Network class
The Network class represents a collection of virtual local area networks (VLANs) with a stated purpose such as management or data storage. This is a transient object created by querying BMC Network Automation.
Network class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the Network class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a Network object. | |
search | POST | Searches for Network objects. |
Operation APIs
The Network class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the destinationNetworkPath relationship. | |
relation | GET | Retrieves the logicalDataCenter relationship. | |
relation | GET | Retrieves the networkContainer relationship. | |
relation | GET | Retrieves the networkInterface relationship. | |
relation | GET | Retrieves the pod relationship. | |
relation | GET | Retrieves the sourceNetworkPath relationship. | |
relation | GET | Retrieves the switchPort relationship. | |
relation | GET | Retrieves the zones relationship. | |
relation | GET | Retrieves the destinationEndPointNetworkPath relationship. | |
relation | GET | Retrieves the logicalNetwork relationship. | |
relation | GET | Retrieves the resourceDomainNameSystem relationship. | |
relation | GET | Retrieves the resourceNetworkInterface relationship. | |
relation | GET | Retrieves the sourceEndPointNetworkPath relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
Network class relationships and attributes
The following tables list the relationships and attributes of the Network class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
destinationNetworkPath | 0..* | Associated destination network paths | |
logicalDataCenter | 0..1 | Associated logical data center | |
networkContainer | 0..* | Associated network containers | |
networkInterface | 0..* | Associated network interfaces | |
pod | 0..1 | Pod associated with the network | |
sourceNetworkPath | 0..* | Associated source network paths | |
switchPort | 0..* | Associated switch ports | |
zones | 0..* | Zones associated with the network | |
destinationEndPointNetworkPath | 0..* |
| |
logicalNetwork | 0..* | Associated logical networks | |
resourceDomainNameSystem | 0..* |
| |
resourceNetworkInterface | 0..* |
| |
sourceEndPointNetworkPath | 0..* |
| |
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 |
|---|---|---|---|
defaultGateway | String | 0..1 |
|
networkLabel | String | 1 | Logical name of the network. The name usually denotes the network purpose. |
vlanID | String | 0..1 | Identifier of the VLAN underlying the Network |
isCustomerNetwork | Boolean | 1 |
|
isEnabled | Boolean | 1 |
|
isExternal | Boolean | 1 |
|
isLocked | Boolean | 1 |
|
isManagementNetwork | Boolean |
|
|
isTemplate | Boolean | 1 |
|
networkAddress | String | 0..1 |
|
networkMask | String | 0..1 |
|
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 |