LogicalCommunicationPath class
The LogicalCommunicationPath class represents a logical communication path.
LogicalCommunicationPath class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the LogicalCommunicationPath class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a LogicalCommunicationPath object. | |
update | POST | Updates a LogicalCommunicationPath object. | |
search | POST | Searches for LogicalCommunicationPath objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
bulkCreate | POST | Creates multiple logical communication paths. | |
bulkDecommission | POST | Decommissions multiple logical communication paths. | |
bulkDelete | POST | Deletes multiple logical communication paths. |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the destinationComputeContainerNetworkInterface relationship. | |
relation | GET | Retrieves the destinationLogicalCommunicationPath relationship. | |
relation | GET | Retrieves the destinationLogicalNetwork relationship. | |
relation | GET | Retrieves the destinationLogicalServerFarm relationship. | |
relation | GET | Retrieves the destinationSoftwareContainerNetworkInterface relationship. | |
relation | GET | Retrieves the functionalComponentConnection relationship. | |
relation | GET | Retrieves the loadBalancingServiceNetworkInterface relationship. | |
relation | GET | Retrieves the logicalHostingEnvironment relationship. | |
relation | GET | Retrieves the resourceNetworkPath relationship. | |
relation | GET | Retrieves the runningSoftware relationship. | |
relation | GET | Retrieves the softwareContainer relationship. | |
relation | GET | Retrieves the sourceComputeContainerNetworkInterface relationship. | |
relation | GET | Retrieves the sourceLogicalCommunicationPath relationship. | |
relation | GET | Retrieves the sourceLogicalNetwork relationship. | |
relation | GET | Retrieves the sourceSoftwareContainerNetworkInterface relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
LogicalCommunicationPath class relationships and attributes
The following tables list the relationships and attributes of the LogicalCommunicationPath class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
destinationComputeContainerNetworkInterface | 0..1 | Destination compute container network interface | |
destinationLogicalCommunicationPath | 0..* |
| |
destinationLogicalNetwork | 0..1 | Destination logical network | |
destinationLogicalServerFarm | 0..1 |
| |
destinationSoftwareContainerNetworkInterface | 0..1 |
| |
functionalComponentConnection | 0..* | Associated functional component connections | |
loadBalancingServiceNetworkInterface | 0..* | Associated load balancing service network interfaces | |
logicalHostingEnvironment | 1 | Associated logical hosting environment | |
resourceNetworkPath | 1 | Associated resource network path | |
runningSoftware | 0..1 |
| |
softwareContainer | 0..1 |
| |
sourceComputeContainerNetworkInterface | 0..1 | Source compute container network interface | |
sourceLogicalCommunicationPath | 0..* |
| |
sourceLogicalNetwork | 0..1 | Source logical network | |
sourceSoftwareContainerNetworkInterface | 0..1 |
| |
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 |
isEnabled | Boolean | 1 | Indicates whether the logical communication path is enabled |
isHidden | Boolean | 1 | Indicates whether the logical communication path is enabled |
isLocked | Boolean | 1 | Indicates whether the logical communication path is enabled |
isLogged | Boolean | 1 | Indicates whether the logical communication path is enabled |
isPermit | Boolean | 1 | Indicates whether traffic is permitted on the logical communication 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 |
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 |