managed_app
Configuration for Managed Application resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| app_networking_data | <String> | Read-write | app networking blob that can be used by placement logic. |
| is_app_placed | <Boolean> | Read-write | 1 if app is placed on some NS, else 0.. |
| lb_role | <String> | Read-write | Application is applied only on the devices with the same Lb role. |
| container_manager | <String> | Read-write | Container orchestration system. |
| app_id | <String> | Read-write | Id for the managed application. |
| app_netfuncs_config | <network_function_config[]> | Read-write | Network function related config for the application. |
| networking_manager | <String> | Read-write | System used to setup the network. |
| app_dns | <String> | Read-write | Doman name service for Application. |
| appname | <String> | Read-write | Name of the Application. |
| dns_manager | <String> | Read-write | Domain Name Service manager. |
| id | <String> | Read-write | Dummy Id needed for input get requests. |
Operations
(click to see Properties)
ADD| DELETE| GET (ALL)| MODIFY
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/managed_app?onerror=<String_value>
HTTP Method: null
Request Payload:
{managed_app: {
"is_app_placed":<Boolean_value>,
"container_manager":<String_value>,
"networking_manager":<String_value>,
"app_netfuncs_config":[{
"parent_id":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"type":<String_value>,
"netfunc_params":<network_function_param_value>}],
"id":<String_value>,
"app_networking_data":<String_value>,
"app_id":<String_value>,
"app_dns":<String_value>,
"appname":<String_value>,
"dns_manager":<String_value>,
"lb_role":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "managed_app":[{
"app_networking_data":<String_value>,
"is_app_placed":<Boolean_value>,
"lb_role":<String_value>,
"container_manager":<String_value>,
"app_id":<String_value>,
"app_netfuncs_config":[{
"parent_name":<String_value>,
"netfunc_params":<network_function_param_value>,
"type":<String_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"networking_manager":<String_value>,
"app_dns":<String_value>,
"appname":<String_value>,
"dns_manager":<String_value>,
"id":<String_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/managed_app/app_id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/managed_app
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "managed_app":[{
"app_networking_data":<String_value>,
"is_app_placed":<Boolean_value>,
"lb_role":<String_value>,
"container_manager":<String_value>,
"app_id":<String_value>,
"app_netfuncs_config":[{
"parent_name":<String_value>,
"netfunc_params":<network_function_param_value>,
"type":<String_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"networking_manager":<String_value>,
"app_dns":<String_value>,
"appname":<String_value>,
"dns_manager":<String_value>,
"id":<String_value>}]}
modify
URL: https://<MGMT-IP>/nitro/v1/config/managed_app/app_id_value<String>
HTTP Method: null
Request Payload:
{managed_app:{
<b>"app_id":<String_value></b>,
"is_app_placed":<Boolean_value>,
"container_manager":<String_value>,
"networking_manager":<String_value>,
"app_netfuncs_config":[{
"parent_id":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"type":<String_value>,
"netfunc_params":<network_function_param_value>}],
"id":<String_value>,
"app_networking_data":<String_value>,
"app_dns":<String_value>,
"appname":<String_value>,
"dns_manager":<String_value>,
"lb_role":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "managed_app":[{
"app_networking_data":<String_value>,
"is_app_placed":<Boolean_value>,
"lb_role":<String_value>,
"container_manager":<String_value>,
"app_id":<String_value>,
"app_netfuncs_config":[{
"parent_name":<String_value>,
"netfunc_params":<network_function_param_value>,
"type":<String_value>,
"id":<String_value>,
"parent_id":<String_value>}],
"networking_manager":<String_value>,
"app_dns":<String_value>,
"appname":<String_value>,
"dns_manager":<String_value>,
"id":<String_value>}]}