Policy evaluation penalty box

Get-AppSecPolicyEvaluationPenaltyBox

Synopsis

Get the penalty box for a policy in evaluation mode.

Syntax

configname-policyname (Default)

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

configname-policyid

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

configid-policyid

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

configid-policyname

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

Description

Gets the penalty box settings for a security policy in evaluation mode.

When the penalty box is enabled for a policy, clients that trigger a Web Application Firewall 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.

In the 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

-ConfigID

An ID for each configuration.

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

-PolicyID

An ID for a security policy.

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

None

Outputs

System.Object