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

(PUT) /cloud/tenants/{ID}

In this article

    Edits settings of a tenant account with the specified ID.

    Request

    To edit settings of the tenant account, you need to send the PUT HTTP request to the URL of the /cloud/tenants/{ID} resource.

    HTTP Request

    PUT http://<Enterprise-Manager>:9399/api/cloud/tenants/{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.

    Request Body

    In the request body, the client must send parameters for the tenant account whose settings 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

    Password

    String

    Password for the tenant account.

    Yes

    0/1

    Description

    String

    Description for the tenant account.

    Yes

    0/1

    Enabled

    Boolean

    Defines if the tenant account must be in the enabled or disabled state.

    Yes

    0/1

    LeaseExpirationDate

    DateTime

    Defines the expiration date of the lease period for the tenant account.

    Yes

    1/1

    CloudTenantResource

    CloudTenant
    Resource

    Defines the storage quota on the cloud backup repository that must be assigned to the tenant. You can assign several storage quotas on different cloud repositories to one tenant. To learn more about storage quota settings, see Cloud Tenant Resources.

    No

    1/1

    CloudTenantComputeResource

    CloudTenantComputeResource

    Defines the hardware plan to which the tenant must be subscribed. You can subscribe one tenant to one or several hardware plans that utilize resources of the same virtualization platform — VMware vSphere or Microsoft Hyper-V. To learn more about storage quota settings, see Cloud Tenant Compute Resources.

    No

    1/1

    For example:

    <?xml version="1.0" encoding="utf-8"?>
    <CloudTenant Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/b25f5f1d-a3c3-45ed-af23-9ef31a94dac7?format=Entity" Name="ABC Company" UID="urn:veeam:CloudTenant:b25f5f1d-a3c3-45ed-af23-9ef31a94dac7" 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">
     <Password/>
     <Description>Tenant account for ABC Company</Description>
     <Enabled>true</Enabled>
     <LeaseOptions Enabled="false"/>
     <Resources>
       <CloudTenantResource Type="CloudTenantResource" Href="http://localhost:9399/api/cloud/tenants/b25f5f1d-a3c3-45ed-af23-9ef31a94dac7/resources/2fcc7f11-2a33-448d-a242-ba8f0618c97b" Id="2fcc7f11-2a33-448d-a242-ba8f0618c97b">
         <RepositoryQuota>
           <DisplayName>ABC Cloud Vol1</DisplayName>
           <RepositoryUid>urn:veeam:Repository:a0f35f34-8d58-4470-b52d-071e1417732a</RepositoryUid>
           <WanAcceleratorUid>urn:veeam:WanAccelerator:34ebeeb4-75d0-4e71-b315-fbc16eb2975f</WanAcceleratorUid>
           <Quota>307200</Quota>
         </RepositoryQuota>
       </CloudTenantResource>
       <CloudTenantResource Type="CloudTenantResource" Href="http://localhost:9399/api/cloud/tenants/b25f5f1d-a3c3-45ed-af23-9ef31a94dac7/resources/8c6aa6b6-4668-4f81-9729-60c56b9b300b" Id="8c6aa6b6-4668-4f81-9729-60c56b9b300b">
         <RepositoryQuota>
           <DisplayName>Cloud Repository 2</DisplayName>
           <RepositoryUid>urn:veeam:Repository:0a9c15f5-bc17-4848-a14b-b2ec3f9919ea</RepositoryUid>
           <Quota>102400</Quota>
         </RepositoryQuota>
       </CloudTenantResource>
     </Resources>
     <LastActive>2016-01-04T21:12:52Z</LastActive>
     <ComputeResources>
       <CloudTenantComputeResource Type="CloudTenantComputeResource" Href="http://localhost:9399/api/cloud/tenants/b25f5f1d-a3c3-45ed-af23-9ef31a94dac7/computeResources/25f485fd-06e3-4ee2-9703-465c4d8c2fae" Id="25f485fd-06e3-4ee2-9703-465c4d8c2fae">
         <CloudHardwarePlanUid>urn:veeam:CloudHardwarePlan:91156f8d-8bd3-44af-bec3-b6ac2ea24288</CloudHardwarePlanUid>
         <WanAcceleratorUid>urn:veeam:WanAccelerator:34ebeeb4-75d0-4e71-b315-fbc16eb2975f</WanAcceleratorUid>
         <PlatformType>VMware</PlatformType>
         <UseNetworkFailoverResources>true</UseNetworkFailoverResources>
         <NetworkAppliance>
           <Name>Cloud Appliance ABC Company(esx01)</Name>
           <ProductionNetwork>VM Network</ProductionNetwork>
           <ObtainIPAddressAutomatically>true</ObtainIPAddressAutomatically>
         </NetworkAppliance>
         <ComputeResourceStats>
           <MemoryUsageMb>8192</MemoryUsageMb>
           <CPUCount>2</CPUCount>
           <StorageResourceStats>
             <StorageResourceStat>
               <StorageName>Cloud Replicas</StorageName>
               <StorageUsageGb>35</StorageUsageGb>
               <StorageLimitGb>300</StorageLimitGb>
             </StorageResourceStat>
           </StorageResourceStats>
         </ComputeResourceStats>
       </CloudTenantComputeResource>
     </ComputeResources>
     <ThrottlingEnabled>false</ThrottlingEnabled>
     <ThrottlingSpeedLimit>10</ThrottlingSpeedLimit>
     <ThrottlingSpeedUnit>MBps</ThrottlingSpeedUnit>
     <PublicIpCount>2</PublicIpCount>
     <BackupCount>1</BackupCount>
     <ReplicaCount>2</ReplicaCount>
    </CloudTenant>

    Cloud Tenant Resources

    You can specify the following settings for the tenant resource:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    DisplayName

    String

    Friendly name of the cloud repository.

    Yes

    1/1

    RepositoryUid

    URN

    ID of the backup repository on which the storage quota must be created.

    Yes

    1/1

    WanAcceleratorUid

    URN

    ID of the WAN accelerator that must be used as a target WAN accelerator with the cloud repository. This parameter must be specified if you want tenants to work with the cloud repository via WAN accelerators.

    Yes

    0/1

    Quota

    Int

    Size of the storage quota assigned to the user on the cloud repository (in MB).

    Yes

    1/1

    For example:

    <Resources>
     <CloudTenantResource Type="CloudTenantResource" Href="http://localhost:9399/api/cloud/tenants/72573c8f-0d94-48c3-aa17-c9ee6f3f7dd0/resources/0a229d79-10f7-48e3-a1d3-42072745eaf2" Id="0a229d79-10f7-48e3-a1d3-42072745eaf2">
       <RepositoryQuota>
         <DisplayName>Cloud repository</DisplayName>
         <RepositoryUid>urn:veeam:Repository:faa06130-e5fb-43bc-ae1d-f4578a46a38c</RepositoryUid>
         <WanAcceleratorUid>urn:veeam:WanAccelerator:8d079e62-c2a6-430c-b73a-f89f6f9fb5a8</WanAcceleratorUid>
         <Quota>10240</Quota>
       </RepositoryQuota>
     </CloudTenantResource>
    </Resources>

    Cloud Tenant Compute Resources

    You can specify the following settings for the tenant compute resource:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    CloudHardwarePlanUid

    String

    ID of the hardware plan to which the tenant must be subscribed, for example: urn:veeam:CloudHardwarePlan:127e652e-e02e-4951-99e7-03280edfe536.

    Yes

    1/1

    WanAcceleratorUid

    URN

    ID of the WAN accelerator that must be used as a target WAN accelerator with the cloud host presented by the hardware plan. This parameter must be specified if you want tenants to work with cloud hosts via WAN accelerators.

    Yes

    0/1

    PlatformType

    String

    Platform for which the hardware plan to which the tenant account is subscribed has been created. Possible values:

    • VMware
    • HyperV

    Yes

    1/1

    UseNetworkFailoverResources

    Boolean

    Defines whether the network extension appliance must be deployed for the tenant account subscribed to the hardware plan.

    Yes

    1/1

    For example:

    <ComputeResources>
     <CloudTenantComputeResource Type="CloudTenantComputeResource" Href="http://localhost:9399/api/cloud/tenants/b25f5f1d-a3c3-45ed-af23-9ef31a94dac7/computeResources/25f485fd-06e3-4ee2-9703-465c4d8c2fae" Id="25f485fd-06e3-4ee2-9703-465c4d8c2fae">
       <CloudHardwarePlanUid>urn:veeam:CloudHardwarePlan:91156f8d-8bd3-44af-bec3-b6ac2ea24288</CloudHardwarePlanUid>
       <WanAcceleratorUid>urn:veeam:WanAccelerator:34ebeeb4-75d0-4e71-b315-fbc16eb2975f</WanAcceleratorUid>
       <PlatformType>VMware</PlatformType>
       <UseNetworkFailoverResources>true</UseNetworkFailoverResources>
       <NetworkAppliance>
         <Name>Cloud Appliance ABC Company(esx01)</Name>
         <ProductionNetwork>VM Network</ProductionNetwork>
         <ObtainIPAddressAutomatically>true</ObtainIPAddressAutomatically>
       </NetworkAppliance>
       <ComputeResourceStats>
         <MemoryUsageMb>8192</MemoryUsageMb>
         <CPUCount>2</CPUCount>
         <StorageResourceStats>
           <StorageResourceStat>
             <StorageName>Cloud Replicas</StorageName>
             <StorageUsageGb>35</StorageUsageGb>
             <StorageLimitGb>300</StorageLimitGb>
           </StorageResourceStat>
         </StorageResourceStats>
       </ComputeResourceStats>
     </CloudTenantComputeResource>
    </ComputeResources>

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

    Response Body

    None.

    Example

    The example below updates the description and password settings for the tenant account with ID 4f90635a-7ecc-49fe-beb6-60b37eb4bd89.

    Request:

    PUT http://localhost:9399/api/cloud/tenants/4f90635a-7ecc-49fe-beb6-60b37eb4bd89

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <CloudTenant Type="CloudTenant" Href="http://localhost:9399/api/cloud/tenants/4f90635a-7ecc-49fe-beb6-60b37eb4bd89?format=Entity" Name="ABC Company" UID="urn:veeam:CloudTenant:4f90635a-7ecc-49fe-beb6-60b37eb4bd89" 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">
     <Password/>
     <Description>Tenant Account for ABC Company</Description>
    </CloudTenant>

     

    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>EditCloudTenant</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>EditCloudTenant</Operation>
     <Result Success="true">
       <Message>Ok</Message>
     </Result>
    </Task>