tp_loadbalancer
Configuration for HA Proxy host details resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
instance_classifier |
|
Read-write | Value based on which certain features may be enabled/disabled in ADM for the instance. |
hostname |
|
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 |
gateway_deployment |
|
Read-write | Is this device acting as Gateway.. |
std_bw_config |
|
Read-write | Standard Bandwidth running. |
gateway_ipv6 |
|
Read-write | Gateway IPv6 Address. |
instance_available |
|
Read-write | Instance license available. |
device_finger_print |
|
Read-write | Fingerprint/thumb-print from UMS public certificate for SSL communication. |
name |
|
Read-write | Name of managed device.
Minimum length = 1 Maximum length = 128 |
description |
|
Read-write | Description of managed device.
Minimum length = 1 Maximum length = 512 |
ent_bw_available |
|
Read-write | Enterprise Bandwidth configured. |
is_autoscale_group |
|
Read-write | Does this device belong to an Autoscale Group.. |
geo_support |
|
Read-write | Is this device configured to support GEO location.. |
sslvpn_config |
|
Read-write | sslvpn license maximum. |
mastools_version |
|
Read-write | Mastools version if the device is embedded agent. |
sysservices |
|
Read-write | System Services. |
ent_bw_total |
|
Read-write | Enterprise Bandwidth Total. |
vcpu_config |
|
Read-write | Number of vCPU allocated for the device. |
netmask |
|
Read-write | Netmask of managed device.
Minimum length = 1 Maximum length = 64 |
ent_bw_config |
|
Read-write | Enterprise Bandwidth configured. |
autoprovisioned |
|
Read-write | Device is auto-provisioned or not. |
datacenter_id |
|
Read-write | Datacenter Id is system generated key for data center. |
instance_config |
|
Read-write | Instance license running. |
is_managed |
|
Read-write | Is Managed. |
instance_mode |
|
Read-write | Denotes state- primary,secondary,clip,clusternode. |
discovery_time |
|
Read-write | discovery time. |
instance_total |
|
Read-write | Instance license. |
is_ha_configured |
|
Read-write | Is HA configured. |
trust_id |
|
Read-write | Device ID obtained from trust service. |
ipv4_address |
|
Read-write | IPv4 Address.
Minimum length = 1 Maximum length = 64 |
profile_name |
|
Read-write | Device Profile Name that is attached with this managed device.
Minimum length = 1 Maximum length = 128 |
std_bw_available |
|
Read-write | Standard Bandwidth Available. |
servicepackage |
|
Read-write | Service Package Name of the device. |
last_updated_time |
|
Read-write | Last Updated Time. |
plt_bw_total |
|
Read-write | Total Platinum Bandwidth. |
id |
|
Read-write | Id is system generated key for all the managed devices. |
ipv6_address |
|
Read-write | IPv6 Address. |
mgmt_ip_address |
|
Read-write | Management IP Address for this Managed Device.
Minimum length = 1 Maximum length = 64 |
license_edition |
|
Read-write | Edition of instance. |
partition_id |
|
Read-write | ID of admin partition. |
plt_bw_available |
|
Read-write | Platinum Bandwidth Available. |
device_family |
|
Read-write | Device Family.
Minimum length = 1 Maximum length = 64 |
template_interval |
|
Read-write | Template refresh interval. |
type |
|
Read-write | Type of device, (Xen | NS).
Minimum length = 1 Maximum length = 64 |
gateway |
|
Read-write | Default Gateway of managed device.
Minimum length = 1 Maximum length = 64 |
internal_annotation |
|
Read-write | Internal annotation used by ADM.Example, if a device is marked for delete. |
config_type |
|
Read-write | Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value = |
node_id |
|
Read-write | Node identification of a device. |
isolation_policy |
|
Read-write | Isolation Policy of the Device. |
ip_address |
|
Read-write | IP Address for this managed device.
Minimum length = 1 Maximum length = 64 |
provision_request_id |
|
Read-write | Value is set only if the instance was provisioned from Citrix ADM. |
httpxforwardedfor |
|
Read-write | HTTP x-Forwardedfor header flag..
Minimum length = 1 Maximum length = 10 |
display_name |
|
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 |
|
Read-write | Standard Bandwidth. |
partition_name |
|
Read-write | Citrix ADC Admin Partition Name.
Maximum length = 512 |
plt_bw_config |
|
Read-write | Platinum Bandwidth configured. |
sslvpn_total |
|
Read-write | sslvpn license. |
agent_id |
|
Read-write | Agent Id. |
peer_device_ip |
|
Read-write | Peer Device IP address for instance of type BLX ADC..
Minimum length = 1 Maximum length = 64 |
profile_username |
|
Read-write | User Name specified by the user for this Citrix ADC Instance..
Minimum length = 1 Maximum length = 128 |
profile_password |
|
Read-write | Password specified by the user for this Citrix ADC Instance..
Minimum length = 1 Maximum length = 128 |
file_location_path |
|
Read-write | File Location on Client for upload/download.
Minimum length = 1 |
peer_host_device_ip |
|
Read-write | Peer Host Device IP Address for instance of type BLX ADC..
Minimum length = 1 Maximum length = 64 |
file_name |
|
Read-write | File name which contains comma separated instances to be discovered.
Minimum length = 1 Maximum length = 128 |
device_host_ip |
|
Read-write | Device Host IP Address for instance of type BLX ADC..
Minimum length = 1 Maximum length = 64 |
tr_task_id |
|
Read-write | Task Id used by Triton to identify NS. |
entity_tag | <property_map[]> | Read-write | Array of tag_name and tag_value pair assocaited with an entity. |
subnet_id |
|
Read-only | in which the instance was launched. Subnet is a Range of IP addresses in a VPC (if hosted on AWS). |
manufacturedate |
|
Read-only | Manufacture Date. |
is_fips_pooled_license_type |
|
Read-only | FIPS BW license : 0 = No FIPS BW License, 1 = FIPS BW Pool license. |
acu_total |
|
Read-only | Total Asymmetric Crypto Units available in host. |
ha_master_state |
|
Read-only | Master State (Primary/Secondary). |
vpc_id |
|
Read-only | VPC ID of the managed device. |
instance_state |
|
Read-only | State of device, UP only if device accessible. |
enabled |
|
Read-only | host State. |
httpquerywithurl |
|
Read-only | URL query params flag.. |
reason |
|
Read-only | Reason of failure for this managed device. |
region |
|
Read-only | Region in which the managed device is hosted. |
disk_space |
|
Read-only | Show Disk Space (MB) available on host. |
disk_free |
|
Read-only | Show free Disk Space (MB) available on host. |
upsince |
|
Read-only | Upsince of managed device. |
private_dns |
|
Read-only | Private DNS of the managed device. |
security_group |
|
Read-only | virtual firewall that controls the traffic for one or more managed devices (if hosted on AWS). |
model_id |
|
Read-only | Device Model Id. |
zone |
|
Read-only | Zone in which the managed device is hosted. |
disk_usage |
|
Read-only | Disk usage (MB) for host. |
tenant_id |
|
Read-only | Tenant ID. |
device_uuid |
|
Read-only | Device UUID. |
do_config |
|
Read-only | Do default config for managed device. |
tx |
|
Read-only | Out Throughput (Mbps) of host. |
version |
|
Read-only | Device Version. |
host_id |
|
Read-only | Host ID. |
number_of_cpu |
|
Read-only | Number of total CPU of host. |
public_dns |
|
Read-only | Public DNS of the managed device. |
memory_free |
|
Read-only | Free memory available (MB) in host. |
instance_type |
|
Read-only | Instance type indicates the deployment type of CPX. |
sysid |
|
Read-only | System ID. |
uuid |
|
Read-only | UUID of host. |
scu_total |
|
Read-only | Total Symmetric Crypto Units available in host. |
cloud |
|
Read-only | Cloud on which the managed device is hosted. |
encoded_serialnumber |
|
Read-only | Encoded Serial Number. |
instance_unique_id |
|
Read-only | 32 bit unique Integer id generated by Citrix ADM for this device. |
uptime |
|
Read-only | Uptime of device. |
private_ip |
|
Read-only | Private IP of the managed device. |
cpufrequncy |
|
Read-only | CPU Frequency (MHZ). |
cpu_license_type |
|
Read-only | VCPU license 0 = No VCPU License, 1 = VCPU Pool license. |
location |
|
Read-only | Device Location. |
ha_sync |
|
Read-only | HA Synchronization State. |
contactperson |
|
Read-only | Device contact person. |
license_grace_time |
|
Read-only | Grace for this Citrix Instance.. |
public_ip |
|
Read-only | Public IP of the managed device. |
ha_ip_address |
|
Read-only | Peer IP Address. |
scu_free |
|
Read-only | Free Symmetric Crypto Units. |
total_crypto_devices |
|
Read-only | Total Crypto Devices. |
acu_free |
|
Read-only | Free Asymmetric Crypto Units. |
cpu_usage |
|
Read-only | CPU Usage (%) of host. |
bmcrevision |
|
Read-only | BMC Firmware Version. |
memory_total |
|
Read-only | Total memory of host in MB. |
status |
|
Read-only | Status of managed device. |
systemname |
|
Read-only | Device System Name. |
geo_location |
|
Read-only | Geo location of the managed device. |
rx |
|
Read-only | In Throughput (Mbps) of host. |
ssl_cores_total |
|
Read-only | Total SSL Cores available in host. |
memory_usage |
|
Read-only | Memory Usage (%) of host. |
ami_id |
|
Read-only | AMI ID of the managed device (if hosted on AWS). |
number_of_cpu_cores |
|
Read-only | Number of total CPU cores of host. |
httpcookie |
|
Read-only | Cookie-Header flag.. |
serialnumber |
|
Read-only | Device Serial Number. |
ssl_cores_free |
|
Read-only | Free SSL Cores. |
act_id |
|
Read-only | Activity Id. |
Operations
(click to see Properties )
- ADD
- DELETE
- GET (ALL)
- GET
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
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/tp_loadbalancer?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:
{"tp_loadbalancer": {
<b>"ip_address":<String_value></b>,
"instance_classifier":<Integer_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>,
"is_autoscale_group":<Boolean_value>,
"geo_support":<Boolean_value>,
"sslvpn_config":<Integer_value>,
"mastools_version":<String_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"vcpu_config":<Integer_value>,
"netmask":<String_value>,
"ent_bw_config":<Integer_value>,
"autoprovisioned":<Boolean_value>,
"profile_username":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"instance_total":<Integer_value>,
"file_location_path":<String_value>,
"is_ha_configured":<Boolean_value>,
"peer_host_device_ip":<String_value>,
"device_host_ip":<String_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>,
"peer_device_ip":<String_value>,
"profile_password":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"file_name":<String_value>,
"plt_bw_total":<Integer_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"template_interval":<Integer_value>,
"type":<String_value>,
"gateway":<String_value>,
"internal_annotation":<String_value>,
"config_type":<Integer_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"provision_request_id":<String_value>,
"httpxforwardedfor":<String_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"tr_task_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, "tp_loadbalancer":[{
"instance_classifier":<Integer_value>,
"subnet_id":<String_value>,
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"hostname":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"is_fips_pooled_license_type":<Integer_value>,
"acu_total":<Integer_value>,
"ha_master_state":<String_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"enabled":<Boolean_value>,
"httpquerywithurl":<String_value>,
"name":<String_value>,
"reason":<String_value>,
"region":<String_value>,
"disk_space":<Double_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"is_autoscale_group":<Boolean_value>,
"disk_free":<Double_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"sslvpn_config":<Integer_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"private_dns":<String_value>,
"security_group":<String_value>,
"model_id":<String_value>,
"mastools_version":<String_value>,
"zone":<String_value>,
"disk_usage":<Double_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"tenant_id":<String_value>,
"vcpu_config":<Integer_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"autoprovisioned":<Boolean_value>,
"do_config":<Boolean_value>,
"tx":<Double_value>,
"version":<String_value>,
"host_id":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"public_dns":<String_value>,
"is_ha_configured":<Boolean_value>,
"memory_free":<Double_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"seq_no":<Double_value>,
"sysid":<String_value>,
"servicepackage":<String_value>,
"uuid":<String_value>,
"scu_total":<Integer_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"instance_unique_id":<Integer_value>,
"uptime":<String_value>,
"plt_bw_total":<Integer_value>,
"private_ip":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"cpu_license_type":<Integer_value>,
"location":<String_value>,
"device_family":<String_value>,
"template_interval":<Integer_value>,
"ha_sync":<String_value>,
"contactperson":<String_value>,
"license_grace_time":<Integer_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"scu_free":<Integer_value>,
"total_crypto_devices":<Integer_value>,
"acu_free":<Integer_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"bmcrevision":<String_value>,
"memory_total":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"internal_annotation":<String_value>,
"config_type":<Integer_value>,
"systemname":<String_value>,
"node_id":<String_value>,
"geo_location":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"provision_request_id":<String_value>,
"httpxforwardedfor":<String_value>,
"rx":<Double_value>,
"ssl_cores_total":<Integer_value>,
"memory_usage":<Double_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"number_of_cpu_cores":<Integer_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"httpcookie":<String_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"serialnumber":<String_value>,
"do_instance_config":<Boolean_value>,
"peer_device_ip":<String_value>,
"parent_inventory":<Boolean_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"default_password":<String_value>,
"register_failed_device":<Boolean_value>,
"ssl_cores_free":<Integer_value>,
"file_location_path":<String_value>,
"peer_host_device_ip":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"device_host_ip":<String_value>,
"tr_task_id":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"force_password_change":<Boolean_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v2/config/tp_loadbalancer/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/tp_loadbalancer Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/tp_loadbalancer ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of tp_loadbalancer 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/tp_loadbalancer ?pagesize=#no;pageno=#no Use this query-parameter to get the tp_loadbalancer resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/tp_loadbalancer ?count=yes Use this query-parameter to get the count of tp_loadbalancer 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, "tp_loadbalancer":[{
"instance_classifier":<Integer_value>,
"subnet_id":<String_value>,
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"hostname":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"is_fips_pooled_license_type":<Integer_value>,
"acu_total":<Integer_value>,
"ha_master_state":<String_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"enabled":<Boolean_value>,
"httpquerywithurl":<String_value>,
"name":<String_value>,
"reason":<String_value>,
"region":<String_value>,
"disk_space":<Double_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"is_autoscale_group":<Boolean_value>,
"disk_free":<Double_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"sslvpn_config":<Integer_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"private_dns":<String_value>,
"security_group":<String_value>,
"model_id":<String_value>,
"mastools_version":<String_value>,
"zone":<String_value>,
"disk_usage":<Double_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"tenant_id":<String_value>,
"vcpu_config":<Integer_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"autoprovisioned":<Boolean_value>,
"do_config":<Boolean_value>,
"tx":<Double_value>,
"version":<String_value>,
"host_id":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"public_dns":<String_value>,
"is_ha_configured":<Boolean_value>,
"memory_free":<Double_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"seq_no":<Double_value>,
"sysid":<String_value>,
"servicepackage":<String_value>,
"uuid":<String_value>,
"scu_total":<Integer_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"instance_unique_id":<Integer_value>,
"uptime":<String_value>,
"plt_bw_total":<Integer_value>,
"private_ip":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"cpu_license_type":<Integer_value>,
"location":<String_value>,
"device_family":<String_value>,
"template_interval":<Integer_value>,
"ha_sync":<String_value>,
"contactperson":<String_value>,
"license_grace_time":<Integer_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"scu_free":<Integer_value>,
"total_crypto_devices":<Integer_value>,
"acu_free":<Integer_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"bmcrevision":<String_value>,
"memory_total":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"internal_annotation":<String_value>,
"config_type":<Integer_value>,
"systemname":<String_value>,
"node_id":<String_value>,
"geo_location":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"provision_request_id":<String_value>,
"httpxforwardedfor":<String_value>,
"rx":<Double_value>,
"ssl_cores_total":<Integer_value>,
"memory_usage":<Double_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"number_of_cpu_cores":<Integer_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"httpcookie":<String_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"serialnumber":<String_value>,
"do_instance_config":<Boolean_value>,
"peer_device_ip":<String_value>,
"parent_inventory":<Boolean_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"default_password":<String_value>,
"register_failed_device":<Boolean_value>,
"ssl_cores_free":<Integer_value>,
"file_location_path":<String_value>,
"peer_host_device_ip":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"device_host_ip":<String_value>,
"tr_task_id":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"force_password_change":<Boolean_value>}]}
get
URL: https://<MGMT-IP>/nitro/v2/config/tp_loadbalancer/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, "tp_loadbalancer":[{
"instance_classifier":<Integer_value>,
"subnet_id":<String_value>,
"is_grace":<Boolean_value>,
"manufacturedate":<String_value>,
"hostname":<String_value>,
"gateway_deployment":<Boolean_value>,
"std_bw_config":<Integer_value>,
"is_fips_pooled_license_type":<Integer_value>,
"acu_total":<Integer_value>,
"ha_master_state":<String_value>,
"gateway_ipv6":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"instance_state":<String_value>,
"device_finger_print":<String_value>,
"enabled":<Boolean_value>,
"httpquerywithurl":<String_value>,
"name":<String_value>,
"reason":<String_value>,
"region":<String_value>,
"disk_space":<Double_value>,
"description":<String_value>,
"ent_bw_available":<Integer_value>,
"is_autoscale_group":<Boolean_value>,
"disk_free":<Double_value>,
"geo_support":<Boolean_value>,
"is_pooled_license":<Boolean_value>,
"sslvpn_config":<Integer_value>,
"upsince":<String_value>,
"user_driven":<Boolean_value>,
"private_dns":<String_value>,
"security_group":<String_value>,
"model_id":<String_value>,
"mastools_version":<String_value>,
"zone":<String_value>,
"disk_usage":<Double_value>,
"sysservices":<Double_value>,
"ent_bw_total":<Integer_value>,
"tenant_id":<String_value>,
"vcpu_config":<Integer_value>,
"netmask":<String_value>,
"device_uuid":<String_value>,
"ent_bw_config":<Integer_value>,
"autoprovisioned":<Boolean_value>,
"do_config":<Boolean_value>,
"tx":<Double_value>,
"version":<String_value>,
"host_id":<String_value>,
"datacenter_id":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"instance_mode":<String_value>,
"discovery_time":<Double_value>,
"number_of_cpu":<Integer_value>,
"instance_total":<Integer_value>,
"public_dns":<String_value>,
"is_ha_configured":<Boolean_value>,
"memory_free":<Double_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"std_bw_available":<Integer_value>,
"seq_no":<Double_value>,
"sysid":<String_value>,
"servicepackage":<String_value>,
"uuid":<String_value>,
"scu_total":<Integer_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"instance_unique_id":<Integer_value>,
"uptime":<String_value>,
"plt_bw_total":<Integer_value>,
"private_ip":<String_value>,
"id":<String_value>,
"ipv6_address":<String_value>,
"mgmt_ip_address":<String_value>,
"license_edition":<String_value>,
"partition_id":<String_value>,
"plt_bw_available":<Integer_value>,
"cpufrequncy":<Integer_value>,
"cpu_license_type":<Integer_value>,
"location":<String_value>,
"device_family":<String_value>,
"template_interval":<Integer_value>,
"ha_sync":<String_value>,
"contactperson":<String_value>,
"license_grace_time":<Integer_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"scu_free":<Integer_value>,
"total_crypto_devices":<Integer_value>,
"acu_free":<Integer_value>,
"cpu_usage":<Double_value>,
"type":<String_value>,
"bmcrevision":<String_value>,
"memory_total":<Double_value>,
"status":<String_value>,
"gateway":<String_value>,
"internal_annotation":<String_value>,
"config_type":<Integer_value>,
"systemname":<String_value>,
"node_id":<String_value>,
"geo_location":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"provision_request_id":<String_value>,
"httpxforwardedfor":<String_value>,
"rx":<Double_value>,
"ssl_cores_total":<Integer_value>,
"memory_usage":<Double_value>,
"display_name":<String_value>,
"std_bw_total":<Integer_value>,
"ami_id":<String_value>,
"number_of_cpu_cores":<Integer_value>,
"partition_name":<String_value>,
"plt_bw_config":<Integer_value>,
"httpcookie":<String_value>,
"sslvpn_total":<Integer_value>,
"agent_id":<String_value>,
"serialnumber":<String_value>,
"do_instance_config":<Boolean_value>,
"peer_device_ip":<String_value>,
"parent_inventory":<Boolean_value>,
"profile_username":<String_value>,
"profile_password":<String_value>,
"default_password":<String_value>,
"register_failed_device":<Boolean_value>,
"ssl_cores_free":<Integer_value>,
"file_location_path":<String_value>,
"peer_host_device_ip":<String_value>,
"sync_operation":<Boolean_value>,
"act_id":<String_value>,
"file_name":<String_value>,
"device_host_ip":<String_value>,
"tr_task_id":<String_value>,
"entity_tag":[{
"prop_value":<String_value>,
"prop_key":<String_value>}],
"force_password_change":<Boolean_value>}]}