Invoke ADCGetAuditmessages - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCGetAuditmessages

SYNOPSIS

Get Audit configuration object(s).

SYNTAX

GetAll (Default)

Invoke-ADCGetAuditmessages [-Filter <Hashtable>] [-GetAll] [-ViewSummary] [<CommonParameters>]

GetByArgument

Invoke-ADCGetAuditmessages [-Loglevel <String[]>] [-Numofmesgs <Double>] [-Filter <Hashtable>]
 [<CommonParameters>]

Count

Invoke-ADCGetAuditmessages [-Count] [-Filter <Hashtable>] [<CommonParameters>]

DESCRIPTION

Configuration for audit message resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCGetAuditmessages

Get data.

EXAMPLE 2

Invoke-ADCGetAuditmessages -GetAll

Get all auditmessages data.

EXAMPLE 3

Invoke-ADCGetAuditmessages -Count

Get the number of auditmessages objects.

EXAMPLE 4

Invoke-ADCGetAuditmessages -name <string>

Get auditmessages object by specifying for example the name.

EXAMPLE 5

Invoke-ADCGetAuditmessages -Filter @{ 'name'='<value>' }

Get auditmessages data with a filter.

PARAMETERS

-Loglevel

Audit log level filter, which specifies the types of events to display. The following loglevels are valid:

  • 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. Possible values = ALL, EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG
Type: String[]
Parameter Sets: GetByArgument
Aliases:

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

-Numofmesgs

Number of log messages to be displayed.

Type: Double
Parameter Sets: GetByArgument
Aliases:

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

-Count

If specified, the count of the auditmessages object(s) will be returned.

Type: SwitchParameter
Parameter Sets: Count
Aliases:

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

-Filter

Specify a filter. -Filter @{ 'name'='<value>' }

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-GetAll

Retrieve all auditmessages object(s).

Type: SwitchParameter
Parameter Sets: GetAll
Aliases:

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

-ViewSummary

When specified, only a summary of information is returned.

Type: SwitchParameter
Parameter Sets: GetAll
Aliases:

Required: False
Position: Named
Default value: False
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-ADCGetAuditmessages Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/audit/auditmessages/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️