Remove-TickleEvent

NAME Remove-TickleEvent



SYNOPSIS

Delete a tickle event from the database.





SYNTAX

Remove-TickleEvent [-ID] <Int32> [-Confirm] [-Credential <PSCredential>] [-ServerInstance <String>] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

Events in the tickle database remain, even though they may not be displayed by default. Normally you can archive

expired events. But you can also delete entries with this command.





PARAMETERS

-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



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



-ID <Int32>

A tickle event ID.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

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



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

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

System.Int32







OUTPUTS

None







NOTES





Learn more about PowerShell: http://jdhitsolutions.com/blog/essentia ... resources/



-------------------------- Example 1 --------------------------



PS C:\\> Remove-TickleEvent -id 100



Removed the event with an ID of 100.

-------------------------- Example 2 --------------------------



PS C:\\> Get-TickleEvent -name Dentist | Remove-TickleEvent



Remove all events with a name of Dentist. Note that this will only remove un-expired and un-archived entries.



RELATED LINKS

Set-TickleEvent

Add-TickleEvent