VMware Cloud Director API - SiteAssociationMember

SiteAssociationType

Element:

SiteAssociationMember

Type:

SiteAssociationType

Namespace:

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

Description:

A reference to another associated site

Since:

29.0

Schema:

multiSite.xsd

Media type(s):

application/vnd.vmware.vcloud.site+xml
application/vnd.vmware.admin.siteAssociation+json
application/vnd.vmware.admin.siteAssociation+xml
application/vnd.vmware.vcloud.site+json

Extends:

MultisiteType

XML Representation:

<SiteAssociationMember xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <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">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <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"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <RestEndpoint> xs:anyURI </RestEndpoint>
    <BaseUiEndpoint> xs:anyURI </BaseUiEndpoint>
    <TenantUiEndpoint> xs:anyURI </TenantUiEndpoint>
    <RestEndpointCertificate> xs:string </RestEndpointCertificate>
    <SiteId> xs:string </SiteId>
    <SiteName> xs:string </SiteName>
    <PublicKey> xs:string </PublicKey>
    <Status> xs:string </Status>
</SiteAssociationMember>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	29.0	The URI of the entity.
type	string	No	always	29.0	The MIME type of the entity.
id	string	No	none	29.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	29.0	The name of the entity.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
BaseUiEndpoint	anyURI	Yes	always	29.0	30.0	The base URI of the UI end-point for the site.
Description	string	No	always	29.0		Optional description.
Link	LinkType	No	none	29.0		A reference to an entity or operation associated with this object.
PublicKey	string	No	always	29.0	35.0	PEM-encoded public key for the remote site.
RestEndpoint	anyURI	Yes	always	29.0		The URI of the REST API end-point for the site.
RestEndpointCertificate	string	No	always	29.0		Optional PEM-encoded certificate to use when connecting to the REST API end-point.
SiteId	string	Yes	create	29.0		The URN of the remote site
SiteName	string	Yes	create	29.0		The name of the remote site
Status	string	No	none	29.0		Current status of this association. One of: ACTIVE (The association has been established by both members, and communication with the remote party succeeded.) ASYMMETRIC (The association has been established at the local site, but the remote party has not yet reciprocated.) UNREACHABLE (The association has been established by both members, but the remote member is currently unreachable.)
Tasks	TasksInProgressType	No	none	29.0		A list of queued, running, or recently completed tasks associated with this entity.
TenantUiEndpoint	anyURI	Yes	always	29.0	30.0	The URI of the Tenant UI end-point for the site.
VCloudExtension	VCloudExtensionType	No	always	29.0		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description
read	GET /site/associations/localAssociationData	Get the {@link SiteAssociationsType} for this site.
read	GET /site/associations/{id}	Get the {@link SiteAssociationType} for the specified site id.
update	PUT /site/associations/{id}	Adds an association for the specified site.
delete	DELETE /site/associations/{id}	Deletes the association for the specified site.
as input	POST /site/associations	Add a new {@link SiteAssociationType} for this site.