Invoke-ADCUpdateAuditsyslogaction

SYNOPSIS

Update Audit configuration Object.

SYNTAX

Invoke-ADCUpdateAuditsyslogaction [-Name] <String> [[-Serverip] <String>] [[-Serverdomainname] <String>]
 [[-Lbvservername] <String>] [[-Domainresolveretry] <Int32>] [[-Domainresolvenow] <Boolean>]
 [[-Serverport] <Int32>] [[-Loglevel] <String[]>] [[-Dateformat] <String>] [[-Logfacility] <String>]
 [[-Tcp] <String>] [[-Acl] <String>] [[-Timezone] <String>] [[-Userdefinedauditlog] <String>]
 [[-Appflowexport] <String>] [[-Lsn] <String>] [[-Alg] <String>] [[-Subscriberlog] <String>]
 [[-Tcpprofilename] <String>] [[-Maxlogdatasizetohold] <Double>] [[-Dns] <String>]
 [[-Contentinspectionlog] <String>] [[-Netprofile] <String>] [[-Sslinterception] <String>]
 [[-Urlfiltering] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for system log action resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateAuditsyslogaction -name <string>

An example how to update auditsyslogaction configuration Object(s).

PARAMETERS

-Name

Name of the syslog 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 syslog action is added.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Serverip

IP address of the syslog server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Serverdomainname

SYSLOG server name as a FQDN. Mutually exclusive with serverIP/lbVserverName.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Lbvservername

Name of the LB vserver. Mutually exclusive with syslog serverIP/serverName.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Domainresolveretry

Time, in seconds, for which the Citrix ADC waits before sending another DNS query to resolve the host name of the syslog server if the last query failed.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Domainresolvenow

Immediately send a DNS query to resolve the server's domain name.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Serverport

Port on which the syslog server accepts connections.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Loglevel

Audit log level, which specifies the types of events to log. Available values 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. Possible values = ALL, EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG, NONE

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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. Possible values = MMDDYYYY, DDMMYYYY, YYYYMMDD

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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. Possible values = LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tcp

Log TCP messages. Possible values = NONE, ALL

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Acl

Log access control list (ACL) messages. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Timezone

Time zone used for date and timestamps in the logs. Supported settings are:

GMT_TIME. Coordinated Universal time.
LOCAL_TIME. Use the server's timezone setting. Possible values = GMT_TIME, LOCAL_TIME

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Userdefinedauditlog

Log user-configurable log messages to syslog. 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. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Lsn

Log lsn info. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Alg

Log alg info. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Subscriberlog

Log subscriber session event information. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tcpprofilename

Name of the TCP profile whose settings are to be applied to the audit server info to tune the TCP connection parameters.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Maxlogdatasizetohold

Max size of log data that can be held in NSB chain of server info.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Dns

Log DNS related syslog messages. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Contentinspectionlog

Log Content Inspection event information. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Netprofile

Name of the network profile. The SNIP configured in the network profile will be used as source IP while sending log messages.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sslinterception

Log SSL Interception event information. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Urlfiltering

Log URL filtering event information. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return details about the created auditsyslogaction item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUpdateAuditsyslogaction Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/audit/auditsyslogaction/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.