Guide

Enrollment

Set-CPSEnrollment

Suggest Edits

Synopsis

Update an enrollment.

Syntax

Set-CPSEnrollment [-EnrollmentID] <Int32> [-Body] <Object> [-AllowCancelPendingChanges] [-AllowStagingBypass] [[-DeployNotAfter] <String>] [[-DeployNotBefore] <String>] [-ForceRenewal] [-RenewalDateCheckOverride] [-AllowMissingCertificateAddition] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates an enrollment with changes.

Note: The request body for this function can be quite complex, therefore, it's recommended that you retrieve the existing enrollment with the Get-CPSEnrollment operation, make your changes locally, and then pipe the object to this function.

Parameters

‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑AllowCancelPendingChanges
Switch Pipeline input: False

Cancels all pending changes when updating an enrollment.
‑AllowMissingCertificateAddition
Switch Pipeline input: False

Applicable to Third Party Dual Stack Enrollments, allows to update missing certificates.
‑AllowStagingBypass
Switch Pipeline input: False

Bypasses staging and pushes meta-data updates directly to the production network. The current change will also be updated with the same changes.
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑DeployNotAfter
String Pipeline input: False

The date (UTC) after which the enrollment shouldn't be deployed.
‑DeployNotBefore
String Pipeline input: False

The date (UTC) before which the enrollment shouldn't be deployed.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑EnrollmentID
Required
Int Pipeline input: ByPropertyName

Enrollment on which to perform the desired operation.
‑ForceRenewal
Switch Pipeline input: False

Forces certificate renewal for an enrollment.
‑RenewalDateCheckOverride
Switch Pipeline input: False

If present, this starts a change to renew certificates in time before they expire. This automatic change is started when a certificate's expiration is within a renewal window, and the system will protect against other changes started during this renewal window.

Setting renewal-date-check-override=true will allow creating a change during the renewal window, potentially running the risk of ending up with an expired certificate on the network.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 5 days ago