VMware Cloud Director API - NsxTManager

VMware Cloud Director API - NsxTManager

NsxTManagerType

Element:
NsxTManager
Type:
NsxTManagerType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents credentials to a NSX-T Manager.
Since:
31.0
Schema:
vmwextensions.xsd
Media type(s):
application/vnd.vmware.admin.networkManagers+xml
application/vnd.vmware.admin.nsxTmanager+xml
application/vnd.vmware.admin.nsxTmanager+json
application/vnd.vmware.admin.networkManagers+json
Extends:
ServerType
XML Representation:
<NsxTManager 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">
    <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>
    <DeploymentType> xs:string </DeploymentType>
    <vcloud_v1.5:VirtualCenterReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:ServiceAppReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <NetworkProviderScope> xs:string </NetworkProviderScope>
    <Version> xs:string </Version>
    <vcloud_v1.5:ProxyConfigurationReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <GlobalManager> xs:boolean </GlobalManager>
    <vcloud_v1.5:LocalNsxTManagerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <LocalManagerLocationName> xs:string </LocalManagerLocationName>
</NsxTManager>

Attributes

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

Elements

Element Type Required Modifiable Since Deprecated Description
DeploymentType string No create 32.0 How the NSX-T Manager is deployed.
Description string No always 31.0 Optional description.
GlobalManager boolean No always 38.0 Set to true if the NSX-T Manager being registered is a Global NSX-T Manager.
Link LinkType No none 31.0 A reference to an entity or operation associated with this object.
LocalManagerLocationName string No none 38.0 The location name of the local Nsx-T Manager.
LocalNsxTManagerRef ReferenceType No always 38.0 Associated local NSX-T managers if this is a global manager.
NetworkProviderScope string No none 33.0 Public label of this NSX-T server visible to all tenants.
Password string No always 31.0 Cleartext password to connect to the server.
ProxyConfigurationReference ReferenceType No none 34.0 38.0 Reference to Proxy Configuration to use for contacting this NSX-T Manager. This attribute is deprecated; use /cloudapi/1.0.0/proxyRules instead. Proxy Rules will take precedence over this attribute.
ServiceAppReference ReferenceType No none 32.0 Reference to Service Application that owns this NSX-T Manager.
Tasks TasksInProgressType No none 31.0 A list of queued, running, or recently completed tasks associated with this entity.
Url anyURI Yes always 31.0 URL of the server.
Username string Yes always 31.0 User name to connect to the server.
VCloudExtension VCloudExtensionType No always 31.0 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
Version string No none 34.0 Version of the NsxT Manager.
VirtualCenterReference ReferenceType No none 32.0 Reference to linked VCenter for VMC.

Operations

CRUD Operation Description Since Deprecated
create POST /admin/extension/nsxtManagers Register an NSX-T Manager. 31.0
create POST /nsxtManagers
read GET /admin/extension/nsxtManagers/{id} Retrieve the representation of a registered NSX-T manager. 31.0
read GET /nsxtManagers/{id}
update PUT /admin/extension/nsxtManagers/{id} Update an existing NSX-T Manager. 31.0
update PUT /nsxtManagers/{id}
delete DELETE /admin/extension/nsxtManagers/{id} Delete an existing NSX-T Manager. 31.0
delete DELETE /nsxtManagers/{id}