ns_servicegroup
Configuration for NS Service Group Information resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| 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 | NS 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 NetScaler 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. |
| svc_grp_state_timestamp | <Double> | Read-only | Service Group Last State Change Time. |
| poll_time | <Integer> | Read-only | Last Polling Time. |
| 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)
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>.
enable
URL: https://<MGMT-IP>/nitro/v1/config/ns_servicegroup?action=enable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_servicegroup: {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"svc_grp_mem_port":<Integer_value>,
"svc_grp_mem_ip_address":<String_value>,
"graceful":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroup":[{
"svrstate":<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>}]}
poll
URL: https://<MGMT-IP>/nitro/v1/config/ns_servicegroup?action=poll;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_servicegroup: {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"svc_grp_mem_port":<Integer_value>,
"svc_grp_mem_ip_address":<String_value>,
"graceful":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroup":[{
"svrstate":<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>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/ns_servicegroup
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroup":[{
"svrstate":<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>}]}
disable
URL: https://<MGMT-IP>/nitro/v1/config/ns_servicegroup?action=disable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_servicegroup: {
<b>"id":<String_value></b>,
"vsvr_name":<String_value>,
"svr_name":<String_value>,
"delay":<Double_value>,
"svr_id":<String_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"ns_ip_address":<String_value>,
"save_config":<Boolean_value>,
"lb_id":<String_value>,
"svc_grp_mem_port":<Integer_value>,
"svc_grp_mem_ip_address":<String_value>,
"graceful":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroup":[{
"svrstate":<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>}]}