Data Object - OvfConsumerOstNode

Property of
ImportSpec, OvfConsumerOstNode, OvfCreateImportSpecParams, OvfParseDescriptorResult
Extends
DynamicData
See also
ManagedEntity, OvfConsumerOvfSection
Since
vSphere API 5.0

Data Object Description

A node in the OVF section tree.

This class represents a node on which OVF sections can be defined. The possible node types are OstNodeType.envelope, OstNodeType.virtualSystem or OstNodeType.virtualSystemCollection, corresponding to the identically named OVF element types.

Since the node contains a list of children, it can also be regarded as a tree. This tree mirrors the structure of the OVF descriptor. It is provided to OVF consumers as a more convenient way to navigate and modify the OVF than by working directly on the XML.

Properties

Name Type Description
child*OvfConsumerOstNode[]

The list of child nodes. As dictated by OVF, this list is subject to the following rules:
  • The Envelope node must have exactly one child.
  • VirtualSystemCollection nodes may have zero or more children.
  • VirtualSystem nodes must have no children.
entity*ManagedObjectReference
to a ManagedEntity

The VM or vApp corresponding to this node.

This field is set when this OstNode represents an existing managed entity.

The entity is unset on nodes of type OstNodeType.envelope.

idxsd:string

The OVF id of the Content (VirtualSystem or VirtualSystemCollection) element. Empty on the envelope node.
section*OvfConsumerOvfSection[]

The list of sections on this node.
typexsd:string

The type of the node. Possible values are defined in the OstNodeType enum.

Since the OstNode tree structure mirrors the structure of the OVF descriptor, only one Envelope node is defined, and it is always the root of the tree.

Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition