vcf_sddc_workload_domain

Execution module for SDDC Manager workload domain lifecycle (T6).

saltext.vcf.modules.vcf_sddc_workload_domain.validate_domain(spec, profile=None)

Validate a workload domain create spec without creating anything.

CLI Example:

salt '*' vcf_sddc_workload_domain.validate_domain spec='{...}'

saltext.vcf.modules.vcf_sddc_workload_domain.create_domain(spec, wait=False, timeout=14400, poll_interval=30, profile=None)

Create a workload domain. Returns the task body (or final result if wait).

CLI Example:

salt '*' vcf_sddc_workload_domain.create_domain spec='{...}' wait=true

saltext.vcf.modules.vcf_sddc_workload_domain.update_domain(domain_id, spec, wait=False, timeout=7200, profile=None)

Update / expand a workload domain.

CLI Example:

salt '*' vcf_sddc_workload_domain.update_domain <domain-id> spec='{...}'

saltext.vcf.modules.vcf_sddc_workload_domain.delete_domain(domain_id, wait=False, timeout=7200, profile=None)

Delete a workload domain.

CLI Example:

salt '*' vcf_sddc_workload_domain.delete_domain <domain-id>

saltext.vcf.modules.vcf_sddc_workload_domain.list_endpoints(domain_id, profile=None)

List management endpoints (vCenter, NSX, …) for domain_id.

CLI Example:

salt '*' vcf_sddc_workload_domain.list_endpoints <domain-id>

saltext.vcf.modules.vcf_sddc_workload_domain.expand_cluster(cluster_id, host_specs, wait=False, timeout=3600, profile=None)

Add hosts to a cluster.

CLI Example:

salt '*' vcf_sddc_workload_domain.expand_cluster <cluster-id> host_specs='[{...}]'

saltext.vcf.modules.vcf_sddc_workload_domain.shrink_cluster(cluster_id, host_ids, force=False, wait=False, timeout=3600, profile=None)

Remove hosts from a cluster.

CLI Example:

salt '*' vcf_sddc_workload_domain.shrink_cluster <cluster-id> host_ids='["...","..."]'

saltext.vcf.modules.vcf_sddc_workload_domain.list_edge_clusters(profile=None)

List NSX edge clusters known to SDDC Manager.

CLI Example:

salt '*' vcf_sddc_workload_domain.list_edge_clusters

saltext.vcf.modules.vcf_sddc_workload_domain.deploy_edge_cluster(spec, wait=False, timeout=7200, profile=None)

Deploy an NSX edge cluster via SDDC Manager.

CLI Example:

salt '*' vcf_sddc_workload_domain.deploy_edge_cluster spec='{...}'

saltext.vcf.modules.vcf_sddc_workload_domain.add_license_key(key, product_type, description='', profile=None)

Register a license key with SDDC Manager.

CLI Example:

salt '*' vcf_sddc_workload_domain.add_license_key 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX' VCENTER

saltext.vcf.modules.vcf_sddc_workload_domain.list_license_keys(profile=None)

List registered license keys.

CLI Example:

salt '*' vcf_sddc_workload_domain.list_license_keys

saltext.vcf.modules.vcf_sddc_workload_domain.licensing_info(profile=None)

Return licensing limits + allocation summary.

CLI Example:

salt '*' vcf_sddc_workload_domain.licensing_info

saltext.vcf.modules.vcf_sddc_workload_domain.task_wait(task_id, timeout=3600, poll_interval=10, profile=None)

Block until task_id reaches terminal status.

CLI Example:

salt '*' vcf_sddc_workload_domain.task_wait <task-id> timeout=7200

saltext.vcf.modules.vcf_sddc_workload_domain.task_get(task_id, profile=None)

Return task status.

CLI Example:

salt '*' vcf_sddc_workload_domain.task_get <task-id>

saltext.vcf.modules.vcf_sddc_workload_domain.task_retry(task_id, profile=None)

Retry a Failed task.

CLI Example:

salt '*' vcf_sddc_workload_domain.task_retry <task-id>