Console
    Contact Us Start free

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

    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
    Name
    Description
    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

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

    ↳ administrators
    array

    Optional. Users to be added to the Built-in Admininstrators group.

    ↳ security_operators
    array

    Optional. 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
    Type
    Description
    string

    setName

    Identifier. The resource name of the active directory.

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Create time of the active directory.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Create time of the active directory.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getState

    Output only. The state of the AD.

    Returns
    Type
    Description
    int

    setState

    Output only. The state of the AD.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getDomain

    Required. Name of the Active Directory domain

    Returns
    Type
    Description
    string

    setDomain

    Required. Name of the Active Directory domain

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSite

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

    Returns
    Type
    Description
    string

    setSite

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDns

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

    Returns
    Type
    Description
    string

    setDns

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getNetBiosPrefix

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

    Returns
    Type
    Description
    string

    setNetBiosPrefix

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getOrganizationalUnit

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

    Returns
    Type
    Description
    string

    setOrganizationalUnit

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAesEncryption

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

    Returns
    Type
    Description
    bool

    setAesEncryption

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

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getUsername

    Required. Username of the Active Directory domain administrator.

    Returns
    Type
    Description
    string

    setUsername

    Required. Username of the Active Directory domain administrator.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPassword

    Required. Password of the Active Directory domain administrator.

    Returns
    Type
    Description
    string

    setPassword

    Required. Password of the Active Directory domain administrator.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getBackupOperators

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setBackupOperators

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

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getAdministrators

    Optional. Users to be added to the Built-in Admininstrators group.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setAdministrators

    Optional. Users to be added to the Built-in Admininstrators group.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getSecurityOperators

    Optional. Domain users to be given the SeSecurityPrivilege.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSecurityOperators

    Optional. Domain users to be given the SeSecurityPrivilege.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getKdcHostname

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

    Returns
    Type
    Description
    string

    setKdcHostname

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getKdcIp

    KDC server IP address for the active directory machine.

    Returns
    Type
    Description
    string

    setKdcIp

    KDC server IP address for the active directory machine.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $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
    Type
    Description
    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
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getDescription

    Description of the active directory.

    Returns
    Type
    Description
    string

    setDescription

    Description of the active directory.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getLdapSigning

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

    Returns
    Type
    Description
    bool

    setLdapSigning

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

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getEncryptDcConnections

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

    Returns
    Type
    Description
    bool

    setEncryptDcConnections

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

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getLabels

    Labels for the active directory.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Labels for the active directory.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getStateDetails

    Output only. The state details of the Active Directory.

    Returns
    Type
    Description
    string

    setStateDetails

    Output only. The state details of the Active Directory.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: