Skip to content

mps_health

Configuration for Health Monitoring Stats resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
disks_usage<mps_disk_usage[]>Read-writeIndividual Disks Usage.
node_id<String>Read-writeApplication Node ID.
id<String>Read-writeId is system generated key.
memory_total<Double>Read-onlyTotal memory in KB.
disk_total_capacity<Double>Read-onlyDisk Total Capacity in KB.
disk_usage<Double>Read-onlyDisk Usage (%).
disk_total<Double>Read-onlyTotal available disk space in KB.
memory_usage<Double>Read-onlyMemory Usage (%).
disk_free<Double>Read-onlyFree disk available in KB.
page_size<Double>Read-onlyTotal memory in KB.
memory_free<Double>Read-onlyFree memory available in KB.
cpu_usage<Double>Read-onlyCPU Usage (%).
disk_used<Double>Read-onlyDisk used in KB.

Operations

(click to see Properties)

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_health":[{
"disks_usage":[{
"free_space":<Double_value>,
"parent_name":<String_value>,
"disk_usage":<Double_value>,
"used_space":<Double_value>,
"parent_id":<String_value>,
"disk_name":<String_value>,
"total_space":<Double_value>,
"disk_partition":<String_value>,
"disk_slice":<String_value>,
"id":<String_value>,
"disk_capacity":<Double_value>}],
"memory_total":<Double_value>,
"disk_total_capacity":<Double_value>,
"disk_usage":<Double_value>,
"disk_total":<Double_value>,
"memory_usage":<Double_value>,
"disk_free":<Double_value>,
"page_size":<Double_value>,
"node_id":<String_value>,
"memory_free":<Double_value>,
"cpu_usage":<Double_value>,
"id":<String_value>,
"disk_used":<Double_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_health":[{
"disks_usage":[{
"free_space":<Double_value>,
"parent_name":<String_value>,
"disk_usage":<Double_value>,
"used_space":<Double_value>,
"parent_id":<String_value>,
"disk_name":<String_value>,
"total_space":<Double_value>,
"disk_partition":<String_value>,
"disk_slice":<String_value>,
"id":<String_value>,
"disk_capacity":<Double_value>}],
"memory_total":<Double_value>,
"disk_total_capacity":<Double_value>,
"disk_usage":<Double_value>,
"disk_total":<Double_value>,
"memory_usage":<Double_value>,
"disk_free":<Double_value>,
"page_size":<Double_value>,
"node_id":<String_value>,
"memory_free":<Double_value>,
"cpu_usage":<Double_value>,
"id":<String_value>,
"disk_used":<Double_value>}]}