ns_authenticationvserver
Configuration for Citrix ADC Authvserver Information resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
user_managed |
|
Read-write | User Managed Idenfication. |
ns_ip_address |
|
Read-write | Citrix ADC IP Address.
Minimum length = 1 Maximum length = 64 |
name |
|
Read-write | Vserver Name.
Minimum length = 1 Maximum length = 100 |
export_list |
|
Read-write | Export List present for the given LB VServer. |
id |
|
Read-write | Id is system generated key. |
vsvr_ip_address |
|
Read-write | Vserver IP Address.
Minimum length = 1 Maximum length = 64 |
throughput |
|
Read-write | throughput value. |
icalog |
|
Read-write | ICA log. |
appflow_policy_rule |
|
Read-write | AppFlow policy rule present. |
es4nslog |
|
Read-write | ESNS enable. |
transport_mode |
|
Read-write | Transport type - IPFix or LogStream. |
hostname |
|
Read-write | Hostname of the managed device.
Minimum length = 1 Maximum length = 256 |
instance_license |
|
Read-write | Feature License for Citrix ADC Instance, needs to be set while provisioning (standard, enterprise, platinum).
Minimum length = 1 Maximum length = 64 |
agent_list |
|
Read-write | Agent List, on which traffic will flow. |
export_option |
|
Read-write | Export Options present for the given LB VServer. |
appflowlog_effective |
|
Read-write | Appflowlog effective (validating AppFlow config) enabled or disabled. |
appflowlog |
|
Read-write | Appflowlog enabled or disabled. |
csvip_name |
|
Read-write | CSVIP Name. |
svc_id |
|
Read-write | Service ID. |
is_throughput_req |
|
Read-write | Throghput required. |
save_config |
|
Read-write | Save configuration after enable/disable. |
svc_name |
|
Read-write | Service Name. |
svc_grp_name |
|
Read-write | Service Group Name. |
svc_grp_id |
|
Read-write | Service Group ID. |
is_bot_policy_bound |
|
Read-write | Is Bot Policy bound to vserver.. |
csvip_id |
|
Read-write | CSVIP ID. |
app_security |
|
Read-write | App Security to know whether bot and appfw policies are bound.. |
is_appfw_policy_bound |
|
Read-write | Is Appfw Policy bound to vserver.. |
targetlbvserver |
|
Read-only | Default Target LBVserver. |
hits |
|
Read-only | Traffic Domain. |
license_type |
|
Read-only | License Type : 0 - not licensed, 1 - manual, 2 - vpx, 3 - cpx, 4 - auto, 5 - cpx-sidecar/free. |
state |
|
Read-only | State of VServer. |
cachetype |
|
Read-only | Cache Type. |
device_type |
|
Read-only | Device Type : vpx, cpx, sdwan, blx, cpx-sidecar. |
display_name |
|
Read-only | Display Name of Vserver. |
comment |
|
Read-only | Vserver comment. |
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_authenticationvserver?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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ns_authenticationvserver": {
<b>"id":<String_value></b>,
"user_managed":<Boolean_value>,
"ns_ip_address":<String_value>,
"csvip_name":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"svc_id":<String_value>,
"is_throughput_req":<Boolean_value>,
"save_config":<Boolean_value>,
"svc_grp_name":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"is_bot_policy_bound":<Boolean_value>,
"csvip_id":<String_value>,
"icalog":<String_value>,
"appflow_policy_rule":<String_value>,
"es4nslog":<String_value>,
"transport_mode":<String_value>,
"hostname":<String_value>,
"svc_name":<String_value>,
"instance_license":<String_value>,
"agent_list":<String_value>,
"export_option":<String_value>,
"svc_grp_id":<String_value>,
"app_security":<String_value>,
"appflowlog_effective":<String_value>,
"is_appfw_policy_bound":<Boolean_value>,
"appflowlog":<String_value>}}
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_authenticationvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"targetlbvserver":<String_value>,
"hits":<String_value>,
"license_type":<Integer_value>,
"persistencetype":<String_value>,
"id":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"type_vserver":<String_value>,
"icalog":<String_value>,
"appflow_policy_rule":<String_value>,
"vsvr_max_users":<String_value>,
"es4nslog":<String_value>,
"cursrvrconnections":<Double_value>,
"parent_app_id":<String_value>,
"parent_app_name":<String_value>,
"transport_mode":<String_value>,
"hostname":<String_value>,
"vsvr_type":<String_value>,
"vsvr_cur_users":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"managed":<Boolean_value>,
"instance_license":<String_value>,
"vsvr_state":<String_value>,
"state":<String_value>,
"cachetype":<String_value>,
"agent_list":<String_value>,
"device_type":<String_value>,
"export_option":<String_value>,
"poll_time":<Integer_value>,
"lbmethod":<String_value>,
"appflowlog_effective":<String_value>,
"activeservices":<String_value>,
"appflowlog":<String_value>,
"display_name":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"csvip_name":<String_value>,
"svc_id":<String_value>,
"is_throughput_req":<Boolean_value>,
"save_config":<Boolean_value>,
"svc_name":<String_value>,
"svc_grp_name":<String_value>,
"svc_grp_id":<String_value>,
"is_bot_policy_bound":<Boolean_value>,
"csvip_id":<String_value>,
"app_security":<String_value>,
"is_appfw_policy_bound":<Boolean_value>}]}
poll
URL: https://<MGMT-IP>/nitro/v2/config/ns_authenticationvserver?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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ns_authenticationvserver": {
<b>"id":<String_value></b>,
"user_managed":<Boolean_value>,
"ns_ip_address":<String_value>,
"csvip_name":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"svc_id":<String_value>,
"is_throughput_req":<Boolean_value>,
"save_config":<Boolean_value>,
"svc_grp_name":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"is_bot_policy_bound":<Boolean_value>,
"csvip_id":<String_value>,
"icalog":<String_value>,
"appflow_policy_rule":<String_value>,
"es4nslog":<String_value>,
"transport_mode":<String_value>,
"hostname":<String_value>,
"svc_name":<String_value>,
"instance_license":<String_value>,
"agent_list":<String_value>,
"export_option":<String_value>,
"svc_grp_id":<String_value>,
"app_security":<String_value>,
"appflowlog_effective":<String_value>,
"is_appfw_policy_bound":<Boolean_value>,
"appflowlog":<String_value>}}
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_authenticationvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"targetlbvserver":<String_value>,
"hits":<String_value>,
"license_type":<Integer_value>,
"persistencetype":<String_value>,
"id":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"type_vserver":<String_value>,
"icalog":<String_value>,
"appflow_policy_rule":<String_value>,
"vsvr_max_users":<String_value>,
"es4nslog":<String_value>,
"cursrvrconnections":<Double_value>,
"parent_app_id":<String_value>,
"parent_app_name":<String_value>,
"transport_mode":<String_value>,
"hostname":<String_value>,
"vsvr_type":<String_value>,
"vsvr_cur_users":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"managed":<Boolean_value>,
"instance_license":<String_value>,
"vsvr_state":<String_value>,
"state":<String_value>,
"cachetype":<String_value>,
"agent_list":<String_value>,
"device_type":<String_value>,
"export_option":<String_value>,
"poll_time":<Integer_value>,
"lbmethod":<String_value>,
"appflowlog_effective":<String_value>,
"activeservices":<String_value>,
"appflowlog":<String_value>,
"display_name":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"csvip_name":<String_value>,
"svc_id":<String_value>,
"is_throughput_req":<Boolean_value>,
"save_config":<Boolean_value>,
"svc_name":<String_value>,
"svc_grp_name":<String_value>,
"svc_grp_id":<String_value>,
"is_bot_policy_bound":<Boolean_value>,
"csvip_id":<String_value>,
"app_security":<String_value>,
"is_appfw_policy_bound":<Boolean_value>}]}
get
URL: https://<MGMT-IP>/nitro/v2/config/ns_authenticationvserver HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
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 Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_authenticationvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"targetlbvserver":<String_value>,
"hits":<String_value>,
"license_type":<Integer_value>,
"persistencetype":<String_value>,
"id":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"type_vserver":<String_value>,
"icalog":<String_value>,
"appflow_policy_rule":<String_value>,
"vsvr_max_users":<String_value>,
"es4nslog":<String_value>,
"cursrvrconnections":<Double_value>,
"parent_app_id":<String_value>,
"parent_app_name":<String_value>,
"transport_mode":<String_value>,
"hostname":<String_value>,
"vsvr_type":<String_value>,
"vsvr_cur_users":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"managed":<Boolean_value>,
"instance_license":<String_value>,
"vsvr_state":<String_value>,
"state":<String_value>,
"cachetype":<String_value>,
"agent_list":<String_value>,
"device_type":<String_value>,
"export_option":<String_value>,
"poll_time":<Integer_value>,
"lbmethod":<String_value>,
"appflowlog_effective":<String_value>,
"activeservices":<String_value>,
"appflowlog":<String_value>,
"display_name":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"csvip_name":<String_value>,
"svc_id":<String_value>,
"is_throughput_req":<Boolean_value>,
"save_config":<Boolean_value>,
"svc_name":<String_value>,
"svc_grp_name":<String_value>,
"svc_grp_id":<String_value>,
"is_bot_policy_bound":<Boolean_value>,
"csvip_id":<String_value>,
"app_security":<String_value>,
"is_appfw_policy_bound":<Boolean_value>}]}
disable
URL: https://<MGMT-IP>/nitro/v2/config/ns_authenticationvserver?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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ns_authenticationvserver": {
<b>"id":<String_value></b>,
"user_managed":<Boolean_value>,
"ns_ip_address":<String_value>,
"csvip_name":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"svc_id":<String_value>,
"is_throughput_req":<Boolean_value>,
"save_config":<Boolean_value>,
"svc_grp_name":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"is_bot_policy_bound":<Boolean_value>,
"csvip_id":<String_value>,
"icalog":<String_value>,
"appflow_policy_rule":<String_value>,
"es4nslog":<String_value>,
"transport_mode":<String_value>,
"hostname":<String_value>,
"svc_name":<String_value>,
"instance_license":<String_value>,
"agent_list":<String_value>,
"export_option":<String_value>,
"svc_grp_id":<String_value>,
"app_security":<String_value>,
"appflowlog_effective":<String_value>,
"is_appfw_policy_bound":<Boolean_value>,
"appflowlog":<String_value>}}
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_authenticationvserver":[{
"user_managed":<Boolean_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"name":<String_value>,
"export_list":<String_value>,
"targetlbvserver":<String_value>,
"hits":<String_value>,
"license_type":<Integer_value>,
"persistencetype":<String_value>,
"id":<String_value>,
"vsvr_ip_address":<String_value>,
"throughput":<Double_value>,
"type_vserver":<String_value>,
"icalog":<String_value>,
"appflow_policy_rule":<String_value>,
"vsvr_max_users":<String_value>,
"es4nslog":<String_value>,
"cursrvrconnections":<Double_value>,
"parent_app_id":<String_value>,
"parent_app_name":<String_value>,
"transport_mode":<String_value>,
"hostname":<String_value>,
"vsvr_type":<String_value>,
"vsvr_cur_users":<String_value>,
"vsvr_state_timestamp":<Double_value>,
"totalservices":<String_value>,
"vsvr_port":<Integer_value>,
"vsvr_health":<Integer_value>,
"managed":<Boolean_value>,
"instance_license":<String_value>,
"vsvr_state":<String_value>,
"state":<String_value>,
"cachetype":<String_value>,
"agent_list":<String_value>,
"device_type":<String_value>,
"export_option":<String_value>,
"poll_time":<Integer_value>,
"lbmethod":<String_value>,
"appflowlog_effective":<String_value>,
"activeservices":<String_value>,
"appflowlog":<String_value>,
"display_name":<String_value>,
"comment":<String_value>,
"partition_name":<String_value>,
"csvip_name":<String_value>,
"svc_id":<String_value>,
"is_throughput_req":<Boolean_value>,
"save_config":<Boolean_value>,
"svc_name":<String_value>,
"svc_grp_name":<String_value>,
"svc_grp_id":<String_value>,
"is_bot_policy_bound":<Boolean_value>,
"csvip_id":<String_value>,
"app_security":<String_value>,
"is_appfw_policy_bound":<Boolean_value>}]}