feat(vsphere): add VMware vSphere Automation (/api) spec and project - #73
Merged
michaelelrom merged 3 commits intoAug 14, 2026
Merged
Conversation
Add a second, independent Integration Model + Studio Project pair for vCenter's modern /api-based vSphere Automation API, alongside the existing /rest-based VMware vSphere vCenter project: - vmware_vsphere_automation-9.1.0.0.json: full spec (1363 ops), sourced from Broadcom's official vmware/vcf-api-specs GitHub repo rather than generated -- unlike the /rest spec, a genuine vendor-published source exists for this API generation. Security scheme narrowed from the vendor's three alternatives to one dynamic-retrieval scheme. - vmware_vsphere_automation-latest.json: curated to 22 operations, deliberately matching the /rest project's scope 1:1 (inventory listing + VM lifecycle) rather than exploring the much larger surface. - VMware vSphere Automation.project.json: same 22 workflows as the existing /rest project, rebuilt on the /api operations, wired to a separate "vSphere Automation" integration instance so both projects can run in parallel without colliding. Auth bootstraps through the legacy /rest session endpoint rather than /api/session -- confirmed live that a token minted via /rest works identically against /api/* endpoints (they share one underlying session), and this routes around a confirmed Itential Platform bug: Gateway.js unconditionally re-JSON.parses an already-decoded string response when routed through a Gateway, which throws whenever a bare string session token (like /api/session returns) isn't itself valid JSON syntax. This is a permanent fix, not a workaround. Also renamed the existing /rest project's adapter_id from "vSphere" to "vSphere vCenter" so both projects can coexist with distinct, clearly named integration instances. Only Vcenter.VM_list has been individually confirmed live (against a real vCenter 7.0.3); the other 21 workflows follow the same platform-generated task pattern (path params as flat fields, JSON bodies as requestBodyPayload/bodyContentType) but haven't each been individually exercised -- flagged in the README.
Gateway routing is a deliberate admin choice (e.g. to reach vCenter over an mTLS tunnel), not an incidental "if gateway-configured" condition specific to this project. Drop the redundant/inaccurate note and correct the same framing in the "Why /rest for Auth Bootstrap" explanation.
Broadens vmware_vsphere_automation-latest.json from 22 to 89 operations so it covers the same breadth as the /rest curated spec: full VM hardware CRUD, guest identity/power, templates/OVF, ISO mount/unmount, storage policies, and guest customization specs, in addition to the original inventory/lifecycle set.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/apisurface (Broadcom's "vSphere Automation API") alongside the existing legacy/restassets: full vendor spec, an 89-operation curated-latest.jsonmatching the/restcurated spec's scope, and aVMware vSphere AutomationStudio Project mirroring the existing/restproject's 22 workflows./restproject's integration instance tovSphere vCenterand names the new project's instancevSphere Automation, so both can run side by side under distinct integration instances./restvs/apicomparison, connection properties for the new integration, and OpenAPI/Studio Project documentation for the new assets.Test plan
vmware_vsphere_automation-latest.jsonas an Integration ModelVMware vSphere Automation.project.jsonas a Studio ProjectvSphere Automationintegration instance per the README's connection properties and confirm a workflow (e.g.List Virtual Machines) runs successfully against a 7.0 U2+ vCenter