3.1.5.15.2 networkInterfaces

The networkInterfaces resource represents a physical NIC on the host device.

It is invoked through the following URI.

 https://<url>/networking/v1/servers/{parentResourceId}/networkInterfaces/{resourceId}

url: The address or name of the REST server of the Network Controller.

parentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.3 for more details.

resourceId: the identifier for the specific descendant resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.15.2.1.1

Create a new networkInterfaces resource or update an existing networkInterfaces resource.

GET

3.1.5.15.2.1.2

Get one networkInterfaces resource.

GET ALL

3.1.5.15.2.1.3

List all networkInterfaces resources in the Network Controller.

DELETE

3.1.5.15.2.1.4

Deletes a networkInterfaces resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

adminStatus

Optional

Indicates the administrator status of the network interface.

interfaceIndex

Optional

Indicates the interface index of the network interface. 

interfaceName

Optional

Indicates the name of the network interface. 

interfaceSpeed

Optional

Indicates the speed of the network interface. 

ipConfiguration

Optional

Indicates an array of IP configurations.

ipConfiguration.ipAddress   

Optional

IP address of the interface.

ipConfiguration.networkPrefix

Optional

Network prefix associated with the interface IP address.

ipConfiguration.defaultGateway

Optional

Default gateway associated with the interface.

ipConfiguration.isDhcpEnabled

Optional

Boolean flag indicating whether the IP address has been obtained using DHCP. TRUE means the IP address has been obtained using DHCP; otherwise the default is FALSE.

logicalSubnets

Read-only

Indicates an array of subnets resources that the network interface is connected to. The array MAY contain both IPv6 and IPv6 subnets.

mac

Optional

Indicates the MAC address of the network interface.

operationalStatus

Optional

Indicates the operational status of the network interface.

vlanIds

Optional

Indicates the ID of the VLANs that the network interface is connected to.

isBMC

Optional

Boolean flag to indicate whether the interface is a BMC interface. TRUE if the interface is a BMC interface, FALSE otherwise.