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

Operation APIs

The NetworkPath class has no operation APIs.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/NetworkPath/guid/destinationEndpointNetworkPath`	Retrieves the `destinationEndpointNetworkPath` relationship.
relation	`GET`	`csm/NetworkPath/guid/destinationNetwork`	Retrieves the `destinationNetwork` relationship.
relation	`GET`	`csm/NetworkPath/guid/destinationNetworkInterface`	Retrieves the `destinationNetworkInterface` relationship.
relation	`GET`	`csm/NetworkPath/guid/destinationResourceNetwork`	Retrieves the `destinationResourceNetwork` relationship.
relation	`GET`	`csm/NetworkPath/guid/destinationServerFarm`	Retrieves the `destinationServerFarm` relationship.
relation	`GET`	`csm/NetworkPath/guid/destinationServerNetworkInterface`	Retrieves the `destinationServerNetworkInterface` relationship.
relation	`GET`	`csm/NetworkPath/guid/destinationSoftwareContainerNetworkInterface`	Retrieves the `destinationSoftwareContainerNetworkInterface` relationship.
relation	`GET`	`csm/NetworkPath/guid/sourceEndpointNetworkPath`	Retrieves the `sourceEndpointNetworkPath` relationship.
relation	`GET`	`csm/NetworkPath/guid/sourceNetwork`	Retrieves the `sourceNetwork` relationship.
relation	`GET`	`csm/NetworkPath/guid/sourceNetworkInterface`	Retrieves the `sourceNetworkInterface` relationship.
relation	`GET`	`csm/NetworkPath/guid/sourceResourceNetwork`	Retrieves the `sourceResourceNetwork` relationship.
relation	`GET`	`csm/NetworkPath/guid/sourceServerNetworkInterface`	Retrieves the `sourceServerNetworkInterface` relationship.
relation	`GET`	`csm/NetworkPath/guid/sourceSoftwareContainerNetworkInterface`	Retrieves the `sourceSoftwareContainerNetworkInterface` relationship.
relation	`GET`	`csm/NetworkPath/guid/logicalCommunicationPath`	Retrieves the `logicalCommunicationPath` relationship.
relation	`GET`	`csm/NetworkPath/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/NetworkPath/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/NetworkPath/guid/tags`	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- plicity	Description
`destinationEndpointNetworkPath`	`NetworkPath`	0..*
`destinationNetwork`	`Network`	0..1	Associated destination network
`destinationNetworkInterface`	`NetworkInterface`	0..1	Associated destination network interface
`destinationResourceNetwork`	`ResourceNetwork`	0..1
`destinationServerFarm`	`ResourceServerFarm`	0..1
`destinationServerNetworkInterface`	`ServerNetworkInterface`	0..1
`destinationSoftwareContainerNetworkInterface`	`NetworkPath`	0..1
`sourceEndpointNetworkPath`	`NetworkPath`	0..*
`sourceNetwork`	`Network`	0..1	Associated source network
`sourceNetworkInterface`	`NetworkInterface`	0..1	Associated source network interface
`sourceResourceNetwork`	`ResourceNetwork`	0..1
`sourceServerNetworkInterface`	`ServerNetworkInterface`	0..1
`sourceSoftwareContainerNetworkInterface`	`NetworkPath`	0..1
`logicalCommunicationPath`	`LogicalCommunicationPath`	0..*	Associated logical communication paths
`tickets`	`Ticket`	0..*
`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
`creationSource`	`SecurityRuleSourceType`
`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`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object