Skip to content

mps_agent

Configuration for MPS Agent information resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
deployment_status<Boolean>Read-writeDeployment status of this node..
hostname<String>Read-writeHostname of the agent.
down_count<Integer>Read-writeShows for how long agent was down, each value of count increases after every 10 seconds.
state<String>Read-writeAgent state.
password<String>Read-writePassword.
Minimum length = 1
Maximum length = 128
tenant<String>Read-writeTenant.
public_key<String>Read-writepublic key for agent.
platform<String>Read-writePlatform.
id<String>Read-writeId is system generated key for agent registered with NMX Cloud..
instance_id<String>Read-writeUnique ID of device provided by Global Trust Service.
version<String>Read-writeversion..
datacenter_id<String>Read-writeDatacenter Id is system generated key for data center.
name<String>Read-writeAgent IP Address.
rpt_sample_time<Double>Read-writeReport Sample time..
discovery_time<Double>Read-writediscovery time.
username<String>Read-writeusername configured on DB node..
Minimum length = 1
Maximum length = 128
certificate<String>Read-writeName of ABDP Certificate File.
connector_ips<String>Read-writeComma separated list of connector node IPs..
bulk_request_ipaddress<String>Read-writeABDP IP Address..
Minimum length = 1
Maximum length = 64
upgrade_version<String>Read-writeRepresents the next version the agent should upgrade to.
registered_devices<managed_device[]>Read-writeList of registered devices..
bulk_request_port<Integer>Read-writePort number for ABDP.
city<String>Read-writeCity.
mas_version<String>Read-writeMAS server's current version.
url<String>Read-writeURL of ABDP Certificate File Location.
country<String>Read-writeCountry.
region<String>Read-writeRegion.
port<Integer>Read-writePort number for ABDP Certificate file location.
zipcode<String>Read-writeZipcode of location.
Maximum length = 32
server_time<Double>Read-writeMAS server's Epoch time.
loc<String>Read-writeLocation - latitude and longitude.
agent_msg_router_url<String>Read-writeURL for router.

Operations

(click to see Properties)

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>.

delete

URL: https://<MGMT-IP>/nitro/v1/config/mps_agent/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/mps_agent

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_agent":[{
"deployment_status":<Boolean_value>,
"hostname":<String_value>,
"down_count":<Integer_value>,
"state":<String_value>,
"password":<String_value>,
"tenant":<String_value>,
"public_key":<String_value>,
"platform":<String_value>,
"id":<String_value>,
"instance_id":<String_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"name":<String_value>,
"rpt_sample_time":<Double_value>,
"discovery_time":<Double_value>,
"username":<String_value>,
"certificate":<String_value>,
"connector_ips":<String_value>,
"bulk_request_ipaddress":<String_value>,
"upgrade_version":<String_value>,
"registered_devices":[{
"subnet_id":<String_value>,
"manufacturedate":<String_value>,
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_deployment":<Boolean_value>,
"gateway_ipv6":<String_value>,
"ha_master_state":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"device_finger_print":<String_value>,
"instance_state":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"name":<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>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"mastools_version":<String_value>,
"model_id":<String_value>,
"virtualization":<String_value>,
"sysservices":<Double_value>,
"termination_protection":<Boolean_value>,
"ent_bw_total":<Integer_value>,
"vcpu_config":<Integer_value>,
"tenant_id":<String_value>,
"device_uuid":<String_value>,
"netmask":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"public_dns":<String_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"cpufrequncy":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"location":<String_value>,
"contactperson":<String_value>,
"ha_sync":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"geo_location":<String_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"plt_bw_config":<Integer_value>,
"partition_name":<String_value>,
"agent_id":<String_value>,
"sslvpn_total":<Integer_value>,
"serialnumber":<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>}]}],
"bulk_request_port":<Integer_value>,
"city":<String_value>,
"mas_version":<String_value>,
"url":<String_value>,
"country":<String_value>,
"region":<String_value>,
"port":<Integer_value>,
"zipcode":<String_value>,
"server_time":<Double_value>,
"loc":<String_value>,
"agent_msg_router_url":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/mps_agent/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_agent":[{
"deployment_status":<Boolean_value>,
"hostname":<String_value>,
"down_count":<Integer_value>,
"state":<String_value>,
"password":<String_value>,
"tenant":<String_value>,
"public_key":<String_value>,
"platform":<String_value>,
"id":<String_value>,
"instance_id":<String_value>,
"version":<String_value>,
"datacenter_id":<String_value>,
"name":<String_value>,
"rpt_sample_time":<Double_value>,
"discovery_time":<Double_value>,
"username":<String_value>,
"certificate":<String_value>,
"connector_ips":<String_value>,
"bulk_request_ipaddress":<String_value>,
"upgrade_version":<String_value>,
"registered_devices":[{
"subnet_id":<String_value>,
"manufacturedate":<String_value>,
"is_grace":<Boolean_value>,
"hostname":<String_value>,
"std_bw_config":<Integer_value>,
"gateway_deployment":<Boolean_value>,
"gateway_ipv6":<String_value>,
"ha_master_state":<String_value>,
"instance_available":<Integer_value>,
"vpc_id":<String_value>,
"device_finger_print":<String_value>,
"instance_state":<String_value>,
"region":<String_value>,
"reason":<String_value>,
"name":<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>,
"security_group":<String_value>,
"private_dns":<String_value>,
"user_driven":<Boolean_value>,
"zone":<String_value>,
"mastools_version":<String_value>,
"model_id":<String_value>,
"virtualization":<String_value>,
"sysservices":<Double_value>,
"termination_protection":<Boolean_value>,
"ent_bw_total":<Integer_value>,
"vcpu_config":<Integer_value>,
"tenant_id":<String_value>,
"device_uuid":<String_value>,
"netmask":<String_value>,
"do_config":<Boolean_value>,
"autoprovisioned":<Boolean_value>,
"ent_bw_config":<Integer_value>,
"datacenter_id":<String_value>,
"host_id":<String_value>,
"version":<String_value>,
"instance_config":<Integer_value>,
"is_managed":<Boolean_value>,
"key_name":<String_value>,
"discovery_time":<Double_value>,
"instance_mode":<String_value>,
"public_dns":<String_value>,
"instance_total":<Integer_value>,
"is_ha_configured":<Boolean_value>,
"trust_id":<String_value>,
"ipv4_address":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>,
"seq_no":<Double_value>,
"std_bw_available":<Integer_value>,
"sysid":<String_value>,
"tenancy":<String_value>,
"servicepackage":<String_value>,
"last_updated_time":<Double_value>,
"cloud":<String_value>,
"encoded_serialnumber":<String_value>,
"plt_bw_total":<Integer_value>,
"uptime":<String_value>,
"private_ip":<String_value>,
"id":<String_value>,
"mgmt_ip_address":<String_value>,
"ipv6_address":<String_value>,
"partition_id":<String_value>,
"license_edition":<String_value>,
"cpu_license_type":<Integer_value>,
"cpufrequncy":<Integer_value>,
"plt_bw_available":<Integer_value>,
"device_family":<String_value>,
"location":<String_value>,
"contactperson":<String_value>,
"ha_sync":<String_value>,
"public_ip":<String_value>,
"ha_ip_address":<String_value>,
"bmcrevision":<String_value>,
"type":<String_value>,
"gateway":<String_value>,
"status":<String_value>,
"systemname":<String_value>,
"config_type":<Integer_value>,
"geo_location":<String_value>,
"node_id":<String_value>,
"isolation_policy":<String_value>,
"ip_address":<String_value>,
"ping_state":<Integer_value>,
"std_bw_total":<Integer_value>,
"display_name":<String_value>,
"ami_id":<String_value>,
"root_device_type":<String_value>,
"ebs_optimized":<Boolean_value>,
"plt_bw_config":<Integer_value>,
"partition_name":<String_value>,
"agent_id":<String_value>,
"sslvpn_total":<Integer_value>,
"serialnumber":<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>}]}],
"bulk_request_port":<Integer_value>,
"city":<String_value>,
"mas_version":<String_value>,
"url":<String_value>,
"country":<String_value>,
"region":<String_value>,
"port":<Integer_value>,
"zipcode":<String_value>,
"server_time":<Double_value>,
"loc":<String_value>,
"agent_msg_router_url":<String_value>}]}