ServerNetworkInterface class
The ServerNetworkInterface class represents the network interface for a server.
ServerNetworkInterface class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the ServerNetworkInterface class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a ServerNetworkInterface object. | |
search | POST | Searches for ServerNetworkInterface objects. |
Operation APIs
The ServerNetworkInterface class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the destinationEndPointNetworkPath relationship. | |
relation | GET | Retrieves the lbPoolEntry relationship. | |
relation | GET | Retrieves the logicalDataCenterServerFarmEntry relationship. | |
relation | GET | Retrieves the server relationship. | |
relation | GET | Retrieves the sourceEndPointNetworkPath relationship. | |
relation | GET | Retrieves the switchPort relationship. | |
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. |
ServerNetworkInterface class relationships and attributes
The following tables list the relationships and attributes of the ServerNetworkInterface class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
destinationEndPointNetworkPath | 0..* |
| |
lbPoolEntry | 0..* | Associated load balancer pool entry | |
logicalDataCenterServerFarmEntry | 0..* |
| |
server | 1 | Associated server | |
sourceEndPointNetworkPath | 0..* |
| |
switchPort | 0..1 | Associated server switch port | |
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. The default value is false. |
nicNumber | Integer | 0..1 | NIC number |
provisioningSource | 1 | Provisioning source for the server network interface | |
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 |