Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

(PUT) /cloud/vlans/{ID}

Edits VLAN ranges that are reserved for Veeam Cloud Connect Replication on the virtual switch with the specified ID.

Request

To edit VLANs, you need to send the PUT HTTP request to the URL of the /cloud/vlans/{ID} resource.

HTTP Request

PUT http://<Enterprise-Manager>:9399/api/cloud/vlans/{ID}

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

Accept

False

The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

Request Body

In the request body, the client must send parameters for the VLAN configuration resource that must be updated. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager RESTful API.

The request body must contain the following elements:

Element

Type

Description

Modifiable

Min/Max Occurrence

HostRef

HierarchyObjRef

Reference to the host on which the virtual switch with VLAN ranges is configured, for example: urn:VMware:Host:4a3f28d9-d4f3-4e4c-9afb-91db8ab57436.host-438.

No

0/1

PlatformType

String

Platform of the virtualization host on which the virtual switch is configured. Possible values:

  • VMware
  • HyperV

No

0/1

VlanIdsWithInternetLeftBound

Int

The first VLAN ID in the range of VLANs that will be used for providing networks with internet access to tenant VM replicas.

Yes

0/1

VlanIdsWithInternetRightBound

Int

The last VLAN ID in the range of VLANs that will be used for providing networks with internet access to tenant VM replicas.

Yes

0/1

VlanIdsWithoutInternetLeftBound

Int

The first VLAN ID in the range of VLANs that will be used for providing networks without internet access to tenant VM replicas.

Yes

0/1

VlanIdsWithoutInternetRightBound

Int

The last VLAN ID in the range of VLANs that will be used for providing networks without internet access to tenant VM replicas.

Yes

0/1

SwitchName

String

Name of the virtual switch on which VLAN ranges are configured, for example: vSwitch0.

No

0/1

SwitchId

String

ID of the virtual switch on which VLAN ranges are configured, for example: vSwitch0.

No

0/1

SwitchType

String

Type of the virtual switch on which VLAN ranges are configured. Possible values:

  • VirtualSwitch
  • DistributedVirtualSwitch

No

0/1

For example:

<?xml version="1.0" encoding="utf-8"?>
<VlanConfiguration Name="vSwitch0" UID="78c6a038-38a2-4908-ac19-1540f9448533" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <HostRef>urn:VMware:Host:4a3f28d9-d4f3-4e4c-9afb-91db8ab57436.host-438</HostRef>
 <PlatformType>VMware</PlatformType>
 <VlanIdsWithInternetLeftBound>500</VlanIdsWithInternetLeftBound>
 <VlanIdsWithInternetRightBound>510</VlanIdsWithInternetRightBound>
 <VlanIdsWithoutInternetLeftBound>511</VlanIdsWithoutInternetLeftBound>
 <VlanIdsWithoutInternetRightBound>520</VlanIdsWithoutInternetRightBound>
 <SwitchName>vSwitch0</SwitchName>
 <SwitchId>vSwitch0</SwitchId>
 <SwitchType>VirtualSwitch</SwitchType>
</VlanConfiguration>

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 202 Accepted.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

  • application/xml
  • application/json

Response Body

None.

Example

The example below updates ranges of VLANs with and without internet access on the virtual switch that has ID 78c6a038-38a2-4908-ac19-1540f9448533.

Request:

PUT http://localhost:9399/api/cloud/vlans/78c6a038-38a2-4908-ac19-1540f9448533

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<VlanConfiguration Name="vSwitch0" UID="78c6a038-38a2-4908-ac19-1540f9448533" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <HostRef>urn:VMware:Host:4a3f28d9-d4f3-4e4c-9afb-91db8ab57436.host-438</HostRef>
 <PlatformType>VMware</PlatformType>
 <VlanIdsWithInternetLeftBound>490</VlanIdsWithInternetLeftBound>
 <VlanIdsWithInternetRightBound>510</VlanIdsWithInternetRightBound>
 <VlanIdsWithoutInternetLeftBound>511</VlanIdsWithoutInternetLeftBound>
 <VlanIdsWithoutInternetRightBound>530</VlanIdsWithoutInternetRightBound>
 <SwitchName>vSwitch0</SwitchName>
 <SwitchId>vSwitch0</SwitchId>
 <SwitchType>VirtualSwitch</SwitchType>
</VlanConfiguration>

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>UpdateVlanConfiguration</Operation>
</Task>

To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:

Request:

GET http://localhost:9399/api/tasks/task-1

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>UpdateVlanConfiguration</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation