ethernetport

package
v2.36.0 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package ethernetport facilitates communication with Intel® AMT devices to configure all Intel® AMT network specific settings (IP, DHCP, VLAN).

Intel® AMT devices support a single wired and a single wireless network adapter. If an Intel® AMT device has multiple wired or wireless network adapters only one of each will be connected to AMT.

Index

Constants

View Source 
const (
	AMTEthernetPortSettings string = "AMT_EthernetPortSettings"
	ValueNotFound           string = "Value not found in map"
	SetLinkPreference       string = "SetLinkPreference"
)

Variables

View Source 
var PhysicalConnectionTypeToString = map[PhysicalConnectionType]string{
	PhysicalConnectionIntegratedLANNIC:      "Integrated LAN NIC",
	PhysicalConnectionDiscreteLANNIC:        "Discrete LAN NIC",
	PhysicalConnectionLANviaThunderboltDock: "LAN via Thunderbolt Dock",
	PhysicalConnectionWirelessLAN:           "Wireless LAN",
}

PhysicalConnectionTypeToString is a map of PhysicalConnectionType values to their string representations.

View Source 
var PhysicalNicMediumToString = map[PhysicalNicMedium]string{
	PhysicalNicMediumSMBUS: "SMBUS",
	PhysicalNicMediumPCIe:  "PCIe",
}

PhysicalNicMediumToString is a map of PhysicalNicMedium values to their string representations.

Functions

This section is empty.

Types

type Body 

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

OUTPUTS Response Types.

type ConsoleTCPMaxRetransmissions 

type ConsoleTCPMaxRetransmissions int

Indicates the number of retransmissions host TCP SW tries if no ack is accepted

MinValue=5

MaxValue=7. 

const (
	ConsoleTCPMaxRetransmissions5 ConsoleTCPMaxRetransmissions = iota + 5
	ConsoleTCPMaxRetransmissions6
	ConsoleTCPMaxRetransmissions7
)

type LinkControl 

type LinkControl int

Determines whether the link is owned by ME or host. Additional Notes: This property is read-only.

ValueMap={1, 2, 3..}

Values={ME, HOST, Reserved}. 

const (
	LinkControlME LinkControl = iota + 1
	LinkControlHOST
)

func (LinkControl) String 

func (l LinkControl) String() string

String returns the string representation of the LinkControl value.

type LinkPolicy 

type LinkPolicy int

Enumeration values for link policy restrictions for better power consumption. If Intel® AMT will not be able to determine the exact power state, the more restrictive closest configuration applies.

ValueMap={1, 14, 16, 224}

Values={available on S0 AC, available on Sx AC, available on S0 DC, available on Sx DC}. 

const (
	LinkPolicyS0AC LinkPolicy = 1   // available on S0 AC
	LinkPolicySxAC LinkPolicy = 14  // available on Sx AC
	LinkPolicyS0DC LinkPolicy = 16  // available on S0 DC
	LinkPolicySxDC LinkPolicy = 224 // available on Sx DC
)

func (LinkPolicy) String 

func (l LinkPolicy) String() string

String returns the string representation of the LinkPolicy value.

type LinkPreference 

type LinkPreference int

Determines whether the link is preferred to be owned by ME or host

ValueMap={1, 2, 3..}

Values={ME, HOST, Reserved}. 

const (
	LinkPreferenceME LinkPreference = iota + 1
	LinkPreferenceHOST
)

func (LinkPreference) String 

func (l LinkPreference) String() string

String returns the string representation of the LinkPreference value.

type PhysicalConnectionType 

type PhysicalConnectionType int

Indicates the physical connection type of this network interface. Note: Applicable in Intel AMT 15.0 and later.

ValueMap={"0", "1", "2", "3", "4.."}

Values={"Integrated LAN NIC", "Discrete LAN NIC", "LAN via a Thunderbolt dock", "Wireless LAN", "Reserved"}. 

const (
	PhysicalConnectionIntegratedLANNIC PhysicalConnectionType = iota
	PhysicalConnectionDiscreteLANNIC
	PhysicalConnectionLANviaThunderboltDock
	PhysicalConnectionWirelessLAN
)

func (PhysicalConnectionType) String 

func (p PhysicalConnectionType) String() string

String returns the string representation of the PhysicalConnectionType value.

type PhysicalNicMedium 

type PhysicalNicMedium int

Indicates which medium is currently used by Intel® AMT to communicate with the NIC. Note: Applicable in Intel AMT 15.0 and later.

ValueMap={"0", "1", "2.."}

Values={"SMBUS", "PCIe", "Reserved"}. 

const (
	PhysicalNicMediumSMBUS PhysicalNicMedium = iota
	PhysicalNicMediumPCIe
)

func (PhysicalNicMedium) String 

func (p PhysicalNicMedium) String() string

String returns the string representation of the PhysicalNicMedium value.

type PullResponse 

type PullResponse struct {
	XMLName           xml.Name           `xml:"PullResponse"`
	EthernetPortItems []SettingsResponse `xml:"Items>AMT_EthernetPortSettings"`
}

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 SetLinkPreferenceRequest added in v2.36.0 

type SetLinkPreferenceRequest struct {
	XMLName        xml.Name `xml:"h:SetLinkPreference_INPUT"`
	H              string   `xml:"xmlns:h,attr"`
	LinkPreference uint32   `xml:"h:LinkPreference"`
	Timeout        uint32   `xml:"h:Timeout"`
}

SetLinkPreferenceRequest is the input for SetLinkPreference method call.

type SetLinkPreferenceResponse added in v2.36.0 

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

SetLinkPreferenceResponse is the response from SetLinkPreference method call.

type Settings 

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

func NewEthernetPortSettingsWithClient 

func NewEthernetPortSettingsWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Settings

NewEthernetPortSettingsWithClient instantiates a new Ethernet Port Settings service.

func (Settings) Enumerate 

func (s Settings) Enumerate() (response Response, err error)

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

func (Settings) Get 

func (s Settings) Get(instanceID string) (response Response, err error)

Get retrieves the representation of the instance.

func (Settings) Pull 

func (s Settings) 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 (Settings) Put 

func (s Settings) Put(instanceID string, ethernetPortSettings SettingsRequest) (response Response, err error)

Put will change properties of the selected instance.

func (Settings) SetLinkPreference added in v2.36.0 

func (s Settings) SetLinkPreference(linkPreference, timeout uint32, instanceID string) (response Response, err error)

SetLinkPreference sets the link preference (ME or Host) and timeout on an ethernet port. This is an AMT method call that changes the link preference setting. linkPreference: 1 for ME, 2 for Host. timeout: timeout value in seconds. instanceID: the InstanceID of the AMT_EthernetPortSettings to modify.

type SettingsRequest 

type SettingsRequest struct {
	XMLName                      xml.Name                     `xml:"h:AMT_EthernetPortSettings"`
	H                            string                       `xml:"xmlns:h,attr"`
	ElementName                  string                       `xml:"h: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:"h:InstanceID,omitempty"`                   // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.
	VLANTag                      int                          `xml:"h:VLANTag,omitempty"`                      // Indicates whether VLAN is in use and what is the VLAN tag when used.
	SharedMAC                    bool                         `xml:"h:SharedMAC"`                              // Indicates whether Intel® AMT shares it's MAC address with the host system.
	LinkIsUp                     bool                         `xml:"h:LinkIsUp"`                               // Indicates whether the network link is up
	LinkPolicy                   []LinkPolicy                 `xml:"h:LinkPolicy,omitempty"`                   // Enumeration values for link policy restrictions for better power consumption. If Intel® AMT will not be able to determine the exact power state, the more restrictive closest configuration applies.
	LinkPreference               LinkPreference               `xml:"h:LinkPreference,omitempty"`               // Determines whether the link is preferred to be owned by ME or host
	SharedStaticIp               bool                         `xml:"h:SharedStaticIp"`                         // Indicates whether the static host IP is shared with ME.
	IpSyncEnabled                bool                         `xml:"h:IpSyncEnabled"`                          // Indicates whether the IP synchronization between host and ME is enabled.
	DHCPEnabled                  bool                         `xml:"h:DHCPEnabled"`                            // Indicates whether DHCP is in use. Additional Notes: 'DHCPEnabled' is a required field for the Put command.
	IPAddress                    string                       `xml:"h:IPAddress,omitempty"`                    // String representation of IP address. Get operation - reports the acquired IP address (whether in static or DHCP mode). Put operation - sets the IP address (in static mode only).
	SubnetMask                   string                       `xml:"h:SubnetMask,omitempty"`                   // Subnet mask in a string format.For example: 255.255.0.0
	DefaultGateway               string                       `xml:"h:DefaultGateway,omitempty"`               // Default Gateway in a string format. For example: 10.12.232.1
	PrimaryDNS                   string                       `xml:"h:PrimaryDNS,omitempty"`                   // Primary DNS in a string format. For example: 10.12.232.1
	SecondaryDNS                 string                       `xml:"h:SecondaryDNS,omitempty"`                 // Secondary DNS in a string format. For example: 10.12.232.1
	ConsoleTcpMaxRetransmissions ConsoleTCPMaxRetransmissions `xml:"h:ConsoleTcpMaxRetransmissions,omitempty"` // Indicates the number of retransmissions host TCP SW tries if no ack is accepted
	PhysicalConnectionType       PhysicalConnectionType       `xml:"h:PhysicalConnectionType,omitempty"`       // Indicates the physical connection type of this network interface. Note: Applicable in Intel AMT 15.0 and later.
	PhysicalNicMedium            PhysicalNicMedium            `xml:"h:PhysicalNicMedium,omitempty"`            // Indicates which medium is currently used by Intel® AMT to communicate with the NIC. Note: Applicable in Intel AMT 15.0 and later.
}

INPUTS Request Types.

type SettingsResponse 

type SettingsResponse struct {
	XMLName                      xml.Name                `xml:"AMT_EthernetPortSettings"`
	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.
	VLANTag                      int                     `xml:"VLANTag,omitempty"`                      // Indicates whether VLAN is in use and what is the VLAN tag when used.
	SharedMAC                    bool                    `xml:"SharedMAC,omitempty"`                    // Indicates whether Intel® AMT shares it's MAC address with the host system.
	MACAddress                   string                  `xml:"MACAddress,omitempty"`                   // The MAC address used by Intel® AMT in a string format. For Example: 01-02-3f-b0-99-99. (This property can only be read and can't be changed.)
	LinkIsUp                     bool                    `xml:"LinkIsUp,omitempty"`                     // Indicates whether the network link is up
	LinkPolicy                   []LinkPolicy            `xml:"LinkPolicy,omitempty"`                   // Enumeration values for link policy restrictions for better power consumption. If Intel® AMT will not be able to determine the exact power state, the more restrictive closest configuration applies.
	LinkPreference               LinkPreference          `xml:"LinkPreference,omitempty"`               // Determines whether the link is preferred to be owned by ME or host
	LinkControl                  LinkControl             `xml:"LinkControl,omitempty"`                  // Determines whether the link is owned by ME or host.  Additional Notes: This property is read-only.
	SharedStaticIp               bool                    `xml:"SharedStaticIp,omitempty"`               // Indicates whether the static host IP is shared with ME.
	SharedDynamicIP              bool                    `xml:"SharedDynamicIP,omitempty"`              // Indicates whether the dynamic host IP is shared with ME. This property is read only.
	IpSyncEnabled                bool                    `xml:"IpSyncEnabled,omitempty"`                // Indicates whether the IP synchronization between host and ME is enabled.
	DHCPEnabled                  bool                    `xml:"DHCPEnabled,omitempty"`                  // Indicates whether DHCP is in use. Additional Notes: 'DHCPEnabled' is a required field for the Put command.
	IPAddress                    string                  `xml:"IPAddress,omitempty"`                    // String representation of IP address. Get operation - reports the acquired IP address (whether in static or DHCP mode). Put operation - sets the IP address (in static mode only).
	SubnetMask                   string                  `xml:"SubnetMask,omitempty"`                   // Subnet mask in a string format.For example: 255.255.0.0
	DefaultGateway               string                  `xml:"DefaultGateway,omitempty"`               // Default Gateway in a string format. For example: 10.12.232.1
	PrimaryDNS                   string                  `xml:"PrimaryDNS,omitempty"`                   // Primary DNS in a string format. For example: 10.12.232.1
	SecondaryDNS                 string                  `xml:"SecondaryDNS,omitempty"`                 // Secondary DNS in a string format. For example: 10.12.232.1
	ConsoleTcpMaxRetransmissions int                     `xml:"ConsoleTcpMaxRetransmissions,omitempty"` // Indicates the number of retransmissions host TCP SW tries ifno ack is accepted
	WLANLinkProtectionLevel      WLANLinkProtectionLevel `xml:"WLANLinkProtectionLevel,omitempty"`      // Defines the level of the link protection feature activation. Read only property.
	PhysicalConnectionType       PhysicalConnectionType  `xml:"PhysicalConnectionType,omitempty"`       // Indicates the physical connection type of this network interface. Note: Applicable in Intel AMT 15.0 and later.
	PhysicalNicMedium            PhysicalNicMedium       `xml:"PhysicalNicMedium,omitempty"`            // Indicates which medium is currently used by Intel® AMT to communicate with the NIC. Note: Applicable in Intel AMT 15.0 and later.
}

OUTPUTS Response Types.

type WLANLinkProtectionLevel 

type WLANLinkProtectionLevel int

Defines the level of the link protection feature activation. Read only property.

ValueMap={0, 1, 2, 3, 4..}

Values={OVERRIDE, NONE, PASSIVE, HIGH, RESERVED}. 

const (
	WLANLinkProtectionLevelOverride WLANLinkProtectionLevel = iota
	WLANLinkProtectionLevelNone
	WLANLinkProtectionLevelPassive
	WLANLinkProtectionLevelHigh
)

func (WLANLinkProtectionLevel) String 

func (w WLANLinkProtectionLevel) String() string

String returns the string representation of the WLANLinkProtectionLevel value.

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.