This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /cloud/vlans/{ID}
Returns a virtual switch with the specified ID on which VLAN ranges for Veeam Cloud Connect Replication are reserved. VLANs are used for providing networking capabilities to tenant VM replicas. The virtual switch is configured on the virtualization host that is used as a replication target and connected to the Veeam backup server managed by Veeam Backup Enterprise Manager.
Request
To get a virtual switch with the specified ID on which VLAN ranges are configured, you need to send the GET HTTP request to the URL of the /cloud/vlans/{ID} resource.
HTTP Request
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 | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries.
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | String | ID of the virtual switch in the Veeam infrastructure, for example: 510f34ea-1534-437c-a746-f32cf0f712aa. | True | True |
SwitchName | String | Name of the virtual switch, for example: Intel(R) I350 Gigabit Network Connection - Virtual Switch. | True | True |
SwitchType | String | Type of the virtual switch. Possible values:
| True | True |
SwitchId | String | ID of the virtual switch in the virtualization infrastructure, for example: 4670EE6D-66BE-4A1C-A58E-6389CA99BD3E. | True | True |
ClusterName | String | Name of the host or cluster on which the virtual switch with VLAN ranges is configured. | True | True |
ClusterRef | HierarchyObjRef | Reference to the host or cluster on which the virtual switch with VLAN ranges is configured, for example: urn:VMware:Host:4a3f28d9-d4f3-4e4c-9afb-91db8ab57436.host-438. | True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the VLAN configuration resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the VLAN configuration resource. | True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
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:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/vlans/{ID} resource collection.
Example
The example below returns a virtual switch with the ID 78c6a038-38a2-4908-ac19-1540f9448533 on which VLAN ranges are configured.
Request: GET https://localhost:9398/api/cloud/vlans/78c6a038-38a2-4908-ac19-1540f9448533?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <VlanConfiguration xmlns="http://www.veeam.com/ent/v1.0" Name="vSwitch0" UID="78c6a038-38a2-4908-ac19-1540f9448533"> |
