vCloud API - AdminVrServer

AdminVrServerType

Element:

AdminVrServer

Type:

AdminVrServerType

Namespace:

http://www.vmware.com/vr/v6.0

Description:

VR server administrative information.

Since:

1.0

Schema:

hcs-docs.xsd

Media type(s):

application/vnd.vmware.hcs.vrServer+xml

Extends:

VrServerType

XML Representation:

<AdminVrServer xmlns="http://www.vmware.com/vr/v6.0" 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:VCloudExtension required="xs:boolean"/>
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string">
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
    </vcloud_v1.5:Link>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
        <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:VCloudExtension required="xs:boolean"/>
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:Link>
            <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:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:Owner>
            <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
                    <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
                </vcloud_v1.5:TenantError>
            </vcloud_v1.5:Error>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:User>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
            </vcloud_v1.5:Organization>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <Uuid> xs:string </Uuid>
    <IsConnected> xs:boolean </IsConnected>
    <VcUuid> xs:string </VcUuid>
    <ReplicationTrafficAddress> xs:string </ReplicationTrafficAddress>
</AdminVrServer>

Attributes

Attribute	Type	Required	Modifiable	Since	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.

Elements

Element	Type	Required	Modifiable	Since	Description
Description	string	No	always	1.0	Optional description.
IsConnected	boolean	Yes		1.0	Indicates whether the VR Server is available.
Link	LinkType	No	none	1.0	A reference to an entity or operation associated with this object.
ReplicationTrafficAddress	string	No		1.0	The VR server replication traffic network IP address.
Tasks	TasksInProgressType	No	none	1.0	A list of queued, running, or recently completed tasks associated with this entity.
Uuid	string	No		1.0	The VR Server UUID.
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.
VcUuid	string	No		1.0	The related vCenter Server UUID.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /admin/extension/vr/vrs/{hbrId}	Retrieves information for the VR server.	1.0
delete	DELETE /admin/extension/vr/vrs/{hbrId}	Unregisters the VR server.	1.0