Guide

Policy mode

Get-AppSecPolicyMode

Suggest Edits

Synopsis

Get the current mode.

Syntax

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

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

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

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

Description

Gets details regarding the mode to which your rules' updates are currently set in a given policy. When using Web Application Firewall in your security policy, the mode determines how the rules get updated:

  • KRS for manual updates.
  • AAG for automatic updates if using a legacy configuration.
  • ASE_AUTO or ASE_MANUAL for newer configurations.

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.
‑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 about 1 month ago