< Back
Submit-Renewal
Post
NAME Submit-Renewal
SYNOPSIS
Renew one or more certificates.
SYNTAX
Submit-Renewal [[-MainDomain] <String>] [-NewKey] [-Force] [-NoSkipManualDns] [-PluginArgs <Hashtable>]
[<CommonParameters>]
Submit-Renewal -AllOrders [-NewKey] [-Force] [-NoSkipManualDns] [-PluginArgs <Hashtable>] [<CommonParameters>]
Submit-Renewal -AllAccounts [-NewKey] [-Force] [-NoSkipManualDns] [-PluginArgs <Hashtable>] [<CommonParameters>]
DESCRIPTION
This function allows you to renew one more more previously completed certificate orders. You can choose to renew a
specific order or set of orders, all orders for the current account, or all orders for all accounts.
PARAMETERS
-MainDomain <String>
The primary domain associated with an order. This is the domain that goes in the certificate's subject.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-AllOrders [<SwitchParameter>]
If specified, renew all valid orders on the current account. Orders that have not reached the renewal window
will be skipped unless -Force is used.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AllAccounts [<SwitchParameter>]
If specified, renew all valid orders on all valid accounts in this profile. Orders that have not reached the
renewal window will be skipped unless -Force is used.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NewKey [<SwitchParameter>]
If specified, a new private key will be generated for the certificate renewal. Otherwise, the old key is
re-used. This is useful if you believe the current key has been compromised.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified, an order that hasn't reached its renewal window will not throw an error and will not be skipped
when using either of the -All parameters.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoSkipManualDns [<SwitchParameter>]
If specified, orders that utilize the Manual DNS plugin will not be skipped and user interaction may be
required to complete the process. Otherwise, orders that utilize the Manual DNS plugin will be skipped.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-PluginArgs <Hashtable>
A hashtable containing an updated set of plugin arguments to use with the renewal. So if a plugin has a
-MyText string and -MyNumber integer parameter, you could specify them as @{MyText='text';MyNumber=1234}.
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:\\>Submit-Renewal
Renew the current order on the current account.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Submit-Renewal -Force
Renew the current order on the current account even if it hasn't reached its suggested renewal window.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Submit-Renewal -AllOrders
Renew all valid orders on the current account that have reached their suggested renewal window.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Submit-Renewal -AllAccounts
Renew all valid orders on all valid accounts that have reached their suggested renewal window.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Submit-Renewal site1.example.com -NewKey -Force
Renew the order for the specified site regardless of its renewal window and generate a new private key.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
New-PACertificate
Get-PAOrder
SYNOPSIS
Renew one or more certificates.
SYNTAX
Submit-Renewal [[-MainDomain] <String>] [-NewKey] [-Force] [-NoSkipManualDns] [-PluginArgs <Hashtable>]
[<CommonParameters>]
Submit-Renewal -AllOrders [-NewKey] [-Force] [-NoSkipManualDns] [-PluginArgs <Hashtable>] [<CommonParameters>]
Submit-Renewal -AllAccounts [-NewKey] [-Force] [-NoSkipManualDns] [-PluginArgs <Hashtable>] [<CommonParameters>]
DESCRIPTION
This function allows you to renew one more more previously completed certificate orders. You can choose to renew a
specific order or set of orders, all orders for the current account, or all orders for all accounts.
PARAMETERS
-MainDomain <String>
The primary domain associated with an order. This is the domain that goes in the certificate's subject.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-AllOrders [<SwitchParameter>]
If specified, renew all valid orders on the current account. Orders that have not reached the renewal window
will be skipped unless -Force is used.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AllAccounts [<SwitchParameter>]
If specified, renew all valid orders on all valid accounts in this profile. Orders that have not reached the
renewal window will be skipped unless -Force is used.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NewKey [<SwitchParameter>]
If specified, a new private key will be generated for the certificate renewal. Otherwise, the old key is
re-used. This is useful if you believe the current key has been compromised.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified, an order that hasn't reached its renewal window will not throw an error and will not be skipped
when using either of the -All parameters.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoSkipManualDns [<SwitchParameter>]
If specified, orders that utilize the Manual DNS plugin will not be skipped and user interaction may be
required to complete the process. Otherwise, orders that utilize the Manual DNS plugin will be skipped.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-PluginArgs <Hashtable>
A hashtable containing an updated set of plugin arguments to use with the renewal. So if a plugin has a
-MyText string and -MyNumber integer parameter, you could specify them as @{MyText='text';MyNumber=1234}.
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:\\>Submit-Renewal
Renew the current order on the current account.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Submit-Renewal -Force
Renew the current order on the current account even if it hasn't reached its suggested renewal window.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Submit-Renewal -AllOrders
Renew all valid orders on the current account that have reached their suggested renewal window.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Submit-Renewal -AllAccounts
Renew all valid orders on all valid accounts that have reached their suggested renewal window.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Submit-Renewal site1.example.com -NewKey -Force
Renew the order for the specified site regardless of its renewal window and generate a new private key.
RELATED LINKS
Project: https://github.com/rmbolger/Posh-ACME
New-PACertificate
Get-PAOrder