getappfwsettingsResult Structure Definition

The getappfwsettingsResult structure defines the return type for getappfwsettings 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.

appfwsettingsList

List of appfwsettingss


appfwsettings Structure Definition

The appfwsettings structure defines the actual return type values for getappfwsettings API.

Syntax



Members

defaultprofile

Profile to use when a connection does not match any policy. Default setting is APPFW_BYPASS, which sends unmatched connections back to the Citrix ADC without attempting to filter them further.

undefaction

Profile to use when an application firewall policy evaluates to undefined (UNDEF). An UNDEF event indicates an internal error condition. The APPFW_BLOCK built-in profile is the default setting. You can specify a different built-in or user-created profile as the UNDEF profile.

sessiontimeout

Session timeout (in seconds).

learnratelimit

Learn messages rate limit value (in messages per second).

sessionlifetime

Session lifetime (in seconds). Zero means no limit.

sessioncookiename

Name of the session cookie that the application firewall uses to track user sessions. Must begin with a letter or number, and can consist of from 1 to 31 letters, numbers, and the hyphen (-) and underscore (_) symbols. 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 cookie name" or 'my cookie name').

clientiploggingheader

Name of header that holds downstream IP address for logging purposes.

importsizelimit

Maximum cumulative size in bytes of all objects imported to Netscaler. The user is not allowed to import an object if the operation exceeds the currently configured limit.

signatureautoupdate

Flag used to enable/disable auto update signatures

signatureurl

URL to download the mapping file from server

cookiepostencryptprefix

String that is prepended to all encrypted cookie values.

logmalformedreq

Log requests that are so malformed that application firewall parsing doesn't occur.
NOTE: This attribute is deprecated.

geolocationlogging

Enable Geo-Location Logging in CEF format logs.

ceflogging

Enable CEF format logs.

entitydecoding

Transform multibyte (double- or half-width) characters to single width characters.

useconfigurablesecretkey

Use configurable secret key in AppFw operations

sessionlimit

Maximum number of sessions that the application firewall allows to be active, regardless of user activity. After the max_limit reaches, No more user session will be created .

malformedreqaction

flag to define action on malformed requests that application firewall cannot parse

learning

Global learning option that overrides the profile level learning. Available settings are as follows: * ON - Honor all profile level learn settings. * OFF - Avoids learning for all profiles ignoring profile level learn setting.

centralizedlearning

Flag used to enable/disable ADM centralized learning

proxyserver

Proxy Server IP to get updated signatures from AWS.

proxyport

Proxy Server Port to get updated signatures from AWS.

proxyusername

Proxy Username

proxypassword

Password with which proxy user logs on.

cookieflags

Add the specified flags to AppFW cookies. Available setttings function as follows: * None - Do not add flags to AppFW cookies. * HTTP Only - Add the HTTP Only flag to AppFW cookies, which prevent scripts from accessing them. * Secure - Add Secure flag to AppFW cookies. * All - Add both HTTPOnly and Secure flag to AppFW cookies.

builtin

Flag to determine if application firewall settings is built-in or not

_nextgenapiresource


See Also