Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Retrieve Folders operation

The Retrieve Folders operation retrieves all the folders and the corresponding configuration on a VMware VirtualCenter, filtered by datacenter.

The following table describes the elements for this request. 

Adapter request elements for Retrieve Folders operation

Element

Definition

Required

<operation-type>

Defines the type of operation: Folder

Yes

<operation-name>

Defines the name of operation: Retrieve_Folders

Yes

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Default format for HTTPS: https://<hostName>:<port>/sdk/vim

Default format for HTTP: http://<hostName>:<port>/sdk/vim
Note: If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

No

<transport>

Specifies the transport protocol for the message

If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration.

Valid values: https-rpc (default), http-rpc
Note: If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.

No

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center

If no user name is specified, the request is executed with the user name that is specified in the configuration.

No

<password>

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

<parameters>

Contains the <datacenter> element required to execute the operation

Yes

<datacenter>

Specifies the name of the datacenter

The operation retrieves all the folders and the corresponding configuration on a VMware VirtualCenter running on the specified datacenter.

If the datacenter element is not specified, the operation retrieves all the folders existing on the VMware VirtualCenter.

Valid value: String

No

The following code sample shows a sample adapter request for the Retrieve Folders operation.

Sample adapter request for the Retrieve Folders operation

<vmware-infrastructure-request>
  <operation-type>Folder</operation-type>
  <operation-name>Retrieve_Folders</operation-name>
  <soap-url></soap-url>
  <transport></transport>
  <user-name></user-name>
  <password></password>
  <parameters>
  <datacenter>DEV1</datacenter>
  </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Retrieve Folders operation.

Sample adapter response for the Retrieve Folders operation

<vmware-infrastructure-response>
     <metadata>
       <status>success</status>
     </metadata>
     <RetrieveFoldersResponse>
       <returnval>
         <Folder>host</Folder>
         <propSet>
           <name>childEntity</name>
           <ArrayOfManagedObjectReference>
             <ClusterComputeResource>domain-c4676</ClusterComputeResource>
             <ClusterComputeResource>domain-c614</ClusterComputeResource>
             <ComputeResource>domain-s4697</ComputeResource>
           </ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>childType</name>
           <ArrayOfString>
             <string>Folder</string>
             <string>ComputeResource</string>
           </ArrayOfString>
         </propSet>
         <propSet>
           <name>configIssue</name>
           <ArrayOfEvent></ArrayOfEvent>
         </propSet>
         <propSet>
           <name>configStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>customValue</name>
           <ArrayOfCustomFieldValue></ArrayOfCustomFieldValue>
         </propSet>
         <propSet>
           <name>declaredAlarmState</name>
           <ArrayOfAlarmState>
             <AlarmState>
               <key>alarm-1.group-h4</key>
               <Folder>host</Folder>
               <Alarm>alarm-1</Alarm>
               <overallStatus>gray</overallStatus>
               <time>2009-11-17T06:48:19.09375Z</time>
             </AlarmState>
           </ArrayOfAlarmState>
         </propSet>
         <propSet>
           <name>disabledMethod</name>
           <ArrayOfString></ArrayOfString>
         </propSet>
         <propSet>
           <name>effectiveRole</name>
           <ArrayOfInt>
             <int>1</int>
           </ArrayOfInt>
         </propSet>
         <propSet>
           <name>name</name>
           <val>host</val>
         </propSet>
         <propSet>
           <name>overallStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>parent</name>
           <Datacenter>datacenter-2</Datacenter>
         </propSet>
         <propSet>
           <name>permission</name>
           <ArrayOfPermission>
             <Permission>
               <Datacenter>datacenter-2</Datacenter>
               <principal>user1</principal>
               <group>false</group>
               <roleId>1</roleId>
               <propagate>true</propagate>
             </Permission>
             <Permission>
               <Datacenter>datacenter-2</Datacenter>
               <principal>user2</principal>
               <group>false</group>
               <roleId>-2</roleId>
               <propagate>true</propagate>
             </Permission>
           </ArrayOfPermission>
         </propSet>
         <propSet>
           <name>recentTask</name>
           <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>triggeredAlarmState</name>
           <ArrayOfAlarmState></ArrayOfAlarmState>
         </propSet>
       </returnval>
       <returnval>
         <Folder>Discovered Virtual Machine</Folder>
         <propSet>
           <name>childEntity</name>
           <ArrayOfManagedObjectReference>
             <VirtualMachine>DEV_VM_ITSM703_FlightDeck</VirtualMachine>
           </ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>childType</name>
           <ArrayOfString>
             <string>Folder</string>
             <string>VirtualMachine</string>
           </ArrayOfString>
         </propSet>
         <propSet>
           <name>configIssue</name>
           <ArrayOfEvent></ArrayOfEvent>
         </propSet>
         <propSet>
           <name>configStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>customValue</name>
           <ArrayOfCustomFieldValue></ArrayOfCustomFieldValue>
         </propSet>
         <propSet>
           <name>declaredAlarmState</name>
           <ArrayOfAlarmState>
             <AlarmState>
               <key>alarm-4.group-v1853</key>
               <Folder>Discovered Virtual Machine</Folder>
               <Alarm>alarm-4</Alarm>
               <overallStatus>gray</overallStatus>
               <time>2009-11-17T06:48:19.109375Z</time>
             </AlarmState>
           </ArrayOfAlarmState>
         </propSet>
         <propSet>
           <name>disabledMethod</name>
           <ArrayOfString></ArrayOfString>
         </propSet>
         <propSet>
           <name>effectiveRole</name>
           <ArrayOfInt>
             <int>1</int>
           </ArrayOfInt>
         </propSet>
         <propSet>
           <name>name</name>
           <val>Discovered Virtual Machine</val>
         </propSet>
         <propSet>
           <name>overallStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>parent</name>
           <Folder>vm</Folder>
         </propSet>
         <propSet>
           <name>permission</name>
           <ArrayOfPermission></ArrayOfPermission>
         </propSet>
         <propSet>
           <name>recentTask</name>
           <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>triggeredAlarmState</name>
           <ArrayOfAlarmState></ArrayOfAlarmState>
         </propSet>
       </returnval>
       <returnval>
         <Folder>vm</Folder>
         <propSet>
           <name>childEntity</name>
           <ArrayOfManagedObjectReference>
             <Folder>Discovered Virtual Machine</Folder>
             <Folder>Test</Folder>
             <VirtualMachine>DEV_VM_BLOM745_Module</VirtualMachine>
             <VirtualMachine>DEV_VM_CDPBLOM745_Module</VirtualMachine>
             <VirtualMachine>VISClone1</VirtualMachine>
           </ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>childType</name>
           <ArrayOfString>
             <string>Folder</string>
             <string>VirtualMachine</string>
           </ArrayOfString>
         </propSet>
         <propSet>
           <name>configIssue</name>
           <ArrayOfEvent></ArrayOfEvent>
         </propSet>
         <propSet>
           <name>configStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>customValue</name>
           <ArrayOfCustomFieldValue></ArrayOfCustomFieldValue>
         </propSet>
         <propSet>
           <name>disabledMethod</name>
           <ArrayOfString></ArrayOfString>
         </propSet>
         <propSet>
           <name>effectiveRole</name>
           <ArrayOfInt>
             <int>1</int>
           </ArrayOfInt>
         </propSet>
         <propSet>
           <name>name</name>
           <val>vm</val>
         </propSet>
         <propSet>
           <name>overallStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>parent</name>
           <Datacenter>datacenter-2</Datacenter>
         </propSet>
         <propSet>
           <name>permission</name>
           <ArrayOfPermission>
             <Permission>
               <Datacenter>datacenter-2</Datacenter>
               <principal>user1</principal>
               <group>false</group>
               <roleId>1</roleId>
               <propagate>true</propagate>
             </Permission>
             <Permission>
               <Datacenter>datacenter-2</Datacenter>
               <principal>user2</principal>
               <group>false</group>
               <roleId>-2</roleId>
               <propagate>true</propagate>
             </Permission>
           </ArrayOfPermission>
         </propSet>
         <propSet>
           <name>recentTask</name>
           <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>triggeredAlarmState</name>
           <ArrayOfAlarmState></ArrayOfAlarmState>
         </propSet>
       </returnval>
       <returnval>
         <Folder>Test</Folder>
         <propSet>
           <name>childEntity</name>
           <ArrayOfManagedObjectReference>
             <VirtualMachine>Det3</VirtualMachine>
             <VirtualMachine>TestVM3</VirtualMachine>
           </ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>childType</name>
           <ArrayOfString>
             <string>Folder</string>
             <string>VirtualMachine</string>
           </ArrayOfString>
         </propSet>
         <propSet>
           <name>configIssue</name>
           <ArrayOfEvent></ArrayOfEvent>
         </propSet>
         <propSet>
           <name>configStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>customValue</name>
           <ArrayOfCustomFieldValue></ArrayOfCustomFieldValue>
         </propSet>
         <propSet>
           <name>disabledMethod</name>
           <ArrayOfString></ArrayOfString>
         </propSet>
         <propSet>
           <name>effectiveRole</name>
           <ArrayOfInt>
             <int>1</int>
           </ArrayOfInt>
         </propSet>
         <propSet>
           <name>name</name>
           <val>Test</val>
         </propSet>
         <propSet>
           <name>overallStatus</name>
           <ManagedEntityStatus>gray</ManagedEntityStatus>
         </propSet>
         <propSet>
           <name>parent</name>
           <Folder>vm</Folder>
         </propSet>
         <propSet>
           <name>permission</name>
           <ArrayOfPermission></ArrayOfPermission>
         </propSet>
         <propSet>
           <name>recentTask</name>
           <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference>
         </propSet>
         <propSet>
           <name>triggeredAlarmState</name>
           <ArrayOfAlarmState></ArrayOfAlarmState>
         </propSet>
       </returnval>
     </RetrieveFoldersResponse>
   </vmware-infrastructure-response>

The following table describes the response elements. 

Adapter response elements for the Retrieve Folders operations

Element

Definition

<configIssue>

Current configuration issues that have been detected for this entity

Typically, these issues have already been logged as events. The entity stores these events as long as they are still current. The configStatus property provides an overall status based on these events.

<configStatus>

Indicates whether the system has detected a configuration issue involving the entity

For example, it might have detected a duplicate IP address or MAC address, or a host in a cluster might be out of compliance. The meanings of the configStatus values are:

  • red: A problem has been detected involving the entity.
  • yellow: A problem is about to occur or a transient condition has occurred (For example, reconfigure fail-over policy).
  • green: No configuration issues have been detecte
  • gray: The configuration status of the entity is not being monitored
    A green status indicates only that a problem has not been detected; it is not a guarantee that the entity is problem-free.
<disabledMethod>

List of operations that are disabled, given the current runtime state of the entity

For example, a power-on operation always fails if a virtual machine is already powered on.

<declaredAlarmState>

A set of alarm states for alarms that apply to this managed entity

The set includes alarms defined on this entity and alarms inherited from the parent entity, or from any ancestors in the inventory hierarchy.

Alarms are inherited if they can be triggered by this entity or its descendants. This set does not include alarms that are defined on descendants of the entity.

<effectiveRole>

Access rights the current session has to the entity

<permission>

List of permissions defined for the entity

<overallStatus>

General health of this managed entity

The value combines the status of all the alarms attached to a managed entity.

If any of the alarms has a gray status, the overall status of the managed entity is gray. If any of the alarms has a red status, the overall status of the managed entity is red. If any of the alarms has a yellow status, the overall status of the managed entity is yellow. Otherwise, the overall status of the managed entity is green.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*