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 |
|---|---|
ad_domain |
|
domain_controllers |
|
name |
|
timeout |
ad_domain¶
- ad_domain¶
The Active Directory domain to which this server belongs.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive 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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive 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 field is required on creation.
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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
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 field is required on creation.
Search
The field is not available for search.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
ad_domain |
String |
Y |
N |
N |
: = ~ |
comment |
String |
N |
N |
N |
: = ~ |
disabled |
Bool |
N |
N |
N |
N/A |
domain_controllers |
[struct] |
Y |
N |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
nested_group_querying |
Bool |
N |
N |
N |
N/A |
timeout |
Unsigned int |
Y |
N |
N |
N/A |
