Developer Documentation
NetScaler SDX 14.1 NITRO API Reference

mps

March 20, 2024
Contributed by: 
C

Configuration for System Status resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
maps_apikey Read-write Maps API Key.
deployment_type Read-write Indicates the type of deployment of Citrix ADM: standalone or ha or scaleout..
is_passive Read-write Indicates the node’s state: ACTIVE or PASSIVE in a HA deployment..
privilege_feature Read-write privilege_feature.
is_cloud Read-write True if its a cloud deployment.
is_member_of_default_group Read-write Is Member Of Default Group.
motd Read-write Message of the Day (contents of motd file) that can be shown on UI after successful login.
config_motd Read-write Configure Message of the Day (contents of motd file), this needs to be set true if user wants to configure message if the day.
is_container Read-write True if its a container deployment.
hist_mig_inprog Read-write Indicates whether the historical tables database migration is in progress or not..
upgrade_agent_version Read-write Indicates the next version the agent needs to upgrade to..
build_number_short Read-only Build Number without Date.
sysid Read-only System Id.
hostname Read-only Host name on which system is running.
bios_version Read-only BIOS Version.
uptime Read-only Uptime.
current_user_permission Read-only This property will show the permission type for current user.
product_build_number Read-only Product Build Number.
serial Read-only Serial Number.
username Read-only User Name who is currently connected to the system.
current_tenant Read-only Current Tenant Name for logged-in user.
current_time_formatted Read-only Current Time (Formatted).
current_time Read-only Current Time.
hostid Read-only Host Id.
product_version Read-only Product Version.
platform Read-only Platform.
hypervisor_uptime Read-only Hypervisor Uptime.
host Read-only Host IP Address on which system is running, this will set for each client session only.
build_number Read-only Build Number.
time_zone_offset Read-only Time zone offset in minutes (Example:-330).
time_zone Read-only Server Time Zone.
product Read-only Product Name.
current_tenant_id Read-only Current Tenant Id for logged-in user.

Operations

(click to see Properties )

  • GET
  • MODIFY

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

get

URL: https://<MGMT-IP>/nitro/v2/config/mps 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":[{
"maps_apikey":<String_value>,
"build_number_short":<String_value>,
"sysid":<String_value>,
"hostname":<String_value>,
"bios_version":<String_value>,
"deployment_type":<String_value>,
"uptime":<String_value>,
"current_user_permission":<String_value>,
"is_passive":<Boolean_value>,
"product_build_number":<String_value>,
"serial":<String_value>,
"privilege_feature":<String_value>,
"username":<String_value>,
"current_tenant":<String_value>,
"current_time_formatted":<String_value>,
"is_cloud":<Boolean_value>,
"current_time":<Integer_value>,
"hostid":<String_value>,
"is_member_of_default_group":<Boolean_value>,
"product_version":<String_value>,
"platform":<String_value>,
"motd":<String_value>,
"hypervisor_uptime":<String_value>,
"config_motd":<Boolean_value>,
"host":<String_value>,
"build_number":<String_value>,
"time_zone_offset":<Integer_value>,
"is_container":<Boolean_value>,
"hist_mig_inprog":<Boolean_value>,
"time_zone":<String_value>,
"product":<String_value>,
"upgrade_agent_version":<String_value>,
"current_tenant_id":<String_value>}]}

<!--NeedCopy-->

modify

URL: https://<MGMT-IP>/nitro/v2/config/mps/ HTTPS Method: PUT

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":{
"maps_apikey":<String_value>,
"is_cloud":<Boolean_value>,
"is_passive":<Boolean_value>,
"config_motd":<Boolean_value>,
"privilege_feature":<String_value>,
"is_member_of_default_group":<Boolean_value>,
"deployment_type":<String_value>,
"is_container":<Boolean_value>,
"hist_mig_inprog":<Boolean_value>,
"upgrade_agent_version":<String_value>,
"motd":<String_value>}}

<!--NeedCopy-->

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":[{
"maps_apikey":<String_value>,
"build_number_short":<String_value>,
"sysid":<String_value>,
"hostname":<String_value>,
"bios_version":<String_value>,
"deployment_type":<String_value>,
"uptime":<String_value>,
"current_user_permission":<String_value>,
"is_passive":<Boolean_value>,
"product_build_number":<String_value>,
"serial":<String_value>,
"privilege_feature":<String_value>,
"username":<String_value>,
"current_tenant":<String_value>,
"current_time_formatted":<String_value>,
"is_cloud":<Boolean_value>,
"current_time":<Integer_value>,
"hostid":<String_value>,
"is_member_of_default_group":<Boolean_value>,
"product_version":<String_value>,
"platform":<String_value>,
"motd":<String_value>,
"hypervisor_uptime":<String_value>,
"config_motd":<Boolean_value>,
"host":<String_value>,
"build_number":<String_value>,
"time_zone_offset":<Integer_value>,
"is_container":<Boolean_value>,
"hist_mig_inprog":<Boolean_value>,
"time_zone":<String_value>,
"product":<String_value>,
"upgrade_agent_version":<String_value>,
"current_tenant_id":<String_value>}]}

<!--NeedCopy-->
mps
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.