Lab: Create and Execute Orchestrator Workflow for Automated Log Collection
Objectives
- Configure VCF Operations Orchestrator and connect to vCenter
- Browse and run pre-built workflows from the workflow library
- Create a custom workflow for automated log collection across hosts
- Schedule workflow execution for recurring support tasks
- Run a workflow from a VCF Operations alert through the Management Pack for Orchestrator
Prerequisites
VVF lab with the VCF Operations orchestrator appliance deployed from its OVA (4 vCPU, 12 GB memory, 200 GB disk) and authenticated against vCenter (vracli vro authentication set -p vsphere). vCenter operational.
Prior labs: vvf-support-12
Required skills:
- VCF Operations UI basics
- Basic scripting concepts
- vCenter administration
Lab Environment
Holodeck vSphere Foundation 9.0 instance (New-HoloDeckInstance -VVF) with VCF Operations, plus a standalone VCF Operations orchestrator appliance deployed from its OVA (4 vCPU / 12 GB / 200 GB) with vSphere as the authentication provider.
Credentials
| System | Username | Password |
|---|---|---|
| Orchestrator | member of the Orchestrator admin group (vSphere SSO) | Set during deployment |
| vCenter | administrator@vsphere.local | Holodeck documented default (Post Deployment table) |
| VCF Operations | admin | Holodeck documented default (Post Deployment table) |
Tasks
Task 1 Configure Orchestrator and Explore Pre-Built Workflows
manageabilityOrchestrator automates repetitive support tasks. Understanding configuration and the pre-built workflow library is foundational for Obj 5.9.
Open the VCF Operations orchestrator client at https://<orchestrator-fqdn> and log in as a member of the Orchestrator administrative group (a vSphere SSO group). On the appliance as root, confirm the authentication provider: vracli vro authentication (should report vsphere). Health: curl -k https://<orchestrator-fqdn>/vco/api/healthstatus.
If the vCenter inventory is not yet registered: Library → Workflows → search 'add a vcenter' → run 'Add a vCenter Server instance' (vSphere plug-in). Enter the vCenter FQDN, connection properties and credentials, accept the certificate.
Browse the workflow library: Library → Workflows → browse the folder tree (Library/vCenter and others). Note the pre-built workflows available.
Run a pre-built workflow: Select 'Create a snapshot for all VMs in a resource pool' → Run. Select target resource pool. Set snapshot name and description.
Review workflow execution history: Activity → Workflow Runs → select the completed run. Review: start time, duration, status (completed/failed), input/output parameters, logs; nested workflow runs appear in a tree view.
Validation Gate
Check: Orchestrator configured, pre-built workflow executed successfully
Expected: vCenter endpoint connected. Snapshot workflow completed. Execution history recorded.
Common Errors
Task 2 Create Custom Workflow for Automated Log Collection
manageabilityCustom workflows automate repetitive support tasks. Building a log collection workflow demonstrates Orchestrator's scripting and action chaining capabilities.
Library → Workflows → New Workflow. Name: 'Automated ESXi Log Collection'. Description: 'Collects support bundles from all ESXi hosts in a cluster and stores in central location.'
Define input parameters: Add parameter 'targetCluster' (type: VC:ClusterComputeResource) — this lets the operator select which cluster to collect logs from.
Add workflow elements in sequence: (1) 'Get hosts in cluster' action — retrieves all ESXi hosts from targetCluster. (2) For-each loop over hosts. (3) Inside loop: 'Run SSH command' action — executes 'vm-support -w /vmfs/volumes/<datastore>/bundles' on each host (the documented ESX bundle command, VCF 9.0.1 docs p.1780; -w writes to a datastore directory instead of /tmp).
Add error handling: Wrap the SSH command in a try-catch block. On failure, log the error and continue to next host (don't stop the entire workflow for one host failure).
Add final action: 'Send email notification' — sends summary email listing which hosts succeeded and which failed. Configure SMTP settings if not already done.
Validate and save workflow. Click 'Validate' to check for binding errors or missing connections. Fix any validation warnings.
Test run: Execute workflow → select target cluster → monitor execution in Runs tab.
Validation Gate
Check: Custom workflow created, validated, and executed successfully
Expected: Workflow runs against cluster. Log collection completes on all hosts (or gracefully handles failures).
Common Errors
Task 3 Schedule Workflow and Configure Event Triggers
manageabilityScheduling and event-based triggers turn manual workflows into automated operations — key for proactive support and exam Obj 5.9.
Schedule the log collection workflow: Library → Workflows → select 'Automated ESXi Log Collection' → Schedule. Set: Daily at 02:00 UTC, target cluster pre-selected.
Connect alerts to the workflow from the VCF Operations side (VCF 9.0.1 docs p.4538): install and configure the Management Pack for Orchestrator in VCF Operations (Administration > Integrations) against this Orchestrator, make sure the same vCenter is known to both, map the log-collection workflow to the Host System object type as an action, then map it to a host alert through a recommendation so the alert shows a Run Action button.
Review the mapping: the workflow appears as an action on Host System objects, and the host alert's recommendation offers it with the affected host as input.
Test: raise a host alert in VCF Operations (lab only), open it and use Run Action; confirm the workflow run under Activity → Workflow Runs in Orchestrator.
Document automation patterns: List 3 common support scenarios that benefit from Orchestrator automation: (1) Proactive log collection on alert, (2) Scheduled compliance checks, (3) Automated VM snapshot cleanup (delete snapshots >7 days old).
Validation Gate
Check: Workflow scheduled, event trigger configured, automation patterns documented
Expected: Scheduled task visible. Policy trigger configured. Three automation use cases documented.
Common Errors
Final Validation
Orchestrator configured, custom workflow created and tested, scheduling and event triggers operational
✓ Orchestrator connected to vCenter → Endpoint shows 'Connected'
✓ Pre-built workflow executed → Snapshot workflow completed successfully
✓ Custom log collection workflow works → Support bundles generated on target hosts
✓ Schedule configured → Daily schedule visible in Scheduled Tasks
✓ Event trigger configured → Policy with critical alert trigger and workflow action
Cleanup / Restore
• Disable scheduled tasks if not needed for ongoing lab use
• Delete test snapshots created by pre-built workflow
• Remove event trigger policies to prevent unintended workflow execution
Design Reflection (VCDX)
Orchestrator transforms reactive support into proactive operations. Architects should design automation runbooks that cover the top-10 support scenarios, reducing human intervention and MTTR.
Requirements
- Automate log collection across all cluster hosts
- Event-driven response to critical alerts
Constraints
- SSH must be enabled on target hosts (security consideration)
- Orchestrator needs sufficient resources for concurrent workflow execution
Assumptions
- vCenter endpoint credentials remain valid
- SMTP configured for email notifications (optional in lab)
Risks
- Overly aggressive event triggers can cause workflow storms — implement cooldown periods
- SSH access to ESXi hosts creates security surface — restrict to Orchestrator service account only
Self-Assessment Discussion Prompts
- What safeguards prevent an event trigger from creating an infinite loop of workflow executions?
- How would you design an Orchestrator workflow for automated host remediation (vLCM patch + reboot)?
- What are the security implications of Orchestrator having SSH access to all ESXi hosts?
Extensions
Create a workflow that generates a weekly vSAN health report and emails it to the ops team
Build an automated snapshot cleanup workflow that deletes snapshots older than 7 days
Integrate Orchestrator with a ticketing system (ServiceNow) to auto-create incidents on critical alerts
Create a multi-step remediation workflow: detect disk failure → evacuate data → create support ticket
⚠ Known Pitfalls
References
- VCF 9.0 documentation — VCF Operations orchestrator (deploy, authentication, scheduling, policies)Tier 1 — Official
- VCF 9.0 documentation — Developing workflows in VCF Operations orchestratorTier 1 — Official
- VCF 9.0 documentation — VCF Operations alerts and Management Pack for OrchestratorTier 1 — Official