mediaaccess

Documentation

Overview

Package mediaaccess facilitiates communication with Intel® AMT devices to represent the ability to access one or more media and use this media to store and retrieve data.

Index

• Constants
• type Body
• type Capabilities
  • func (e Capabilities) String() string
• type Device
  • func NewMediaAccessDeviceWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Device
  • func (device Device) Enumerate() (response Response, err error)
  • func (device Device) Pull(enumerationContext string) (response Response, err error)
• type EnabledDefault
  • func (e EnabledDefault) String() string
• type EnabledState
  • func (e EnabledState) String() string
• type MediaAccessDevice
• type OperationalStatus
  • func (e OperationalStatus) String() string
• type PullResponse
• type RequestedState
  • func (e RequestedState) String() string
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string
• type Security
  • func (e Security) String() string

Constants

const (
	CIMMediaAccessDevice string = "CIM_MediaAccessDevice"
	ValueNotFound        string = "Value not found in map"
)

Types

type Body

type Body struct {
	XMLName           xml.Name `xml:"Body"`
	PullResponse      PullResponse
	EnumerateResponse common.EnumerateResponse
}

Response Types.

type Capabilities

type Capabilities int

Capabilities is an integer enumeration that indicates the various capabilities of the media access device.

const (
	UnknownCapabilities Capabilities = iota
	OtherCapabilities
	SequentialAccess
	RandomAccess
	SupportsWriting
	Encryption
	Compression
	SupportsRemovableMedia
	ManualCleaning
	AutomaticCleaning
	SmartNotification
	SupportsDualSidedMedia
	PreDismountEjectNotRequired
)

func (Capabilities) String

func (e Capabilities) String() string

String returns a human-readable string representation of the Capabilities enumeration.

type Device

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

func NewMediaAccessDeviceWithClient

func NewMediaAccessDeviceWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Device

NewMediaAccessDevice returns a new instance of the MediaAccessDevice struct.

func (Device) Enumerate

func (device Device) Enumerate() (response Response, err error)

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

func (Device) Pull

func (device Device) 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.

type EnabledDefault

type EnabledDefault int

EnabledDefault is an integer enumeration that indicates the administrator's default or startup configuration for the Enabled State of an element.

const (
	EnabledDefaultEnabled           EnabledDefault = 2
	EnabledDefaultDisabled          EnabledDefault = 3
	EnabledDefaultNotApplicable     EnabledDefault = 5
	EnabledDefaultEnabledButOffline EnabledDefault = 6
	EnabledDefaultNoDefault         EnabledDefault = 7
	EnabledDefaultQuiesce           EnabledDefault = 9
)

func (EnabledDefault) String

func (e EnabledDefault) String() string

String returns a human-readable string representation of the EnabledDefault enumeration.

type EnabledState

type EnabledState int

EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states.

const (
	EnabledStateUnknown EnabledState = iota
	EnabledStateOther
	EnabledStateEnabled
	EnabledStateDisabled
	EnabledStateShuttingDown
	EnabledStateNotApplicable
	EnabledStateEnabledButOffline
	EnabledStateInTest
	EnabledStateDeferred
	EnabledStateQuiesce
	EnabledStateStarting
)

func (EnabledState) String

func (e EnabledState) String() string

String returns a human-readable string representation of the EnabledState enumeration.

type MediaAccessDevice

type MediaAccessDevice struct {
	Capabilities            []Capabilities      `xml:"Capabilities,omitempty"`  // ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12} Values={Unknown, Other, Sequential Access, Random Access, Supports Writing, Encryption, Compression, Supports Removeable Media, Manual Cleaning, Automatic Cleaning, SMART Notification, Supports Dual Sided Media, Predismount Eject Not Required} ArrayType=Indexed
	CreationClassName       string              `xml:"CreationClassName"`       // CreationClassName indicates the name of the class or the subclass used in the creation of an instance.
	DeviceID                string              `xml:"DeviceID"`                // An address or other identifying information to uniquely name the LogicalDevice.
	ElementName             string              `xml:"ElementName"`             // This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
	EnabledDefault          EnabledDefault      `xml:"EnabledDefault"`          // An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element.
	EnabledState            EnabledState        `xml:"EnabledState"`            // EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states.
	MaxMediaSize            uint64              `xml:"MaxMediaSize,omitempty"`  // Maximum size, in KBytes, of media supported by this Device.
	OperationalStatus       []OperationalStatus `xml:"OperationalStatus"`       // Indicates the current statuses of the element.
	RequestedState          RequestedState      `xml:"RequestedState"`          // RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested.
	Security                Security            `xml:"Security,omitempty"`      // ValueMap={1, 2, 3, 4, 5, 6, 7} Values={Other, Unknown, None, Read Only, Locked Out, Boot Bypass, Boot Bypass and Read Only}
	SystemCreationClassName string              `xml:"SystemCreationClassName"` // The scoping System's CreationClassName.
	SystemName              string              `xml:"SystemName"`              // The scoping System's Name.
}

Response Types.

type OperationalStatus

type OperationalStatus int

OperationalStatus is an integer enumeration that indicates the current statuses of the element.

const (
	OperationalStatusUnknown OperationalStatus = iota
	OperationalStatusOther
	OperationalStatusOK
	OperationalStatusDegraded
	OperationalStatusStressed
	OperationalStatusPredictiveFailure
	OperationalStatusError
	OperationalStatusNonRecoverableError
	OperationalStatusStarting
	OperationalStatusStopping
	OperationalStatusStopped
	OperationalStatusInService
	OperationalStatusNoContact
	OperationalStatusLostCommunication
	OperationalStatusAborted
	OperationalStatusDormant
	OperationalStatusSupportingEntityInError
	OperationalStatusCompleted
	OperationalStatusPowerMode
	OperationalStatusRelocating
)

func (OperationalStatus) String

func (e OperationalStatus) String() string

String returns a human-readable string representation of the OperationalStatus enumeration.

type PullResponse

type PullResponse struct {
	XMLName            xml.Name            `xml:"PullResponse"`
	MediaAccessDevices []MediaAccessDevice `xml:"Items>CIM_MediaAccessDevice"`
}

Response Types.

type RequestedState

type RequestedState int

RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested.

const (
	RequestedStateUnknown       RequestedState = 0
	RequestedStateEnabled       RequestedState = 2
	RequestedStateDisabled      RequestedState = 3
	RequestedStateShutDown      RequestedState = 4
	RequestedStateNoChange      RequestedState = 5
	RequestedStateOffline       RequestedState = 6
	RequestedStateTest          RequestedState = 7
	RequestedStateDeferred      RequestedState = 8
	RequestedStateQuiesce       RequestedState = 9
	RequestedStateReboot        RequestedState = 10
	RequestedStateReset         RequestedState = 11
	RequestedStateNotApplicable RequestedState = 12
)

func (RequestedState) String

func (e RequestedState) String() string

String returns a human-readable string representation of the RequestedState enumeration.

type Response

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

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 Security

type Security int

Security is an integer enumeration that indicates the security supported by the media access device.

const (
	Other Security = iota + 1
	Unknown
	None
	ReadOnly
	LockedOut
	BootBypass
	BootBypassAndReadOnly
)

func (Security) String

func (e Security) String() string

String returns a human-readable string representation of the Security enumeration.