nsx_cluster

NSX Management API — cluster status (singleton) and API VIP.

The management-plane cluster VIP is exposed only via the Manager API (/api/v1/cluster/api-virtual-ip); there is no equivalent surface on the Policy API. Reference: NSX-T API guide, “Cluster Management” section on developer.broadcom.com.

saltext.vcf.clients.nsx_cluster.status(opts, profile=None)[source]

Return cluster status: cluster_id, mgmt/control statuses, overall_status.

saltext.vcf.clients.nsx_cluster.api_virtual_ip_get(opts, profile=None)[source]

Return the current management-plane cluster VIP.

Response shape: {"ip_address": "1.2.3.4"} (ip_address may be the empty string when no VIP is set).

saltext.vcf.clients.nsx_cluster.api_virtual_ip_set(opts, ip_address, profile=None)[source]

Set the management-plane cluster VIP to ip_address.

Emits POST /api/v1/cluster/api-virtual-ip?action=set_virtual_ip&ip_address=.... NSX validates that the IP is reachable on the manager management network before accepting the request.

saltext.vcf.clients.nsx_cluster.api_virtual_ip_clear(opts, profile=None)[source]

Clear the management-plane cluster VIP.

Emits POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip. After clearing, NSX returns ip_address as an empty string on GET.