3.1.5.19 virtualNetworkManager

The virtualNetworkManager resource is a singleton resource that configures the virtual network service of the Network Controller. The properties in this resource are global for all virtual networks managed by the Network Controller.

It is invoked through the following URI.

 https://<url>/networking/v1/virtualNetworkManager/configuration

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

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

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.19.1.1

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

GET

3.1.5.19.1.2

Get the virtualNetworkManager 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.

distributedRouterState

Optional

Indicates the state of the built-in distributed router of the virtual network.  Values can be Enable or Disable.  The default value is Enable.

networkVirtualizationProtocol

Optional

Indicates the encapsulation format String values which can be Network Virtualization using Generic Routing Encapsulation (NVGRE) ([RFC7637]) or Virtual Extensible LAN (VXLAN)([RFC7348]). The default value is VXLAN.

VirtualSubnetIdRange

Optional

A structure of type VirtualSubnetIdRange, has the following two properties StartId and EndId. It allows configuration of the server to use a desired range of identifiers for virtual subnets.

This property is supported with URI version v2 or later.

StartId

Optional

Indicates the minimum identifier that the server MUST use for virtual subnets. This value cannot be less than 4096.

This property is supported with URI version v2 or later.

EndId

Optional

Indicates the maximum identifier that the server MUST use for virtual subnets. This value cannot be greater than 16777215.

This property is supported with URI version v2 or later.