Resource: ActiveDirectory
ActiveDirectory is the public representation of the active directory config.
JSON representation |
---|
{
"name": string,
"createTime": string,
"state": enum ( |
Fields | |
---|---|
name |
Identifier. The resource name of the active directory. Format: |
create |
Output only. Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. The state of the AD. |
domain |
Required. Name of the Active Directory domain |
site |
The Active Directory site the service will limit Domain Controller discovery too. |
dns |
Required. Comma separated list of DNS server IP addresses for the Active Directory domain. |
net |
Required. NetBIOSPrefix is used as a prefix for SMB server name. |
organizational |
The Organizational Unit (OU) within the Windows Active Directory the user belongs to. |
aes |
If enabled, AES encryption will be enabled for SMB communication. |
username |
Required. Username of the Active Directory domain administrator. |
password |
Required. Password of the Active Directory domain administrator. |
backup |
Optional. Users to be added to the Built-in Backup Operator active directory group. |
administrators[] |
Optional. Users to be added to the Built-in Admininstrators group. |
security |
Optional. Domain users to be given the SeSecurityPrivilege. |
kdc |
Name of the active directory machine. This optional parameter is used only while creating kerberos volume |
kdc |
KDC server IP address for the active directory machine. |
nfs |
If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled. |
description |
Description of the active directory. |
ldap |
Specifies whether or not the LDAP traffic needs to be signed. |
encrypt |
If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted. |
labels |
Labels for the active directory. An object containing a list of |
state |
Output only. The state details of the Active Directory. |
State
The Active Directory States
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified Active Directory State |
CREATING |
Active Directory State is Creating |
READY |
Active Directory State is Ready |
UPDATING |
Active Directory State is Updating |
IN_USE |
Active Directory State is In use |
DELETING |
Active Directory State is Deleting |
ERROR |
Active Directory State is Error |
DIAGNOSING |
Active Directory State is Diagnosing. |
Methods |
|
---|---|
|
CreateActiveDirectory Creates the active directory specified in the request. |
|
Delete the active directory specified in the request. |
|
Describes a specified active directory. |
|
Lists active directories. |
|
Update the parameters of an active directories. |