NetworkInterface class
The NetworkInterface class represents the interface between a compute container and the network. The term network interface is synonymous with NIC.
NetworkInterface class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the NetworkInterface class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a NetworkInterface object. | |
search | POST | Searches for NetworkInterface objects. |
Operation APIs
The NetworkInterface class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the computeContainer relationship. | |
relation | GET | Retrieves the destinationNetworkPath relationship. | |
relation | GET | Retrieves the host relationship. | |
relation | GET | Retrieves the ipAddresses relationship. | |
relation | GET | Retrieves the network relationship. | |
relation | GET | Retrieves the sourceNetworkPath relationship. | |
relation | GET | Retrieves the zone relationship. | |
relation | GET | Retrieves the computeContainerNetworkInterface relationship. | |
relation | GET | Retrieves the loadBalancingServiceNetworkInterface relationship. | |
relation | GET | Retrieves the logicalFirewallInterface relationship. | |
relation | GET | Retrieves the logicalLoadBalancerInterface relationship. | |
relation | GET | Retrieves the resourceNetwork relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
NetworkInterface class relationships and attributes
The following tables list the relationships and attributes of the NetworkInterface class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
computeContainer | 0..1 | Associated compute container | |
destinationNetworkPath | 0..* | Associated destination network path | |
host | 1 | Server access via the NIC | |
ipAddresses | 1..* | IP addresses assigned to the NIC | |
network | 1..* | Associated network | |
sourceNetworkPath | 0..* | Associated source network path | |
zone | 1 | Associated zone | |
computeContainerNetworkInterface | 0..* | Realized compute container network interfaces | |
loadBalancingServiceNetworkInterface | 0..* | Realized load balancing service network interfaces | |
logicalFirewallInterface | 0..1 |
| |
logicalLoadBalancerInterface | 1 |
| |
resourceNetwork | 1..* |
| |
tickets | 0..* |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
isDHCP | Boolean | 1 | Indicates whether the interface uses DHCP |
isPublicIP | Boolean | 0..1 |
|
lanID | String | 1 | Local area network identifier |
macAddress | String | 0..1 | MAC Address |
networkLabel | String | 1 | Network label |
nicNumber | Integer | 1 | Network interface card number |
switch | String | 0..1 | Switch |
switchPort | String | 0..1 | Switch port |
isOnboarded | Boolean | 1 | Indicates whether the object is onboarded |
externalID | String | 0..1 | Identifier used for the object by an external provider |
owner | String | 0..1 | Name of the owner of the object |
reconciliationID | String | 0..1 | Reconciliation identity value for the object from the BMC Atrium CMDB |
tokenID | String | 0..1 | Token identifier |
description | String | 0..1 | Text that describes the object |
guid | String | 1 | Globally unique identifier for the object |
labels | String | 0..* |
|
modifiedDate | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |