mas_summary

June 20, 2023

Contributed by:

Configuration for Citrix ADM Summary resource.

Properties

(click to see Operations )

Name	Permissions	Description
sdx_count	Read-only	SDX count.
ns_service_count	Read-only	Service count.
ns_ssl_certkey_count	Read-only	SSL certificate count.
ns_servicegroup_count	Read-only	Service count.
tenant_count	Read-only	Tenants count.
swg_count	Read-only	SWG count.
dc_count	Read-only	DataCenter count.
sdwanwo_count	Read-only	Citrix SD-WAN WO count.
ns_gslbservice_count	Read-only	GSLB Service count.
ns_vip_count	Read-only	VIP count.
gateway_count	Read-only	Gateway count.
partition_count	Read-only	Admin Partitions count.
application_count	Read-only	Application count.
haproxy_count	Read-only	HAProxy count.
ns_count	Read-only	Citrix ADC count.
ns_gslbservicegroup_count	Read-only	GSLB ServiceGroup count.
sdwanee_count	Read-only	Citrix SD-WAN EE count.
blx_count	Read-only	BLX count.

Operations

(click to see Properties )

GET (ALL)

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 (all)

URL: https://<MGMT-IP>/nitro/v2/config/mas_summary Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/mas_summary ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of mas_summary 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/mas_summary ?pagesize=#no;pageno=#no Use this query-parameter to get the mas_summary resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/mas_summary ?count=yes Use this query-parameter to get the count of mas_summary resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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, "mas_summary":[{
"sdx_count":<Integer_value>,
"ns_service_count":<Integer_value>,
"ns_ssl_certkey_count":<Integer_value>,
"ns_servicegroup_count":<Integer_value>,
"tenant_count":<Integer_value>,
"swg_count":<Integer_value>,
"dc_count":<Integer_value>,
"sdwanwo_count":<Integer_value>,
"ns_gslbservice_count":<Integer_value>,
"ns_vip_count":<Integer_value>,
"gateway_count":<Integer_value>,
"partition_count":<Integer_value>,
"application_count":<Integer_value>,
"haproxy_count":<Integer_value>,
"ns_count":<Integer_value>,
"ns_gslbservicegroup_count":<Integer_value>,
"sdwanee_count":<Integer_value>,
"blx_count":<Integer_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

mas_summary

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

mas_summary

Properties

Operations

get (all)

In this article