Guide

Policy evaluation mode

Set-AppSecPolicyEvaluationMode

Suggest Edits

Synopsis

Set evaluation mode.

Syntax

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

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

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

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
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.
‑ConfigID
Conditionally required
Int Parameter sets: configid-policyid, configid-policyname Pipeline input: False

Your configuration's ID.
‑ConfigName
Conditionally required
String Parameter sets: configname-policyid, configname-policyname 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.
‑Eval
Required
String Accepted values: START, STOP, RESTART, COMPLETE, UPDATE Pipeline input: False

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. For more information, see Set-AppSecPolicyEvaluationMode.
‑Mode
String Accepted values: ASE_AUTO, ASE_MANUAL Pipeline input: False

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

Your security policy's ID.
‑PolicyName
Conditionally required
String Parameter sets: configid-policyname, configname-policyname 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 4 months ago