Set-TickleEvent

NAME Set-TickleEvent



SYNOPSIS

Modify a tickle event.





SYNTAX

Set-TickleEvent [-ID] <Int32> [-Archive] [-Confirm] [-Credential <PSCredential>] [-Passthru] [-ServerInstance

<String>] [-WhatIf] [<CommonParameters>]



Set-TickleEvent [-ID] <Int32> [-Comment <String>] [-Confirm] [-Credential <PSCredential>] [-Date <DateTime>]

[-Event <String>] [-Passthru] [-ServerInstance <String>] [-WhatIf] [<CommonParameters>]





DESCRIPTION

Use this command to update or modify an existing tickle event. This command will use the Tickle variables for its

defaults.





PARAMETERS

-Archive [<SwitchParameter>]

Mark an entry as archived. The current version of the module retains all events in a single database table.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Comment <String>

Update the event comment field.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-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



-Date <DateTime>

Update the event's date field.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Event <String>

Update the event name.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ID <Int32>

Select an event by its ID.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Passthru [<SwitchParameter>]

Write the updated event back to the pipeline.



Required? false

Position? named

Default value False

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



-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





MyTickle







NOTES





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



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



PS C:\\> Set-TickleEvent -id 100 -date "8/1/2019 5:00PM"



Set a new date for tickle event ID 100.

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



PS C:\\> Get-TickleEvent -expired | Set-TickleEvent -archived



Get all expired events and mark them as archived.



RELATED LINKS

Add-TickleEvent

Get-TickleEvent