application

Configuration for Applications Managed by Management System resource.

Read/write properties

configpack_id<String>

Config pack Id..

vsvr_ip_address_criteria<String>

vsvr_ip_address_criteria.
Maximum length = 4096

throughput_avg<Double>

Sum of throughput across all vips of the app.

application_managed<Boolean>

Managed field.

svr_ip_address_criteria<String>

svr_ip_address_criteria.
Maximum length = 4096

name<String>

Application Name.
Minimum length = 1
Maximum length = 1024

ns_ip_address<String>

ns_ip_address.

app_category<String>

Application Category.
Minimum length = 1
Maximum length = 255

curclntconnections<Double>

curclntconnections Value across all vips of the app.

vsvc_port_criteria<String>

vsvc_port_criteria.
Maximum length = 4096

tags<String>

Tags associated with application.

family<String>

Application Family.
Minimum length = 1
Maximum length = 255

svc_port_criteria<String>

svc_port_criteria.
Maximum length = 4096

app_type<Integer>

Application Type - 0: HMCUserDefined, 1: HMCAutoGenerated, 2: CNN App.

cursrvrconnections<Double>

cursrvrconnections Value across all vips of the app.

svr_name_criteria<String>

svr_name_criteria.
Maximum length = 4096

vsvr_name_criteria<String>

vsvr_name_criteria.
Maximum length = 4096

no_of_svcgrp<String>

Number of Service Groups.

vsvr_app_components<app_component[]>

Application components.

no_of_vpn<String>

Number of VPN VIPs.

no_of_lb<String>

Number of LB VIPs.

app_info_required<Boolean>

app_info_required.

app_name_references_array<String[]>

All application names separated by comma that are referenced by this custom application.

no_of_svr<String>

Number of Servers.

no_of_auth<String>

Number of AUTH VIPs.

no_of_gslbsvc<String>

Number of LB VIPs.

no_of_svc<String>

Number of Services.

no_of_gslb<String>

Number of GSLB VIPs.

force_delete<Boolean>

force delete.

is_migration<Boolean>

is_migration.

stylebook_params<String>

Stylebook Parameter.

no_of_cr<String>

Number of CR VIPs.

no_of_cs<String>

Number of CS VIPs.

application_ids<String[]>

Application IDs that are part of this application.

Read only properties

tenant_id<String>

Tenant Id.

application_class<String>

Application class.

user_name<String>

User Name.

id<String>

Id is system generated key..

user_name_enc<String>

User Name.

tenant_name<String>

Tenant Name.

act_id<String>

Activity Id.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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

add update get (all)get delete

add

URL:https://<MGMT-IP>/nitro/v2/config/application?onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"application": {
      "vsvc_port_criteria":<String_value>,
      "app_category":<String_value>,
      "curclntconnections":<Double_value>,
      "tags":<String_value>,
      "cursrvrconnections":<Double_value>,
      "app_type":<Integer_value>,
      "vsvr_name_criteria":<String_value>,
      "no_of_cr":<String_value>,
      "vsvr_ip_address_criteria":<String_value>,
      "configpack_id":<String_value>,
      "no_of_svc":<String_value>,
      "throughput_avg":<Double_value>,
      "force_delete":<Boolean_value>,
      "app_info_required":<Boolean_value>,
      "svr_ip_address_criteria":<String_value>,
      "app_name_references_array":<String_value[]>,
      "name":<String_value>,
      "vsvr_app_components":[{
      "client_header":<String_value>,
      "vsvr_ip_address":<String_value>,
      "id":<String_value>,
      "name":<String_value>,
      "vsvr_type":<String_value>,
      "hostname":<String_value>,
      "type":<String_value>,
      "transaction_log_effective":<String_value>,
      "metrics_option":<String_value>,
      "state":<String_value>,
      "httpxforwardedfor":<String_value>,
      "ns_ip_address":<String_value>,
      "metrics_enabled":<Boolean_value>,
      "export_option":<String_value>}],
      "no_of_cs":<String_value>,
      "application_ids":<String_value[]>,
      "no_of_gslb":<String_value>,
      "stylebook_params":<String_value>,
      "svr_name_criteria":<String_value>,
      "family":<String_value>,
      "svc_port_criteria":<String_value>,
      "no_of_svr":<String_value>,
      "no_of_svcgrp":<String_value>,
      "is_migration":<Boolean_value>,
      "no_of_gslbsvc":<String_value>,
      "no_of_auth":<String_value>,
      "application_managed":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "no_of_vpn":<String_value>,
      "no_of_lb":<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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "application":[{
      "configpack_id":<String_value>,
      "vsvr_ip_address_criteria":<String_value>,
      "throughput_avg":<Double_value>,
      "customer_name":<String_value>,
      "tenant_id":<String_value>,
      "application_managed":<Boolean_value>,
      "application_class":<String_value>,
      "svr_ip_address_criteria":<String_value>,
      "name":<String_value>,
      "user_name":<String_value>,
      "ns_ip_address":<String_value>,
      "app_category":<String_value>,
      "id":<String_value>,
      "curclntconnections":<Double_value>,
      "vsvc_port_criteria":<String_value>,
      "tags":<String_value>,
      "user_name_enc":<String_value>,
      "family":<String_value>,
      "app_name_references":<String_value>,
      "svc_port_criteria":<String_value>,
      "app_type":<Integer_value>,
      "cursrvrconnections":<Double_value>,
      "svr_name_criteria":<String_value>,
      "parent_filters":<String_value>,
      "tenant_name":<String_value>,
      "vsvr_name_criteria":<String_value>,
      "no_of_svcgrp":<String_value>,
      "vsvr_app_components":[{
      "metrics_option":<String_value>,
      "configuration_path":<String_value>,
      "transaction_log_effective":<String_value>,
      "export_option":<String_value>,
      "id":<String_value>,
      "type":<String_value>,
      "metrics_enabled":<Boolean_value>,
      "vsvr_ip_address":<String_value>,
      "ns_ip_address":<String_value>,
      "httpxforwardedfor":<String_value>,
      "vsvr_type":<String_value>,
      "hostname":<String_value>,
      "display_name":<String_value>,
      "client_header":<String_value>,
      "state":<String_value>,
      "name":<String_value>}],
      "no_of_vpn":<String_value>,
      "no_of_lb":<String_value>,
      "app_info_required":<Boolean_value>,
      "app_name_references_array":<String_value>,
      "no_of_svr":<String_value>,
      "no_of_auth":<String_value>,
      "no_of_gslbsvc":<String_value>,
      "no_of_svc":<String_value>,
      "no_of_gslb":<String_value>,
      "force_delete":<Boolean_value>,
      "is_migration":<Boolean_value>,
      "stylebook_params":<String_value>,
      "no_of_cr":<String_value>,
      "no_of_cs":<String_value>,
      "application_ids":<String_value>,
      "act_id":<String_value>}]}

update

URL:https://<MGMT-IP>/nitro/v2/config/application/id_value<String>

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"application":{
      "stylebook_params":<String_value>,
      "no_of_gslb":<String_value>,
      "application_ids":<String_value[]>,
      "no_of_cs":<String_value>,
      "no_of_svcgrp":<String_value>,
      "family":<String_value>,
      "svc_port_criteria":<String_value>,
      "no_of_svr":<String_value>,
      "svr_name_criteria":<String_value>,
      "is_migration":<Boolean_value>,
      "no_of_lb":<String_value>,
      "no_of_vpn":<String_value>,
      "ns_ip_address":<String_value>,
      "no_of_gslbsvc":<String_value>,
      "no_of_auth":<String_value>,
      "application_managed":<Boolean_value>,
      "tags":<String_value>,
      "app_category":<String_value>,
      "curclntconnections":<Double_value>,
      "vsvc_port_criteria":<String_value>,
      "vsvr_name_criteria":<String_value>,
      "app_type":<Integer_value>,
      "cursrvrconnections":<Double_value>,
      "throughput_avg":<Double_value>,
      "force_delete":<Boolean_value>,
      "no_of_svc":<String_value>,
      "configpack_id":<String_value>,
      "vsvr_ip_address_criteria":<String_value>,
      "no_of_cr":<String_value>,
      "name":<String_value>,
      "vsvr_app_components":[{
      "client_header":<String_value>,
      "vsvr_ip_address":<String_value>,
      "id":<String_value>,
      "name":<String_value>,
      "vsvr_type":<String_value>,
      "hostname":<String_value>,
      "type":<String_value>,
      "transaction_log_effective":<String_value>,
      "metrics_option":<String_value>,
      "state":<String_value>,
      "httpxforwardedfor":<String_value>,
      "ns_ip_address":<String_value>,
      "metrics_enabled":<Boolean_value>,
      "export_option":<String_value>}],
      "app_name_references_array":<String_value[]>,
      "app_info_required":<Boolean_value>,
      "svr_ip_address_criteria":<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:JSON

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/application

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/application?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of application resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/application?pagesize=#no&pageno=#no

Use this query-parameter to get the application resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/application?count=yes

Use this query-parameter to get the count of application resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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:JSON

get

URL:https://<MGMT-IP>/nitro/v2/config/application/id_value<String>

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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:JSON

delete

URL:https://<MGMT-IP>/nitro/v2/config/application/id_value<String>

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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 Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }