< Back
Remove-PAOrder
Post
NAME Remove-PAOrder
SYNOPSIS
Remove an ACME order from the local profile.
SYNTAX
Remove-PAOrder [-MainDomain] <String> [-RevokeCert] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function removes the reference to the order from the local profile which also removes any associated
certificate and private key. It will not remove or cleanup copies of the certificate that have been exported or
installed elsewhere. It will also not revoke the certificate unless -RevokeCert is used. The ACME server may
retain a reference to the order until it decides to delete it.
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? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-RevokeCert [<SwitchParameter>]
If specified and there is a currently valid certificate associated with the order, the certificate will be
revoked before deleting the order. This is not required, but generally a good practice if the certificate is
no longer being used.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified, interactive confirmation prompts will be skipped.
Required? false
Position? named
Default value False
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:\\>Remove-PAOrder site1.example.com
Remove the specified order without revoking the certificate.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-PAOrder -List | Remove-PAOrder -RevokeCert -Force
Remove all orders associated with the current account, revoke all certificates, and skip confirmation prompts.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
Get-PAOrder
New-PAOrder
SYNOPSIS
Remove an ACME order from the local profile.
SYNTAX
Remove-PAOrder [-MainDomain] <String> [-RevokeCert] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function removes the reference to the order from the local profile which also removes any associated
certificate and private key. It will not remove or cleanup copies of the certificate that have been exported or
installed elsewhere. It will also not revoke the certificate unless -RevokeCert is used. The ACME server may
retain a reference to the order until it decides to delete it.
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? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-RevokeCert [<SwitchParameter>]
If specified and there is a currently valid certificate associated with the order, the certificate will be
revoked before deleting the order. This is not required, but generally a good practice if the certificate is
no longer being used.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified, interactive confirmation prompts will be skipped.
Required? false
Position? named
Default value False
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:\\>Remove-PAOrder site1.example.com
Remove the specified order without revoking the certificate.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-PAOrder -List | Remove-PAOrder -RevokeCert -Force
Remove all orders associated with the current account, revoke all certificates, and skip confirmation prompts.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
Get-PAOrder
New-PAOrder