Configuring Client Event Thresholds

You can configure the set and clear thresholds that control when any of the following client events are generated for a specific client profile:

Spool Usage Thresholds for Client-Provisioned Endpoints

To configure the threshold values that determine when to generate events for the amount of message spool used by all endpoints provisioned by clients using the given client profile, enter the following commands:

solace(configure)# client-profile <name> message-vpn <vpn‑name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# client-provisioned-endpoint-spool-usage thresholds {{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

The no version of the command, no client-provisioned-endpoint-spool-usage thresholds, resets event generation for message spool usage by client-provisioned endpoints back to the default values.

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-percentage> is the set threshold value expressed as a percentage of the maximum spool usage for all client-provisioned endpoints. The valid range is from 0 to 100.

<clear-percentage> is a clear threshold value expressed as a percentage of the maximum spool usage for all client-provisioned endpoints. The valid range is from 0 to 100.

For information about the default values for this setting, see Maximum Spool Usage.

Changing these values during event broker operation does not affect existing sessions. They are only validated at session establishment time.

Connections Per Client Username Thresholds

To configure the threshold values that determine when to generate events for SMF and/or Web transport service clients using the given client profile and the same client username that simultaneously connect to the event broker, enter the following commands:

solace(configure)# client-profile <name> message-vpn <vpn-name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# connections-per-client-username thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value. The valid range and default value depends on the type of event broker and NAB used.

<clear-value> is the clear threshold expressed as a count value. The valid range and the default value depends on the type of event broker and NAB used.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of simultaneous client connections (that is, the maximum number of simultaneous sessions established between the client and event broker) that can be made using the same client username account in a client profile. The default value is 80.

<clear-percentage> is a clear threshold value expressed as a percentage (from 0 to 100) of the maximum number of simultaneous client connections that can be made using the same client username account in a client profile. The default value is 60.

The no version of the command, no connections-per-client-username thresholds, resets event generation for number of client connections for the given client username back to the default values.

For information on setting the max-egress-flows for a client profile, see Configuring Max Connections Per Username.

Egress Flows Thresholds

To configure the threshold values that determine when to generate events for the number of egress flows (that is, Guaranteed message client consumer flows) established for clients using the given client profile, enter the followingcommands:

solace(configure)# client-profile <name> message-vpn <vpn‑name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# egress-flows thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value.

<clear-value> is a clear threshold expressed as a count value.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of egress flows that can be created by a single client associated with the client profile. The default value is 80.

<clear-percentage> is a clear threshold percentage (from 0 to 100) expressed as a percentage of the value set through the Max Number of Egress Flows Permitted. The default is 60.

The no version of the command, no egress-flows thresholds, resets event generation for the maximum number of egress flows per client back to the default values.

Endpoints Per Client Username Thresholds

You can configure the threshold values that determine when to generate events for the number of endpoints owned by clients using the given client profile and the same client username. (The owned endpoints can be durable and non-durable queues and/or topic endpoints.)

To configure the endpoints-per-client-username thresholds for the given client profile, enter the following commands:

solace(configure)# client-profile <name> message-vpn <vpn‑name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# endpoints-per-client-username thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of durable and non-durable endpoints that can be owned by the clients using the same client username within a client profile. The default value is 80.

<clear-percentage> is a clear threshold value expressed as a percentage (from 0 to 100) of the maximum number of durable and non-durable endpoints that can be owned by the clients using the same client username within a client profile. The default value is 60.

The no version of the command, no endpoints-per-client-username thresholds, resets event generation for the maximum number of endpoints a client can own back to the default values.

For information on setting the max-endpoints-per-client-username, see Configuring Max Connections Per Username.

Ingress Flows Thresholds

To configure the threshold values that determine when to generate events for the number of ingress flows (that is, Guaranteed message client producer flows) established for clients using the given client profile, enter the following commands:

solace(configure)# client-profile <name> message-vpn <vpn‑name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# ingress-flows thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of ingress flows that can be created by a single client associated with this client profile. The default value is 80.

<clear-percentage> is a clear threshold percentage expressed as a percentage (from 0 to 100) of the maximum number of ingress flows that can be created by a single client associated with this client profile. The default value is 60.

The no version of the command, no max-ingress-flows, resets event generation for the maximum number of ingress flows per client back to the default values.

For information on setting the max-ingress-flows for a client profile, see Configuring the Max Ingress Flows Permitted.

Client Username Service Thresholds

You can configure the connections-per-client-username thresholds that define when the event broker should generate events separately for:

SMF Connections Per Client Username

To configure the threshold values that determine when to generate events for the SMF transport clients using the given client profile and the same client username that simultaneously connect to the event broker, enter the following commands:

solace(configure/client-profile/event/service)# smf
solace(...gure/client-profile/event/service/smf)# connections-per-client-username
solace(...e/smf/connections-per-client-username)# thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value. The valid range is from 0 to the maximum total number of SMF clients that can be supported by the type of event broker (for example, 3530 or 3560) and the version of NAB used.

<clear-value> is the clear threshold expressed as a count value. The valid range is from 0 to the maximum total number of SMF clients that can be supported by the type of event broker and the version of NAB used.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of SMF clients using the same client username that may simultaneously connect to the event broker. The default value is 80.

<clear-percentage> is a clear threshold value expressed as a percentage (from 0 to 100) of the maximum number of SMF clients using the same client username that may simultaneously connect to the event broker. The default value is 60.

The no version of this command, no thresholds, resets event generation for SMF connections in a client profile back to the default values.

To view the maximum total number of SMF client connections that can be supported, enter the show service User EXEC command

For information on how to set the maximum number of SMF clients using the same client username that may simultaneously connect to the event broker, see Configuring Client Profiles.

Web Transport Connections Per Client Username

To configure the threshold values that determine when to generate events for the Web transport clients using the given client profile and the same client username that simultaneously connect to the event broker, enter the following commands:

solace(configure/client-profile/event)# service web-transport
solace(...t-profile/event/service/web-transport)# connections-per-client-username 
solace(...sport/connections-per-client-username)#thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value. The valid range is from 0 to the maximum total number of Web clients that can be supported by the type of event broker (for example, 3530 or 3560) and the version of NAB used.

<clear-value> is the clear threshold expressed as a count value. The valid range is from 0 to the maximum total number of Web clients that can be supported by the type of event broker and the version of NAB used.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of Web clients using the same client username that may simultaneously connect to the event broker. The default value is 80.

<clear-percentage> is a clear threshold value expressed as a percentage (from 0 to 100) of the maximum number of Web clients using the same client username that may simultaneously connect to the event broker. The default value is 60.

The no version of the command, no thresholds, resets event generation for Web connections in a client profile back to the default values.

To view the maximum total number of Web client connections that can be supported, enter the show service User EXEC command.

For information on how to set the maximum number of Web clients using the same client username that may simultaneously connect to the event broker, see Configuring Max Web Client Connections.

Subscriptions Thresholds

To configure the threshold values that determine when to generate events for the number of subscriptions allowed for a Message VPN, enter the following commands:

solace(configure)# client-profile <name> message-vpn <vpn‑name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# subscriptions thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of subscriptions for a single client in a client profile. The default value is 80.

<clear-percentage> is a clear threshold value expressed as a percentage (from 0 to 100) of the maximum number of subscriptions for a single client in a client profile. The default value is 60.

The no version of the command, no subscriptions thresholds, resets event generation for subscription count in a client profile back to the default values.

For information on setting the max-subscriptions, see Configuring Max Permitted Subscriptions.

Transacted Sessions Thresholds

To configure the threshold values that determine when to generate events for the number of simultaneous transacted sessions (that is, local transacted sessions) and/or XA Sessions established per a client using the given client profile, enter the following commands:

solace(configure)# client-profile <name> message-vpn <vpn‑name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# transacted-sessions thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is the set threshold expressed as a count value.

<clear-value> is a clear threshold expressed as a count value.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of transacted sessions allowed per client by a client profile. The default value is 80.

<clear-percentage> is a clear threshold percentage expressed as a percentage (from 0 to 100) of the maximum number of transacted sessions allowed per client by a client profile. The default value is 60.

The no version of the command, no transacted-sessions thresholds, resets event generation for the maximum number of simultaneous transacted sessions allowed for clients back to the default values.

For information on setting the max-transacted-sessions, see Configuring the Max Number of Transacted Sessions.

Transactions Thresholds

To configure the threshold values that determine when to generate events for the total number of simultaneous transactions (both local transactions and transactions within XA transaction branches) per client using the given client profile, enter the following commands:

solace(configure)# client-profile <name> message-vpn <vpn‑name>
solace(configure/client-profile)# event
solace(configure/client-profile/event)# transactions thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<name> is an existing client profile name.

<vpn-name> is the name of the Message VPN that the client profile belongs to. It must already exist.

<set-value> is a set threshold expressed as a count value.

<clear-value> is a clear threshold expressed as a count value.

<set-percentage> is a set threshold value from 0 to 100, set as a percentage of the maximum number of simultaneous transactions allowed for the event broker. The default value is 80.

<clear-percentage> is a clear threshold percentage from 0 to 100, set as a percentage of the maximum number of simultaneous transactions allowed for the event broker. The default value is 60.

The no version of this command, no transactions thresholds, resets the transactions event thresholds back to the default values.