Type alias MsgVpnClientProfile

MsgVpnClientProfile: {
    allowBridgeConnectionsEnabled?: boolean;
    allowCutThroughForwardingEnabled?: boolean;
    allowGuaranteedEndpointCreateDurability?: allowGuaranteedEndpointCreateDurability;
    allowGuaranteedEndpointCreateEnabled?: boolean;
    allowGuaranteedMsgReceiveEnabled?: boolean;
    allowGuaranteedMsgSendEnabled?: boolean;
    allowSharedSubscriptionsEnabled?: boolean;
    allowTransactedSessionsEnabled?: boolean;
    apiQueueManagementCopyFromOnCreateName?: string;
    apiQueueManagementCopyFromOnCreateTemplateName?: string;
    apiTopicEndpointManagementCopyFromOnCreateName?: string;
    apiTopicEndpointManagementCopyFromOnCreateTemplateName?: string;
    clientProfileName?: string;
    compressionEnabled?: boolean;
    elidingDelay?: number;
    elidingEnabled?: boolean;
    elidingMaxTopicCount?: number;
    eventClientProvisionedEndpointSpoolUsageThreshold?: EventThresholdByPercent;
    eventConnectionCountPerClientUsernameThreshold?: EventThreshold;
    eventEgressFlowCountThreshold?: EventThreshold;
    eventEndpointCountPerClientUsernameThreshold?: EventThreshold;
    eventIngressFlowCountThreshold?: EventThreshold;
    eventServiceSmfConnectionCountPerClientUsernameThreshold?: EventThreshold;
    eventServiceWebConnectionCountPerClientUsernameThreshold?: EventThreshold;
    eventSubscriptionCountThreshold?: EventThreshold;
    eventTransactedSessionCountThreshold?: EventThreshold;
    eventTransactionCountThreshold?: EventThreshold;
    maxConnectionCountPerClientUsername?: number;
    maxEgressFlowCount?: number;
    maxEndpointCountPerClientUsername?: number;
    maxIngressFlowCount?: number;
    maxMsgsPerTransaction?: number;
    maxSubscriptionCount?: number;
    maxTransactedSessionCount?: number;
    maxTransactionCount?: number;
    msgVpnName?: string;
    queueControl1MaxDepth?: number;
    queueControl1MinMsgBurst?: number;
    queueDirect1MaxDepth?: number;
    queueDirect1MinMsgBurst?: number;
    queueDirect2MaxDepth?: number;
    queueDirect2MinMsgBurst?: number;
    queueDirect3MaxDepth?: number;
    queueDirect3MinMsgBurst?: number;
    queueGuaranteed1MaxDepth?: number;
    queueGuaranteed1MinMsgBurst?: number;
    rejectMsgToSenderOnNoSubscriptionMatchEnabled?: boolean;
    replicationAllowClientConnectWhenStandbyEnabled?: boolean;
    serviceMinKeepaliveTimeout?: number;
    serviceSmfMaxConnectionCountPerClientUsername?: number;
    serviceSmfMinKeepaliveEnabled?: boolean;
    serviceWebInactiveTimeout?: number;
    serviceWebMaxConnectionCountPerClientUsername?: number;
    serviceWebMaxPayload?: number;
    tcpCongestionWindowSize?: number;
    tcpKeepaliveCount?: number;
    tcpKeepaliveIdleTime?: number;
    tcpKeepaliveInterval?: number;
    tcpMaxSegmentSize?: number;
    tcpMaxWindowSize?: number;
    tlsAllowDowngradeToPlainTextEnabled?: boolean;
}

Type declaration

  • Optional allowBridgeConnectionsEnabled?: boolean

    Enable or disable allowing Bridge clients using the Client Profile to connect. Changing this setting does not affect existing Bridge client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional allowCutThroughForwardingEnabled?: boolean

    Enable or disable allowing clients using the Client Profile to bind to endpoints with the cut-through forwarding delivery mode. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Deprecated since 2.22. This attribute has been deprecated. Please visit the Solace Product Lifecycle Policy web page for details on deprecated features.

  • Optional allowGuaranteedEndpointCreateDurability?: allowGuaranteedEndpointCreateDurability

    The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "all". The allowed values and their meaning are:

    "all" - Client can create any type of endpoint.
"durable" - Client can create only durable endpoints.
"non-durable" - Client can create only non-durable endpoints.

    Available since 2.14.

  • Optional allowGuaranteedEndpointCreateEnabled?: boolean

    Enable or disable allowing clients using the Client Profile to create topic endponts or queues. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional allowGuaranteedMsgReceiveEnabled?: boolean

    Enable or disable allowing clients using the Client Profile to receive guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional allowGuaranteedMsgSendEnabled?: boolean

    Enable or disable allowing clients using the Client Profile to send guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional allowSharedSubscriptionsEnabled?: boolean

    Enable or disable allowing shared subscriptions. Changing this setting does not affect existing subscriptions. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.11.

  • Optional allowTransactedSessionsEnabled?: boolean

    Enable or disable allowing clients using the Client Profile to establish transacted sessions. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional apiQueueManagementCopyFromOnCreateName?: string

    The name of a queue to copy settings from when a new queue is created by a client using the Client Profile. The referenced queue must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.14. This attribute has been replaced with apiQueueManagementCopyFromOnCreateTemplateName.

  • Optional apiQueueManagementCopyFromOnCreateTemplateName?: string

    The name of a queue template to copy settings from when a new queue is created by a client using the Client Profile. If the referenced queue template does not exist, queue creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.14.

  • Optional apiTopicEndpointManagementCopyFromOnCreateName?: string

    The name of a topic endpoint to copy settings from when a new topic endpoint is created by a client using the Client Profile. The referenced topic endpoint must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Deprecated since 2.14. This attribute has been replaced with apiTopicEndpointManagementCopyFromOnCreateTemplateName.

  • Optional apiTopicEndpointManagementCopyFromOnCreateTemplateName?: string

    The name of a topic endpoint template to copy settings from when a new topic endpoint is created by a client using the Client Profile. If the referenced topic endpoint template does not exist, topic endpoint creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "". Available since 2.14.

  • Optional clientProfileName?: string

    The name of the Client Profile.

  • Optional compressionEnabled?: boolean

    Enable or disable allowing clients using the Client Profile to use compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.10.

  • Optional elidingDelay?: number

    The amount of time to delay the delivery of messages to clients using the Client Profile after the initial message has been delivered (the eliding delay interval), in milliseconds. A value of 0 means there is no delay in delivering messages to clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional elidingEnabled?: boolean

    Enable or disable message eliding for clients using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional elidingMaxTopicCount?: number

    The maximum number of topics tracked for message eliding per client connection using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 256.

  • Optional eventClientProvisionedEndpointSpoolUsageThreshold?: EventThresholdByPercent
  • Optional eventConnectionCountPerClientUsernameThreshold?: EventThreshold
  • Optional eventEgressFlowCountThreshold?: EventThreshold
  • Optional eventEndpointCountPerClientUsernameThreshold?: EventThreshold
  • Optional eventIngressFlowCountThreshold?: EventThreshold
  • Optional eventServiceSmfConnectionCountPerClientUsernameThreshold?: EventThreshold
  • Optional eventServiceWebConnectionCountPerClientUsernameThreshold?: EventThreshold
  • Optional eventSubscriptionCountThreshold?: EventThreshold
  • Optional eventTransactedSessionCountThreshold?: EventThreshold
  • Optional eventTransactionCountThreshold?: EventThreshold
  • Optional maxConnectionCountPerClientUsername?: number

    The maximum number of client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

  • Optional maxEgressFlowCount?: number

    The maximum number of transmit flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

  • Optional maxEndpointCountPerClientUsername?: number

    The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

  • Optional maxIngressFlowCount?: number

    The maximum number of receive flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

  • Optional maxMsgsPerTransaction?: number

    The maximum number of publisher and consumer messages combined that is allowed within a transaction for each client associated with this client-profile. Exceeding this limit will result in a transaction prepare or commit failure. Changing this value during operation will not affect existing sessions. It is only validated at transaction creation time. Large transactions consume more resources and are more likely to require retrieving messages from the ADB or from disk to process the transaction prepare or commit requests. The transaction processing rate may diminish if a large number of messages must be retrieved from the ADB or from disk. Care should be taken to not use excessively large transactions needlessly to avoid exceeding resource limits and to avoid reducing the overall broker performance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 256. Available since 2.20.

  • Optional maxSubscriptionCount?: number

    The maximum number of subscriptions per client using the Client Profile. This limit is not enforced when a client adds a subscription to an endpoint, except for MQTT QoS 1 subscriptions. In addition, this limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

  • Optional maxTransactedSessionCount?: number

    The maximum number of transacted sessions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10.

  • Optional maxTransactionCount?: number

    The maximum number of transactions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional queueControl1MaxDepth?: number

    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 and replication sites via config-sync. The default value is 20000.

  • Optional queueControl1MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Control 1" (C-1) priority queue, regardless of the queueControl1MaxDepth value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

  • Optional queueDirect1MaxDepth?: number

    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 and replication sites via config-sync. The default value is 20000.

  • Optional queueDirect1MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Direct 1" (D-1) priority queue, regardless of the queueDirect1MaxDepth value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

  • Optional queueDirect2MaxDepth?: number

    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 and replication sites via config-sync. The default value is 20000.

  • Optional queueDirect2MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Direct 2" (D-2) priority queue, regardless of the queueDirect2MaxDepth value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

  • Optional queueDirect3MaxDepth?: number

    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 and replication sites via config-sync. The default value is 20000.

  • Optional queueDirect3MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the queueDirect3MaxDepth value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

  • Optional queueGuaranteed1MaxDepth?: number

    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 and replication sites via config-sync. The default value is 20000.

  • Optional queueGuaranteed1MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Guaranteed 1" (G-3) priority queue, regardless of the queueGuaranteed1MaxDepth value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 255.

  • Optional rejectMsgToSenderOnNoSubscriptionMatchEnabled?: boolean

    Enable or disable the sending of a negative acknowledgement (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.2.

  • Optional replicationAllowClientConnectWhenStandbyEnabled?: boolean

    Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional serviceMinKeepaliveTimeout?: number

    The minimum client keepalive timeout which will be enforced for client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30. Available since 2.19.

  • Optional serviceSmfMaxConnectionCountPerClientUsername?: number

    The maximum number of SMF client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

  • Optional serviceSmfMinKeepaliveEnabled?: boolean

    Enable or disable the enforcement of a minimum keepalive timeout for SMF clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.19.

  • Optional serviceWebInactiveTimeout?: number

    The timeout for inactive Web Transport client sessions using the Client Profile, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30.

  • Optional serviceWebMaxConnectionCountPerClientUsername?: number

    The maximum number of Web Transport client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.

  • Optional serviceWebMaxPayload?: number

    The maximum Web Transport payload size before fragmentation occurs for clients using the Client Profile, in bytes. The size of the header is not included. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000000.

  • Optional tcpCongestionWindowSize?: number

    The TCP initial congestion window size for clients using the Client Profile, 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 and replication sites via config-sync. The default value is 2.

  • Optional tcpKeepaliveCount?: number

    The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5.

  • Optional tcpKeepaliveIdleTime?: number

    The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

  • Optional tcpKeepaliveInterval?: number

    The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

  • Optional tcpMaxSegmentSize?: number

    The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1460.

  • Optional tcpMaxWindowSize?: number

    The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 256.

  • Optional tlsAllowDowngradeToPlainTextEnabled?: boolean

    Enable or disable allowing a client using the Client Profile to downgrade an encrypted connection to plain text. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.8.

Settings

Member Visibility

Theme