ns_application
Configuration for Applications Managed by Management System resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| curclntconnections | <Double> | Read-write | curclntconnections Value across all vips of the app. |
| name | <String> | Read-write | Application Name. Maximum length = 1024 |
| id | <String> | Read-write | Id is system generated key.. |
| app_criteria | <criteria[]> | Read-write | Application criteria. |
| cursrvrconnections | <Double> | Read-write | cursrvrconnections Value across all vips of the app. |
| configpack_id | <String> | Read-write | Config pack Id.. |
| application_managed | <Boolean> | Read-write | Managed field. |
| family | <String> | Read-write | Application Family. Minimum length = 1 Maximum length = 255 |
| app_category | <String> | Read-write | Application Category. Minimum length = 1 Maximum length = 255 |
| throughput_avg | <Double> | Read-write | Sum of throughput across all vips of the app. |
| app_components | <authorized_scope_app[]> | Read-write | Application components. |
| no_of_auth | <String> | Read-write | Number of AUTH VIPs. |
| no_of_gslb | <String> | Read-write | Number of GSLB VIPs. |
| no_of_cr | <String> | Read-write | Number of CR VIPs. |
| no_of_gslbsvc | <String> | Read-write | Number of LB VIPs. |
| no_of_cs | <String> | Read-write | Number of CS VIPs. |
| no_of_svc | <String> | Read-write | Number of Services. |
| no_of_svcgrp | <String> | Read-write | Number of Service Groups. |
| no_of_haproxy_be | <String> | Read-write | Number of Banckends. |
| force_delete | <Boolean> | Read-write | force delete. |
| stylebook_params | <String> | Read-write | Stylebook Parameter. |
| no_of_svr | <String> | Read-write | Number of Servers. |
| no_of_vpn | <String> | Read-write | Number of VPN VIPs. |
| no_of_lb | <String> | Read-write | Number of LB VIPs. |
| application_ids | <String[]> | Read-write | Application IDs that are part of this application. |
| no_of_haproxy_fe | <String> | Read-write | Number of Frontends. |
| application_class | <String> | Read-only | Application class. |
| tenant_name | <String> | Read-only | Tenant Name. |
| tenant_id | <String> | Read-only | Tenant Id. |
| user_name | <String> | Read-only | User Name. |
| act_id | <String> | Read-only | Activity Id. |
Operations
(click to see Properties)
ADD| DELETE| GET (ALL)| GET| UPDATE
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>.
add
URL: https://<MGMT-IP>/nitro/v1/config/ns_application?onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_application: {
"app_category":<String_value>,
"curclntconnections":<Double_value>,
"no_of_gslb":<String_value>,
"no_of_auth":<String_value>,
"no_of_gslbsvc":<String_value>,
"no_of_cr":<String_value>,
"no_of_cs":<String_value>,
"application_managed":<Boolean_value>,
"id":<String_value>,
"no_of_svc":<String_value>,
"app_criteria":[{
"criteria_condn":<String_value>,
"parent_id":<String_value>,
"id":<String_value>,
"criteria_value":<String_value>,
"parent_name":<String_value>,
"criteria_type":<String_value>}],
"no_of_svcgrp":<String_value>,
"throughput_avg":<Double_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"no_of_svr":<String_value>,
"stylebook_params":<String_value>,
"no_of_lb":<String_value>,
"no_of_vpn":<String_value>,
"no_of_haproxy_fe":<String_value>,
"application_ids":<String_value[]>,
"app_components":[{
"parent_id":<String_value>,
"appname":<String_value>,
"id":<String_value>,
"config_path":<String_value>,
"parent_name":<String_value>,
"app_state":<String_value>,
"app_protocol":<String_value>,
"device_ip_address":<String_value>,
"app_ip_address":<String_value>,
"app_type":<String_value>,
"entity_id":<String_value>}],
"family":<String_value>,
"configpack_id":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_application":[{
"curclntconnections":<Double_value>,
"name":<String_value>,
"application_class":<String_value>,
"id":<String_value>,
"app_criteria":[{
"parent_name":<String_value>,
"criteria_type":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"criteria_value":<String_value>,
"criteria_condn":<String_value>}],
"tenant_name":<String_value>,
"cursrvrconnections":<Double_value>,
"configpack_id":<String_value>,
"application_managed":<Boolean_value>,
"family":<String_value>,
"tenant_id":<String_value>,
"app_category":<String_value>,
"throughput_avg":<Double_value>,
"user_name":<String_value>,
"app_components":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_cr":<String_value>,
"no_of_gslbsvc":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"no_of_svr":<String_value>,
"no_of_vpn":<String_value>,
"no_of_lb":<String_value>,
"application_ids":<String_value>,
"no_of_haproxy_fe":<String_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/ns_application/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/ns_application
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_application":[{
"curclntconnections":<Double_value>,
"name":<String_value>,
"application_class":<String_value>,
"id":<String_value>,
"app_criteria":[{
"parent_name":<String_value>,
"criteria_type":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"criteria_value":<String_value>,
"criteria_condn":<String_value>}],
"tenant_name":<String_value>,
"cursrvrconnections":<Double_value>,
"configpack_id":<String_value>,
"application_managed":<Boolean_value>,
"family":<String_value>,
"tenant_id":<String_value>,
"app_category":<String_value>,
"throughput_avg":<Double_value>,
"user_name":<String_value>,
"app_components":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_cr":<String_value>,
"no_of_gslbsvc":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"no_of_svr":<String_value>,
"no_of_vpn":<String_value>,
"no_of_lb":<String_value>,
"application_ids":<String_value>,
"no_of_haproxy_fe":<String_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/ns_application/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_application":[{
"curclntconnections":<Double_value>,
"name":<String_value>,
"application_class":<String_value>,
"id":<String_value>,
"app_criteria":[{
"parent_name":<String_value>,
"criteria_type":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"criteria_value":<String_value>,
"criteria_condn":<String_value>}],
"tenant_name":<String_value>,
"cursrvrconnections":<Double_value>,
"configpack_id":<String_value>,
"application_managed":<Boolean_value>,
"family":<String_value>,
"tenant_id":<String_value>,
"app_category":<String_value>,
"throughput_avg":<Double_value>,
"user_name":<String_value>,
"app_components":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_cr":<String_value>,
"no_of_gslbsvc":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"no_of_svr":<String_value>,
"no_of_vpn":<String_value>,
"no_of_lb":<String_value>,
"application_ids":<String_value>,
"no_of_haproxy_fe":<String_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/ns_application/id_value<String>
HTTP Method: null
Request Payload:
{ns_application:{
"app_category":<String_value>,
"curclntconnections":<Double_value>,
"no_of_gslb":<String_value>,
"no_of_auth":<String_value>,
"no_of_gslbsvc":<String_value>,
"no_of_cr":<String_value>,
"no_of_cs":<String_value>,
"application_managed":<Boolean_value>,
"id":<String_value>,
"no_of_svc":<String_value>,
"app_criteria":[{
"criteria_condn":<String_value>,
"parent_id":<String_value>,
"id":<String_value>,
"criteria_value":<String_value>,
"parent_name":<String_value>,
"criteria_type":<String_value>}],
"no_of_svcgrp":<String_value>,
"throughput_avg":<Double_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"no_of_svr":<String_value>,
"stylebook_params":<String_value>,
"no_of_lb":<String_value>,
"no_of_vpn":<String_value>,
"no_of_haproxy_fe":<String_value>,
"application_ids":<String_value[]>,
"app_components":[{
"parent_id":<String_value>,
"appname":<String_value>,
"id":<String_value>,
"config_path":<String_value>,
"parent_name":<String_value>,
"app_state":<String_value>,
"app_protocol":<String_value>,
"device_ip_address":<String_value>,
"app_ip_address":<String_value>,
"app_type":<String_value>,
"entity_id":<String_value>}],
"family":<String_value>,
"configpack_id":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_application":[{
"curclntconnections":<Double_value>,
"name":<String_value>,
"application_class":<String_value>,
"id":<String_value>,
"app_criteria":[{
"parent_name":<String_value>,
"criteria_type":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"criteria_value":<String_value>,
"criteria_condn":<String_value>}],
"tenant_name":<String_value>,
"cursrvrconnections":<Double_value>,
"configpack_id":<String_value>,
"application_managed":<Boolean_value>,
"family":<String_value>,
"tenant_id":<String_value>,
"app_category":<String_value>,
"throughput_avg":<Double_value>,
"user_name":<String_value>,
"app_components":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_cr":<String_value>,
"no_of_gslbsvc":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"no_of_svr":<String_value>,
"no_of_vpn":<String_value>,
"no_of_lb":<String_value>,
"application_ids":<String_value>,
"no_of_haproxy_fe":<String_value>}]}