GET /admin/extension/settings

Operation:

GET /admin/extension/settings

Description:

Retrieve system settings.

System settings specify default values and behaviors for the cloud and all of the organizations in it. System settings are divided into categories. This request retrieves all categories of system settings.

Since:

1.5

Input parameters

Consume media type(s):

None

Input type:

None

Output parameters

{@link JAXBElement}

Produce media type(s):

application/vnd.vmware.admin.systemSettings+xml

Output type:

SystemSettingsType

Examples

Request

HTTP 1.1
GET /api/admin/extension/settings

Headers:
x-vcloud-authorization: M69zc2o7Ol7AuYVBAslGYbnTluZZVZKIYa1HPe8MzEk=

Body:

Response

HTTP/1.1 200 OK

Headers:
Content-Length: 15406
Content-Type: application/vnd.vmware.admin.systemsettings+xml;version=5.5
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?><vmext:SystemSettings
    xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
    xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    href="https://vcloud.example.com/api/admin/extension/settings"
    type="application/vnd.vmware.admin.systemSettings+xml"
    xsi:schemaLocation="http://www.vmware.com/vcloud/extension/v1.5 http://https://vcloud.example.com/api/v1.5/schema/vmwextensions.xsd http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings"
        rel="edit"
        type="application/vnd.vmware.admin.systemSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/general"
        rel="down"
        type="application/vnd.vmware.admin.generalSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/notifications"
        rel="down"
        type="application/vnd.vmware.admin.notificationsSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings"
        rel="down"
        type="application/vnd.vmware.admin.ldapSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/amqp"
        rel="down"
        type="application/vnd.vmware.admin.amqpSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/passwordPolicy"
        rel="down"
        type="application/vnd.vmware.admin.systemPasswordPolicySettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/blockingTask"
        rel="down"
        type="application/vnd.vmware.admin.blockingTaskSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/branding"
        rel="down"
        type="application/vnd.vmware.admin.brandingSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/license"
        rel="down"
        type="application/vnd.vmware.admin.licenseSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/email"
        rel="down"
        type="application/vnd.vmware.admin.emailSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/kerberosSettings"
        rel="down"
        type="application/vnd.vmware.admin.kerberosSettings+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/extension/settings/lookupService"
        rel="down"
        type="application/vnd.vmware.admin.lookupServiceSettings+xml"/>
    <vmext:GeneralSettings
        href="https://vcloud.example.com/api/admin/extension/settings/general"
        type="application/vnd.vmware.admin.generalSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/general/action/updateVcTrustsore"
            rel="truststore:update"
            type="application/vnd.vmware.admin.vcTrustStoreUpdateParams+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/general/action/resetVcTrustsore"
            rel="truststore:reset"/>
        <vmext:AbsoluteSessionTimeoutMinutes>1440</vmext:AbsoluteSessionTimeoutMinutes>
        <vmext:ActivityLogDisplayDays>30</vmext:ActivityLogDisplayDays>
        <vmext:ActivityLogKeepDays>90</vmext:ActivityLogKeepDays>
        <vmext:AllowOverlappingExtNets>false</vmext:AllowOverlappingExtNets>
        <vmext:ChargebackEventsKeepDays>365</vmext:ChargebackEventsKeepDays>
        <vmext:ChargebackTablesCleanupJobTimeInSeconds>10800</vmext:ChargebackTablesCleanupJobTimeInSeconds>
        <vmext:ConsoleProxyExternalAddress/>
        <vmext:HostCheckDelayInSeconds>300</vmext:HostCheckDelayInSeconds>
        <vmext:HostCheckTimeoutSeconds>30</vmext:HostCheckTimeoutSeconds>
        <vmext:InstallationId>4</vmext:InstallationId>
        <vmext:IpReservationTimeoutSeconds>0</vmext:IpReservationTimeoutSeconds>
        <vmext:SyslogServerSettings/>
        <vmext:LoginNameOnly>false</vmext:LoginNameOnly>
        <vmext:PrePopDefaultName>true</vmext:PrePopDefaultName>
        <vmext:QuarantineEnabled>false</vmext:QuarantineEnabled>
        <vmext:QuarantineResponseTimeoutSeconds>21600</vmext:QuarantineResponseTimeoutSeconds>
        <vmext:RestApiBaseUri/>
        <vmext:SessionTimeoutMinutes>30</vmext:SessionTimeoutMinutes>
        <vmext:ShowStackTraces>false</vmext:ShowStackTraces>
        <vmext:SyncStartDate>9999-12-31T23:59:59.000+02:00</vmext:SyncStartDate>
        <vmext:SyncIntervalInHours>24</vmext:SyncIntervalInHours>
        <vmext:TransferSessionTimeoutSeconds>3600</vmext:TransferSessionTimeoutSeconds>
        <vmext:VerifyVcCertificates>false</vmext:VerifyVcCertificates>
        <vmext:VcTruststoreType>JCEKS</vmext:VcTruststoreType>
        <vmext:VmrcVersion>2.5.0.279773</vmext:VmrcVersion>
        <vmext:VerifyVsmCertificates>false</vmext:VerifyVsmCertificates>
    </vmext:GeneralSettings>
    <vmext:NotificationsSettings
        href="https://vcloud.example.com/api/admin/extension/settings/notifications"
        type="application/vnd.vmware.admin.notificationsSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/notifications"
            rel="edit"
            type="application/vnd.vmware.admin.notificationsSettings+xml"/>
        <vmext:EnableNotifications>false</vmext:EnableNotifications>
    </vmext:NotificationsSettings>
    <vmext:LdapSettings
        href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings"
        type="application/vnd.vmware.admin.ldapSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings"
            rel="up"
            type="application/vnd.vmware.admin.systemSettings+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings"
            rel="edit"
            type="application/vnd.vmware.admin.ldapSettings+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings/action/updateLdapCertificate"
            rel="certificate:update"
            type="application/vnd.vmware.admin.certificateUpdateParams+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings/action/resetLdapCertificate"
            rel="certificate:reset"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings/action/updateLdapKeyStore"
            rel="keystore:update"
            type="application/vnd.vmware.admin.keystoreUpdateParams+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings/action/resetLdapKeyStore"
            rel="keystore:reset"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings/action/updateLdapSspiKeytab"
            rel="keytab:update"
            type="application/vnd.vmware.admin.sspiKeytabUpdateParams+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/ldapSettings/action/resetLdapSspiKeytab"
            rel="keytab:reset"/>
        <vmext:Port>389</vmext:Port>
        <vmext:IsSsl>false</vmext:IsSsl>
        <vmext:IsSslAcceptAll>false</vmext:IsSslAcceptAll>
        <vmext:PagedSearchDisabled>false</vmext:PagedSearchDisabled>
        <vmext:PageSize>200</vmext:PageSize>
        <vmext:MaxResults>200</vmext:MaxResults>
        <vmext:MaxUserGroups>1015</vmext:MaxUserGroups>
        <vmext:AuthenticationMechanism>SIMPLE</vmext:AuthenticationMechanism>
        <vmext:IsGroupSearchBaseEnabled>false</vmext:IsGroupSearchBaseEnabled>
        <vmext:ConnectorType>ACTIVE_DIRECTORY</vmext:ConnectorType>
        <vmext:UserAttributes>
            <vmext:ObjectClass>user</vmext:ObjectClass>
            <vmext:ObjectIdentifier>objectGuid</vmext:ObjectIdentifier>
            <vmext:UserName>sAMAccountName</vmext:UserName>
            <vmext:Email>mail</vmext:Email>
            <vmext:FullName>displayName</vmext:FullName>
            <vmext:GivenName>givenName</vmext:GivenName>
            <vmext:Surname>sn</vmext:Surname>
            <vmext:Telephone>telephoneNumber</vmext:Telephone>
            <vmext:GroupMembershipIdentifier>dn</vmext:GroupMembershipIdentifier>
            <vmext:GroupBackLinkIdentifier>tokenGroups</vmext:GroupBackLinkIdentifier>
        </vmext:UserAttributes>
        <vmext:GroupAttributes>
            <vmext:ObjectClass>group</vmext:ObjectClass>
            <vmext:ObjectIdentifier>objectGuid</vmext:ObjectIdentifier>
            <vmext:GroupName>cn</vmext:GroupName>
            <vmext:Membership>member</vmext:Membership>
            <vmext:MembershipIdentifier>dn</vmext:MembershipIdentifier>
            <vmext:BackLinkIdentifier>objectSid</vmext:BackLinkIdentifier>
        </vmext:GroupAttributes>
        <vmext:UseExternalKerberos>false</vmext:UseExternalKerberos>
    </vmext:LdapSettings>
    <vmext:AmqpSettings
        href="https://vcloud.example.com/api/admin/extension/settings/amqp"
        type="application/vnd.vmware.admin.amqpSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/amqp/action/test"
            rel="test"
            type="application/vnd.vmware.admin.amqpSettings+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/amqp/action/updateAmqpCertificate"
            rel="certificate:update"
            type="application/vnd.vmware.admin.certificateUpdateParams+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/amqp/action/resetAmqpCertificate"
            rel="certificate:reset"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/amqp/action/updateAmqpTruststore"
            rel="truststore:update"
            type="application/vnd.vmware.admin.trustStoreUpdateParams+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/amqp/action/resetAmqpTruststore"
            rel="truststore:reset"/>
        <vmext:AmqpHost/>
        <vmext:AmqpPort>5672</vmext:AmqpPort>
        <vmext:AmqpUsername>guest</vmext:AmqpUsername>
        <vmext:AmqpExchange>systemExchange</vmext:AmqpExchange>
        <vmext:AmqpVHost>/</vmext:AmqpVHost>
        <vmext:AmqpUseSSL>false</vmext:AmqpUseSSL>
        <vmext:AmqpSslAcceptAll>false</vmext:AmqpSslAcceptAll>
        <vmext:AmqpPrefix>vcd</vmext:AmqpPrefix>
    </vmext:AmqpSettings>
    <vmext:EmailSettings
        href="https://vcloud.example.com/api/admin/extension/settings/email"
        type="application/vnd.vmware.admin.emailSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/email"
            rel="edit"
            type="application/vnd.vmware.admin.emailSettings+xml"/>
        <vmext:SenderEmailAddress/>
        <vmext:EmailSubjectPrefix/>
        <vmext:AlertEmailToAllAdmins>true</vmext:AlertEmailToAllAdmins>
        <vmext:AlertEmailTo/>
        <vmext:SmtpSettings>
            <vmext:UseAuthentication>false</vmext:UseAuthentication>
            <vmext:SmtpServerName/>
            <vmext:SmtpServerPort>25</vmext:SmtpServerPort>
            <vmext:ssl>false</vmext:ssl>
            <vmext:UserName/>
        </vmext:SmtpSettings>
    </vmext:EmailSettings>
    <vmext:License
        href="https://vcloud.example.com/api/admin/extension/settings/license"
        type="application/vnd.vmware.admin.licenseSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/license"
            rel="edit"
            type="application/vnd.vmware.admin.licenseSettings+xml"/>
        <vmext:SerialNumber>xxx</vmext:SerialNumber>
        <vmext:ValidSerial>true</vmext:ValidSerial>
        <vmext:Expired>false</vmext:Expired>
        <vmext:Persisted>true</vmext:Persisted>
        <vmext:PublishingToRemoteSitesFeature>true</vmext:PublishingToRemoteSitesFeature>
        <vmext:SubscribingToRemoteSitesFeature>true</vmext:SubscribingToRemoteSitesFeature>
        <vmext:LicenseMetricsInfo>
            <vmext:vRAM>0</vmext:vRAM>
            <vmext:vCPU>0</vmext:vCPU>
            <vmext:RunningVMs>0</vmext:RunningVMs>
            <vmext:PhysicalMemoryUsed>0</vmext:PhysicalMemoryUsed>
            <vmext:PhysicalSocketCount>2</vmext:PhysicalSocketCount>
            <vmext:AvailablePhysicalMemory>8191</vmext:AvailablePhysicalMemory>
            <vmext:LastUpdate>2013-02-14T12:35:00.040+02:00</vmext:LastUpdate>
            <vmext:PublishingToRemoteSites>false</vmext:PublishingToRemoteSites>
            <vmext:SubscribingToRemoteSites>false</vmext:SubscribingToRemoteSites>
        </vmext:LicenseMetricsInfo>
    </vmext:License>
    <vmext:BrandingSettings
        href="https://vcloud.example.com/api/admin/extension/settings/branding"
        type="application/vnd.vmware.admin.brandingSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/branding"
            rel="edit"
            type="application/vnd.vmware.admin.brandingSettings+xml"/>
        <vmext:CompanyName>VMware vCloud Director</vmext:CompanyName>
        <vmext:Theme/>
    </vmext:BrandingSettings>
    <vmext:BlockingTaskSettings
        href="https://vcloud.example.com/api/admin/extension/settings/blockingTask"
        type="application/vnd.vmware.admin.blockingTaskSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/blockingTask"
            rel="edit"
            type="application/vnd.vmware.admin.blockingTaskSettings+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/blockingTask/operations"
            rel="down"
            type="application/vnd.vmware.admin.taskOperationList+xml"/>
        <vmext:TimeoutAction>abort</vmext:TimeoutAction>
        <vmext:BlockingTaskOperations
            href="https://vcloud.example.com/api/admin/extension/settings/blockingTask/operations"
            type="application/vnd.vmware.admin.taskOperationList+xml">
            <vcloud:Link
                href="https://vcloud.example.com/api/admin/extension/settings/blockingTask/operations"
                rel="edit"
                type="application/vnd.vmware.admin.taskOperationList+xml"/>
        </vmext:BlockingTaskOperations>
        <vmext:TimeoutInMilliseconds>432000000</vmext:TimeoutInMilliseconds>
    </vmext:BlockingTaskSettings>
    <vmext:PasswordPolicySettings
        href="https://vcloud.example.com/api/admin/extension/settings/passwordPolicy"
        type="application/vnd.vmware.admin.systemPasswordPolicySettings+xml">
        <vmext:AccountLockoutEnabled>false</vmext:AccountLockoutEnabled>
        <vmext:AdminAccountLockoutEnabled>false</vmext:AdminAccountLockoutEnabled>
        <vmext:InvalidLoginsBeforeLockout>5</vmext:InvalidLoginsBeforeLockout>
        <vmext:AccountLockoutIntervalMinutes>10</vmext:AccountLockoutIntervalMinutes>
    </vmext:PasswordPolicySettings>
    <vmext:KerberosSettings
        allowLowerCaseRealms="false"
        href="https://vcloud.example.com/api/admin/extension/settings/kerberosSettings"
        type="application/vnd.vmware.admin.kerberosSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/kerberosSettings"
            rel="edit"
            type="application/vnd.vmware.admin.kerberosSettings+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings"
            rel="up"
            type="application/vnd.vmware.admin.systemSettings+xml"/>
    </vmext:KerberosSettings>
    <vmext:LookupServiceSettings
        href="https://vcloud.example.com/api/admin/extension/settings/lookupService"
        type="application/vnd.vmware.admin.lookupServiceSettings+xml">
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings"
            rel="up"
            type="application/vnd.vmware.admin.systemSettings+xml"/>
        <vcloud:Link
            href="https://vcloud.example.com/api/admin/extension/settings/lookupService"
            rel="edit"
            type="application/vnd.vmware.admin.lookupServiceParams+xml"/>
        <vmext:LookupServiceUrl/>
    </vmext:LookupServiceSettings>
</vmext:SystemSettings>