wifi

package
v2.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 11, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package WiFi facilitates communication with Intel® AMT devices to access and configure WiFi Endpoint Settings and WiFi Port features of AMT.

WiFiEndpointSettings: A class derived from SettingData that can be applied to an instance of CIM_WiFiEndpoint to enable it to associate to a particular Wi-Fi network.

WiFiPort: A class derived from NetworkPort that provides the logical representation of wireless local area network communications hardware that conforms to the IEEE 802.11 series of specifications. It embodies properties at the lowest layers of a network stack, such as the antennas used for transmission and reception, the address permanently embedded into the hardware, and the operational bandwidth of the device.

Index

Constants

View Source 
const (
	CIMWiFiEndpoint         string = "CIM_WiFiEndpoint"
	CIMWiFiEndpointSettings string = "CIM_WiFiEndpointSettings"
	CIMWiFiPort             string = "CIM_WiFiPort"
	ValueNotFound           string = "Value not found in map"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticationMethod 

type AuthenticationMethod int

AuthenticationMethod shall specify the 802.11 authentication method used when the settings are applied. 

const (
	AuthenticationMethodOther AuthenticationMethod = iota + 1
	AuthenticationMethodOpenSystem
	AuthenticationMethodSharedKey
	AuthenticationMethodWPAPSK
	AuthenticationMethodWPAIEEE8021x
	AuthenticationMethodWPA2PSK
	AuthenticationMethodWPA2IEEE8021x
	AuthenticationMethodWPA3SAE AuthenticationMethod = 32768
	AuthenticationMethodWPA3OWE AuthenticationMethod = 32769
)

func (AuthenticationMethod) String added in v2.2.4 

func (e AuthenticationMethod) String() string

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

type BSSType 

type BSSType int

BSSType shall indicate the Basic Service Set (BSS) Type that shall be used when the settings are applied. 

const (
	BSSTypeUnknown        BSSType = 0
	BSSTypeIndependent    BSSType = 2
	BSSTypeInfrastructure BSSType = 3
)

func (BSSType) String added in v2.2.4 

func (e BSSType) String() string

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

type Body 

type Body struct {
	XMLName                   xml.Name `xml:"Body"`
	WiFiPortGetResponse       WiFiPort
	EnumerateResponse         common.EnumerateResponse
	PullResponse              PullResponse
	RequestStateChange_OUTPUT common.ReturnValue
}

OUTPUT Response Types.

type EnabledState added in v2.2.4 

type EnabledState int

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

const (
	EnabledStateWifiDisabled      EnabledState = 3
	EnabledStateWifiEnabledS0     EnabledState = 32768
	EnabledStateWifiEnabledS0SxAC EnabledState = 32769
)

func (EnabledState) String added in v2.2.4 

func (e EnabledState) String() string

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

type EncryptionMethod 

type EncryptionMethod int

EncryptionMethod shall specify the 802.11 encryption method used when the settings are applied. 

const (
	EncryptionMethod_Other EncryptionMethod = iota + 1
	EncryptionMethod_WEP
	EncryptionMethod_TKIP
	EncryptionMethod_CCMP
	EncryptionMethod_None
)

func (EncryptionMethod) String added in v2.2.4 

func (e EncryptionMethod) String() string

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

type EndpointSettings 

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

func NewWiFiEndpointSettingsWithClient 

func NewWiFiEndpointSettingsWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) EndpointSettings

NewWiFiEndpointSettings returns a new instance of the WiFiEndpointSettings struct.

func (EndpointSettings) Delete 

func (endpointSettings EndpointSettings) Delete(handle string) (response Response, err error)

Delete removes a the specified instance.

func (EndpointSettings) Enumerate 

func (endpointSettings EndpointSettings) Enumerate() (response Response, err error)

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

func (EndpointSettings) Pull 

func (endpointSettings EndpointSettings) 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.

type HealthState added in v2.2.4 

type HealthState int

HealthState shall indicate the current health of the element. 

const (
	HealthStateUnknown             HealthState = 0
	HealthStateOK                  HealthState = 5
	HealthStateDegraded            HealthState = 10
	HealthStateMinorFailure        HealthState = 15
	HealthStateMajorFailure        HealthState = 20
	HealthStateCriticalFailure     HealthState = 25
	HealthStateNonRecoverableError HealthState = 30
)

func (HealthState) String added in v2.2.4 

func (e HealthState) String() string

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

type LinkTechnology 

type LinkTechnology int

LinkTechnology shall contain an enumeration of the types of links. When set to 1 ("Other"), the related property OtherLinkTechnology shall contain a string description of the type of link. 

const (
	LinkTechnologyUnknown LinkTechnology = iota
	LinkTechnologyOther
	LinkTechnologyEthernet
	LinkTechnologyIB
	LinkTechnologyFC
	LinkTechnologyFDDI
	LinkTechnologyATM
	LinkTechnologyTokenRing
	LinkTechnologyFrameRelay
	LinkTechnologyInfrared
	LinkTechnologyBlueTooth
	LinkTechnologyWirelessLAN
)

func (LinkTechnology) String added in v2.2.4 

func (e LinkTechnology) String() string

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

type Port 

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

func NewWiFiPortWithClient 

func NewWiFiPortWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Port

NewWiFiPort returns a new instance of the WiFiPort struct.

func (Port) Enumerate 

func (port Port) Enumerate() (response Response, err error)

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

func (Port) Get 

func (port Port) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (Port) Pull 

func (port Port) 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 (Port) RequestStateChange 

func (port Port) RequestStateChange(requestedState int) (response Response, err error)

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

type PortType added in v2.2.4 

type PortType int

PortType shall contain the specific 802.11 operating mode that is currently enabled on the Port. 

const (
	PortTypeUnknown PortType = 0
	PortTypeOther   PortType = 1
	PortType80211a  PortType = 70
	PortType80211b  PortType = 71
	PortType80211g  PortType = 72
	PortType80211n  PortType = 73
)

func (PortType) String added in v2.2.4 

func (e PortType) String() string

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

type PullResponse 

type PullResponse struct {
	XMLName               xml.Name                       `xml:"PullResponse"`
	EndpointSettingsItems []WiFiEndpointSettingsResponse `xml:"Items>CIM_WiFiEndpointSettings"`
	WiFiPortItems         []WiFiPort                     `xml:"Items>CIM_WiFiPort"`
}

OUTPUT Response Types.

type RequestedState added in v2.2.4 

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 (
	RequestedStateWifiDisabled      RequestedState = 3
	RequestedStateWifiEnabledS0     RequestedState = 32768
	RequestedStateWifiEnabledS0SxAC RequestedState = 32769
)

func (RequestedState) String added in v2.2.4 

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"`
}

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 is a 16-bit unsigned integer enumeration that specifies the completion status of the operation. 

const (
	CompletedWithNoError ReturnValue = iota
	NotSupported
	UnknownOrUnspecifiedError
	CannotCompleteWithinTimeoutPeriod
	Failed
	InvalidParameter
	InUse
	MethodParametersCheckedJobStarted ReturnValue = 4096
	InvalidStateTransition            ReturnValue = 4097
	UseOfTimeoutParameterNotSupported ReturnValue = 4098
	Busy                              ReturnValue = 4099
)

func (ReturnValue) String added in v2.2.4 

func (e ReturnValue) String() string

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

type WiFiEndpointSettingsRequest 

type WiFiEndpointSettingsRequest struct {
	XMLName xml.Name `xml:"h:WiFiEndpointSettingsInput"`
	H       string   `xml:"xmlns:q,attr"`
	// SettingData
	ElementName          string               `xml:"q:ElementName,omitempty"`
	InstanceID           string               `xml:"q:InstanceID,omitempty"`
	AuthenticationMethod AuthenticationMethod `xml:"q:AuthenticationMethod,omitempty"`
	EncryptionMethod     EncryptionMethod     `xml:"q:EncryptionMethod,omitempty"`
	SSID                 string               `xml:"q:SSID,omitempty"` // Max Length 32
	Priority             int                  `xml:"q:Priority,omitempty"`
	PSKPassPhrase        string               `xml:"q:PSKPassPhrase,omitempty"` // Min Length 8 Max Length 63
	BSSType              BSSType              `xml:"q:BSSType,omitempty"`
	Keys                 []string             `xml:"q:Keys,omitempty"` // OctetString ArrayType=Indexed Max Length 256
	KeyIndex             int                  `xml:"q:KeyIndex,omitempty"`
	PSKValue             int                  `xml:"q:PSKValue,omitempty"` // OctetString
}

INPUT Request Types.

type WiFiEndpointSettingsResponse 

type WiFiEndpointSettingsResponse struct {
	XMLName              xml.Name             `xml:"CIM_WiFiEndpointSettings"`
	AuthenticationMethod AuthenticationMethod // AuthenticationMethod shall specify the 802.11 authentication method used when the settings are applied.
	BSSType              BSSType              // BSSType shall indicate the Basic Service Set (BSS) Type that shall be used when the settings are applied.
	ElementName          string               // 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.)
	EncryptionMethod     EncryptionMethod     // EncryptionMethod shall specify the 802.11 encryption method used when the settings are applied.
	InstanceID           string               // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.
	Priority             int                  // Priority shall indicate the priority of the instance among all WiFiEndpointSettings instances.
	SSID                 string               // SSID shall indicate the Service Set Identifier (SSID) that shall be used when the settings are applied to a WiFiEndpoint. An SSID identifies a wireless network.
}

OUTPUT Response Types.

type WiFiEndpointSettings_INPUT 

type WiFiEndpointSettings_INPUT struct {
	XMLName              xml.Name `xml:"CIM_WiFiEndpointSettings"`
	H                    string   `xml:"xmlns:q,attr"`
	AuthenticationMethod AuthenticationMethod
	BSSType              BSSType
	ElementName          string
	EncryptionMethod     EncryptionMethod
	InstanceID           string
	Priority             int
	SSID                 string
}

INPUT Request Types.

type WiFiPort 

type WiFiPort struct {
	XMLName                 xml.Name       `xml:"CIM_WiFiPort"`
	LinkTechnology          LinkTechnology // An enumeration of the types of links. When set to 1 ("Other"), the related property OtherLinkTechnology contains a string description of the type of link.
	DeviceID                string         // An address or other identifying information to uniquely name the LogicalDevice.
	CreationClassName       string         // CreationClassName indicates the name of the class or the subclass used in the creation of an instance.
	SystemName              string         // The scoping System's Name.
	SystemCreationClassName string         // The scoping System's CreationClassName.
	ElementName             string         // 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.
	HealthState             HealthState    // Indicates the current health of the element.
	EnabledState            EnabledState   // EnabledState is an integer enumeration that indicates the enabled and disabled states of an element.
	RequestedState          RequestedState // 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.
	PortType                PortType       // PortType shall contain the specific 802.11 operating mode that is currently enabled on the Port.
	PermanentAddress        string         // IEEE 802 EUI-48 MAC address, formatted as twelve hexadecimal digits (for example, "010203040506"), with each pair representing one of the six octets of the MAC address in "canonical" bit order.
}

OUTPUT Response Types.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.