(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 https://<Enterprise-Manager>:9398/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. 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.

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 REST 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. For details, 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:

  • True
  • False

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 Representation

<?xml version="1.0" encoding="utf-8"?>
<VCloudOrganizationConfig Href="https://localhost:9398/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7?format=Entity" Type="VCloudOrganizationConfig" Name="org02" UID="urn:veeam:VCloudOrganizationConfig:228fef7b-6e5e-4107-886e-40c8f482b5c7" 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">
 <BackupServerUid>urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222</BackupServerUid>
 <RepositoryUid>urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
 <QuotaGb>1024</QuotaGb>
 <JobSettings>
   <DefaultSettings>true</DefaultSettings>
   <JobSchedulerType>Full</JobSchedulerType>
 </JobSettings>
 <IsDisabled>false</IsDisabled>
</VCloudOrganizationConfig>

JSON Representation

{

 "BackupServerUid": "urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222",

 "RepositoryUid": "urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451",

 "QuotaGb": 1024,

 "IsDisabled": false,

 "JobSettings": {

   "DefaultSettings": true,

   "JobSchedulerType": "Full"

 },

 "UsedQuotaMb": 0,

 "Name": "org02",

 "UID": "urn:veeam:VCloudOrganizationConfig:228fef7b-6e5e-4107-886e-40c8f482b5c7",

 "Href": "https://localhost:9398/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7?format\u003dEntity",

 "Type": "VCloudOrganizationConfig"

}

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:

  • True
  • False

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:

  • True
  • False

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

CopyFromThisJob

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 backup server connected to Veeam Backup Enterprise Manager.

Yes

0/1

JobSchedulerType

String

Job scheduling options. Possible values:

  • FullvCloud Director organization administrator has full access to all job scheduling options.
  • PartialvCloud Director organization administrator can create daily and monthly jobs only.
  • RandomvCloud Director organization administrator can create daily jobs with randomized start time within the backup window.
  • DisabledvCloud Director organization administrator can create only jobs with no schedule assigned.

Yes

1/1

HighPriorityJob

Boolean

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

  • True
  • False

Yes

0/1

For example:

XML Representation

<JobSettings>
 <CustomSettings>true</CustomSettings>
 <JobSchedulerType>Full</JobSchedulerType>
</JobSettings>

JSON Representation

"JobSettings": {

 "CustomSettings": "true",

 "JobSchedulerType": "Full"

}

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:

  • application/xml
  • application/json

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 https://localhost:9398/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7

 

Request Headers:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Content-Type         application/xml

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<VCloudOrganizationConfig Href="https://localhost:9398/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7?format=Entity" Type="VCloudOrganizationConfig" Name="org02" UID="urn:veeam:VCloudOrganizationConfig:228fef7b-6e5e-4107-886e-40c8f482b5c7" 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">
 <BackupServerUid>urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222</BackupServerUid>
 <RepositoryUid>urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
 <QuotaGb>500</QuotaGb>
 <JobSettings>
   <DefaultSettings>true</DefaultSettings>
   <JobSchedulerType>Full</JobSchedulerType>
 </JobSettings>
 <IsDisabled>false</IsDisabled>
</VCloudOrganizationConfig>

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="https://localhost:9398/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>EditVCloudOrganizationConfig</Operation>
</Task>

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">
 <Links>
   <Link Rel="Delete" Href="https://localhost:9398/api/tasks/task-1" />
   <Link Rel="Related" Type="VCloudOrganizationConfigReference" Href="https://localhost:9398/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7" Name="org02" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>EditVCloudOrganizationConfig</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

 

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.