Share via

CacheUsernameDownloadSettings interface

  • Reference
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. 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.

Property Details

autoDownloadCertificate

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

autoDownloadCertificate?: boolean

Property Value

boolean

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?: string

Property Value

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?: boolean

Property Value

boolean

extendedGroups

Whether or not Extended Groups is enabled.

extendedGroups?: boolean

Property Value

boolean

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?: string

Property Value

string

ldapBaseDN

The base distinguished name for the LDAP domain.

ldapBaseDN?: string

Property Value

string

ldapServer

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

ldapServer?: string

Property Value

string

requireValidCertificate

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

requireValidCertificate?: boolean

Property Value

boolean

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?: string

Property Value

string

usernameDownloaded

Indicates whether or not the HPC Cache has performed the username download successfully. NOTE: This property will not be serialized. It can only be populated by the server.

usernameDownloaded?: string

Property Value

string

usernameSource

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

usernameSource?: string

Property Value

string