Citrix ADM NITRO API Reference

ns_gslbservicegroup

June 20, 2023

Contributed by:

Configuration for Citrix ADC GSLB Service Group Information resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
appflowlog	<String>	Read-write	AppFlow is enabled at GSLB servicegroup of GSLBVServer.
hostname	<String>	Read-write	Hostname of the managed device. Minimum length = 1 Maximum length = 256
svc_grp_mem_port	<Integer>	Read-write	Service Group Member Port. Minimum value = 1 Maximum value =
svc_grp_name	<String>	Read-write	Service Group Name. Minimum length = 1 Maximum length = 100
ns_ip_address	<String>	Read-write	Citrix ADC IP Address. Minimum length = 1 Maximum length = 64
svc_grp_mem_ip_address	<String>	Read-write	Service Group Member IP Address. Minimum length = 1 Maximum length = 64
id	<String>	Read-write	Id is system generated key.
save_config	<Boolean>	Read-write	Save configuration after enable/disable.
lb_id	<String>	Read-write	LB ID.
vsvr_name	<String>	Read-write	Vserver Name. Minimum length = 1 Maximum length = 100
svr_name	<String>	Read-write	Server Member Name. Minimum length = 1 Maximum length = 100
delay	<Double>	Read-write	Time, in seconds, allocated to the Citrix ADC appliance for a graceful shutdown of the service.
svr_id	<String>	Read-write	Server ID.
graceful	<Boolean>	Read-write	Graceful shutdown of Service..
svrstate	<String>	Read-only	Service State.
display_name	<String>	Read-only	Display Name.
svc_grp_effective_state	<String>	Read-only	Service Group Effective State.
partition_name	<String>	Read-only	Partition Name.
comment	<String>	Read-only	Comment.
svc_grp_mem_state	<String>	Read-only	Service Group Member State.
svc_grp_mem_type	<String>	Read-only	Service Group Member Type.

Operations

(click to see Properties )

ENABLE
POLL
GET
DISABLE

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

enable

URL: https://<MGMT-IP>/nitro/v2/config/ns_gslbservicegroup?action=enable;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_gslbservicegroup": {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"svr_id":<String_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"svc_grp_mem_ip_address":<String_value>,
"delay":<Double_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"appflowlog":<String_value>,
"svc_grp_mem_port":<Integer_value>,
"graceful":<Boolean_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_gslbservicegroup":[{
"svrstate":<String_value>,
"appflowlog":<String_value>,
"hostname":<String_value>,
"svc_grp_state_timestamp":<Double_value>,
"svc_grp_mem_port":<Integer_value>,
"svc_grp_name":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"svc_grp_effective_state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"comment":<String_value>,
"svc_grp_mem_ip_address":<String_value>,
"svc_grp_mem_state":<String_value>,
"id":<String_value>,
"svc_grp_mem_type":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}

<!--NeedCopy-->

poll

URL: https://<MGMT-IP>/nitro/v2/config/ns_gslbservicegroup?action=poll;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_gslbservicegroup": {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"svr_id":<String_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"svc_grp_mem_ip_address":<String_value>,
"delay":<Double_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"appflowlog":<String_value>,
"svc_grp_mem_port":<Integer_value>,
"graceful":<Boolean_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_gslbservicegroup":[{
"svrstate":<String_value>,
"appflowlog":<String_value>,
"hostname":<String_value>,
"svc_grp_state_timestamp":<Double_value>,
"svc_grp_mem_port":<Integer_value>,
"svc_grp_name":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"svc_grp_effective_state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"comment":<String_value>,
"svc_grp_mem_ip_address":<String_value>,
"svc_grp_mem_state":<String_value>,
"id":<String_value>,
"svc_grp_mem_type":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_gslbservicegroup HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_gslbservicegroup":[{
"svrstate":<String_value>,
"appflowlog":<String_value>,
"hostname":<String_value>,
"svc_grp_state_timestamp":<Double_value>,
"svc_grp_mem_port":<Integer_value>,
"svc_grp_name":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"svc_grp_effective_state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"comment":<String_value>,
"svc_grp_mem_ip_address":<String_value>,
"svc_grp_mem_state":<String_value>,
"id":<String_value>,
"svc_grp_mem_type":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}

<!--NeedCopy-->

disable

URL: https://<MGMT-IP>/nitro/v2/config/ns_gslbservicegroup?action=disable;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_gslbservicegroup": {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"svr_id":<String_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"svc_grp_mem_ip_address":<String_value>,
"delay":<Double_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"appflowlog":<String_value>,
"svc_grp_mem_port":<Integer_value>,
"graceful":<Boolean_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_gslbservicegroup":[{
"svrstate":<String_value>,
"appflowlog":<String_value>,
"hostname":<String_value>,
"svc_grp_state_timestamp":<Double_value>,
"svc_grp_mem_port":<Integer_value>,
"svc_grp_name":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"svc_grp_effective_state":<String_value>,
"ns_ip_address":<String_value>,
"partition_name":<String_value>,
"comment":<String_value>,
"svc_grp_mem_ip_address":<String_value>,
"svc_grp_mem_state":<String_value>,
"id":<String_value>,
"svc_grp_mem_type":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"graceful":<Boolean_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

ns_gslbservicegroup

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

ns_gslbservicegroup

Properties

Operations

enable

poll

get

disable

In this article