VMware Cloud Director API - ShieldManager

ShieldManagerType

Element:

ShieldManager

Type:

ShieldManagerType

Namespace:

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

Description:

Represents credentials to a vShield Manager server.

Since:

0.9

Schema:

vmwextensions.xsd

Media type(s):

application/vnd.vmware.admin.vshieldmanager+xml
application/vnd.vmware.admin.vshieldmanager+json

Extends:

ServerType

XML Representation:

<ShieldManager 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>
    <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>

Attributes

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

Elements

Element	Type	Required	Modifiable	Since	Description
AssociatedVimServer	ReferenceType	No	always	0.9	Reference to the vCenter server for this vShield manager.
ControlVmDatastoreName	string	No	always	30.0	Name of the Datastore to use for creating Control VM for Cross-VDC Networking.
ControlVmManagementInterfaceName	string	No	always	30.0	Name of the management interface to use for creating Control VM for Cross-VDC Networking.
ControlVmResourcePoolVcPath	string	No	always	31.0	Path to the resource pool to use for creating Control VM for Cross-VDC Networking.
Description	string	No	always	0.9	Optional description.
Link	LinkType	No	none	0.9	A reference to an entity or operation associated with this object.
NetworkProviderScope	string	No	none	31.0	Public label of this NSX server visible to all tenants.
Password	string	No	always	0.9	Cleartext password to connect to the server.
SoftwareVersion	string	No	always	34.0	Version of the NSX-V Manager
Tasks	TasksInProgressType	No	none	0.9	A list of queued, running, or recently completed tasks associated with this entity.
Url	anyURI	Yes	always	0.9	URL of the server.
Username	string	Yes	always	0.9	User name to connect to the server.
VCloudExtension	VCloudExtensionType	No	always	0.9	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /admin/extension/vsm/{id}	Retrieve vShield Manager configuration details, including administrator credentials.	5.1
update	PUT /admin/extension/vsm/{id}	Update vShield Manager configuration details, including administrator credentials.	5.1