VMware Cloud Director API - PortGroupPoolType

VMware Cloud Director API - PortGroupPoolType

PortGroupPoolType

Type:

PortGroupPoolType

Namespace:

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

Description:

Represents a network pool backed by one or more vSphere port groups.

Since:

1.0

Schema:

vmwextensions.xsd

Media type(s):

None

Extends:

VMWNetworkPoolType

XML Representation:

<PortGroupPoolType 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" status="xs:int">
    <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>
    <vcloud_v1.5:Files>
        <vcloud_v1.5:File href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" size="xs:long" bytesTransferred="xs:long" checksum="xs:normalizedString">
            <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>
        </vcloud_v1.5:File>
    </vcloud_v1.5:Files>
    <PortGroupRefs>
        <VimObjectRef>
            <vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <MoRef> xs:string </MoRef>
            <VimObjectType> xs:string </VimObjectType>
        </VimObjectRef>
    </PortGroupRefs>
    <vcloud_v1.5:VimServer href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <UsedNetworksCount> xs:int </UsedNetworksCount>
</PortGroupPoolType>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	1.0		The URI of the entity.
type	string	No	always	1.0		The MIME type of the entity.
id	string	No	none	1.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	1.0		The name of the entity.
status	int	No	none	1.0		Creation status of the resource entity.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Description	string	No	always	1.0		Optional description.
Files	FilesListType	No	none	1.0		Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
Link	LinkType	No	none	1.0		A reference to an entity or operation associated with this object.
PortGroupRefs	VimObjectRefsType	Yes	always	1.0		References to the vSphere port groups that support this network pool. Required at least one port group moref, for modify and create.
Tasks	TasksInProgressType	No	none	1.0		A list of queued, running, or recently completed tasks associated with this entity.
UsedNetworksCount	int	No	none	1.0		This is a read-only indication of how many networks in this pool are in use.
VCloudExtension	VCloudExtensionType	No	always	1.0		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VimServer	ReferenceType	Yes	always	1.0		Reference to the vSphere which hosts the port groups. Required VC server on which the port groups exist, for modify and create.