Network class (Provider API)
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
The Network class has no basic APIs.
Operation APIs
The Network class has no operation APIs.
Relationship APIs
The Network class has no relationship APIs.
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 | |
networkContainer | 0..* | Associated network containers | |
pod | 0..1 | Pod associated with the network | |
sourceNetworkPath | 0..* | Associated source network paths | |
zones | 0..* | Zones associated with the network | |
destinationEndPointNetworkPath | 0..* |
| |
sourceEndPointNetworkPath | 0..* |
|
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 |