active_directories

Creates, updates, deletes, gets or lists an active_directories resource.

Overview

Name	active_directories
Type	Resource
Id	google.netapp.active_directories

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the active directory. Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.
administrators	array	Optional. Users to be added to the Built-in Admininstrators group.
aesEncryption	boolean	If enabled, AES encryption will be enabled for SMB communication.
backupOperators	array	Optional. Users to be added to the Built-in Backup Operator active directory group.
createTime	string (google-datetime)	Output only. Create time of the active directory.
description	string	Description of the active directory.
dns	string	Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
domain	string	Required. Name of the Active Directory domain
encryptDcConnections	boolean	If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
kdcHostname	string	Name of the active directory machine. This optional parameter is used only while creating kerberos volume
kdcIp	string	KDC server IP address for the active directory machine.
labels	object	Labels for the active directory.
ldapSigning	boolean	Specifies whether or not the LDAP traffic needs to be signed.
netBiosPrefix	string	Required. NetBIOSPrefix is used as a prefix for SMB server name.
nfsUsersWithLdap	boolean	If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
organizationalUnit	string	The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
password	string	Required. Password of the Active Directory domain administrator.
securityOperators	array	Optional. Domain users to be given the SeSecurityPrivilege.
site	string	The Active Directory site the service will limit Domain Controller discovery too.
state	string	Output only. The state of the AD.
stateDetails	string	Output only. The state details of the Active Directory.
username	string	Required. Username of the Active Directory domain administrator.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the active directory. Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.
administrators	array	Optional. Users to be added to the Built-in Admininstrators group.
aesEncryption	boolean	If enabled, AES encryption will be enabled for SMB communication.
backupOperators	array	Optional. Users to be added to the Built-in Backup Operator active directory group.
createTime	string (google-datetime)	Output only. Create time of the active directory.
description	string	Description of the active directory.
dns	string	Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
domain	string	Required. Name of the Active Directory domain
encryptDcConnections	boolean	If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
kdcHostname	string	Name of the active directory machine. This optional parameter is used only while creating kerberos volume
kdcIp	string	KDC server IP address for the active directory machine.
labels	object	Labels for the active directory.
ldapSigning	boolean	Specifies whether or not the LDAP traffic needs to be signed.
netBiosPrefix	string	Required. NetBIOSPrefix is used as a prefix for SMB server name.
nfsUsersWithLdap	boolean	If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
organizationalUnit	string	The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
password	string	Required. Password of the Active Directory domain administrator.
securityOperators	array	Optional. Domain users to be given the SeSecurityPrivilege.
site	string	The Active Directory site the service will limit Domain Controller discovery too.
state	string	Output only. The state of the AD.
stateDetails	string	Output only. The state details of the Active Directory.
username	string	Required. Username of the Active Directory domain administrator.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, activeDirectoriesId		Describes a specified active directory.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists active directories.
create	insert	projectsId, locationsId	activeDirectoryId	CreateActiveDirectory Creates the active directory specified in the request.
patch	update	projectsId, locationsId, activeDirectoriesId	updateMask	Update the parameters of an active directories.
delete	delete	projectsId, locationsId, activeDirectoriesId		Delete the active directory specified in the request.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
activeDirectoriesId	string
locationsId	string
projectsId	string
activeDirectoryId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Describes a specified active directory.

SELECT
name,
administrators,
aesEncryption,
backupOperators,
createTime,
description,
dns,
domain,
encryptDcConnections,
kdcHostname,
kdcIp,
labels,
ldapSigning,
netBiosPrefix,
nfsUsersWithLdap,
organizationalUnit,
password,
securityOperators,
site,
state,
stateDetails,
username
FROM google.netapp.active_directories
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND activeDirectoriesId = '{{ activeDirectoriesId }}' -- required;

list

Lists active directories.

SELECT
name,
administrators,
aesEncryption,
backupOperators,
createTime,
description,
dns,
domain,
encryptDcConnections,
kdcHostname,
kdcIp,
labels,
ldapSigning,
netBiosPrefix,
nfsUsersWithLdap,
organizationalUnit,
password,
securityOperators,
site,
state,
stateDetails,
username
FROM google.netapp.active_directories
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

CreateActiveDirectory Creates the active directory specified in the request.

INSERT INTO google.netapp.active_directories (
data__name,
data__domain,
data__site,
data__dns,
data__netBiosPrefix,
data__organizationalUnit,
data__aesEncryption,
data__username,
data__password,
data__backupOperators,
data__administrators,
data__securityOperators,
data__kdcHostname,
data__kdcIp,
data__nfsUsersWithLdap,
data__description,
data__ldapSigning,
data__encryptDcConnections,
data__labels,
projectsId,
locationsId,
activeDirectoryId
)
SELECT 
'{{ name }}',
'{{ domain }}',
'{{ site }}',
'{{ dns }}',
'{{ netBiosPrefix }}',
'{{ organizationalUnit }}',
{{ aesEncryption }},
'{{ username }}',
'{{ password }}',
'{{ backupOperators }}',
'{{ administrators }}',
'{{ securityOperators }}',
'{{ kdcHostname }}',
'{{ kdcIp }}',
{{ nfsUsersWithLdap }},
'{{ description }}',
{{ ldapSigning }},
{{ encryptDcConnections }},
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ activeDirectoryId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: active_directories
  props:
    - name: projectsId
      value: string
      description: Required parameter for the active_directories resource.
    - name: locationsId
      value: string
      description: Required parameter for the active_directories resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
        
    - name: domain
      value: string
      description: >
        Required. Name of the Active Directory domain
        
    - name: site
      value: string
      description: >
        The Active Directory site the service will limit Domain Controller discovery too.
        
    - name: dns
      value: string
      description: >
        Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
        
    - name: netBiosPrefix
      value: string
      description: >
        Required. NetBIOSPrefix is used as a prefix for SMB server name.
        
    - name: organizationalUnit
      value: string
      description: >
        The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
        
    - name: aesEncryption
      value: boolean
      description: >
        If enabled, AES encryption will be enabled for SMB communication.
        
    - name: username
      value: string
      description: >
        Required. Username of the Active Directory domain administrator.
        
    - name: password
      value: string
      description: >
        Required. Password of the Active Directory domain administrator.
        
    - name: backupOperators
      value: array
      description: >
        Optional. Users to be added to the Built-in Backup Operator active directory group.
        
    - name: administrators
      value: array
      description: >
        Optional. Users to be added to the Built-in Admininstrators group.
        
    - name: securityOperators
      value: array
      description: >
        Optional. Domain users to be given the SeSecurityPrivilege.
        
    - name: kdcHostname
      value: string
      description: >
        Name of the active directory machine. This optional parameter is used only while creating kerberos volume
        
    - name: kdcIp
      value: string
      description: >
        KDC server IP address for the active directory machine.
        
    - name: nfsUsersWithLdap
      value: boolean
      description: >
        If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
        
    - name: description
      value: string
      description: >
        Description of the active directory.
        
    - name: ldapSigning
      value: boolean
      description: >
        Specifies whether or not the LDAP traffic needs to be signed.
        
    - name: encryptDcConnections
      value: boolean
      description: >
        If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
        
    - name: labels
      value: object
      description: >
        Labels for the active directory.
        
    - name: activeDirectoryId
      value: string

UPDATE examples

patch

Update the parameters of an active directories.

UPDATE google.netapp.active_directories
SET 
data__name = '{{ name }}',
data__domain = '{{ domain }}',
data__site = '{{ site }}',
data__dns = '{{ dns }}',
data__netBiosPrefix = '{{ netBiosPrefix }}',
data__organizationalUnit = '{{ organizationalUnit }}',
data__aesEncryption = {{ aesEncryption }},
data__username = '{{ username }}',
data__password = '{{ password }}',
data__backupOperators = '{{ backupOperators }}',
data__administrators = '{{ administrators }}',
data__securityOperators = '{{ securityOperators }}',
data__kdcHostname = '{{ kdcHostname }}',
data__kdcIp = '{{ kdcIp }}',
data__nfsUsersWithLdap = {{ nfsUsersWithLdap }},
data__description = '{{ description }}',
data__ldapSigning = {{ ldapSigning }},
data__encryptDcConnections = {{ encryptDcConnections }},
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND activeDirectoriesId = '{{ activeDirectoriesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete the active directory specified in the request.

DELETE FROM google.netapp.active_directories
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND activeDirectoriesId = '{{ activeDirectoriesId }}' --required;