PUT /aicc/network/interfaces/{id}

Use this method to configure the settings for a specific network interface.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://{management_server_IP}/aicc/network/interfaces/{id}

where {id} is the network interface ID, such as eth0 or eth1.

Query parameters

None

Request body

Attributes Required / Optional Type Description
id Required String Network interface ID (such as eth0 or eth1)
ip_address Required Array Information about the IP addresses
  assign_method Required String Assignment method used for this IP address. This can be one of the following values.
  • static
  • dhcp
  • auto
  ip Required String IPv4 or IPv6 address
  prefix_length Required Integer Prefix length (in bits) for this IP address
  version Required Integer IP version of this address. This can be one of the following values.
  • 4

  • 6

role Required Array of strings Roles that are performed by this network interface. This can be one or more of the following values.
  • none
  • management
  • osdeployment
Note: The first network interface (for example, eth0), is always set to management. If a second network interface (for example, eth1) is added, you can use it for OS deployment.
The following example sets DHCP IPv6 address and static IPv4 address for the eth0 interface using PUT /aicc/network/interfaces/eth0.
{
   "id": "eth0",
   "ip_addresses": [{
      "assign_method": "dhcp",
      "version": 6
   },
   {
      "assign_method": "static",
      "ip": "1.1.1.1",
      "prefix_length": 24,
      "version": 4
   }],
   "role": ["management"]
}
The following example sets an IPv6 address using auto configuration for the eth1 interface using PUT /aicc/network/interfaces/eth1.
{
    "id": "eth1",
    "ip_addresses": [{
        "assign_method": "auto",
        "version": 6
    }]
   "role": ["osdeployment"]
}

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401 Unauthorized The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available
The following example is returned if the request is successful.
{
   "result": "success",
   "messages": [{
      "id": "FQXHMNM00007I",
      "text": "The network specified configuration has been set successfully.",
      "recovery": {
         "text": "",
         "url": ""
      },
      "explanation": "The user has set a new network configuration."
   }]
}