AMTOperateForMachines Method in Class SMS_Collection

 

Updated: November 1, 2013

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

The AMTOperateForMachines Windows Management Instrumentation (WMI) class method, in System Center 2012 R2 Configuration Manager, executes an Intel Active Management (AMT) operation on a set of computers.

The following syntax is simplified from Managed Object Format (MOF) code and defines the method.

SInt32 AMTOperateForMachines(    
     UInt32 CollectionID,
     UInt32 ResourceIDs[],
     UInt32 Opcode,
     UInt32 extData
);

 CollectionID

Data type: String

Qualifiers: [in]

Unique auto-generated ID containing eight characters. The default value is "".

The format of the collection ID is the site code that created the collection followed by a five-digit hexadecimal serial number, for example, "JAX0002C". The default Configuration Manager collections, created during the installation, use the "SMS" prefix, for example, "SMS00001".

 ResourceIDs[]

Data type: UInt32

Qualifiers: [in]

Array of SMS_R_System.ResourceID values. The items in the array represent the computers that the AMT operation is executed on.

 Opcode

Data type: UInt32

Qualifiers: [in]

The AMT operation to execute. The following table provides the list of supported actions:

Value

Description

1

WakeUp: Brings a sleeping computer back into the powered-on state.

2

Restart: Causes a hard reset of the computer, and the computer is then powered on. This does not shut the operating system down.

3

Shutdown: Causes a hard reset of the computer. This does not shut the operating system down.

8

DiscoveryBMC: Detects the AMT capability from an Out of Band service point. This populates the AMTStatus and AMTFullVersion properties of the corresponding SMS_R_System record.

16

ReinventoryBMC: Currently unimplemented.

32

PartialUnprovision: Resets the AMT device for the computer to the factory default settings, except for the following types of properties:

  • Keys, passwords, and user names

  • The current host name

  • Provisioning server IP and port, FQDN, and DNS suffix

  • Domain name

  • Customized hashes

64

FullUnprovision: Resets the AMT device of the computer to the factory default settings.

128

Provision: Currently unimplemented.

256

ReProvision: Provision the computer for AMT operation. If the current System Center 2012 R2 Configuration Manager infrastructure is configured correctly, this happens automatically. See How to Provision Computers for AMT for more details.

544

FullUnprovisionSuppressAuto: The same as 64 FullUnprovision, except this also sets the SuppressAutoProvision flag, which prevents automatic provisioning from taking place when the computer is in an SMS_Collection with the Enable Auto Provision setting set to true.

576

PartialUnprovisionSuppressAuto: The same as 32 PartialUnprovision, except this will also set the SuppressAutoProvision flag which, prevents any automatic provisioning from taking place when the computer is in an SMS_Collection with the Enable Auto Provision setting set to true.

1024

ClearSuppressAutoProvision:

2048

EnableAudit: Enable audit logging.

4096

DisableAudit: Disable audit logging.

8192

ClearAuditLog: Clear audit log entries.

 extData

Data type: UInt32

Qualifiers: [in]

Use 0 for this value.

An SInt32 data type that is 0 to indicate success or non-zero to indicate failure.

For more information about handling returned errors, see About Configuration Manager Errors.

Show: