Skip to content

Read-VdcLog

SYNOPSIS

Read entries from the TLSPDC log

SYNTAX

Read-VdcLog [[-Path] <String>] [[-EventId] <String>] [[-Severity] <TppEventSeverity>] [[-StartTime] <DateTime>]
 [[-EndTime] <DateTime>] [[-Text1] <String>] [[-Text2] <String>] [[-Value1] <Int32>] [[-Value2] <Int32>]
 [[-First] <Int32>] [[-VenafiSession] <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Read entries from the TLSPDC log.

EXAMPLES

EXAMPLE 1

Read-VdcLog -First 10

Get the most recent 10 log items

EXAMPLE 2

$capiObject | Read-VdcLog

Find all events for a specific object

EXAMPLE 3

Read-VdcLog -EventId '00130003'

Find all events with event ID '00130003', Certificate Monitor - Certificate Expiration Notice

PARAMETERS

-Path

Path to search for related records

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

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

-EventId

Event ID as found in Logging->Event Definitions

Type: String
Parameter Sets: (All)
Aliases:

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

-Severity

Filter records by severity

Type: TppEventSeverity
Parameter Sets: (All)
Aliases:
Accepted values: Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug

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

-StartTime

Start time of events

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-EndTime

End time of events

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-Text1

Filter matching results of Text1

Type: String
Parameter Sets: (All)
Aliases:

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

-Text2

Filter matching results of Text2

Type: String
Parameter Sets: (All)
Aliases:

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

-Value1

Filter matching results of Value1

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Value2

Filter matching results of Value2

Type: Int32
Parameter Sets: (All)
Aliases:

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

-First

Return only these number of records

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
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 TLSPDC token can also provided. If providing a TLSPDC token, an environment variable named VDC_SERVER must also be set.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
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.

INPUTS

Path

OUTPUTS

PSCustomObject

EventId

ClientTimestamp

Component

ComponentId

ComponentSubsystem

Data

Grouping

Id

Name

ServerTimestamp

Severity

SourceIP

Text1

Text2

Value1

Value2

NOTES

https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-GET-Log.php