VMware Cloud Director API - VMWVmGroups

VMWVmGroupsType

Element:

VMWVmGroups

Type:

VMWVmGroupsType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

List of VM groups in this resource pool.

Since:

27.0

Schema:

vmwextensions.xsd

Media type(s):

application/vnd.vmware.admin.vmwVmGroupType+json
application/vnd.vmware.admin.vmwVmGroupsType+xml
application/vnd.vmware.admin.vmwVmGroupType+xml
application/vnd.vmware.admin.vmwVmGroupsType+json

Extends:

ResourceType

XML Representation:

<VMWVmGroups 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"/>
    <VmGroup 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>
    </VmGroup>
</VMWVmGroups>

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.

Elements

Element	Type	Required	Modifiable	Since	Description
Link	LinkType	No	none	27.0	A reference to an entity or operation associated with this object.
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.
VmGroup	VMWVmGroupType	Yes	always	27.0	List of vm groups in this resource pool.

Operations

CRUD	Operation	Description	Since
read	GET /admin/extension/resourcePool/{rpId}/vmGroups	List all VmGroups within this resource pool.	27.0
read	GET /admin/extension/vmGroups/name/{groupName}
read	GET /vmGroups