saltext.vcf
Salt extension for VMware Cloud Foundation 9.x. Targets the full VCF stack: vCenter, NSX, SDDC Manager, VCF Operations, VKS (Supervisor), VMSP (mediated), vSAN, and standalone ESXi.
Coverage
- vCenter — REST
/api/for clusters, hosts, VMs, datacenters, datastores, networks, storage policies, content libraries, folders, resource pools, tags, custom attributes, appliance services, KMS providers; pyVmomi/SOAP for alarms, perf, extensions, VM snapshots. - vSphere 9 Cluster Configuration Profile — desired-state profile API for vCenter-managed clusters (replaces direct ESXi REST).
- NSX — Policy API (segments, tier-0/tier-1, groups, security policies, firewall rules, services, context profiles, NAT, IP blocks/pools, DHCP, edge clusters) and Management API (node, cluster status, transport zones/nodes, compute collections, RBAC).
- SDDC Manager — hosts, clusters, workload domains, vCenters,
bundles, network pools, releases, upgrades, certificates,
credentials, VMSP service health via
/v1/vcf-services. - VCF Operations — resources, adapters, alert/symptom definitions, active alerts, policies, notifications, recommendations, RBAC (sources/roles/users/groups/privileges), collectors, credentials, super metrics, resource groups, reports, maintenance schedules, tasks, solutions, node status.
- VKS — Supervisor enablement, services catalog, namespaces, VM classes, software lifecycle, compatibility probes, kubeconfig fetch bridge to saltext-kubernetes.
- vSAN — cluster config, disk groups, fault domains, health (SOAP
at
/vsanHealth). - Salt Resources framework —
vcenter,sddc,nsx,vcfops,esxi,vcf_vmresource types for fleet-style management with grain-based targeting.
~80 execution modules, 27 state modules, 82 REST/SOAP clients across six VCF components.
Quickstart
pip install saltext-vcf
Configure pillar:
saltext.vcf:
vcenter:
host: mgmt-vc.example.com
username: administrator@vsphere.local
password: secret
verify_ssl: false
sddc_manager:
host: sddc-manager.example.com
username: administrator@vsphere.local
password: secret
verify_ssl: false
nsx:
host: mgmt-nsx.example.com
username: admin
password: secret
verify_ssl: false
vcf_ops:
host: ops.example.com
username: admin
password: secret
verify_ssl: false
Run from any minion with the extension installed:
salt-call vcf_vcenter_cluster.list_
salt-call vcf_sddc_domain.list_
salt-call vcf_nsx_segment.list_
salt-call vcf_vcfops_deployment.healthy
salt-call vcf_vcf_services.status_map
Extras
| Extra | Adds |
|---|---|
[vcenter] |
vmware-vcenter SDK for advanced vCenter REST flows |
[sddc] |
vmware-vcf SDK for SDDC Manager flows |
[vks] |
saltext-kubernetes + kubernetes for the VKS kubeconfig bridge |
pip install 'saltext-vcf[vks]'
Documentation
Full docs at https://salt-extensions.github.io/saltext-vcf/.
Local build:
pip install -e '.[docs]'
make -C docs html
xdg-open docs/_build/html/index.html
Topic guides under docs/topics/:
- Installation
- Configuration
- Resources Framework
- VKS / Supervisor bridge
- vSAN over SOAP
- VMSP mediated access
Examples per component live under docs/examples/.
Development
pip install -e '.[dev,tests,lint]'
pre-commit install
pytest tests/ -q
Live integration tests run against a real VCF lab and live in a separate integration repository; they're not part of the unit test suite here.
License
Apache 2.0. See LICENSE.
Release files for saltext.vcf 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| saltext_vcf-1.0.0.tar.gz | 422.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| saltext_vcf-1.0.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 838.7 kB
Release files / saltext_vcf-1.0.0.tar.gz
| Download URL | saltext_vcf-1.0.0.tar.gz |
|---|---|
| Size | 422.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c15b81a3228b5430c730390f48e38b80e081c4a796f99972a5610c043399521a
|
|
BLAKE2b-256 checksum How to use checksums |
4879845955317d9f12330744c9d1ffb2e9b128f3d06f3234f914d8e1ea748b9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 7, 2026.
Transparency logRelease files / saltext_vcf-1.0.0-py2.py3-none-any.whl
| Download URL | saltext_vcf-1.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 416.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
61a7635bb372be70d357b41c2c6a8ef7de9f44bf0641aeef8d6197d62f6dc70a
|
|
BLAKE2b-256 checksum How to use checksums |
a5b880bfad149d4559394aac7a1f085606c212176e6fb4a324fb76ae8d99dbdd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 7, 2026.
Transparency log