getsystemuserResult Structure Definition

The getsystemuserResult structure defines the return type for getsystemuser API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

systemuserList

List of systemusers


systemuser Structure Definition

The systemuser structure defines the actual return type values for getsystemuser API.

Syntax



Members

username

Name of a system user about whom to display information.

groupname

The system group.

policyname

The name of method policy.

priority

The priority of the policy.

encrypted


hashmethod


externalauth

Whether to use external authentication servers for the system user authentication or not

promptstring

String to display at the method-line prompt. Can consist of letters, numbers, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore (_), and the following variables: * %u - Will be replaced by the user name. * %h - Will be replaced by the hostname of the Citrix ADC. * %t - Will be replaced by the current time in 12-hour format. * %T - Will be replaced by the current time in 24-hour format. * %d - Will be replaced by the current date. * %s - Will be replaced by the state of the Citrix ADC. Note: The 63-character limit for the length of the string does not apply to the characters that replace the variables.

promptinheritedfrom

From where the prompt has been inherited.

timeout

CLI session inactivity timeout, in seconds. If Restrictedtimeout argument of system parameter is enabled, Timeout can have values in the range [300-86400] seconds. If Restrictedtimeout argument of system parameter is disabled, Timeout can have values in the range [0, 10-100000000] seconds. Default value is 900 seconds.

timeoutkind

From where the timeout has been inherited.

partitionname

Name of the Partition to bind to the system user.

logging

Users logging privilege

maxsession

Maximum number of client connection allowed per user

allowedmanagementinterface

Allowed Management interfaces to the system user. By default user is allowed from both API and CLI interfaces. If management interface for a user is set to API, then user is not allowed to access NS through CLI. GUI interface will come under API interface

allowedmanagementinterfacekind

Value of allowed interface which can be inherited from Global, Group or User.

lastpwdchangetimestamp

Timestamp for the last password change for system user

daystoexpirekind

From where the daystoexpire value has been inherited.

_nextgenapiresource


See Also