Deprecation of ESXi in core Salt in favor of Salt VMware extensions for 3008

This commit is contained in:
David Murphy 2022-11-02 13:09:11 -06:00 committed by Megan Wilhite
parent 1157e91381
commit 0508d2966d
10 changed files with 356 additions and 0 deletions

View file

@ -3,6 +3,7 @@ Module used to access the esxcluster proxy connection methods
"""
import logging
from functools import wraps
import salt.utils.platform
@ -22,5 +23,27 @@ def __virtual__():
return (False, "Must be run on a proxy minion")
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxcluster' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def get_details():
return __proxy__["esxcluster.get_details"]()

View file

@ -3,6 +3,7 @@ Module used to access the esxdatacenter proxy connection methods
"""
import logging
from functools import wraps
import salt.utils.platform
@ -22,5 +23,27 @@ def __virtual__():
return (False, "Must be run on a proxy minion")
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxdatacenter' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def get_details():
return __proxy__["esxdatacenter.get_details"]()

View file

@ -28,6 +28,7 @@ type manor.
import logging
from functools import wraps
import salt.utils.platform
@ -49,6 +50,28 @@ def __virtual__():
)
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxi' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def cmd(command, *args, **kwargs):
proxy_prefix = __opts__["proxy"]["proxytype"]
proxy_cmd = proxy_prefix + ".ch_config"
@ -56,5 +79,6 @@ def cmd(command, *args, **kwargs):
return __proxy__[proxy_cmd](command, *args, **kwargs)
@_deprecation_message
def get_details():
return __proxy__["esxi.get_details"]()

View file

@ -4,6 +4,7 @@ Module used to access the esx proxy connection methods
import logging
from functools import wraps
import salt.utils.platform
@ -23,5 +24,27 @@ def __virtual__():
return (False, "Must be run on a proxy minion")
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxvm' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def get_details():
return __proxy__["esxvm.get_details"]()

View file

@ -3,6 +3,7 @@ Module used to access the vcenter proxy connection methods
"""
import logging
from functools import wraps
import salt.utils.platform
@ -22,5 +23,27 @@ def __virtual__():
return False
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'vcenter' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def get_details():
return __proxy__["vcenter.get_details"]()

View file

@ -300,6 +300,28 @@ def __virtual__():
return __virtualname__
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'vsphere' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def get_proxy_type():
"""
Returns the proxy type retrieved either from the pillar of from the proxy
@ -470,6 +492,7 @@ def _gets_service_instance_via_proxy(fn):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi", "esxcluster", "esxdatacenter", "vcenter", "esxvm")
@_deprecation_message
def get_service_instance_via_proxy(service_instance=None):
"""
Returns a service instance to the proxied endpoint (vCenter/ESXi host).
@ -493,6 +516,7 @@ def get_service_instance_via_proxy(service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi", "esxcluster", "esxdatacenter", "vcenter", "esxvm")
@_deprecation_message
def disconnect(service_instance):
"""
Disconnects from a vCenter or ESXi host
@ -512,6 +536,7 @@ def disconnect(service_instance):
@depends(HAS_ESX_CLI)
@_deprecation_message
def esxcli_cmd(
cmd_str,
host=None,
@ -607,6 +632,7 @@ def esxcli_cmd(
@depends(HAS_ESX_CLI)
@_deprecation_message
def get_coredump_network_config(
host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None
):
@ -700,6 +726,7 @@ def get_coredump_network_config(
@depends(HAS_ESX_CLI)
@_deprecation_message
def coredump_network_enable(
host,
username,
@ -800,6 +827,7 @@ def coredump_network_enable(
@depends(HAS_ESX_CLI)
@_deprecation_message
def set_coredump_network_config(
host,
username,
@ -912,6 +940,7 @@ def set_coredump_network_config(
@depends(HAS_ESX_CLI)
@_deprecation_message
def get_firewall_status(
host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None
):
@ -1018,6 +1047,7 @@ def get_firewall_status(
@depends(HAS_ESX_CLI)
@_deprecation_message
def enable_firewall_ruleset(
host,
username,
@ -1113,6 +1143,7 @@ def enable_firewall_ruleset(
@depends(HAS_ESX_CLI)
@_deprecation_message
def syslog_service_reload(
host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None
):
@ -1193,6 +1224,7 @@ def syslog_service_reload(
@depends(HAS_ESX_CLI)
@_deprecation_message
def set_syslog_config(
host,
username,
@ -1378,6 +1410,7 @@ def set_syslog_config(
@depends(HAS_ESX_CLI)
@_deprecation_message
def get_syslog_config(
host, username, password, protocol=None, port=None, esxi_hosts=None, credstore=None
):
@ -1460,6 +1493,7 @@ def get_syslog_config(
@depends(HAS_ESX_CLI)
@_deprecation_message
def reset_syslog_config(
host,
username,
@ -1584,6 +1618,7 @@ def reset_syslog_config(
@ignores_kwargs("credstore")
@_deprecation_message
def upload_ssh_key(
host,
username,
@ -1668,6 +1703,7 @@ def upload_ssh_key(
@ignores_kwargs("credstore")
@_deprecation_message
def get_ssh_key(
host, username, password, protocol=None, port=None, certificate_verify=None
):
@ -1725,6 +1761,7 @@ def get_ssh_key(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def get_host_datetime(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -1792,6 +1829,7 @@ def get_host_datetime(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def get_ntp_config(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -1858,6 +1896,7 @@ def get_ntp_config(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def get_service_policy(
host,
username,
@ -2000,6 +2039,7 @@ def get_service_policy(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def get_service_running(
host,
username,
@ -2142,6 +2182,7 @@ def get_service_running(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def get_vmotion_enabled(
host,
username,
@ -2218,6 +2259,7 @@ def get_vmotion_enabled(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def get_vsan_enabled(
host,
username,
@ -2299,6 +2341,7 @@ def get_vsan_enabled(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def get_vsan_eligible_disks(
host,
username,
@ -2389,6 +2432,7 @@ def get_vsan_eligible_disks(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi", "esxcluster", "esxdatacenter", "vcenter", "esxvm")
@_gets_service_instance_via_proxy
@_deprecation_message
def test_vcenter_connection(service_instance=None):
"""
Checks if a connection is to a vCenter
@ -2409,6 +2453,7 @@ def test_vcenter_connection(service_instance=None):
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def system_info(
host,
username,
@ -2465,6 +2510,7 @@ def system_info(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_datacenters(
host, username, password, protocol=None, port=None, verify_ssl=True
):
@ -2511,6 +2557,7 @@ def list_datacenters(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_clusters(host, username, password, protocol=None, port=None, verify_ssl=True):
"""
Returns a list of clusters for the specified host.
@ -2555,6 +2602,7 @@ def list_clusters(host, username, password, protocol=None, port=None, verify_ssl
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_datastore_clusters(
host, username, password, protocol=None, port=None, verify_ssl=True
):
@ -2600,6 +2648,7 @@ def list_datastore_clusters(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_datastores(
host, username, password, protocol=None, port=None, verify_ssl=True
):
@ -2645,6 +2694,7 @@ def list_datastores(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_hosts(host, username, password, protocol=None, port=None, verify_ssl=True):
"""
Returns a list of hosts for the specified VMware environment.
@ -2688,6 +2738,7 @@ def list_hosts(host, username, password, protocol=None, port=None, verify_ssl=Tr
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_resourcepools(
host, username, password, protocol=None, port=None, verify_ssl=True
):
@ -2733,6 +2784,7 @@ def list_resourcepools(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_networks(host, username, password, protocol=None, port=None, verify_ssl=True):
"""
Returns a list of networks for the specified host.
@ -2776,6 +2828,7 @@ def list_networks(host, username, password, protocol=None, port=None, verify_ssl
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_vms(host, username, password, protocol=None, port=None, verify_ssl=True):
"""
Returns a list of VMs for the specified host.
@ -2819,6 +2872,7 @@ def list_vms(host, username, password, protocol=None, port=None, verify_ssl=True
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_folders(host, username, password, protocol=None, port=None, verify_ssl=True):
"""
Returns a list of folders for the specified host.
@ -2862,6 +2916,7 @@ def list_folders(host, username, password, protocol=None, port=None, verify_ssl=
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_dvs(host, username, password, protocol=None, port=None, verify_ssl=True):
"""
Returns a list of distributed virtual switches for the specified host.
@ -2905,6 +2960,7 @@ def list_dvs(host, username, password, protocol=None, port=None, verify_ssl=True
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_vapps(host, username, password, protocol=None, port=None, verify_ssl=True):
"""
Returns a list of vApps for the specified host.
@ -2949,6 +3005,7 @@ def list_vapps(host, username, password, protocol=None, port=None, verify_ssl=Tr
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_ssds(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -3018,6 +3075,7 @@ def list_ssds(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def list_non_ssds(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -3094,6 +3152,7 @@ def list_non_ssds(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def set_ntp_config(
host,
username,
@ -3189,6 +3248,7 @@ def set_ntp_config(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def service_start(
host,
username,
@ -3331,6 +3391,7 @@ def service_start(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def service_stop(
host,
username,
@ -3471,6 +3532,7 @@ def service_stop(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def service_restart(
host,
username,
@ -3613,6 +3675,7 @@ def service_restart(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def set_service_policy(
host,
username,
@ -3777,6 +3840,7 @@ def set_service_policy(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def update_host_datetime(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -3854,6 +3918,7 @@ def update_host_datetime(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def update_host_password(
host, username, password, new_password, protocol=None, port=None, verify_ssl=True
):
@ -3927,6 +3992,7 @@ def update_host_password(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def vmotion_disable(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -4003,6 +4069,7 @@ def vmotion_disable(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def vmotion_enable(
host,
username,
@ -4090,6 +4157,7 @@ def vmotion_enable(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def vsan_add_disks(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -4219,6 +4287,7 @@ def vsan_add_disks(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def vsan_disable(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -4318,6 +4387,7 @@ def vsan_disable(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def vsan_enable(
host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True
):
@ -4529,6 +4599,7 @@ def _get_dvs_infrastructure_traffic_resources(dvs_name, dvs_infra_traffic_ress):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_dvss(datacenter=None, dvs_names=None, service_instance=None):
"""
Returns a list of distributed virtual switches (DVSs).
@ -4738,6 +4809,7 @@ def _apply_dvs_network_resource_pools(network_resource_pools, resource_dicts):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_dvs(dvs_dict, dvs_name, service_instance=None):
"""
Creates a distributed virtual switch (DVS).
@ -4812,6 +4884,7 @@ def create_dvs(dvs_dict, dvs_name, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def update_dvs(dvs_dict, dvs, service_instance=None):
"""
Updates a distributed virtual switch (DVS).
@ -5040,6 +5113,7 @@ def _get_dvportgroup_dict(pg_ref):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_dvportgroups(dvs=None, portgroup_names=None, service_instance=None):
"""
Returns a list of distributed virtual switch portgroups.
@ -5097,6 +5171,7 @@ def list_dvportgroups(dvs=None, portgroup_names=None, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_uplink_dvportgroup(dvs, service_instance=None):
"""
Returns the uplink portgroup of a distributed virtual switch.
@ -5314,6 +5389,7 @@ def _apply_dvportgroup_config(pg_name, pg_spec, pg_conf):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_dvportgroup(portgroup_dict, portgroup_name, dvs, service_instance=None):
"""
Creates a distributed virtual portgroup.
@ -5369,6 +5445,7 @@ def create_dvportgroup(portgroup_dict, portgroup_name, dvs, service_instance=Non
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def update_dvportgroup(portgroup_dict, portgroup, dvs, service_instance=True):
"""
Updates a distributed virtual portgroup.
@ -5447,6 +5524,7 @@ def update_dvportgroup(portgroup_dict, portgroup, dvs, service_instance=True):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster")
@_gets_service_instance_via_proxy
@_deprecation_message
def remove_dvportgroup(portgroup, dvs, service_instance=None):
"""
Removes a distributed virtual portgroup.
@ -5528,6 +5606,7 @@ def _get_policy_dict(policy):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_storage_policies(policy_names=None, service_instance=None):
"""
Returns a list of storage policies.
@ -5561,6 +5640,7 @@ def list_storage_policies(policy_names=None, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_default_vsan_policy(service_instance=None):
"""
Returns the default vsan storage policy.
@ -5603,6 +5683,7 @@ def _get_capability_definition_dict(cap_metadata):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_capability_definitions(service_instance=None):
"""
Returns a list of the metadata of all capabilities in the vCenter.
@ -5678,6 +5759,7 @@ def _apply_policy_config(policy_spec, policy_dict):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_storage_policy(policy_name, policy_dict, service_instance=None):
"""
Creates a storage policy.
@ -5722,6 +5804,7 @@ def create_storage_policy(policy_name, policy_dict, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def update_storage_policy(policy, policy_dict, service_instance=None):
"""
Updates a storage policy.
@ -5766,6 +5849,7 @@ def update_storage_policy(policy, policy_dict, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxcluster", "esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_default_storage_policy_of_datastore(datastore, service_instance=None):
"""
Returns a list of datastores assign the storage policies.
@ -5805,6 +5889,7 @@ def list_default_storage_policy_of_datastore(datastore, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxcluster", "esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def assign_default_storage_policy_to_datastore(
policy, datastore, service_instance=None
):
@ -5856,6 +5941,7 @@ def assign_default_storage_policy_to_datastore(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "esxcluster", "vcenter", "esxvm")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_datacenters_via_proxy(datacenter_names=None, service_instance=None):
"""
Returns a list of dict representations of VMware datacenters.
@ -5899,6 +5985,7 @@ def list_datacenters_via_proxy(datacenter_names=None, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_datacenter(datacenter_name, service_instance=None):
"""
Creates a datacenter.
@ -6013,6 +6100,7 @@ def _get_cluster_dict(cluster_name, cluster_ref):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_cluster(datacenter=None, cluster=None, service_instance=None):
"""
Returns a dict representation of an ESX cluster.
@ -6192,6 +6280,7 @@ def _apply_cluster_dict(cluster_spec, cluster_dict, vsan_spec=None, vsan_61=True
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_cluster(cluster_dict, datacenter=None, cluster=None, service_instance=None):
"""
Creates a cluster.
@ -6291,6 +6380,7 @@ def create_cluster(cluster_dict, datacenter=None, cluster=None, service_instance
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def update_cluster(cluster_dict, datacenter=None, cluster=None, service_instance=None):
"""
Updates a cluster.
@ -6407,6 +6497,7 @@ def update_cluster(cluster_dict, datacenter=None, cluster=None, service_instance
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_datastores_via_proxy(
datastore_names=None,
backing_disk_ids=None,
@ -6509,6 +6600,7 @@ def list_datastores_via_proxy(
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_vmfs_datastore(
datastore_name,
disk_id,
@ -6575,6 +6667,7 @@ def create_vmfs_datastore(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def rename_datastore(datastore_name, new_datastore_name, service_instance=None):
"""
Renames a datastore. The datastore needs to be visible to the proxy.
@ -6613,6 +6706,7 @@ def rename_datastore(datastore_name, new_datastore_name, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def remove_datastore(datastore, service_instance=None):
"""
Removes a datastore. If multiple datastores an error is raised.
@ -6650,6 +6744,7 @@ def remove_datastore(datastore, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_licenses(service_instance=None):
"""
Lists all licenses on a vCenter.
@ -6683,6 +6778,7 @@ def list_licenses(service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def add_license(key, description, safety_checks=True, service_instance=None):
"""
Adds a license to the vCenter or ESXi host
@ -6773,6 +6869,7 @@ def _validate_entity(entity):
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_assigned_licenses(
entity, entity_display_name, license_keys=None, service_instance=None
):
@ -6827,6 +6924,7 @@ def list_assigned_licenses(
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def assign_license(
license_key,
license_name,
@ -6886,6 +6984,7 @@ def assign_license(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi", "esxcluster", "esxdatacenter", "vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_hosts_via_proxy(
hostnames=None, datacenter=None, cluster=None, service_instance=None
):
@ -6940,6 +7039,7 @@ def list_hosts_via_proxy(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_disks(disk_ids=None, scsi_addresses=None, service_instance=None):
"""
Returns a list of dict representations of the disks in an ESXi host.
@ -7000,6 +7100,7 @@ def list_disks(disk_ids=None, scsi_addresses=None, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def erase_disk_partitions(disk_id=None, scsi_address=None, service_instance=None):
"""
Erases the partitions on a disk.
@ -7060,6 +7161,7 @@ def erase_disk_partitions(disk_id=None, scsi_address=None, service_instance=None
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_disk_partitions(disk_id=None, scsi_address=None, service_instance=None):
"""
Lists the partitions on a disk.
@ -7138,6 +7240,7 @@ def list_disk_partitions(disk_id=None, scsi_address=None, service_instance=None)
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_diskgroups(cache_disk_ids=None, service_instance=None):
"""
Returns a list of disk group dict representation on an ESXi host.
@ -7185,6 +7288,7 @@ def list_diskgroups(cache_disk_ids=None, service_instance=None):
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_diskgroup(
cache_disk_id, capacity_disk_ids, safety_checks=True, service_instance=None
):
@ -7260,6 +7364,7 @@ def create_diskgroup(
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def add_capacity_to_diskgroup(
cache_disk_id, capacity_disk_ids, safety_checks=True, service_instance=None
):
@ -7334,6 +7439,7 @@ def add_capacity_to_diskgroup(
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def remove_capacity_from_diskgroup(
cache_disk_id,
capacity_disk_ids,
@ -7418,6 +7524,7 @@ def remove_capacity_from_diskgroup(
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def remove_diskgroup(cache_disk_id, data_accessibility=True, service_instance=None):
"""
Remove the diskgroup with the specified cache disk.
@ -7460,6 +7567,7 @@ def remove_diskgroup(cache_disk_id, data_accessibility=True, service_instance=No
@depends(HAS_PYVMOMI)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def get_host_cache(service_instance=None):
"""
Returns the host cache configuration on the proxy host.
@ -7496,6 +7604,7 @@ def get_host_cache(service_instance=None):
@depends(HAS_JSONSCHEMA)
@_supports_proxies("esxi")
@_gets_service_instance_via_proxy
@_deprecation_message
def configure_host_cache(
enabled, datastore=None, swap_size_MiB=None, service_instance=None
):
@ -7912,6 +8021,7 @@ def _set_syslog_config_helper(
@depends(HAS_PYVMOMI)
@ignores_kwargs("credstore")
@_deprecation_message
def add_host_to_dvs(
host,
username,
@ -8408,6 +8518,7 @@ def _get_esxi_proxy_details():
@depends(HAS_PYVMOMI)
@_gets_service_instance_via_proxy
@_deprecation_message
def get_vm(
name,
datacenter=None,
@ -8451,6 +8562,7 @@ def get_vm(
@depends(HAS_PYVMOMI)
@_gets_service_instance_via_proxy
@_deprecation_message
def get_vm_config_file(name, datacenter, placement, datastore, service_instance=None):
"""
Queries the virtual machine config file and returns
@ -8584,6 +8696,7 @@ def _apply_memory_config(config_spec, memory):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def get_advanced_configs(vm_name, datacenter, service_instance=None):
"""
Returns extra config parameters from a virtual machine advanced config list
@ -8635,6 +8748,7 @@ def _apply_advanced_config(config_spec, advanced_config, vm_extra_config=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def set_advanced_configs(vm_name, datacenter, advanced_configs, service_instance=None):
"""
Appends extra config parameters to a virtual machine advanced config list
@ -8707,6 +8821,7 @@ def _delete_advanced_config(config_spec, advanced_config, vm_extra_config):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def delete_advanced_configs(
vm_name, datacenter, advanced_configs, service_instance=None
):
@ -9759,6 +9874,7 @@ def _convert_units(devices):
return True
@_deprecation_message
def compare_vm_configs(new_config, current_config):
"""
Compares virtual machine current and new configuration, the current is the
@ -9855,6 +9971,7 @@ def compare_vm_configs(new_config, current_config):
@_gets_service_instance_via_proxy
@_deprecation_message
def get_vm_config(name, datacenter=None, objects=True, service_instance=None):
"""
Queries and converts the virtual machine properties to the available format
@ -10411,6 +10528,7 @@ def _get_client(server, username, password, verify_ssl=None, ca_bundle=None):
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_tag_categories(
server=None,
username=None,
@ -10456,6 +10574,7 @@ def list_tag_categories(
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_tags(
server=None,
username=None,
@ -10501,6 +10620,7 @@ def list_tags(
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def attach_tag(
object_id,
tag_id,
@ -10586,6 +10706,7 @@ def attach_tag(
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def list_attached_tags(
object_id,
managed_obj="ClusterComputeResource",
@ -10658,6 +10779,7 @@ def list_attached_tags(
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_tag_category(
name,
description,
@ -10739,6 +10861,7 @@ def create_tag_category(
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def delete_tag_category(
category_id,
server=None,
@ -10797,6 +10920,7 @@ def delete_tag_category(
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_tag(
name,
description,
@ -10870,6 +10994,7 @@ def create_tag(
@depends(HAS_PYVMOMI, HAS_VSPHERE_SDK)
@_supports_proxies("vcenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def delete_tag(
tag_id,
server=None,
@ -10929,6 +11054,7 @@ def delete_tag(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def create_vm(
vm_name,
cpu,
@ -11151,6 +11277,7 @@ def create_vm(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def update_vm(
vm_name,
cpu=None,
@ -11363,6 +11490,7 @@ def update_vm(
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def register_vm(name, datacenter, placement, vmx_path, service_instance=None):
"""
Registers a virtual machine to the inventory with the given vmx file.
@ -11446,6 +11574,7 @@ def register_vm(name, datacenter, placement, vmx_path, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def power_on_vm(name, datacenter=None, service_instance=None):
"""
Powers on a virtual machine specified by its name.
@ -11489,6 +11618,7 @@ def power_on_vm(name, datacenter=None, service_instance=None):
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def power_off_vm(name, datacenter=None, service_instance=None):
"""
Powers off a virtual machine specified by its name.
@ -11576,6 +11706,7 @@ def _remove_vm(name, datacenter, service_instance, placement=None, power_off=Non
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def delete_vm(name, datacenter, placement=None, power_off=False, service_instance=None):
"""
Deletes a virtual machine defined by name and placement
@ -11622,6 +11753,7 @@ def delete_vm(name, datacenter, placement=None, power_off=False, service_instanc
@depends(HAS_PYVMOMI)
@_supports_proxies("esxvm", "esxcluster", "esxdatacenter")
@_gets_service_instance_via_proxy
@_deprecation_message
def unregister_vm(
name, datacenter, placement=None, power_off=False, service_instance=None
):

View file

@ -41,6 +41,7 @@ Module was developed against.
import logging
import sys
from functools import wraps
import salt.exceptions
from salt.config.schemas.esxcluster import ESXClusterConfigSchema, LicenseSchema
@ -88,6 +89,28 @@ def __virtual__():
return True
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxcluster' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def mod_init(low):
"""
Retrieves and adapt the login credentials from the proxy connection module
@ -112,6 +135,7 @@ def _get_vsan_datastore(si, cluster_name):
return vsan_datastores[0]
@_deprecation_message
def cluster_configured(name, cluster_config):
"""
Configures a cluster. Creates a new cluster, if it doesn't exist on the
@ -307,6 +331,7 @@ def cluster_configured(name, cluster_config):
return ret
@_deprecation_message
def vsan_datastore_configured(name, datastore_name):
"""
Configures the cluster's VSAN datastore
@ -391,6 +416,7 @@ def vsan_datastore_configured(name, datastore_name):
return ret
@_deprecation_message
def licenses_configured(name, licenses=None):
"""
Configures licenses on the cluster entity

View file

@ -50,6 +50,7 @@ State configuration:
import logging
from functools import wraps
import salt.exceptions
@ -62,10 +63,33 @@ def __virtual__():
return "esxdatacenter"
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxdatacenter' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def mod_init(low):
return True
@_deprecation_message
def datacenter_configured(name):
"""
Makes sure a datacenter exists.

View file

@ -94,6 +94,7 @@ example.
import logging
import re
import sys
from functools import wraps
import salt.utils.files
from salt.config.schemas.esxi import DiskGroupsDiskScsiAddressSchema, HostCacheSchema
@ -143,6 +144,28 @@ def __virtual__():
return (False, "esxi module could not be loaded")
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxi' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def coredump_configured(name, enabled, dump_ip, host_vnic="vmk0", dump_port=6500):
"""
Ensures a host's core dump configuration.
@ -279,6 +302,7 @@ def coredump_configured(name, enabled, dump_ip, host_vnic="vmk0", dump_port=6500
return ret
@_deprecation_message
def password_present(name, password):
"""
Ensures the given password is set on the ESXi host. Passwords cannot be obtained from
@ -328,6 +352,7 @@ def password_present(name, password):
return ret
@_deprecation_message
def ntp_configured(
name,
service_running,
@ -510,6 +535,7 @@ def ntp_configured(
return ret
@_deprecation_message
def vmotion_configured(name, enabled, device="vmk0"):
"""
Configures a host's VMotion properties such as enabling VMotion and setting
@ -578,6 +604,7 @@ def vmotion_configured(name, enabled, device="vmk0"):
return ret
@_deprecation_message
def vsan_configured(name, enabled, add_disks_to_vsan=False):
"""
Configures a host's VSAN properties such as enabling or disabling VSAN, or
@ -670,6 +697,7 @@ def vsan_configured(name, enabled, add_disks_to_vsan=False):
return ret
@_deprecation_message
def ssh_configured(
name,
service_running,
@ -886,6 +914,7 @@ def ssh_configured(
return ret
@_deprecation_message
def syslog_configured(
name,
syslog_configs,
@ -1053,6 +1082,7 @@ def syslog_configured(
@depends(HAS_PYVMOMI)
@depends(HAS_JSONSCHEMA)
@_deprecation_message
def diskgroups_configured(name, diskgroups, erase_disks=False):
"""
Configures the disk groups to use for vsan.
@ -1383,6 +1413,7 @@ def diskgroups_configured(name, diskgroups, erase_disks=False):
@depends(HAS_PYVMOMI)
@depends(HAS_JSONSCHEMA)
@_deprecation_message
def host_cache_configured(
name,
enabled,

View file

@ -185,6 +185,7 @@ example.
import logging
import sys
from functools import wraps
import salt.exceptions
from salt.config.schemas.esxvm import ESXVirtualMachineConfigSchema
@ -228,6 +229,28 @@ def __virtual__():
return True
def _deprecation_message(function):
"""
Decorator wrapper to warn about azurearm deprecation
"""
@wraps(function)
def wrapped(*args, **kwargs):
salt.utils.versions.warn_until(
"Argon",
"The 'esxvm' functionality in Salt has been deprecated and its "
"functionality will be removed in version 3008 in favor of the "
"saltext.vmware Salt Extension. "
"(https://github.com/saltstack/salt-ext-modules-vmware)",
category=FutureWarning,
)
ret = function(*args, **salt.utils.args.clean_kwargs(**kwargs))
return ret
return wrapped
@_deprecation_message
def vm_configured(
name,
vm_name,
@ -369,6 +392,7 @@ def vm_configured(
return result
@_deprecation_message
def vm_cloned(name):
"""
Clones a virtual machine from a template virtual machine if it doesn't
@ -379,6 +403,7 @@ def vm_cloned(name):
return result
@_deprecation_message
def vm_updated(
name,
vm_name,
@ -503,6 +528,7 @@ def vm_updated(
return result
@_deprecation_message
def vm_created(
name,
vm_name,
@ -585,6 +611,7 @@ def vm_created(
return result
@_deprecation_message
def vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):
"""
Registers a virtual machine if the machine files are available on