NetworkPath class (Provider API)

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

create

POST

csm/NetworkPath

Creates a NetworkPath object.

delete

DELETE

csm/NetworkPath/guid

Deletes a NetworkPath object.

Operation APIs

The NetworkPath class has no operation APIs.

Relationship APIs

The NetworkPath class has no relationship APIs.

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

destinationSoftwareContainerNetworkInterface

NetworkPath

0..1

sourceEndpointNetworkPath

NetworkPath

0..*

sourceNetwork

Network

0..1

Associated source network

sourceSoftwareContainerNetworkInterface

NetworkPath

0..1

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

Was this page helpful? Yes No Submitting... Thank you

Comments