CacheUsernameDownloadSettings interface

Package:

@azure/arm-storagecache

Settings for Extended Groups username and group download.

Properties

autoDownloadCertificate	Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
caCertificateURI	The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
credentials	When present, these are the credentials for the secure LDAP connection.
encryptLdapConnection	Whether or not the LDAP connection should be encrypted.
extendedGroups	Whether or not Extended Groups is enabled.
groupFileURI	The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
ldapBaseDN	The base distinguished name for the LDAP domain.
ldapServer	The fully qualified domain name or IP address of the LDAP server to use.
requireValidCertificate	Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
userFileURI	The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
usernameDownloaded	Indicates whether or not the HPC Cache has performed the username download successfully. Possible values include: 'Yes', 'No', 'Error' NOTE: This property will not be serialized. It can only be populated by the server.
usernameSource	This setting determines how the cache gets username and group names for clients. Possible values include: 'AD', 'LDAP', 'File', 'None'. Default value: 'None'.

Property Details

autoDownloadCertificate

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

autoDownloadCertificate?: undefined | false | true

Property Value

undefined | false | true

caCertificateURI

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

caCertificateURI?: undefined | string

Property Value

undefined | string

credentials

When present, these are the credentials for the secure LDAP connection.

credentials?: CacheUsernameDownloadSettingsCredentials

Property Value

CacheUsernameDownloadSettingsCredentials

encryptLdapConnection

Whether or not the LDAP connection should be encrypted.

encryptLdapConnection?: undefined | false | true

Property Value

undefined | false | true

extendedGroups

Whether or not Extended Groups is enabled.

extendedGroups?: undefined | false | true

Property Value

undefined | false | true

groupFileURI

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

groupFileURI?: undefined | string

Property Value

undefined | string

ldapBaseDN

The base distinguished name for the LDAP domain.

ldapBaseDN?: undefined | string

Property Value

undefined | string

ldapServer

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

ldapServer?: undefined | string

Property Value

undefined | string

requireValidCertificate

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

requireValidCertificate?: undefined | false | true

Property Value

undefined | false | true

userFileURI

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

userFileURI?: undefined | string

Property Value

undefined | string

usernameDownloaded

Indicates whether or not the HPC Cache has performed the username download successfully. Possible values include: 'Yes', 'No', 'Error' NOTE: This property will not be serialized. It can only be populated by the server.

usernameDownloaded?: UsernameDownloadedType

Property Value

UsernameDownloadedType

usernameSource

This setting determines how the cache gets username and group names for clients. Possible values include: 'AD', 'LDAP', 'File', 'None'. Default value: 'None'.

usernameSource?: UsernameSource

Property Value

UsernameSource