Class AMT_EthernetPortSettings
Used in features: Network Administration , General Info
CIM_ManagedElement
CIM_SettingData
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.4
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 
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 formatFor Example: 01-02-3f-b0-99-99 . . .
|
boolean |
LinkIsUp
Indicates whether the network link is up
|
boolean |
DHCPEnabled
Indicates whether DHCP is in use . . .
|
string |
IPAddress
String representation of IP addresss . . .
|
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 |
|
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
|
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 a index property for a search of query. (Note: Name does not have to be unique within a namespace.)
Qualifiers:
-------------
Required
Override=ElementName
MaxLen=35
InstanceID 
public string InstanceID
-
General Information:
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order 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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This 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 re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.
Qualifiers:
-------------
Key
MaxLen=50
MACAddress
public string MACAddress
-
General Information:
The MAC address used by Intel(R) AMT in a string formatFor Example: 01-02-3f-b0-99-99. (This property can only be read and can't be changed)
Product Specific Usage:
This property is only visible / usable for users of ADMIN_SECURITY_ADMINISTRATION realm.
Qualifiers:
-------------
MaxLen=20
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 false these parameters will not be ignored: SubnetMask, DefaultGAteway, IPAddress, PrimaryDNS, SecondaryDNS.
Product Specific Usage:
This property is only visible / usable for users of ADMIN_SECURITY_ADMINISTRATION realm.
Additional Notes:
1) 'DHCPEnabled' is a required field for the Put command.
IPAddress
public string IPAddress
-
General Information:
String representation of IP addresss. Get operation - reports the acquired IP address (whether in static or DHCP mode). Put operation - sets the IP address (in static mode only).
Product Specific Usage:
This property is only visible / usable for users of ADMIN_SECURITY_ADMINISTRATION realm.
Qualifiers:
-------------
MaxLen=20
SubnetMask
public string SubnetMask
-
General Information:
Subnet mask in a string format. For example: 255.255.0.0
Product Specific Usage:
This property is only visible / usable for users of ADMIN_SECURITY_ADMINISTRATION realm.
Qualifiers:
-------------
MaxLen=20
DefaultGateway
public string DefaultGateway
-
General Information:
Default Gateway in a string format. For example: 10.12.232.1
Product Specific Usage:
This property is only visible / usable for users of ADMIN_SECURITY_ADMINISTRATION realm.
Qualifiers:
-------------
MaxLen=20
PrimaryDNS
public string PrimaryDNS
-
General Information:
Primary DNS in a string format. For example: 10.12.232.1
Product Specific Usage:
This property is only visible / usable for users of ADMIN_SECURITY_ADMINISTRATION realm.
Qualifiers:
-------------
MaxLen=20
SecondaryDNS
public string SecondaryDNS
-
General Information:
Secondary DNS in a string format. For example: 10.12.232.1
Product Specific Usage:
This property is only visible / usable for users of ADMIN_SECURITY_ADMINISTRATION realm.
Qualifiers:
-------------
MaxLen=20
Put
public Put([IN]AMT_EthernetPortSettings Instance)
-
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM
General Information:
Changes properties of the selected instance
Get
public Get([OUT]AMT_EthernetPortSettings Instance)
-
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_GENERAL_INFO_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