SystemSettings

Element:

SystemSettings

Type:

SystemSettingsType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

Represents the settings of the system.

Since:

1.5

Schema:

settings.xsd

Media type(s):

application/vnd.vmware.admin.systemSettings+xml

Extends:

ResourceType

XML Representation:

<SystemSettings xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <GeneralSettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <AbsoluteSessionTimeoutMinutes> xs:int </AbsoluteSessionTimeoutMinutes>
        <ActivityLogDisplayDays> xs:int </ActivityLogDisplayDays>
        <ActivityLogKeepDays> xs:int </ActivityLogKeepDays>
        <AllowOverlappingExtNets> xs:boolean </AllowOverlappingExtNets>
        <ChargebackEventsKeepDays> xs:int </ChargebackEventsKeepDays>
        <ChargebackTablesCleanupJobTimeInSeconds> xs:int </ChargebackTablesCleanupJobTimeInSeconds>
        <ConsoleProxyExternalAddress> xs:string </ConsoleProxyExternalAddress>
        <HostCheckDelayInSeconds> xs:int </HostCheckDelayInSeconds>
        <HostCheckTimeoutSeconds> xs:int </HostCheckTimeoutSeconds>
        <InstallationId> xs:int </InstallationId>
        <IpReservationTimeoutSeconds> xs:int </IpReservationTimeoutSeconds>
        <vcloud_v1.5:SyslogServerSettings>
            <vcloud_v1.5:SyslogServerIp1> vcloud_v1.5:IpAddressType </vcloud_v1.5:SyslogServerIp1>
            <vcloud_v1.5:SyslogServerIp2> vcloud_v1.5:IpAddressType </vcloud_v1.5:SyslogServerIp2>
        </vcloud_v1.5:SyslogServerSettings>
        <LoginNameOnly> xs:boolean </LoginNameOnly>
        <PrePopDefaultName> xs:boolean </PrePopDefaultName>
        <QuarantineEnabled> xs:boolean </QuarantineEnabled>
        <QuarantineResponseTimeoutSeconds> xs:int </QuarantineResponseTimeoutSeconds>
        <RestApiBaseUri> xs:string </RestApiBaseUri>
        <SessionTimeoutMinutes> xs:int </SessionTimeoutMinutes>
        <ShowStackTraces> xs:boolean </ShowStackTraces>
        <SyncStartDate> xs:dateTime </SyncStartDate>
        <SyncIntervalInHours> xs:long </SyncIntervalInHours>
        <SystemExternalAddress> xs:string </SystemExternalAddress>
        <TransferSessionTimeoutSeconds> xs:int </TransferSessionTimeoutSeconds>
        <VerifyVcCertificates> xs:boolean </VerifyVcCertificates>
        <VcTruststorePassword> xs:string </VcTruststorePassword>
        <VcTruststoreContents> xs:hexBinary </VcTruststoreContents>
        <VcTruststoreType> xs:string </VcTruststoreType>
        <VmrcVersion> xs:string </VmrcVersion>
        <VerifyVsmCertificates> xs:boolean </VerifyVsmCertificates>
    </GeneralSettings>
    <NotificationsSettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <EnableNotifications> xs:boolean </EnableNotifications>
    </NotificationsSettings>
    <LdapSettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <HostName> xs:string </HostName>
        <Port> xs:int </Port>
        <IsSsl> xs:boolean </IsSsl>
        <IsSslAcceptAll> xs:boolean </IsSslAcceptAll>
        <Realm> xs:string </Realm>
        <PagedSearchDisabled> xs:boolean </PagedSearchDisabled>
        <PageSize> xs:int </PageSize>
        <MaxResults> xs:int </MaxResults>
        <MaxUserGroups> xs:int </MaxUserGroups>
        <SearchBase> xs:string </SearchBase>
        <UserName> xs:string </UserName>
        <Password> xs:string </Password>
        <AuthenticationMechanism> xs:string </AuthenticationMechanism>
        <GroupSearchBase> xs:string </GroupSearchBase>
        <IsGroupSearchBaseEnabled> xs:boolean </IsGroupSearchBaseEnabled>
        <ConnectorType> xs:string </ConnectorType>
        <UserAttributes href="xs:anyURI" type="xs:string">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <ObjectClass> xs:string </ObjectClass>
            <ObjectIdentifier> xs:string </ObjectIdentifier>
            <UserName> xs:string </UserName>
            <Email> xs:string </Email>
            <FullName> xs:string </FullName>
            <GivenName> xs:string </GivenName>
            <Surname> xs:string </Surname>
            <Telephone> xs:string </Telephone>
            <GroupMembershipIdentifier> xs:string </GroupMembershipIdentifier>
            <GroupBackLinkIdentifier> xs:string </GroupBackLinkIdentifier>
        </UserAttributes>
        <GroupAttributes href="xs:anyURI" type="xs:string">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <ObjectClass> xs:string </ObjectClass>
            <ObjectIdentifier> xs:string </ObjectIdentifier>
            <GroupName> xs:string </GroupName>
            <Membership> xs:string </Membership>
            <MembershipIdentifier> xs:string </MembershipIdentifier>
            <BackLinkIdentifier> xs:string </BackLinkIdentifier>
        </GroupAttributes>
    </LdapSettings>
    <AmqpSettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <AmqpHost> xs:string </AmqpHost>
        <AmqpPort> xs:int </AmqpPort>
        <AmqpUsername> xs:string </AmqpUsername>
        <AmqpPassword> xs:string </AmqpPassword>
        <AmqpExchange> xs:string </AmqpExchange>
        <AmqpVHost> xs:string </AmqpVHost>
        <AmqpUseSSL> xs:boolean </AmqpUseSSL>
    </AmqpSettings>
    <EmailSettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <SenderEmailAddress> xs:string </SenderEmailAddress>
        <EmailSubjectPrefix> xs:string </EmailSubjectPrefix>
        <AlertEmailToAllAdmins> xs:boolean </AlertEmailToAllAdmins>
        <AlertEmailTo> xs:string </AlertEmailTo>
        <SmtpSettings href="xs:anyURI" type="xs:string">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <UseAuthentication> xs:boolean </UseAuthentication>
            <SmtpServerName> xs:string </SmtpServerName>
            <SmtpServerPort> xs:int </SmtpServerPort>
            <ssl> xs:boolean </ssl>
            <UserName> xs:string </UserName>
            <Password> xs:string </Password>
        </SmtpSettings>
    </EmailSettings>
    <License href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <SerialNumber> xs:string </SerialNumber>
        <LicensedVMCount> xs:int </LicensedVMCount>
        <ExpirationDate> xs:dateTime </ExpirationDate>
        <ValidSerial> xs:boolean </ValidSerial>
        <Expired> xs:boolean </Expired>
        <LicenseMetricsInfo href="xs:anyURI" type="xs:string">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <vRAM> xs:long </vRAM>
            <vCPU> xs:long </vCPU>
            <RunningVMs> xs:long </RunningVMs>
            <PhysicalMemoryUsed> xs:long </PhysicalMemoryUsed>
            <PhysicalSocketCount> xs:int </PhysicalSocketCount>
            <AvailablePhysicalMemory> xs:long </AvailablePhysicalMemory>
            <LastUpdate> xs:dateTime </LastUpdate>
        </LicenseMetricsInfo>
    </License>
    <BrandingSettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <CompanyName> xs:string </CompanyName>
        <Theme> xs:string </Theme>
        <AboutCompanyUrl> xs:string </AboutCompanyUrl>
        <SupportUrl> xs:string </SupportUrl>
        <SignUpUrl> xs:string </SignUpUrl>
        <ForgotUserNameOrPasswordURL> xs:string </ForgotUserNameOrPasswordURL>
    </BrandingSettings>
    <BlockingTaskSettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <TimeoutAction> xs:string </TimeoutAction>
        <vcloud_v1.5:BlockingTaskOperations href="xs:anyURI" type="xs:string">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Operation> xs:string </Operation>
        </vcloud_v1.5:BlockingTaskOperations>
        <TimeoutInMilliseconds> BlockingTaskSettingsType/TimeoutInMilliseconds </TimeoutInMilliseconds>
    </BlockingTaskSettings>
    <PasswordPolicySettings href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <AccountLockoutEnabled> xs:boolean </AccountLockoutEnabled>
        <AdminAccountLockoutEnabled> xs:boolean </AdminAccountLockoutEnabled>
        <InvalidLoginsBeforeLockout> xs:int </InvalidLoginsBeforeLockout>
        <AccountLockoutIntervalMinutes> SystemPasswordPolicySettingsType/AccountLockoutIntervalMinutes </AccountLockoutIntervalMinutes>
    </PasswordPolicySettings>
</SystemSettings>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.5	Contains the URI to the entity.
type	string	No	always	1.5	Contains the type of the entity.

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes.
Link	LinkType	0..*	none	1.5	Optional link to an entity or operation associated with this object.
GeneralSettings	GeneralSettingsType	0..1		1.5	The general settings.
NotificationsSettings	NotificationsSettingsType	0..1		1.5	Notifications settings.
LdapSettings	LdapSettingsType	0..1		1.5	LDAP settings.
AmqpSettings	AmqpSettingsType	0..1		1.5	AMQP settings.
EmailSettings	EmailSettingsType	0..1		1.5	Represent all the email related settings in the system.
License	LicenseType	0..1		1.5	This is used by the API to update and retrieve site license specific information.
BrandingSettings	BrandingSettingsType	0..1		1.5	BrandingSettings stores all information about how to brand the product for vCloud service, like provider name, logo etc.
BlockingTaskSettings	BlockingTaskSettingsType	0..1		1.5	Blocking task settings.
PasswordPolicySettings	SystemPasswordPolicySettingsType	0..1		1.5	Password policy settings for the cloud provider administrator. These are also inherited by organizations, unless overridden at the organization level.

Operations

CRUD	Operation	Description	Since
read	GET /admin/extension/settings	Retrieves the {@link SystemSettings}.	1.5
as input	PUT /admin/extension/settings	Updates the {@link SystemSettings}.	1.5