saltext.vmware.modules.vmc_sddc_clusters#

Salt execution module for Cluster management Provides methods to Retrieve, Create and Delete cluster in the target SDDC

saltext.vmware.modules.vmc_sddc_clusters.list_(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves Clusters list for the given SDDC

Please refer the VMC Get SDDC documentation to get insight of functionality and input parameters

CLI Example:


salt <minion id> vmc_sddc_cluster.get hostname=vmc.vmware.com …

hostname

The host name of VMC

refresh_key

API Token of the user which is used to get the Access Token required for VMC operations

authorization_host

Hostname of the Cloud Services Platform (CSP)

org_id

The Id of organization to which the SDDC belongs to

sddc_id

The Id of SDDC for which the clusters would be retrieved

verify_ssl (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_sddc_clusters.create(hostname, refresh_key, authorization_host, org_id, sddc_id, num_hosts, host_cpu_cores_count=None, host_instance_type=None, msft_license_config=None, storage_capacity=None, verify_ssl=True, cert=None)[source]#

Creates a new cluster for a given SDDC with passed config

Please refer the VMC create cluster documentation to get insight of functionality and input parameters

CLI Example:

salt <minion id> vmc_sddc_cluster.create hostname=vmc.vmware.com ...
hostname

The host name of VMC

refresh_key

API Token of the user which is used to get the Access Token required for VMC operations

authorization_host

Hostname of the Cloud Services Platform (CSP)

org_id

The Id of organization to which the SDDC belongs to

sddc_id

The Id of SDDC for which the cluster would be created

num_hosts: Integer

(Required) Number of hosts in a cluster

host_cpu_cores_count: Integer

(Optional) Customize CPU cores on hosts in a cluster. Specify number of cores to be enabled on hosts in a cluster

host_instance_type: enum

(Optional) The instance type for the esx hosts added to this cluster. Possible values are: i3.metal, r5.metal, i3en.metal

msft_license_config

(Optional) The desired Microsoft license status to apply to this cluster msft_license_config expects to be passed as a dict with provided licences

 msft_license_config": {
    "mssql_licensing": "string",
    "windows_licensing": "string"
}
storage_capacity: Integer

(Optional) For EBS-backed instances only, the requested storage capacity in GiB.

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

For example:

 {
    "host_cpu_cores_count": 0,
    "host_instance_type": "i3.metal",
    "msft_license_config": {
        "mssql_licensing": "ENABLED",
        "windows_licensing": "DISABLED",
        "academic_license": null
    },
    "num_hosts": 1,
    "storage_capacity": 0
}
saltext.vmware.modules.vmc_sddc_clusters.get_primary(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves the primary cluster in provided customer sddc UUID

Please refer the VMC Get primary cluster documentation to get insight of functionality and input parameters

CLI Example:

salt <minion id> vmc_sddc_cluster.get_primary_cluster hostname=vmc.vmware.com ...
hostname

The host name of VMC

refresh_key

API Token of the user which is used to get the Access Token required for VMC operations

authorization_host

Hostname of the Cloud Services Platform (CSP)

org_id

The Id of organization to which the SDDC belongs to

sddc_id

The Id of SDDC for which the cluster would be retrieved

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_sddc_clusters.delete(hostname, refresh_key, authorization_host, org_id, sddc_id, cluster_id, verify_ssl=True, cert=None)[source]#

Delete the cluster in the given SDDC Please refer the VMC Delete SDDC cluster documentation to get insight of functionality and input parameters

This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off.

CLI Example:

salt <minion id> vmc_sddc_cluster.create hostname=vmc.vmware.com ...
hostname

The host name of VMC

refresh_key

API Token of the user which is used to get the Access Token required for VMC operations

authorization_host

Hostname of the Cloud Services Platform (CSP)

org_id

The Id of organization to which the SDDC belongs to

sddc_id

The Id of SDDC for which the cluster would be deleted

cluster_id

The Id of the cluster that would get deleted

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

cert

(Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.