Download full document:

mps_datacenter

Configuration for MPS Datacenter resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
country<String>Read-writecountry.
Maximum length = 32
longitude<Double>Read-writelongitude of the city.
is_default<Boolean>Read-writeIS Default Datacentre.
location<String>Read-writeCloud Provide.
region<String>Read-writeregion.
Maximum length = 64
name<String>Read-writeDatacentre Name.
Minimum length = 1
Maximum length = 128
zipcode<String>Read-writeZipcode of location.
Maximum length = 32
cloud_vpc<String>Read-writecloud_vpc.
Maximum length = 64
city<String>Read-writecity.
Maximum length = 64
tenant_id<String>Read-writeTenant ID.
cloud_provider<String>Read-writeCloud Provide.
latitude<Double>Read-writelatitude of the city.
cloud_region<String>Read-writecloud_region.
Maximum length = 64
id<String>Read-writeId is system generated key for all the system users.
type<Integer>Read-writeDatacenter type: Site/Datacenter.
count_map<entity_map[]>Read-writeCount Map.
application_name<String>Read-writeApplication Name.
device_ip<String>Read-writeDevice Ip.
total_critical_events<Integer>Read-onlyTotal Critical events city wise..
total_number_of_devices<Integer>Read-onlyTotal number of devices deployed city wise...
total_major_events<Integer>Read-onlyTotal major events..
total_events<Integer>Read-onlyTotal events city wise..
total_number_of_agents<Integer>Read-onlyTotal number of agents deployed city wise..

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

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

add

URL: https://<MGMT-IP>/nitro/v1/config/mps_datacenter?onerror=<String_value>

HTTP Method: null

Request Payload:

{mps_datacenter: {
"application_name":<String_value>,
"latitude":<Double_value>,
"cloud_provider":<String_value>,
"id":<String_value>,
"is_default":<Boolean_value>,
"longitude":<Double_value>,
"location":<String_value>,
"name":<String_value>,
"region":<String_value>,
"cloud_region":<String_value>,
"type":<Integer_value>,
"device_ip":<String_value>,
"cloud_vpc":<String_value>,
"count_map":[{
"key":<String_value>,
"value":<String_value>}],
"tenant_id":<String_value>,
"city":<String_value>,
"country":<String_value>,
"zipcode":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_datacenter":[{
"country":<String_value>,
"longitude":<Double_value>,
"is_default":<Boolean_value>,
"location":<String_value>,
"region":<String_value>,
"name":<String_value>,
"zipcode":<String_value>,
"cloud_vpc":<String_value>,
"city":<String_value>,
"tenant_id":<String_value>,
"cloud_provider":<String_value>,
"latitude":<Double_value>,
"cloud_region":<String_value>,
"id":<String_value>,
"type":<Integer_value>,
"count_map":[{
"value":<String_value>,
"key":<String_value>}],
"total_critical_events":<Integer_value>,
"total_number_of_devices":<Integer_value>,
"application_name":<String_value>,
"total_major_events":<Integer_value>,
"total_events":<Integer_value>,
"total_number_of_agents":<Integer_value>,
"device_ip":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/mps_datacenter/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_datacenter

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_datacenter":[{
"country":<String_value>,
"longitude":<Double_value>,
"is_default":<Boolean_value>,
"location":<String_value>,
"region":<String_value>,
"name":<String_value>,
"zipcode":<String_value>,
"cloud_vpc":<String_value>,
"city":<String_value>,
"tenant_id":<String_value>,
"cloud_provider":<String_value>,
"latitude":<Double_value>,
"cloud_region":<String_value>,
"id":<String_value>,
"type":<Integer_value>,
"count_map":[{
"value":<String_value>,
"key":<String_value>}],
"total_critical_events":<Integer_value>,
"total_number_of_devices":<Integer_value>,
"application_name":<String_value>,
"total_major_events":<Integer_value>,
"total_events":<Integer_value>,
"total_number_of_agents":<Integer_value>,
"device_ip":<String_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_datacenter":[{
"country":<String_value>,
"longitude":<Double_value>,
"is_default":<Boolean_value>,
"location":<String_value>,
"region":<String_value>,
"name":<String_value>,
"zipcode":<String_value>,
"cloud_vpc":<String_value>,
"city":<String_value>,
"tenant_id":<String_value>,
"cloud_provider":<String_value>,
"latitude":<Double_value>,
"cloud_region":<String_value>,
"id":<String_value>,
"type":<Integer_value>,
"count_map":[{
"value":<String_value>,
"key":<String_value>}],
"total_critical_events":<Integer_value>,
"total_number_of_devices":<Integer_value>,
"application_name":<String_value>,
"total_major_events":<Integer_value>,
"total_events":<Integer_value>,
"total_number_of_agents":<Integer_value>,
"device_ip":<String_value>}]}

update

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

HTTP Method: null

Request Payload:

{mps_datacenter:{
<b>"id":<String_value></b>,
"application_name":<String_value>,
"latitude":<Double_value>,
"cloud_provider":<String_value>,
"is_default":<Boolean_value>,
"longitude":<Double_value>,
"location":<String_value>,
"name":<String_value>,
"region":<String_value>,
"cloud_region":<String_value>,
"type":<Integer_value>,
"device_ip":<String_value>,
"cloud_vpc":<String_value>,
"count_map":[{
"key":<String_value>,
"value":<String_value>}],
"tenant_id":<String_value>,
"city":<String_value>,
"country":<String_value>,
"zipcode":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_datacenter":[{
"country":<String_value>,
"longitude":<Double_value>,
"is_default":<Boolean_value>,
"location":<String_value>,
"region":<String_value>,
"name":<String_value>,
"zipcode":<String_value>,
"cloud_vpc":<String_value>,
"city":<String_value>,
"tenant_id":<String_value>,
"cloud_provider":<String_value>,
"latitude":<Double_value>,
"cloud_region":<String_value>,
"id":<String_value>,
"type":<Integer_value>,
"count_map":[{
"value":<String_value>,
"key":<String_value>}],
"total_critical_events":<Integer_value>,
"total_number_of_devices":<Integer_value>,
"application_name":<String_value>,
"total_major_events":<Integer_value>,
"total_events":<Integer_value>,
"total_number_of_agents":<Integer_value>,
"device_ip":<String_value>}]}