adminrole : Admin Role object.

An Admin Role object creates and manages a local admin role on the Infoblox appliance. A Role object is used to aggregate a set of permissions (represented by Permission objects).

The name part of the admin role object reference has the following components:

  • Name of the Admin Role object

Example: adminrole/ZG5zLm5ldHdvcmtfdmlldyQxMTk:default

Object Reference

References to adminrole are object references.

Restrictions

The object does not support the following operations:

  • Scheduling

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): comment, name.

The following fields are required to create this object:

Field Notes
name  

comment

comment

The descriptive comment of the Admin Role object.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The comment is part of the base object.

disable

disable

The disable flag.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

name

name

The name of an admin role.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
disable Bool N N N N/A
extattrs Extattr N N N ext
name String Y N Y : = ~

Table Of Contents

Previous topic

admingroup : Admin Group object.

Next topic

adminuser : Admin User object.