VMware Cloud Director API - RegisterVimServerParams

VMware Cloud Director API - RegisterVimServerParams

RegisterVimServerParamsType

Element:
RegisterVimServerParams
Type:
RegisterVimServerParamsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents parameters to register a vCenter server.
Since:
0.9
Schema:
vmwextensions.xsd
Media type(s):
application/vnd.vmware.admin.registerVimServerParams+xml
application/vnd.vmware.admin.registerVimServerParams+json
Extends:
anyType
XML Representation:
<RegisterVimServerParams xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5">
    <VimServer 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>
        <Username> xs:string </Username>
        <Password> xs:string </Password>
        <Url> xs:anyURI </Url>
        <IsEnabled> xs:boolean </IsEnabled>
        <rootFolder> xs:string </rootFolder>
        <vcNoneNetwork> xs:string </vcNoneNetwork>
        <ComputeProviderScope> xs:string </ComputeProviderScope>
        <IsConnected> xs:boolean </IsConnected>
        <ShieldManagerHost> xs:anyURI </ShieldManagerHost>
        <ShieldManagerUserName> xs:string </ShieldManagerUserName>
        <VsmVersion> xs:string </VsmVersion>
        <Uuid> xs:string </Uuid>
        <VcProxy> xs:string </VcProxy>
        <VcVersion> xs:string </VcVersion>
        <UseVsphereService> xs:boolean </UseVsphereService>
        <VsphereWebClientServerUrl> xs:string </VsphereWebClientServerUrl>
        <tenantScoped> xs:boolean </tenantScoped>
        <providerScoped> xs:boolean </providerScoped>
        <listenerState> xs:string </listenerState>
        <clusterHealthStatus> xs:string </clusterHealthStatus>
        <proxyEnabled> xs:boolean </proxyEnabled>
        <clustersCount> xs:int </clustersCount>
        <totalVmCount> xs:int </totalVmCount>
        <poweredOnVmCount> xs:int </poweredOnVmCount>
        <totalMemMb> xs:int </totalMemMb>
        <reservedMemMb> xs:int </reservedMemMb>
        <demandedMemMb> xs:int </demandedMemMb>
        <totalCpuMhz> xs:int </totalCpuMhz>
        <reservedCpuMhz> xs:int </reservedCpuMhz>
        <demandedCpuMhz> xs:int </demandedCpuMhz>
        <totalStorageMb> xs:int </totalStorageMb>
        <freeStorageMb> xs:int </freeStorageMb>
        <uncommittedStorageMb> xs:int </uncommittedStorageMb>
    </VimServer>
    <ShieldManager 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>
        <Username> xs:string </Username>
        <Password> xs:string </Password>
        <Url> xs:anyURI </Url>
        <NetworkProviderScope> xs:string </NetworkProviderScope>
        <vcloud_v1.5:AssociatedVimServer href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <ControlVmResourcePoolVcPath> xs:string </ControlVmResourcePoolVcPath>
        <ControlVmDatastoreName> xs:string </ControlVmDatastoreName>
        <ControlVmManagementInterfaceName> xs:string </ControlVmManagementInterfaceName>
        <SoftwareVersion> xs:string </SoftwareVersion>
    </ShieldManager>
</RegisterVimServerParams>

Elements

Element Type Required Modifiable Since Deprecated Description
ShieldManager ShieldManagerType No always 0.9 vShield manager administrator credentials. Required for register, modify.
VimServer VimServerType Yes always 0.9 vCenter administrator credentials. Required for register, modify.

Operations

CRUD Operation Description Since Deprecated
as input POST /admin/extension/action/registervimserver Register a vCenter server and vShield manager. 1.0 34.0