Skip to main content

Retrieve applied central access rules for an SVM

Contributors
PDFs

GET /protocols/cifs/group-policies/{svm.uuid}/central-access-rules

Introduced In: 9.12

Retrieves applied central access rules for specified SVM.

  • vserver cifs group-policy central-access-rule show-applied

Parameters

Name Type In Required Description

description

string

query

False

Filter by description

name

string

query

False

Filter by name

  • minLength: 1

proposed_permission

string

query

False

Filter by proposed_permission

create_time

string

query

False

Filter by create_time

current_permission

string

query

False

Filter by current_permission

svm.name

string

query

False

Filter by svm.name

update_time

string

query

False

Filter by update_time

resource_criteria

string

query

False

Filter by resource_criteria

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 central access rules.

records

array[group_policy_object_central_access_rule]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "create_time": "2018-01-01 11:00:00 -0500",
      "current_permission": "O:SYG:SYD:AR(A;;FA;;;WD)",
      "description": "rule #1",
      "name": "p1",
      "proposed_permission": "O:SYG:SYD:(A;;FA;;;OW)(A;;FA;;;BA)(A;;FA;;;SY)",
      "resource_criteria": "department",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "update_time": "2018-01-01 11:00:00 -0500"
    }
  ]
}

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_central_access_rule

Name Type Description

create_time

string

Policy creation timestamp.

current_permission

string

Effective security policy in security descriptor definition language format.

description

string

Description about the policy.

name

string

proposed_permission

string

Proposed security policy in security descriptor definition language format.

resource_criteria

string

Criteria to scope resources for which access rules apply.

svm

svm

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

update_time

string

Last policy modification timestamp.

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.