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

Operation APIs

Name	HTTP method	URI	Description
bulkCreate	`POST`	`csm/LogicalCommunicationPath/bulkCreate`	Creates multiple logical communication paths.
bulkDecommission	`POST`	`csm/LogicalCommunicationPath/bulkDecommission`	Decommissions multiple logical communication paths.
bulkDelete	`POST`	`csm/LogicalCommunicationPath/bulkDelete`	Deletes multiple logical communication paths.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/LogicalCommunicationPath/guid/destinationComputeContainerNetworkInterface`	Retrieves the `destinationComputeContainerNetworkInterface` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/destinationLogicalCommunicationPath`	Retrieves the `destinationLogicalCommunicationPath` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/destinationLogicalNetwork`	Retrieves the `destinationLogicalNetwork` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/destinationLogicalServerFarm`	Retrieves the `destinationLogicalServerFarm` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/destinationSoftwareContainerNetworkInterface`	Retrieves the `destinationSoftwareContainerNetworkInterface` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/functionalComponentConnection`	Retrieves the `functionalComponentConnection` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/loadBalancingServiceNetworkInterface`	Retrieves the `loadBalancingServiceNetworkInterface` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/logicalHostingEnvironment`	Retrieves the `logicalHostingEnvironment` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/resourceNetworkPath`	Retrieves the `resourceNetworkPath` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/runningSoftware`	Retrieves the `runningSoftware` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/softwareContainer`	Retrieves the `softwareContainer` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/sourceComputeContainerNetworkInterface`	Retrieves the `sourceComputeContainerNetworkInterface` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/sourceLogicalCommunicationPath`	Retrieves the `sourceLogicalCommunicationPath` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/sourceLogicalNetwork`	Retrieves the `sourceLogicalNetwork` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/sourceSoftwareContainerNetworkInterface`	Retrieves the `sourceSoftwareContainerNetworkInterface` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/LogicalCommunicationPath/guid/tags`	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- plicity	Description
`destinationComputeContainerNetworkInterface`	`ComputeContainerNetworkInterface`	0..1	Destination compute container network interface
`destinationLogicalCommunicationPath`	`LogicalCommunicationPath`	0..*
`destinationLogicalNetwork`	`LogicalNetwork`	0..1	Destination logical network
`destinationLogicalServerFarm`	`LogicalServerFarm`	0..1
`destinationSoftwareContainerNetworkInterface`	`LogicalCommunicationPath`	0..1
`functionalComponentConnection`	`FunctionalComponentConnection`	0..*	Associated functional component connections
`loadBalancingServiceNetworkInterface`	`LoadBalancingServiceNetworkInterface`	0..*	Associated load balancing service network interfaces
`logicalHostingEnvironment`	`LogicalHostingEnvironment`	1	Associated logical hosting environment
`resourceNetworkPath`	`ResourceNetworkPath`	1	Associated resource network path
`runningSoftware`	`RunningSoftware`	0..1
`softwareContainer`	`SoftwareContainer`	0..1
`sourceComputeContainerNetworkInterface`	`ComputeContainerNetworkInterface`	0..1	Source compute container network interface
`sourceLogicalCommunicationPath`	`LogicalCommunicationPath`	0..*
`sourceLogicalNetwork`	`LogicalNetwork`	0..1	Source logical network
`sourceSoftwareContainerNetworkInterface`	`LogicalCommunicationPath`	0..1
`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
`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`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object