Guide

Policy activation

Get-CloudletPolicyActivation

Suggest Edits

Synopsis

Get status for an activation.

Syntax

Get-CloudletPolicyActivation -PolicyID <Int32> [-Legacy] [-Size <Int32>] [-Page <Int32>] [-Network <String>] [-PropertyName <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-CloudletPolicyActivation -PolicyID <Int32> [-Legacy] [-ActivationID <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all policy activations or returns a specific activation by its ID. Use the -Legacy switch to specify v2 policies (both when listing policies or retrieving a single policy); otherwise, the command will apply only to v3 (shared) policies.

When listing all activations, you can control paging with the -Page and -Size parameters. When listing v2 policy activations, you can additionally filter them by network and property name.

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.
‑ActivationID
Int Parameter sets: single Pipeline input: False

Identifies the policy activation.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Legacy
Switch Pipeline input: False

If present, this indicates that your policy is legacy (v2). Without this switch, v3 of the Cloudlets API is used.
‑Network
String Accepted values: prod, staging Parameter sets: all Pipeline input: False

Returns only activations for the selected network, either STAGING or PRODUCTION. Note that this has no effect on Shared policies.
‑Page
Int Parameter sets: all Pipeline input: False

Specifies a page number for batched results, starting at zero.
‑PolicyID
Required
Int Pipeline input: False

Your cloudlet policy's ID.
‑PropertyName
String Parameter sets: all Pipeline input: False

Returns only activations for the selected property. Note that this has no effect on Shared policies.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Size
Int Parameter sets: all Pipeline input: False

Specifies the number of objects on a page, at least 10 objects if using Shared. Otherwise the minimum is 1.

Related Links

Updated about 6 hours ago