getappfwprofileResult Structure Definition

The getappfwprofileResult structure defines the return type for getappfwprofile API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

appfwprofileList

List of appfwprofiles


appfwprofile Structure Definition

The appfwprofile structure defines the actual return type values for getappfwprofile API.

Syntax



Members

name

Name of the application firewall profile.

type

The profile type of of this Application Firewall profile. If the profile is of the HTML type, only checks relevant to HTML are applied. If the profile is of the XML type, only checks relevent to XML are applied. if the profile is of the Web 2.0 type, then both types of checks are applied.

state

Enabled.

defaults

Default configuration to apply to the profile. Basic defaults are intended for standard content that requires little further configuration, such as static web site content. Advanced defaults are intended for specialized content that requires significant specialized configuration, such as heavily scripted or dynamic content. CLI users: When adding an application firewall profile, you can set either the defaults or the type, but not both. To set both options, create the profile by using the add appfw profile method, and then use the set appfw profile method to configure the other option.

usehtmlerrorobject

Send an imported HTML Error object to a user when a request is blocked, instead of redirecting the user to the designated Error URL.

errorurl

The error page for this profile.

htmlerrorobject

Name to assign to the HTML Error Object. Must begin with a letter, number, or the underscore character \(_\), and must contain only letters, numbers, and the hyphen \(-\), period \(.\) pound \(\#\), space \( \), at (@), equals \(=\), colon \(:\), and underscore characters. Cannot be changed after the HTML error object is added. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks \(for example, "my HTML error object" or 'my HTML error object'\).

htmlerrorstatuscode

Response status code associated with HTML error page. Non-empty HTML error object must be imported to the application firewall profile for the status code.

htmlerrorstatusmessage

Response status message associated with HTML error page

logeverypolicyhit

Log every profile match, regardless of security checks results.

stripcomments

Tells the Application Firewall to strip HTML comments from responses before sending them to the user.
NOTE: This attribute is deprecated.
Replaced by a new method that provides an option to exclude comments inside