Merge branch 'main' into content-library-only

Author: jgangel

.pre-commit-config.yaml

@@ -10,6 +10,7 @@ repos:
       - id: mixed-line-ending     # Replaces or checks mixed line ending.
         args: [--fix=lf]
       - id: end-of-file-fixer     # Makes sure files end in a newline and only a newline.
+        exclude: changelog/*
       - id: check-merge-conflict  # Check for files that contain merge conflict strings.
       - id: check-ast             # Simply check whether files parse as valid python.
 

README.md

@@ -26,7 +26,7 @@ The [Salt Contributing guide][salt-contributing] has a lot of relevant informati
     # Change to the repo dir
     cd salt-ext-modules-vmware
 
-    # Create a new venv
+    # Create a new venv, after sourcing activate `python` will refer to python3.
     python3 -m venv env --prompt vmw-ext
     source env/bin/activate
 
@@ -54,20 +54,53 @@ The [Salt Contributing guide][salt-contributing] has a lot of relevant informati
     # 1. Make a local salt dir
     mkdir -p local/etc/salt
 
-    # 2. Create a minion config
+    # 2. Make a local dir for salt state files
+    mkdir -p local/srv/salt
+
+    # 3. Make a local dir for salt pillar files
+    mkdir -p local/srv/pillar
+
+    # 4. Create a minion config
     cat << EOF> local/etc/salt/minion
     user: $(whoami)
     root_dir: $PWD/local/
     file_root: $PWD/local
     master: localhost
     id: saltdev
     master_port: 55506
+    pillar_roots:
+      base:
+        - $PWD/local/srv/pillar
+    EOF
+
+    # 5. Make a Saltfile
+    cat << EOF> Saltfile
+    salt-call:
+      local: true
+      config_dir: local/etc/salt
+    EOF
+
+    # 6. Create a pillar file for you configuration
+    cat << EOF> local/srv/my_vsphere_conf.sls
+    # vCenter
+    saltext.vmware:
+      # Or use IP address, e.g. 203.0.113.42
+      host: vsphere.example.com
+      password: CorrectHorseBatteryStaple
+      user: BobbyTables
+    EOF
+
+    # 7. Create a pillar top file
+    cat << EOF>  local/srv/pillar.sls
+    base:
+      saltdev:
+        - my_vsphere_conf
     EOF
 
-    # 3. Create a test config file:
+    # 8. (deprecated but not removed yet) If you're contributing to the project and need to run the tests, create a test config file:
     python tools/test_value_scraper.py -c local/vcenter.conf
 
-    # 4. Create a test config file for VMC:
+    # 9. (deprecated but not removed yet) Create a test config file for VMC:
     python tools/test_value_scraper_vmc.py --help
     This command will return the required information.
 

changelog/333.added

@@ -0,0 +1,2 @@
+Added modules storage_policy.find and storage_policy.save.
+Added state storage_policy.config.

docs/ref/modules/all.rst

@@ -32,6 +32,7 @@ Execution Modules
     saltext.vmware.modules.nsxt_transport_zone
     saltext.vmware.modules.nsxt_uplink_profiles
     saltext.vmware.modules.ssl_adapter
+    saltext.vmware.modules.storage_policies
     saltext.vmware.modules.subscribed_library
     saltext.vmware.modules.tag
     saltext.vmware.modules.vm

docs/ref/modules/saltext.vmware.modules.storage_policies.rst

@@ -0,0 +1,6 @@
+
+saltext.vmware.modules.storage_policies
+=======================================
+
+.. automodule:: saltext.vmware.modules.storage_policies
+    :members:

docs/ref/states/all.rst

@@ -26,6 +26,7 @@ State Modules
     saltext.vmware.states.nsxt_transport_node_profiles
     saltext.vmware.states.nsxt_transport_zone
     saltext.vmware.states.nsxt_uplink_profiles
+    saltext.vmware.states.storage_policies
     saltext.vmware.states.tag
     saltext.vmware.states.vm
     saltext.vmware.states.vmc_dhcp_profiles

docs/ref/states/saltext.vmware.states.storage_policies.rst

@@ -0,0 +1,6 @@
+
+saltext.vmware.states.storage_policies
+======================================
+
+.. automodule:: saltext.vmware.states.storage_policies
+    :members:

src/saltext/vmware/modules/esxi.py

@@ -1775,6 +1775,63 @@ def remove_user(
         raise salt.exceptions.SaltException(str(exc))
 
 
+def get_user(
+    user_name,
+    datacenter_name=None,
+    cluster_name=None,
+    host_name=None,
+    service_instance=None,
+    profile=None,
+):
+    """
+    Get local user on matching ESXi hosts.
+
+    user_name
+        User to delete on matching ESXi hosts. (required).
+
+    datacenter_name
+        Filter by this datacenter name (required when cluster is specified)
+
+    cluster_name
+        Filter by this cluster name (optional)
+
+    host_name
+        Filter by this ESXi hostname (optional)
+
+    service_instance
+        Use this vCenter service connection instance instead of creating a new one. (optional).
+
+    profile
+        Profile to use (optional)
+
+    .. code-block:: bash
+
+        salt '*' vmware_esxi.get_user user_name=foo
+    """
+    log.debug("Running vmware_esxi.get_user")
+    ret = {}
+    service_instance = service_instance or utils_connect.get_service_instance(
+        config=__opts__, profile=profile
+    )
+    hosts = utils_esxi.get_hosts(
+        service_instance=service_instance,
+        host_names=[host_name] if host_name else None,
+        cluster_name=cluster_name,
+        datacenter_name=datacenter_name,
+        get_all_hosts=host_name is None,
+    )
+
+    try:
+        for host in hosts:
+            user_account = host.configManager.userDirectory.RetrieveUserGroups(
+                None, user_name, None, None, True, True, False
+            )
+            ret[host.name] = user_account
+        return ret
+    except DEFAULT_EXCEPTIONS as exc:
+        raise salt.exceptions.SaltException(str(exc))
+
+
 def _get_net_stack(network_tcpip_stack):
     return {
         "default": "defaultTcpipStack",