CCM_Scheduler_ScheduledMessage Client WMI Class

 

Updated: November 1, 2013

Applies To: System Center 2012 Configuration Manager, System Center 2012 Configuration Manager SP1, System Center 2012 R2 Configuration Manager

In System Center 2012 R2 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[];
};

The CCM_Scheduler_ScheduledMessage class does not define any methods.

ActiveMessage

Data type: String

Access type: Read/Write

Qualifiers: None

Message to send when the schedule becomes active. If the value is omitted, no message is sent to the target endpoint.

ActiveTime

Data type: DateTime

Access type: Read/Write

Qualifiers: None

Date and time when the schedule becomes active.

ActiveTimeIsGMT

Data type: Boolean

Access type: Read/Write

Qualifiers: None

true 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: UInt32

Access type: Read/Write

Qualifiers: None

Defines 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: String

Access type: Read/Write

Qualifiers: None

Mode set for every message delivered under the schedule. Possible values are:

  • Express

  • Recoverable

ExpireMessage

Data type: String

Access type: Read/Write

Qualifiers: None

Message to send when the schedule expires. If the value is omitted, no message is sent to the target endpoint.

ExpireTime

Data type: DateTime

Access type: Read/Write

Qualifiers: None

Date and time when the schedule expires.

ExpireTimeIsGMT

Data type: Boolean

Access type: Read/Write

Qualifiers: None

true 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: UInt32

Access type: Read/Write

Qualifiers: None

Defines 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

 

System_CAPS_importantImportant

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: String

Access type: Read/Write

Qualifiers: None

Name 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: String

Access type: Read/Write

Qualifiers: None

Timeout 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: UInt32

Access type: Read/Write

Qualifiers: None

Defines 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: String

Access type: Read/Write

Qualifiers: [key]

See CCM_Policy Client WMI Class.

PolicyInstanceID

Data type: String

Access type: Read/Write

Qualifiers: [key]

See CCM_Policy Client WMI Class.

PolicyPrecedence

Data type: UInt32

Access type: Read/Write

Qualifiers: None

See CCM_Policy Client WMI Class.

PolicyRuleID

Data type: String

Access type: Read/Write

Qualifiers: [key]

See CCM_Policy Client WMI Class.

PolicySource

Data type: String

Access type: Read/Write

Qualifiers: [key]

See CCM_Policy Client WMI Class.

PolicyVersion

Data type: String

Access type: Read/Write

Qualifiers: [key]

See CCM_Policy Client WMI Class.

ReplyToEndpoint

Data type: String

Access type: Read/Write

Qualifiers: None

Reply-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: String

Access type: Read/Write

Qualifier: [RealKey, Not_Null]

ID of the scheduled message, which can be any unique string.

TargetEndpoint

Data type: String

Access type: Read/Write

Qualifiers: None

Endpoint 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: String

Access type: Read/Write

Qualifiers: None

Message 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 Array

Access type: Read/Write

Qualifiers: None

Array of trigger strings that define when the message should be sent.


<TriggerString> := <TriggerType> [ ';' <Name> '=' <Value>]*

<TriggerType> :=  The type of  trigger.
<Name> := Name of a property defined by the trigger type.
<Value> := Value of the property.
Show: