admingroup : Admin Group object.

An Admin Group object creates and manages a local admin group on the Infoblox appliance. The privileges and properties that are set for the group apply to all the admin accounts that are assigned to the group.

Object Reference

References to admingroup are object references.

Restrictions

The object does not support the following operations:

  • Scheduling
  • CSV export

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  

access_method

access_method

Access methods specify whether an admin group can use the GUI and the API to access the appliance or to send Taxii messages to the appliance. Note that API includes both the Perl API and RESTful API.

Type

Enum values array.

Valid values are:
  • API
  • CLOUD_API
  • GUI
  • TAXII

Create

The default value is [‘GUI’, ‘API’, ‘TAXII’].

Search

The field is not available for search.

comment

comment

Comment for the Admin Group; maximum 256 characters.

Type

String.

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

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

Determines whether the Admin Group is disabled or not. When this is set to False, the Admin Group is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

disable_concurrent_login

disable_concurrent_login

Disable concurrent login feature

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

email_addresses

email_addresses

The e-mail addresses for the Admin Group.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

enable_restricted_user_access

enable_restricted_user_access

Determines whether the restrictions will be applied to the admin connector level for users of this Admin Group.

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.

inactivity_lockout_setting

inactivity_lockout_setting

The Admin group inactivity lockout settings.

Type

A/An Inactivity Lockout settings struct.

Create

The default value is:

  { 'account_inactivity_lockout_enable': False,
'inactive_days': 30,
'reactivate_via_remote_console_enable': True,
'reactivate_via_serial_console_enable': True,
'reminder_days': 15}

Search

The field is not available for search.

Notes

inactivity_lockout_setting is associated with the field use_account_inactivity_lockout_enable (see use flag).

lockout_setting

lockout_setting

This struct specifies security policy settings in admin group.

Type

A/An lockout_setting struct.

Create

The default value is:

  { 'enable_sequential_failed_login_attempts_lockout': False,
'failed_lockout_duration': 5,
'never_unlock_user': False,
'sequential_attempts': 5}

Search

The field is not available for search.

Notes

lockout_setting is associated with the field use_lockout_setting (see use flag).

name

name

The name of the Admin Group.

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.

password_setting

password_setting

The Admin Group password settings.

Type

A/An Password settings struct.

Create

The default value is:

{ 'expire_days': 30, 'expire_enable': False, 'reminder_days': 15}

Search

The field is not available for search.

Notes

password_setting is associated with the field use_password_setting (see use flag).

roles

roles

The names of roles this Admin Group applies to.

Type

String array.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)

saml_setting

saml_setting

The Admin Group SAML settings.

Type

A/An SAML settings struct.

Create

The default value is:

{ 'auto_create_user': False, 'persist_auto_created_user': False}

Search

The field is not available for search.

superuser

superuser

Determines whether this Admin Group is a superuser group. A superuser group can perform all operations on the appliance, and can view and configure all types of data.

Type

Bool.

Create

The default value is False.

Search

The field is available for search via

  • ‘=’ (exact equality)

use_account_inactivity_lockout_enable

use_account_inactivity_lockout_enable

This is the use flag for account inactivity lockout settings.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_disable_concurrent_login

use_disable_concurrent_login

Whether to override grid concurrent login

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_lockout_setting

use_lockout_setting

Whether to override grid sequential lockout setting

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_password_setting

use_password_setting

Whether grid password expiry setting should be override.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

user_access

user_access

The access control items for this Admin Group.

Type

A/An Address ac struct array.

Create

The default value is:

empty

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
access_method [Enum] N N N N/A
comment String N N Y : = ~
disable Bool N N N N/A
disable_concurrent_login Bool N N N N/A
email_addresses [String] N N N N/A
enable_restricted_user_access Bool N N N N/A
extattrs Extattr N N N ext
inactivity_lockout_setting struct N N N N/A
lockout_setting struct N N N N/A
name String Y N Y : = ~
password_setting struct N N N N/A
roles [String] N N N =
saml_setting struct N N N N/A
superuser Bool N N N =
use_account_inactivity_lockout_enable Bool N N N N/A
use_disable_concurrent_login Bool N N N N/A
use_lockout_setting Bool N N N N/A
use_password_setting Bool N N N N/A
user_access [struct] N N N N/A