POST /selfService/vSphere/Configs
Creates a vSphere Self-Service Backup Portal tenant access configuration.
Request
To create a vSphere Self-Service Backup Portal tenant access configuration, send the POST HTTP request to the URL of the /selfService/vSphere/Configs resource.
HTTP Request
POST https://<Enterprise-Manager>:9398/api/selfService/vSphere/Configs |
Request Header
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 of the vSphere Self-Service Backup Portal tenant access configuration. 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 contains the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
AccountName | String | Name of the user or group account for which the tenant access configuration is created. The account must be created in advance on a vCenter Server processed by a backup server added to Veeam Backup Enterprise Manager. | Yes | 1/1 |
AccountType | String | Type of the tenant access configuration. Possible values:
| False | 0/1 |
RepositoryUid | UidType | UID of the backup repository on which the storage quota for the tenant of vSphere Self-Service Backup Portal must be created, for example: urn:veeam:Repository:893d2ecc-879a-4f2a-8a31-3594t7cr1ya4. You cannot assign to tenants quotas on cloud repositories, as well as NetApp or Nimble storage systems that store snapshots created by Veeam snapshot-only jobs. | 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 |
TemplateJobUid | UidType | UID of the backup job that will be used as a template for backup jobs created by the tenant of vSphere Self-Service Backup Portal. The backup job must be created in advance on the backup server connected to Veeam Backup Enterprise Manager. Settings of the specified job will be applied to backup jobs created by the tenant. If the job ID is not specified, tenant jobs will be configured with the default vSphere backup job settings. Settings applied to backup jobs of the tenant will be displayed in the representation of the /selfService/vSphere/Configs/{ID}/backupJobSettings resource. | 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 |
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 will be available to the tenant. For details, see vSphere Tags. vSphere tags must be specified if the vSphere tags delegation mode is selected in Veeam Backup Enterprise Manager. | Yes | 0/1 |
For example:
XML Representation
<?xml version="1.0" encoding="utf-8"?> |
JSON Representation
{ "AccountName": "Administrators", "RepositoryUid": "urn:veeam:Repository:425b6739-5082-4f7a-99fb-1ae13ef87d9f", "QuotaGb": 500, "PerUser": false, "TemplateJobUid": "urn:veeam:Job:24f70e27-549a-4126-bfe5-167cca158a0f", "JobSchedulerType": "Full", "HighPriorityJob": true, "VCentersScopes": [ "urn:veeam:ManagedServer:6edb23da-560b-4759-951f-1da6aca08169", "urn:veeam:ManagedServer:095585e0-6a9a-4bb8-8433-a1d815687ce9" ], "Tags": [ "RestAPITag" ] } |
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" ] |
If the vSphere tags delegation mode is selected in Veeam Backup Enterprise Manager, you must specify tags in the tenant access configuration. The tenant will be able to back up only those VMs to which the specified tags are assigned.
The request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
Tag | String | vSphere tag assigned to a VM that must be available to the tenant. | Yes | 0/- |
For example:
<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 creates a new tenant access configuration for the vSphere user with the name tech\william.fox. The storage quota of 100 GB is created on the backup repository that has ID df9903aa-d2b6-4edd-9a0b-057bc8dd4451. The backup job with ID 24f70e27-549a-4126-bfe5-167cca158a0f is used as a template for backup jobs created by the tenant of the vSphere Self-Service Backup Portal. The tenant has full access to all job scheduling options.
Request: POST https://localhost:9398/api/selfService/vSphere/Configs
Request Headers: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <VSphereSelfServiceCreateSpec 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">
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" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Href="https://localhost:9398/api/tasks/task-1" Type="Task"> |