Activations

New-AppSecActivation

Synopsis

Activate a configuration version.

Syntax

configname (Default)

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

configid

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

body

New-AppSecActivation -Body <String> [-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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AcknowledgedInvalidHosts

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)

Type: String
Parameter Sets: configname, configid
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

Type: String
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigID

An ID for each configuration.

Type: Int32
Parameter Sets: configid
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigName

The name of the security configuration.

Type: String
Parameter Sets: configname
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Network

The target Akamai activation environment, either STAGING or PRODUCTION.

Type: String
Parameter Sets: configname, configid
Aliases:
Accepted values: STAGING, PRODUCTION

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Note

The notes you entered for the activation.

Type: String
Parameter Sets: configname, configid
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NotificationEmails

The email addresses to notify when the activation happens.

Type: String
Parameter Sets: configname, configid
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VersionNumber

An ID for each version of a configuration. Can be an integer or the word latest.

Type: String
Parameter Sets: configname, configid
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object