cbwanopt
Configuration for CBWANOPT resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| gateway_deployment | <Boolean> | Read-write | Is this device acting as Gateway.. |
| std_bw_config | <Integer> | Read-write | Standard Bandwidth running. |
| gateway_ipv6 | <String> | Read-write | Gateway IPv6 Address. |
| instance_available | <Integer> | Read-write | Instance license available. |
| device_finger_print | <String> | Read-write | Fingerprint/thumb-print from UMS public certificate for SSL communication. |
| name | <String> | Read-write | Name of managed device. Minimum length = 1 Maximum length = 128 |
| mastools_version | <String> | Read-write | Mastools version if the device is embedded agent. |
| ent_bw_total | <Integer> | Read-write | Enterprise Bandwidth Total. |
| ssh_port | <Integer> | Read-write | SSH port of the container.. |
| netmask | <String> | Read-write | Netmask of managed device. Minimum length = 1 Maximum length = 64 |
| ent_bw_config | <Integer> | Read-write | Enterprise Bandwidth configured. |
| datacenter_id | <String> | Read-write | Datacenter Id is system generated key for data center. |
| instance_config | <Integer> | Read-write | Instance license running. |
| instance_mode | <String> | Read-write | Denotes state- primary,secondary,clip,clusternode. |
| discovery_time | <Double> | Read-write | discovery time. |
| std_bw_available | <Integer> | Read-write | Standard Bandwidth Available. |
| plt_bw_total | <Integer> | Read-write | Total Platinum Bandwidth. |
| host_ip_address | <String> | Read-write | Host IPAddress where VM is provisioned. Minimum length = 1 Maximum length = 64 |
| id | <String> | Read-write | Id is system generated key for all the managed devices. |
| ipv6_address | <String> | Read-write | IPv6 Address. |
| mgmt_ip_address | <String> | Read-write | Management IP Address for this Managed Device. Minimum length = 1 Maximum length = 64 |
| plt_bw_available | <Integer> | Read-write | Platinum Bandwidth Available. |
| device_family | <String> | Read-write | Device Family. Minimum length = 1 Maximum length = 64 |
| type | <String> | Read-write | Type of device, (Xen | NS). Minimum length = 1 Maximum length = 64 |
| throughput | <Double> | Read-write | Assign throughput in Mbps to VM Instance. |
| gateway | <String> | Read-write | Default Gateway of managed device. Minimum length = 1 Maximum length = 64 |
| http_port | <Integer> | Read-write | HTTP port of the container.. |
| isolation_policy | <String> | Read-write | Isolation Policy of the Device. |
| provision_request_id | <String> | Read-write | Value is set only if the instance was provisioned from MAS. |
| lb_role | <String> | Read-write | LB role performed by the device: North-South (Ingress or server), or East-West (client). |
| https_port | <Integer> | Read-write | HTTPS port of the container.. |
| domain_name | <String> | Read-write | Domain name of VM Device. Minimum length = 1 Maximum length = 128 |
| snmp_port | <Integer> | Read-write | SNMP port of the container.. |
| image_name | <String> | Read-write | Image Name, This parameter is used while provisioning VM Instance with XVA image, template_name is given priority if provided along with image_name. Minimum length = 1 Maximum length = 128 |
| hostname | <String> | Read-write | Assign hostname to managed device, if this is not provided, name will be set as host name . Minimum length = 1 Maximum length = 256 |
| ent_bw_available | <Integer> | Read-write | Enterprise Bandwidth configured. |
| description | <String> | Read-write | Description of managed device. Minimum length = 1 Maximum length = 512 |
| geo_support | <Boolean> | Read-write | Is this device configured to support GEO location.. |
| sslvpn_config | <Integer> | Read-write | sslvpn license maximum. |
| sysservices | <Double> | Read-write | System Services. |
| burst_priority | <Integer> | Read-write | Burst Priority of the VM Instance.. |
| routable | <Boolean> | Read-write | Whether the device is reachable or not. |
| autoprovisioned | <Boolean> | Read-write | Device is auto-provisioned or not. |
| is_managed | <Boolean> | Read-write | Is Managed. |
| number_of_cpu | <Integer> | Read-write | Number of CPU that is assigned to VM Instance. |
| instance_total | <Integer> | Read-write | Instance license. |
| is_ha_configured | <Boolean> | Read-write | Is HA configured. |
| trust_id | <String> | Read-write | Device ID obtained from trust service. |
| ipv4_address | <String> | Read-write | IPv4 Address. Minimum length = 1 Maximum length = 64 |
| profile_name | <String> | Read-write | Device Profile Name that is attached with this managed device. Minimum length = 1 Maximum length = 128 |
| servicepackage | <String> | Read-write | Service Package Name of the device. |
| last_updated_time | <Double> | Read-write | Last Updated Time. |
| partition_id | <String> | Read-write | ID of admin partition. |
| number_of_ssl_cores | <Integer> | Read-write | Assign number of ssl virtual functions to VM Instance. |
| max_burst_throughput | <Double> | Read-write | Maximum burst throughput in Mbps of VM Instance. |
| config_type | <Integer> | Read-write | Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both. Maximum value = |
| node_id | <String> | Read-write | Node identification of a device. |
| ip_address | <String> | Read-write | IP Address for this managed device. Minimum length = 1 Maximum length = 64 |
| number_of_cores | <Integer> | Read-write | Number of cores that are assigned to VM Instance. |
| is_sdx_platform | <Boolean> | Read-write | True if it is SDX platform. |
| display_name | <String> | Read-write | Display Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP. Minimum length = 1 Maximum length = 128 |
| std_bw_total | <Integer> | Read-write | Standard Bandwidth. |
| partition_name | <String> | Read-write | NS Admin Partition Name. Maximum length = 512 |
| plt_bw_config | <Integer> | Read-write | Platinum Bandwidth configured. |
| sslvpn_total | <Integer> | Read-write | sslvpn license. |
| agent_id | <String> | Read-write | Agent Id. |
| formation_instance_id | <String> | Read-write | This property is deprecated;ltbr;gtFormation Instance Id that this VM is Part of. Minimum length = 1 Maximum length = 128 |
| profile_username | <String> | Read-write | User Name specified by the user for this Netscaler Instance.. Minimum length = 1 Maximum length = 128 |
| profile_password | <String> | Read-write | Password specified by the user for this Netscaler.. Minimum length = 1 Maximum length = 128 |
| file_location_path | <String> | Read-write | File Location on Client for upload/download. Minimum length = 1 |
| file_name | <String> | Read-write | File name which contains comma separated instances to be discovered. Minimum length = 1 Maximum length = 128 |
| entity_tag | <property_map[]> | Read-write | Array of tag_name and tag_value pair assocaited with an entity. |
| manufacturedate | <String> | Read-only | Manufacture Date. |
| bandwidth_mode | <String> | Read-only | Boost status : Bandwidth Mode of NetScaler SD-WAN Instance. |
| instance_state | <String> | Read-only | State of device, UP only if device accessible. |
| qosstatus | <String> | Read-only | QoS Status. |
| virtualization | <String> | Read-only | paravirtual(PV) or Hardware Virtual Machine(HVM) (if hosted on AWS). |
| termination_protection | <Boolean> | Read-only | If termination_protection is enabled, instance can't be terminated unless it is disabled (if hosted on AWS). |
| vcpu_config | <Integer> | Read-only | Number of vCPU allocated for the device. |
| wan_in | <Double> | Read-only | WAN In of NetScaler SD-WAN Instance in Mbps. |
| device_uuid | <String> | Read-only | Device UUID. |
| platform | <String> | Read-only | Platform. |
| version | <String> | Read-only | Device Version. |
| public_dns | <String> | Read-only | Public DNS of the managed device. |
| build_number | <String> | Read-only | Build Number. |
| instance_type | <String> | Read-only | Instance type indicates the size of the managed device which is a combination of CPU, memory, storage, and networking capacity. |
| sysid | <String> | Read-only | System ID. |
| tenancy | <String> | Read-only | default or dedicated. Dedicated means -> running on a single tenant (if hosted on AWS). |
| vm_state | <String> | Read-only | State of Virtual Machine (Running | Halted). |
| uuid | <String> | Read-only | UUID of VM Instance. |
| connected_plugins | <String> | Read-only | connected plugins. |
| encoded_serialnumber | <String> | Read-only | Encoded Serial Number. |
| ssl_virtual_functions | <String> | Read-only | SSL Virtual Functions assigned to VM Instance. |
| cpufrequncy | <Integer> | Read-only | CPU Frequency (MHZ). |
| ha_sync | <String> | Read-only | HA Synchronization State. |
| ha_peer_state | <String> | Read-only | Peer State of Sd-WAN WO Instance in HA mode. |
| ha_ip_address | <String> | Read-only | Peer IP Address. |
| bypass | <String> | Read-only | bypass value of NetScaler SD-WAN WAN Opt Instance. |
| cpu_usage | <Double> | Read-only | CPU Usage (%) of CBWANOPT Instance. |
| status | <String> | Read-only | Status of managed device. |
| current_time | <Integer> | Read-only | Current Time. |
| max_plugins | <String> | Read-only | Maximum plugins. |
| systemname | <String> | Read-only | Device System Name. |
| wan_out | <Double> | Read-only | WAN Out of NetScaler SD-WAN Instance in Mbps. |
| geo_location | <String> | Read-only | Geo location of the managed device. |
| unacl_connections | <String> | Read-only | non-accelerated connections. |
| license | <String> | Read-only | NetScaler SD-WAN License. |
| acl_connections | <String> | Read-only | Accelerated Connections. |
| serialnumber | <String> | Read-only | Device Serial Number. |
| product | <String> | Read-only | Product Name. |
| subnet_id | <String> | Read-only | in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS). |
| ha_master_state | <String> | Read-only | Master State (Primary/Secondary). |
| vpc_id | <String> | Read-only | VPC ID of the managed device. |
| region | <String> | Read-only | Region in which the managed device is hosted. |
| reason | <String> | Read-only | Reason of failure for this managed device. |
| virtual_functions | <String> | Read-only | Virtual Functions assigned to VM Instance. |
| upsince | <String> | Read-only | Upsince of managed device. |
| lan_out | <Double> | Read-only | LAN Out of NetScaler SD-WAN Instance in Mbps. |
| security_group | <String> | Read-only | virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS). |
| private_dns | <String> | Read-only | Private DNS of the managed device. |
| zone | <String> | Read-only | Zone in which the managed device is hosted. |
| model_id | <String> | Read-only | Device Model Id. |
| active_connections | <Double> | Read-only | Total Active Connections on NetScaler SD-WAN Instance. |
| tenant_id | <String> | Read-only | Tenant ID. |
| do_config | <Boolean> | Read-only | Do default config for managed device. |
| host_id | <String> | Read-only | Host ID. |
| system_load | <Double> | Read-only | System Load (%) on NetScaler SD-WAN Instance. |
| key_name | <String> | Read-only | name of the S3 bucket in which managed device is stored (if hosted on AWS). |
| ha_state | <String> | Read-only | State of NetScaler SD-WAN WAN Opt Instance in HA mode. |
| operation_status | <String> | Read-only | Operation status of NetScaler SD-WAN WAN Opt Instance. |
| is_swg | <Boolean> | Read-only | Boolean to indicate whether a VM is SWG. |
| data_reduction | <Double> | Read-only | Data Reduction (%). |
| cloud | <String> | Read-only | Cloud on which the managed device is hosted. |
| uptime | <String> | Read-only | Uptime of device. |
| ha_peer_ip_address | <String> | Read-only | Peer IP Address of NetScaler SD-WAN WAN Opt Instance. |
| private_ip | <String> | Read-only | Private IP of the managed device. |
| cpu_license_type | <Integer> | Read-only | VCPU license 0 = No VCPU License, 1 = VCPU Pool license. |
| location | <String> | Read-only | Device Location. |
| contactperson | <String> | Read-only | Device contact person. |
| havmip | <String> | Read-only | HA VM IPAddress. |
| public_ip | <String> | Read-only | Public IP of the managed device. |
| lan_in | <Double> | Read-only | Lan In of NetScaler SD-WAN Instance in Mbps. |
| bmcrevision | <String> | Read-only | BMC Firmware Version. |
| ha_peer_id | <Double> | Read-only | Id of the Peer in an HA setup. |
| vm_description | <String> | Read-only | Description. |
| memory_usage | <Double> | Read-only | Memory Usage (%) of CBWANOPT Instance. |
| ami_id | <String> | Read-only | AMI ID of the managed device (if hosted on AWS). |
| root_device_type | <String> | Read-only | contains the image used to boot the managed device (if hosted on AWS). |
| bandwidth_limit | <Double> | Read-only | bandwidth limit of NetScaler SD-WAN Instance (K-Bits/sec). |
| ebs_optimized | <Boolean> | Read-only | AWS offers consistent and low-latency performance if EBS optimized is true. |
| act_id | <String> | Read-only | Activity Id. |
Operations
(click to see Properties)
UNMANAGE| REBOOT| ADD| DELETE| GET (ALL)| GET| MANAGE
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>.
unmanage
URL: https://<MGMT-IP>/nitro/v1/config/cbwanopt/id_value<String>?action=unmanage;onerror=<String_value>
HTTP Method: null
Request Payload:
{"cbwanopt": { }}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>}
reboot
URL: https://<MGMT-IP>/nitro/v1/config/cbwanopt/id_value<String>?action=reboot;onerror=<String_value>
HTTP Method: null
Request Payload:
{"cbwanopt": { }}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>}
add
URL: https://<MGMT-IP>/nitro/v1/config/cbwanopt?onerror=<String_value>
HTTP Method: null
Request Payload:
{cbwanopt: {
<b>"ip_address":<String_value></b>,
"image_name":<String_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_deployment":<Boolean_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"geo_support":<Boolean_value>,
"sslvpn_config":<Integer_value>,
"mastools_version":<String_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"ssh_port":<Integer_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"netmask":<String_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"profile_username":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"file_location_path":<String_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"profile_password":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"file_name":<String_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"type":<String_value>,
"throughput":<Double_value>,
"gateway":<String_value>,
"http_port":<Integer_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"provision_request_id":<String_value>,
"number_of_cores":<Integer_value>,
"lb_role":<String_value>,
"is_sdx_platform":<Boolean_value>,
"https_port":<Integer_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"domain_name":<String_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"formation_instance_id":<String_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"snmp_port":<Integer_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "cbwanopt":[{
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"gateway_ipv6":<String_value>,
"bandwidth_mode":<String_value>,
"instance_available":<Integer_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"mastools_version":<String_value>,
"qosstatus":<String_value>,
"virtualization":<String_value>,
"ent_bw_total":<Integer_value>,
"termination_protection":<Boolean_value>,
"ssh_port":<Integer_value>,
"vcpu_config":<Integer_value>,
"wan_in":<Double_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"platform":<String_value>,
"ent_bw_config":<Integer_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"public_dns":<String_value>,
"build_number":<String_value>,
"instance_type":<String_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"connected_plugins":<String_value>,
"encoded_serialnumber":<String_value>,
"ssl_virtual_functions":<String_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"device_family":<String_value>,
"ha_sync":<String_value>,
"ha_peer_state":<String_value>,
"ha_ip_address":<String_value>,
"bypass":<String_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"throughput":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"current_time":<Integer_value>,
"max_plugins":<String_value>,
"http_port":<Integer_value>,
"systemname":<String_value>,
"wan_out":<Double_value>,
"geo_location":<String_value>,
"isolation_policy":<String_value>,
"unacl_connections":<String_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"license":<String_value>,
"https_port":<Integer_value>,
"acl_connections":<String_value>,
"domain_name":<String_value>,
"serialnumber":<String_value>,
"product":<String_value>,
"snmp_port":<Integer_value>,
"subnet_id":<String_value>,
"image_name":<String_value>,
"hostname":<String_value>,
"ha_master_state":<String_value>,
"vpc_id":<String_value>,
"vnc_console_url":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"virtual_functions":<String_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"sslvpn_config":<Integer_value>,
"lan_out":<Double_value>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"model_id":<String_value>,
"sysservices":<Double_value>,
"active_connections":<Double_value>,
"host_type":<String_value>,
"tenant_id":<String_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"host_id":<String_value>,
"system_load":<Double_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"ha_state":<String_value>,
"is_ha_configured":<Boolean_value>,
"operation_status":<String_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"is_swg":<Boolean_value>,
"seq_no":<Double_value>,
"dns":<String_value>,
"data_reduction":<Double_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"uptime":<String_value>,
"ha_peer_ip_address":<String_value>,
"private_ip":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"location":<String_value>,
"contactperson":<String_value>,
"havmip":<String_value>,
"public_ip":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"lan_in":<Double_value>,
"bmcrevision":<String_value>,
"ha_peer_id":<Double_value>,
"vm_description":<String_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"number_of_cores":<Integer_value>,
"memory_usage":<Double_value>,
"is_sdx_platform":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"bandwidth_limit":<Double_value>,
"ebs_optimized":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"formation_instance_id":<String_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/cbwanopt/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/cbwanopt
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "cbwanopt":[{
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"gateway_ipv6":<String_value>,
"bandwidth_mode":<String_value>,
"instance_available":<Integer_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"mastools_version":<String_value>,
"qosstatus":<String_value>,
"virtualization":<String_value>,
"ent_bw_total":<Integer_value>,
"termination_protection":<Boolean_value>,
"ssh_port":<Integer_value>,
"vcpu_config":<Integer_value>,
"wan_in":<Double_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"platform":<String_value>,
"ent_bw_config":<Integer_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"public_dns":<String_value>,
"build_number":<String_value>,
"instance_type":<String_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"connected_plugins":<String_value>,
"encoded_serialnumber":<String_value>,
"ssl_virtual_functions":<String_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"device_family":<String_value>,
"ha_sync":<String_value>,
"ha_peer_state":<String_value>,
"ha_ip_address":<String_value>,
"bypass":<String_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"throughput":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"current_time":<Integer_value>,
"max_plugins":<String_value>,
"http_port":<Integer_value>,
"systemname":<String_value>,
"wan_out":<Double_value>,
"geo_location":<String_value>,
"isolation_policy":<String_value>,
"unacl_connections":<String_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"license":<String_value>,
"https_port":<Integer_value>,
"acl_connections":<String_value>,
"domain_name":<String_value>,
"serialnumber":<String_value>,
"product":<String_value>,
"snmp_port":<Integer_value>,
"subnet_id":<String_value>,
"image_name":<String_value>,
"hostname":<String_value>,
"ha_master_state":<String_value>,
"vpc_id":<String_value>,
"vnc_console_url":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"virtual_functions":<String_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"sslvpn_config":<Integer_value>,
"lan_out":<Double_value>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"model_id":<String_value>,
"sysservices":<Double_value>,
"active_connections":<Double_value>,
"host_type":<String_value>,
"tenant_id":<String_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"host_id":<String_value>,
"system_load":<Double_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"ha_state":<String_value>,
"is_ha_configured":<Boolean_value>,
"operation_status":<String_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"is_swg":<Boolean_value>,
"seq_no":<Double_value>,
"dns":<String_value>,
"data_reduction":<Double_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"uptime":<String_value>,
"ha_peer_ip_address":<String_value>,
"private_ip":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"location":<String_value>,
"contactperson":<String_value>,
"havmip":<String_value>,
"public_ip":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"lan_in":<Double_value>,
"bmcrevision":<String_value>,
"ha_peer_id":<Double_value>,
"vm_description":<String_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"number_of_cores":<Integer_value>,
"memory_usage":<Double_value>,
"is_sdx_platform":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"bandwidth_limit":<Double_value>,
"ebs_optimized":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"formation_instance_id":<String_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/cbwanopt/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "cbwanopt":[{
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"gateway_ipv6":<String_value>,
"bandwidth_mode":<String_value>,
"instance_available":<Integer_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"name":<String_value>,
"mastools_version":<String_value>,
"qosstatus":<String_value>,
"virtualization":<String_value>,
"ent_bw_total":<Integer_value>,
"termination_protection":<Boolean_value>,
"ssh_port":<Integer_value>,
"vcpu_config":<Integer_value>,
"wan_in":<Double_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"platform":<String_value>,
"ent_bw_config":<Integer_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"public_dns":<String_value>,
"build_number":<String_value>,
"instance_type":<String_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"vm_state":<String_value>,
"uuid":<String_value>,
"connected_plugins":<String_value>,
"encoded_serialnumber":<String_value>,
"ssl_virtual_functions":<String_value>,
"plt_bw_total":<Integer_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"device_family":<String_value>,
"ha_sync":<String_value>,
"ha_peer_state":<String_value>,
"ha_ip_address":<String_value>,
"bypass":<String_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"throughput":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"current_time":<Integer_value>,
"max_plugins":<String_value>,
"http_port":<Integer_value>,
"systemname":<String_value>,
"wan_out":<Double_value>,
"geo_location":<String_value>,
"isolation_policy":<String_value>,
"unacl_connections":<String_value>,
"provision_request_id":<String_value>,
"lb_role":<String_value>,
"license":<String_value>,
"https_port":<Integer_value>,
"acl_connections":<String_value>,
"domain_name":<String_value>,
"serialnumber":<String_value>,
"product":<String_value>,
"snmp_port":<Integer_value>,
"subnet_id":<String_value>,
"image_name":<String_value>,
"hostname":<String_value>,
"ha_master_state":<String_value>,
"vpc_id":<String_value>,
"vnc_console_url":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"virtual_functions":<String_value>,
"ent_bw_available":<Integer_value>,
"description":<String_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"upsince":<String_value>,
"sslvpn_config":<Integer_value>,
"lan_out":<Double_value>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"model_id":<String_value>,
"sysservices":<Double_value>,
"active_connections":<Double_value>,
"host_type":<String_value>,
"tenant_id":<String_value>,
"burst_priority":<Integer_value>,
"routable":<Boolean_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"host_id":<String_value>,
"system_load":<Double_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"ha_state":<String_value>,
"is_ha_configured":<Boolean_value>,
"operation_status":<String_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"profile_name":<String_value>,
"is_swg":<Boolean_value>,
"seq_no":<Double_value>,
"dns":<String_value>,
"data_reduction":<Double_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"uptime":<String_value>,
"ha_peer_ip_address":<String_value>,
"private_ip":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"location":<String_value>,
"contactperson":<String_value>,
"havmip":<String_value>,
"public_ip":<String_value>,
"number_of_ssl_cores":<Integer_value>,
"lan_in":<Double_value>,
"bmcrevision":<String_value>,
"ha_peer_id":<Double_value>,
"vm_description":<String_value>,
"max_burst_throughput":<Double_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"number_of_cores":<Integer_value>,
"memory_usage":<Double_value>,
"is_sdx_platform":<Boolean_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"bandwidth_limit":<Double_value>,
"ebs_optimized":<Boolean_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"formation_instance_id":<String_value>,
"parent_inventory":<Boolean_value>,
"provision_request_id":<String_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"file_location_path":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}]}]}
manage
URL: https://<MGMT-IP>/nitro/v1/config/cbwanopt/id_value<String>?action=manage;onerror=<String_value>
HTTP Method: null
Request Payload:
{"cbwanopt": { }}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>}