feature: Set api_token and validate_certs module parameters via environment variable (#136)

* Added missing env-fallback parameters to argument-spec

* add PR# to Changelog fragement

* Update changelogs/fragments/136-api-token-env-var-support.yml

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/doc_fragments/proxmox.py with new env-vars

---------

Co-authored-by: Felix Fontein <[email protected]>

Author: Bytesalat

changelogs/fragments/136-api-token-env-var-support.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - proxmox* modules - added fallback environment variables for ``api_token``, ``api_secret``, and ``validate_certs`` (https://github.com/ansible-collections/community.proxmox/issues/63, https://github.com/ansible-collections/community.proxmox/pull/136).

plugins/doc_fragments/proxmox.py

@@ -14,6 +14,7 @@ class ModuleDocFragment(object):
   api_host:
     description:
       - Specify the target host of the Proxmox VE cluster.
+      - Uses the E(PROXMOX_HOST) environment variable if not specified.
     type: str
     required: true
   api_port:
@@ -25,25 +26,29 @@ class ModuleDocFragment(object):
   api_user:
     description:
       - Specify the user to authenticate with.
+      - Uses the E(PROXMOX_USER) environment variable if not specified.
     type: str
     required: true
   api_password:
     description:
       - Specify the password to authenticate with.
-      - You can use E(PROXMOX_PASSWORD) environment variable.
+      - Uses the E(PROXMOX_PASSWORD) environment variable if not specified.
     type: str
   api_token_id:
     description:
       - Specify the token ID.
+      - Uses the E(PROXMOX_TOKEN_ID) environment variable if not specified.
     type: str
   api_token_secret:
     description:
       - Specify the token secret.
+      - Uses the E(PROXMOX_TOKEN_SECRET) environment variable if not specified.
     type: str
   validate_certs:
     description:
       - If V(false), SSL certificates will not be validated.
       - This should only be used on personally controlled sites using self-signed certificates.
+      - Uses the E(PROXMOX_VALIDATE_CERTS) environment variable if not specified.
     type: bool
     default: false
 requirements: ["proxmoxer >= 2.0", "requests"]

plugins/module_utils/proxmox.py

@@ -43,13 +43,16 @@ def proxmox_auth_argument_spec():
                           fallback=(env_fallback, ['PROXMOX_PASSWORD'])
                           ),
         api_token_id=dict(type='str',
-                          no_log=False
+                          no_log=False,
+                          fallback=(env_fallback, ['PROXMOX_TOKEN_ID'])
                           ),
         api_token_secret=dict(type='str',
-                              no_log=True
+                              no_log=True,
+                              fallback=(env_fallback, ['PROXMOX_TOKEN_SECRET'])
                               ),
         validate_certs=dict(type='bool',
-                            default=False
+                            default=False,
+                            fallback=(env_fallback, ['PROXMOX_VALIDATE_CERTS'])
                             ),
     )