ns_servicegroupmember_binding
Configuration for NetScaler Service Group Member Bindings resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| ip | <String> | Read-write | Server IP. |
| state | <String> | Read-write | state. |
| ns_ip_address | <String> | Read-write | NS IP Address. Minimum length = 1 Maximum length = 64 |
| customserverid | <String> | Read-write | CustomServerID. |
| weight | <String> | Read-write | Weight. |
| id | <String> | Read-write | Id is system generated key. |
| servicegroupname | <String> | Read-write | Service Group Name. |
| svrstate | <String> | Read-write | Server State. |
| port | <Integer> | Read-write | Server Port. |
| serverid | <String> | Read-write | ServerID. |
| servername | <String> | Read-write | ServerName. |
| save_config | <Boolean> | Read-write | Save configuration after enable/disable. |
| delay | <Double> | Read-write | Time, in seconds, allocated to the NetScaler appliance for a graceful shutdown of the service. |
| svc_grp_id | <String> | Read-write | Service Group ID. |
| graceful | <Boolean> | Read-write | Graceful shutdown of Service.. |
| hostname | <String> | Read-only | Host name of the Managed device . |
| poll_time | <Integer> | Read-only | Last Polling Time. |
| display_name | <String> | Read-only | Display Name. |
| comment | <String> | Read-only | Comment. |
| partition_name | <String> | Read-only | Partition Name. |
| hash_id | <String> | Read-only | Hash Id. |
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_servicegroupmember_binding?action=enable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_servicegroupmember_binding: {
<b>"id":<String_value></b>,
"ip":<String_value>,
"delay":<Double_value>,
"ns_ip_address":<String_value>,
"state":<String_value>,
"customserverid":<String_value>,
"weight":<String_value>,
"save_config":<Boolean_value>,
"servicegroupname":<String_value>,
"svrstate":<String_value>,
"svc_grp_id":<String_value>,
"port":<Integer_value>,
"serverid":<String_value>,
"servername":<String_value>,
"graceful":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroupmember_binding":[{
"ip":<String_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"customserverid":<String_value>,
"weight":<String_value>,
"id":<String_value>,
"servicegroupname":<String_value>,
"svrstate":<String_value>,
"poll_time":<Integer_value>,
"port":<Integer_value>,
"display_name":<String_value>,
"serverid":<String_value>,
"servername":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"hash_id":<String_value>,
"save_config":<Boolean_value>,
"delay":<Double_value>,
"svc_grp_id":<String_value>,
"graceful":<Boolean_value>}]}
poll
URL: https://<MGMT-IP>/nitro/v1/config/ns_servicegroupmember_binding?action=poll;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_servicegroupmember_binding: {
<b>"id":<String_value></b>,
"ip":<String_value>,
"delay":<Double_value>,
"ns_ip_address":<String_value>,
"state":<String_value>,
"customserverid":<String_value>,
"weight":<String_value>,
"save_config":<Boolean_value>,
"servicegroupname":<String_value>,
"svrstate":<String_value>,
"svc_grp_id":<String_value>,
"port":<Integer_value>,
"serverid":<String_value>,
"servername":<String_value>,
"graceful":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroupmember_binding":[{
"ip":<String_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"customserverid":<String_value>,
"weight":<String_value>,
"id":<String_value>,
"servicegroupname":<String_value>,
"svrstate":<String_value>,
"poll_time":<Integer_value>,
"port":<Integer_value>,
"display_name":<String_value>,
"serverid":<String_value>,
"servername":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"hash_id":<String_value>,
"save_config":<Boolean_value>,
"delay":<Double_value>,
"svc_grp_id":<String_value>,
"graceful":<Boolean_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/ns_servicegroupmember_binding
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroupmember_binding":[{
"ip":<String_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"customserverid":<String_value>,
"weight":<String_value>,
"id":<String_value>,
"servicegroupname":<String_value>,
"svrstate":<String_value>,
"poll_time":<Integer_value>,
"port":<Integer_value>,
"display_name":<String_value>,
"serverid":<String_value>,
"servername":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"hash_id":<String_value>,
"save_config":<Boolean_value>,
"delay":<Double_value>,
"svc_grp_id":<String_value>,
"graceful":<Boolean_value>}]}
disable
URL: https://<MGMT-IP>/nitro/v1/config/ns_servicegroupmember_binding?action=disable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_servicegroupmember_binding: {
<b>"id":<String_value></b>,
"ip":<String_value>,
"delay":<Double_value>,
"ns_ip_address":<String_value>,
"state":<String_value>,
"customserverid":<String_value>,
"weight":<String_value>,
"save_config":<Boolean_value>,
"servicegroupname":<String_value>,
"svrstate":<String_value>,
"svc_grp_id":<String_value>,
"port":<Integer_value>,
"serverid":<String_value>,
"servername":<String_value>,
"graceful":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_servicegroupmember_binding":[{
"ip":<String_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"customserverid":<String_value>,
"weight":<String_value>,
"id":<String_value>,
"servicegroupname":<String_value>,
"svrstate":<String_value>,
"poll_time":<Integer_value>,
"port":<Integer_value>,
"display_name":<String_value>,
"serverid":<String_value>,
"servername":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"hash_id":<String_value>,
"save_config":<Boolean_value>,
"delay":<Double_value>,
"svc_grp_id":<String_value>,
"graceful":<Boolean_value>}]}