Get-OCIWaasWafLogsList

SYNOPSIS

Invokes Waas service - ListWafLogs operation.

SYNTAX

Limit

Get-OCIWaasWafLogsList -WaasPolicyId <String> [-OpcRequestId <String>] [-Limit <Int32>] [-Page <String>] [-TimeObservedGreaterThanOrEqualTo <DateTime>] [-TimeObservedLessThan <DateTime>] [-TextContains <String>] [-AccessRuleKey <System.Collections.Generic.List`1[System.String]>] [-Action <System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+ActionEnum]>] [-ClientAddress <System.Collections.Generic.List`1[System.String]>] [-CountryCode <System.Collections.Generic.List`1[System.String]>] [-CountryName <System.Collections.Generic.List`1[System.String]>] [-Fingerprint <System.Collections.Generic.List`1[System.String]>] [-HttpMethod <System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+HttpMethodEnum]>] [-IncidentKey <System.Collections.Generic.List`1[System.String]>] [-LogType <System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+LogTypeEnum]>] [-OriginAddress <System.Collections.Generic.List`1[System.String]>] [-Referrer <System.Collections.Generic.List`1[System.String]>] [-RequestUrl <System.Collections.Generic.List`1[System.String]>] [-ResponseCode <System.Collections.Generic.List`1[System.Int32]>] [-ThreatFeedKey <System.Collections.Generic.List`1[System.String]>] [-UserAgent <System.Collections.Generic.List`1[System.String]>] [-ProtectionRuleKey <System.Collections.Generic.List`1[System.String]>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIWaasWafLogsList -WaasPolicyId <String> [-OpcRequestId <String>] [-Page <String>] [-TimeObservedGreaterThanOrEqualTo <DateTime>] [-TimeObservedLessThan <DateTime>] [-TextContains <String>] [-AccessRuleKey <System.Collections.Generic.List`1[System.String]>] [-Action <System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+ActionEnum]>] [-ClientAddress <System.Collections.Generic.List`1[System.String]>] [-CountryCode <System.Collections.Generic.List`1[System.String]>] [-CountryName <System.Collections.Generic.List`1[System.String]>] [-Fingerprint <System.Collections.Generic.List`1[System.String]>] [-HttpMethod <System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+HttpMethodEnum]>] [-IncidentKey <System.Collections.Generic.List`1[System.String]>] [-LogType <System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+LogTypeEnum]>] [-OriginAddress <System.Collections.Generic.List`1[System.String]>] [-Referrer <System.Collections.Generic.List`1[System.String]>] [-RequestUrl <System.Collections.Generic.List`1[System.String]>] [-ResponseCode <System.Collections.Generic.List`1[System.Int32]>] [-ThreatFeedKey <System.Collections.Generic.List`1[System.String]>] [-UserAgent <System.Collections.Generic.List`1[System.String]>] [-ProtectionRuleKey <System.Collections.Generic.List`1[System.String]>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets structured Web Application Firewall event logs for a WAAS policy. Sorted by the timeObserved in ascending order (starting from the oldest recorded event).

PARAMETERS

-AccessRuleKey

Filters logs by access rule key.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Action

Filters logs by Web Application Firewall action.

Type: System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+ActionEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Block, Detect, Bypass, Log, Redirected

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

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

-ClientAddress

Filters logs by client IP address.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

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

-CountryCode

Filters logs by country code. Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO's website.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CountryName

Filter logs by country name.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Fingerprint

Filter logs by device fingerprint.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-HttpMethod

Filter logs by HTTP method.

Type: System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+HttpMethodEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Options, Get, Head, Post, Put, Delete, Trace, Connect

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IncidentKey

Filter logs by incident key.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

The maximum number of items to return in a paginated call. If unspecified, defaults to `20`.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LogType

Filter by log type. For more information about WAF logs, see Logs.

Type: System.Collections.Generic.List`1[Oci.WaasService.Requests.ListWafLogsRequest+LogTypeEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Access, ProtectionRules, JsChallenge, Captcha, AccessRules, ThreatFeeds, HumanInteractionChallenge, DeviceFingerprintChallenge, AddressRateLimiting

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

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

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

-OpcRequestId

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OriginAddress

Filter by origin IP address.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

The value of the `opc-next-page` response header from the previous paginated call.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

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

-ProtectionRuleKey

Filter by protection rule key.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Referrer

Filter by referrer.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RequestUrl

Filter by request URL.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResponseCode

Filter by response code.

Type: System.Collections.Generic.List`1[System.Int32]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TextContains

A full text search for logs.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ThreatFeedKey

Filter by threat feed key.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeObservedGreaterThanOrEqualTo

A filter that matches log entries where the observed event occurred on or after a date and time specified in RFC 3339 format. If unspecified, defaults to two hours before receipt of the request.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeObservedLessThan

A filter that matches log entries where the observed event occurred before a date and time, specified in RFC 3339 format.

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

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

-UserAgent

Filter by user agent.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WaasPolicyId

The OCID of the WAAS policy.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

OUTPUTS

• Oci.WaasService.Models.WafLog
• Oci.WaasService.Responses.ListWafLogsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples