| getsystemgroupResult Structure Definition |
The getsystemgroupResult structure defines the return type for getsystemgroup 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. |
systemgroupList |
List of systemgroups |
| systemgroup Structure Definition |
The systemgroup structure defines the actual return type values for getsystemgroup API. |
Syntax |
Members |
groupname |
Name of the system group about which to display information. |
username |
The system user. |
policyname |
The name of method policy. |
priority |
The priority of the method policy. |
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. |
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. |
partitionname |
Name of the Partition to bind to the system group. |
allowedmanagementinterface |
Allowed Management interfaces of the system users in the group. By default allowed from both API and CLI interfaces. If management interface for a group is set to API, then all users under this group will not allowed to access NS through CLI. GUI interface will come under API interface |
daystoexpire |
Password days to expire for system groups. The daystoexpire value ranges from 30 to 255. |
warnpriorndays |
Number of days before which password expiration warning would be thrown with respect to daystoexpire. The warnpriorndays value ranges from 5 to 40. |
_nextgenapiresource |
See Also |