Skip to main content

Retrieve applied restricted group policies for an SVM

Contributors
PDFs

GET /protocols/cifs/group-policies/{svm.uuid}/restricted-groups

Introduced In: 9.12

Retrieves applied policies of restricted groups for specified SVM.

  • vserver cifs group-policy restricted-group show-applied

Parameters

Name Type In Required Description

version

integer

query

False

Filter by version

members

string

query

False

Filter by members

group_name

string

query

False

Filter by group_name

  • minLength: 1

policy_name

string

query

False

Filter by policy_name

  • minLength: 1

svm.name

string

query

False

Filter by svm.name

memberships

string

query

False

Filter by memberships

link

string

query

False

Filter by link

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

max_records

integer

query

False

Limit the number of records returned.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of restricted group info.

records

array[group_policy_object_restricted_group]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "group_name": "test_group",
      "link": "domain",
      "members": [
        "DOMAIN/test_user",
        "DOMAIN/user2"
      ],
      "memberships": [
        "DOMAIN/AdministratorGrp",
        "DOMAIN/deptMark"
      ],
      "policy_name": "test_policy",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "version": 7
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

svm

Will not be populated for objects that are yet to be applied.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

group_policy_object_restricted_group

Name Type Description

group_name

string

link

string

Link info.

members

array[string]

Members of the group.

memberships

array[string]

Group is member of Group/OU.

policy_index

integer

Group policy index.

policy_name

string

svm

svm

Will not be populated for objects that are yet to be applied.

version

integer

Group policy object version.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.