Guide

Activations

New-AppSecActivation

Suggest Edits

Synopsis

Activate a configuration version.

Syntax

New-AppSecActivation [-ConfigName] <String> -VersionNumber <String> -Network <String> -NotificationEmails <String> [-Note <String>] [-AcknowledgedInvalidHosts <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-AppSecActivation -ConfigID <Int32> -VersionNumber <String> -Network <String> -NotificationEmails <String> [-Note <String>] [-AcknowledgedInvalidHosts <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-AppSecActivation -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Activates one or more configurations globally.

Note that you need to explicitly list any invalid hosts in the -AcknowledgedInvalidHosts parameter to successfully activate a configuration that includes invalid hostnames.

You can choose to provide activation settings individually, but, by doing so, the command can only activate a single configuration. To activate multiple configurations at once, you need to use the -Body parameter and provide the request body as a string or PSCustomObject.

When making a request, you can specify a configuration with the -ConfigName or -ConfigID parameter. The -VersionNumber parameter is an integer or the word latest.

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.
‑AcknowledgedInvalidHosts
String Parameter sets: configid, configname Pipeline input: False

The list of invalid hostnames in the security configuration to activate.

In some cases, you may want to activate a security configuration with hostnames that WAF can't protect (for example, hostnames not managed as Akamai properties, or managed under a different contract than the configuration)
‑Body
Conditionally required
Object Parameter sets: body Pipeline input: False

The request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑ConfigID
Conditionally required
Int Parameter sets: configid Pipeline input: False

Your configuration's ID.
‑ConfigName
Conditionally required
String Parameter sets: configname Pipeline input: False

The name of your security configuration.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Network
Conditionally required
String Accepted values: STAGING, PRODUCTION Parameter sets: configid, configname Pipeline input: False

The target Akamai activation environment, either STAGING or PRODUCTION.
‑Note
String Parameter sets: configid, configname Pipeline input: False

The notes you entered for the activation.
‑NotificationEmails
Conditionally required
String Parameter sets: configid, configname Pipeline input: False

The email addresses to notify when the activation happens.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑VersionNumber
Conditionally required
String Parameter sets: configid, configname Pipeline input: False

A configuration's version. Can be an integer or the word latest.

Related Links

Updated 4 months ago