AdminOrg

Element:
AdminOrg
Type:
AdminOrgType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
The AdminOrgType represents an administrative view of an organization. It includes all members of the Org element, and adds several elements that can be viewed and modified only by system administrators.
Since:
0.9
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.organization+xml
Extends:
OrgType
XML Representation:
<AdminOrg xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                endTime="xs:dateTime" expiryTime="xs:dateTime">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
        </Task>
    </Tasks>
    <FullName> xs:string </FullName>
    <IsEnabled> xs:boolean </IsEnabled>
    <Settings 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>
    </Settings>
    <Users>
        <UserReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Users>
    <Groups>
        <GroupReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Groups>
    <Catalogs>
        <CatalogReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Catalogs>
    <Vdcs>
        <Vdc href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Vdcs>
    <Networks>
        <Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Networks>
</AdminOrg>

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.
name string Yes always 0.9 The name of the entity.
id string No none 0.9 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.

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.
Description string 0..1 always 0.9 Optional description.
Tasks TasksInProgressType 0..1 none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
FullName string 1 always 0.9 Full name of the organization.
IsEnabled boolean 0..1 none 0.9 Not specifying this flag in the request to update the OrgSettings will result in disabling the org (default value if flag is not specified is false) True if this organization is enabled. If enabled, the organization allows login and all other operations.
Settings OrgSettingsType 1 always 0.9 Settings for this organization. Establishes quotas and policies, specifies how the organization connects to LDAP and email services.
Users UsersListType 0..1 none 0.9 Container for ReferenceType elements that reference users in the organization.
Groups GroupsListType 0..1 none 0.9 Container for ReferenceType elements that reference groups in the organization.
Catalogs CatalogsListType 0..1 none 0.9 Container for ReferenceType elements that reference catalogs in the organization.
Vdcs VdcsType 0..1 none 0.9 Container for ReferenceType elements that reference vDCs in the organization.
Networks NetworksType 0..1 none 0.9 Container for ReferenceType elements that reference networks in the organization.

Operations

CRUD Operation Description Since
create POST /admin/orgs Creates an organization. 0.9
read GET /admin/org/{id} Retrieves an admin view of an organization. 0.9
update PUT /admin/org/{id} Modifies an admin organization. 0.9
delete DELETE /admin/org/{id} Deletes an admin organization. 0.9
action POST /admin/org/{id}/action/disable Disables an organization. 1.0
action POST /admin/org/{id}/action/enable Enables an admin organization If the organization was disabled this action enables it. 1.0
action POST /admin/org/{id}/networks Creates a network in an organization. 0.9