This is an archive version of the document. To get the most up-to-date information, see the current version.(PUT) /vCloud/orgConfigs/{ID}
Edits settings of a vCloud Director organization configuration with the specified ID.
Request
To edit settings of the vCloud Director organization configuration, you need to send the PUT HTTP request to the URL of the /vCloud/orgConfigs/{ID} resource.
HTTP Request
PUT http://<Enterprise-Manager>:9399/api/vCloud/orgConfigs/{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. |
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 vCloud Director organization 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 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 |
JobSettings | String | vCloud Director backup job options set for the organization. To learn more, see vCloud Director Backup Job Settings. | Yes | 1/1 |
IsDisabled | UShort | Defines if the vCloud Director organization configuration is in the disabled state. Possible values:
If the True value is specified, the vCloud Director organization will use default organization settings. Default settings are specified in the sample configuration with the name Other organizations. Settings specified for this configuration are also applied to all organizations for which individual configurations are not created. | Yes | 1/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
vCloud Director Backup Job Settings
You can define the following parameters for tenant-side vCloud Director backup jobs:
Element | Type | Description | Modifiable | Min/Max Occurrence |
DefaultSettings | Bool | Defines whether tenant-side jobs created for the organization must be configured with the default vCloud Director backup job settings. Possible values:
If set to False, the ID of the backup job that will be used as a template for tenant-side jobs must be specified in the CopyFromThisJob element. | Yes | 0/1 |
CustomSettings | Bool | Defines whether tenant-side jobs created for the organization must use settings of a specific vCloud Director backup job. Possible values:
If set to True, the ID of the backup job that will be used as a template for tenant-side jobs must be specified in the CopyFromThisJob element. | Yes | 0/1 |
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. | Yes | 0/1 | |
JobSchedulerType | String | Job scheduling options. Possible values:
| Yes | 1/1 |
For example:
<JobSettings> |
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 updates the storage quota on the backup repository for the configuration with ID 228fef7b-6e5e-4107-886e-40c8f482b5c7.
Request: PUT http://localhost:9399/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7
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="http://localhost:9399/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 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"> |
