VMware Cloud Director API - SystemSettings
SystemSettingsType
- Element:
- SystemSettings
- Type:
- SystemSettingsType
- Namespace:
- http://www.vmware.com/vcloud/extension/v1.5
- Description:
- Represents system-level settings.
- Since:
- 1.5
- Schema:
- settings.xsd
- Media type(s):
-
application/vnd.vmware.admin.systemSettings+json
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" model="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" model="xs:string"/>
<AbsoluteSessionTimeoutMinutes> xs:int </AbsoluteSessionTimeoutMinutes>
<ActivityLogDisplayDays> xs:int </ActivityLogDisplayDays>
<ActivityLogKeepDays> xs:int </ActivityLogKeepDays>
<AllowOverlappingExtNets> xs:boolean </AllowOverlappingExtNets>
<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>
<RestApiBaseHttpUri> xs:string </RestApiBaseHttpUri>
<RestApiBaseUri> xs:string </RestApiBaseUri>
<RestApiBaseUriPublicCertChain> xs:string </RestApiBaseUriPublicCertChain>
<SessionTimeoutMinutes> xs:int </SessionTimeoutMinutes>
<ShowStackTraces> xs:boolean </ShowStackTraces>
<SyncEnabled> xs:boolean </SyncEnabled>
<SyncStartDate> xs:dateTime </SyncStartDate>
<SyncIntervalInHours> xs:long </SyncIntervalInHours>
<SystemExternalHttpAddress> xs:string </SystemExternalHttpAddress>
<SystemExternalAddress> xs:string </SystemExternalAddress>
<SystemExternalAddressPublicCertChain> xs:string </SystemExternalAddressPublicCertChain>
<TenantPortalExternalHttpAddress> xs:string </TenantPortalExternalHttpAddress>
<TenantPortalExternalAddress> xs:string </TenantPortalExternalAddress>
<TenantPortalPublicCertChain> xs:string </TenantPortalPublicCertChain>
<TransferSessionTimeoutSeconds> xs:int </TransferSessionTimeoutSeconds>
<VerifyVcCertificates> xs:boolean </VerifyVcCertificates>
<VcTruststorePassword> xs:string </VcTruststorePassword>
<VcTruststoreContents> xs:hexBinary </VcTruststoreContents>
<VcTruststoreType> xs:string </VcTruststoreType>
<VmrcVersion> xs:string </VmrcVersion>
<ElasticAllocationPool> xs:boolean </ElasticAllocationPool>
<AdvancedNetworkingEnabled> xs:boolean </AdvancedNetworkingEnabled>
<AdvancedNetworkingDfwApiUrl> xs:string </AdvancedNetworkingDfwApiUrl>
<AdvancedNetworkingDfwUiUrl> xs:string </AdvancedNetworkingDfwUiUrl>
<AdvancedNetworkingGatewayApiUrl> xs:string </AdvancedNetworkingGatewayApiUrl>
<AdvancedNetworkingGatewayUiUrl> xs:string </AdvancedNetworkingGatewayUiUrl>
<MaxVdcQuota> xs:int </MaxVdcQuota>
<SubInterfacesEnabled> xs:boolean </SubInterfacesEnabled>
<VmDiscoveryEnabled> xs:boolean </VmDiscoveryEnabled>
<AllowFipsModeForEdgeGateways> xs:boolean </AllowFipsModeForEdgeGateways>
</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" model="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" model="xs:string"/>
<HostName> xs:string </HostName>
<Port> xs:int </Port>
<IsSsl> xs:boolean </IsSsl>
<CustomTruststore> xs:string </CustomTruststore>
<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" model="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" model="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" model="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>
<AmqpPrefix> xs:string </AmqpPrefix>
</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" model="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" model="xs:string"/>
<UseAuthentication> xs:boolean </UseAuthentication>
<SmtpServerName> xs:string </SmtpServerName>
<SmtpServerPort> xs:int </SmtpServerPort>
<vcloud_v1.5:SmtpSecureMode> vcloud_v1.5:SmtpSecureModeType </vcloud_v1.5:SmtpSecureMode>
<SslTrustStore> xs:string </SslTrustStore>
<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" model="xs:string"/>
<SerialNumber> xs:string </SerialNumber>
<LicensedVMCount> xs:int </LicensedVMCount>
<ExpirationDate> xs:dateTime </ExpirationDate>
<ValidSerial> xs:boolean </ValidSerial>
<Expired> xs:boolean </Expired>
<Persisted> xs:boolean </Persisted>
<PublishingToRemoteSitesFeature> xs:boolean </PublishingToRemoteSitesFeature>
<SubscribingToRemoteSitesFeature> xs:boolean </SubscribingToRemoteSitesFeature>
<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" model="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>
<PublishingToRemoteSites> xs:boolean </PublishingToRemoteSites>
<SubscribingToRemoteSites> xs:boolean </SubscribingToRemoteSites>
</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" model="xs:string"/>
<CompanyName> xs:string </CompanyName>
<LoginPageCustomizationTheme> xs:hexBinary </LoginPageCustomizationTheme>
<PreviewCustomTheme> xs:hexBinary </PreviewCustomTheme>
<FinalCustomTheme> xs:hexBinary </FinalCustomTheme>
<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" model="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" model="xs:string"/>
<vcloud_v1.5:TaskOperationType>
<Category> xs:string </Category>
<Operation> xs:string </Operation>
</vcloud_v1.5:TaskOperationType>
</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" model="xs:string"/>
<AccountLockoutEnabled> xs:boolean </AccountLockoutEnabled>
<AdminAccountLockoutEnabled> xs:boolean </AdminAccountLockoutEnabled>
<InvalidLoginsBeforeLockout> xs:int </InvalidLoginsBeforeLockout>
<AccountLockoutIntervalMinutes> SystemPasswordPolicySettingsType/AccountLockoutIntervalMinutes </AccountLockoutIntervalMinutes>
</PasswordPolicySettings>
<CatalogSettings 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" model="xs:string"/>
<isSyncEnabled> xs:boolean </isSyncEnabled>
<SyncStartDate> xs:dateTime </SyncStartDate>
<SyncStopDate> xs:dateTime </SyncStopDate>
<NextSyncDate> xs:dateTime </NextSyncDate>
<RefreshInterval> xs:long </RefreshInterval>
</CatalogSettings>
<OperationLimitsSettings 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" model="xs:string"/>
<RunningPerUser> xs:int </RunningPerUser>
<RunningPerOrg> xs:int </RunningPerOrg>
<QueuedOperationsPerUser> xs:int </QueuedOperationsPerUser>
<QueuedOperationsPerOrg> xs:int </QueuedOperationsPerOrg>
</OperationLimitsSettings>
<CpomSettings 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" model="xs:string"/>
<MaxActiveSddcProxyQuota> xs:int </MaxActiveSddcProxyQuota>
<MaxActiveSddcProxyPerUserQuota> xs:int </MaxActiveSddcProxyPerUserQuota>
<SddcProxiedHostConnectionTimeoutSeconds> xs:int </SddcProxiedHostConnectionTimeoutSeconds>
<AllowInsecureSddcProxying> xs:boolean </AllowInsecureSddcProxying>
</CpomSettings>
</SystemSettings>
-
Attributes
-
Attribute Type Required Modifiable Since Deprecated Description href anyURI No always 1.5 The URI of the entity. type string No always 1.5 The MIME type of the entity. -
Elements
-
Element Type Required Modifiable Since Deprecated Description AmqpSettings AmqpSettingsType No 1.5 AMQP settings. BlockingTaskSettings BlockingTaskSettingsType No 1.5 Blocking task settings. BrandingSettings BrandingSettingsType No 1.5 BrandingSettings stores all information about how to brand the product for vCloud service, like provider name, logo etc. CatalogSettings CatalogSettingsType No 5.5 Catalog settings. CpomSettings CpomSettingsType No 32.0 CPoM Settings. EmailSettings EmailSettingsType No 1.5 Email settings. GeneralSettings GeneralSettingsType No 1.5 General settings. LdapSettings LdapSettingsType No 1.5 LDAP settings. License LicenseType No 1.5 Settings for retrieving and updating vCloud Director license information. Link LinkType No none 1.5 A reference to an entity or operation associated with this object. NotificationsSettings NotificationsSettingsType No 1.5 Notifications settings. OperationLimitsSettings OperationLimitsSettingsType No 20.0 Global Tenant Throttling limits PasswordPolicySettings SystemPasswordPolicySettingsType No 1.5 Password policy settings for the cloud provider administrator. These are also inherited by organizations, unless overridden at the organization level. VCloudExtension VCloudExtensionType No always 1.5 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services. -
Operations
-
CRUD Operation Description Since Deprecated read GET /admin/extension/settings Retrieve system settings. 1.5 as input PUT /admin/extension/settings Update system settings. 1.5