| addauditnslogaction |
Use this method to adds an nslog action. The action contains a reference to an nslog server and specifies which information to log and how to log that information. |
Syntax |
Parameters |
name |
Name of the nslog action. 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 nslog action 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 nslog action" or 'my nslog action'). This is mandatory parameter. |
serverip |
IP address of the nslog server. |
serverdomainname |
Auditserver name as a FQDN. Mutually exclusive with serverIP |
domainresolveretry |
Time, in seconds, for which the Citrix ADC waits before sending another DNS query to resolve the host name of the audit server if the last query failed. Default value = 5. Minimum value = 5. Maximum value = 20939. |
serverport |
Port on which the nslog server accepts connections. Minimum value = 1. |
loglevel |
Audit log level, which specifies the types of events to log.
Available settings function as follows:
* ALL - All events.
* EMERGENCY - Events that indicate an immediate crisis on the server.
* ALERT - Events that might require action.
* CRITICAL - Events that indicate an imminent server crisis.
* ERROR - Events that indicate some type of error.
* WARNING - Events that require action in the near future.
* NOTICE - Events that the administrator should know about.
* INFORMATIONAL - All but low-level events.
* DEBUG - All events, in extreme detail.
* NONE - No events. This is mandatory parameter. |
dateformat |
Format of dates in the logs.
Supported formats are:
* MMDDYYYY - U.S. style month/date/year format.
* DDMMYYYY - European style date/month/year format.
* YYYYMMDD - ISO style year/month/date format. |
logfacility |
Facility value, as defined in RFC 3164, assigned to the log message.
Log facility values are numbers 0 to 7 (LOCAL0 through LOCAL7). Each number indicates where a specific message originated from, such as the Citrix ADC itself, the VPN, or external. |
tcp |
Log TCP messages. |
acl |
Log access control list (ACL) messages. |
timezone |
Time zone used for date and timestamps in the logs.
Available settings function as follows:
* GMT_TIME. Coordinated Universal Time.
* LOCAL_TIME. The server's timezone setting. |
userdefinedauditlog |
Log user-configurable log messages to nslog.
Setting this parameter to NO causes auditing to ignore all user-configured message actions. Setting this parameter to YES causes auditing to log user-configured message actions that meet the other logging criteria. |
appflowexport |
Export log messages to AppFlow collectors.
Appflow collectors are entities to which log messages can be sent so that some action can be performed on them. |
lsn |
Log the LSN messages |
alg |
Log the ALG messages |
subscriberlog |
Log subscriber session event information |
sslinterception |
Log SSL Interception event information |
contentinspectionlog |
Log Content Inspection event information |
protocolviolations |
Log protocol violations |
denylistviolations |
Log denylist violations |
Return Value |
Returns simpleResult |
See Also |