Variables for Device Commands/Events

The user can use these variables to create custom commands. The variable names are case insensitive. Unknown variables are not resolved, the place holder will not be removed.

General Variables

These variables can be used for Device Commands and for the listed Events.

Variable	Description	Example	Events
%NetEcm.ScriptDir%	ScriptDir aus App.config		DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied DeviceReplaced AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%NetEcm.UserName%	Username of the user who started a action or command.	contoso\john	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceName%	Hostname of the device	MAN-127	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceMacAddress%	MAC Address of the device	00:15:5d:3a:6c:01	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceSMBiosGuid%	SMBiosGuid of the device	03472543-0B59-4353-8D57-DBF7840A002F	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceType%	Name of the corresponding device type	ClientType	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceStagingCollectionID%	OSD Collection ID	t0100001	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>].DataType%	DataType of the device variable <VariableName>	1=String 2=Bool 3=DateTime 4=Enum	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>] .VariableName%	Name of the device variable <VariableName>	Location	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>] .VariableDisplayName%	Displayname of the device variable <VariableName>	Place	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>] .Required%	Returns true if the variable is required <VariableName>	True, False	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>] .DefaultValue%	Default value of the device variable <VariableName>	Switzerland	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>].Value%	Value of the device variable	Germany	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>]%	Alias for %DeviceVariable[<VariableName>].Value%	Germany	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed
%DeviceVariable[<VariableName>] .ValidationPattern%	Pattern of the device variable <VariableName>	^((([0-9a-fA-F]){2}:){5}(([0-9a-fA-F]){2}))?$	DeviceAdded DeviceUpdated DeviceDeleted DeviceMacGuidUpdated DeviceConfigApplied AfterStageDeviceJob DeviceReadyToStage DeviceStagingStarted DeviceStaged StageDeviceFailed

Variables for specific Events

The following variables are only available for a specific Event.

DeviceDeleted

Variable	Description	Example
%DeleteSccmObject%	Should the device be deleted in the ConfigMgr DB	True, False

AfterStageDeviceJob

Variable	Description	Example
%ClearPxe%	Should the pxe flag be reset on restage	True, False

DeviceMacGuidUpdated, DeviceConfigApplied

Variable	Description	Example
%OldDeviceName%
%OldDeviceMacAddress%
%OldDeviceSMBiosGuid%
%OldDeviceType%
%OldDeviceStagingCollectionID%
%OldDeviceVariable[<VariableName>].DataType%
%OldDeviceVariable[<VariableName>].VariableName%
%OldDeviceVariable[<VariableName>].VariableDisplayName%
%OldDeviceVariable[<VariableName>].Required%
%OldDeviceVariable[<VariableName>].DefaultValue%
%OldDeviceVariable[<VariableName>].Value%
%OldDeviceVariable[<VariableName>]%
%OldDeviceVariable[<VariableName>].ValidationPattern%

DeviceReplaced

Variable	Description	Example
<%DeviceToReplaceDeviceName%/td>
%DeviceToReplaceDeviceMacAddress%
%DeviceToReplaceDeviceSMBiosGuid%
%DeviceToReplaceDeviceType%
%DeviceToReplaceDeviceStagingCollectionID%
%DeviceToReplaceDeviceVariable[<VariableName>].DataType%
%DeviceToReplaceDeviceVariable[<VariableName>].VariableName%
%DeviceToReplaceDeviceVariable[<VariableName>].VariableDisplayName%
%DeviceToReplaceDeviceVariable[<VariableName>].Required%
%DeviceToReplaceDeviceVariable[<VariableName>].DefaultValue%
%DeviceToReplaceDeviceVariable[<VariableName>].Value%
%DeviceToReplaceDeviceVariable[<VariableName>]%
%DeviceToReplaceDeviceVariable[<VariableName>].ValidationPattern%
%ExchangeDeviceName%
%ExchangeDeviceMacAddress%
%ExchangeDeviceSMBiosGuid%
%ExchangeDeviceType%
%ExchangeDeviceStagingCollectionID%
%ExchangeDeviceVariable[<VariableName>].DataType%
%ExchangeDeviceVariable[<VariableName>].VariableName%
%ExchangeDeviceVariable[<VariableName>].VariableDisplayName%
%ExchangeDeviceVariable[<VariableName>].Required%
%ExchangeDeviceVariable[<VariableName>].DefaultValue%
%ExchangeDeviceVariable[<VariableName>].Value%
%ExchangeDeviceVariable[<VariableName>]%
%ExchangeDeviceVariable[<VariableName>].ValidationPattern%

DeviceReadyToStage, DeviceStagingStarted, DeviceStaged, StageDeviceFailed

Variable	Description	Example
%StagingState.CollectionID%	Staging CollectionID, which is used for the staging process and is configured in the device type
%StagingState.ErrorMessage%	Error Message
%StagingState.ErrorArgument%	Error Argument Message (Detail Message)
%StagingState.ErrorClass%	Error Class	1=Timeout 2=TaskSequence 4=StageDevcieJob 8=RemoveDeviceFromCollectionJob
%StagingState .WaitingForCollectionMembershipTime%	Timestamp of status change WaitingStageJob -> WaitingForCollectionMembership	yyyy-MM-dd HH:mm:ss.fff
%StagingState.ReadyToStageTime%	Timestamp of status change WaitingForCollectionMembership -> ReadyToStage	yyyy-MM-dd HH:mm:ss.fff
%StagingState.SequenceStartTime%	Timestamp of TaskSequence start	yyyy-MM-dd HH:mm:ss.fff
%StagingState.LatestMessageTime%	Last response from TaskSequnece	yyyy-MM-dd HH:mm:ss.fff
%StagingState.TaskSequenceName%	TaskSequence Name
%StagingState.TaskSequenceID%	TaskSequence ID
%StagingState.ConfirmedManually%	Was the staging state changed manually?	True, False