NAME

Add-DcsTrigger

SYNOPSIS

Creates a trigger for the specified task.

SYNTAX

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   -Interval <TimeSpan>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   -WeekDays <String[]>   -WeekInterval <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   -DayInterval <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   [ -Monthnumber <Int32> ]   -DayOfMonth <Int32>   -MonthlyInterval <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   [ -Monthnumber <Int32> ]   -WeekDays <String[]>   -MonthlyInterval <Int32>   -Weeknumber <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -MonitorId <String>   -MonitorState <String>   -Comparison <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -TemplateTypeId <String>   -MonitorState <String>   -Comparison <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -FilterType <String[]>   -FilterValue <String[]>   -FilterComparison <String[]>   -RequireAll <Boolean>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -VirtualDisk <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a trigger for the specified task. A trigger contains criteria that, when met, causes the task actions to be performed (see Add-DcsAction). One trigger can be added to the task each time the cmdlet is invoked.The trigger will be based on one of the following types of events: a scheduled time, a monitor state change, a message posted in the event log, or a replication checkpoint being received. There are several parameter sets for this cmdlet; five for scheduled time events, two for a monitor state change event, one for a log message event, and one for a replication checkpoint event. When creating a trigger for a log message event, filters are used to narrow the scope of the log messages. If multiple filters are configured, the number of values specified for FilterType, FilterValue, and FilterComparison parameters in the array must be identical and in an associated order. See example 7.

PARAMETERS

-Task<Object>

TaskData object, ID, or name of the task that the trigger will be added to.

Required: true

Position: named

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-Description<String>

The description parameter has been deprecated and will always be empty. This parameter is left in the interface for backwards compatibility. It cannot be changed.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-SignalDuration<TimeSpan>

This parameter indicates how long the trigger will be considered active. If not specified, the default value of "00:00:00" will be used, which indicates no signal duration setting. This parameter is only relevant when multiple triggers exist, and the RequireAllTriggers parameter set to $true in Add-DcsTask. For example, if one trigger is set to run once at 8PM and another scheduled time trigger in the same task is set to run hourly and the SignalDuration parameter is set to 12 hours, then the action would run 12 times starting at 8PM. One way to provide the SignalDuration parameter would be by passing a variable created from invoking New-Object with the TypeName parameter of TimeSpan with the correct arguments (see the Help for New-Object). The TimeSpan parameter can also be provided in a string that represents the number of days, hours, and minutes in this format: "dd:dd:dd". This value does not require quotes. For instance, to keep the triggers active for one week, the value would be "07:00:00" or to keep the triggers active for 12 hours, the value would be "00:12:00".

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-StartTime<DateTime>

The beginning date and time of a scheduled time trigger. One way to provide the StartTime parameter would be by passing a variable created by invoking New-Object with the TypeName parameter of DateTime with the correct arguments (see the Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string with the date and time. An example of the format to use is "04/06/2011 02:51:00 PM" which represents April 6, 2011 at 2:51 PM. This value must be in quotes.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Interval<TimeSpan>

When creating a scheduled time event, this parameter is used to indicate the amount of time in hours, minutes, seconds to wait between triggering the event again. The format to use is dd:dd:dd. This value does not require quotes. For instance, "02:15:30" would represent that the scheduled time event to occur every 2 hours, 15 minutes and 30 seconds. Use "00:00:00" to not set an interval.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Connection<String>

Alias of the connection to the server group. If not specified, the default connection is used.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PipelineVariable<String>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-WeekDays<String[]>

When creating a scheduled time event based on specific days of the week, this parameter uses an array of the days on which the event will occur. Possible values are: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", and "Weekdays". The "Weekdays" value is exclusive; when "Weekdays" is used, then no other day is valid. For instance, for a scheduled time event to run Monday through Friday, the parameter value would be "Weekdays". For a scheduled time event to run Monday, Wednesday, and Friday, the parameter value would be "Monday", "Wednesday", "Friday".

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-WeekInterval<Int32>

When creating a weekly scheduled time event based on the WeekDays parameter, the WeekInterval indicates how many weeks are in-between each firing of the event. For example: A value of "1" indicates that the event will occur every week. A value of "2" indicates that the event will occur every two weeks (or every other week). A value of "3" indicates that the event will occur every three weeks.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DayInterval<Int32>

When creating a scheduled time event, this parameter is used to indicate how often, in terms of days, that the event should be triggered. For example: To trigger the event every day, use "1". To trigger the event to run every two days (or every other day), use "2". To trigger the event every seven days, use "7".

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Monthnumber<Int32>

When creating a yearly scheduled time event, this parameter is used to signify the number of the month on which event will occur. For instance, January would be "1" and December would be "12". If Monthnumber and MonthlyInterval are both set, Monthnumber will supersede MonthlyInterval.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DayOfMonth<Int32>

When creating a yearly or monthly scheduled time event based on the Monthnumber or MonthlyInterval parameters, the DayOfMonth parameter is used to indicate the day of the month when the event is triggered. Valid parameter values are 1 through 31. For instance a value of "2" would indicate the second day of the month.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-MonthlyInterval<Int32>

When creating a monthly scheduled time event, the MonthlyInterval parameter indicates how many months are in-between each firing of the event. For example: A value of 1 indicates that the event will occur every month. A value of 2 indicates that the event will occur every two months (or every other month). A value of 3 indicates that the event will occur every three months.(If Monthnumber and MonthlyInterval are both used in the parameter set, Monthnumber will supersede MonthlyInterval.)

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Weeknumber<Int32>

When creating a monthly scheduled time event, this parameter signifies the number of the week in a month when the event will occur. For instance, the first week in the month would be "1" and the forth week in the month would be "4".

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-MonitorId<String>

The ID of the monitor that will trigger the event. This parameter is used to specify an instance of a specific monitor. The monitor ID is included in the MonitorData object (ID field), which can be obtained from Get-DcsMonitor. See the example 5 for more information.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-MonitorState<String>

The state that will trigger the Monitor based event. Possible values in order from lowest to highest: "Healthy", "Attention", "Warning" , and "Critical". This parameter works in conjunction with the comparison operator.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Comparison<String>

Monitor Comparison values are as follows: ">", ">=", "=", "<", and "<=".

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-TemplateTypeId<String>

The Type ID of the template used in the Monitor based trigger. This parameter is used to specify a selection of all instances of a monitor type. The template type ID is included in the MonitorDataTemplate object (TypeID field) and can be obtained from Get-DcsMonitorTemplate. See the example 6 for more information.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-FilterType<String[]>

The FilterType parameter is used to indicate what aspect of the log messages will be used to trigger the event. Potential values are: "Source", "SourceType", "MessageText", and "LogLevel". If creating multiple filters, the number of values for FilterType, FilterValue, and FilterComparison parameters must be equal and in an associated order.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-FilterValue<String[]>

The filter value that the LogMessage based trigger must contain to trigger the event. For a filter type of "Source", possible values include a string containing the name of a SAN resource. For a filter type of "SourceType", possible values include: "General", "Disk pools", "Mirrors", "Monitors", "Paths", "Physical disks", "Ports", "Replications", "Rollbacks", "Security", "Snapshots", "Hosts", "DataCore Servers", "Tasks", "Virtual disk sources", "Virtual disks", "Support", or "PerfStorage". For a filter type of "MessageText", possible values include a string from the message text field. For a filter type of "LogLevel", possible values include "Trace", "Info", "Warning", or "Error". If creating multiple filters, the number of values for FilterType, FilterValue, and FilterComparison parameters must be equal and in an associated order.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-FilterComparison<String[]>

The filter comparison value is used to compare the FilterValue to see whether the criteria have been met. Possible values are: "Contains", "DoesNotContain", "IsEqualTo", and "IsNotEqualTo". If creating multiple filters, the number of values for FilterType, FilterValue, and FilterComparison parameters must be equal and in an associated order.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-RequireAll<Boolean>

Indicates whether all Filters must be met when creating a log based event trigger.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-VirtualDisk<String>

The name or ID of the virtual disk that will receive the replication checkpoint marker.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

INPUTS

TaskData : Object that identifies and describes the task.

OUTPUTS

TaskTriggerData : Object that identifies and describes the task trigger.

NOTES

Also see Get-DcsTask, Get-DcsTrigger, Remove-DcsTrigger, Add-DcsTask, Get-DcsMonitor, Get-DcsMonitorTemplate.

EXAMPLES

Add-DcsTrigger -Task MyHourlyTask -Interval 01:00:00  -SignalDuration 00:00:00 -StartTime "07/28/2011 11:00:00 PM"
		

Add-DcsTrigger -Task MyTask -SignalDuration 00:00:00 -StartTime "10/18/11 11:45:00 AM" -DayInterval 3
		

Add-DcsTrigger -Task MyTask -SignalDuration 00:00:00 -StartTime "10/18/11 1:00:00 PM" -WeekDays "Monday", "Wednesday", "Friday" -WeekInterval 1
		

Add-DcsTrigger -Task MyTask -VirtualDisk "Virtual disk 2"
		

$Monitor = Get-DcsMonitor -Object (Get-DcsClient -Client "HostVM1")
Add-DcsTrigger -Task MonitorStateChange -MonitorId $Monitor.Id -MonitorState Healthy -Comparison ">"
		

Add-DcsTrigger -Task MonitorHosts -TemplateTypeId "T(DataCore.Executive.Controller.ClientMachineStateMonitor<DataCore.Executive.Controller.ClientMachine>)" -MonitorState Healthy -Comparison ">"
		

$Tasks = Get-DcsTask
$tasks | Add-DcsTrigger -FilterType "SourceType","LogLevel" -FilterValue "Disk pools","Warning" -FilterComparison "IsEqualTo","IsEqualTo" -RequireAll $true
		

Add-DcsTrigger -Task "Task 1" -Interval 00:00:00 -SignalDuration 00:00:00 -StartTime "06/18/2012 15:30:00 PM"
		

Add-DcsTrigger -Task "Task 1" -SignalDuration 00:00:00 -StartTime "06/18/2012 15:30:00 PM" -WeekInterval 1 -WeekDays "Weekdays"
		

Add-DcsTrigger -Task "Task 1" -SignalDuration 00:00:00 -StartTime "06/18/2012 14:00:00 PM" -MonthlyInterval 1 -DayOfMonth "15"
		

Add-DcsTrigger -Task "Task 1" -SignalDuration 00:00:00 -StartTime "06/18/2012 20:00:00 PM" -Monthnumber 1 -DayOfMonth "15" -MonthInterval 12