Class ClientProfileService

Hierarchy

  • ClientProfileService

Constructors

constructor

Methods

createMsgVpnClientProfile deleteMsgVpnClientProfile getMsgVpnClientProfile getMsgVpnClientProfiles replaceMsgVpnClientProfile updateMsgVpnClientProfile

Constructors

constructor

Methods

Static createMsgVpnClientProfile

  • Create a Client Profile object. Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    allowCutThroughForwardingEnabled x
    apiQueueManagementCopyFromOnCreateName x
    apiTopicEndpointManagementCopyFromOnCreateName x
    clientProfileName x x
    msgVpnName x x

    The following attributes in the request may only be provided in certain combinations with other attributes:

    Class Attribute Requires Conflicts
    EventThreshold clearPercent setPercent clearValue, setValue
    EventThreshold clearValue setValue clearPercent, setPercent
    EventThreshold setPercent clearPercent clearValue, setValue
    EventThreshold setValue clearValue clearPercent, setPercent
    EventThresholdByPercent clearPercent setPercent
    EventThresholdByPercent setPercent clearPercent

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientProfileResponse The Client Profile object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnClientProfile;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnClientProfile

        The Client Profile object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnClientProfileResponse | SempMetaOnlyResponse>

Static deleteMsgVpnClientProfile

  • Delete a Client Profile object. Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          clientProfileName: string;
          msgVpnName: string;
          xContextId?: string;
      }
      • clientProfileName: string

        The name of the Client Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnClientProfile

  • Get a Client Profile object. Get a Client Profile object.

    Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.

    Attribute Identifying Write-Only Deprecated Opaque
    allowCutThroughForwardingEnabled x
    apiQueueManagementCopyFromOnCreateName x
    apiTopicEndpointManagementCopyFromOnCreateName x
    clientProfileName x
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientProfileResponse The Client Profile object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          clientProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • clientProfileName: string

        The name of the Client Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnClientProfileResponse | SempMetaOnlyResponse>

Static getMsgVpnClientProfiles

  • Get a list of Client Profile objects. Get a list of Client Profile objects.

    Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.

    Attribute Identifying Write-Only Deprecated Opaque
    allowCutThroughForwardingEnabled x
    apiQueueManagementCopyFromOnCreateName x
    apiTopicEndpointManagementCopyFromOnCreateName x
    clientProfileName x
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientProfilesResponse The list of Client Profile objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnClientProfilesResponse | SempMetaOnlyResponse>

Static replaceMsgVpnClientProfile

  • Replace a Client Profile object. Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    allowCutThroughForwardingEnabled x
    apiQueueManagementCopyFromOnCreateName x
    apiTopicEndpointManagementCopyFromOnCreateName x
    clientProfileName x x
    msgVpnName x x

    The following attributes in the request may only be provided in certain combinations with other attributes:

    Class Attribute Requires Conflicts
    EventThreshold clearPercent setPercent clearValue, setValue
    EventThreshold clearValue setValue clearPercent, setPercent
    EventThreshold setPercent clearPercent clearValue, setValue
    EventThreshold setValue clearValue clearPercent, setPercent
    EventThresholdByPercent clearPercent setPercent
    EventThresholdByPercent setPercent clearPercent

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientProfileResponse The Client Profile object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnClientProfile;
          clientProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnClientProfile

        The Client Profile object's attributes. *

      • clientProfileName: string

        The name of the Client Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnClientProfileResponse | SempMetaOnlyResponse>

Static updateMsgVpnClientProfile

  • Update a Client Profile object. Update a Client Profile object. Any attribute missing from the request will be left unchanged.

    Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    allowCutThroughForwardingEnabled x
    apiQueueManagementCopyFromOnCreateName x
    apiTopicEndpointManagementCopyFromOnCreateName x
    clientProfileName x x
    msgVpnName x x

    The following attributes in the request may only be provided in certain combinations with other attributes:

    Class Attribute Requires Conflicts
    EventThreshold clearPercent setPercent clearValue, setValue
    EventThreshold clearValue setValue clearPercent, setPercent
    EventThreshold setPercent clearPercent clearValue, setValue
    EventThreshold setValue clearValue clearPercent, setPercent
    EventThresholdByPercent clearPercent setPercent
    EventThresholdByPercent setPercent clearPercent

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.0.

    Returns

    MsgVpnClientProfileResponse The Client Profile object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnClientProfile;
          clientProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnClientProfile

        The Client Profile object's attributes. *

      • clientProfileName: string

        The name of the Client Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnClientProfileResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme