Variable $MsgVpnMqttSessionConst

Type declaration

• properties: {
      enabled: {
          description: "Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
          type: "boolean";
      };
      mqttSessionClientId: {
          description: "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.";
          type: "string";
      };
      mqttSessionVirtualRouter: {
          type: "Enum";
      };
      msgVpnName: {
          description: "The name of the Message VPN.";
          type: "string";
      };
      owner: {
          description: "The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
          type: "string";
      };
      queueConsumerAckPropagationEnabled: {
          description: "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14.";
          type: "boolean";
      };
      queueDeadMsgQueue: {
          description: "The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14.";
          type: "string";
      };
      queueEventBindCountThreshold: {
          type: "EventThreshold";
      };
      queueEventMsgSpoolUsageThreshold: {
          type: "EventThreshold";
      };
      queueEventRejectLowPriorityMsgLimitThreshold: {
          type: "EventThreshold";
      };
      queueMaxBindCount: {
          description: "The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14.";
          format: "int64";
          type: "number";
      };
      queueMaxDeliveredUnackedMsgsPerFlow: {
          description: "The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14.";
          format: "int64";
          type: "number";
      };
      queueMaxMsgSize: {
          description: "The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14.";
          format: "int32";
          type: "number";
      };
      queueMaxMsgSpoolUsage: {
          description: "The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14.";
          format: "int64";
          type: "number";
      };
      queueMaxRedeliveryCount: {
          description: "The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.";
          format: "int64";
          type: "number";
      };
      queueMaxTtl: {
          description: "The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.";
          format: "int64";
          type: "number";
      };
      queueRejectLowPriorityMsgEnabled: {
          description: "Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.";
          type: "boolean";
      };
      queueRejectLowPriorityMsgLimit: {
          description: "The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.";
          format: "int64";
          type: "number";
      };
      queueRejectMsgToSenderOnDiscardBehavior: {
          type: "Enum";
      };
      queueRespectTtlEnabled: {
          description: "Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.";
          type: "boolean";
      };
  }

  • enabled: {
        description: "Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."

    • type: "boolean"

  • mqttSessionClientId: {
        description: "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.";
        type: "string";
    }

    • description: "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet."

    • type: "string"

  • mqttSessionVirtualRouter: {
        type: "Enum";
    }

    • type: "Enum"

  • msgVpnName: {
        description: "The name of the Message VPN.";
        type: "string";
    }

    • description: "The name of the Message VPN."

    • type: "string"

  • owner: {
        description: "The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
        type: "string";
    }

    • description: "The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`."

    • type: "string"

  • queueConsumerAckPropagationEnabled: {
        description: "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14.";
        type: "boolean";
    }

    • description: "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14."

    • type: "boolean"

  • queueDeadMsgQueue: {
        description: "The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14.";
        type: "string";
    }

    • description: "The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14."

    • type: "string"

  • queueEventBindCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • queueEventMsgSpoolUsageThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • queueEventRejectLowPriorityMsgLimitThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • queueMaxBindCount: {
        description: "The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14."

    • format: "int64"

    • type: "number"

  • queueMaxDeliveredUnackedMsgsPerFlow: {
        description: "The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14."

    • format: "int64"

    • type: "number"

  • queueMaxMsgSize: {
        description: "The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14.";
        format: "int32";
        type: "number";
    }

    • description: "The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14."

    • format: "int32"

    • type: "number"

  • queueMaxMsgSpoolUsage: {
        description: "The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14."

    • format: "int64"

    • type: "number"

  • queueMaxRedeliveryCount: {
        description: "The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14."

    • format: "int64"

    • type: "number"

  • queueMaxTtl: {
        description: "The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14."

    • format: "int64"

    • type: "number"

  • queueRejectLowPriorityMsgEnabled: {
        description: "Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.";
        type: "boolean";
    }

    • description: "Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14."

    • type: "boolean"

  • queueRejectLowPriorityMsgLimit: {
        description: "The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.";
        format: "int64";
        type: "number";
    }

    • description: "The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14."

    • format: "int64"

    • type: "number"

  • queueRejectMsgToSenderOnDiscardBehavior: {
        type: "Enum";
    }

    • type: "Enum"

  • queueRespectTtlEnabled: {
        description: "Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.";
        type: "boolean";
    }

    • description: "Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14."

    • type: "boolean"