Skip to content

cbwanopt

Configuration for CBWANOPT resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
gateway_deployment<Boolean>Read-writeIs this device acting as Gateway..
std_bw_config<Integer>Read-writeStandard Bandwidth running.
gateway_ipv6<String>Read-writeGateway IPv6 Address.
instance_available<Integer>Read-writeInstance license available.
device_finger_print<String>Read-writeFingerprint/thumb-print from UMS public certificate for SSL communication.
name<String>Read-writeName of managed device.
Minimum length = 1
Maximum length = 128
mastools_version<String>Read-writeMastools version if the device is embedded agent.
ent_bw_total<Integer>Read-writeEnterprise Bandwidth Total.
ssh_port<Integer>Read-writeSSH port of the container..
netmask<String>Read-writeNetmask of managed device.
Minimum length = 1
Maximum length = 64
ent_bw_config<Integer>Read-writeEnterprise Bandwidth configured.
datacenter_id<String>Read-writeDatacenter Id is system generated key for data center.
instance_config<Integer>Read-writeInstance license running.
instance_mode<String>Read-writeDenotes state- primary,secondary,clip,clusternode.
discovery_time<Double>Read-writediscovery time.
std_bw_available<Integer>Read-writeStandard Bandwidth Available.
plt_bw_total<Integer>Read-writeTotal Platinum Bandwidth.
host_ip_address<String>Read-writeHost IPAddress where VM is provisioned.
Minimum length = 1
Maximum length = 64
id<String>Read-writeId is system generated key for all the managed devices.
ipv6_address<String>Read-writeIPv6 Address.
mgmt_ip_address<String>Read-writeManagement IP Address for this Managed Device.
Minimum length = 1
Maximum length = 64
plt_bw_available<Integer>Read-writePlatinum Bandwidth Available.
device_family<String>Read-writeDevice Family.
Minimum length = 1
Maximum length = 64
type<String>Read-writeType of device, (Xen | NS).
Minimum length = 1
Maximum length = 64
throughput<Double>Read-writeAssign throughput in Mbps to VM Instance.
gateway<String>Read-writeDefault Gateway of managed device.
Minimum length = 1
Maximum length = 64
http_port<Integer>Read-writeHTTP port of the container..
isolation_policy<String>Read-writeIsolation Policy of the Device.
provision_request_id<String>Read-writeValue is set only if the instance was provisioned from MAS.
lb_role<String>Read-writeLB role performed by the device: North-South (Ingress or server), or East-West (client).
https_port<Integer>Read-writeHTTPS port of the container..
domain_name<String>Read-writeDomain name of VM Device.
Minimum length = 1
Maximum length = 128
snmp_port<Integer>Read-writeSNMP port of the container..
image_name<String>Read-writeImage 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-writeAssign 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-writeEnterprise Bandwidth configured.
description<String>Read-writeDescription of managed device.
Minimum length = 1
Maximum length = 512
geo_support<Boolean>Read-writeIs this device configured to support GEO location..
sslvpn_config<Integer>Read-writesslvpn license maximum.
sysservices<Double>Read-writeSystem Services.
burst_priority<Integer>Read-writeBurst Priority of the VM Instance..
routable<Boolean>Read-writeWhether the device is reachable or not.
autoprovisioned<Boolean>Read-writeDevice is auto-provisioned or not.
is_managed<Boolean>Read-writeIs Managed.
number_of_cpu<Integer>Read-writeNumber of CPU that is assigned to VM Instance.
instance_total<Integer>Read-writeInstance license.
is_ha_configured<Boolean>Read-writeIs HA configured.
trust_id<String>Read-writeDevice ID obtained from trust service.
ipv4_address<String>Read-writeIPv4 Address.
Minimum length = 1
Maximum length = 64
profile_name<String>Read-writeDevice Profile Name that is attached with this managed device.
Minimum length = 1
Maximum length = 128
servicepackage<String>Read-writeService Package Name of the device.
last_updated_time<Double>Read-writeLast Updated Time.
partition_id<String>Read-writeID of admin partition.
number_of_ssl_cores<Integer>Read-writeAssign number of ssl virtual functions to VM Instance.
max_burst_throughput<Double>Read-writeMaximum burst throughput in Mbps of VM Instance.
config_type<Integer>Read-writeConfiguration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value =
node_id<String>Read-writeNode identification of a device.
ip_address<String>Read-writeIP Address for this managed device.
Minimum length = 1
Maximum length = 64
number_of_cores<Integer>Read-writeNumber of cores that are assigned to VM Instance.
is_sdx_platform<Boolean>Read-writeTrue if it is SDX platform.
display_name<String>Read-writeDisplay 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-writeStandard Bandwidth.
partition_name<String>Read-writeNS Admin Partition Name.
Maximum length = 512
plt_bw_config<Integer>Read-writePlatinum Bandwidth configured.
sslvpn_total<Integer>Read-writesslvpn license.
agent_id<String>Read-writeAgent Id.
formation_instance_id<String>Read-writeThis property is deprecated;ltbr;gtFormation Instance Id that this VM is Part of.
Minimum length = 1
Maximum length = 128
profile_username<String>Read-writeUser Name specified by the user for this Netscaler Instance..
Minimum length = 1
Maximum length = 128
profile_password<String>Read-writePassword specified by the user for this Netscaler..
Minimum length = 1
Maximum length = 128
file_location_path<String>Read-writeFile Location on Client for upload/download.
Minimum length = 1
file_name<String>Read-writeFile name which contains comma separated instances to be discovered.
Minimum length = 1
Maximum length = 128
entity_tag<property_map[]>Read-writeArray of tag_name and tag_value pair assocaited with an entity.
manufacturedate<String>Read-onlyManufacture Date.
bandwidth_mode<String>Read-onlyBoost status : Bandwidth Mode of NetScaler SD-WAN Instance.
instance_state<String>Read-onlyState of device, UP only if device accessible.
qosstatus<String>Read-onlyQoS Status.
virtualization<String>Read-onlyparavirtual(PV) or Hardware Virtual Machine(HVM) (if hosted on AWS).
termination_protection<Boolean>Read-onlyIf termination_protection is enabled, instance can't be terminated unless it is disabled (if hosted on AWS).
vcpu_config<Integer>Read-onlyNumber of vCPU allocated for the device.
wan_in<Double>Read-onlyWAN In of NetScaler SD-WAN Instance in Mbps.
device_uuid<String>Read-onlyDevice UUID.
platform<String>Read-onlyPlatform.
version<String>Read-onlyDevice Version.
public_dns<String>Read-onlyPublic DNS of the managed device.
build_number<String>Read-onlyBuild Number.
instance_type<String>Read-onlyInstance type indicates the size of the managed device which is a combination of CPU, memory, storage, and networking capacity.
sysid<String>Read-onlySystem ID.
tenancy<String>Read-onlydefault or dedicated. Dedicated means -> running on a single tenant (if hosted on AWS).
vm_state<String>Read-onlyState of Virtual Machine (Running | Halted).
uuid<String>Read-onlyUUID of VM Instance.
connected_plugins<String>Read-onlyconnected plugins.
encoded_serialnumber<String>Read-onlyEncoded Serial Number.
ssl_virtual_functions<String>Read-onlySSL Virtual Functions assigned to VM Instance.
cpufrequncy<Integer>Read-onlyCPU Frequency (MHZ).
ha_sync<String>Read-onlyHA Synchronization State.
ha_peer_state<String>Read-onlyPeer State of Sd-WAN WO Instance in HA mode.
ha_ip_address<String>Read-onlyPeer IP Address.
bypass<String>Read-onlybypass value of NetScaler SD-WAN WAN Opt Instance.
cpu_usage<Double>Read-onlyCPU Usage (%) of CBWANOPT Instance.
status<String>Read-onlyStatus of managed device.
current_time<Integer>Read-onlyCurrent Time.
max_plugins<String>Read-onlyMaximum plugins.
systemname<String>Read-onlyDevice System Name.
wan_out<Double>Read-onlyWAN Out of NetScaler SD-WAN Instance in Mbps.
geo_location<String>Read-onlyGeo location of the managed device.
unacl_connections<String>Read-onlynon-accelerated connections.
license<String>Read-onlyNetScaler SD-WAN License.
acl_connections<String>Read-onlyAccelerated Connections.
serialnumber<String>Read-onlyDevice Serial Number.
product<String>Read-onlyProduct Name.
subnet_id<String>Read-onlyin which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS).
ha_master_state<String>Read-onlyMaster State (Primary/Secondary).
vpc_id<String>Read-onlyVPC ID of the managed device.
region<String>Read-onlyRegion in which the managed device is hosted.
reason<String>Read-onlyReason of failure for this managed device.
virtual_functions<String>Read-onlyVirtual Functions assigned to VM Instance.
upsince<String>Read-onlyUpsince of managed device.
lan_out<Double>Read-onlyLAN Out of NetScaler SD-WAN Instance in Mbps.
security_group<String>Read-onlyvirtual firewall that controls the traffic for one or more managed devices (if hosted on AWS).
private_dns<String>Read-onlyPrivate DNS of the managed device.
zone<String>Read-onlyZone in which the managed device is hosted.
model_id<String>Read-onlyDevice Model Id.
active_connections<Double>Read-onlyTotal Active Connections on NetScaler SD-WAN Instance.
tenant_id<String>Read-onlyTenant ID.
do_config<Boolean>Read-onlyDo default config for managed device.
host_id<String>Read-onlyHost ID.
system_load<Double>Read-onlySystem Load (%) on NetScaler SD-WAN Instance.
key_name<String>Read-onlyname of the S3 bucket in which managed device is stored (if hosted on AWS).
ha_state<String>Read-onlyState of NetScaler SD-WAN WAN Opt Instance in HA mode.
operation_status<String>Read-onlyOperation status of NetScaler SD-WAN WAN Opt Instance.
is_swg<Boolean>Read-onlyBoolean to indicate whether a VM is SWG.
data_reduction<Double>Read-onlyData Reduction (%).
cloud<String>Read-onlyCloud on which the managed device is hosted.
uptime<String>Read-onlyUptime of device.
ha_peer_ip_address<String>Read-onlyPeer IP Address of NetScaler SD-WAN WAN Opt Instance.
private_ip<String>Read-onlyPrivate IP of the managed device.
cpu_license_type<Integer>Read-onlyVCPU license 0 = No VCPU License, 1 = VCPU Pool license.
location<String>Read-onlyDevice Location.
contactperson<String>Read-onlyDevice contact person.
havmip<String>Read-onlyHA VM IPAddress.
public_ip<String>Read-onlyPublic IP of the managed device.
lan_in<Double>Read-onlyLan In of NetScaler SD-WAN Instance in Mbps.
bmcrevision<String>Read-onlyBMC Firmware Version.
ha_peer_id<Double>Read-onlyId of the Peer in an HA setup.
vm_description<String>Read-onlyDescription.
memory_usage<Double>Read-onlyMemory Usage (%) of CBWANOPT Instance.
ami_id<String>Read-onlyAMI ID of the managed device (if hosted on AWS).
root_device_type<String>Read-onlycontains the image used to boot the managed device (if hosted on AWS).
bandwidth_limit<Double>Read-onlybandwidth limit of NetScaler SD-WAN Instance (K-Bits/sec).
ebs_optimized<Boolean>Read-onlyAWS offers consistent and low-latency performance if EBS optimized is true.
act_id<String>Read-onlyActivity 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>}