mpsgroup

Configuration for System Groups resource.

Read/write properties

apply_all_bound_entities<Boolean>

Apply for all bound entities (TRUE|FALSE).

role<String>

Role (admin|nonadmin).

authscope_props<rba_authscope_props[]>

Authorized Scope Properties.

session_timeout<Integer>

Session timeout for the Group.

assign_all_apps<Boolean>

Assign All Applications (YES|NO).

name<String>

Group Name.
Minimum length = 1
Maximum length = 64

bound_entity_selected<Integer>

Which bound entiy is selected VSERVER(0),SERVICE(1),SERVICEGROUP(2),SERVER(3).

user_session_limit<Integer>

Number of session(s) limited per user part of this group.
Minimum value = 1
Maximum value =

enable_session_timeout<Boolean>

Enables session timeout for group.

assign_all_selected_device_apps<Boolean>

Assign All Application from selected instances (YES|NO).

tenant_id<String>

Id of the tenant.
Minimum length = 1
Maximum length = 128

select_individual_entity<Boolean>

Select Individual Entity Type.

assign_all_devices<Boolean>

Assign All Instances (YES|NO).

assign_all_autoscale_groups<Boolean>

Assign All Autoscale groups (YES|NO).

session_timeout_unit<String>

Session timeout unit for the Group.

description<String>

Description of Group.
Minimum length = 1
Maximum length = 1024

allow_application_only<Boolean>

Checks if only application centic page is needed.

permission<String>

Permission for the group (admin/read-only).
Minimum length = 1
Maximum length = 128

id<String>

Id is system generated key for all the system groups.

users<String[]>

Users belong to the group.

application_names<String[]>

All Application names that are part of this group.This includes selected appnames as well as applications which are result of defined regex.

roles<String[]>

Roles assigned to the group.

autoscale_groups_id<String[]>

Autoscale groups belong to this groupp.

standalone_instances_id<String[]>

Stand alone instances belong to this groupp.

Read only properties

application_names_with_regex<String[]>

Application names defined with regex that are part of this group.

application_names_without_regex<String[]>

selected application names that are part of this group.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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

update add get (all)get delete

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:JSON

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

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:JSON

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

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:JSON

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

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:JSON

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:

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:JSON

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:

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:JSON

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:

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }