application
Configuration for Applications Managed by Management System resource.
Related information
Configuration
aa_ind_details_l2adc_application_summaryanomaly_detailsanomaly_eventsanomaly_summaryapp_categoryapp_deviceapp_infoapp_service_graph_node_edgesapp_template_infoApplicationsappscore_factorappscore_threshold_configauthorized_applicationglobal_service_graph_config_mappingglobal_service_graph_node_edgesjob_triggersecurity_app_dashboard_detailsswg_domain_summaryswg_ssl_detailsswg_trans_detailsswg_user_detailsswg_user_summary
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| app_category | <String> | Read-write | Application Category. Minimum length = 1 Maximum length = 255 |
| curclntconnections | <Double> | Read-write | curclntconnections Value across all vips of the app. |
| ns_ip_address | <String> | Read-write | ns_ip_address. |
| svr_name_criteria | <String> | Read-write | svr_name_criteria. Maximum length = 4096 |
| application_managed | <Boolean> | Read-write | Managed field. |
| throughput_avg | <Double> | Read-write | Sum of throughput across all vips of the app. |
| svc_port_criteria | <String> | Read-write | svc_port_criteria. Maximum length = 4096 |
| vsvr_name_criteria | <String> | Read-write | vsvr_name_criteria. Maximum length = 4096 |
| vsvc_port_criteria | <String> | Read-write | vsvc_port_criteria. Maximum length = 4096 |
| svr_ip_address_criteria | <String> | Read-write | svr_ip_address_criteria. Maximum length = 4096 |
| name | <String> | Read-write | Application Name. Minimum length = 1 Maximum length = 1024 |
| cursrvrconnections | <Double> | Read-write | cursrvrconnections Value across all vips of the app. |
| vsvr_ip_address_criteria | <String> | Read-write | vsvr_ip_address_criteria. Maximum length = 4096 |
| app_type | <Integer> | Read-write | Application Type - 0: HMCUserDefined, 1: HMCAutoGenerated, 2: CNN App. |
| family | <String> | Read-write | Application Family. Minimum length = 1 Maximum length = 255 |
| configpack_id | <String> | Read-write | Config pack Id.. |
| is_migration | <Boolean> | Read-write | is_migration. |
| app_info_required | <Boolean> | Read-write | app_info_required. |
| no_of_auth | <String> | Read-write | Number of AUTH VIPs. |
| no_of_gslb | <String> | Read-write | Number of GSLB VIPs. |
| no_of_gslbsvc | <String> | Read-write | Number of LB VIPs. |
| no_of_cr | <String> | Read-write | Number of CR 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. |
| vsvr_app_components | <app_component[]> | Read-write | Application components. |
| no_of_haproxy_be | <String> | Read-write | Number of Banckends. |
| force_delete | <Boolean> | Read-write | force delete. |
| no_of_svr | <String> | Read-write | Number of Servers. |
| stylebook_params | <String> | Read-write | Stylebook Parameter. |
| no_of_lb | <String> | Read-write | Number of LB VIPs. |
| no_of_vpn | <String> | Read-write | Number of VPN VIPs. |
| no_of_haproxy_fe | <String> | Read-write | Number of Frontends. |
| application_ids | <String[]> | Read-write | Application IDs that are part of this application. |
| tenant_id | <String> | Read-only | Tenant Id. |
| id | <String> | Read-only | Id is system generated key.. |
| tenant_name | <String> | Read-only | Tenant Name. |
| user_name | <String> | Read-only | User Name. |
| application_class | <String> | Read-only | Application class. |
| 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=yesIf 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
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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"application": {
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"no_of_cs":<String_value>,
"application_managed":<Boolean_value>,
"no_of_svcgrp":<String_value>,
"vsvr_name_criteria":<String_value>,
"name":<String_value>,
"vsvr_ip_address_criteria":<String_value>,
"no_of_vpn":<String_value>,
"no_of_lb":<String_value>,
"no_of_haproxy_fe":<String_value>,
"family":<String_value>,
"no_of_cr":<String_value>,
"svc_port_criteria":<String_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"app_type":<Integer_value>,
"app_category":<String_value>,
"app_info_required":<Boolean_value>,
"svr_name_criteria":<String_value>,
"no_of_gslb":<String_value>,
"no_of_auth":<String_value>,
"no_of_gslbsvc":<String_value>,
"throughput_avg":<Double_value>,
"vsvr_app_components":[{
"ns_ip_address":<String_value>,
"name":<String_value>,
"state":<String_value>,
"id":<String_value>,
"vsvr_ip_address":<String_value>,
"type":<String_value>}],
"svr_ip_address_criteria":<String_value>,
"is_migration":<Boolean_value>,
"no_of_svc":<String_value>,
"vsvc_port_criteria":<String_value>,
"cursrvrconnections":<Double_value>,
"no_of_svr":<String_value>,
"application_ids":<String_value[]>,
"configpack_id":<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, "application":[{
"app_category":<String_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"svr_name_criteria":<String_value>,
"tenant_id":<String_value>,
"application_managed":<Boolean_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"throughput_avg":<Double_value>,
"svc_port_criteria":<String_value>,
"vsvr_name_criteria":<String_value>,
"vsvc_port_criteria":<String_value>,
"svr_ip_address_criteria":<String_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"user_name":<String_value>,
"application_class":<String_value>,
"vsvr_ip_address_criteria":<String_value>,
"app_type":<Integer_value>,
"family":<String_value>,
"configpack_id":<String_value>,
"is_migration":<Boolean_value>,
"app_info_required":<Boolean_value>,
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_gslbsvc":<String_value>,
"no_of_cr":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"vsvr_app_components":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_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>}]}
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>
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 Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }
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>
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, "application":[{
"app_category":<String_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"svr_name_criteria":<String_value>,
"tenant_id":<String_value>,
"application_managed":<Boolean_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"throughput_avg":<Double_value>,
"svc_port_criteria":<String_value>,
"vsvr_name_criteria":<String_value>,
"vsvc_port_criteria":<String_value>,
"svr_ip_address_criteria":<String_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"user_name":<String_value>,
"application_class":<String_value>,
"vsvr_ip_address_criteria":<String_value>,
"app_type":<Integer_value>,
"family":<String_value>,
"configpack_id":<String_value>,
"is_migration":<Boolean_value>,
"app_info_required":<Boolean_value>,
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_gslbsvc":<String_value>,
"no_of_cr":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"vsvr_app_components":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_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>}]}
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>
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, "application":[{
"app_category":<String_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"svr_name_criteria":<String_value>,
"tenant_id":<String_value>,
"application_managed":<Boolean_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"throughput_avg":<Double_value>,
"svc_port_criteria":<String_value>,
"vsvr_name_criteria":<String_value>,
"vsvc_port_criteria":<String_value>,
"svr_ip_address_criteria":<String_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"user_name":<String_value>,
"application_class":<String_value>,
"vsvr_ip_address_criteria":<String_value>,
"app_type":<Integer_value>,
"family":<String_value>,
"configpack_id":<String_value>,
"is_migration":<Boolean_value>,
"app_info_required":<Boolean_value>,
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_gslbsvc":<String_value>,
"no_of_cr":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"vsvr_app_components":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_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>}]}
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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"application":{
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"no_of_cs":<String_value>,
"application_managed":<Boolean_value>,
"no_of_svcgrp":<String_value>,
"vsvr_name_criteria":<String_value>,
"name":<String_value>,
"vsvr_ip_address_criteria":<String_value>,
"no_of_vpn":<String_value>,
"no_of_lb":<String_value>,
"no_of_haproxy_fe":<String_value>,
"family":<String_value>,
"no_of_cr":<String_value>,
"svc_port_criteria":<String_value>,
"no_of_haproxy_be":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"app_type":<Integer_value>,
"app_category":<String_value>,
"app_info_required":<Boolean_value>,
"svr_name_criteria":<String_value>,
"no_of_gslb":<String_value>,
"no_of_auth":<String_value>,
"no_of_gslbsvc":<String_value>,
"throughput_avg":<Double_value>,
"vsvr_app_components":[{
"ns_ip_address":<String_value>,
"name":<String_value>,
"state":<String_value>,
"id":<String_value>,
"vsvr_ip_address":<String_value>,
"type":<String_value>}],
"svr_ip_address_criteria":<String_value>,
"is_migration":<Boolean_value>,
"no_of_svc":<String_value>,
"vsvc_port_criteria":<String_value>,
"cursrvrconnections":<Double_value>,
"no_of_svr":<String_value>,
"application_ids":<String_value[]>,
"configpack_id":<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, "application":[{
"app_category":<String_value>,
"curclntconnections":<Double_value>,
"ns_ip_address":<String_value>,
"svr_name_criteria":<String_value>,
"tenant_id":<String_value>,
"application_managed":<Boolean_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"throughput_avg":<Double_value>,
"svc_port_criteria":<String_value>,
"vsvr_name_criteria":<String_value>,
"vsvc_port_criteria":<String_value>,
"svr_ip_address_criteria":<String_value>,
"name":<String_value>,
"cursrvrconnections":<Double_value>,
"user_name":<String_value>,
"application_class":<String_value>,
"vsvr_ip_address_criteria":<String_value>,
"app_type":<Integer_value>,
"family":<String_value>,
"configpack_id":<String_value>,
"is_migration":<Boolean_value>,
"app_info_required":<Boolean_value>,
"no_of_auth":<String_value>,
"no_of_gslb":<String_value>,
"no_of_gslbsvc":<String_value>,
"no_of_cr":<String_value>,
"act_id":<String_value>,
"no_of_cs":<String_value>,
"no_of_svc":<String_value>,
"no_of_svcgrp":<String_value>,
"vsvr_app_components":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_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>}]}