key
Key of the target environment variable to look up.
Type: List
Environment variable prefix for a list of data types that the database represented by the relevant configuration block accepts.
Type: List<String>
Required: no
Type: String Required: yes
Environment variable prefix for the unique database identifier.
Type: String
Required: yes
Type: String Required: yes
Environment variable prefix for the database schema containing the VDI control tables.
Type: String
Required: yes
Type: String Required: yes
Environment variable prefix for the database schema containing the VDI installed-data tables.
Type: String
Required: yes
Type: Boolean Required: no
Environment variable prefix for the database enabled/disabled flag.
Type: Boolean
Required: no
Type: String Required: no
Environment variable prefix for the database hostname value.
This environment variable would not typically be used at the same time as DBLDAPPrefix prefixed variables.
Type: String
Required: no
Type: String Required: yes
Environment variable prefix for the LDAP service name used to lookup database connection details.
This environment variable would not typically be used at the same time as the DBHostPrefix, DBPortPrefix, or DBNamePrefix prefixed variables.
Type: String
Required: no
Type: String Required: no
Environment variable prefix for the target database name.
This environment variable would not typically be used at the same time as DBLDAPPrefix prefixed variables.
Type: String
Required: no
Type: String Required: yes
Environment variable prefix for the database credentials password.
Type: String
Required: yes
Type: String Required: no
Environment variable prefix for the database platform type.
Type: String
Required: no
Type: UByte Required: no
Environment variable prefix for the database connection pool size.
Type: UByte
Required: no
Type: UByte Required: no
Environment variable prefix for the database host port value.
This environment variable would not typically be used at the same time as DBLDAPPrefix prefixed variables.
Type: UByte
Required: no
Type: List
Environment variable prefix for a list of data types that the database represented by the relevant configuration block accepts.
Type: String Required: yes
Environment variable prefix for the unique database identifier.
Type: String Required: yes
Environment variable prefix for the database schema containing the VDI control tables.
Type: String Required: yes
Environment variable prefix for the database schema containing the VDI installed-data tables.
Type: Boolean Required: no
Environment variable prefix for the database enabled/disabled flag.
Type: String Required: no
Environment variable prefix for the database hostname value.
Type: String Required: yes
Environment variable prefix for the LDAP service name used to lookup database connection details.
Type: String Required: no
Environment variable prefix for the target database name.
Type: String Required: yes
Environment variable prefix for the database credentials password.
Type: String Required: no
Environment variable prefix for the database platform type.
Type: UByte Required: no
Environment variable prefix for the database connection pool size.
Type: UByte Required: no
Environment variable prefix for the database host port value.
Type: List
Type: List<[HostAddress]>
Required: yes
Type: String Required: yes
Type: String
Required: yes
Type: List
Type: String Required: yes
Retrieves an optional target boolean environment variable or null if the target variable is blank or absent.
Valid boolean values must align with a value in the following mapping table:
| Raw Value | Parsed Value |
|---|---|
"true" | true |
"yes" | true |
"on" | true |
"1" | true |
"false" | false |
"no" | false |
"off" | false |
"0" | false |
The parsed boolean value from the environment or null if the variable was blank or absent.
Key of the target environment variable to look up.
If the target environment variable could not be parsed as a boolean value according to the table above.
Retrieves an optional target boolean environment variable or null if the target variable is blank or absent.
Valid boolean values must align with a value in the following mapping table:
| Raw Value | Parsed Value |
|---|---|
"true" | true |
"yes" | true |
"on" | true |
"1" | true |
"false" | false |
"no" | false |
"off" | false |
"0" | false |
The parsed boolean value from the environment or null if the variable was blank or absent.
Key of the target environment variable to look up.
If the target environment variable could not be parsed as a boolean value according to the table above.
Requires that the target environment variable is set to a Boolean value.
Valid boolean values must align with a value in the following mapping table:
| Raw Value | Parsed Value |
|---|---|
"true" | true |
"yes" | true |
"on" | true |
"1" | true |
"false" | false |
"no" | false |
"off" | false |
"0" | false |
The parsed Boolean value.
Key of the target environment variable to require.
If the environment variable is blank, absent, or could not be parsed as a Boolean value.
Requires that the target environment variable is set to a Boolean value.
Valid boolean values must align with a value in the following mapping table:
| Raw Value | Parsed Value |
|---|---|
"true" | true |
"yes" | true |
"on" | true |
"1" | true |
"false" | false |
"no" | false |
"off" | false |
"0" | false |
The parsed Boolean value.
Key of the target environment variable to require.
If the environment variable is blank, absent, or could not be parsed as a Boolean value.