Citrix ADM NITRO API Reference

mpsgroup

June 20, 2023

Contributed by:

Configuration for System Groups resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
session_timeout		Read-write	Session timeout for the Group.
session_timeout_unit		Read-write	Session timeout unit for the Group.
assign_all_apps		Read-write	Assign All Applications (YES\|NO).
enable_session_timeout		Read-write	Enables session timeout for group.
select_individual_entity		Read-write	Select Individual Entity Type.
authscope_props	<rba_authscope_props[]>	Read-write	Authorized Scope Properties.
tenant_id		Read-write	Id of the tenant. Minimum length = 1 Maximum length = 128
apply_all_bound_entities		Read-write	Apply for all bound entities (TRUE\|FALSE).
assign_all_devices		Read-write	Assign All Instances (YES\|NO).
assign_all_selected_device_apps		Read-write	Assign All Application from selected instances (YES\|NO).
id		Read-write	Id is system generated key for all the system groups.
allow_application_only		Read-write	Checks if only application centic page is needed.
name		Read-write	Group Name. Minimum length = 1 Maximum length = 64
permission		Read-write	Permission for the group (admin/read-only). Minimum length = 1 Maximum length = 128
description		Read-write	Description of Group. Minimum length = 1 Maximum length = 1024
bound_entity_selected		Read-write	Which bound entiy is selected VSERVER(0),SERVICE(1),SERVICEGROUP(2),SERVER(3).
assign_all_autoscale_groups		Read-write	Assign All Autoscale groups (YES\|NO).
role		Read-write	Role (admin\|nonadmin).
roles	<String[]>	Read-write	Roles assigned to the group.
standalone_instances_id	<String[]>	Read-write	Stand alone instances belong to this groupp.
users	<String[]>	Read-write	Users belong to the group.
application_names	<String[]>	Read-write	All Application names that are part of this group.This includes selected appnames as well as applications which are result of defined regex.
autoscale_groups_id	<String[]>	Read-write	Autoscale groups belong to this groupp.
application_names_without_regex	<String[]>	Read-only	selected application names that are part of this group.
application_names_with_regex	<String[]>	Read-only	Application names defined with regex that are part of this group.

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

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

add

URL: https://<MGMT-IP>/nitro/v2/config/mpsgroup?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"mpsgroup": {
<b>"name":<String_value></b>,
<b>"permission":<String_value></b>,
"session_timeout":<Integer_value>,
"enable_session_timeout":<Boolean_value>,
"autoscale_groups_id":<String_value[]>,
"description":<String_value>,
"assign_all_autoscale_groups":<Boolean_value>,
"role":<String_value>,
"standalone_instances_id":<String_value[]>,
"users":<String_value[]>,
"tenant_id":<String_value>,
"authscope_props":[{
<b>"id":<String_value></b>,
"propvalue":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>}],
"select_individual_entity":<Boolean_value>,
"assign_all_devices":<Boolean_value>,
"apply_all_bound_entities":<Boolean_value>,
"bound_entity_selected":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"id":<String_value>,
"roles":<String_value[]>,
"allow_application_only":<Boolean_value>,
"application_names":<String_value[]>,
"assign_all_selected_device_apps":<Boolean_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, "mpsgroup":[{
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"select_individual_entity":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"apply_all_bound_entities":<Boolean_value>,
"assign_all_devices":<Boolean_value>,
"assign_all_selected_device_apps":<Boolean_value>,
"id":<String_value>,
"allow_application_only":<Boolean_value>,
"name":<String_value>,
"permission":<String_value>,
"description":<String_value>,
"bound_entity_selected":<Integer_value>,
"assign_all_autoscale_groups":<Boolean_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_value>}],
"application_names_with_regex":<String_value>,
"autoscale_groups_id":<String_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/mpsgroup/id_value<String> HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Payload:

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

<!--NeedCopy-->

get (all)

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

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

count https://<MGMT-IP>/nitro/v2/config/mpsgroup ?count=yes Use this query-parameter to get the count of mpsgroup 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 Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "mpsgroup":[{
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"select_individual_entity":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"apply_all_bound_entities":<Boolean_value>,
"assign_all_devices":<Boolean_value>,
"assign_all_selected_device_apps":<Boolean_value>,
"id":<String_value>,
"allow_application_only":<Boolean_value>,
"name":<String_value>,
"permission":<String_value>,
"description":<String_value>,
"bound_entity_selected":<Integer_value>,
"assign_all_autoscale_groups":<Boolean_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_value>}],
"application_names_with_regex":<String_value>,
"autoscale_groups_id":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/mpsgroup/id_value<String> 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 Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "mpsgroup":[{
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"select_individual_entity":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"apply_all_bound_entities":<Boolean_value>,
"assign_all_devices":<Boolean_value>,
"assign_all_selected_device_apps":<Boolean_value>,
"id":<String_value>,
"allow_application_only":<Boolean_value>,
"name":<String_value>,
"permission":<String_value>,
"description":<String_value>,
"bound_entity_selected":<Integer_value>,
"assign_all_autoscale_groups":<Boolean_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_value>}],
"application_names_with_regex":<String_value>,
"autoscale_groups_id":<String_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/mpsgroup/id_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"mpsgroup":{
<b>"id":<String_value></b>,
"session_timeout":<Integer_value>,
"enable_session_timeout":<Boolean_value>,
"autoscale_groups_id":<String_value[]>,
"name":<String_value>,
"description":<String_value>,
"assign_all_autoscale_groups":<Boolean_value>,
"role":<String_value>,
"standalone_instances_id":<String_value[]>,
"users":<String_value[]>,
"tenant_id":<String_value>,
"authscope_props":[{
<b>"id":<String_value></b>,
"propvalue":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>}],
"select_individual_entity":<Boolean_value>,
"assign_all_devices":<Boolean_value>,
"apply_all_bound_entities":<Boolean_value>,
"bound_entity_selected":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"roles":<String_value[]>,
"allow_application_only":<Boolean_value>,
"permission":<String_value>,
"application_names":<String_value[]>,
"assign_all_selected_device_apps":<Boolean_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "mpsgroup":[{
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"select_individual_entity":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"apply_all_bound_entities":<Boolean_value>,
"assign_all_devices":<Boolean_value>,
"assign_all_selected_device_apps":<Boolean_value>,
"id":<String_value>,
"allow_application_only":<Boolean_value>,
"name":<String_value>,
"permission":<String_value>,
"description":<String_value>,
"bound_entity_selected":<Integer_value>,
"assign_all_autoscale_groups":<Boolean_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"name":<String_value>,
"display_name":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"vsvr_ip_address":<String_value>,
"configuration_path":<String_value>,
"id":<String_value>,
"type":<String_value>}],
"application_names_with_regex":<String_value>,
"autoscale_groups_id":<String_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

mpsgroup

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

mpsgroup

Properties

Operations

add

delete

get (all)

get

update

In this article