Find-VcLog¶
SYNOPSIS¶
Find log entries on TLSPC
SYNTAX¶
SimpleFilter (Default)¶
Find-VcLog [-Type <String[]>] [-Name <String[]>] [-Message <String>] [-Critical] [-DateFrom <DateTime>]
[-DateTo <DateTime>] [-IncludeAny] [-Order <PSObject[]>] [-First <Int32>] [-VenafiSession <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
AdvancedFilter¶
Find-VcLog -Filter <System.Collections.Generic.List`1[System.Object]> [-Order <PSObject[]>] [-First <Int32>]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Find log entries
EXAMPLES¶
EXAMPLE 1¶
Find-VcLog -First 10
Get the most recent 10 log items
EXAMPLE 2¶
Find-VcLog -Type 'Authentication'
Filter log results by specific value
EXAMPLE 3¶
Find-VcLog -DateFrom (Get-Date).AddDays(-7) -Message "certificate"
Find all logs from the past week containing "certificate" in the message
EXAMPLE 4¶
Find-VcLog -Type 'Authentication' -Message 'failed' -IncludeAny
Find logs that are either Authentication type OR contain 'failed' in the message
EXAMPLE 5¶
Find-VcLog -Filter @('and', @('activityDate', 'gt', (get-date).AddMonths(-1)), @('or', @('message', 'find', 'greg@venafi.com'), @('message', 'find', 'bob@venafi.com')), @('activityType','eq','Authentication'))
Advanced filtering of results. This filter will find authentication log entries by 1 of 2 people within the last month.
EXAMPLE 6¶
Find-VcLog -Type 'Authentication' -Order 'activityDate'
Filter log results and order them. By default, order will be ascending.
EXAMPLE 7¶
Find-VcLog -Type 'Authentication' -Order @{'activityDate'='desc'}
Filter log results and order them descending
EXAMPLE 8¶
Find-VcLog -Type 'Authentication' -Order @{'activityDate'='desc'}, 'criticality'
Filter log results and order them by multiple fields
PARAMETERS¶
-Type¶
One or more activity type, tab completion supported
Type: String[]
Parameter Sets: SimpleFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name¶
One or more activity name, tab completion supported
Type: String[]
Parameter Sets: SimpleFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Message¶
Look anywhere in the message for the string provided
Type: String
Parameter Sets: SimpleFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Critical¶
Filter logs by critical or not.
Type: SwitchParameter
Parameter Sets: SimpleFilter
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DateFrom¶
Filter logs from this date/time. Combine with DateTo for a date range.
Type: DateTime
Parameter Sets: SimpleFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DateTo¶
Filter logs to this date/time Combine with DateFrom for a date range.
Type: DateTime
Parameter Sets: SimpleFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeAny¶
When using multiple filter parameters (Type, Name, Message, Criticality), combine them with OR logic instead of AND logic
Type: SwitchParameter
Parameter Sets: SimpleFilter
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Filter¶
Array or multidimensional array of fields and values to filter on. Each array should be of the format @('operator', @(field, comparison operator, value), @(field2, comparison operator2, value2)). Nested filters are supported. For a complete list of comparison operators, see https://docs.venafi.cloud/api/about-api-search-operators/.
Type: System.Collections.Generic.List`1[System.Object]
Parameter Sets: AdvancedFilter
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Order¶
Array of fields to order on. For each item in the array, you can provide a field name by itself; this will default to ascending. You can also provide a hashtable with the field name as the key and either asc or desc as the value.
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-First¶
Only retrieve this many records
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-VenafiSession¶
Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TLSPC key can also provided.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.