vcenter_appliance¶
Client for vCenter appliance APIs under /api/appliance/.
Covers the VAMI-equivalent REST surface: services, system version, health summary, DNS, syslog forwarding, and the Customer Experience Improvement Program (CEIP) opt-in.
Note: /api/appliance/health/system returns a JSON-encoded plain string
(e.g. "green") rather than a dict. utils/vcenter.api_get returns
that string verbatim; callers should not assume a dict shape.
- saltext.vcf.clients.vcenter_appliance.services_list(opts, profile=None)[source]¶
Return the dict of appliance services, keyed by service id.
- saltext.vcf.clients.vcenter_appliance.health_system(opts, profile=None)[source]¶
Return the overall health status string (e.g.
"green").
- saltext.vcf.clients.vcenter_appliance.dns_get(opts, profile=None)[source]¶
Return
{"mode": "is_static"|"dhcp", "servers": [...]}.
- saltext.vcf.clients.vcenter_appliance.logging_forwarding_set(opts, servers, profile=None)[source]¶
Replace the syslog forwarding destination list.
servers is a list of forwarder configs, each shaped like:
{"hostname": "collector.example.com", "port": 514, "protocol": "UDP"}
- saltext.vcf.clients.vcenter_appliance.ceip_get(opts, profile=None)[source]¶
Return the CEIP participation config:
{"accepted": bool}.On some vCenter builds the endpoint returns a bare
{"accepted": ...}dict; on others the value is wrapped as{"value": {"accepted": ...}}. Callers should tolerate both shapes.