5.5.2
Table Of Contents
- Using VMware vCenter Orchestrator Plug-Ins
- Contents
- Using VMware vCenter Orchestrator Plug-Ins
- Introduction to Orchestrator Plug-Ins
- Configure the Orchestrator Plug-Ins
- Using the vCenter Server Plug-In
- Configuring the vCenter Server Plug-In
- vCenter Server Plug-In Scripting API
- Using the vCenter Server Plug-In Inventory
- Access the vCenter Server Plug-In Workflow Library
- vCenter Server Plug-In Workflow Library
- Batch Workflows
- Cluster and Compute Resource Workflows
- Custom Attributes Workflows
- Datacenter Workflows
- Datastore and Files Workflows
- Datacenter Folder Management Workflows
- Host Folder Management Workflows
- Virtual Machine Folder Management Workflows
- Guest Operation Files Workflows
- Guest Operation Processes Workflows
- Power Host Management Workflows
- Basic Host Management Workflows
- Host Registration Management Workflows
- Networking Workflows
- Distributed Virtual Port Group Workflows
- Distributed Virtual Switch Workflows
- Standard Virtual Switch Workflows
- Resource Pool Workflows
- Storage Workflows
- Storage DRS Workflows
- Basic Virtual Machine Management Workflows
- Clone Workflows
- Linked Clone Workflows
- Linux Customization Clone Workflows
- Tools Clone Workflows
- Windows Customization Clone Workflows
- Device Management Workflows
- Move and Migrate Workflows
- Other Workflows
- Power Management Workflows
- Snapshot Workflows
- VMware Tools Workflows
- Using the Configuration Plug-In
- Using the vCO Library Plug-In
- Using the SQL Plug-In
- Using the SSH Plug-In
- Using the XML Plug-In
- Using the Mail Plug-In
- Using the Net Plug-In
- Using the Enumeration Plug-In
- Using the Workflow Documentation Plug-In
- Using the HTTP-REST Plug-In
- Using the SOAP Plug-In
- Using the AMQP Plug-In
- Using the SNMP Plug-In
- Using the Active Directory Plug-In
- Using the Dynamic Types Plug-In
- Configuring and Using the Multi-Node Plug-In
- Using the PowerShell Plug-In
- Using the PowerShell Plug-In Inventory
- Configuring the PowerShell Plug-In
- Running PowerShell Scripts
- Generating Actions
- Passing Invocation Results Between Actions
- PowerCLI Integration with the PowerShell Plug-In
- Sample Workflows
- Access the PowerShell Plug-In API
- Working with PowerShell Results
- Examples of Scripts for Common PowerShell Tasks
- Troubleshooting
- Index
Using the Workflow Documentation
Plug-In 12
You can use the Workflow Documentation plug-in to generate PDF documentation about a specific
workflow or workflow category.
This chapter includes the following topics:
n
“Workflow Library for the Workflow Documentation Plug-In,” on page 77
n
“Generate Workflow Documentation,” on page 77
Workflow Library for the Workflow Documentation Plug-In
With the Workflow Documentation plug-in workflows you can generate PDF documentation about specific
workflows or workflow categories.
You can access these workflows from Library > Workflow documentation in the Workflows view of the
Orchestrator client.
Get documentation for
workflow
Generates information about a workflow that you select.
Get documentation for
workflow category
Generates information about a workflow category that you select.
Generate Workflow Documentation
You can export documentation in PDF format about a workflow or a workflow folder that you select at any
time.
The exported document contains detailed information about the selected workflow or the workflows in the
folder. The information about each workflow includes name, version history of the workflow, attributes,
parameter presentation, workflow schema, and workflow actions. In addition, the documentation also
provides the source code for the used actions.
Procedure
1 From the drop-down menu in the Orchestrator client, select Run or Design.
2 Click the Workflows view.
3 Navigate to the workflow or workflow folder for which you want to generate documentation and right-
click it.
4 Select Generate documentation.
5 Browse to locate the folder in which to save the PDF file, provide a file name, and click Save.
VMware, Inc.
77