LogicalNetwork class

The LogicalNetwork class represents a logical network.

LogicalNetwork class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the LogicalNetwork class.

Basic APIs

Name	HTTP method	URI	Description
get	GET	csm/LogicalNetwork/guid	Retrieves a LogicalNetwork object.
search	POST	csm/LogicalNetwork/search	Searches for LogicalNetwork objects.

Operation APIs

The LogicalNetwork class has no operation APIs.

Relationship APIs

Name	HTTP method	URI	Description
relation	GET	csm/LogicalNetwork/guid/computeContainerNetworkInterface	Retrieves the computeContainerNetworkInterface relationship.
relation	GET	csm/LogicalNetwork/guid/destinationLogicalCommunicationPath	Retrieves the destinationLogicalCommunicationPath relationship.
relation	GET	csm/LogicalNetwork/guid/loadBalancingServiceNetworkInterface	Retrieves the loadBalancingServiceNetworkInterface relationship.
relation	GET	csm/LogicalNetwork/guid/logicalAddressPool	Retrieves the logicalAddressPool relationship.
relation	GET	csm/LogicalNetwork/guid/logicalDomainNameSystem	Retrieves the logicalDomainNameSystem relationship.
relation	GET	csm/LogicalNetwork/guid/logicalFirewallInterface	Retrieves the logicalFirewallInterface relationship.
relation	GET	csm/LogicalNetwork/guid/logicalHostingEnvironment	Retrieves the logicalHostingEnvironment relationship.
relation	GET	csm/LogicalNetwork/guid/logicalLoadBalancerInterface	Retrieves the logicalLoadBalancerInterface relationship.
relation	GET	csm/LogicalNetwork/guid/logicalNetworkGroup	Retrieves the logicalNetworkGroup relationship.
relation	GET	csm/LogicalNetwork/guid/logicalRouteTable	Retrieves the logicalRouteTable relationship.
relation	GET	csm/LogicalNetwork/guid/logicalZone	Retrieves the logicalZone relationship.
relation	GET	csm/LogicalNetwork/guid/resourceNetwork	Retrieves the resourceNetwork relationship.
relation	GET	csm/LogicalNetwork/guid/sourceLogicalCommunicationPath	Retrieves the sourceLogicalCommunicationPath relationship.
relation	GET	csm/LogicalNetwork/guid/tickets	Retrieves the tickets relationship.
relation	GET	csm/LogicalNetwork/guid/provider	Retrieves the provider relationship.
relation	GET	csm/LogicalNetwork/guid/tags	Retrieves the tags relationship.

LogicalNetwork class relationships and attributes

The following tables list the relationships and attributes of the LogicalNetwork class.

Relationships

Name	Type	Multi- plicity	Description
computeContainerNetworkInterface	ComputeContainerNetworkInterface	0..*	Associated compute container network interfaces
destinationLogicalCommunicationPath	LogicalCommunicationPath	0..*	Associated destination logical communication paths
loadBalancingServiceNetworkInterface	LoadBalancingServiceNetworkInterface	0..*	Associated load balancing service network interfaces
logicalAddressPool	LogicalAddressPool	0..*
logicalDomainNameSystem	LogicalDomainNameSystem	0..*
logicalFirewallInterface	LogicalFirewallInterface	0..*
logicalHostingEnvironment	LogicalHostingEnvironment	1..*	Associated logical hosting environments
logicalLoadBalancerInterface	LogicalLoadBalancerInterface	0..*
logicalNetworkGroup	LogicalNetworkGroup	1
logicalRouteTable	LogicalRouteTable	0..1
logicalZone	LogicalZone	0..*
resourceNetwork	ResourceNetwork	1..*	Associated resource networks
sourceLogicalCommunicationPath	LogicalCommunicationPath	0..*	Associated source 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
isCustomerNetwork	Boolean	0..1	Indicates whether the network is a customer network.
isEnabled	Boolean	1	Indicates whether the logical network is enabled
isExternal	Boolean	1	Indicates whether the logical network is an external network
isLocked	Boolean	1	Indicates whether the logical network is enabled
isManagementNetwork	Boolean	1	Indicates whether the logical network is a management network
isTemplate	Boolean	0..1
networkAddress	String	0..1	Network address
networkLabel	String	0..1	The {{ NetworkLabel }} identifies a provider-specifc label as represented in it's concrete class. This has been marked as deprecated because it has only been introduced for the support of label-based network placement defined in pre-Stryker service blueprints.
networkMask	String	0..1	Network mask
useExternalDNS	Boolean	0..1
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