boot

package
v2.36.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package boot facilitates communication with Intel® AMT devices to access the boot capabilities and boot setting data.

Capabilities reports what boot options that the Intel® AMT device supports.

SettingData provides configuration-related and operational parameters for the boot service in the Intel® AMT device. In order to activate these settings use pkg/github.com/device-management-toolkit/go-wsman-messages/v2/pkg/wsman/cim/power RequestPowerStateChange(). Notice that you can't set certain values while others are enabled (for example: You can't set UseIDER or UseSOL if a CIM_BootSourceSetting is chosen).

Index

Constants

View Source 
const (
	AMTBootSettingData  string = "AMT_BootSettingData"
	AMTBootCapabilities string = "AMT_BootCapabilities"
	ValueNotFound       string = "Value not found in map"
)

INPUTS Constants.

Variables

View Source 
var MaxSizes = map[ParameterType]int{
	OCR_EFI_NETWORK_DEVICE_PATH:         300,
	OCR_EFI_FILE_DEVICE_PATH:            300,
	OCR_EFI_DEVICE_PATH_LEN:             2,
	OCR_BOOT_IMAGE_HASH_SHA256:          32,
	OCR_BOOT_IMAGE_HASH_SHA384:          48,
	OCR_BOOT_IMAGE_HASH_SHA512:          64,
	OCR_EFI_BOOT_OPTIONAL_DATA:          50,
	OCR_HTTPS_CERT_SYNC_ROOT_CA:         1,
	OCR_HTTPS_CERT_SERVER_NAME:          256,
	OCR_HTTPS_SERVER_NAME_VERIFY_METHOD: 2,
	OCR_HTTPS_SERVER_CERT_HASH_SHA256:   32,
	OCR_HTTPS_SERVER_CERT_HASH_SHA384:   48,
	OCR_HTTPS_SERVER_CERT_HASH_SHA512:   64,
	OCR_HTTPS_REQUEST_TIMEOUT:           2,
	OCR_HTTPS_USER_NAME:                 16,
	OCR_HTTPS_PASSWORD:                  16,
}

Parameter max sizes (in bytes).

View Source 
var ParameterDetails = map[ParameterType]struct {
	Mandatory bool
	DependsOn ParameterType
	Comment   string
}{
	OCR_EFI_NETWORK_DEVICE_PATH: {
		Mandatory: true,
		Comment:   "Mandatory for boot to HTTPS",
	},
	OCR_EFI_FILE_DEVICE_PATH: {
		Mandatory: false,
		Comment:   "Used when console specifies device path not registered by BIOS",
	},
	OCR_EFI_DEVICE_PATH_LEN: {
		Mandatory: false,
		DependsOn: OCR_EFI_FILE_DEVICE_PATH,
		Comment:   "Mandatory when OCR_EFI_FILE_DEVICE_PATH is provided",
	},
	OCR_BOOT_IMAGE_HASH_SHA256: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot. Mandatory when image not signed and secure boot can't be disabled",
	},
	OCR_BOOT_IMAGE_HASH_SHA384: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot. Mandatory when image not signed and secure boot can't be disabled",
	},
	OCR_BOOT_IMAGE_HASH_SHA512: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot. Mandatory when image not signed and secure boot can't be disabled",
	},
	OCR_EFI_BOOT_OPTIONAL_DATA: {
		Mandatory: false,
		Comment:   "Optional binary data for loaded image",
	},
	OCR_HTTPS_CERT_SYNC_ROOT_CA: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot. Required if BIOS doesn't have root CA",
	},
	OCR_HTTPS_CERT_SERVER_NAME: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot",
	},
	OCR_HTTPS_SERVER_NAME_VERIFY_METHOD: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot",
	},
	OCR_HTTPS_SERVER_CERT_HASH_SHA256: {
		Mandatory: false,
		Comment:   "Can be provided instead of or with Root CA, server name and verify method",
	},
	OCR_HTTPS_SERVER_CERT_HASH_SHA384: {
		Mandatory: false,
		Comment:   "Can be provided instead of or with Root CA, server name and verify method",
	},
	OCR_HTTPS_SERVER_CERT_HASH_SHA512: {
		Mandatory: false,
		Comment:   "Can be provided instead of or with Root CA, server name and verify method",
	},
	OCR_HTTPS_REQUEST_TIMEOUT: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot",
	},
	OCR_HTTPS_USER_NAME: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot",
	},
	OCR_HTTPS_PASSWORD: {
		Mandatory: false,
		Comment:   "Optional for HTTPS boot",
	},
}

Parameter details for validation rules.

View Source 
var ParameterNames = map[ParameterType]string{
	OCR_EFI_NETWORK_DEVICE_PATH:         "URI to HTTPS Server",
	OCR_EFI_FILE_DEVICE_PATH:            "Device path to PBA.efi",
	OCR_EFI_DEVICE_PATH_LEN:             "Device path length",
	OCR_BOOT_IMAGE_HASH_SHA256:          "SHA256 hash of boot loader",
	OCR_BOOT_IMAGE_HASH_SHA384:          "SHA384 hash of boot loader",
	OCR_BOOT_IMAGE_HASH_SHA512:          "SHA512 hash of boot loader",
	OCR_EFI_BOOT_OPTIONAL_DATA:          "Optional binary data",
	OCR_HTTPS_CERT_SYNC_ROOT_CA:         "Sync Root CAs with Intel AMT",
	OCR_HTTPS_CERT_SERVER_NAME:          "HTTPS server certificate name",
	OCR_HTTPS_SERVER_NAME_VERIFY_METHOD: "Server name verification method",
	OCR_HTTPS_SERVER_CERT_HASH_SHA256:   "SHA256 hash of server certificate",
	OCR_HTTPS_SERVER_CERT_HASH_SHA384:   "SHA384 hash of server certificate",
	OCR_HTTPS_SERVER_CERT_HASH_SHA512:   "SHA512 hash of server certificate",
	OCR_HTTPS_REQUEST_TIMEOUT:           "HTTP Request timeout",
	OCR_HTTPS_USER_NAME:                 "HTTPS Username",
	OCR_HTTPS_PASSWORD:                  "HTTPS Password",
}

Parameter names for friendly error messages.

Functions

func CreateTLVBuffer 

func CreateTLVBuffer(parameters []TLVParameter) ([]byte, error)

CreateTLVBuffer creates a TLV buffer from parameters.

func GetStringValue 

func GetStringValue(param TLVParameter) string

GetStringValue retrieves a string from a parameter value (UTF-8).

func GetUint16Value 

func GetUint16Value(param TLVParameter) (uint16, error)

GetUint16Value retrieves a uint16 from a parameter value (little-endian).

func ValidateParameters 

func ValidateParameters(parameters []TLVParameter) (bool, []string)

ValidateParameters validates a set of parameters without creating a buffer.

func ValidateTLVEntry 

func ValidateTLVEntry(paramType ParameterType, length byte, value []byte) error

ValidateTLVEntry validates a single TLV entry.

Types

type Body 

type Body struct {
	XMLName                     xml.Name `xml:"Body"`
	BootSettingDataGetResponse  BootSettingDataResponse
	BootCapabilitiesGetResponse BootCapabilitiesResponse
	EnumerateResponse           common.EnumerateResponse
	PullResponse                PullResponse
}

OUTPUTS Response Types.

type BootCapabilitiesResponse 

type BootCapabilitiesResponse struct {
	XMLName                            xml.Name `xml:"AMT_BootCapabilities"`
	InstanceID                         string   `xml:"InstanceID,omitempty"`                         // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace. For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.
	ElementName                        string   `xml:"ElementName,omitempty"`                        // The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)
	IDER                               bool     `xml:"IDER,omitempty"`                               // Indicates whether Intel® AMT device supports 'IDE Redirection'
	SOL                                bool     `xml:"SOL,omitempty"`                                // Indicates whether Intel® AMT device supports 'Serial Over Lan'
	BIOSReflash                        bool     `xml:"BIOSReflash,omitempty"`                        // Indicates whether Intel® AMT device supports 'BIOS Reflash'
	BIOSSetup                          bool     `xml:"BIOSSetup,omitempty"`                          // Indicates whether Intel® AMT device supports 'BIOS Setup'
	BIOSPause                          bool     `xml:"BIOSPause,omitempty"`                          // Indicates whether Intel® AMT device supports 'BIOS Pause'
	ForcePXEBoot                       bool     `xml:"ForcePXEBoot,omitempty"`                       // Indicates whether Intel® AMT device supports 'Force PXE Boot'
	ForceHardDriveBoot                 bool     `xml:"ForceHardDriveBoot,omitempty"`                 // Indicates whether Intel® AMT device supports 'Force Hard Drive Boot'
	ForceHardDriveSafeModeBoot         bool     `xml:"ForceHardDriveSafeModeBoot,omitempty"`         // Indicates whether Intel® AMT device supports 'Force Hard Drive Safe Mode Boot'
	ForceDiagnosticBoot                bool     `xml:"ForceDiagnosticBoot,omitempty"`                // Indicates whether Intel® AMT device supports 'Force Diagnostic Boot'
	ForceCDorDVDBoot                   bool     `xml:"ForceCDorDVDBoot,omitempty"`                   // Indicates whether Intel® AMT device supports 'Force CD or DVD Boot'
	VerbosityScreenBlank               bool     `xml:"VerbosityScreenBlank,omitempty"`               // Indicates whether Intel® AMT device supports 'Verbosity Screen Blank'
	PowerButtonLock                    bool     `xml:"PowerButtonLock,omitempty"`                    // Indicates whether Intel® AMT device supports 'Power Button Lock'
	ResetButtonLock                    bool     `xml:"ResetButtonLock,omitempty"`                    // Indicates whether Intel® AMT device supports 'Reset Button Lock'
	KeyboardLock                       bool     `xml:"KeyboardLock,omitempty"`                       // Indicates whether Intel® AMT device supports 'Keyboard Lock'
	SleepButtonLock                    bool     `xml:"SleepButtonLock,omitempty"`                    // Indicates whether Intel® AMT device supports 'Sleep Button Lock'
	UserPasswordBypass                 bool     `xml:"UserPasswordBypass,omitempty"`                 // Indicates whether Intel® AMT device supports 'User Password Bypass'
	ForcedProgressEvents               bool     `xml:"ForcedProgressEvents,omitempty"`               // Indicates whether Intel® AMT device supports 'Forced Progress Events'
	VerbosityVerbose                   bool     `xml:"VerbosityVerbose,omitempty"`                   // Indicates whether Intel® AMT device supports 'Verbosity/Verbose'
	VerbosityQuiet                     bool     `xml:"VerbosityQuiet,omitempty"`                     // Indicates whether Intel® AMT device supports 'Verbosity/Quiet'
	ConfigurationDataReset             bool     `xml:"ConfigurationDataReset,omitempty"`             // Indicates whether Intel® AMT device supports 'Configuration Data Reset'
	BIOSSecureBoot                     bool     `xml:"BIOSSecureBoot,omitempty"`                     // Indicates whether Intel® AMT device supports 'BIOS Secure Boot'
	SecureErase                        bool     `xml:"SecureErase,omitempty"`                        // Indicates whether Intel® AMT device supports 'Secure Erase'
	ForceWinREBoot                     bool     `xml:"ForceWinREBoot,omitempty"`                     // Supports Intel AMT invoking boot to WinRE
	ForceUEFILocalPBABoot              bool     `xml:"ForceUEFIPBABoot,omitempty"`                   // Supports booting to an ISV’s PBA
	ForceUEFIHTTPSBoot                 bool     `xml:"ForceUEFIHTTPSBoot,omitempty"`                 // Supports Intel AMT invoking HTTPS boot
	AMTSecureBootControl               bool     `xml:"AMTSecureBootControl,omitempty"`               // Determines whether Intel AMT is privileged by BIOS to disable secure boot for an AMT triggered boot option. If true, the BIOS allows Intel AMT to control the secure boot (i.e., to disable secure boot in recovery from HTTPS under certain conditions).
	UEFIWiFiCoExistenceAndProfileShare bool     `xml:"UEFIWiFiCoExistenceAndProfileShare,omitempty"` // Read-only field, determines whether UEFI BIOS and Intel AMT WiFi profile share is supported. The feature is available from Intel® CSME 16.0.
	PlatformErase                      int      `xml:"PlatformErase,omitempty"`                      // Indicates whether the Intel AMT device supports Intel Remote Platform Erase (i.e., whether the OEM's BIOS includes support for the feature), and shows the devices that can be erased. The feature is available from Intel® CSME 16.0.
}

OUTPUTS Response Types.

type BootSettingDataRequest 

type BootSettingDataRequest struct {
	XMLName                  xml.Name          `xml:"h:AMT_BootSettingData"`
	H                        string            `xml:"xmlns:h,attr"`
	BIOSLastStatus           []uint16          `xml:"h:BIOSLastStatus,omitempty"` // Last boot status reported by BIOS. The first 16-bit word contains the general BIOS status (0 - Success, 1 - In Progress, 2 - Not Updated, 0xFFFF - Failed). The second word contains the detailed error status (0 - Success/In Progress, 1 - General Drive Failure, 2 - Drive Password/Authentication Failure, 3 - Feature is not supported). This property is read-only.
	BIOSPause                bool              `xml:"h:BIOSPause"`                // Required. When True, the BIOS pauses for user input on the next boot cycle. This property can be set to true only when a boot source isn't set (using CIM_BootConfigSetting.ChangeBootOrder method).
	BIOSSetup                bool              `xml:"h:BIOSSetup"`                // Required. When True, the Intel® AMT firmware enters the CMOS Setup screen on the next boot cycle. This property can be set to true only when a boot source isn't set (using CIM_BootConfigSetting.ChangeBootOrder method).
	BootMediaIndex           int               `xml:"h:BootMediaIndex"`           // Required. This property identifies the boot-media index for the managed client (when a boot source is set using the CIM_BootConfigSetting.ChangeBootOrder method). For Hard-Drive or CD/DVD boot - when the parameter value is 0, the default boot-media is booted. When the parameter value is 1, the primary boot-media is booted; when the value is 2, the secondary boot-media is booted; and so on. For PXE or diagnostics boot this property must be 0.
	BootguardStatus          int               `xml:"h:BootguardStatus"`          // Enables the console to discover the security level of the BIOS boot flow. This property is read only.
	ConfigurationDataReset   bool              `xml:"h:ConfigurationDataReset"`   // Required. When True, the Intel® AMT firmware resets its non-volatile configuration data to the managed system's Setup defaults prior to booting the system.
	ElementName              string            `xml:"h:ElementName"`              // Required. The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
	EnforceSecureBoot        bool              `xml:"h:EnforceSecureBoot"`        // When True, Secure boot over IDER is enforced on the next boot cycle, if IDER boot is used. This field is also used in One-Click Recovery.
	FirmwareVerbosity        FirmwareVerbosity `xml:"h:FirmwareVerbosity"`        // Required. When set to a non-zero value, controls the amount of information the managed system writes to its local display.
	ForcedProgressEvents     bool              `xml:"h:ForcedProgressEvents"`     // Required. When True, the Intel® AMT firmware transmits all progress PET events to the alert-sending device.
	IDERBootDevice           IDERBootDevice    `xml:"h:IDERBootDevice"`           // Required. Specifies the device to use when UseIder is set. 0 - Floppy Boot, 1- CD Boot.
	InstanceID               string            `xml:"h:InstanceID"`               // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.  <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.
	LockKeyboard             bool              `xml:"h:LockKeyboard"`             // Required. When True, the Intel® AMT firmware disallows keyboard activity during its boot process.
	LockPowerButton          bool              `xml:"h:LockPowerButton"`          // Required. When True, the Intel® AMT firmware disables the power button operation for the system, normally until the next boot cycle.
	LockResetButton          bool              `xml:"h:LockResetButton"`          // Required. When True, the Intel® AMT firmware disables the reset button operation for the system, normally until the next boot cycle.
	LockSleepButton          bool              `xml:"h:LockSleepButton"`          // Required. When True, the Intel® AMT firmware disables the sleep button operation for the system, normally until the next boot cycle.
	OptionsCleared           bool              `xml:"h:OptionsCleared"`           // Indicates whether the boot options have been cleared by BIOS or not. This property is read only.
	OwningEntity             string            `xml:"h:OwningEntity"`             // OwningEntity identifies the vendor or organization that defines the contained boot settings.
	PlatformErase            bool              `xml:"h:PlatformErase"`            // When set to True, sets the boot option to trigger Secure Remote Platform Erase in the next boot.  Note: This command needs to execute over TLS.
	RSEPassword              string            `xml:"h:RSEPassword"`              // SSD password for Remote Secure Erase operation. This is a write-only field, an empty string is returned when instance is read. When writing, an empty string or lack of field will be ignored. The password length is limited to 32 ASCII characters. Note: Customers are recommended to use Secure Remote Platform Erase which is newer and more advanced than Remote Secure Erase.
	ReflashBIOS              bool              `xml:"h:ReflashBIOS"`              // Required. When True, the Intel® AMT firmware reflashes the BIOS on the next boot cycle. This property can be set to true only when a boot source isn't set (using CIM_BootConfigSetting.ChangeBootOrder method).
	SecureBootControlEnabled bool              `xml:"h:SecureBootControlEnabled"` // Determines whether Intel AMT is privileged by BIOS to disable secure boot for an AMT triggered boot option. If not, BIOSSecureBoot must be set to TRUE. This property is read only.
	SecureErase              bool              `xml:"h:SecureErase"`              // Required. When True, the BIOS performs secure erase operation. Note: Customers are recommended to use Secure Remote Platform Erase which is newer and more advanced than this function.
	UEFIHTTPSBootEnabled     bool              `xml:"h:UEFIHTTPSBootEnabled"`     // Indicates whether ForceUEFIHTTPSBoot is enabled in BIOS. This property is read only.
	UefiBootParametersArray  string            `xml:"h:UefiBootParametersArray"`  // TLV parameters array encoded with base64 for configuring boot parameters for One-Click Recovery and Secure Remote Platform Erase.
	UEFILocalPBABootEnabled  bool              `xml:"h:UEFILocalPBABootEnabled"`  // Indicates whether ForceUEFILocalPBABoot is enabled in BIOS. This property is read only.
	UefiBootNumberOfParams   int               `xml:"h:UefiBootNumberOfParams"`   // Number of parameters in UefiBootParametersArray
	UseIDER                  bool              `xml:"h:UseIDER"`                  // Required. When True, IDER is used on the next boot cycle.
	UseSOL                   bool              `xml:"h:UseSOL"`                   // Required. When True, Serial over LAN is used on the next boot cycle.
	UseSafeMode              bool              `xml:"h:UseSafeMode"`              // Required. When a Hard-drive boot source is chosen (using CIM_BootConfigSetting) and this property is set to True, the Intel® AMT firmware will boot in safe mode.
	UserPasswordBypass       bool              `xml:"h:UserPasswordBypass"`       // Required. When True, the Intel® AMT firmware boots the system and bypasses any user or boot password that might be set in the system.
	WinREBootEnabled         bool              `xml:"h:WinREBootEnabled"`         // Indicates whether ForceWinREBoot is enabled in BIOS. This property is read only.	}
}

INPUTS Request Types.

type BootSettingDataResponse 

type BootSettingDataResponse struct {
	XMLName                  xml.Name          `xml:"AMT_BootSettingData"`
	BIOSLastStatus           []uint16          `xml:"BIOSLastStatus,omitempty"`           // Last boot status reported by BIOS. The first 16-bit word contains the general BIOS status (0 - Success, 1 - In Progress, 2 - Not Updated, 0xFFFF - Failed). The second word contains the detailed error status (0 - Success/In Progress, 1 - General Drive Failure, 2 - Drive Password/Authentication Failure, 3 - Feature is not supported). This property is read-only.
	BIOSPause                bool              `xml:"BIOSPause,omitempty"`                // When True, the BIOS pauses for user input on the next boot cycle. This property can be set to true only when a boot source isn't set (using CIM_BootConfigSetting.ChangeBootOrder method).
	BIOSSetup                bool              `xml:"BIOSSetup,omitempty"`                // When True, the Intel® AMT firmware enters the CMOS Setup screen on the next boot cycle. This property can be set to true only when a boot source isn't set (using CIM_BootConfigSetting.ChangeBootOrder method).
	BootMediaIndex           int               `xml:"BootMediaIndex,omitempty"`           // This property identifies the boot-media index for the managed client (when a boot source is set using the CIM_BootConfigSetting.ChangeBootOrder method). For Hard-Drive or CD/DVD boot - when the parameter value is 0, the default boot-media is booted. When the parameter value is 1, the primary boot-media is booted; when the value is 2, the secondary boot-media is booted; and so on. For PXE or diagnostics boot this property must be 0.
	BootguardStatus          int               `xml:"BootguardStatus,omitempty"`          // Enables the console to discover the security level of the BIOS boot flow. This property is read only.
	ConfigurationDataReset   bool              `xml:"ConfigurationDataReset,omitempty"`   // When True, the Intel® AMT firmware resets its non-volatile configuration data to the managed system's Setup defaults prior to booting the system.
	ElementName              string            `xml:"ElementName,omitempty"`              // The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
	EnforceSecureBoot        bool              `xml:"EnforceSecureBoot,omitempty"`        // When True, Secure boot over IDER is enforced on the next boot cycle, if IDER boot is used. This field is also used in One-Click Recovery.
	FirmwareVerbosity        FirmwareVerbosity `xml:"FirmwareVerbosity,omitempty"`        // When set to a non-zero value, controls the amount of information the managed system writes to its local display.
	ForcedProgressEvents     bool              `xml:"ForcedProgressEvents,omitempty"`     // When True, the Intel® AMT firmware transmits all progress PET events to the alert-sending device.
	IDERBootDevice           IDERBootDevice    `xml:"IDERBootDevice,omitempty"`           // Specifies the device to use when UseIder is set. 0 - Floppy Boot, 1- CD Boot.
	InstanceID               string            `xml:"InstanceID,omitempty"`               // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.
	LockKeyboard             bool              `xml:"LockKeyboard,omitempty"`             // When True, the Intel® AMT firmware disallows keyboard activity during its boot process.
	LockPowerButton          bool              `xml:"LockPowerButton,omitempty"`          // When True, the Intel® AMT firmware disables the power button operation for the system, normally until the next boot cycle.
	LockResetButton          bool              `xml:"LockResetButton,omitempty"`          // When True, the Intel® AMT firmware disables the reset button operation for the system, normally until the next boot cycle.
	LockSleepButton          bool              `xml:"LockSleepButton,omitempty"`          // When True, the Intel® AMT firmware disables the sleep button operation for the system, normally until the next boot cycle.
	OptionsCleared           bool              `xml:"OptionsCleared,omitempty"`           // Indicates whether the boot options have been cleared by BIOS or not. This property is read only.
	OwningEntity             string            `xml:"OwningEntity,omitempty"`             // OwningEntity identifies the vendor or organization that defines the contained boot settings.
	PlatformErase            bool              `xml:"PlatformErase,omitempty"`            // When set to True, sets the boot option to trigger Secure Remote Platform Erase in the next boot.  Note: This command needs to execute over TLS.
	RPEEnabled               bool              `xml:"RPEEnabled,omitempty"`               // Indicates whether Secure Remote Platform Erase is enabled by the BIOS. Note: This command needs to execute over TLS.
	RSEPassword              string            `xml:"RSEPassword,omitempty"`              // SSD password for Remote Secure Erase operation. This is a write-only field, an empty string is returned when instance is read. When writing, an empty string or lack of field will be ignored. The password length is limited to 32 ASCII characters.
	ReflashBIOS              bool              `xml:"ReflashBIOS,omitempty"`              // When True, the Intel® AMT firmware reflashes the BIOS on the next boot cycle. This property can be set to true only when a boot source isn't set (using CIM_BootConfigSetting.ChangeBootOrder method).
	SecureBootControlEnabled bool              `xml:"SecureBootControlEnabled,omitempty"` // Determines whether Intel AMT is privileged by BIOS to disable secure boot for an AMT triggered boot option. If not, BIOSSecureBoot must be set to TRUE. This property is read only.
	SecureErase              bool              `xml:"SecureErase,omitempty"`              // When True, the BIOS performs secure erase operation. Note: Customers are recommended to use Secure Remote Platform Erase which is newer and more advanced than this function.
	UEFIHTTPSBootEnabled     bool              `xml:"UEFIHTTPSBootEnabled,omitempty"`     // Indicates whether ForceUEFIHTTPSBoot is enabled in BIOS. This property is read only.
	UEFIBootParametersArray  []uint8           `xml:"UEFIBootParametersArray,omitempty"`  // TLV parameters array encoded with base64 for configuring boot parameters for One-Click Recovery and Secure Remote Platform Erase.
	UEFILocalPBABootEnabled  bool              `xml:"UEFILocalPBABootEnabled,omitempty"`  // Indicates whether ForceUEFILocalPBABoot is enabled in BIOS. This property is read only.
	UefiBootNumberOfParams   int               `xml:"UefiBootNumberOfParams,omitempty"`   // Number of parameters in UefiBootParametersArray
	UseIDER                  bool              `xml:"UseIDER,omitempty"`                  // When True, IDER is used on the next boot cycle.
	UseSOL                   bool              `xml:"UseSOL,omitempty"`                   // When True, Serial over LAN is used on the next boot cycle.
	UseSafeMode              bool              `xml:"UseSafeMode,omitempty"`              // When a Hard-drive boot source is chosen (using CIM_BootConfigSetting) and this property is set to True, the Intel® AMT firmware will boot in safe mode.
	UserPasswordBypass       bool              `xml:"UserPasswordBypass,omitempty"`       // When True, the Intel® AMT firmware boots the system and bypasses any user or boot password that might be set in the system.
	WinREBootEnabled         bool              `xml:"WinREBootEnabled,omitempty"`         // Indicates whether ForceWinREBoot is enabled in BIOS. This property is read only.
}

OUTPUTS Response Types.

type Capabilities 

type Capabilities struct {
	base.WSManService[Response]
}

func NewBootCapabilitiesWithClient 

func NewBootCapabilitiesWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Capabilities

NewBootCapabilitiesWithClient instantiates a new Boot Capabilities service.

type FirmwareVerbosity 

type FirmwareVerbosity int

When set to a non-zero value, controls the amount of information the managed system writes to its local display.

ValueMap={0, 1, 2, 3}

Values={System default, Quiet - minimal screen activity, Verbose - all messages appear on the screen, Screen blank - no messages appear on the screen}. 

const (
	SystemDefault FirmwareVerbosity = iota
	QuietMinimal
	VerboseAll
	ScreenBlank
)

func (FirmwareVerbosity) String 

func (f FirmwareVerbosity) String() string

String returns the string representation of the FirmwareVerbosity value.

type IDERBootDevice 

type IDERBootDevice int

Specifies the device to use when UseIder is set. 0 - Floppy Boot, 1- CD Boot.

ValueMap={0, 1}

Values={Floppy Boot, CD Boot}. 

const (
	FloppyBoot IDERBootDevice = iota
	CDBoot
)

func (IDERBootDevice) String 

func (i IDERBootDevice) String() string

String returns the string representation of the IDERBootDevice value.

type ParameterType 

type ParameterType byte
const (
	OCR_EFI_NETWORK_DEVICE_PATH         ParameterType = 1
	OCR_EFI_FILE_DEVICE_PATH            ParameterType = 2
	OCR_EFI_DEVICE_PATH_LEN             ParameterType = 3
	OCR_BOOT_IMAGE_HASH_SHA256          ParameterType = 4
	OCR_BOOT_IMAGE_HASH_SHA384          ParameterType = 5
	OCR_BOOT_IMAGE_HASH_SHA512          ParameterType = 6
	OCR_EFI_BOOT_OPTIONAL_DATA          ParameterType = 10
	OCR_HTTPS_CERT_SYNC_ROOT_CA         ParameterType = 20
	OCR_HTTPS_CERT_SERVER_NAME          ParameterType = 21
	OCR_HTTPS_SERVER_NAME_VERIFY_METHOD ParameterType = 22
	OCR_HTTPS_SERVER_CERT_HASH_SHA256   ParameterType = 23
	OCR_HTTPS_SERVER_CERT_HASH_SHA384   ParameterType = 24
	OCR_HTTPS_SERVER_CERT_HASH_SHA512   ParameterType = 25
	OCR_HTTPS_REQUEST_TIMEOUT           ParameterType = 30
	OCR_HTTPS_USER_NAME                 ParameterType = 40
	OCR_HTTPS_PASSWORD                  ParameterType = 41
)

UEFI Boot Parameter Types.

type PullResponse 

type PullResponse struct {
	XMLName               xml.Name                   `xml:"PullResponse"`
	BootSettingDataItems  []BootSettingDataResponse  `xml:"Items>AMT_BootSettingData"`
	BootCapabilitiesItems []BootCapabilitiesResponse `xml:"Items>AMT_BootCapabilities"`
}

OUTPUTS Response Types.

type Response 

type Response struct {
	*client.Message
	XMLName xml.Name       `xml:"Envelope"`
	Header  message.Header `xml:"Header"`
	Body    Body           `xml:"Body"`
}

OUTPUTS Response Types.

func (*Response) JSON 

func (r *Response) JSON() string

JSON marshals the type into JSON format.

func (*Response) YAML 

func (r *Response) YAML() string

YAML marshals the type into YAML format.

type SettingData 

type SettingData struct {
	// contains filtered or unexported fields
}

func NewBootSettingDataWithClient 

func NewBootSettingDataWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) SettingData

Instantiates a new Boot Setting Data service.

func (SettingData) Enumerate 

func (settingData SettingData) Enumerate() (response Response, err error)

Enumerate returns an enumeration context which is used in a subsequent Pull call.

func (SettingData) Get 

func (settingData SettingData) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (SettingData) Pull 

func (settingData SettingData) Pull(enumerationContext string) (response Response, err error)

Pull returns the instances of this class. An enumeration context provided by the Enumerate call is used as input.

func (SettingData) Put 

func (settingData SettingData) Put(bootSettingData BootSettingDataRequest) (response Response, err error)

type TLVParameter 

type TLVParameter struct {
	Type   ParameterType
	Length byte
	Value  []byte
	Valid  bool
}

TLVParameter represents a single TLV entry.

func NewBoolParameter 

func NewBoolParameter(paramType ParameterType, value bool) TLVParameter

NewBoolParameter creates a new parameter with a boolean value.

func NewStringParameter 

func NewStringParameter(paramType ParameterType, value string) (TLVParameter, error)

NewStringParameter creates a new parameter with a string value.

func NewUint16Parameter 

func NewUint16Parameter(paramType ParameterType, value uint16) TLVParameter

NewUint16Parameter creates a new parameter with a uint16 value.

type ValidationResult 

type ValidationResult struct {
	Valid      bool
	Parameters []TLVParameter
	Errors     []string
}

ValidationResult contains the results of TLV validation.

func ParseTLVBuffer 

func ParseTLVBuffer(buffer []byte) ValidationResult

ParseTLVBuffer parses and validates a TLV buffer.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.