Policy penalty box

Set-AppSecPolicyPenaltyBox

Synopsis

Modify the penalty box.

Syntax

configname-policyname-body (Default)

Set-AppSecPolicyPenaltyBox [-ConfigName] <String> [-VersionNumber] <String> [-PolicyName] <String>
 -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

configname-policyid-body

Set-AppSecPolicyPenaltyBox [-ConfigName] <String> [-VersionNumber] <String> -PolicyID <String> -Body <Object>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

configname-policyid-attributes

Set-AppSecPolicyPenaltyBox [-ConfigName] <String> [-VersionNumber] <String> -PolicyID <String> -Action <String>
 -PenaltyBoxProtection <Boolean> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

configname-policyname-attributes

Set-AppSecPolicyPenaltyBox [-ConfigName] <String> [-VersionNumber] <String> [-PolicyName] <String>
 -Action <String> -PenaltyBoxProtection <Boolean> [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyid-body

Set-AppSecPolicyPenaltyBox -ConfigID <Int32> [-VersionNumber] <String> -PolicyID <String> -Body <Object>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

configid-policyid-attributes

Set-AppSecPolicyPenaltyBox -ConfigID <Int32> [-VersionNumber] <String> -PolicyID <String> -Action <String>
 -PenaltyBoxProtection <Boolean> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyname-body

Set-AppSecPolicyPenaltyBox -ConfigID <Int32> [-VersionNumber] <String> [-PolicyName] <String> -Body <Object>
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

configid-policyname-attributes

Set-AppSecPolicyPenaltyBox -ConfigID <Int32> [-VersionNumber] <String> [-PolicyName] <String> -Action <String>
 -PenaltyBoxProtection <Boolean> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Modifies the penalty box settings for a security policy. When the penalty box is enabled for a policy, clients that trigger a WAF deny action are placed in the penalty box. There, the action you select for the penalty box (either alert or deny) continues to apply to any requests from those clients for the next 10 minutes.

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. To specify a policy, use the -PolicyName or -PolicyID parameter.

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

-Action

Specifies the action that the rule should trigger. Either alert, deny, deny_custom_{custom_deny_id}, or none. If the action is none, it isn't associated with the policy.

Use deny_custom_{custom_deny_id} to apply a custom action instead of Akamai's default.

Type: String
Parameter Sets: configname-policyid-attributes, configname-policyname-attributes, configid-policyid-attributes, configid-policyname-attributes
Aliases: None
Required: True
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: Object
Parameter Sets: configname-policyname-body, configname-policyid-body, configid-policyid-body, configid-policyname-body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ConfigID

An ID for each configuration.

Type: Int32
Parameter Sets: configid-policyid-body, configid-policyid-attributes, configid-policyname-body, configid-policyname-attributes
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-policyname-body, configname-policyid-body, configname-policyid-attributes, configname-policyname-attributes
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

-PenaltyBoxProtection

Specifies whether penalty box protection is enabled for the security policy. When set to true, the action occurs if triggered by a request.

Type: Boolean
Parameter Sets: configname-policyid-attributes, configname-policyname-attributes, configid-policyid-attributes, configid-policyname-attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PolicyID

An ID for a security policy.

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

-PolicyName

The name of the security policy.

Type: String
Parameter Sets: configname-policyname-body, configname-policyname-attributes, configid-policyname-body, configid-policyname-attributes
Aliases: None
Required: True
Position: 2
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: (All)
Aliases: None
Required: True
Position: 1
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

System.Object

Outputs