3.1.5.8 logicalNetworks

  • Article

The logicalNetworks resource represents a logical partition of physical network that is dedicated for a specific purpose. A logical network comprises of a collection of logical subnets.

It is invoked through the following URI.

 https://<url>/networking/v1/logicalNetworks/{resourceId}

url: The address or name of the REST server of the Network Controller.

resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, v1 or later, in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.8.1.1

Create a new logicalNetworks resource or update an existing logicalNetworks resource.

GET

3.1.5.8.1.2

Get one logicalNetworks resource.

GET ALL

3.1.5.8.1.3

List all logicalNetworks resources in the Network Controller.

DELETE

3.1.5.8.1.4

Deletes a logicalNetworks resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

subnets

Optional

Indicates the subnets that are contained in the logical network. See subnets resource, section 3.1.5.8.2, for full details on this element.

networkVirtualizationEnabled

Optional

Indicates if the logical network is enabled to be the Provider Address (underlay) network for one or more virtual networks. Valid values are TRUE or FALSE. The default is FALSE.

virtualNetworks

Read-only

Indicates an array of virtualNetworks resources that are using the network.