userinitiatedconnection

Documentation

Overview

Package userinitiatedconnection facilitiates communication with Intel® AMT devices to access and change the state of the user initiated connection feature of AMT.

Index

• Constants
• type Body
• type EnabledState
  • func (e EnabledState) String() string
• type PullResponse
• type RequestStateChange_OUTPUT
• type RequestedState
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string
• type ReturnValue
  • func (r ReturnValue) String() string
• type Service
  • func NewUserInitiatedConnectionServiceWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Service
  • func (service Service) Enumerate() (response Response, err error)
  • func (service Service) Get() (response Response, err error)
  • func (service Service) Pull(enumerationContext string) (response Response, err error)
  • func (service Service) RequestStateChange(requestedState RequestedState) (response Response, err error)
• type UserResponse

Constants

const (
	AMTUserInitiatedConnectionService string = "AMT_UserInitiatedConnectionService"
	ValueNotFound                     string = "Value not found in map"
)

Types

type Body

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

OUTPUTS Response Types.

type EnabledState

type EnabledState int

EnabledState is an integer enumeration that indicates the enabled and disabled states of an element.

const (
	EnabledStateUnknown                    EnabledState = 0
	EnabledStateOther                      EnabledState = 1
	EnabledStateEnabled                    EnabledState = 2
	EnabledStateDisabled                   EnabledState = 3
	EnabledStateShuttingDown               EnabledState = 4
	EnabledStateNotApplicable              EnabledState = 5
	EnabledStateEnabledButOffline          EnabledState = 6
	EnabledStateInTest                     EnabledState = 7
	EnabledStateDeferred                   EnabledState = 8
	EnabledStateQuiesce                    EnabledState = 9
	EnabledStateStarting                   EnabledState = 10
	EnabledStateAllInterfacesDisabled      EnabledState = 32768
	EnabledStateBIOSInterfaceEnabled       EnabledState = 32769
	EnabledStateOSInterfaceEnabled         EnabledState = 32770
	EnabledStateBIOSAndOSInterfacesEnabled EnabledState = 32771
)

func (EnabledState) String

func (e EnabledState) String() string

String returns the string representation of the EnabledState value.

type PullResponse

type PullResponse struct {
	XMLName   xml.Name       `xml:"PullResponse"`
	UserItems []UserResponse `xml:"Items>AMT_UserInitiatedConnectionService"`
}

OUTPUTS Response Types.

type RequestStateChange_OUTPUT

type RequestStateChange_OUTPUT struct {
	XMLName     xml.Name    `xml:"RequestStateChange_OUTPUT"`
	ReturnValue ReturnValue `xml:"ReturnValue"`
}

OUTPUTS Response Types.

type RequestedState

type RequestedState int

The state requested for the element. The valid input values for userinitiatedconnection request state change are: 32768, 32769, 32770, 32771.

ValueMap={32768, 32769, 32770, 32771}

Values={All Interfaces disabled, BIOS Interface enabled, OS Interface enabled, BIOS and OS Interfaces enabled}.

const (
	AllInterfacesDisabled      RequestedState = 32768
	BIOSInterfaceEnabled       RequestedState = 32769
	OSInterfaceEnabled         RequestedState = 32770
	BIOSandOSInterfacesEnabled RequestedState = 32771
)

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 ReturnValue

type ReturnValue int

ReturnValue is a 32-bit unsigned integer indicating the success or failure of the operation.

const (
	ReturnValueCompletedWithNoError              ReturnValue = 0
	ReturnValueNotSupported                      ReturnValue = 1
	ReturnValueUnknownOrUnspecified              ReturnValue = 2
	ReturnValueCannotCompleteWithinTimeout       ReturnValue = 3
	ReturnValueFailed                            ReturnValue = 4
	ReturnValueInvalidParameter                  ReturnValue = 5
	ReturnValueInUse                             ReturnValue = 6
	ReturnValueMethodParametersCheckedJobStarted ReturnValue = 4096
	ReturnValueInvalidStateTransition            ReturnValue = 4097
	ReturnValueUseOfTimeoutParameterNotSupported ReturnValue = 4098
	ReturnValueBusy                              ReturnValue = 4099
)

func (ReturnValue) String

func (r ReturnValue) String() string

String returns the string representation of the ReturnValue value.

type Service

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

func NewUserInitiatedConnectionServiceWithClient

func NewUserInitiatedConnectionServiceWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Service

func (Service) Enumerate

func (service Service) Enumerate() (response Response, err error)

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

func (Service) Get

func (service Service) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (Service) Pull

func (service Service) 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 (Service) RequestStateChange

func (service Service) RequestStateChange(requestedState RequestedState) (response Response, err error)

Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.

Additional Notes:

1) In Intel AMT Release 5.0 and earlier releases 'datetime' format is simple string. In Intel AMT Release 5.1 and later releases 'datetime' format is as defined in DSP0230 'DMTF WS-CIM Mapping Specification'.

2) AMT doesn't support the TimeoutPeriod parameter (only value 0 is valid).

3) The supported values in RequestedState are 32768-32771.

ValueMap={0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535}

Values={Completed with No Error, Not Supported, Unknown or Unspecified Error, Cannot complete within Timeout Period, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method Reserved, Vendor Specific}.

type UserResponse

type UserResponse struct {
	XMLName                 xml.Name     `xml:"AMT_UserInitiatedConnectionService"`
	CreationClassName       string       `xml:"CreationClassName,omitempty"`       // CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
	ElementName             string       `xml:"ElementName,omitempty"`             // A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.
	EnabledState            EnabledState `xml:"EnabledState"`                      // EnabledState is an integer enumeration that indicates the enabled and disabled states of an element.
	Name                    string       `xml:"Name,omitempty"`                    // The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.
	SystemCreationClassName string       `xml:"SystemCreationClassName,omitempty"` // The CreationClassName of the scoping System.
	SystemName              string       `xml:"SystemName,omitempty"`              // The Name of the scoping System.
}

OUTPUTS Response Types.