Get-PAServer¶
Synopsis¶
Get ACME server details.
Syntax¶
Specific (Default)¶
Get-PAServer [[-DirectoryUrl] <String>] [-Name <String>] [-Refresh] [-Quiet] [<CommonParameters>]
List¶
Get-PAServer [-List] [-Refresh] [<CommonParameters>]
Description¶
The primary use for this function is checking which ACME server is currently configured. New Account and Cert requests will be directed to this server. It may also be used to refresh server details and list additional servers that have previously been used.
Examples¶
Example 1: Current Server¶
Get-PAServer
Get cached ACME server details for the currently selected server.
Example 2: Specific Server¶
Get-PAServer -DirectoryUrl LE_PROD
Get cached LetsEncrypt production server details using the short name.
Example 3: Specific Server URL¶
Get-PAServer -DirectoryUrl https://myacme.example.com/directory
Get cached ACME server details for the specified directory URL.
Example 4: All Servers¶
Get-PAServer -List
Get all cached ACME server details.
Parameters¶
-DirectoryUrl¶
Either the URL to an ACME server's "directory" endpoint or one of the supported short names. Currently supported short names include LE_PROD (LetsEncrypt Production), LE_STAGE (LetsEncrypt Staging), BUYPASS_PROD (BuyPass.com Production), BUYPASS_TEST (BuyPass.com Testing), and ZEROSSL_PROD (Zerossl.com Production).
Type: String
Parameter Sets: Specific
Aliases: location
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Name¶
The name of the ACME server. The parameter is ignored if DirectoryUrl is specified.
Type: String
Parameter Sets: Specific
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-List¶
If specified, the details for all previously used servers will be returned.
Type: SwitchParameter
Parameter Sets: List
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Refresh¶
If specified, any server details returned will be freshly queried from the ACME server. Otherwise, cached details will be returned.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Quiet¶
If specified, no warning will be thrown if a specified server is not found.
Type: SwitchParameter
Parameter Sets: Specific
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs¶
PoshACME.PAServer¶
A server object.