In System Center 2012 Configuration Manager, the CCM_Scheduler_ScheduledMessage class is a client Windows Management Instrumentation (WMI) class that represents the configuration for a scheduled message. There is an instance of this class for each scheduled message.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Class CCM_Scheduler_ScheduledMessage : CCM_Policy { String ActiveMessage; DateTime ActiveTime; Boolean ActiveTimeIsGMT; UInt32 DeadlineMinutes; String DeliverMode; String ExpireMessage; DateTime ExpireTime; Boolean ExpireTimeIsGMT; UInt32 LaunchConditions; String MessageName; String MessageTimeout; UInt32 Order; String PolicyID; String PolicyInstanceID; UInt32 PolicyPrecedence; String PolicyRuleID; String PolicySource; String PolicyVersion; String ReplyToEndpoint; String ScheduledMessageID; String TargetEndpoint; String TriggerMessage; String Triggers[]; }; |
Methods
The CCM_Scheduler_ScheduledMessage class does not define any methods.
Properties
- ActiveMessage
- Data type: StringAccess type: Read/WriteQualifiers: NoneMessage to send when the schedule becomes active. If the value is omitted, no message is sent to the target endpoint.
- ActiveTime
- Data type: DateTimeAccess type: Read/WriteQualifiers: NoneDate and time when the schedule becomes active.
- ActiveTimeIsGMT
- Data type: BooleanAccess type: Read/WriteQualifiers: Nonetrue if ActiveTime is in Universal Coordinated Time (UTC). If the value is omitted or set to FALSE, the time specifies the client computer's local time.
- DeadlineMinutes
- Data type: UInt32Access type: Read/WriteQualifiers: NoneDefines how long the schedule will be on hold if its launch conditions are not met. The default value is 4320 minutes (3 days).
- DeliverMode
- Data type: StringAccess type: Read/WriteQualifiers:
NoneMode set for every message delivered under the schedule.
Possible values are:
- Express
- Recoverable
- Express
- ExpireMessage
- Data type: StringAccess type: Read/WriteQualifiers: NoneMessage to send when the schedule expires. If the value is omitted, no message is sent to the target endpoint.
- ExpireTime
- Data type: DateTimeAccess type: Read/WriteQualifiers: NoneDate and time when the schedule expires.
- ExpireTimeIsGMT
- Data type: BooleanAccess type: Read/WriteQualifiers: Nonetrue if ExpireTime is in Universal Coordinated Time (UTC). If the value is omitted or set to false, the time specifies the client computer's local time.
- LaunchConditions
- Data type: UInt32Access type: Read/WriteQualifiers:
NoneDefines the system resource conditions to fire this schedule.
The default value is 1. Possible values are a combination of the
following:
0
eTaskCondition_None
1
eTaskCondition_AboveCriticalBattery
2
eTaskCondition_AboveLowBattery
4
eTaskCondition_OnAC
8
eTaskCondition_Idle
16
eTaskCondition_NetworkConnected
Important Only one of these power conditions should be supplied in the schedule policy. If more than one is supplied, we honor: OnAC > AboveLowBattery > AboveCriticalBattery
- MessageName
- Data type: StringAccess type: Read/WriteQualifiers: NoneName to set for every message delivered under the schedule. If the value is omitted, this property is not set on the message.
- MessageTimeout
- Data type: StringAccess type: Read/WriteQualifiers: NoneTimeout set for every message delivered under the schedule. If the value is omitted or set to 0, the timeout is set to INFINITE.
- Order
- Data type: UInt32Access type: Read/WriteQualifiers: NoneDefines the order of the firing if multiple schedules were waiting on conditions and now all the conditions have been met. The smaller the number, the higher the priority. The default value is 4294967295 (0xFFFFFFFF).
- PolicyID
- Data type: StringAccess type: Read/WriteQualifiers: [key]See CCM_Policy Client WMI Class.
- PolicyInstanceID
- Data type: StringAccess type: Read/WriteQualifiers: [key]See CCM_Policy Client WMI Class.
- PolicyPrecedence
- Data type: UInt32Access type: Read/WriteQualifiers: NoneSee CCM_Policy Client WMI Class.
- PolicyRuleID
- Data type: StringAccess type: Read/WriteQualifiers: [key]See CCM_Policy Client WMI Class.
- PolicySource
- Data type: StringAccess type: Read/WriteQualifiers: [key]See CCM_Policy Client WMI Class.
- PolicyVersion
- Data type: StringAccess type: Read/WriteQualifiers: [key]See CCM_Policy Client WMI Class.
- ReplyToEndpoint
- Data type: StringAccess type: Read/WriteQualifiers: NoneReply-to endpoint set for every message delivered under the schedule. If the value is omitted, this property is not set on the message.
- ScheduledMessageID
- Data type: StringAccess type: Read/WriteQualifier: [RealKey, Not_Null]ID of the scheduled message, which can be any unique string.
- TargetEndpoint
- Data type: StringAccess type: Read/WriteQualifiers: NoneEndpoint address to send messages to when a trigger fires or when activation/expiration occurs. This address is relative to the computer on which the scheduler evaluates the schedule.
- TriggerMessage
- Data type: StringAccess type: Read/WriteQualifiers: NoneMessage to send when a trigger on the schedule occurs. If the value is omitted, an empty message is sent to the target endpoint.
- Triggers
- Data type: String ArrayAccess type: Read/WriteQualifiers: NoneArray of trigger strings that define when the message should be sent.
Syntax
Copy Code | |
---|---|
<TriggerString> := <TriggerType> [ ';' <Name> '=' <Value>]* <TriggerType> := The type of trigger. <Name> := Name of a property defined by the trigger type. <Value> := Value of the property. |
Requirements
Runtime Requirements
For more information, see Configuration Manager Client Runtime Requirements.
Development Requirements
For more information, see Configuration Manager Client Development Requirements.