Skip to content

mps_agent

Configuration for MPS Agent information resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
deployment_status <Boolean> Read-write Deployment status of this node..
disk_count <Integer> Read-write Shows for how long agent disk threshold breach, each value of count increases after every 5 minutes.
disk_usage <Double> Read-write Total disk space usage..
hostname <String> Read-write Hostname of the agent.
down_count <Integer> Read-write Shows for how long agent was down, each value of count increases after every 10 seconds.
state <String> Read-write Agent state.
cpu_count <Integer> Read-write Shows for how long agent cpu threshold breach, each value of count increases after every 5 minutes.
password <String> Read-write Password.

Minimum length = 1

Maximum length = 128
tenant <String> Read-write Tenant.
memory_count <Integer> Read-write Shows for how long agent memory threshold breach, each value of count increases after every 5 minutes.
public_key <String> Read-write public key for agent.
platform <String> Read-write Platform.
id <String> Read-write Id is system generated key for agent registered with NMX Cloud..
instance_id <String> Read-write Unique ID of device provided by Global Trust Service.
provision_request_id <String> Read-write Value is set only if the instance was provisioned from MAS.
version <String> Read-write version..
datacenter_id <String> Read-write Datacenter Id is system generated key for data center.
memory_usage <Double> Read-write Total memory usage..
name <String> Read-write Agent IP Address.
rpt_sample_time <Double> Read-write Report Sample time..
discovery_time <Double> Read-write discovery time.
username <String> Read-write username configured on DB node..

Minimum length = 1

Maximum length = 128
cpu_usage <Double> Read-write Total CPU usage..
agent_upgrade_state <String> Read-write Status of Agent Upgrade(Scheduled/InProgress/Success/Failed)..

Maximum length = 128
certificate <String> Read-write Name of ABDP Certificate File.
connector_ips <String> Read-write Comma separated list of connector node IPs..
bulk_request_ipaddress <String> Read-write ABDP IP Address..

Minimum length = 1

Maximum length = 64
upgrade_version <String> Read-write Represents the next version the agent should upgrade to.
registered_devices <managed_device[]> Read-write List of registered devices..
bulk_request_port <Integer> Read-write Port number for ABDP.
city <String> Read-write City.
act_id <String> Read-write Activity Id.
mas_version <String> Read-write Citrix ADM server's current version.
url <String> Read-write URL of ABDP Certificate File Location.
country <String> Read-write Country.
region <String> Read-write Region.
new_password <String> Read-write new password.
port <Integer> Read-write Port number for ABDP Certificate file location.
zipcode <String> Read-write Zipcode of location.

Maximum length = 32
server_time <Double> Read-write Citrix ADM server's Epoch time.
loc <String> Read-write Location - latitude and longitude.
agent_msg_router_url <String> Read-write URL for router.

Operations

(click to see Properties )

  • RESTART
  • REBOOT
  • 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

restart

URL: https://<MGMT-IP>/nitro/v2/config/mps_agent?action=restart;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:

{"mps_agent": {
      "hostname":<String_value>,
      "registered_devices":[{
      "instance_classifier":<Integer_value>,
      "hostname":<String_value>,
      "gateway_deployment":<Boolean_value>,
      "std_bw_config":<Integer_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>,
      "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>,
      "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_key":<String_value>,
      "prop_value":<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>,
      "mgmt_ip_address":<String_value>,
      "ipv6_address":<String_value>,
      "partition_id":<String_value>,
      "license_edition":<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>,
      "ip_address":<String_value>,
      "provision_request_id":<String_value>,
      "httpxforwardedfor":<String_value>,
      "std_bw_total":<Integer_value>,
      "display_name":<String_value>,
      "plt_bw_config":<Integer_value>,
      "partition_name":<String_value>,
      "agent_id":<String_value>,
      "sslvpn_total":<Integer_value>,
      "tr_task_id":<String_value>}],
      "password":<String_value>,
      "cpu_count":<Integer_value>,
      "act_id":<String_value>,
      "tenant":<String_value>,
      "url":<String_value>,
      "region":<String_value>,
      "name":<String_value>,
      "new_password":<String_value>,
      "username":<String_value>,
      "loc":<String_value>,
      "disk_usage":<Double_value>,
      "bulk_request_ipaddress":<String_value>,
      "upgrade_version":<String_value>,
      "down_count":<Integer_value>,
      "mas_version":<String_value>,
      "platform":<String_value>,
      "country":<String_value>,
      "datacenter_id":<String_value>,
      "version":<String_value>,
      "rpt_sample_time":<Double_value>,
      "discovery_time":<Double_value>,
      "agent_upgrade_state":<String_value>,
      "deployment_status":<Boolean_value>,
      "connector_ips":<String_value>,
      "state":<String_value>,
      "bulk_request_port":<Integer_value>,
      "id":<String_value>,
      "public_key":<String_value>,
      "port":<Integer_value>,
      "server_time":<Double_value>,
      "cpu_usage":<Double_value>,
      "certificate":<String_value>,
      "disk_count":<Integer_value>,
      "city":<String_value>,
      "memory_count":<Integer_value>,
      "instance_id":<String_value>,
      "provision_request_id":<String_value>,
      "memory_usage":<Double_value>,
      "zipcode":<String_value>,
      "agent_msg_router_url":<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, "mps_agent":[{
      "deployment_status":<Boolean_value>,
      "disk_count":<Integer_value>,
      "disk_usage":<Double_value>,
      "hostname":<String_value>,
      "down_count":<Integer_value>,
      "state":<String_value>,
      "cpu_count":<Integer_value>,
      "password":<String_value>,
      "tenant":<String_value>,
      "memory_count":<Integer_value>,
      "public_key":<String_value>,
      "platform":<String_value>,
      "id":<String_value>,
      "instance_id":<String_value>,
      "provision_request_id":<String_value>,
      "version":<String_value>,
      "datacenter_id":<String_value>,
      "memory_usage":<Double_value>,
      "name":<String_value>,
      "rpt_sample_time":<Double_value>,
      "discovery_time":<Double_value>,
      "username":<String_value>,
      "cpu_usage":<Double_value>,
      "agent_upgrade_state":<String_value>,
      "certificate":<String_value>,
      "connector_ips":<String_value>,
      "bulk_request_ipaddress":<String_value>,
      "upgrade_version":<String_value>,
      "registered_devices":[{
      "instance_classifier":<Integer_value>,
      "subnet_id":<String_value>,
      "manufacturedate":<String_value>,
      "is_grace":<Boolean_value>,
      "hostname":<String_value>,
      "std_bw_config":<Integer_value>,
      "gateway_deployment":<Boolean_value>,
      "is_fips_pooled_license_type":<Integer_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>,
      "httpquerywithurl":<String_value>,
      "region":<String_value>,
      "reason":<String_value>,
      "name":<String_value>,
      "ent_bw_available":<Integer_value>,
      "description":<String_value>,
      "is_autoscale_group":<Boolean_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>,
      "sysservices":<Double_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>,
      "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>,
      "servicepackage":<String_value>,
      "last_updated_time":<Double_value>,
      "cloud":<String_value>,
      "encoded_serialnumber":<String_value>,
      "instance_unique_id":<Integer_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>,
      "template_interval":<Integer_value>,
      "license_grace_time":<Integer_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>,
      "internal_annotation":<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>,
      "provision_request_id":<String_value>,
      "ping_state":<Integer_value>,
      "httpxforwardedfor":<String_value>,
      "std_bw_total":<Integer_value>,
      "display_name":<String_value>,
      "ami_id":<String_value>,
      "httpcookie":<String_value>,
      "plt_bw_config":<Integer_value>,
      "partition_name":<String_value>,
      "agent_id":<String_value>,
      "sslvpn_total":<Integer_value>,
      "serialnumber":<String_value>
      "peer_device_ip":<String_value>
      "parent_inventory":<Boolean_value>
      "profile_password":<String_value>
      "register_failed_device":<Boolean_value>
      "act_id":<String_value>
      "file_name":<String_value>
      "do_instance_config":<Boolean_value>
      "profile_username":<String_value>
      "default_password":<String_value>
      "file_location_path":<String_value>
      "sync_operation":<Boolean_value>
      "peer_host_device_ip":<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>}],
      "bulk_request_port":<Integer_value>,
      "city":<String_value>,
      "act_id":<String_value>,
      "mas_version":<String_value>,
      "url":<String_value>,
      "country":<String_value>,
      "region":<String_value>,
      "new_password":<String_value>,
      "port":<Integer_value>,
      "zipcode":<String_value>,
      "server_time":<Double_value>,
      "loc":<String_value>,
      "agent_msg_router_url":<String_value>}]}

reboot

URL: https://<MGMT-IP>/nitro/v2/config/mps_agent?action=reboot;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:

{"mps_agent": {
      "hostname":<String_value>,
      "registered_devices":[{
      "instance_classifier":<Integer_value>,
      "hostname":<String_value>,
      "gateway_deployment":<Boolean_value>,
      "std_bw_config":<Integer_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>,
      "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>,
      "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_key":<String_value>,
      "prop_value":<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>,
      "mgmt_ip_address":<String_value>,
      "ipv6_address":<String_value>,
      "partition_id":<String_value>,
      "license_edition":<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>,
      "ip_address":<String_value>,
      "provision_request_id":<String_value>,
      "httpxforwardedfor":<String_value>,
      "std_bw_total":<Integer_value>,
      "display_name":<String_value>,
      "plt_bw_config":<Integer_value>,
      "partition_name":<String_value>,
      "agent_id":<String_value>,
      "sslvpn_total":<Integer_value>,
      "tr_task_id":<String_value>}],
      "password":<String_value>,
      "cpu_count":<Integer_value>,
      "act_id":<String_value>,
      "tenant":<String_value>,
      "url":<String_value>,
      "region":<String_value>,
      "name":<String_value>,
      "new_password":<String_value>,
      "username":<String_value>,
      "loc":<String_value>,
      "disk_usage":<Double_value>,
      "bulk_request_ipaddress":<String_value>,
      "upgrade_version":<String_value>,
      "down_count":<Integer_value>,
      "mas_version":<String_value>,
      "platform":<String_value>,
      "country":<String_value>,
      "datacenter_id":<String_value>,
      "version":<String_value>,
      "rpt_sample_time":<Double_value>,
      "discovery_time":<Double_value>,
      "agent_upgrade_state":<String_value>,
      "deployment_status":<Boolean_value>,
      "connector_ips":<String_value>,
      "state":<String_value>,
      "bulk_request_port":<Integer_value>,
      "id":<String_value>,
      "public_key":<String_value>,
      "port":<Integer_value>,
      "server_time":<Double_value>,
      "cpu_usage":<Double_value>,
      "certificate":<String_value>,
      "disk_count":<Integer_value>,
      "city":<String_value>,
      "memory_count":<Integer_value>,
      "instance_id":<String_value>,
      "provision_request_id":<String_value>,
      "memory_usage":<Double_value>,
      "zipcode":<String_value>,
      "agent_msg_router_url":<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, "mps_agent":[{
      "deployment_status":<Boolean_value>,
      "disk_count":<Integer_value>,
      "disk_usage":<Double_value>,
      "hostname":<String_value>,
      "down_count":<Integer_value>,
      "state":<String_value>,
      "cpu_count":<Integer_value>,
      "password":<String_value>,
      "tenant":<String_value>,
      "memory_count":<Integer_value>,
      "public_key":<String_value>,
      "platform":<String_value>,
      "id":<String_value>,
      "instance_id":<String_value>,
      "provision_request_id":<String_value>,
      "version":<String_value>,
      "datacenter_id":<String_value>,
      "memory_usage":<Double_value>,
      "name":<String_value>,
      "rpt_sample_time":<Double_value>,
      "discovery_time":<Double_value>,
      "username":<String_value>,
      "cpu_usage":<Double_value>,
      "agent_upgrade_state":<String_value>,
      "certificate":<String_value>,
      "connector_ips":<String_value>,
      "bulk_request_ipaddress":<String_value>,
      "upgrade_version":<String_value>,
      "registered_devices":[{
      "instance_classifier":<Integer_value>,
      "subnet_id":<String_value>,
      "manufacturedate":<String_value>,
      "is_grace":<Boolean_value>,
      "hostname":<String_value>,
      "std_bw_config":<Integer_value>,
      "gateway_deployment":<Boolean_value>,
      "is_fips_pooled_license_type":<Integer_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>,
      "httpquerywithurl":<String_value>,
      "region":<String_value>,
      "reason":<String_value>,
      "name":<String_value>,
      "ent_bw_available":<Integer_value>,
      "description":<String_value>,
      "is_autoscale_group":<Boolean_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>,
      "sysservices":<Double_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>,
      "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>,
      "servicepackage":<String_value>,
      "last_updated_time":<Double_value>,
      "cloud":<String_value>,
      "encoded_serialnumber":<String_value>,
      "instance_unique_id":<Integer_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>,
      "template_interval":<Integer_value>,
      "license_grace_time":<Integer_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>,
      "internal_annotation":<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>,
      "provision_request_id":<String_value>,
      "ping_state":<Integer_value>,
      "httpxforwardedfor":<String_value>,
      "std_bw_total":<Integer_value>,
      "display_name":<String_value>,
      "ami_id":<String_value>,
      "httpcookie":<String_value>,
      "plt_bw_config":<Integer_value>,
      "partition_name":<String_value>,
      "agent_id":<String_value>,
      "sslvpn_total":<Integer_value>,
      "serialnumber":<String_value>
      "peer_device_ip":<String_value>
      "parent_inventory":<Boolean_value>
      "profile_password":<String_value>
      "register_failed_device":<Boolean_value>
      "act_id":<String_value>
      "file_name":<String_value>
      "do_instance_config":<Boolean_value>
      "profile_username":<String_value>
      "default_password":<String_value>
      "file_location_path":<String_value>
      "sync_operation":<Boolean_value>
      "peer_host_device_ip":<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>}],
      "bulk_request_port":<Integer_value>,
      "city":<String_value>,
      "act_id":<String_value>,
      "mas_version":<String_value>,
      "url":<String_value>,
      "country":<String_value>,
      "region":<String_value>,
      "new_password":<String_value>,
      "port":<Integer_value>,
      "zipcode":<String_value>,
      "server_time":<Double_value>,
      "loc":<String_value>,
      "agent_msg_router_url":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/mps_agent/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/mps_agent

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/mps_agent ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of mps_agent 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/mps_agent ?pagesize=#no;pageno=#no

Use this query-parameter to get the mps_agent resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/mps_agent ?count=yes

Use this query-parameter to get the count of mps_agent 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, "mps_agent":[{
      "deployment_status":<Boolean_value>,
      "disk_count":<Integer_value>,
      "disk_usage":<Double_value>,
      "hostname":<String_value>,
      "down_count":<Integer_value>,
      "state":<String_value>,
      "cpu_count":<Integer_value>,
      "password":<String_value>,
      "tenant":<String_value>,
      "memory_count":<Integer_value>,
      "public_key":<String_value>,
      "platform":<String_value>,
      "id":<String_value>,
      "instance_id":<String_value>,
      "provision_request_id":<String_value>,
      "version":<String_value>,
      "datacenter_id":<String_value>,
      "memory_usage":<Double_value>,
      "name":<String_value>,
      "rpt_sample_time":<Double_value>,
      "discovery_time":<Double_value>,
      "username":<String_value>,
      "cpu_usage":<Double_value>,
      "agent_upgrade_state":<String_value>,
      "certificate":<String_value>,
      "connector_ips":<String_value>,
      "bulk_request_ipaddress":<String_value>,
      "upgrade_version":<String_value>,
      "registered_devices":[{
      "instance_classifier":<Integer_value>,
      "subnet_id":<String_value>,
      "manufacturedate":<String_value>,
      "is_grace":<Boolean_value>,
      "hostname":<String_value>,
      "std_bw_config":<Integer_value>,
      "gateway_deployment":<Boolean_value>,
      "is_fips_pooled_license_type":<Integer_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>,
      "httpquerywithurl":<String_value>,
      "region":<String_value>,
      "reason":<String_value>,
      "name":<String_value>,
      "ent_bw_available":<Integer_value>,
      "description":<String_value>,
      "is_autoscale_group":<Boolean_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>,
      "sysservices":<Double_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>,
      "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>,
      "servicepackage":<String_value>,
      "last_updated_time":<Double_value>,
      "cloud":<String_value>,
      "encoded_serialnumber":<String_value>,
      "instance_unique_id":<Integer_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>,
      "template_interval":<Integer_value>,
      "license_grace_time":<Integer_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>,
      "internal_annotation":<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>,
      "provision_request_id":<String_value>,
      "ping_state":<Integer_value>,
      "httpxforwardedfor":<String_value>,
      "std_bw_total":<Integer_value>,
      "display_name":<String_value>,
      "ami_id":<String_value>,
      "httpcookie":<String_value>,
      "plt_bw_config":<Integer_value>,
      "partition_name":<String_value>,
      "agent_id":<String_value>,
      "sslvpn_total":<Integer_value>,
      "serialnumber":<String_value>
      "peer_device_ip":<String_value>
      "parent_inventory":<Boolean_value>
      "profile_password":<String_value>
      "register_failed_device":<Boolean_value>
      "act_id":<String_value>
      "file_name":<String_value>
      "do_instance_config":<Boolean_value>
      "profile_username":<String_value>
      "default_password":<String_value>
      "file_location_path":<String_value>
      "sync_operation":<Boolean_value>
      "peer_host_device_ip":<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>}],
      "bulk_request_port":<Integer_value>,
      "city":<String_value>,
      "act_id":<String_value>,
      "mas_version":<String_value>,
      "url":<String_value>,
      "country":<String_value>,
      "region":<String_value>,
      "new_password":<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/v2/config/mps_agent/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, "mps_agent":[{
      "deployment_status":<Boolean_value>,
      "disk_count":<Integer_value>,
      "disk_usage":<Double_value>,
      "hostname":<String_value>,
      "down_count":<Integer_value>,
      "state":<String_value>,
      "cpu_count":<Integer_value>,
      "password":<String_value>,
      "tenant":<String_value>,
      "memory_count":<Integer_value>,
      "public_key":<String_value>,
      "platform":<String_value>,
      "id":<String_value>,
      "instance_id":<String_value>,
      "provision_request_id":<String_value>,
      "version":<String_value>,
      "datacenter_id":<String_value>,
      "memory_usage":<Double_value>,
      "name":<String_value>,
      "rpt_sample_time":<Double_value>,
      "discovery_time":<Double_value>,
      "username":<String_value>,
      "cpu_usage":<Double_value>,
      "agent_upgrade_state":<String_value>,
      "certificate":<String_value>,
      "connector_ips":<String_value>,
      "bulk_request_ipaddress":<String_value>,
      "upgrade_version":<String_value>,
      "registered_devices":[{
      "instance_classifier":<Integer_value>,
      "subnet_id":<String_value>,
      "manufacturedate":<String_value>,
      "is_grace":<Boolean_value>,
      "hostname":<String_value>,
      "std_bw_config":<Integer_value>,
      "gateway_deployment":<Boolean_value>,
      "is_fips_pooled_license_type":<Integer_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>,
      "httpquerywithurl":<String_value>,
      "region":<String_value>,
      "reason":<String_value>,
      "name":<String_value>,
      "ent_bw_available":<Integer_value>,
      "description":<String_value>,
      "is_autoscale_group":<Boolean_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>,
      "sysservices":<Double_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>,
      "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>,
      "servicepackage":<String_value>,
      "last_updated_time":<Double_value>,
      "cloud":<String_value>,
      "encoded_serialnumber":<String_value>,
      "instance_unique_id":<Integer_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>,
      "template_interval":<Integer_value>,
      "license_grace_time":<Integer_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>,
      "internal_annotation":<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>,
      "provision_request_id":<String_value>,
      "ping_state":<Integer_value>,
      "httpxforwardedfor":<String_value>,
      "std_bw_total":<Integer_value>,
      "display_name":<String_value>,
      "ami_id":<String_value>,
      "httpcookie":<String_value>,
      "plt_bw_config":<Integer_value>,
      "partition_name":<String_value>,
      "agent_id":<String_value>,
      "sslvpn_total":<Integer_value>,
      "serialnumber":<String_value>
      "peer_device_ip":<String_value>
      "parent_inventory":<Boolean_value>
      "profile_password":<String_value>
      "register_failed_device":<Boolean_value>
      "act_id":<String_value>
      "file_name":<String_value>
      "do_instance_config":<Boolean_value>
      "profile_username":<String_value>
      "default_password":<String_value>
      "file_location_path":<String_value>
      "sync_operation":<Boolean_value>
      "peer_host_device_ip":<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>}],
      "bulk_request_port":<Integer_value>,
      "city":<String_value>,
      "act_id":<String_value>,
      "mas_version":<String_value>,
      "url":<String_value>,
      "country":<String_value>,
      "region":<String_value>,
      "new_password":<String_value>,
      "port":<Integer_value>,
      "zipcode":<String_value>,
      "server_time":<Double_value>,
      "loc":<String_value>,
      "agent_msg_router_url":<String_value>}]}
Was this article helpful?