Class AMT_EthernetPortSettings

Used in features: Intel(R) ME defined Classes
CIM_ManagedElement
   extended by CIM_SettingData
      extended by AMT_EthernetPortSettings


class AMT_EthernetPortSettings
extends CIM_SettingData

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

Qualifiers:
-------------
Version=0.0.3
LOCALE=0x409
dynamic
provider=IntelMEProv
InternalOnly=This class is taken from the ME CIM schema


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 . . .
 string MACAddress
The MAC address used by Intel(R) AMT in a string format . . .
 boolean LinkIsUp
Indicates whether the network link is up
 boolean DHCPEnabled
Indicates whether DHCP is in use . . .
 string IPAddress
String representation of IP address . . .
 string SubnetMask
Subnet mask in a string format . . .
 string DefaultGateway
Default Gateway in a string format . . .
 string PrimaryDNS
Primary DNS in a string format . . .
 string SecondaryDNS
Secondary DNS in a string format . . .

Methods Summary
  Get(Instance)
Gets the representation of the instance
  Enumerate()
Enumerates the instances of this class

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.)

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


InstanceID Key

public string InstanceID
General Information:
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.

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


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=256


LinkIsUp

public boolean LinkIsUp
General Information:
Indicates whether the network link is up


DHCPEnabled

public boolean DHCPEnabled
General Information:
Indicates whether DHCP is in use. When this parameter is set to true these parameters will be ignored: SubnetMask, DefaultGAteway, IPAddress, PrimaryDNS, SecondaryDNS.


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=256


SubnetMask

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

Qualifiers:
-------------
MaxLen=256


DefaultGateway

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

Qualifiers:
-------------
MaxLen=256


PrimaryDNS

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

Qualifiers:
-------------
MaxLen=256


SecondaryDNS

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

Qualifiers:
-------------
MaxLen=256


Method Detail

Get

public  Get([OUT]AMT_EthernetPortSettings Instance)
Permission Information:
No permissions defined

General Information:
Gets the representation of the instance

Enumerate

public  Enumerate()
Permission Information:
All users permitted to use method

General Information:
Enumerates the instances of this class

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