GeneralSettings

Element:
GeneralSettings
Type:
GeneralSettingsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents the general part of the system settings.
Since:
1.5
Schema:
settings.xsd
Media type(s):
application/vnd.vmware.admin.generalSettings+xml
Extends:
ResourceType
XML Representation:
<GeneralSettings 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"/>
    <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>

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.
AbsoluteSessionTimeoutMinutes int 1 always 1.5 Absolute number of minutes to timeout client session. This will trigger session timeout even when there are user activities.
ActivityLogDisplayDays int 1 always 1.5 Days of activities to be displayed to the users.
ActivityLogKeepDays int 1 always 1.5 Days of activities to keep in the system.
AllowOverlappingExtNets boolean 1 always 1.5 Boolean flag that allows/disallows creation of multiple external networks on the same LAN segment.
ChargebackEventsKeepDays int 1 always 1.5 Days for which events are to be kept in Chargeback Tables.
ChargebackTablesCleanupJobTimeInSeconds int 1 always 1.5 Time of the day at which the job should run.
ConsoleProxyExternalAddress string 0..1 always 1.5 Load balancer address configured for Console Proxy. Leave empty to clear the address.
HostCheckDelayInSeconds int 1 always 1.5 Frequency of checking the host status
HostCheckTimeoutSeconds int 1 always 1.5 Number of seconds to wait for a response from a host before marking it as hung.
InstallationId int 0..1 none 1.5 The installation Id. The acceptable value is between 0 and 63.
IpReservationTimeoutSeconds int 1 always 1.5 Number of seconds to keep released IP addresses on hold before making them available for allocation again. This is typically set to 2 hours to allow old entries to expire from client ARP tables.
SyslogServerSettings SyslogServerSettingsType 1 always 1.5 Default syslog server settings for networks. If logging is configured for firewall rules, the logs will be directed to these syslog servers. If you change these values, you must synchronize the syslog server settings for each network in the system by running its syncSyslogServerSettings action.
LoginNameOnly boolean 1 always 1.5 System login policy setting (automatic login or remember user name only).
PrePopDefaultName boolean 1 always 1.5 Pre-populate default configuration and virtual machine name.
QuarantineEnabled boolean 1 always 1.5 Flag to indicate whether uploads should be quarantined.
QuarantineResponseTimeoutSeconds int 1 always 1.5 The length of time, in seconds, before a quarantined transfer is 'timedout'.
RestApiBaseUri string 0..1 always 1.5 Load balancer address configured for the REST API. Leave empty to clear the address.
SessionTimeoutMinutes int 1 always 1.5 Number of minutes to timeout client session.
ShowStackTraces boolean 1 always 1.5 Boolean flag to turn on/off the display of exception stack traces.
SyncStartDate dateTime 1 always 1.5 Number of minutes to timeout client session.
SyncIntervalInHours long 1 always 1.5 LDAP sync repeats interval time in hours.
SystemExternalAddress string 0..1 always 1.5 The systemExternalAddress is the external web link address to system. Leave empty to clear the address.
TransferSessionTimeoutSeconds int 1 always 1.5 Transfer sessions time out in this number of seconds.
VerifyVcCertificates boolean 1 always 1.5 Boolean flag to apply a strict trust check to vCenter certificates.
VcTruststorePassword string 0..1 always 1.5 Password for the vCenter truststore, if used. If empty or no password is passed then no update is performed.
VcTruststoreContents hexBinary 0..1 always 1.5 vCenter truststore bytes (if used).
VcTruststoreType string 1 always 1.5 vCenter truststore type (JKS, JCEKS, PKCS12).
VmrcVersion string 0..1 none 1.5 VMRC version.
VerifyVsmCertificates boolean 0..1 always 1.5 Boolean flag to apply a strict trust check to vShield Manager certificates.

Operations

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