SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class AMT_EthernetPortSettings

Used in features: Network Administration , General Info , Wireless
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_SettingData
      extended by AMT_EthernetPortSettings


class AMT_EthernetPortSettings
 extends CIM_SettingData


General Information:
This class contains all Intel® AMT specific 
settings (IP, DHCP, VLAN) for one network interface in the 
system.

Qualifiers:
-------------
Version=7.0.0









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
The 
      user-friendly name for this instance of SettingData . . .

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this 
    class.

  

     uint16 
      
    VLANTag 
Indicates 
      whether VLAN is in use and what is the VLAN tag when used.

  

     boolean 
      
    SharedMAC 
Indicates 
      whether Intel(R) AMT shares it's MAC address with the host system.

  

     string 
      
    MACAddress 
The MAC 
      address used by Intel(R) AMT in a string format . . .

  

     boolean 
      
    LinkIsUp 
Indicates 
      whether the network link is up

  

     uint8[4] 
      
    LinkPolicy 
      
Enumeration values for link policy restrictions for better 
      power consumption . . .

  

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

  

     uint32 
      
    LinkControl 
      
Determines whether the link is owned by ME or host

  

     boolean 
      
    SharedStaticIp 
      
Indicates whether the static host IP is shared with ME.

  

     boolean 
      
    SharedDynamicIP 
      
Indicates whether the dynamic host IP is shared with ME.

  

     boolean 
      
    IpSyncEnabled 
      
Indicates whether the IP synchronization between host and ME is 
      enabled.

  

     boolean 
      
    DHCPEnabled 
      
Indicates whether DHCP is in use.

  

     string 
      
    IPAddress 
String 
      representation of IP address . . .

  

     string 
      
    SubnetMask 
Subnet 
      mask in a string format.For example: 255.255.0.0

  

     string 
      
    DefaultGateway 
      
Default Gateway in a string format . . .

  

     string 
      
    PrimaryDNS 
Primary 
      DNS in a string format . . .

  

     string 
      
    SecondaryDNS 
      
Secondary DNS in a string format . . .

  

     uint32 
      
    ConsoleTcpMaxRetransmissions 
      
Indicates the number of retransmissions host TCP SW tries ifno 
      ack is accepted

  

     uint32 
      
    WLANLinkProtectionLevel 
      
Defines the level of the link protection feature activation . . 
      .

	  
	  

     uint32 
      
    PhysicalConnectionType 
      
Indicates the physical connection type of this network interface.


	  
	  

     uint32 
      
    PhysicalNicMedium 
      
Indicates which medium is currently used by Intel® AMT to communicate with the NIC
      .

	  
	  




  
  

    Methods Summary

  

     uint32
    SetLinkPreference(LinkPreference, 
      Timeout) 
Defines the link preferred owner entity

  

     uint32
    CancelLinkProtection() 
      
Used to cancel WLAN LP . . .

  

     uint32
    RestoreLinkProtection() 
      
Used to restore Link Protection if previously canceled by calling 
      CancelLinkProtection() . . .

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context




  
  

    Field 
Detail


ElementName 
public string ElementName



  
General Information:
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.)

Product Specific Usage:
In Intel AMT 
  Release 6.0 and later releases value is 'Intel(r) AMT Ethernet Port 
  Settings'

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=35


  

  





InstanceID Key 
public string InstanceID



  
General Information:
Within the scope of the instantiating 
  Namespace, InstanceID opaquely and uniquely identifies an instance of this 
  class.

Product Specific Usage:
In Intel AMT Release 6.0 and 
  later releases value is 'Intel(r) AMT Ethernet Port Settings 0' for wired 
  instance and 'Intel(r) AMT Ethernet Port Settings 1' for wireless 
  instance

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=50


  

  





VLANTag 
public uint16 VLANTag



  
General Information:
Indicates whether VLAN is in use and what 
  is the VLAN tag when used.

Product Specific Usage:
Only this 
  property will be visible to General-Info users. 
This property is not 
  supported in Release 4.x, Release 6.0, and later 
  releases.

Qualifiers:
-------------
ValueMap={1..}


  

  





SharedMAC 
public boolean SharedMAC



  
General Information:
Indicates whether Intel(R) AMT shares it's 
  MAC address with the host system.

Product Specific 
  Usage:
Additional Notes: 
1) 'SharedMAC' is a required property in 
  Intel AMT Release 3.0 and Intel AMT Release 3.2.

  

  





MACAddress 
public string MACAddress



  
General Information:
The MAC address used by Intel(R) AMT in a 
  string format. For Example: 01-02-3f-b0-99-99. (This property can only be read 
  and can't be 
  changed.)

Qualifiers:
-------------
MaxLen=20


  

  





LinkIsUp 
public boolean LinkIsUp



  
General Information:
Indicates whether the network link is 
up

  

  





LinkPolicy 
public uint8[4] LinkPolicy



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

Qualifiers:
-------------
ValueMap={1, 14, 16, 
  224}
Values={available on S0 AC, available on Sx AC, available on S0 DC, 
  available on Sx DC}


  

  





LinkPreference 
public uint32 LinkPreference



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

Qualifiers:
-------------
ValueMap={1, 2, 
  3..}
Values={ME, HOST, Reserved}


  

  





LinkControl 
public uint32 LinkControl



  
General Information:
Determines whether the link is owned by ME 
  or host

Product Specific Usage:
Additional Notes: 
1) This 
  property is 
  read-only.

Qualifiers:
-------------
ValueMap={1, 2, 
  3..}
Values={ME, HOST, Reserved}


  

  





SharedStaticIp 
public boolean SharedStaticIp



  
General Information:
Indicates whether the static host IP is 
  shared with ME.

  

  





SharedDynamicIP 
public boolean SharedDynamicIP



  
General Information:
Indicates whether the dynamic host IP is 
  shared with ME.

Product Specific Usage:
This property is read 
  only.

  

  





IpSyncEnabled 
public boolean IpSyncEnabled



  
General Information:
Indicates whether the IP synchronization 
  between host and ME is enabled.

  

  





DHCPEnabled 
public boolean DHCPEnabled



  
General Information:
Indicates whether DHCP is in 
  use.

Product Specific Usage:
Additional Notes: 
1) 
  'DHCPEnabled' is a required field for the Put command.

  

  





IPAddress 
public string IPAddress



  
General Information:
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).

Qualifiers:
-------------
MaxLen=20


  

  





SubnetMask 
public string SubnetMask



  
General Information:
Subnet mask in a string format.For example: 
  255.255.0.0

Qualifiers:
-------------
MaxLen=20


  

  





DefaultGateway 
public string DefaultGateway



  
General Information:
Default Gateway in a string format. For 
  example: 
  10.12.232.1

Qualifiers:
-------------
MaxLen=20


  

  





PrimaryDNS 
public string PrimaryDNS



  
General Information:
Primary DNS in a string format. For 
  example: 
  10.12.232.1

Qualifiers:
-------------
MaxLen=20


  

  





SecondaryDNS 
public string SecondaryDNS



  
General Information:
Secondary DNS in a string format. For 
  example: 
  10.12.232.1

Qualifiers:
-------------
MaxLen=20


  

  





ConsoleTcpMaxRetransmissions 
public uint32 ConsoleTcpMaxRetransmissions



  
General Information:
Indicates the number of retransmissions 
  host TCP SW tries ifno ack is 
  accepted

Qualifiers:
-------------
MinValue=5
MaxValue=7


  

  





WLANLinkProtectionLevel 
public uint32 WLANLinkProtectionLevel



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

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4..}
Values={OVERRIDE, NONE, PASSIVE, HIGH, RESERVED}


  

  






PhysicalConnectionType 
public uint32 PhysicalConnectionType



  
General Information:
Indicates the physical connection type of this network interface.


  Note: Applicable in Intel AMT 15.0 and later.


  Qualifiers:
-------------
ValueMap={"0", "1", "2", "3", 
  "4.."}
Values={"Integrated LAN NIC", "Discrete LAN NIC", "LAN via a Thunderbolt dock", "Wireless LAN", "Reserved"}


  

  






PhysicalNicMedium 
public uint32 PhysicalNicMedium



  
General Information:
Indicates which medium is currently used by Intel® AMT to communicate with the NIC.


  Note: Applicable in Intel AMT 15.0 and later.


  Qualifiers:
-------------
ValueMap={"0", "1", "2.."}
Values={"SMBUS", "PCIe", "Reserved"}


  

  








  
  

    Method 
Detail


SetLinkPreference
public uint32 SetLinkPreference([IN]uint32 LinkPreference, [IN]uint32 Timeout)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_RCS_ADMIN_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM, ADMIN_SECURITY_SOLIDER_REALM, 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM

General 
  Information:
Defines the link preferred owner entity

Product 
  Specific Usage:
Supported only for the wireless port 
  instance.

Qualifiers:
-------------
ValueMap={0, 1, 2, 36, 
  2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_LINK_PREFERENCE_OVERRIDEN, PT_STATUS_INVALID_PARAMETER, 
  PT_STATUS_AUDIT_FAIL}


Parameters:
--------------

  

    
LinkPreference 
    
General Information:
The link preference which will be applied 
    to the ethernet port - either ME or 
    host

Qualifiers:
-------------
IN
Required
ValueMap={1, 
    2, 3..}
Values={ME, HOST, Reserved}


    
Timeout 
    
General Information:
The timeout (in seconds) after which the 
    link preference return back to Host.Valid only when LinkPreference is 1 
    (ME).

Qualifiers:
-------------
IN
ValueMap={1..65535}
Values={Timeout 
    value in seconds}







CancelLinkProtection
public uint32 CancelLinkProtection()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_SOLIDER_REALM, 
  ADMIN_SECURITY_RCS_ADMIN_REALM, ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Used 
  to cancel WLAN LP. When this API is called the Link Protection set by the MC 
  (using the SetLinkPreference() API) is canceled. In addition, ME applications 
  get the request to cancel LP and determine according to their policies whether 
  to do so or not. AMT redirection applications will all cancel Link Protection 
  when this API is called.This API can cancel Link Protection for a maximum of 
  one hour. Once this time expires Link Protection will be restored if still 
  needed by an ME 
  application.

Qualifiers:
-------------
ValueMap={0, 1, 2, 
  3..}
Values={SUCCESS, NOT_ALLOWED, INTERNAL_ERROR, 
RESERVED}






RestoreLinkProtection
public uint32 RestoreLinkProtection()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_SOLIDER_REALM, 
  ADMIN_SECURITY_RCS_ADMIN_REALM, ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Used 
  to restore Link Protection if previously canceled by calling 
  CancelLinkProtection(). If there is no redirection session open or if link 
  protection is already set, this API will do nothing. If there is a redirection 
  session open, it will get a notification that Link Protection is requested to 
  be restored and it will restore Link Protection. Each redirection application 
  will cancel its own link protection when the session 
  ends.

Qualifiers:
-------------
ValueMap={0, 1, 
  2..}
Values={SUCCESS, INTERNAL_ERROR, RESERVED}






Put
public  Put([IN]AMT_EthernetPortSettings Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
When 'DHCPEnabled' property 
  is set to true the following properties should be set to NULL: 
SubnetMask, 
  DefaultGateway, IPAddress, PrimaryDNS, SecondaryDNS. 
If one of these 
  properties is not NULL a wxf:InvalidRepresentation is returned with Detail: 
  
http://schemas.dmtf.org/wbem/wsman/1/wsman/faultDetail/InvalidValues.





Get
public  Get([OUT]AMT_EthernetPortSettings Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_GENERAL_INFO_REALM, 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, ADMIN_SECURITY_SOLIDER_REALM, 
  ADMIN_SECURITY_LOCAL_APPS_REALM

General Information:
Gets the 
  representation of the instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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