PUT /selfService/vSphere/Configs/{ID}

In this article

    Edits settings of a tenant access configuration with the specified ID.

    Request

    To edit settings of the tenant access configuration, you need to send the PUT HTTP request to the URL of the /selfService/vSphere/Configs/{ID} resource.  

    HTTP Request

    PUT https://<Enterprise-Manager>:9398/api/selfService/vSphere/Configs/{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. For details, see Authentication and Security.

    Content-Type

    True

    Identifies the format of the request body message. Possible values:

    • application/xml
    • application/json

    Accept

    False

    Identifies the format of the response. Possible values:

    • application/xml — the client can send this value in the header to accept response in the XML format.
    • application/json — the client must send this value in the header to accept the request in the JSON format.

    If the request does not contain the header, the server will return the response in the XML format.

    Request Body

    In the request body, the client must send parameters for the tenant access configuration whose settings must be updated. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager REST API.

    The request body must contain the following elements:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    BackupServerUid

    URN

    ID of the backup server that must process VMs available to the tenant of the vSphere Self-Service Backup Portal, for example: urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222.

    False

    1/1

    RepositoryUid

    URN

    ID of the backup repository on which the storage quota for the tenant of the portal must be created, for example: urn:veeam:Repository:82db96c3-445c-4a7e-9587-f2d523e839f4.

    Yes

    1/1

    QuotaGb

    Long

    Size of the storage quota assigned to the tenant (in GB).

    Yes

    1/1

    PerUser

    Boolean

    Defines whether users of the group for which the tenant access configuration is created will have separate quotas on the backup repository and what backup jobs will be available to users. Possible values:

    • True — each user of the group has a separate quota on the backup repository. Each user has access to backup jobs created by this user only.
    • False — all users of the group share the same quota on the backup repository. Each user has access to all backup jobs created by users of the group.

    Yes

    0/1

    Account

    VSphereSelfServiceConfigAccountInfoType

    Specifies the tenant access configuration settings. For details, see vSphere Self-Service Account Settings

    False

    1/1

    JobSettings

    VSphereSelfServiceConfigEntityTypeJobSettings

    vSphere backup job options set for the organization. For details, see vSphere Self-Service Backup Job Settings.

    Yes

    1/1

    Tags

    TagsListType

    vSphere tags that define what VMs will be available to the tenant. For details, see vSphere Tags.

    Yes

    0/1

    For example:

    XML Representation

    <VSphereSelfServiceConfig Href="https://localhost:9398/api/selfService/vSphere/Configs/21774252-e680-49ce-9f99-6764a8b84440?format=Entity" Type="VSphereSelfServiceConfig" Name="Domain Users" UID="urn:veeam:VSphereSelfServiceConfig:21774252-e680-49ce-9f99-6764a8b84440" 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">
     <BackupServerUid>urn:veeam:BackupServer:8c88c6d6-931f-4044-8c0b-7a0c5f188b00</BackupServerUid>
     <RepositoryUid>urn:veeam:Repository:44f0b2ba-9bff-4cd0-8d34-5b11e5d17fe9</RepositoryUid>
     <QuotaGb>30</QuotaGb>
     <PerUser>true</PerUser>
     <Account>
       <AccountName>Domain Users</AccountName>
       <AccountSid>S-1-5-21-2710250414-1144789048-1111555807-513</AccountSid>
       <AccountType>Group</AccountType>
     </Account>
     <JobSettings>
       <DefaultSettings>true</DefaultSettings>
       <JobSchedulerType>Full</JobSchedulerType>
     </JobSettings>
     <Tags/>
    </VSphereSelfServiceConfig>

    JSON Representation

    {

     "BackupServerUid": "urn:veeam:BackupServer:8c88c6d6-931f-4044-8c0b-7a0c5f188b00",

     "RepositoryUid": "urn:veeam:Repository:44f0b2ba-9bff-4cd0-8d34-5b11e5d17fe9",

     "QuotaGb": 30,

     "PerUser": true,

     "Account": {

       "AccountName": "Domain Users",

       "AccountSid": "S-1-5-21-2710250414-1144789048-1111555807-513",

       "AccountType": "Group"

     },

     "JobSettings": {

       "DefaultSettings": true,

       "JobSchedulerType": "Full"

     },

     "Tags": [],

     "UsedQuotaMb": 0,

     "Name": "Domain Users",

     "UID": "urn:veeam:VSphereSelfServiceConfig:21774252-e680-49ce-9f99-6764a8b84440",

     "Href": "https://localhost:9398/api/selfService/vSphere/Configs/21774252-e680-49ce-9f99-6764a8b84440?format\u003dEntity",

     "Type": "VSphereSelfServiceConfig"

    }

    vSphere Self-Service Backup Job Settings

    You can define the following parameters for tenant backup jobs:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    DefaultSettings

    Boolean

    Defines what settings are applied to backup jobs created by the tenant of vSphere Self-Service Backup Portal. Possible values:

    • True — tenant jobs are configured with the default settings of a backup job for vSphere VMs.
    • False — tenant jobs are configured with settings of the backup job specified as a template.

    Yes

    0/1

    JobSchedulerType

    String

    Job scheduling options. Possible values:

    • Full — tenant of the vSphere Self-Service Backup Portal has full access to all job scheduling options.
    • Partial — tenant of the vSphere Self-Service Backup Portal can create daily and monthly jobs only.
    • Random — tenant of the vSphere Self-Service Backup Portal can create daily jobs with randomized start time within the backup window.
    • Disabled — tenant of the vSphere Self-Service Backup Portal can create only jobs with no schedule assigned.

    Yes

    0/1

    For example:

    XML Representation

    <JobSettings>
     <CustomSettings>true</CustomSettings>
     <JobSchedulerType>Full</JobSchedulerType>
    </JobSettings>

    JSON Representation

    "JobSettings": {

     "DefaultSettings": true,

     "JobSchedulerType": "Full"

    }

    vSphere Self-Service Account Settings

    You must specify the following parameters of the edited tenant access configuration:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    AccountName

    String

    Name of the tenant access configuration.

    False

    1/1

    AccountSid

    String

    ID of the tenant access configuration, for example: S-1-5-21-2710250414-1144789048-1111555807-25028.

    False

    1/1

    AccountType

    String

    Type of the tenant access configuration. Possible values:

    • User — tenant access configuration is created for a vSphere user.
    • Group — tenant access configuration is created for a vSphere group.

    False

    1/1

    For example:

    XML Representation

    <Account>
     <AccountName>Domain Users</AccountName>
     <AccountSid>S-1-5-21-2710250414-1144789048-1111555807-513</AccountSid>
     <AccountType>Group</AccountType>
    </Account>

    JSON Representation

    "Account": {

     "AccountName": "Domain Users",

     "AccountSid": "S-1-5-21-2710250414-1144789048-1111555807-513",

     "AccountType": "Group"

    }

    vSphere Tags

    You can define the following parameters for vSphere tags:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    Tag

    String

    vSphere tag assigned to a VM that must be available to the tenant.

    You must specify tags in the tenant access configuration if the vSphere tags delegation mode is selected in Veeam Backup Enterprise Manager. The tenant will be able to back up only those VMs to which the specified tags are assigned.

    Yes

    0/-

    For example:

    XML Representation

    <Tags>
     <Tag>RestAPITag</Tag>
    </Tags>

    JSON Representation

    "Tags": [

    "RestAPITag"

    ]

    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 the storage quota on the backup repository for the configuration with ID 21774252-e680-49ce-9f99-6764a8b84440.

    Request:

    PUT https://localhost:9398/api/vCloud/orgConfigs/21774252-e680-49ce-9f99-6764a8b84440

     

    Request Headers:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
    Content-Type         application/xml

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <VSphereSelfServiceConfig Href="https://localhost:9398/api/selfService/vSphere/Configs/21774252-e680-49ce-9f99-6764a8b84440?format=Entity" Type="VSphereSelfServiceConfig" Name="Domain Users" UID="urn:veeam:VSphereSelfServiceConfig:21774252-e680-49ce-9f99-6764a8b84440" 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">
     <BackupServerUid>urn:veeam:BackupServer:8c88c6d6-931f-4044-8c0b-7a0c5f188b00</BackupServerUid>
     <RepositoryUid>urn:veeam:Repository:44f0b2ba-9bff-4cd0-8d34-5b11e5d17fe9</RepositoryUid>
     <QuotaGb>30</QuotaGb>
     <PerUser>true</PerUser>
     <Account>
       <AccountName>Domain Users</AccountName>
       <AccountSid>S-1-5-21-2710250414-1144789048-1111555807-513</AccountSid>
       <AccountType>Group</AccountType>
     </Account>
     <JobSettings>
       <DefaultSettings>true</DefaultSettings>
       <JobSchedulerType>Full</JobSchedulerType>
     </JobSettings>
     <Tags/>
    </VSphereSelfServiceConfig>

     

    Response:

    202 Accepted

     

    Response Body:

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

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

    Request:

    GET https://localhost:9398/api/tasks/task-1

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
     <Links>
       <Link Rel="Delete" Href="https://localhost:9398/api/tasks/task-1" />
       <Link Rel="Related" Type="VSphereOrganizationConfigReference" Href="https://localhost:9398/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7" Name="org02" />
     </Links>
     <TaskId>task-1</TaskId>
     <State>Finished</State>
     <Operation>EditVSphereOrganizationConfig</Operation>
     <Result Success="true">
       <Message>Ok</Message>
     </Result>
    </Task>

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.