Share via


SMS_TaskSequence_EnableBitLockerAction Server WMI Class

Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2

The SMS_TaskSequence_EnableBitLockerAction Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents a task sequence action that enables the low-level BitLocker encryption on the specified drive.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.

Class SMS_TaskSequence_EnableBitLockerAction : SMS_TaskSequence_Action
{
      SMS_TaskSequence_Condition Condition;
      Boolean ContinueOnError;
      String CreateRecoveryPassword;
      String Description;
      Boolean Enabled;
      String Mode;
      String Name;
      String StartupKeyDrive;
      String SupportedEnvironment;
      String TargetDrive;
      UInt32 Timeout;
      Boolean WaitForEncryption;
};

Methods

The SMS_TaskSequence_EnableBitLockerAction class does not define any methods.

Properties

  • CreateRecoveryPassword
    Data type: String

    Access type: Read/Write

    Qualifiers: [CommandLineArg(5), Not_Null]

    Value indicating whether a recovery password should be created in Active Directory. Possible values are:

    • None

    • AD (default)

  • Mode
    Data type: String

    Access type: Read/Write

    Qualifiers: [CommandLineArg(3), RequiredIfNull("TargetDrive")]

    Key protector mode. Possible values are:

    • TPM

    • Key

    • TPMAndKey

    The default value is null. This property is required if TargetDrive is set to null.

  • StartupKeyDrive
    Data type: String

    Access type: Read/Write

    Qualifiers: [CommandLineArg(4)]

    Drive letter of removable USB drive on which to store key protectors. This property is ignored unless the Mode property is set to Key or TPMAndKey. Set this property to null (default) to use the first available USB drive.

  • SupportedEnvironment
    Data type: String

    Access type: Read/Write

    Qualifiers: [Not_Null:ToInstance]

    See SMS_TaskSequence_Action Server WMI Class.

    The default value of this property for this task sequence action is FullOS.

  • TargetDrive
    Data type: String

    Access type: Read/Write

    Qualifiers: [CommandLineArg(1)]

    Drive letter of the volume on which to enable the Bitlocker encryption. Set this property to null (default) to use the current operating system volume.

  • WaitForEncryption
    Data type: Boolean

    Access type: Read/Write

    Qualifiers: [CommandLineArg(2), Not_Null]

    true to wait for disk encryption to complete before continuing with the task sequence. Set this property to false (default) to continue the task sequence while encryption proceeds in the background.

Remarks

Class qualifiers for this class include:

[CommandLine("OSDBitLocker.exe /enable <?1: /drive:%1><?2: /wait:%2><?3: /mode:%3><?4: /keydrive:%4><?5: /pwd:%5>"),

ActionCategory{"Disks,4,2"},ActionUI{"AdminUI.TaskSequenceEditor.dll", "Microsoft.ConfigurationManagement.AdminConsole.TaskSequenceEditor", "EnableBitLockerControl", "TaskSequenceOptionControl"},

VariablePrefix("OSDBitLocker")]

For more information about both the class qualifiers and the property qualifiers included in the Properties section, see Configuration Manager Class and Property Qualifiers.

BitLocker requires at least two partitions on the hard drive. The first partition contains the Windows bootstrap code, and the second partition contains the operating system. The bootstrap partition must remain unencrypted.

The variable prefix for this class is "OSDBitLocker".

Requirements

Runtime Requirements

For more information, see Configuration Manager Server Runtime Requirements.

Development Requirements

For more information, see Configuration Manager Server Development Requirements.

See Also

Concepts

Operating System Deployment Server WMI Classes
SMS_TaskSequence_Action Server WMI Class
About Operating System Deployment Task Sequences
Configuration Manager Operating System Deployment
How to Create an Operating System Deployment Task Sequence
How to Add an Operating System Deployment Task Sequence Action