ns_lbvserver
Configuration for NS Lbvserver Information resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| user_managed | <Boolean> | Read-write | User Managed Idenfication. |
| curclntconnections | <Double> | Read-write | curclntconnections Value. |
| hostname | <String> | Read-write | Hostname of the managed device. Minimum length = 1 Maximum length = 256 |
| ns_ip_address | <String> | Read-write | NS IP Address. Minimum length = 1 Maximum length = 64 |
| id | <String> | Read-write | Id is system generated key. |
| vsvr_port | <Integer> | Read-write | Vserver Port. Minimum value = 1 Maximum value = |
| name | <String> | Read-write | Vserver Name. Minimum length = 1 Maximum length = 100 |
| cursrvrconnections | <Double> | Read-write | cursrvrconnections Value. |
| managed | <Boolean> | Read-write | Managed. |
| vsvr_ip_address | <String> | Read-write | Vserver IP Address. Minimum length = 1 Maximum length = 64 |
| throughput | <Double> | Read-write | throughput value. |
| save_config | <Boolean> | Read-write | Save configuration after enable/disable. |
| is_throughput_req | <Boolean> | Read-write | Throghput required. |
| svc_grp_name | <String> | Read-write | Service Group Name. |
| csvip_id | <String> | Read-write | CSVIP ID. |
| svc_grp_id | <String> | Read-write | Service Group ID. |
| csvip_name | <String> | Read-write | CSVIP Name. |
| svc_name | <String> | Read-write | Service Name. |
| svc_id | <String> | Read-write | Service ID. |
| vsvr_state | <String> | Read-only | Vserver Effective State. |
| vsvr_state_timestamp | <Double> | Read-only | Vserver Last State Change Time. |
| state | <String> | Read-only | Vserver State. |
| lbmethod | <String> | Read-only | lbmethod. |
| activeservices | <String> | Read-only | Active services bound to the LB Vserver. |
| vsvr_type | <String> | Read-only | Vserver Type. |
| totalservices | <String> | Read-only | Total services bound to the LB Vserver. |
| vsvr_health | <Integer> | Read-only | Vserver Health. |
| poll_time | <Integer> | Read-only | Last Polling Time. |
| display_name | <String> | Read-only | Display Name. |
| persistencetype | <String> | Read-only | Persistence Type. |
| comment | <String> | Read-only | Vserver State. |
| partition_name | <String> | Read-only | Partition Name. |
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_lbvserver?action=enable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_lbvserver: {
<b>"id":<String_value></b>,
"user_managed":<Boolean_value>,
"is_throughput_req":<Boolean_value>,
"curclntconnections":<Double_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"csvip_id":<String_value>,
"ns_ip_address":<String_value>,
"csvip_name":<String_value>,
"save_config":<Boolean_value>,
"vsvr_port":<Integer_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"svc_grp_id":<String_value>,
"managed":<Boolean_value>,
"svc_name":<String_value>,
"vsvr_ip_address":<String_value>,
"svc_id":<String_value>,
"throughput":<Double_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_lbvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"vsvr_state":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"lbmethod":<String_value>,
"activeservices":<String_value>,
"vsvr_type":<String_value>,
"id":<String_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"managed":<Boolean_value>,
"persistencetype":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"save_config":<Boolean_value>,
"is_throughput_req":<Boolean_value>,
"svc_grp_name":<String_value>,
"csvip_id":<String_value>,
"svc_grp_id":<String_value>,
"csvip_name":<String_value>,
"svc_name":<String_value>,
"svc_id":<String_value>}]}
poll
URL: https://<MGMT-IP>/nitro/v1/config/ns_lbvserver?action=poll;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_lbvserver: {
<b>"id":<String_value></b>,
"user_managed":<Boolean_value>,
"is_throughput_req":<Boolean_value>,
"curclntconnections":<Double_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"csvip_id":<String_value>,
"ns_ip_address":<String_value>,
"csvip_name":<String_value>,
"save_config":<Boolean_value>,
"vsvr_port":<Integer_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"svc_grp_id":<String_value>,
"managed":<Boolean_value>,
"svc_name":<String_value>,
"vsvr_ip_address":<String_value>,
"svc_id":<String_value>,
"throughput":<Double_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_lbvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"vsvr_state":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"lbmethod":<String_value>,
"activeservices":<String_value>,
"vsvr_type":<String_value>,
"id":<String_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"managed":<Boolean_value>,
"persistencetype":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"save_config":<Boolean_value>,
"is_throughput_req":<Boolean_value>,
"svc_grp_name":<String_value>,
"csvip_id":<String_value>,
"svc_grp_id":<String_value>,
"csvip_name":<String_value>,
"svc_name":<String_value>,
"svc_id":<String_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/ns_lbvserver
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_lbvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"vsvr_state":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"lbmethod":<String_value>,
"activeservices":<String_value>,
"vsvr_type":<String_value>,
"id":<String_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"managed":<Boolean_value>,
"persistencetype":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"save_config":<Boolean_value>,
"is_throughput_req":<Boolean_value>,
"svc_grp_name":<String_value>,
"csvip_id":<String_value>,
"svc_grp_id":<String_value>,
"csvip_name":<String_value>,
"svc_name":<String_value>,
"svc_id":<String_value>}]}
disable
URL: https://<MGMT-IP>/nitro/v1/config/ns_lbvserver?action=disable;onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_lbvserver: {
<b>"id":<String_value></b>,
"user_managed":<Boolean_value>,
"is_throughput_req":<Boolean_value>,
"curclntconnections":<Double_value>,
"svc_grp_name":<String_value>,
"hostname":<String_value>,
"csvip_id":<String_value>,
"ns_ip_address":<String_value>,
"csvip_name":<String_value>,
"save_config":<Boolean_value>,
"vsvr_port":<Integer_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"svc_grp_id":<String_value>,
"managed":<Boolean_value>,
"svc_name":<String_value>,
"vsvr_ip_address":<String_value>,
"svc_id":<String_value>,
"throughput":<Double_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_lbvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"vsvr_state":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"hostname":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"lbmethod":<String_value>,
"activeservices":<String_value>,
"vsvr_type":<String_value>,
"id":<String_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"managed":<Boolean_value>,
"persistencetype":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"save_config":<Boolean_value>,
"is_throughput_req":<Boolean_value>,
"svc_grp_name":<String_value>,
"csvip_id":<String_value>,
"svc_grp_id":<String_value>,
"csvip_name":<String_value>,
"svc_name":<String_value>,
"svc_id":<String_value>}]}