Skip to content

options clientprofile

Pankaj A edited this page Apr 5, 2020 · 2 revisions

Create Client Profile

% splus clientprofile create --help
Usage: splus clientprofile create [OPTIONS] NAME

  Create a new client profile

Options:
  --enable-bridge / --no-enable-bridge
                                  Manage Bridge clients using the client-
                                  profile to connect  [default: True]
  --enable-cut-through / --no-enable-cut-through
                                  Enable or disable allowing clients using the
                                  client-profile to bind to endpoints with the
                                  cut-through forwarding delivery mode
                                  [default: False]
  --client-create-durability [all|durable|non-durable]
                                  Types of Queues and Topic Endpoints that
                                  clients using the client-profile can create
                                  [default: all]
  --enable-client-endpoint / --no-enable-client-endpoint
                                  Allow clients using the Client Profile to
                                  create topic endpoints or queues  [default:
                                  True]
  --enable-gm-receive / --no-enable-gm-receive
                                  Allow clients using the Client Profile to
                                  receive guaranteed messages  [default: True]
  --enable-gm-send / -no-enable-gm-send
                                  Allow clients using the Client Profile to
                                  send guaranteed messages  [default: True]
  --enable-shared / -no-enable-shared
                                  Enable or disable allowing shared
                                  subscriptions  [default: True]
  --enable-tx / -no-enable-tx     Enable or disable allowing clients using the
                                  Client Profile to establish transacted
                                  sessions  [default: False]
  --template-queue TEXT           Name of a queue template to copy settings
                                  from when a new queue is created by a client
                                  using the Client Profile
  --template-topic-endpoint TEXT  Name of a topic endpoint template to copy
                                  settings from when a new topic endpoint is
                                  created by a client using the Client Profile
  --compress / --no-compress      Enable or disable allowing clients using the
                                  Client Profile to use compression  [default:
                                  True]
  --eliding-delay INTEGER         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  [default: 0]
  --enable-eliding / --no-eliding
                                  Enable or disable message eliding for
                                  clients using the Client Profile  [default:
                                  True]
  --eliding-max-topics INTEGER    Maximum number of topics tracked for message
                                  eliding per client connection using the
                                  Client Profile  [default: 256]
  --max-client-connects INTEGER   Maximum number of client connections per
                                  Client Username
  --max-egress-flows INTEGER      Maximum number of transmit flows that can be
                                  created by one client  [default: 16000]
  --max-client-created-endpoints INTEGER
                                  Maximum number of queues and topic endpoints
                                  that can be created by clients with the same
                                  Client Username  [default: 16000]
  --max-ingress-flows INTEGER     Maximum number of receive flows that can be
                                  created by one client  [default: 16000]
  --max-subscriptions INTEGER     Maximum number of subscriptions per client
  --max-tx-sessions INTEGER       Maximum number of transacted sessions that
                                  can be created by one client  [default: 10]
  --max-client-tx INTEGER         Maximum number of transactions that can be
                                  created by one client
  --reject-no-subscription / --no-reject-no-subscription
                                  Enable or disable the sending of a negative
                                  acknowledgement (NACK) to a client when
                                  discarding a guaranteed message due to no
                                  matching subscription found  [default:
                                  False]
  --enable-connect-standby / --no-enable-connect-standby
                                  Allow clients to connect to the Message VPN
                                  when its replication state is standby
                                  [default: False]
  --max-client-smf-connects INTEGER
                                  Maximum number of SMF client connections per
                                  Client Username
  --web-inactive-timeout INTEGER  Timeout for inactive Web Transport client
                                  sessions, in seconds  [default: 30]
  --max-client-web-connects INTEGER
                                  Maximum number of Web Transport client
                                  connections per Client Username
  --max-web-payload INTEGER       Maximum Web Transport payload size, in
                                  bytes, before fragmentation occurs for
                                  clients. The size of the header is not
                                  included  [default: 1000000]
  --tcp-congestion-size INTEGER   TCP initial congestion window size for
                                  clients, in multiples of the TCP Maximum
                                  Segment Size (MSS).  [default: 2]
  --tcp-keepalive INTEGER         Number of TCP keepalive retransmissions to a
                                  client before declaring that it is not
                                  available  [default: 5]
  --tcp-keepalive-idle INTEGER    Amount of time, in seconds,  a client
                                  connection must remain idle before TCP
                                  begins sending keepalive probes  [default:
                                  3]
  --tcp-keepalive-interval INTEGER
                                  Amount of time, in seconds,  between TCP
                                  keepalive retransmissions to a client when
                                  no acknowledgement is received  [default: 1]
  --tcp-max-segment-size INTEGER  TCP maximum segment size for clients, in
                                  kilobytes.  [default: 1460]
  --tcp-max-window-size INTEGER   TCP maximum window size for clients, in
                                  kilobytes.  [default: 256]
  --allow-tls-downgrade / --no-tls-allow-downgrade
                                  Enable or disable allowing a client to
                                  downgrade an encrypted connection to plain
                                  text  [default: True]
  --default-vpn TEXT              Name of the MsgVPN (default from config
                                  file)
  --broker-url TEXT               MsgVPN URL (default from config file
  --broker-username TEXT          Admin username (default from config file)
  --broker-password TEXT          Admin password (default from config file)
  --help                          Show this message and exit.

Update Client Profile

% splus clientprofile update --help
Usage: splus clientprofile update [OPTIONS] NAME

  Update an existing client profile

Options:
  --enable-bridge / --no-enable-bridge
                                  Manage Bridge clients using the client-
                                  profile to connect
  --enable-cut-through / --no-enable-cut-through
                                  Enable or disable allowing clients using the
                                  client-profile to bind to endpoints with the
                                  cut-through forwarding delivery mode
  --client-create-durability [all|durable|non-durable]
                                  Types of Queues and Topic Endpoints that
                                  clients using the client-profile can create
  --enable-client-endpoint / --no-enable-client-endpoint
                                  Allow clients using the Client Profile to
                                  create topic endpoints or queues
  --enable-gm-receive / --no-enable-gm-receive
                                  Allow clients using the Client Profile to
                                  receive guaranteed messages
  --enable-gm-send / -no-enable-gm-send
                                  Allow clients using the Client Profile to
                                  send guaranteed messages
  --enable-shared / -no-enable-shared
                                  Enable or disable allowing shared
                                  subscriptions
  --enable-tx / -no-enable-tx     Enable or disable allowing clients using the
                                  Client Profile to establish transacted
                                  sessions
  --template-queue TEXT           Name of a queue template to copy settings
                                  from when a new queue is created by a client
                                  using the Client Profile
  --template-topic-endpoint TEXT  Name of a topic endpoint template to copy
                                  settings from when a new topic endpoint is
                                  created by a client using the Client Profile
  --compress / --no-compress      Enable or disable allowing clients using the
                                  Client Profile to use compression
  --eliding-delay INTEGER         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
  --enable-eliding / --no-eliding
                                  Enable or disable message eliding for
                                  clients using the Client Profile
  --eliding-max-topics INTEGER    Maximum number of topics tracked for message
                                  eliding per client connection using the
                                  Client Profile
  --max-client-connects INTEGER   Maximum number of client connections per
                                  Client Username
  --max-egress-flows INTEGER      Maximum number of transmit flows that can be
                                  created by one client
  --max-client-created-endpoints INTEGER
                                  Maximum number of queues and topic endpoints
                                  that can be created by clients with the same
                                  Client Username
  --max-ingress-flows INTEGER     Maximum number of receive flows that can be
                                  created by one client
  --max-subscriptions INTEGER     Maximum number of subscriptions per client
  --max-tx-sessions INTEGER       Maximum number of transacted sessions that
                                  can be created by one client
  --max-client-tx INTEGER         Maximum number of transactions that can be
                                  created by one client
  --reject-no-subscription / --no-reject-no-subscription
                                  Enable or disable the sending of a negative
                                  acknowledgement (NACK) to a client when
                                  discarding a guaranteed message due to no
                                  matching subscription found
  --enable-connect-standby / --no-enable-connect-standby
                                  Allow clients to connect to the Message VPN
                                  when its replication state is standby
  --max-client-smf-connects INTEGER
                                  Maximum number of SMF client connections per
                                  Client Username
  --web-inactive-timeout INTEGER  Timeout for inactive Web Transport client
                                  sessions, in seconds
  --max-client-web-connects INTEGER
                                  Maximum number of Web Transport client
                                  connections per Client Username
  --max-web-payload INTEGER       Maximum Web Transport payload size, in
                                  bytes, before fragmentation occurs for
                                  clients. The size of the header is not
                                  included
  --tcp-congestion-size INTEGER   TCP initial congestion window size for
                                  clients, in multiples of the TCP Maximum
                                  Segment Size (MSS).
  --tcp-keepalive INTEGER         Number of TCP keepalive retransmissions to a
                                  client before declaring that it is not
                                  available
  --tcp-keepalive-idle INTEGER    Amount of time, in seconds,  a client
                                  connection must remain idle before TCP
                                  begins sending keepalive probes
  --tcp-keepalive-interval INTEGER
                                  Amount of time, in seconds,  between TCP
                                  keepalive retransmissions to a client when
                                  no acknowledgement is received
  --tcp-max-segment-size INTEGER  TCP maximum segment size for clients, in
                                  kilobytes.
  --tcp-max-window-size INTEGER   TCP maximum window size for clients, in
                                  kilobytes.
  --allow-tls-downgrade / --no-tls-allow-downgrade
                                  Enable or disable allowing a client to
                                  downgrade an encrypted connection to plain
                                  text
  --default-vpn TEXT              Name of the MsgVPN (default from config
                                  file)
  --broker-url TEXT               MsgVPN URL (default from config file
  --broker-username TEXT          Admin username (default from config file)
  --broker-password TEXT          Admin password (default from config file)
  --help                          Show this message and exit.
Clone this wiki locally