Set/Get Synchronized IP Settings

Setup and Configuration of Intel AMT > Configuration Settings > Network Administration > Use Cases > Set/Get Synchronized IP Settings

Set/Get Synchronized IP Settings

Starting with Release 7.0, Intel AMT can synchronize its IPv4 address with the Host IP address. See Automatic Synchronization of IP Addresses. Intel AMT supports shared static or dynamic IPv4 addresses. When the IP address is static, Intel AMT synchronizes with other static values.

Note:

Only the wired interface supports static addressing. Therefore, this is not supported on LAN-less platforms.

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

2. Retrieve the relevant settings with AMT_EthernetPortSettings.Get:

Property	Value
DHCPEnabled	Indicates whether DHCP is in use (TRUE by default)
IPSyncEnabled	Indicates whether the IP synchronization between host and ME is enabled (FALSE by default)
SharedDynamicIP	Indicates whether the dynamic host IP is shared with ME (TRUE by default). This is a read-only value.
SharedStaticIP	Indicates whether the static host IP is shared with ME (FALSE by default).

3. Enable Intel AMT to synchronize to the host IP by setting IPSyncEnabled to TRUE (if this value is FALSE, then the IP address must be set by supplying the IPAddress property manually). The value can match the host IP address.

4. Set the following properties to NULL:

Property	Value
IPAddress	NULL
SubnetMask	NULL
DefaultGateway	NULL
PrimaryDNS	NULL
SecondaryDNS	NULL

5. Perform AMT_EthernetPortSettings.Put.

Click here for a snippet demonstrating this step

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

# Select the wired interface.

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

$ethernetPortSettingsInstance =$ethernetPortSettingsRef.Get()

$dhcpEnabled =$ethernetPortSettingsInstance.GetProperty("DHCPEnabled")

$ipSyncEnabled =$ethernetPortSettingsInstance.GetProperty("IpSyncEnabled")

$sharedDynamicIP =$ethernetPortSettingsInstance.GetProperty("SharedDynamicIP")

$sharedStaticIP =$ethernetPortSettingsInstance.GetProperty("SharedStaticIp")

if($ipSyncEnabled -like "false")

{

$ethernetPortSettingsInstance =$ethernetPortSettingsInstance

$ethernetPortSettingsInstance.RemoveProperty("IPAddress")

$ethernetPortSettingsInstance.RemoveProperty("SubnetMask")

$ethernetPortSettingsInstance.RemoveProperty("DefaultGateway")

$ethernetPortSettingsInstance.RemoveProperty("PrimaryDNS")

$ethernetPortSettingsInstance.RemoveProperty("SecondaryDNS")

$ethernetPortSettingsInstance.SetProperty("DHCPEnabled","false")

$ethernetPortSettingsInstance.SetProperty("IpSyncEnabled","true")

$ethernetPortSettingsRef.Put($ethernetPortSettingsInstance)

}

Additional Information

A local application other than the LMS (Release 9.0) or UNS (prior to Release 9.0) (see Automatic Synchronization of IP Addresses) can set the host parameters:

1. The application user must have OS admin privileges on the host.

2. The application requests the $$OsAdmin username name and password.

3. Using these credentials, the application gets the IPS_HostIPSettings object.

4. The application updates the object properties with the host IP parameters and puts the object.

Instance Diagram

Classes Used in This Flow

• AMT_EthernetPortSettings

SDK Sample

Not applicable