POST /selfService/vSphere/Configs

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.

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:

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

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:

• 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

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:

• 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

HighPriorityJob

Boolean

Defines whether the backup job has a high priority. Possible values:

• True
• False

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

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/-

Tag

String

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

Yes

0/-

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