Skip to content

ns_application

Configuration for Applications Managed by Management System resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
curclntconnections<Double>Read-writecurclntconnections Value across all vips of the app.
name<String>Read-writeApplication Name.
Maximum length = 1024
id<String>Read-writeId is system generated key..
app_criteria<criteria[]>Read-writeApplication criteria.
cursrvrconnections<Double>Read-writecursrvrconnections Value across all vips of the app.
configpack_id<String>Read-writeConfig pack Id..
application_managed<Boolean>Read-writeManaged field.
family<String>Read-writeApplication Family.
Minimum length = 1
Maximum length = 255
app_category<String>Read-writeApplication Category.
Minimum length = 1
Maximum length = 255
throughput_avg<Double>Read-writeSum of throughput across all vips of the app.
app_components<authorized_scope_app[]>Read-writeApplication components.
no_of_auth<String>Read-writeNumber of AUTH VIPs.
no_of_gslb<String>Read-writeNumber of GSLB VIPs.
no_of_cr<String>Read-writeNumber of CR VIPs.
no_of_gslbsvc<String>Read-writeNumber of LB VIPs.
no_of_cs<String>Read-writeNumber of CS VIPs.
no_of_svc<String>Read-writeNumber of Services.
no_of_svcgrp<String>Read-writeNumber of Service Groups.
no_of_haproxy_be<String>Read-writeNumber of Banckends.
force_delete<Boolean>Read-writeforce delete.
stylebook_params<String>Read-writeStylebook Parameter.
no_of_svr<String>Read-writeNumber of Servers.
no_of_vpn<String>Read-writeNumber of VPN VIPs.
no_of_lb<String>Read-writeNumber of LB VIPs.
application_ids<String[]>Read-writeApplication IDs that are part of this application.
no_of_haproxy_fe<String>Read-writeNumber of Frontends.
application_class<String>Read-onlyApplication class.
tenant_name<String>Read-onlyTenant Name.
tenant_id<String>Read-onlyTenant Id.
user_name<String>Read-onlyUser Name.
act_id<String>Read-onlyActivity 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>}]}