Skip to content

Get-PAOrder

Synopsis

Get ACME order details.

Syntax

Specific

Get-PAOrder [[-MainDomain] <String>] [-Name <String>] [-Refresh] [<CommonParameters>]

List

Get-PAOrder [-List] [-Refresh] [<CommonParameters>]

Description

Returns details such as Domains, key length, expiration, and status for one or more ACME orders previously created.

Examples

Example 1: Current Order

Get-PAOrder

Get cached ACME order details for the currently selected order.

Example 2: Specific Order

Get-PAOrder example.com

Get cached ACME order details for the specified domain.

Example 3: All Orders

Get-PAOrder -List

Get all cached ACME order details.

Example 4: Refresh Order Status

Get-PAOrder -Refresh

Get fresh ACME order details for the currently selected order.

Parameters

-MainDomain

The primary domain associated with the order. This is the domain that goes in the certificate's subject.

Type: String
Parameter Sets: Specific
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

The name of the ACME order. This can be useful to distinguish between two orders that have the same MainDomain.

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 orders 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 order 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

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.PAOrder

An order object.

Set-PAOrder

New-PAOrder