GET /query?type=VlanConfiguration
Returns a resource representation of a collection of all virtual switches on which VLAN ranges for Veeam Cloud Connect Replication are reserved. For details, see /cloud/vlans.
Request
To get a list of virtual switches with configured VLAN ranges, send the GET HTTP request to the query with the type parameter set to VlanConfiguration.
HTTP Request
|
GET https://<Enterprise-Manager>:9398/api/query?type=VlanConfiguration |
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. For details, 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.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
|
Parameter |
Type |
Description |
|---|---|---|
|
UID |
String |
ID of the virtual switch in the Veeam infrastructure, for example: 510f34ea-1534-437c-a746-f32cf0f712aa. |
|
SwitchName |
String |
Name of the virtual switch, for example: Intel(R) I350 Gigabit Network Connection - Virtual Switch. |
|
SwitchType |
String |
Type of the virtual switch. Possible values:
|
|
SwitchId |
String |
ID of the virtual switch in the virtualization infrastructure, for example: 4670EE6D-66BE-4A1C-A58E-6389CA99BD3E. |
|
ClusterName |
String |
Name of the host or cluster on which the virtual switch with VLAN ranges is configured. |
|
ClusterRef |
HierarchyObjRefType |
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. You can construct the reference manually or use the lookup service to retrieve the reference. |
|
BackupServerUid |
UidType |
UID of the backup server parent to the VLAN configuration resource. |
|
BackupServerName |
String |
Name of the backup server parent to the VLAN configuration resource. |
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, the REST API returns a representation of the //cloud/vlans resource collection.
Example
The example below returns an entity resource representation of a collection of virtual switches that were added on the backup server that has ID ca19249e-e638-421a-ab22-68cb89b9009a. The results are ordered in the acceding order by the SwitchName parameter.
|
Request: GET https://localhost:9398/api/query?type=VlanConfiguration&format=Entities&sortAsc=SwitchName&filter=BackupServerUid=="ca19249e-e638-421a-ab22-68cb89b9009a" Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |