Skip to main content
A newer release of this product is available.

Create an EMS role-based configuration for an access control role

Contributors
PDFs

POST /support/ems/role-configs

Introduced In: 9.13

Creates an EMS role-based configuration for an access control role.

Required properties

  • access_control_role - Uniquely identifies the access control role.

  • event_filter - Identifies the event filter.

  • limit_access_to_global_configs - Indicates whether the access control role has limited access to global EMS configurations.

  • event role-config create

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_links

access_control_role

access_control_role

Access control role that the event filter is assigned to.

event_filter

event_filter

Event filter that is assigned to the access control role.

limit_access_to_global_configs

boolean

Indicates whether the access control has limited access to global EMS configurations.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "access_control_role": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "admin"
  },
  "event_filter": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "important-events"
  }
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "access_control_role": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "admin"
      },
      "event_filter": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "important-events"
      }
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

983198

The event filter provided does not exist.

983199

The access control role provided does not exist.

Also see the table of common errors in the Response body overview section of this documentation.

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

self

href

access_control_role

Access control role that the event filter is assigned to.

Name Type Description

_links

_links

name

string

Role name

event_filter

Event filter that is assigned to the access control role.

Name Type Description

_links

_links

name

string

ems_role_config

Name Type Description

_links

_links

access_control_role

access_control_role

Access control role that the event filter is assigned to.

event_filter

event_filter

Event filter that is assigned to the access control role.

limit_access_to_global_configs

boolean

Indicates whether the access control has limited access to global EMS configurations.

_links

Name Type Description

next

href

self

href

records

Name Type Description

_links

_links

access_control_role

access_control_role

Access control role that the event filter is assigned to.

event_filter

event_filter

Event filter that is assigned to the access control role.

limit_access_to_global_configs

boolean

Indicates whether the access control has limited access to global EMS configurations.

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.