< Back
Set-PAOrder
Post
NAME Set-PAOrder
SYNOPSIS
Set the current ACME order, edits an orders properties, or revokes an order's certificate.
SYNTAX
Set-PAOrder [[-MainDomain] <String>] [-NoSwitch] [-DnsPlugin <String[]>] [-PluginArgs <Hashtable>] [-FriendlyName
<String>] [-PfxPass <String>] [-Install] [-DNSSleep <Int32>] [-ValidationTimeout <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-PAOrder [[-MainDomain] <String>] -RevokeCert [-Force] [-NoSwitch] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Switch to a specific ACME order and edit its properties or revoke its certificate. Revoked certificate orders are
not deleted and can be re-requested using Submit-Renewal or New-PACertificate.
PARAMETERS
-MainDomain <String>
The primary domain for the order. For a SAN order, this was the first domain in the list when creating the
order.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-RevokeCert [<SwitchParameter>]
If specified, a request will be sent to the associated ACME server to revoke the certificate on this order.
Clients may wish to do this if the certificate is decommissioned or the private key has been compromised. A
warning will be displayed if the order is not currently valid or the existing certificate file can't be found.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified, confirmation prompts for certificate revocation will be skipped.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoSwitch [<SwitchParameter>]
If specified, the currently selected order will not change. Useful primarily for bulk certificate revocation.
This switch is ignored if no MainDomain is specified.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DnsPlugin <String[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PluginArgs <Hashtable>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FriendlyName <String>
Modify the friendly name for the certificate and subsequent renewals. This will populate the "Friendly Name"
field in the Windows certificate store when the PFX is imported. Must not be an empty string.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PfxPass <String>
Modify the PFX password for the certificate and subsequent renewals.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Install [<SwitchParameter>]
Enables the Install switch for the order. Use -Install:$false to disable the switch on the order. This affects
whether the module will automatically import the certificate to the Windows certificate store on subsequent
renewals. It will not import the current certificate if it exists. Use Install-PACertificate for that purpose.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DNSSleep <Int32>
Number of seconds to wait for DNS changes to propagate before asking the ACME server to validate DNS
challenges.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ValidationTimeout <Int32>
Number of seconds to wait for the ACME server to validate the challenges after asking it to do so. If the
timeout is exceeded, an error will be thrown.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-PAOrder site1.example.com
Switch to the specified domain's order.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-PAOrder -RevokeCert
Revoke the current order's certificate.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-PAOrder -FriendlyName 'new friendly name'
Edit the friendly name for the current order and certificate if it exists.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
Get-PAOrder
New-PAOrder
SYNOPSIS
Set the current ACME order, edits an orders properties, or revokes an order's certificate.
SYNTAX
Set-PAOrder [[-MainDomain] <String>] [-NoSwitch] [-DnsPlugin <String[]>] [-PluginArgs <Hashtable>] [-FriendlyName
<String>] [-PfxPass <String>] [-Install] [-DNSSleep <Int32>] [-ValidationTimeout <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-PAOrder [[-MainDomain] <String>] -RevokeCert [-Force] [-NoSwitch] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Switch to a specific ACME order and edit its properties or revoke its certificate. Revoked certificate orders are
not deleted and can be re-requested using Submit-Renewal or New-PACertificate.
PARAMETERS
-MainDomain <String>
The primary domain for the order. For a SAN order, this was the first domain in the list when creating the
order.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-RevokeCert [<SwitchParameter>]
If specified, a request will be sent to the associated ACME server to revoke the certificate on this order.
Clients may wish to do this if the certificate is decommissioned or the private key has been compromised. A
warning will be displayed if the order is not currently valid or the existing certificate file can't be found.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified, confirmation prompts for certificate revocation will be skipped.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoSwitch [<SwitchParameter>]
If specified, the currently selected order will not change. Useful primarily for bulk certificate revocation.
This switch is ignored if no MainDomain is specified.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DnsPlugin <String[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PluginArgs <Hashtable>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FriendlyName <String>
Modify the friendly name for the certificate and subsequent renewals. This will populate the "Friendly Name"
field in the Windows certificate store when the PFX is imported. Must not be an empty string.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PfxPass <String>
Modify the PFX password for the certificate and subsequent renewals.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Install [<SwitchParameter>]
Enables the Install switch for the order. Use -Install:$false to disable the switch on the order. This affects
whether the module will automatically import the certificate to the Windows certificate store on subsequent
renewals. It will not import the current certificate if it exists. Use Install-PACertificate for that purpose.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DNSSleep <Int32>
Number of seconds to wait for DNS changes to propagate before asking the ACME server to validate DNS
challenges.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ValidationTimeout <Int32>
Number of seconds to wait for the ACME server to validate the challenges after asking it to do so. If the
timeout is exceeded, an error will be thrown.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-PAOrder site1.example.com
Switch to the specified domain's order.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-PAOrder -RevokeCert
Revoke the current order's certificate.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-PAOrder -FriendlyName 'new friendly name'
Edit the friendly name for the current order and certificate if it exists.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
Get-PAOrder
New-PAOrder