GetCertifiCatVariables - RIT-ITS/CertifiCat-PS GitHub Wiki
Enumerates and displays all of the default CertifiCat-PS variables, used for verification and validation purposes.
Get-CertifiCatVariables
[-debugEnabled] [-debugLogDirectory <string>] [-debugMode <string>]This function will enumerate all of the default variables used in the module, and display them. This allows a user to verify that the defaults are the values that are expected, particularly in cases where a variable is overwritten via an environmental variable.
Note: This function will also display the value of the POSHACME_HOME variable. This is not used directly by CertifiCat-PS, but rather, by Posh-ACME to control the ACME working directory. CertifiCat-PS provides a dedicated function, Set-ACMEHome, to help facilitate the updating of this variable.
Get-CertifiCatVariables
This switch must be present to cause the function in question to output the contents of the object to a file or event log
Type: Switch
Position: Named
Required: False
Specifies where the CertifiCat-PS debug logs are written, when the debugMode option is EVT or Both.
Type: String
Position: Named
Required: False
Controls where the CertifiCat-PS debug informaiton is written: EVT (the windows event log), File (a text file on disk), or Both (a text file on disk and the Windows Event Log)
Type: String
Position: Named
Required: False
Default Value: EVT
ValidateSet: EVT, File, Both
Returns a custom PowerShell object with properties about the function and the account that was set up. The object has the following properties:
| Property | Details |
|---|---|
| FunctionName | Name of the function that was run |
| RunningPSVersion | The version of the PowerShell console used to run the function |
| PS5Command | A full string containing the commands needed to run the same command in PowerShell 5 |
| FunctionArguments | A list of the arguments passed to the function |
| FunctionSuccess | True/False indicating if the function succeeded. When false, this typically indicates a larger issue (e.g. no admin rights, etc) |
| Errors | A string containing details about any errors that were encountered |
| debugEnabled | Boolean indicating whether debug logging was enabled |
| debugLogDirectory | String indicating the location of the debug log file, if file logging mode is enabled |
| debugMode | String indicating the logging mode (i.e. EVT, File, or Both) |
| variableList | An array containing all of the enumerated variables |