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 method	URI	Description
get	`GET`	`csm/Network/guid`	Retrieves a `Network` object.
search	`POST`	`csm/Network/search`	Searches for `Network` objects.

Operation APIs

The Network class has no operation APIs.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/Network/guid/destinationNetworkPath`	Retrieves the `destinationNetworkPath` relationship.
relation	`GET`	`csm/Network/guid/logicalDataCenter`	Retrieves the `logicalDataCenter` relationship.
relation	`GET`	`csm/Network/guid/networkContainer`	Retrieves the `networkContainer` relationship.
relation	`GET`	`csm/Network/guid/networkInterface`	Retrieves the `networkInterface` relationship.
relation	`GET`	`csm/Network/guid/pod`	Retrieves the `pod` relationship.
relation	`GET`	`csm/Network/guid/sourceNetworkPath`	Retrieves the `sourceNetworkPath` relationship.
relation	`GET`	`csm/Network/guid/switchPort`	Retrieves the `switchPort` relationship.
relation	`GET`	`csm/Network/guid/zones`	Retrieves the `zones` relationship.
relation	`GET`	`csm/Network/guid/logicalNetwork`	Retrieves the `logicalNetwork` relationship.
relation	`GET`	`csm/Network/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/Network/guid/tags`	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- plicity	Description
`destinationNetworkPath`	`NetworkPath`	0..*	Associated destination network paths
`logicalDataCenter`	`LogicalDataCenter`	0..1	Associated logical data center
`networkContainer`	`NetworkContainer`	0..*	Associated network containers
`networkInterface`	`NetworkInterface`	0..*	Associated network interfaces
`pod`	`Pod`	0..1	Pod associated with the network
`sourceNetworkPath`	`NetworkPath`	0..*	Associated source network paths
`switchPort`	`SwitchPort`	0..*	Associated switch ports
`zones`	`Zone`	0..*	Zones associated with the network
`logicalNetwork`	`LogicalNetwork`	0..*	Associated logical networks
`cloudClass`	`CloudClass`	1	Fully-qualified name of the class to which the object belongs
`provider`	`Provider`	1	Provider that created the object
`tags`	`Tag`	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
`defaultGateway`	`String`	0..1
`isCustomerNetwork`	`Boolean`	1	Indicates whether the network is a customer network.
`isEnabled`	`Boolean`	1	Indicates whether the network is enabled.
`isExternal`	`Boolean`	1	Indicates whether the network is an external network.
`isLocked`	`Boolean`	1	Indicates whether the network is locked.
`isManagementNetwork`	`Boolean`	1	Indicates whether the network is a management network.
`isTemplate`	`Boolean`	1	Indicates whether the network is a template.
`networkAddress`	`String`	0..1	Address range. For example, `192.168.1.1/24`
`networkLabel`	`String`	1	Logical name of the network. The name usually denotes the network purpose.
`networkMask`	`String`	0..1	Network mask
`totalVLANs`	`Integer`	0..1	Total number of VLANs
`vlanID`	`String`	0..1	Identifier of the VLAN underlying the Network
`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
`name`	`String`	1	Human-readable name of the object