NetworkPath class
The NetworkPath class represents a network path. A network path embodies a source, a destination, and a rule for all the firewalls between the source and destination.
NetworkPath class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the NetworkPath class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a NetworkPath object. | |
search | POST | Searches for NetworkPath objects. |
Operation APIs
The NetworkPath class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the destinationEndpointNetworkPath relationship. | |
relation | GET | Retrieves the destinationNetwork relationship. | |
relation | GET | Retrieves the destinationNetworkInterface relationship. | |
relation | GET | Retrieves the destinationResourceNetwork relationship. | |
relation | GET | Retrieves the destinationServerFarm relationship. | |
relation | GET | Retrieves the destinationServerNetworkInterface relationship. | |
relation | GET | Retrieves the destinationSoftwareContainerNetworkInterface relationship. | |
relation | GET | Retrieves the sourceEndpointNetworkPath relationship. | |
relation | GET | Retrieves the sourceNetwork relationship. | |
relation | GET | Retrieves the sourceNetworkInterface relationship. | |
relation | GET | Retrieves the sourceResourceNetwork relationship. | |
relation | GET | Retrieves the sourceServerNetworkInterface relationship. | |
relation | GET | Retrieves the sourceSoftwareContainerNetworkInterface relationship. | |
relation | GET | Retrieves the logicalCommunicationPath relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
NetworkPath class relationships and attributes
The following tables list the relationships and attributes of the NetworkPath class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
destinationEndpointNetworkPath | 0..* |
| |
destinationNetwork | 0..1 | Associated destination network | |
destinationNetworkInterface | 0..1 | Associated destination network interface | |
destinationResourceNetwork | 0..1 |
| |
destinationServerFarm | 0..1 |
| |
destinationServerNetworkInterface | 0..1 |
| |
destinationSoftwareContainerNetworkInterface | 0..1 |
| |
sourceEndpointNetworkPath | 0..* |
| |
sourceNetwork | 0..1 | Associated source network | |
sourceNetworkInterface | 0..1 | Associated source network interface | |
sourceResourceNetwork | 0..1 |
| |
sourceServerNetworkInterface | 0..1 |
| |
sourceSoftwareContainerNetworkInterface | 0..1 |
| |
logicalCommunicationPath | 0..* | Associated logical communication paths | |
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 |
|---|---|---|---|
creationSource |
|
| |
destinationIPAddress | String | 0..1 | Destination IP address |
destinationNetworkAddress | String | 0..1 | Destination network address |
destinationNetworkMask | String | 0..1 | Destination network mask |
destinationPort | Integer | 0..1 | Destination port |
destinationPortRange | String | 0..1 | Destination port range |
isEnabled | Boolean | 1 | Indicates whether the network path is enabled. |
isHidden | Boolean | 1 | Indicates whether the network path is enabled. |
isLocked | Boolean | 1 | Indicates whether the network path is enabled. |
isLogged | Boolean | 1 | Indicates whether the network path is enabled. |
isPermit | Boolean | 1 | Indicates whether traffic is permitted or denied on the network path. |
sourceIPAddress | String | 0..1 | Source IP address |
sourceNetworkAddress | String | 0..1 | Source network address |
sourceNetworkMask | String | 0..1 | Source network mask |
sourcePort | Integer | 0..1 | Source port |
transportProtocol | Integer | 0..1 | Transport protocol identifier |
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 |