OrgSettings

Element:
OrgSettings
Type:
OrgSettingsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Describes various settings for some organization. This type establishes quotas and policies for the organization. It also contains elements that specify the details of how the organization connects to LDAP and email services.
Since:
0.9
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.orgSettings+xml
Extends:
ResourceType
XML Representation:
<OrgSettings xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <OrgGeneralSettings href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <CanPublishCatalogs> xs:boolean </CanPublishCatalogs>
        <DeployedVMQuota> xs:int </DeployedVMQuota>
        <StoredVmQuota> xs:int </StoredVmQuota>
        <UseServerBootSequence> xs:boolean </UseServerBootSequence>
        <DelayAfterPowerOnSeconds> xs:int </DelayAfterPowerOnSeconds>
    </OrgGeneralSettings>
    <VAppLeaseSettings href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <DeleteOnStorageLeaseExpiration> xs:boolean </DeleteOnStorageLeaseExpiration>
        <DeploymentLeaseSeconds> xs:int </DeploymentLeaseSeconds>
        <StorageLeaseSeconds> xs:int </StorageLeaseSeconds>
    </VAppLeaseSettings>
    <VAppTemplateLeaseSettings href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <DeleteOnStorageLeaseExpiration> xs:boolean </DeleteOnStorageLeaseExpiration>
        <StorageLeaseSeconds> xs:int </StorageLeaseSeconds>
    </VAppTemplateLeaseSettings>
    <OrgLdapSettings href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <OrgLdapMode> xs:string </OrgLdapMode>
        <CustomUsersOu> xs:string </CustomUsersOu>
        <CustomOrgLdapSettings>
            <HostName> xs:string </HostName>
            <Port> xs:int </Port>
            <IsSsl> xs:boolean </IsSsl>
            <IsSslAcceptAll> xs:boolean </IsSslAcceptAll>
            <Realm> xs:string </Realm>
            <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>
                <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>
                <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>
        </CustomOrgLdapSettings>
    </OrgLdapSettings>
    <OrgEmailSettings href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <IsDefaultSmtpServer> xs:boolean </IsDefaultSmtpServer>
        <IsDefaultOrgEmail> xs:boolean </IsDefaultOrgEmail>
        <FromEmailAddress> xs:string </FromEmailAddress>
        <DefaultSubjectPrefix> xs:string </DefaultSubjectPrefix>
        <IsAlertEmailToAllAdmins> xs:boolean </IsAlertEmailToAllAdmins>
        <AlertEmailTo> xs:string </AlertEmailTo>
        <SmtpServerSettings>
            <IsUseAuthentication> xs:boolean </IsUseAuthentication>
            <Host> xs:string </Host>
            <Username> xs:string </Username>
            <Password> xs:string </Password>
        </SmtpServerSettings>
    </OrgEmailSettings>
    <OrgPasswordPolicySettings href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <AccountLockoutEnabled> xs:boolean </AccountLockoutEnabled>
        <InvalidLoginsBeforeLockout> xs:int </InvalidLoginsBeforeLockout>
        <AccountLockoutIntervalMinutes> xs:int </AccountLockoutIntervalMinutes>
    </OrgPasswordPolicySettings>
</OrgSettings>

Attributes

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

Elements

Element Type Occurrence Modifiable Since Description
VCloudExtension VCloudExtensionType 0..* always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 0.9 Optional link to an entity or operation associated with this object.
OrgGeneralSettings OrgGeneralSettingsType 0..1 always 0.9 Defines general org settings.
VAppLeaseSettings OrgLeaseSettingsType 0..1 always 0.9 Defines default lease durations and related policies.
VAppTemplateLeaseSettings OrgVAppTemplateLeaseSettingsType 0..1 always 1.5 Defines default lease policies for vAppTemplate on organization level.
OrgLdapSettings OrgLdapSettingsType 0..1 always 0.9 Defines the hostname and connection details for the organization s primary LDAP service.
OrgEmailSettings OrgEmailSettingsType 0..1 always 0.9 Defines the email settings for this organization.
OrgPasswordPolicySettings OrgPasswordPolicySettingsType 0..1 always 0.9 Defines the password policy settings for an organization. If not explicitly set, the organization inherits the system password policy settings.

Operations

CRUD Operation Description Since
read GET /admin/org/{id}/settings Gets organizational settings for this organization.
update PUT /admin/org/{id}/settings Updates organizational settings for this organization.