System settings establish systemwide behaviors and default values.

The SystemSettings element includes all system settings for this VMware Cloud Director server group. The element also includes links that allow you to retrieve these subsidiary elements, which define specific categories of settings.

GeneralSettings
Specify service URLs, timeouts, truststore details, and similar global properties of the server group.
NotificationsSettings
Control the VMware Cloud Director AMQP notifications service.
LdapSettings
Specify details of the system LDAP directory service.
AmqpSettings
Specify credentials and connection information for the AMQP broker that handles notifications and blocking task messages.
EmailSettings
Define configuration and connection parameters for the system default email service, and specifies properties of email alerts that the system sends.
License
System license serial number and related settings.
BrandingSettings
Customize the branding of the VMware Cloud Director HTML5 UI and some of the links that appear on the VMware Cloud Director Home login screen.
BlockingTaskSettings
Control the behavior of blocking tasks and enable blocking for specific operations.
PasswordPolicySettings
Specify default policies to be followed when a user in any organization enters an incorrect password. Organization administrators can override this default for their organizations.
CPoM
Configure the dedicated vCenter Server settings. You can configure the maximum number of active proxies for the system and for a user. You can configure the timeout value in seconds for testing a connection to an SDDC proxied host. You can allow the attached vCenter Server instances to be both tenant-scoped and provider-scoped, that is one vCenter Server instance can back both a provider VDC and a dedicated vCenter Server instance. You can allow proxying over insecure HTTP in addition to HTTPS.
LookupServiceSettings
Specify the vSphere Lookup Service URL. Certain VMware Cloud Director services need this URL to authenticate with vSphere.
CatalogSettings
Specify the schedule for background synchronization of catalogs that have an external subscription. These settings apply to all organizations in the system.

You can retrieve the entire SystemSettings element to view all of these settings. To update an individual subsection, retrieve it with a GET request, modify it, and update it with a PUT request.

Prerequisites

This operation is restricted to system administrators.

Procedure

  1. Retrieve the SystemSettings element.
    Use a request like this one.
    GET https://vcloud.example.com/api/admin/extension/settings
  2. Examine the response to locate the Link elements that you can use to retrieve an individual subsection.
    These links have a rel attribute value of down.
  3. Use the link to retrieve the subsection.
    Make a GET request to the href value of the link.
  4. (Optional) Modify the retrieved subsection.
    Subsections that you can modify include a link where rel="edit".
  5. (Optional) To update the subsection, PUT the modified subsection to the href of the link described in Step 4.