< Back
Get-TickleEvent
Post
NAME Get-TickleEvent
SYNOPSIS
Get one or more tickle event entries.
SYNTAX
Get-TickleEvent [-All] [-Credential <PSCredential>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Archived] [-Credential <PSCredential>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Next <Int32>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Id <Int32[]>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Name <String>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Expired] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Next <Int32>] [-Offline <String>] [<CommonParameters>]
DESCRIPTION
This command will query the tickle event database and return matching events. The parameters are used to fine-tune
the query and should be self-explanatory.
The default behavior is to query the designated SQL Server instance, but you can specify a CSV file of event log
entries and access the event data in an offline, or read-only mode.
PARAMETERS
-All [<SwitchParameter>]
List all entries in the tickle event database table.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Archived [<SwitchParameter>]
List entries that have been marked as Archived.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Specify a credential to authenticate to the SQL Server instance. This should normally not be required.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Expired [<SwitchParameter>]
Display events that have expired.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <Int32[]>
Display an event by its ID number.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Display an event by its name. You can use wildcards.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Next <Int32>
Get events in the next number of days.
Required? false
Position? named
Default value $TickleDefaultDays
Accept pipeline input? False
Accept wildcard characters? false
-Offline <String>
Access an offline, CSV version. It is assumed you have previously run a command like:
Get-TickleEvent | Export-CSV tickleexport.csv
Offline mode will not include any past events.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServerInstance <String>
The name of your SQL Server instance. The parameter will default to the module variable.
Required? false
Position? named
Default value $TickleServerInstance
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
MyTickle
NOTES
Learn more about PowerShell: http://jdhitsolutions.com/blog/essentia ... resources/
-------------------------- Example 1 --------------------------
PS C:\\> Get-TickleEvent
Display all non-expired and non-archived events.
-------------------------- Example 2 --------------------------
PS C:\\> Get-TickleEvent -next 14
Display all non-expired and non-archived events scheduled for the next 14 days.
-------------------------- Example 3 --------------------------
PS C:\\> Get-TickleEvent -offline c:\\users\\jeff\\dropbox\\tickledb.csv
Display all non-expired from an offline source. By default, offline mode will display events scheduled for the
next number days specified by $TickleDefaultDays or the value of the -Next parameter.
-------------------------- Example 4 --------------------------
PS C:\\> get-tickleevent -name 'mvp summit'
ID Event Comment Date Countdown
-- ----- ------- ---- ---------
282 MVP Summit through 3/22 3/17/2019 12:00:00 AM 66.11:35:09
Get an event by its name.
RELATED LINKS
Set-TickleEvent
Add-TickleEvent
SYNOPSIS
Get one or more tickle event entries.
SYNTAX
Get-TickleEvent [-All] [-Credential <PSCredential>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Archived] [-Credential <PSCredential>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Next <Int32>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Id <Int32[]>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Name <String>] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Credential <PSCredential>] [-Expired] [-ServerInstance <String>] [<CommonParameters>]
Get-TickleEvent [-Next <Int32>] [-Offline <String>] [<CommonParameters>]
DESCRIPTION
This command will query the tickle event database and return matching events. The parameters are used to fine-tune
the query and should be self-explanatory.
The default behavior is to query the designated SQL Server instance, but you can specify a CSV file of event log
entries and access the event data in an offline, or read-only mode.
PARAMETERS
-All [<SwitchParameter>]
List all entries in the tickle event database table.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Archived [<SwitchParameter>]
List entries that have been marked as Archived.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Specify a credential to authenticate to the SQL Server instance. This should normally not be required.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Expired [<SwitchParameter>]
Display events that have expired.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <Int32[]>
Display an event by its ID number.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Display an event by its name. You can use wildcards.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Next <Int32>
Get events in the next number of days.
Required? false
Position? named
Default value $TickleDefaultDays
Accept pipeline input? False
Accept wildcard characters? false
-Offline <String>
Access an offline, CSV version. It is assumed you have previously run a command like:
Get-TickleEvent | Export-CSV tickleexport.csv
Offline mode will not include any past events.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServerInstance <String>
The name of your SQL Server instance. The parameter will default to the module variable.
Required? false
Position? named
Default value $TickleServerInstance
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
MyTickle
NOTES
Learn more about PowerShell: http://jdhitsolutions.com/blog/essentia ... resources/
-------------------------- Example 1 --------------------------
PS C:\\> Get-TickleEvent
Display all non-expired and non-archived events.
-------------------------- Example 2 --------------------------
PS C:\\> Get-TickleEvent -next 14
Display all non-expired and non-archived events scheduled for the next 14 days.
-------------------------- Example 3 --------------------------
PS C:\\> Get-TickleEvent -offline c:\\users\\jeff\\dropbox\\tickledb.csv
Display all non-expired from an offline source. By default, offline mode will display events scheduled for the
next number days specified by $TickleDefaultDays or the value of the -Next parameter.
-------------------------- Example 4 --------------------------
PS C:\\> get-tickleevent -name 'mvp summit'
ID Event Comment Date Countdown
-- ----- ------- ---- ---------
282 MVP Summit through 3/22 3/17/2019 12:00:00 AM 66.11:35:09
Get an event by its name.
RELATED LINKS
Set-TickleEvent
Add-TickleEvent