New-AzStorageCacheDirectorySettingObject

Module:

Az.StorageCache Module

Create an in-memory object for CacheDirectorySettings.

Syntax

Default (Default)

New-AzStorageCacheDirectorySettingObject
    [-ActiveDirectoryCacheNetBiosName <String>]
    [-ActiveDirectoryDomainName <String>]
    [-ActiveDirectoryDomainNetBiosName <String>]
    [-ActiveDirectoryPrimaryDnsIPAddress <String>]
    [-ActiveDirectorySecondaryDnsIPAddress <String>]
    [-CredentialsBindDn <String>]
    [-CredentialsBindPassword <String>]
    [-CredentialsPassword <String>]
    [-CredentialsUsername <String>]
    [-UsernameDownloadAutoDownloadCertificate <Boolean>]
    [-UsernameDownloadCaCertificateUri <String>]
    [-UsernameDownloadEncryptLdapConnection <Boolean>]
    [-UsernameDownloadExtendedGroup <Boolean>]
    [-UsernameDownloadGroupFileUri <String>]
    [-UsernameDownloadLdapBaseDn <String>]
    [-UsernameDownloadLdapServer <String>]
    [-UsernameDownloadRequireValidCertificate <Boolean>]
    [-UsernameDownloadUserFileUri <String>]
    [-UsernameDownloadUsernameSource <UsernameSource>]
    [<CommonParameters>]

Description

Create an in-memory object for CacheDirectorySettings.

Examples

Example 1: Create an in-memory object for CacheDirectorySettings.

New-AzStorageCacheDirectorySettingObject -ActiveDirectoryCacheNetBiosName "contosoSmb" -ActiveDirectoryDomainName "contosoAd.contoso.local" -ActiveDirectoryDomainNetBiosName "contosoAd" -ActiveDirectoryPrimaryDnsIPAddress "192.0.2.10" -ActiveDirectorySecondaryDnsIPAddress "192.0.2.11" -CredentialsBindDn "cn=ldapadmin,dc=contosoad,dc=contoso,dc=local" -CredentialsBindPassword "<bindPassword>" -CredentialsPassword "<password>" -CredentialsUsername "contosoAdmin" -UsernameDownloadCaCertificateUri "http://contoso.net/cacert.pem" -UsernameDownloadAutoDownloadCertificate:$False -UsernameDownloadEncryptLdapConnection:$False -UsernameDownloadExtendedGroup:$False -UsernameDownloadGroupFileUri "http://contoso.net/group.file" -UsernameDownloadLdapBaseDn "dc=contosoad,dc=contoso,dc=local" -UsernameDownloadLdapServer "192.0.2.12" -UsernameDownloadRequireValidCertificate:$False -UsernameDownloadUsernameSource 'LDAP' -UsernameDownloadUserFileUri "http://contoso.net/passwd.file"

ActiveDirectoryCacheNetBiosName         : contosoSmb
ActiveDirectoryDomainJoined             :
ActiveDirectoryDomainName               : contosoAd.contoso.local
ActiveDirectoryDomainNetBiosName        : contosoAd
ActiveDirectoryPrimaryDnsIPAddress      : 192.0.2.10
ActiveDirectorySecondaryDnsIPAddress    : 192.0.2.11
CredentialsBindDn                       : cn=ldapadmin,dc=contosoad,dc=contoso,dc=local
CredentialsBindPassword                 : <bindPassword>
CredentialsPassword                     : <password>
CredentialsUsername                     : consotoAdmin
UsernameDownloadAutoDownloadCertificate : False
UsernameDownloadCaCertificateUri        : http://contoso.net/cacert.pem
UsernameDownloadEncryptLdapConnection   : False
UsernameDownloadExtendedGroup           : False
UsernameDownloadGroupFileUri            : http://contoso.net/group.file
UsernameDownloadLdapBaseDn              : dc=contosoad,dc=contoso,dc=local
UsernameDownloadLdapServer              : 192.0.2.12
UsernameDownloadRequireValidCertificate : False
UsernameDownloadUserFileUri             : http://contoso.net/passwd.file
UsernameDownloadUsernameDownloaded      :
UsernameDownloadUsernameSource          : LDAP

Create an in-memory object for CacheDirectorySettings.

Parameters

-ActiveDirectoryCacheNetBiosName

The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ActiveDirectoryDomainName

The fully qualified domain name of the Active Directory domain controller.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ActiveDirectoryDomainNetBiosName

The Active Directory domain's NetBIOS name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ActiveDirectoryPrimaryDnsIPAddress

Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ActiveDirectorySecondaryDnsIPAddress

Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CredentialsBindDn

The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CredentialsBindPassword

The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CredentialsPassword

Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CredentialsUsername

Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadAutoDownloadCertificate

Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadCaCertificateUri

The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadEncryptLdapConnection

Whether or not the LDAP connection should be encrypted.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadExtendedGroup

Whether or not Extended Groups is enabled.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadGroupFileUri

The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadLdapBaseDn

The base distinguished name for the LDAP domain.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadLdapServer

The fully qualified domain name or IP address of the LDAP server to use.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadRequireValidCertificate

Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadUserFileUri

The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsernameDownloadUsernameSource

This setting determines how the cache gets username and group names for clients.

Parameter properties

Type:	UsernameSource
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

CacheDirectorySettings