Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

(PUT) /selfService/vSphere/Configs/{ID}

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

Request

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

HTTP Request

PUT http://<Enterprise-Manager>:9399/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. To learn more, see Authentication and Security.

Accept

False

The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

Request Body

In the request body, the client must send parameters for the vSphere 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 RESTful 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 of the vSphere organization, 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 vSphere organization 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 vSphere organization (in GB).

Yes

1/1

PerUser

Boolean

If set to True, users of the tenant account group will be able to observe only their respective jobs. If set to False, users of the tenant account group will see each others jobs as well.

Yes

0/1

Account

VSphereSelfServiceConfigAccountInfoType

Specifies the vSphere tenant account settings. For more information, see vSphere Self-Service Account Settings

False

1/1

JobSettings

VSphereSelfServiceConfigEntityTypeJobSettings

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

Yes

1/1

Tags

TagsListType

List of tags for the vSphere Tags mode in Delegation Mode. For more information, see Tags.

Yes

0/1

For example:

<VSphereSelfServiceConfig Href="http://localhost:9399/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>

vSphere Self-Service Backup Job Settings

You can define the following parameters for tenant-side vSphere backup jobs:

Element

Type

Description

Modifiable

Min/Max Occurrence

DefaultSettings

Boolean

If set to True, the tenant-side jobs are configured with the default vSphere backup job settings. If set to False, users of the tenant account group will see each others jobs as well.

Yes

0/1

JobSchedulerType

String

Job scheduling options. Possible values:

  • FullvSphere tenant user has full access to all job scheduling options.
  • PartialvSphere tenant user can create daily and monthly jobs only.
  • RandomvSphere tenant user can create daily jobs with randomized start time within the backup window.
  • DisabledvSphere tenant user can create only jobs with no schedule assigned.

Yes

0/1

For example:

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

vSphere Self-Service Account Settings

You can define the following parameters for vSphere tenatn account:

Element

Type

Description

Modifiable

Min/Max Occurrence

AccountName

String

Name of the vSphere tenant account user or group for which configuration is created. The vSphere tenant account must be created in advance on a vSphere server processed by a Veeam backup server added to Veeam Backup Enterprise Manager.

False

1/1

AccountSid

String

SID of the vSphere tenant account user or group for which configuration is created, for example: S-1-5-21-2710250414-1144789048-1111555807-25028.

False

1/1

AccountType

String

Type of the vSphere tenant account. Possible values:

  • User — vSphere Self-Service Backup Portal tenant account is a user account.
  • Group — vSphere Self-Service Backup Portal tenant account is a group account.

False

1/1

For example:

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

vSphere Tags

You can define the following parameters for vSphere Delegation Mode Tags:

Element

Type

Description

Modifiable

Min/Max Occurrence

Tag

String

vSphere Delegation Mode Tags.

Yes

0/-

For example:

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

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 http://localhost:9399/api/vCloud/orgConfigs/21774252-e680-49ce-9f99-6764a8b84440

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<VSphereSelfServiceConfig Href="http://localhost:9399/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="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>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 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" Href="http://localhost:9399/api/tasks/task-1" />
   <Link Rel="Related" Type="VSphereOrganizationConfigReference" Href="http://localhost:9399/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>

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation