PUT /selfService/vSphere/Configs/{ID}
Edits settings of a tenant access configuration with the specified ID.
Request
To edit settings of the tenant access configuration, 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:
|
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
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.
Important |
If you use the XML media type, make sure that the order of parameters in the request body is correct. For details, see request body examples in this section. |
The request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
BackupServerUid | UidType | UID 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 | UidType | UID 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:
| 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 |
VCentersScope | VCentersScopeListType | Defines a list of vCenter Servers whose VMs are available to the tenant. By default, the tenant has access to all vCenter Servers. For details, see vCenters Scope Settings. | Yes | 0/1 |
Tags | TagsListType | vSphere tags that define what VMs are available to the tenant. For details, see vSphere Tags. | Yes | 0/1 |
For example:
XML Representation
<?xml version="1.0" encoding="utf-8"?> |
JSON Representation
{ "BackupServerUid": "urn:veeam:BackupServer:7445e6ce-86f5-4171-b909-dac209c66563", "RepositoryUid": "urn:veeam:Repository:425b6739-5082-4f7a-99fb-1ae13ef87d9f", "QuotaGb": 500, "PerUser": false, "Account": { "AccountName": "Administrators", "AccountSid": "S-1-5-32-544", "AccountType": "Group" }, "JobSettings": { "DefaultSettings": false, "JobSchedulerType": "Full", "HighPriorityJob": true, "TemplateJobUid": null }, "VCentersScopes": [ "urn:veeam:ManagedServer:6edb23da-560b-4759-951f-1da6aca08169", "urn:veeam:ManagedServer:095585e0-6a9a-4bb8-8433-a1d815687ce9" ], "Tags": [ "RestAPITag" ], "UsedQuotaMb": 0, "Name": "Administrators", "UID": "urn:veeam:VSphereSelfServiceConfig:c6a041d0-36a1-47c7-9f4b-a12327796c68", "Links": null, "Href": "https://localhost:9398/api/selfService/vSphere/Configs/c6a041d0-36a1-47c7-9f4b-a12327796c68?format=Entity", "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:
| Yes | 0/1 |
JobSchedulerType | String | Job scheduling options. Possible values:
| Yes | 0/1 |
HighPriorityJob | Boolean | Defines whether the backup job has a high priority. Possible values:
| Yes | 0/1 |
For example:
XML Representation
<JobSettings> |
JSON Representation
"JobSettings": { "DefaultSettings": true, "JobSchedulerType": "Full" "HighPriorityJob": true } |
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 | 0/1 |
AccountType | String | Type of the tenant access configuration. Possible values:
| False | 1/1 |
For example:
XML Representation
<Account> |
JSON Representation
"Account": { "AccountName": "Domain Users", "AccountSid": "S-1-5-21-2710250414-1144789048-1111555807-513", "AccountType": "Group" } |
You can define a list of vCenter Servers whose VMs are available to the tenant. By default, the tenant has access to all vCenter Servers.
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
VCenterUid | UidType | UID of the vCenter Server that must be available to the tenant, for example: urn:veeam:ManagedServer:6edb23da-560b-4759-951f-1da6aca08169. | Yes | 0/- |
For example:
XML Representation
<VCentersScope> |
JSON Representation
"VCentersScope": [ "urn:veeam:ManagedServer:6edb23da-560b-4759-951f-1da6aca08169", "urn:veeam:ManagedServer:095585e0-6a9a-4bb8-8433-a1d815687ce9" ] |
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> |
JSON Representation
"Tags": [ "RestAPITag" ] |
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:
|
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
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 202 Accepted
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track 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"> |