Guide

Policy evaluation penalty box

Set-AppSecPolicyEvaluationPenaltyBox

Suggest Edits

Synopsis

Modify the evaluation penalty box.

Syntax

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

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

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

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

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

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

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

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

Description

Updates the penalty box setting for a security policy in evaluation mode. If this setting is enabled, you can deny requests coming from a client in the penalty box or trigger an alert.

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
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.
‑Action
Conditionally required
String Parameter sets: configid-policyid-attributes, configid-policyname-attributes, configname-policyid-attributes, configname-policyname-attributes Pipeline input: False

Specifies the action that the rule should trigger. Either alert, deny, deny, or none.

Use deny to apply a custom action instead of Akamai's default. If the action is none, it isn't associated with the policy.
‑Body
Conditionally required
Object Parameter sets: configid-policyid-body, configid-policyname-body, configname-policyid-body, configname-policyname-body Pipeline input: ByValue

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

Your configuration's ID.
‑ConfigName
Conditionally required
String Parameter sets: configname-policyid-body, configname-policyid-attributes, configname-policyname-body, configname-policyname-attributes 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.
‑PenaltyBoxProtection
Conditionally required
Bool Parameter sets: configid-policyid-attributes, configid-policyname-attributes, configname-policyid-attributes, configname-policyname-attributes Pipeline input: False

Specifies whether penalty box protection is enabled for the security policy. When set to true, the action occurs if triggered by a request.
‑PolicyID
Conditionally required
String Parameter sets: configid-policyid-body, configid-policyid-attributes, configname-policyid-body, configname-policyid-attributes Pipeline input: False

Your security policy's ID.
‑PolicyName
Conditionally required
String Parameter sets: configid-policyname-body, configid-policyname-attributes, configname-policyname-body, configname-policyname-attributes Pipeline input: False

The name of your security policy.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑VersionNumber
Required
String Pipeline input: False

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

Related Links

Updated 19 days ago