< Back
Get-PAServer
Post
NAME Get-PAServer
SYNOPSIS
Get ACME server details.
SYNTAX
Get-PAServer [[-DirectoryUrl] <String>] [-Refresh] [<CommonParameters>]
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.
PARAMETERS
-DirectoryUrl <String>
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 v2) and LE_STAGE (LetsEncrypt Staging v2).
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-List [<SwitchParameter>]
If specified, the details for all previously used servers will be returned.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Refresh [<SwitchParameter>]
If specified, any server details returned will be freshly queried from the ACME server. Otherwise, cached
details will be returned.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
PoshACME.PAServer
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-PAServer
Get cached ACME server details for the currently selected server.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-PAServer -DirectoryUrl LE_PROD
Get cached LetsEncrypt production server details using the short name.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-PAServer -List
Get all cached ACME server details.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-PAServer -DirectoryUrl https://myacme.example.com/directory
Get cached ACME server details for the specified directory URL.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-PAServer -Refresh
Get fresh ACME server details for the currently selected server.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-PAServer -List -Refresh
Get fresh ACME server details for all previously used servers.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
Set-PAServer
SYNOPSIS
Get ACME server details.
SYNTAX
Get-PAServer [[-DirectoryUrl] <String>] [-Refresh] [<CommonParameters>]
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.
PARAMETERS
-DirectoryUrl <String>
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 v2) and LE_STAGE (LetsEncrypt Staging v2).
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-List [<SwitchParameter>]
If specified, the details for all previously used servers will be returned.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Refresh [<SwitchParameter>]
If specified, any server details returned will be freshly queried from the ACME server. Otherwise, cached
details will be returned.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
PoshACME.PAServer
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-PAServer
Get cached ACME server details for the currently selected server.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-PAServer -DirectoryUrl LE_PROD
Get cached LetsEncrypt production server details using the short name.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-PAServer -List
Get all cached ACME server details.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-PAServer -DirectoryUrl https://myacme.example.com/directory
Get cached ACME server details for the specified directory URL.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-PAServer -Refresh
Get fresh ACME server details for the currently selected server.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-PAServer -List -Refresh
Get fresh ACME server details for all previously used servers.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
Set-PAServer