CollapseAll image

Set/Get Link Preference and Control

The following steps describe how to manipulate the wireless interface link preference option and get link preference and control settings.

1.  Retrieve the instance of AMT_EthernetPortSettings, where the “InstanceID” key equals “Intel(r) AMT Ethernet Port Settings 1” (wireless port).

2.  This flow is relevant for cases in which a SOL/Remote Storage/KVM/remote access session is open over the wireless interface, and the user wishes to make sure it is maintained across resets. For that to occur, the Link Preference needs to be controlled. In order to find if a specific wireless interface is used for such a session:

   Check if the relevant association instance for the session exists (IPS_SolSessionUsingPort/IPS_IderSessionUsingPort/IPS_KvmSessionUsingPort/IPS_RasSessionUsingPort) and is connected to the AMT_EthernetPortSettings.

3.  Retrieve the following AMT_EthernetPortSettings properties using the Get method:

Property

Value

LinkPreference (Read Only)

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

LinkControl (Read Only)

Indicates whether the link is currently owned by the ME or the host.

Click here for a snippet demonstrating this step

You can execute this snippet by inserting it into the execution template found here.

  

$ethernetPortSettingsRef =$wsmanConnectionObject.NewReference("SELECT * FROM AMT_EthernetPortSettings WHERE InstanceID='Intel(r) AMT Ethernet Port Settings 1'")

$ethernetPortSettingsInstance =$ethernetPortSettingsRef.Get()

$linkPreference =$ethernetPortSettingsInstance.GetProperty("LinkPreference")

$linkControl =$ethernetPortSettingsInstance.GetProperty("LinkControl")

 

 

4.  To change the link preference, invoke AMT_EthernetPortSettings.SetLinkPreference.

Click here for a snippet demonstrating this step

You can execute this snippet by inserting it into the execution template found here.

  

$ethernetPortSettingsRef =$wsmanConnectionObject.NewReference("SELECT * FROM AMT_EthernetPortSettings WHERE InstanceID='Intel(r) AMT Ethernet Port Settings 1'")

$ethernetPortSettingsInstance =$ethernetPortSettingsRef.Get()

$inputObject =$ethernetPortSettingsRef.CreateMethodInput("SetLinkPreference")

$inputObject.SetProperty("LinkPreference","1")

$inputObject.SetProperty("Timeout","60")

$outputObject =$ethernetPortSettingsRef.InvokeMethod($inputObject)

$returnValue =$outputObject.GetProperty("ReturnValue")

 

 

 

 Note:

   Change from host to ME preference if you wish to maintain a redirection/remote access wireless session, before performing operations that will make the host wireless driver non-functional, such as rebooting the machine or disabling the driver.

   Provide a short timeout (e.g. 1 minute) to return to host control if ME control fails (for example, due to missing wireless profile parameters). If the handoff to ME succeeds, periodically call this function with a longer timeout (e.g. 5 minutes), and call again before the end of the timeout interval. Only after control changes to ME, perform the desired operation (for example, reboot).

   If host preference is needed during the session (e.g. it is necessary to connect the host to the network), call SetLinkPreference() again with host preference.

   Note that temporary disconnections are likely to occur when the link control is changed in ME-to-host transitions.

 

 

Instance Diagram

Classes Used in This Flow

SDK Sample

If there is a sample demonstrating this flow, it is included in the SDK installation file. See SDK Installation Layout for details.

 

See Also:

   Link Preference and Control

 

Copyright © 2006-2022, Intel Corporation. All rights reserved.