VMware Cloud Director API - VMWVmGroup

VMware Cloud Director API - VMWVmGroup

VMWVmGroupType

Element:
VMWVmGroup
Type:
VMWVmGroupType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
VmGroup identifies a group of VMs in this resource pool to which VM-Host affinity rules can be applied. VM-Host affinity rules control placement of virtual machines on hosts in a resource pool.
Since:
27.0
Schema:
vmwextensions.xsd
Media type(s):
application/vnd.vmware.admin.vmwVmGroupType+json
application/vnd.vmware.admin.vmwVmGroupType+xml
Extends:
EntityType
XML Representation:
<VMWVmGroup 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" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5:Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </vcloud_v1.5:Error>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <vcloud_v1.5:VcTaskList>
                <vcloud_v1.5:VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </vcloud_v1.5:VcTaskList>
            <vcloud_v1.5:Result>
                <ResultContent> ... </ResultContent>
                <vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </vcloud_v1.5:Result>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <vmCount> xs:int </vmCount>
</VMWVmGroup>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 27.0 The URI of the entity.
type string No always 27.0 The MIME type of the entity.
id string No none 27.0 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.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 27.0 The name of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
Description string No always 27.0 Optional description.
Link LinkType No none 27.0 A reference to an entity or operation associated with this object.
Tasks TasksInProgressType No none 27.0 A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension VCloudExtensionType No always 27.0 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
vmCount int Yes always 27.0 Number of VMs in this VM group

Operations

CRUD Operation Description Since Deprecated
read GET /admin/extension/resourcePool/{rpId}/vmGroup/name/{groupName} Gets {@link JAXBElement } with given VM group name.
read GET /admin/extension/vmGroup/{groupId} Retrieves the vm group by Id 27.0
read GET /vmGroup/name/{groupName}
delete DELETE /admin/extension/vmGroup/{groupId} Delete the specified VM group 27.0
as input POST /admin/extension/resourcePool/{rpId}/vmGroups Create VM group within this resource pool.
as input POST /vmGroups