Class MqttSessionService

Hierarchy

  • MqttSessionService

Constructors

constructor

Methods

createMsgVpnMqttSession createMsgVpnMqttSessionSubscription deleteMsgVpnMqttSession deleteMsgVpnMqttSessionSubscription getMsgVpnMqttSession getMsgVpnMqttSessionSubscription getMsgVpnMqttSessionSubscriptions getMsgVpnMqttSessions replaceMsgVpnMqttSession replaceMsgVpnMqttSessionSubscription updateMsgVpnMqttSession updateMsgVpnMqttSessionSubscription

Constructors

constructor

Methods

Static createMsgVpnMqttSession

  • Create an MQTT Session object. Create an MQTT Session 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 MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    mqttSessionClientId x x
    mqttSessionVirtualRouter 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

    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.1.

    Returns

    MsgVpnMqttSessionResponse The MQTT Session object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The MQTT Session 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<MsgVpnMqttSessionResponse | SempMetaOnlyResponse>

Static createMsgVpnMqttSessionSubscription

  • Create a Subscription object. Create a Subscription 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 MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    mqttSessionClientId x x
    mqttSessionVirtualRouter x x
    msgVpnName x x
    subscriptionTopic 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.1.

    Returns

    MsgVpnMqttSessionSubscriptionResponse The Subscription object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnMqttSessionSubscription;
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnMqttSessionSubscription

        The Subscription object's attributes. *

      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

Static deleteMsgVpnMqttSession

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

    An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).

    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.1.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          xContextId?: string;
      }
      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnMqttSessionSubscription

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

    An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.

    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.1.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          subscriptionTopic: string;
          xContextId?: string;
      }
      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

      • msgVpnName: string

        The name of the Message VPN. *

      • subscriptionTopic: string

        The MQTT subscription topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnMqttSession

  • Get an MQTT Session object. Get an MQTT Session object.

    An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).

    Attribute Identifying Write-Only Deprecated Opaque
    mqttSessionClientId x
    mqttSessionVirtualRouter 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.1.

    Returns

    MsgVpnMqttSessionResponse The MQTT Session object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

Static getMsgVpnMqttSessionSubscription

  • Get a Subscription object. Get a Subscription object.

    An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.

    Attribute Identifying Write-Only Deprecated Opaque
    mqttSessionClientId x
    mqttSessionVirtualRouter x
    msgVpnName x
    subscriptionTopic 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.1.

    Returns

    MsgVpnMqttSessionSubscriptionResponse The Subscription object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          subscriptionTopic: string;
          xContextId?: string;
      }
      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

      • subscriptionTopic: string

        The MQTT subscription topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnMqttSessionSubscriptionResponse | SempMetaOnlyResponse>

Static getMsgVpnMqttSessionSubscriptions

  • Get a list of Subscription objects. Get a list of Subscription objects.

    An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.

    Attribute Identifying Write-Only Deprecated Opaque
    mqttSessionClientId x
    mqttSessionVirtualRouter x
    msgVpnName x
    subscriptionTopic 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.1.

    Returns

    MsgVpnMqttSessionSubscriptionsResponse The list of Subscription objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: 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. *

      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

Static getMsgVpnMqttSessions

  • Get a list of MQTT Session objects. Get a list of MQTT Session objects.

    An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).

    Attribute Identifying Write-Only Deprecated Opaque
    mqttSessionClientId x
    mqttSessionVirtualRouter 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.1.

    Returns

    MsgVpnMqttSessionsResponse The list of MQTT Session 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<MsgVpnMqttSessionsResponse | SempMetaOnlyResponse>

Static replaceMsgVpnMqttSession

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

    An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    mqttSessionClientId x x
    mqttSessionVirtualRouter x x
    msgVpnName x x
    owner 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

    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.1.

    Returns

    MsgVpnMqttSessionResponse The MQTT Session object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnMqttSession;
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnMqttSession

        The MQTT Session object's attributes. *

      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

Static replaceMsgVpnMqttSessionSubscription

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

    An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    mqttSessionClientId x x
    mqttSessionVirtualRouter x x
    msgVpnName x x
    subscriptionTopic 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.1.

    Returns

    MsgVpnMqttSessionSubscriptionResponse The Subscription object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnMqttSessionSubscription;
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          subscriptionTopic: string;
          xContextId?: string;
      }
      • body: MsgVpnMqttSessionSubscription

        The Subscription object's attributes. *

      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

      • subscriptionTopic: string

        The MQTT subscription topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnMqttSessionSubscriptionResponse | SempMetaOnlyResponse>

Static updateMsgVpnMqttSession

  • Update an MQTT Session object. Update an MQTT Session object. Any attribute missing from the request will be left unchanged.

    An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    mqttSessionClientId x x
    mqttSessionVirtualRouter x x
    msgVpnName x x
    owner 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

    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.1.

    Returns

    MsgVpnMqttSessionResponse The MQTT Session object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnMqttSession;
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnMqttSession

        The MQTT Session object's attributes. *

      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

Static updateMsgVpnMqttSessionSubscription

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

    An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    mqttSessionClientId x x
    mqttSessionVirtualRouter x x
    msgVpnName x x
    subscriptionTopic 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.1.

    Returns

    MsgVpnMqttSessionSubscriptionResponse The Subscription object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnMqttSessionSubscription;
          mqttSessionClientId: string;
          mqttSessionVirtualRouter: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          subscriptionTopic: string;
          xContextId?: string;
      }
      • body: MsgVpnMqttSessionSubscription

        The Subscription object's attributes. *

      • mqttSessionClientId: string

        The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. *

      • mqttSessionVirtualRouter: string

        The virtual router of the MQTT Session. *

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

      • subscriptionTopic: string

        The MQTT subscription topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnMqttSessionSubscriptionResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme