PeerType

Element:

Peer

Type:

PeerType

Namespace:

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

Description:

Generic VR peer resource type common for vCenter Server and VCD peer sites.

Since:

1.0

Schema:

hcs-docs.xsd

Media type(s):

application/vnd.vmware.hcs.peer+xml

Extends:

EntityType

XML Representation:

<Peer 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>
    <SiteName> xs:string </SiteName>
    <SiteUuid> xs:string </SiteUuid>
    <VdcId> xs:string </VdcId>
</Peer>

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.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Description	string	No	always	1.0		Optional description.
Link	LinkType	No	none	1.0		A reference to an entity or operation associated with this object.
SiteName	string	No		1.0		The peer site name.
SiteUuid	string	No		1.0		The peer site UUID.
Tasks	TasksInProgressType	No	none	1.0		A list of queued, running, or recently completed tasks associated with this entity.
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.
VdcId	string	No		1.0		The identifier of the Org VDC which is paired with the remote peer site.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /vr/peers/{peerResourceId}	Retrieves VR Peer (pairing) information.	1.0