environmentdetection

Documentation

Overview

Package environmentdetection facilitates communication with Intel® AMT device configuration-related and operational parameters for the Environment Detection service in Intel® AMT.

Index

• Constants
• type Body
• type DetectionAlgorithm
  • func (d DetectionAlgorithm) String() string
• type EnvironmentDetectionSettingDataRequest
• type EnvironmentDetectionSettingDataResponse
• type PullResponse
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string
• type SettingData
  • func NewEnvironmentDetectionSettingDataWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) SettingData
  • func (sd SettingData) Enumerate() (response Response, err error)
  • func (sd SettingData) Get() (response Response, err error)
  • func (sd SettingData) Pull(enumerationContext string) (response Response, err error)
  • func (sd SettingData) Put(environmentDetectionSettingData EnvironmentDetectionSettingDataRequest) (response Response, err error)

Constants

const (
	AMTEnvironmentDetectionSettingData string = "AMT_EnvironmentDetectionSettingData"
)

INPUTS Constants.

Types

type Body

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

OUTPUTS Response Types.

type DetectionAlgorithm

type DetectionAlgorithm int

Specifies which algorithm is used to determine whether the system is in its intranet environment or in the Internet environment.

Currently, AMT supports only the "Local Domains" type.

ValueMap={0, 1}

Values={Local Domains, Remote URLs}.

const (
	LocalDomains DetectionAlgorithm = iota
	RemoteURLs
)

func (DetectionAlgorithm) String

func (d DetectionAlgorithm) String() string

String returns the string representation of the DetectionAlgorithm value.

type EnvironmentDetectionSettingDataRequest

type EnvironmentDetectionSettingDataRequest struct {
	XMLName                    xml.Name           `xml:"h:AMT_EnvironmentDetectionSettingData"`
	H                          string             `xml:"xmlns:h,attr"`
	ElementName                string             `xml:"h:ElementName"`                          // Required. The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
	InstanceID                 string             `xml:"h:InstanceID"`                           // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.
	DetectionAlgorithm         DetectionAlgorithm `xml:"h:DetectionAlgorithm"`                   // Required. Specifies which algorithm is used to determine whether the system is in its intranet environment or in the Internet environment. Currently, AMT supports only the "Local Domains" type.
	DetectionStrings           []string           `xml:"h:DetectionStrings,omitempty"`           // An array of strings used in the environment detection algorithm. If DetectionAlgorithm is "Local Domains", DetectionStrings contains a set of local domain strings. If DetectionAlgorithm is "Remote URLs", then DetectionStrings contains a set of remote URLs.
	DetectionIPv6LocalPrefixes []string           `xml:"h:DetectionIPv6LocalPrefixes,omitempty"` // Can be used for environment detection in IPv6 networks that do not configure the DNS suffix via DHCP. The format is: "XXXX:XXXX:XXXX:XXXX/Y" where Y is the prefix length, the XXXX:XXXX:XXXX:XXXX part can include zeros compression (e.g. 0:0:0 or ::) formats.
}

INPUTS Request Types.

type EnvironmentDetectionSettingDataResponse

type EnvironmentDetectionSettingDataResponse struct {
	XMLName                    xml.Name           `xml:"AMT_EnvironmentDetectionSettingData"`
	ElementName                string             `xml:"ElementName,omitempty"`                // The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
	InstanceID                 string             `xml:"InstanceID,omitempty"`                 // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.
	DetectionAlgorithm         DetectionAlgorithm `xml:"DetectionAlgorithm,omitempty"`         // Specifies which algorithm is used to determine whether the system is in its intranet environment or in the Internet environment. Currently, AMT supports only the "Local Domains" type.
	DetectionStrings           []string           `xml:"DetectionStrings,omitempty"`           // An array of strings used in the environment detection algorithm. If DetectionAlgorithm is "Local Domains", DetectionStrings contains a set of local domain strings. If DetectionAlgorithm is "Remote URLs", then DetectionStrings contains a set of remote URLs.
	DetectionIPv6LocalPrefixes []string           `xml:"DetectionIPv6LocalPrefixes,omitempty"` // Can be used for environment detection in IPv6 networks that do not configure the DNS suffix via DHCP. The format is: "XXXX:XXXX:XXXX:XXXX/Y" where Y is the prefix length, the XXXX:XXXX:XXXX:XXXX part can include zeros compression (e.g. 0:0:0 or ::) formats.
}

OUTPUTS Response Types.

type PullResponse

type PullResponse struct {
	XMLName                              xml.Name                                  `xml:"PullResponse"`
	EnvironmentDetectionSettingDataItems []EnvironmentDetectionSettingDataResponse `xml:"Items>AMT_EnvironmentDetectionSettingData"`
}

OUTPUTS Response Types.

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 SettingData

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

func NewEnvironmentDetectionSettingDataWithClient

func NewEnvironmentDetectionSettingDataWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) SettingData

NewEnvironmentDetectionSettingDataWithClient instantiates a new Environment Detection Setting Data service.

func (SettingData) Enumerate

func (sd SettingData) Enumerate() (response Response, err error)

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

func (SettingData) Get

func (sd SettingData) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (SettingData) Pull

func (sd SettingData) 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 (SettingData) Put

func (sd SettingData) Put(environmentDetectionSettingData EnvironmentDetectionSettingDataRequest) (response Response, err error)

Put will change properties of the selected instance.