Skip to content

mps

Configuration for System Status resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
maps_apikey<String>Read-writeMaps API Key.
is_cloud<Boolean>Read-writeTrue if its a cloud deployment.
is_member_of_default_group<Boolean>Read-writeIs Member Of Default Group.
deployment_type<String>Read-writeIndicates the type of deployment of MAS: standalone or ha or scaleout..
is_passive<Boolean>Read-writeIndicates the node's state: ACTIVE or PASSIVE in a HA deployment..
privilege_feature<String>Read-writeprivilege_feature.
upgrade_agent_version<String>Read-writeIndicates the next version the agent needs to upgrade to..
build_number_short<String>Read-onlyBuild Number without Date.
current_time<Integer>Read-onlyCurrent Time.
sysid<String>Read-onlySystem Id.
hostname<String>Read-onlyHost name on which system is running.
bios_version<String>Read-onlyBIOS Version.
hostid<String>Read-onlyHost Id.
product_version<String>Read-onlyProduct Version.
uptime<String>Read-onlyUptime.
current_user_permission<String>Read-onlyThis property will show the permission type for current user.
platform<String>Read-onlyPlatform.
hypervisor_uptime<String>Read-onlyHypervisor Uptime.
product_build_number<String>Read-onlyProduct Build Number.
serial<String>Read-onlySerial Number.
host<String>Read-onlyHost IP Address on which system is running, this will set for each client session only.
username<String>Read-onlyUser Name who is currently connected to the system.
current_tenant<String>Read-onlyCurrent Tenant Name for logged-in user.
time_zone_offset<Integer>Read-onlyTime zone offset in minutes (Example:-330).
build_number<String>Read-onlyBuild Number.
current_time_formatted<String>Read-onlyCurrent Time (Formatted).
time_zone<String>Read-onlyServer Time Zone.
product<String>Read-onlyProduct Name.
current_tenant_id<String>Read-onlyCurrent Tenant Id for logged-in user.

Operations

(click to see Properties)

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

reboot

URL: https://<MGMT-IP>/nitro/v1/config/mps?action=reboot;onerror=<String_value>

HTTP Method: null

Request Payload:

{"mps": { }}

Response Payload:

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

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps":[{
"maps_apikey":<String_value>,
"build_number_short":<String_value>,
"is_cloud":<Boolean_value>,
"current_time":<Integer_value>,
"sysid":<String_value>,
"hostname":<String_value>,
"bios_version":<String_value>,
"hostid":<String_value>,
"is_member_of_default_group":<Boolean_value>,
"product_version":<String_value>,
"deployment_type":<String_value>,
"uptime":<String_value>,
"current_user_permission":<String_value>,
"platform":<String_value>,
"is_passive":<Boolean_value>,
"hypervisor_uptime":<String_value>,
"product_build_number":<String_value>,
"serial":<String_value>,
"privilege_feature":<String_value>,
"host":<String_value>,
"username":<String_value>,
"current_tenant":<String_value>,
"time_zone_offset":<Integer_value>,
"build_number":<String_value>,
"current_time_formatted":<String_value>,
"time_zone":<String_value>,
"upgrade_agent_version":<String_value>,
"product":<String_value>,
"current_tenant_id":<String_value>}]}