This is an archive version of the document. To get the most up-to-date information, see the current version.

(GET) /cloud/vlans

In this article

    Returns a resource representation of a collection of all virtual switches on which VLAN ranges for Veeam Cloud Connect Replication are reserved. VLANs are used for providing networking capabilities to tenant VM replicas. Virtual switches are configured on virtualization hosts that are used as a replication target and connected to Veeam backup servers managed by Veeam Backup Enterprise Manager.

    Request

    To get a list of virtual switches with configured VLAN ranges, you need to send the GET HTTP request to the URL of the /cloud/vlans resource.

    HTTP Request

    GET http://<Enterprise-Manager>:9399/api/cloud/vlans

    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.

    Request Body

    None.

    Query Parameters

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 Success.

    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: application/xml.

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/vlans resource collection.

    Example

    The example below returns a list of virtual switches with configured VLAN ranges. Virtual switches are configured on virtualization hosts that are used as a replication target and connected to Veeam backup servers managed by Veeam Backup Enterprise Manager.

    Request:

    GET http://localhost:9399/api/cloud/vlans

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 Success

     

    Response Body:

    <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
     <Ref Type="VlanConfigurationReference" Href="http://localhost:9399/api/cloud/vlans/78c6a038-38a2-4908-ac19-1540f9448533" Name="vSwitch0" UID="urn:veeam:VlanConfiguration:78c6a038-38a2-4908-ac19-1540f9448533">
       <Links>
         <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
         <Link Rel="Alternate" Type="VlanConfiguration" Href="http://localhost:9399/api/cloud/vlans/78c6a038-38a2-4908-ac19-1540f9448533?format=Entity" Name="vSwitch0" />
       </Links>
     </Ref>
     <Ref Type="VlanConfigurationReference" Href="http://localhost:9399/api/cloud/vlans/510f34ea-1534-437c-a746-f32cf0f712aa" Name="Intel(R) I350 Gigabit Network Connection - Virtual Switch" UID="urn:veeam:VlanConfiguration:510f34ea-1534-437c-a746-f32cf0f712aa">
       <Links>
         <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
         <Link Rel="Alternate" Type="VlanConfiguration" Href="http://localhost:9399/api/cloud/vlans/510f34ea-1534-437c-a746-f32cf0f712aa?format=Entity" Name="Intel(R) I350 Gigabit Network Connection - Virtual Switch" />
       </Links>
     </Ref>
    </EntityReferences>