Class AclProfileService

Hierarchy

  • AclProfileService

Constructors

constructor

Methods

createMsgVpnAclProfile createMsgVpnAclProfileClientConnectException createMsgVpnAclProfilePublishException createMsgVpnAclProfilePublishTopicException createMsgVpnAclProfileSubscribeException createMsgVpnAclProfileSubscribeShareNameException createMsgVpnAclProfileSubscribeTopicException deleteMsgVpnAclProfile deleteMsgVpnAclProfileClientConnectException deleteMsgVpnAclProfilePublishException deleteMsgVpnAclProfilePublishTopicException deleteMsgVpnAclProfileSubscribeException deleteMsgVpnAclProfileSubscribeShareNameException deleteMsgVpnAclProfileSubscribeTopicException getMsgVpnAclProfile getMsgVpnAclProfileClientConnectException getMsgVpnAclProfileClientConnectExceptions getMsgVpnAclProfilePublishException getMsgVpnAclProfilePublishExceptions getMsgVpnAclProfilePublishTopicException getMsgVpnAclProfilePublishTopicExceptions getMsgVpnAclProfileSubscribeException getMsgVpnAclProfileSubscribeExceptions getMsgVpnAclProfileSubscribeShareNameException getMsgVpnAclProfileSubscribeShareNameExceptions getMsgVpnAclProfileSubscribeTopicException getMsgVpnAclProfileSubscribeTopicExceptions getMsgVpnAclProfiles replaceMsgVpnAclProfile updateMsgVpnAclProfile

Constructors

constructor

Methods

Static createMsgVpnAclProfile

  • Create an ACL Profile object. Create an ACL 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.

    An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x

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

    This has been available since 2.0.

    Returns

    MsgVpnAclProfileResponse The ACL Profile object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The ACL 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<MsgVpnAclProfileResponse | SempMetaOnlyResponse>

Static createMsgVpnAclProfileClientConnectException

  • Create a Client Connect Exception object. Create a Client Connect Exception 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.

    A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    aclProfileName x x
    clientConnectExceptionAddress x x
    msgVpnName x x

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

    This has been available since 2.0.

    Returns

    MsgVpnAclProfileClientConnectExceptionResponse The Client Connect Exception object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfileClientConnectException

        The Client Connect Exception 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<MsgVpnAclProfileClientConnectExceptionResponse | SempMetaOnlyResponse>

Static createMsgVpnAclProfilePublishException

  • Deprecated

    Create a Publish Topic Exception object. Create a Publish Topic Exception 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.

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    aclProfileName x x x
    msgVpnName x x x
    publishExceptionTopic x x x
    topicSyntax x x x

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

    This has been deprecated since 2.14. Replaced by publishTopicExceptions.

    Returns

    MsgVpnAclProfilePublishExceptionResponse The Publish Topic Exception object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfilePublishException

        The Publish Topic Exception 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<MsgVpnAclProfilePublishExceptionResponse | SempMetaOnlyResponse>

Static createMsgVpnAclProfilePublishTopicException

  • Create a Publish Topic Exception object. Create a Publish Topic Exception 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.

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x
    publishTopicException x x
    publishTopicExceptionSyntax x x

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

    This has been available since 2.14.

    Returns

    MsgVpnAclProfilePublishTopicExceptionResponse The Publish Topic Exception object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfilePublishTopicException

        The Publish Topic Exception 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<MsgVpnAclProfilePublishTopicExceptionResponse | SempMetaOnlyResponse>

Static createMsgVpnAclProfileSubscribeException

  • Deprecated

    Create a Subscribe Topic Exception object. Create a Subscribe Topic Exception 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.

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    aclProfileName x x x
    msgVpnName x x x
    subscribeExceptionTopic x x x
    topicSyntax x x x

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

    This has been deprecated since 2.14. Replaced by subscribeTopicExceptions.

    Returns

    MsgVpnAclProfileSubscribeExceptionResponse The Subscribe Topic Exception object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfileSubscribeException

        The Subscribe Topic Exception 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<MsgVpnAclProfileSubscribeExceptionResponse | SempMetaOnlyResponse>

Static createMsgVpnAclProfileSubscribeShareNameException

  • Create a Subscribe Share Name Exception object. Create a Subscribe Share Name Exception 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.

    A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x
    subscribeShareNameException x x
    subscribeShareNameExceptionSyntax x x

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

    This has been available since 2.14.

    Returns

    MsgVpnAclProfileSubscribeShareNameExceptionResponse The Subscribe Share Name Exception object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfileSubscribeShareNameException

        The Subscribe Share Name Exception 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<MsgVpnAclProfileSubscribeShareNameExceptionResponse | SempMetaOnlyResponse>

Static createMsgVpnAclProfileSubscribeTopicException

  • Create a Subscribe Topic Exception object. Create a Subscribe Topic Exception 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.

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x
    subscribeTopicException x x
    subscribeTopicExceptionSyntax x x

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

    This has been available since 2.14.

    Returns

    MsgVpnAclProfileSubscribeTopicExceptionResponse The Subscribe Topic Exception object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfileSubscribeTopicException

        The Subscribe Topic Exception 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<MsgVpnAclProfileSubscribeTopicExceptionResponse | SempMetaOnlyResponse>

Static deleteMsgVpnAclProfile

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

    An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.

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

    This has been available since 2.0.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAclProfileClientConnectException

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

    A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.

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

    This has been available since 2.0.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          clientConnectExceptionAddress: string;
          msgVpnName: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL Profile. *

      • clientConnectExceptionAddress: string

        The IP address/netmask of the client connect exception in CIDR form. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAclProfilePublishException

  • Deprecated

    Delete a Publish Topic Exception object. Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

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

    This has been deprecated since 2.14. Replaced by publishTopicExceptions.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          publishExceptionTopic: string;
          topicSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • publishExceptionTopic: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • topicSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAclProfilePublishTopicException

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

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

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

    This has been available since 2.14.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          publishTopicException: string;
          publishTopicExceptionSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • publishTopicException: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • publishTopicExceptionSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAclProfileSubscribeException

  • Deprecated

    Delete a Subscribe Topic Exception object. Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

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

    This has been deprecated since 2.14. Replaced by subscribeTopicExceptions.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          subscribeExceptionTopic: string;
          topicSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • subscribeExceptionTopic: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • topicSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAclProfileSubscribeShareNameException

  • Delete a Subscribe Share Name Exception object. Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.

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

    This has been available since 2.14.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          subscribeShareNameException: string;
          subscribeShareNameExceptionSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • subscribeShareNameException: string

        The subscribe share name exception to the default action taken. May include wildcard characters. *

      • subscribeShareNameExceptionSyntax: string

        The syntax of the subscribe share name for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnAclProfileSubscribeTopicException

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

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

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

    This has been available since 2.14.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          subscribeTopicException: string;
          subscribeTopicExceptionSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL Profile. *

      • msgVpnName: string

        The name of the Message VPN. *

      • subscribeTopicException: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • subscribeTopicExceptionSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnAclProfile

  • Get an ACL Profile object. Get an ACL Profile object.

    An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName 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

    MsgVpnAclProfileResponse The ACL Profile object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL 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<MsgVpnAclProfileResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileClientConnectException

  • Get a Client Connect Exception object. Get a Client Connect Exception object.

    A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    clientConnectExceptionAddress 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

    MsgVpnAclProfileClientConnectExceptionResponse The Client Connect Exception object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • clientConnectExceptionAddress: string

        The IP address/netmask of the client connect exception in CIDR form. *

      • 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<MsgVpnAclProfileClientConnectExceptionResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileClientConnectExceptions

  • Get a list of Client Connect Exception objects. Get a list of Client Connect Exception objects.

    A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    clientConnectExceptionAddress 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

    MsgVpnAclProfileClientConnectExceptionsResponse The list of Client Connect Exception objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • 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<MsgVpnAclProfileClientConnectExceptionsResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfilePublishException

  • Deprecated

    Get a Publish Topic Exception object. Get a Publish Topic Exception object.

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x
    publishExceptionTopic x x
    topicSyntax x x

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

    This has been deprecated since 2.14. Replaced by publishTopicExceptions.

    Returns

    MsgVpnAclProfilePublishExceptionResponse The Publish Topic Exception object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          publishExceptionTopic: string;
          select?: string[];
          topicSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL 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. *

      • publishExceptionTopic: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • 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. *

      • topicSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAclProfilePublishExceptionResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfilePublishExceptions

  • Deprecated

    Get a list of Publish Topic Exception objects. Get a list of Publish Topic Exception objects.

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x
    publishExceptionTopic x x
    topicSyntax x x

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

    This has been deprecated since 2.14. Replaced by publishTopicExceptions.

    Returns

    MsgVpnAclProfilePublishExceptionsResponse The list of Publish Topic Exception objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • 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<MsgVpnAclProfilePublishExceptionsResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfilePublishTopicException

  • Get a Publish Topic Exception object. Get a Publish Topic Exception object.

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    msgVpnName x
    publishTopicException x
    publishTopicExceptionSyntax 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.14.

    Returns

    MsgVpnAclProfilePublishTopicExceptionResponse The Publish Topic Exception object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          publishTopicException: string;
          publishTopicExceptionSyntax: string;
          select?: string[];
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL 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. *

      • publishTopicException: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • publishTopicExceptionSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • 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<MsgVpnAclProfilePublishTopicExceptionResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfilePublishTopicExceptions

  • Get a list of Publish Topic Exception objects. Get a list of Publish Topic Exception objects.

    A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    msgVpnName x
    publishTopicException x
    publishTopicExceptionSyntax 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.14.

    Returns

    MsgVpnAclProfilePublishTopicExceptionsResponse The list of Publish Topic Exception objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • 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<MsgVpnAclProfilePublishTopicExceptionsResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileSubscribeException

  • Deprecated

    Get a Subscribe Topic Exception object. Get a Subscribe Topic Exception object.

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x
    subscribeExceptionTopic x x
    topicSyntax x x

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

    This has been deprecated since 2.14. Replaced by subscribeTopicExceptions.

    Returns

    MsgVpnAclProfileSubscribeExceptionResponse The Subscribe Topic Exception object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          subscribeExceptionTopic: string;
          topicSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL 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. *

      • subscribeExceptionTopic: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • topicSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAclProfileSubscribeExceptionResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileSubscribeExceptions

  • Deprecated

    Get a list of Subscribe Topic Exception objects. Get a list of Subscribe Topic Exception objects.

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x x
    msgVpnName x x
    subscribeExceptionTopic x x
    topicSyntax x x

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

    This has been deprecated since 2.14. Replaced by subscribeTopicExceptions.

    Returns

    MsgVpnAclProfileSubscribeExceptionsResponse The list of Subscribe Topic Exception objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • 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<MsgVpnAclProfileSubscribeExceptionsResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileSubscribeShareNameException

  • Get a Subscribe Share Name Exception object. Get a Subscribe Share Name Exception object.

    A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    msgVpnName x
    subscribeShareNameException x
    subscribeShareNameExceptionSyntax 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.14.

    Returns

    MsgVpnAclProfileSubscribeShareNameExceptionResponse The Subscribe Share Name Exception object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          subscribeShareNameException: string;
          subscribeShareNameExceptionSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL 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. *

      • subscribeShareNameException: string

        The subscribe share name exception to the default action taken. May include wildcard characters. *

      • subscribeShareNameExceptionSyntax: string

        The syntax of the subscribe share name for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAclProfileSubscribeShareNameExceptionResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileSubscribeShareNameExceptions

  • Get a list of Subscribe Share Name Exception objects. Get a list of Subscribe Share Name Exception objects.

    A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    msgVpnName x
    subscribeShareNameException x
    subscribeShareNameExceptionSyntax 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.14.

    Returns

    MsgVpnAclProfileSubscribeShareNameExceptionsResponse The list of Subscribe Share Name Exception objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • 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<MsgVpnAclProfileSubscribeShareNameExceptionsResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileSubscribeTopicException

  • Get a Subscribe Topic Exception object. Get a Subscribe Topic Exception object.

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    msgVpnName x
    subscribeTopicException x
    subscribeTopicExceptionSyntax 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.14.

    Returns

    MsgVpnAclProfileSubscribeTopicExceptionResponse The Subscribe Topic Exception object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          aclProfileName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          subscribeTopicException: string;
          subscribeTopicExceptionSyntax: string;
          xContextId?: string;
      }
      • aclProfileName: string

        The name of the ACL 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. *

      • subscribeTopicException: string

        The topic for the exception to the default action taken. May include wildcard characters. *

      • subscribeTopicExceptionSyntax: string

        The syntax of the topic for the exception to the default action taken. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnAclProfileSubscribeTopicExceptionResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfileSubscribeTopicExceptions

  • Get a list of Subscribe Topic Exception objects. Get a list of Subscribe Topic Exception objects.

    A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName x
    msgVpnName x
    subscribeTopicException x
    subscribeTopicExceptionSyntax 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.14.

    Returns

    MsgVpnAclProfileSubscribeTopicExceptionsResponse The list of Subscribe Topic Exception objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • 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<MsgVpnAclProfileSubscribeTopicExceptionsResponse | SempMetaOnlyResponse>

Static getMsgVpnAclProfiles

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

    An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.

    Attribute Identifying Write-Only Deprecated Opaque
    aclProfileName 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

    MsgVpnAclProfilesResponse The list of ACL 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<MsgVpnAclProfilesResponse | SempMetaOnlyResponse>

Static replaceMsgVpnAclProfile

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

    An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    aclProfileName x x
    msgVpnName x x

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

    This has been available since 2.0.

    Returns

    MsgVpnAclProfileResponse The ACL Profile object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfile

        The ACL 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<MsgVpnAclProfileResponse | SempMetaOnlyResponse>

Static updateMsgVpnAclProfile

  • Update an ACL Profile object. Update an ACL Profile object. Any attribute missing from the request will be left unchanged.

    An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    aclProfileName x x
    msgVpnName x x

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

    This has been available since 2.0.

    Returns

    MsgVpnAclProfileResponse The ACL Profile object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The name of the ACL Profile. *

      • body: MsgVpnAclProfile

        The ACL 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<MsgVpnAclProfileResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme