timesynchronization

Documentation

Overview

Package timesynchronization facilitiates communication with Intel® AMT devices to synchronize the AMT internal clock with an external clock

Index

• Constants
• type Body
• type EnabledState
  • func (e EnabledState) String() string
• type GetLowAccuracyTimeSynchResponse
• type LocalTimeSyncEnabled
  • func (l LocalTimeSyncEnabled) String() string
• type PullResponse
• type RequestedState
  • func (r RequestedState) String() string
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string
• type ReturnValue
  • func (r ReturnValue) String() string
• type Service
  • func NewTimeSynchronizationServiceWithClient(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) GetLowAccuracyTimeSynch() (response Response, err error)
  • func (service Service) Pull(enumerationContext string) (response Response, err error)
  • func (service Service) SetHighAccuracyTimeSynch(ta0, tm1, tm2 int64) (response Response, err error)
• type SetHighAccuracyTimeSynchResponse
• type SetHighAccuracyTimeSynch_INPUT
• type TimeSource
  • func (t TimeSource) String() string
• type TimeSynchronizationServiceResponse

Constants

const (
	AMTTimeSynchronizationService string = "AMT_TimeSynchronizationService"
	GetLowAccuracyTimeSynch       string = "GetLowAccuracyTimeSynch"
	SetHighAccuracyTimeSynch      string = "SetHighAccuracyTimeSynch"
	ValueNotFound                 string = "Value not found in map"
)

Types

type Body

type Body struct {
	XMLName                          xml.Name `xml:"Body"`
	GetResponse                      TimeSynchronizationServiceResponse
	EnumerateResponse                common.EnumerateResponse
	PullResponse                     PullResponse
	GetLowAccuracyTimeSynchResponse  GetLowAccuracyTimeSynchResponse
	SetHighAccuracyTimeSynchResponse SetHighAccuracyTimeSynchResponse
}

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 = iota
	EnabledStateOther
	EnabledStateEnabled
	EnabledStateDisabled
	EnabledStateShuttingDown
	EnabledStateNotApplicable
	EnabledStateEnabledButOffline
	EnabledStateInTest
	EnabledStateDeferred
	EnabledStateQuiesce
	EnabledStateStarting
)

func (EnabledState) String

func (e EnabledState) String() string

String returns the string representation of the EnabledState value.

type GetLowAccuracyTimeSynchResponse

type GetLowAccuracyTimeSynchResponse struct {
	XMLName     xml.Name    `xml:"GetLowAccuracyTimeSynch_OUTPUT"`
	Ta0         int64       `xml:"Ta0"`
	ReturnValue ReturnValue `xml:"ReturnValue"`
}

ValueMap={0, 1}

Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR}.

type LocalTimeSyncEnabled

type LocalTimeSyncEnabled int

LocalTimeSyncEnabled is an integer enumeration that determines if user with LOCAL_SYSTEM_REALM permission can set the time.

const (
	LocalTimeSyncEnabledDefaultTrue LocalTimeSyncEnabled = iota
	LocalTimeSyncEnabledConfiguredTrue
	LocalTimeSyncEnabledFalse
)

func (LocalTimeSyncEnabled) String

func (l LocalTimeSyncEnabled) String() string

String returns the string representation of the LocalTimeSyncEnabled value.

type PullResponse

type PullResponse struct {
	XMLName                         xml.Name                             `xml:"PullResponse"`
	TimeSynchronizationServiceItems []TimeSynchronizationServiceResponse `xml:"Items>AMT_TimeSynchronizationService"`
}

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 (r RequestedState) String() string

String returns the string representation of the RequestedState value.

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 integer enumeration that indicates the success or failure of the operation.

const (
	ReturnValueSuccess                 ReturnValue = 0
	ReturnValueInternalError           ReturnValue = 1
	ReturnValueInvalidParameter        ReturnValue = 36
	ReturnValueFlashWriteLimitExceeded ReturnValue = 38
)

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 NewTimeSynchronizationServiceWithClient

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

NewTimeSynchronizationServiceWithClient instantiates a new 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) GetLowAccuracyTimeSynch

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

GetLowAccuracyTimeSynch is used for reading the Intel® AMT device's internal clock.

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

func (service Service) SetHighAccuracyTimeSynch(ta0, tm1, tm2 int64) (response Response, err error)

SetHighAccuracyTimeSynch is used to synchronize the Intel® AMT device's internal clock with an external clock.

ta0: The time value received from invoking GetLowAccuracyTimeSynch().

tm1: The remote client timestamp after getting a response from GetLowAccuracyTimeSynch().

tm2: The remote client timestamp obtained immediately prior to invoking this method.

ValueMap={0, 1, 36, 38}

Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, PT_STATUS_INVALID_PARAMETER, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED}.

type SetHighAccuracyTimeSynchResponse

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

ValueMap={0, 1, 36, 38}

Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, PT_STATUS_INVALID_PARAMETER, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED}.

type SetHighAccuracyTimeSynch_INPUT

type SetHighAccuracyTimeSynch_INPUT struct {
	XMLName xml.Name `xml:"h:SetHighAccuracyTimeSynch_INPUT"`
	H       string   `xml:"xmlns:h,attr"`
	Ta0     int64    `xml:"h:Ta0"`
	Tm1     int64    `xml:"h:Tm1"`
	Tm2     int64    `xml:"h:Tm2"`
}

Ta0: The time value received from invoking GetLowAccuracyTimeSynch().

Tm1: The remote client timestamp after getting a response from GetLowAccuracyTimeSynch().

Tm2: The remote client timestamp obtained immediately prior to invoking this method.

type TimeSource

type TimeSource int

TimeSource is an integer enumeration that determines if RTC was set to UTC by any configuration SW.

const (
	TimeSourceBiosRTC TimeSource = iota
	TimeSourceConfigured
)

func (TimeSource) String

func (t TimeSource) String() string

String returns the string representation of the TimeSource value.

type TimeSynchronizationServiceResponse

type TimeSynchronizationServiceResponse struct {
	XMLName                 xml.Name             `xml:"AMT_TimeSynchronizationService"`
	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.
	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.
	SystemName              string               `xml:"SystemName,omitempty"`              // The Name of the scoping System.
	SystemCreationClassName string               `xml:"SystemCreationClassName,omitempty"` // The CreationClassName of the scoping System.
	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,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.
	LocalTimeSyncEnabled    LocalTimeSyncEnabled `xml:"LocalTimeSyncEnabled,omitempty"`    // Determines if user with LOCAL_SYSTEM_REALM permission can set the time.
	TimeSource              TimeSource           `xml:"TimeSource,omitempty"`              // Determines if RTC was set to UTC by any configuration SW.
}

Response Types.