optin

Documentation

Overview

Package optin facilitates communication with Intel® AMT devices to describe the user consent service.

This service manages user opt-in options and sends a user consent code for KVM, redirection, and set boot options.

Index

• Constants
• type Body
• type CanModifyOptInPolicy
  • func (c CanModifyOptInPolicy) String() string
• type CancelOptIn_OUTPUT
• type OptInCode
• type OptInRequired
  • func (o OptInRequired) String() string
• type OptInServiceRequest
• type OptInServiceResponse
• type OptInState
  • func (o OptInState) String() string
• type PullResponse
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string
• type ReturnValue
  • func (r ReturnValue) String() string
• type SendOptInCode_OUTPUT
• type Service
  • func NewOptInServiceWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Service
  • func (service Service) CancelOptIn() (response Response, err error)
  • 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) Put(request OptInServiceRequest) (response Response, err error)
  • func (service Service) SendOptInCode(optInCode int) (response Response, err error)
  • func (service Service) StartOptIn() (response Response, err error)
• type StartOptIn_OUTPUT

Constants

const (
	IPSOptInService string = "IPS_OptInService"
	ValueNotFound   string = "Value not found in map"
)

Types

type Body

type Body struct {
	XMLName               xml.Name `xml:"Body"`
	EnumerateResponse     common.EnumerateResponse
	GetAndPutResponse     OptInServiceResponse `xml:"IPS_OptInService"`
	PullResponse          PullResponse         `xml:"PullResponse"`
	StartOptInResponse    StartOptIn_OUTPUT    `xml:"StartOptIn_OUTPUT"`
	CancelOptInResponse   CancelOptIn_OUTPUT   `xml:"CancelOptIn_OUTPUT"`
	SendOptInCodeResponse SendOptInCode_OUTPUT `xml:"SendOptInCode_OUTPUT"`
}

OUTPUT Response Types.

type CanModifyOptInPolicy

type CanModifyOptInPolicy int

CanModifyOptInPolicy indicates whether the OptIn policy can be modified.

const (
	CanModifyOptInPolicyFalse CanModifyOptInPolicy = 0
	CanModifyOptInPolicyTrue  CanModifyOptInPolicy = 1
)

func (CanModifyOptInPolicy) String

func (c CanModifyOptInPolicy) String() string

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

type CancelOptIn_OUTPUT

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

OUTPUT Response Types.

type OptInCode

type OptInCode struct {
	XMLName   xml.Name `xml:"h:SendOptInCode_INPUT"`
	H         string   `xml:"xmlns:h,attr"`
	OptInCode int      `xml:"h:OptInCode"`
}

INPUT Request Types.

type OptInRequired

type OptInRequired uint32

OptInRequired indicates the OptIn (user consent) policy for redirection operations.

const (
	OptInRequiredNone OptInRequired = iota
	OptInRequiredKVM
	OptInRequiredAll OptInRequired = 4294967295
)

func (OptInRequired) String

func (o OptInRequired) String() string

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

type OptInServiceRequest

type OptInServiceRequest struct {
	XMLName                 xml.Name `xml:"h:IPS_OptInService"`
	H                       string   `xml:"xmlns:h,attr"`
	CanModifyOptInPolicy    int      `xml:"h:CanModifyOptInPolicy,omitempty"`
	CreationClassName       string   `xml:"h:CreationClassName,omitempty"`
	ElementName             string   `xml:"h:ElementName,omitempty"`
	Name                    string   `xml:"h:Name,omitempty"`
	OptInCodeTimeout        int      `xml:"h:OptInCodeTimeout,omitempty"`
	OptInDisplayTimeout     int      `xml:"h:OptInDisplayTimeout,omitempty"`
	OptInRequired           int      `xml:"h:OptInRequired"`
	OptInState              int      `xml:"h:OptInState"`
	SystemName              string   `xml:"h:SystemName,omitempty"`
	SystemCreationClassName string   `xml:"h:SystemCreationClassName,omitempty"`
}

INPUT Request Types.

type OptInServiceResponse

type OptInServiceResponse struct {
	XMLName                 xml.Name `xml:"IPS_OptInService"`
	Name                    string   `xml:"Name,omitempty"`
	CreationClassName       string   `xml:"CreationClassName,omitempty"`
	SystemName              string   `xml:"SystemName,omitempty"`
	SystemCreationClassName string   `xml:"SystemCreationClassName,omitempty"`
	ElementName             string   `xml:"ElementName,omitempty"`
	OptInCodeTimeout        int      `xml:"OptInCodeTimeout,omitempty"`
	OptInRequired           uint32   `xml:"OptInRequired"`
	OptInState              int      `xml:"OptInState"`
	CanModifyOptInPolicy    int      `xml:"CanModifyOptInPolicy,omitempty"`
	OptInDisplayTimeout     int      `xml:"OptInDisplayTimeout,omitempty"`
}

OUTPUT Response Types.

type OptInState

type OptInState int

OptInState indicates the current state of the OptIn (user consent) policy.

const (
	NotStarted OptInState = iota
	Requested
	Displayed
	Received
	InSession
)

func (OptInState) String

func (o OptInState) String() string

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

type PullResponse

type PullResponse struct {
	XMLName           xml.Name               `xml:"PullResponse"`
	OptInServiceItems []OptInServiceResponse `xml:"Items>IPS_OptInService"`
}

OUTPUT Response Types.

type Response

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

OUTPUT 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 indicates the status of the operation.

const (
	ReturnValueSuccess ReturnValue = iota
	ReturnValueInternalError
	ReturnValueInvalidState
	ReturnValueBlocked
	ReturnValueFailedFFS
)

func (ReturnValue) String

func (r ReturnValue) String() string

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

type SendOptInCode_OUTPUT

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

OUTPUT Response Types.

type Service

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

func NewOptInServiceWithClient

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

NewOptInService returns a new instance of the OptInService struct.

func (Service) CancelOptIn

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

Cancel a previous opt-in code request.

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)

Gets the representation of OptInService.

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) Put

func (service Service) Put(request OptInServiceRequest) (response Response, err error)

Put will change properties of the selected instance.

func (Service) SendOptInCode

func (service Service) SendOptInCode(optInCode int) (response Response, err error)

Send the opt-in code to Intel® AMT.

func (Service) StartOptIn

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

Request an opt-in code.

type StartOptIn_OUTPUT

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

OUTPUT Response Types.