Google Cloud Net App V1 Client - Class ActiveDirectory (0.2.0)

Reference documentation and code samples for the Google Cloud Net App V1 Client class ActiveDirectory.

ActiveDirectory is the public representation of the active directory config.

Generated from protobuf message google.cloud.netapp.v1.ActiveDirectory

Namespace

Google \ Cloud \ NetApp \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the active directory. Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.

↳ create_time Google\Protobuf\Timestamp

Output only. Create time of the active directory.

↳ state int

Output only. The state of the AD.

↳ domain string

Required. Name of the Active Directory domain

↳ site string

The Active Directory site the service will limit Domain Controller discovery too.

↳ dns string

Required. Comma separated list of DNS server IP addresses for the Active Directory domain.

↳ net_bios_prefix string

Required. NetBIOSPrefix is used as a prefix for SMB server name.

↳ organizational_unit string

The Organizational Unit (OU) within the Windows Active Directory the user belongs to.

↳ aes_encryption bool

If enabled, AES encryption will be enabled for SMB communication.

↳ username string

Required. Username of the Active Directory domain administrator.

↳ password string

Required. Password of the Active Directory domain administrator.

↳ backup_operators array

Users to be added to the Built-in Backup Operator active directory group.

↳ security_operators array

Domain users to be given the SeSecurityPrivilege.

↳ kdc_hostname string

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

↳ kdc_ip string

KDC server IP address for the active directory machine.

↳ nfs_users_with_ldap bool

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 string

Description of the active directory.

↳ ldap_signing bool

Specifies whether or not the LDAP traffic needs to be signed.

↳ encrypt_dc_connections bool

If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.

↳ labels array|Google\Protobuf\Internal\MapField

Labels for the active directory.

↳ state_details string

Output only. The state details of the Active Directory.

getName

Identifier. The resource name of the active directory.

Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.

Returns
TypeDescription
string

setName

Identifier. The resource name of the active directory.

Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Create time of the active directory.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create time of the active directory.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

Output only. The state of the AD.

Returns
TypeDescription
int

setState

Output only. The state of the AD.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDomain

Required. Name of the Active Directory domain

Returns
TypeDescription
string

setDomain

Required. Name of the Active Directory domain

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSite

The Active Directory site the service will limit Domain Controller discovery too.

Returns
TypeDescription
string

setSite

The Active Directory site the service will limit Domain Controller discovery too.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDns

Required. Comma separated list of DNS server IP addresses for the Active Directory domain.

Returns
TypeDescription
string

setDns

Required. Comma separated list of DNS server IP addresses for the Active Directory domain.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNetBiosPrefix

Required. NetBIOSPrefix is used as a prefix for SMB server name.

Returns
TypeDescription
string

setNetBiosPrefix

Required. NetBIOSPrefix is used as a prefix for SMB server name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrganizationalUnit

The Organizational Unit (OU) within the Windows Active Directory the user belongs to.

Returns
TypeDescription
string

setOrganizationalUnit

The Organizational Unit (OU) within the Windows Active Directory the user belongs to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAesEncryption

If enabled, AES encryption will be enabled for SMB communication.

Returns
TypeDescription
bool

setAesEncryption

If enabled, AES encryption will be enabled for SMB communication.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUsername

Required. Username of the Active Directory domain administrator.

Returns
TypeDescription
string

setUsername

Required. Username of the Active Directory domain administrator.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPassword

Required. Password of the Active Directory domain administrator.

Returns
TypeDescription
string

setPassword

Required. Password of the Active Directory domain administrator.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBackupOperators

Users to be added to the Built-in Backup Operator active directory group.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setBackupOperators

Users to be added to the Built-in Backup Operator active directory group.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getSecurityOperators

Domain users to be given the SeSecurityPrivilege.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSecurityOperators

Domain users to be given the SeSecurityPrivilege.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getKdcHostname

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

Returns
TypeDescription
string

setKdcHostname

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKdcIp

KDC server IP address for the active directory machine.

Returns
TypeDescription
string

setKdcIp

KDC server IP address for the active directory machine.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNfsUsersWithLdap

If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.

Returns
TypeDescription
bool

setNfsUsersWithLdap

If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDescription

Description of the active directory.

Returns
TypeDescription
string

setDescription

Description of the active directory.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLdapSigning

Specifies whether or not the LDAP traffic needs to be signed.

Returns
TypeDescription
bool

setLdapSigning

Specifies whether or not the LDAP traffic needs to be signed.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEncryptDcConnections

If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.

Returns
TypeDescription
bool

setEncryptDcConnections

If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getLabels

Labels for the active directory.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels for the active directory.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getStateDetails

Output only. The state details of the Active Directory.

Returns
TypeDescription
string

setStateDetails

Output only. The state details of the Active Directory.

Parameter
NameDescription
var string
Returns
TypeDescription
$this