Skip to content

user-vserver

The following operations can be performed on "user-vserver":

rm| show| enable| unset| add| set| disable| stat|

rm user vserver

Removes an user defined virtual server from the Citrix ADC.

Synopsis

rm user vserver

Arguments

name Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my vserver" or 'my vserver').

show user vserver

Displays information about the user defined virtual server.

Synopsis

show user vserver []

Arguments

name Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my vserver" or 'my vserver').

Output

userProtocol User protocol uesd by the service.

IPAddress IPv4 or IPv6 address to assign to the virtual server.

port Port number for the virtual server.

defaultLB Name of the default Load Balancing virtual server used for load balancing of services. The protocol type of default Load Balancing virtual server should be a user type.

params Any comments associated with the protocol.

comment Any comments that you might want to associate with the virtual server.

stateflag state Current user vserver state.

value SSL status.

stateChangeTimeSec Time when last state change happened. Seconds part.

stateChangeTimemSec Time at which last state change happened. Milliseconds part.

ticksSinceLastStateChange Time in 10 millisecond ticks since the last state change.

state Initial state of the user vserver.

noDefaultBindings to determine if the configuration will have default ssl CIPHER and ECC curve bindings

devno count

enable user vserver

Enables an user virtual server.

Synopsis

enable user vserver @

Arguments

name Name of the user virtual server to enable. Note: Virtual servers, when added, are enabled by default.

Example

enable user vserver user_vip

unset user vserver

Use this command to remove user vserver settings.Refer to the set user vserver command for meanings of the arguments.

Synopsis

unset user vserver [-params] [-comment]

add user vserver

Creates an user defined load balancing virtual server. Example: add user protocol MQTT -transporttype TCP -extension mqtt_logic

Synopsis

add user vserver @ @ -defaultLB [-params ] [-comment ] [-state ( ENABLED | DISABLED )]

Arguments

name Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my vserver" or 'my vserver').

userProtocol User protocol uesd by the service.

IPAddress IPv4 or IPv6 address to assign to the virtual server.

port Port number for the virtual server.

defaultLB Name of the default Load Balancing virtual server used for load balancing of services. The protocol type of default Load Balancing virtual server should be a user type.

params Any comments associated with the protocol.

comment Any comments that you might want to associate with the virtual server.

state Initial state of the user vserver.

Possible values: ENABLED, DISABLED Default value: ENABLED

set user vserver

Modifies the specified parameters of an user defined virtual server.

Synopsis

set user vserver [-IPAddress @] [-defaultLB ] [-params ] [-comment ]

Arguments

name Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my vserver" or 'my vserver').

IPAddress IPv4 or IPv6 address to assign to the virtual server.

defaultLB Name of the default Load Balancing virtual server used for load balancing of services. The protocol type of default Load Balancing virtual server should be a user type.

params Any comments associated with the protocol.

comment Any comments that you might want to associate with the virtual server.

disable user vserver

Disables an user virtual server.

Synopsis

disable user vserver @

Arguments

name Name of the user virtual server to be disabled.

Example

disable user vserver user_vip

stat user vserver

Displays the statistical data collected for an user defined load balancing virtual server.

Synopsis

stat user vserver [] [-detail] [-fullValues] [-ntimes ] [-logFile ] [-clearstats ( basic | full )] [-sortBy Hits []]

Arguments

name Name of the user defined virtual server. If no name is provided, statistical data of all configured user defined virtual servers is displayed.

detail Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0

logFile The name of the log file to be used as input.

clearstats Clear the statsistics / counters

Possible values: basic, full

sortBy use this argument to sort by specific key

Possible values: Hits

sortOrder use this argument to specify sort order

Possible values: ascending, descending Default value: SORT_DESCENDING

Output

count devno stateflag

Counters

Current Client Est connections (ClntEstConn) Number of client connections in ESTABLISHED state.

total INACTIVE services (inactSvcs) number of INACTIVE services bound to a vserver

Vserver Health (Health) Health of the vserver. This gives percentage of UP services bound to this vserver.

Vserver IP address (vsvrIP) IP address of the vserver

Port (port) The port on which the service is running.

Vserver protocol name (Protocol) Protocol associated with the vserver

State Current state of the server. There are seven possible values: UP(7), DOWN(1), UNKNOWN(2), BUSY(3), OFS(Out of Service)(4), TROFS(Transition Out of Service)(5), TROFS_DOWN(Down When going Out of Service)(8)

total ACTIVE services (actSvcs) number of ACTIVE services bound to a vserver

Vserver hits (Hits) Total vserver hits

Requests (Req) Total number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)

Responses (Rsp) Number of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)

Request bytes (Reqb) Total number of request bytes received on this service or virtual server.

Response bytes (Rspb) Number of response bytes received by this service or virtual server.

Total Packets rcvd (PktRx) Total number of packets received by this service or virtual server.

Total Packets sent (PktTx) Total number of packets sent.

Current client connections (ClntConn) Number of current client connections.

Current server connections (SvrConn) Number of current connections to the actual servers behind the virtual server.

Invalid Request/Response (IvldReqRsp) Number invalid requests/responses on this vserver

Invalid Request/Response Dropped (IvldReqRspDrp) Number invalid requests/responses dropped on this vserver

Current Server Est connections (SvrEstConn) Number of server connections in ESTABLISHED state.

Was this article helpful?