Modify Ethernet port IPv4 settings

Edit online

Modifies the IPv4 settings of the Ethernet port. If you modify a Ethernet port that connects your host system to the library, you may terminate the connection to the library.

Request syntax

PATCH /v1/ethernetPorts/{location} {"ipv4Address": <IPv4 address>, "ipv4Subnet": <IPv4 subnet mask>, "ipv4Gateway": <IPv4 gatway address>, "ipv4Assignment": <"static"|"dynamic">, "ipv4Primary": <IPv4 address>, "ipv4Secondary": <IPv4 address>}
Modifies the IPv4 settings of a Ethernet port. The parameters are all optional and can be issued separately.

Path parameters

location (string)

The unique location of the Ethernet port.

Table 1. Ethernet port locations.
Resource Format Example
Ethernet Port ethernetPort_F<f><use>

ethernetPort_F2Pa

ethernetPort_F2Pb

ethernetPort_F2Pimc

ethernetPort_F2Ptssc

ethernetPort_F2Pservice

Request body parameters

ipv4Address (string, optional)

The IPv4 address of this Ethernet port.

ipv4Subnet (string, optional)

The IPv4 subnet mask of this Ethernet port.

ipv4Gateway (string, optional)

The IPv4 gateway address of this Ethernet port.

ipv4Assignment (string, optional)

The IPv4 address of this Ethernet port. Values include static and dynamic.

ipv4Primary (string, optional)

The IPv4 primary DNS address of this Ethernet port. If the ipv4Assignment is static, this value may still be used for other network addresses that use host names such as remote authentication servers and encryption servers.

ipv4Secondary (string, optional)

The IPv4 secondary DNS address of this Ethernet port. If the ipv4Assignment is static, this value may still be used for other network addresses that use host names such as remote authentication servers and encryption servers.

Example

Settings a static IP address.

> PATCH /v1/enternetPorts/{location} {"ipv4Address": "192.168.1.82",
"ipv4Subnet": "255.255.255.0", "ipv4Gateway": "192.168.1.254",
"ipv4Assignment": "static"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0

Error handling

  • Invalid input causes entire command to fail with a 400 Bad Request status code without changing any values.
  • Modifying any values for the ethernetPort_F2Pservice port fails with a 400 Bad Request status code saying Modify service port settings is not allowed.
  • Modifying any values for the ethernetPort_F2Pimc port fails with a 400 Bad Request status code saying Modify IMC port settings is not allowed.
  • Modifying any values for the ethernetPort_F2Ptssc port besides the ipv4Address attribute fails with a 400 Bad Request status code saying Modify TSSC portsettings other than the last octet of the ipv4Address is not allowed.