Salt Extension for VMware VCF infrastructure management (vCenter, NSX, SDDC Manager, VCF Operations, VKS, VMSP)
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file saltext_vcf-1.0.0.tar.gz.
File metadata
- Download URL: saltext_vcf-1.0.0.tar.gz
- Upload date:
- Size: 422.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c15b81a3228b5430c730390f48e38b80e081c4a796f99972a5610c043399521a
|
|
| MD5 |
589eba0db0fc0a113f6bdf0028f35326
|
|
| BLAKE2b-256 |
4879845955317d9f12330744c9d1ffb2e9b128f3d06f3234f914d8e1ea748b9c
|
Provenance
The following attestation bundles were made for saltext_vcf-1.0.0.tar.gz:
Publisher:
deploy-package-action.yml on salt-extensions/saltext-vcf
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
saltext_vcf-1.0.0.tar.gz -
Subject digest:
c15b81a3228b5430c730390f48e38b80e081c4a796f99972a5610c043399521a - Sigstore transparency entry: 1752680438
- Sigstore integration time:
-
Permalink:
salt-extensions/saltext-vcf@869700bcc086ebcfd8fc099c7b94ad71976e998a -
Branch / Tag:
refs/heads/main - Owner: https://github.com/salt-extensions
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-package-action.yml@869700bcc086ebcfd8fc099c7b94ad71976e998a -
Trigger Event:
workflow_run
-
Statement type:
File details
Details for the file saltext_vcf-1.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: saltext_vcf-1.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 416.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61a7635bb372be70d357b41c2c6a8ef7de9f44bf0641aeef8d6197d62f6dc70a
|
|
| MD5 |
365a06f72db13a3f8fd9abc9ca9f0062
|
|
| BLAKE2b-256 |
a5b880bfad149d4559394aac7a1f085606c212176e6fb4a324fb76ae8d99dbdd
|
Provenance
The following attestation bundles were made for saltext_vcf-1.0.0-py2.py3-none-any.whl:
Publisher:
deploy-package-action.yml on salt-extensions/saltext-vcf
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
saltext_vcf-1.0.0-py2.py3-none-any.whl -
Subject digest:
61a7635bb372be70d357b41c2c6a8ef7de9f44bf0641aeef8d6197d62f6dc70a - Sigstore transparency entry: 1752680558
- Sigstore integration time:
-
Permalink:
salt-extensions/saltext-vcf@869700bcc086ebcfd8fc099c7b94ad71976e998a -
Branch / Tag:
refs/heads/main - Owner: https://github.com/salt-extensions
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-package-action.yml@869700bcc086ebcfd8fc099c7b94ad71976e998a -
Trigger Event:
workflow_run
-
Statement type: