kvm

Documentation

Overview

Package kvm facilitates communication with Intel® AMT devices derived from Service Access Point, that describes an access point to start the KVM redirection. One access point represents access to a single KVM redirection stream.

Index

• Constants
• type Body
• type EnabledState
  • func (e EnabledState) String() string
• type KVMProtocol
  • func (e KVMProtocol) String() string
• type KVMRedirectionSAP
• type KVMRedirectionSAPRequestStateChangeInput
• type PullResponse
• type RedirectionSAP
  • func NewKVMRedirectionSAPWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) RedirectionSAP
  • func (redirectionSAP RedirectionSAP) Enumerate() (response Response, err error)
  • func (redirectionSAP RedirectionSAP) Get() (response Response, err error)
  • func (redirectionSAP RedirectionSAP) Pull(enumerationContext string) (response Response, err error)
  • func (redirectionSAP RedirectionSAP) RequestStateChange(requestedState KVMRedirectionSAPRequestStateChangeInput) (response Response, err error)
• type RequestStateChange_OUTPUT
• type RequestedState
  • func (e RequestedState) String() string
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string
• type ReturnValue
  • func (e ReturnValue) String() string
• type Time

Constants

const (
	CIMKVMRedirectionSAP string = "CIM_KVMRedirectionSAP"
	ValueNotFound        string = "Value not found in map"
)

Types

type Body

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

Response Types.

type EnabledState

type EnabledState int

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

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

EnabledState constants.

func (EnabledState) String

func (e EnabledState) String() string

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

type KVMProtocol

type KVMProtocol int

KVMProtocol is an enumeration specifying the type of the KVM stream supported on this SAP.

const (
	KVMProtocolUnknown KVMProtocol = iota
	KVMProtocolOther
	KVMProtocolRaw
	KVMProtocolRDP
	KVMProtocolVNCRFB
)

KVMProtocol constants.

func (KVMProtocol) String

func (e KVMProtocol) String() string

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

type KVMRedirectionSAP

type KVMRedirectionSAP struct {
	CreationClassName       string         `xml:"CreationClassName"`        // CreationClassName indicates the name of the class or the subclass 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"`              // 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.
	Name                    string         `xml:"Name"`                     // The Name property uniquely identifies the ServiceAccessPoint 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"`  // The CreationClassName of the scoping System.
	SystemName              string         `xml:"SystemName"`               // The Name of the scoping System.
	EnabledState            EnabledState   `xml:"EnabledState,omitempty"`   // EnabledState is an integer enumeration that indicates the enabled and disabled states of an element.
	RequestedState          RequestedState `xml:"RequestedState,omitempty"` // 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.
	KVMProtocol             KVMProtocol    `xml:"KVMProtocol,omitempty"`    // An enumeration specifying the type of the KVM stream supported on this SAP.
}

Response Types.

type KVMRedirectionSAPRequestStateChangeInput

type KVMRedirectionSAPRequestStateChangeInput int

Request Types.

const (
	RedirectionSAPEnable  KVMRedirectionSAPRequestStateChangeInput = 2
	RedirectionSAPDisable KVMRedirectionSAPRequestStateChangeInput = 3
)

type PullResponse

type PullResponse struct {
	XMLName xml.Name            `xml:"PullResponse"`
	Items   []KVMRedirectionSAP `xml:"Items>CIM_KVMRedirectionSAP"`
}

Response Types.

type RedirectionSAP

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

func NewKVMRedirectionSAPWithClient

func NewKVMRedirectionSAPWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) RedirectionSAP

NewKVMRedirectionSAP returns a new instance of the KVMRedirectionSAP struct.

func (RedirectionSAP) Enumerate

func (redirectionSAP RedirectionSAP) Enumerate() (response Response, err error)

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

func (RedirectionSAP) Get

func (redirectionSAP RedirectionSAP) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (RedirectionSAP) Pull

func (redirectionSAP RedirectionSAP) 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 (RedirectionSAP) RequestStateChange

func (redirectionSAP RedirectionSAP) RequestStateChange(requestedState KVMRedirectionSAPRequestStateChangeInput) (response Response, err error)

RequestStateChange requests that the state of the element be changed to the value specified in the RequestedState parameter . . .

type RequestStateChange_OUTPUT

type RequestStateChange_OUTPUT struct {
	XMLName xml.Name `xml:"RequestStateChange_OUTPUT"`
	// 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}
	ReturnValue ReturnValue `xml:"ReturnValue"`
}

Response Types.

type RequestedState

type RequestedState int

RequestedState is an 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
)

RequestedState constants.

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 ReturnValue

type ReturnValue int

ReturnValue is an enumeration specifying the return value of the operation.

const (
	ReturnValueCompletedNoError ReturnValue = iota
	ReturnValueNotSupported
	ReturnValueUnknownError
	ReturnValueTimeout
	ReturnValueFailed
	ReturnValueInvalidParameter
	ReturnValueInUse
	ReturnValueMethodParametersChecked      ReturnValue = 4096
	ReturnValueInvalidStateTransition       ReturnValue = 4097
	ReturnValueTimeoutParameterNotSupported ReturnValue = 4098
	ReturnValueBusy                         ReturnValue = 4099
)

ReturnValue constants.

func (ReturnValue) String

func (e ReturnValue) String() string

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

type Time

type Time struct {
	DateTime string `xml:"Datetime"`
}

Response Types.