Variable $DmrClusterLinkConst

Type declaration

• properties: {
      authenticationBasicPassword: {
          description: "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.";
          type: "string";
      };
      authenticationScheme: {
          type: "Enum";
      };
      clientProfileQueueControl1MaxDepth: {
          description: "The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueControl1MinMsgBurst: {
          description: "The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueDirect1MaxDepth: {
          description: "The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueDirect1MinMsgBurst: {
          description: "The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueDirect2MaxDepth: {
          description: "The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueDirect2MinMsgBurst: {
          description: "The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueDirect3MaxDepth: {
          description: "The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueDirect3MinMsgBurst: {
          description: "The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueGuaranteed1MaxDepth: {
          description: "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
          format: "int32";
          type: "number";
      };
      clientProfileQueueGuaranteed1MinMsgBurst: {
          description: "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.";
          format: "int32";
          type: "number";
      };
      clientProfileTcpCongestionWindowSize: {
          description: "The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`.";
          format: "int64";
          type: "number";
      };
      clientProfileTcpKeepaliveCount: {
          description: "The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`.";
          format: "int64";
          type: "number";
      };
      clientProfileTcpKeepaliveIdleTime: {
          description: "The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.";
          format: "int64";
          type: "number";
      };
      clientProfileTcpKeepaliveInterval: {
          description: "The amount of time between TCP keepalive retransmissions when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.";
          format: "int64";
          type: "number";
      };
      clientProfileTcpMaxSegmentSize: {
          description: "The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`.";
          format: "int64";
          type: "number";
      };
      clientProfileTcpMaxWindowSize: {
          description: "The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`.";
          format: "int64";
          type: "number";
      };
      dmrClusterName: {
          description: "The name of the Cluster.";
          type: "string";
      };
      egressFlowWindowSize: {
          description: "The number of outstanding guaranteed messages that can be sent over the Link before acknowledgement is received by the sender. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.";
          format: "int64";
          type: "number";
      };
      enabled: {
          description: "Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      };
      initiator: {
          type: "Enum";
      };
      queueDeadMsgQueue: {
          description: "The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.";
          type: "string";
      };
      queueEventSpoolUsageThreshold: {
          type: "EventThreshold";
      };
      queueMaxDeliveredUnackedMsgsPerFlow: {
          description: "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1000000`.";
          format: "int64";
          type: "number";
      };
      queueMaxMsgSpoolUsage: {
          description: "The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `800000`.";
          format: "int64";
          type: "number";
      };
      queueMaxRedeliveryCount: {
          description: "The maximum number of times the 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 via config-sync. The default value is `0`.";
          format: "int64";
          type: "number";
      };
      queueMaxTtl: {
          description: "The maximum time in seconds a message can stay in the 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 Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.";
          format: "int64";
          type: "number";
      };
      queueRejectMsgToSenderOnDiscardBehavior: {
          type: "Enum";
      };
      queueRespectTtlEnabled: {
          description: "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      };
      remoteNodeName: {
          description: "The name of the node at the remote end of the Link.";
          type: "string";
      };
      span: {
          type: "Enum";
      };
      transportCompressedEnabled: {
          description: "Enable or disable compression on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      };
      transportTlsEnabled: {
          description: "Enable or disable encryption (TLS) on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      };
  }

  • authenticationBasicPassword: {
        description: "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.";
        type: "string";
    }

    • description: "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`."

    • type: "string"

  • authenticationScheme: {
        type: "Enum";
    }

    • type: "Enum"

  • clientProfileQueueControl1MaxDepth: {
        description: "The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
        format: "int32";
        type: "number";
    }

    • description: "The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueControl1MinMsgBurst: {
        description: "The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
        format: "int32";
        type: "number";
    }

    • description: "The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueDirect1MaxDepth: {
        description: "The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
        format: "int32";
        type: "number";
    }

    • description: "The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueDirect1MinMsgBurst: {
        description: "The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
        format: "int32";
        type: "number";
    }

    • description: "The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueDirect2MaxDepth: {
        description: "The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
        format: "int32";
        type: "number";
    }

    • description: "The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueDirect2MinMsgBurst: {
        description: "The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
        format: "int32";
        type: "number";
    }

    • description: "The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueDirect3MaxDepth: {
        description: "The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
        format: "int32";
        type: "number";
    }

    • description: "The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueDirect3MinMsgBurst: {
        description: "The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.";
        format: "int32";
        type: "number";
    }

    • description: "The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueGuaranteed1MaxDepth: {
        description: "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.";
        format: "int32";
        type: "number";
    }

    • description: "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`."

    • format: "int32"

    • type: "number"

  • clientProfileQueueGuaranteed1MinMsgBurst: {
        description: "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.";
        format: "int32";
        type: "number";
    }

    • description: "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`."

    • format: "int32"

    • type: "number"

  • clientProfileTcpCongestionWindowSize: {
        description: "The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`."

    • format: "int64"

    • type: "number"

  • clientProfileTcpKeepaliveCount: {
        description: "The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`.";
        format: "int64";
        type: "number";
    }

    • description: "The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`."

    • format: "int64"

    • type: "number"

  • clientProfileTcpKeepaliveIdleTime: {
        description: "The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.";
        format: "int64";
        type: "number";
    }

    • description: "The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`."

    • format: "int64"

    • type: "number"

  • clientProfileTcpKeepaliveInterval: {
        description: "The amount of time between TCP keepalive retransmissions when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.";
        format: "int64";
        type: "number";
    }

    • description: "The amount of time between TCP keepalive retransmissions when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`."

    • format: "int64"

    • type: "number"

  • clientProfileTcpMaxSegmentSize: {
        description: "The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`."

    • format: "int64"

    • type: "number"

  • clientProfileTcpMaxWindowSize: {
        description: "The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`."

    • format: "int64"

    • type: "number"

  • dmrClusterName: {
        description: "The name of the Cluster.";
        type: "string";
    }

    • description: "The name of the Cluster."

    • type: "string"

  • egressFlowWindowSize: {
        description: "The number of outstanding guaranteed messages that can be sent over the Link before acknowledgement is received by the sender. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.";
        format: "int64";
        type: "number";
    }

    • description: "The number of outstanding guaranteed messages that can be sent over the Link before acknowledgement is received by the sender. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`."

    • format: "int64"

    • type: "number"

  • enabled: {
        description: "Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`."

    • type: "boolean"

  • initiator: {
        type: "Enum";
    }

    • type: "Enum"

  • queueDeadMsgQueue: {
        description: "The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.";
        type: "string";
    }

    • description: "The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`."

    • type: "string"

  • queueEventSpoolUsageThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

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

    • description: "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1000000`."

    • format: "int64"

    • type: "number"

  • queueMaxMsgSpoolUsage: {
        description: "The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `800000`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `800000`."

    • format: "int64"

    • type: "number"

  • queueMaxRedeliveryCount: {
        description: "The maximum number of times the 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 via config-sync. The default value is `0`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of times the 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 via config-sync. The default value is `0`."

    • format: "int64"

    • type: "number"

  • queueMaxTtl: {
        description: "The maximum time in seconds a message can stay in the 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 Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum time in seconds a message can stay in the 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 Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`."

    • 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 Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
        type: "boolean";
    }

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

    • type: "boolean"

  • remoteNodeName: {
        description: "The name of the node at the remote end of the Link.";
        type: "string";
    }

    • description: "The name of the node at the remote end of the Link."

    • type: "string"

  • span: {
        type: "Enum";
    }

    • type: "Enum"

  • transportCompressedEnabled: {
        description: "Enable or disable compression on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable compression on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`."

    • type: "boolean"

  • transportTlsEnabled: {
        description: "Enable or disable encryption (TLS) on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable encryption (TLS) on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`."

    • type: "boolean"