Policy evaluation mode

Set-AppSecPolicyEvaluationMode

Synopsis

Set evaluation mode.

Syntax

configname-policyname (Default)

Set-AppSecPolicyEvaluationMode [-ConfigName] <String> [-VersionNumber] <String> [-PolicyName] <String>
 -Eval <String> [-Mode <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

configname-policyid

Set-AppSecPolicyEvaluationMode [-ConfigName] <String> [-VersionNumber] <String> -PolicyID <String>
 -Eval <String> [-Mode <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyid

Set-AppSecPolicyEvaluationMode -ConfigID <Int32> [-VersionNumber] <String> -PolicyID <String> -Eval <String>
 [-Mode <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyname

Set-AppSecPolicyEvaluationMode -ConfigID <Int32> [-VersionNumber] <String> [-PolicyName] <String>
 -Eval <String> [-Mode <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Evaluation mode runs concurrently with your existing Web Application Firewall rule settings and records how the rules would respond if they were applied to live traffic. The default action for evaluation rules is alert. Use the START value in the Eval request parameter to begin evaluation mode.

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

-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

-Eval

Set eval to start, stop, restart, complete, or update to manage the evaluation of new rules you want to test before you upgrade. If you set eval to start, restart, or update, the response object will have an eval value of enabled. The value is disabled for requests of stop or complete.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: START, STOP, RESTART, COMPLETE, UPDATE

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

-Mode

The type of update you want to make to the evaluation hostname list. You can append additional hostnames, remove hostnames from the list, or replace the existing list with the hostnames you pass in your request.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ASE_AUTO, ASE_MANUAL

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