ad_auth_service : Active Directory Authentication Service object.

This object allows you to specify an Active Directory (AD) authentication method and the AD authentication servers that Infoblox uses to authenticate administrators.

Object Reference

References to ad_auth_service are object references. The name part of the Active Directory Authentication Service object reference has the following components:

  • The name of the Active Directory authentication service.

Example: ad_auth_service/ZG5zLm5ldHdvcmtfdmlldyQxMTk:Infoblox

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): name.

The following fields are required to create this object:

Field Notes
name  

ad_domain

ad_domain

The Active Directory domain to which this server belongs.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

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

additional_search_paths

additional_search_paths

The unordered list of additional search paths for nested group querying.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

comment

comment

The descriptive comment for the AD authentication service.

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)

disable_default_search_path

disable_default_search_path

Determines whether the default search path for nested group querying is used.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

disabled

disabled

Determines if Active Directory Authentication Service is disabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

domain_controllers

domain_controllers

The AD authentication server list.

Type

A/An Active Directory Authentication Server struct array.

Create

The default value is undefined.

Search

The field is not available for search.

name

name

The AD authentication service name.

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.

nested_group_querying

nested_group_querying

Determines whether the nested group querying is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

timeout

timeout

The number of seconds that the appliance waits for a response from the AD server.

Type

Unsigned integer.

Create

The default value is 5.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
ad_domain String N N N : = ~
additional_search_paths [String] N N N N/A
comment String N N N : = ~
disable_default_search_path Bool N N N N/A
disabled Bool N N N N/A
domain_controllers [struct] N N N N/A
name String Y N Y : = ~
nested_group_querying Bool N N N N/A
timeout Unsigned int N N N N/A