This is an archive version of the document. To get the most up-to-date information, see the current version.(POST) /vCloud/orgConfigs
Creates a vCloud Director organization configuration.
Request
To create a vCloud Director organization configuration, you need to send the POST HTTP request to the URL of the /vCloud/orgConfigs resource.
HTTP Request
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. To learn more, 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 vCloud Director organization configuration. 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 |
|---|---|---|---|---|
OrganizationName | String | Name of the vCloud Director organization for which configuration is created. The vCloud Director organization must be created in advance on a vCloud Director server processed by a Veeam backup server added to Veeam Backup Enterprise Manager. | Yes | 1/1 |
BackupServerUid | URN | ID of the backup server that must process VMs of the vCloud Director organization, for example: urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222. | Yes | 1/1 |
RepositoryUid | URN | ID of the backup repository on which the storage quota for the vCloud Director 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 vCloud Director organization (in GB). | Yes | 1/1 |
TemplateJobUid | URN | ID of the vCloud Director backup job that will be used as a template for vCloud Director organization VMs processing. The backup job must be created in advance on the Veeam backup server connected to Veeam Backup Enterprise Manager. Settings of the specified job will be applied to backup jobs created by tenant-side users. If the job ID is not specified, tenant-side jobs will be configured with the default vCloud Director backup job settings. Job settings applied to backup jobs for the vCloud Director organization will be listed in the representation of the /vCloud/orgConfigs/{ID}/backupJobSettings resource. | Yes | 0/1 |
JobSchedulerType | String | Job scheduling options. Possible values:
| Yes | 1/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
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:
|
Response Body
None.
Example
The example below creates a new configuration for the vCloud Director organization with the name org1. 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 6c6ab2af-df49-4112-a036-72cf9bd28fef is used as a template for tenant-side backup jobs. The vCloud Director organization administrator has full access to all job scheduling options.
Request: POST https://localhost:9398/api/vCloud/orgConfigs
Request Header: 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 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"> |
