Added documentation for new parameter

Author: danopt

plugins/README.md

@@ -1,31 +1,7 @@
 # Collections Plugins Directory
 
-This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that
-is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that
-would contain module utils and modules respectively.
-
-Here is an example directory of the majority of plugins currently supported by Ansible:
-
 ```
 └── plugins
-    ├── action
-    ├── become
-    ├── cache
-    ├── callback
-    ├── cliconf
-    ├── connection
-    ├── filter
-    ├── httpapi
-    ├── inventory
-    ├── lookup
-    ├── module_utils
-    ├── modules
-    ├── netconf
-    ├── shell
-    ├── strategy
-    ├── terminal
-    ├── test
-    └── vars
+    ├── [module_utils](https://github.com/NETWAYS/ansible-collection-elasticstack/tree/main/plugins/module_utils)
+    └── [modules](https://github.com/NETWAYS/ansible-collection-elasticstack/tree/main/plugins/modules)
 ```
-
-A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible-core/2.13/plugins/plugins.html).

plugins/modules/README.md

@@ -14,7 +14,7 @@
 
 ## `cert_info` module
 
-The netways.elasticstack.cert_info module gathers information about pkcs12 certificates generated by the Elastic stack cert util.
+The netways.elasticstack.cert_info module gathers information about pkcs12 certificates generated by the Elasticstack cert util.
 
 ### Dependencies
 - python-cryptography >= 2.5.0 on the remote node
@@ -71,9 +71,11 @@ Currently, the information of the following extensions and values will be return
 `path`:
 Absolute path to certificate. (**Default:** undefined, required)
 
-`password`:
-The password of the pkcs12 certificate. (**Default:** No default, optional)
+`passphrase`:
+The passphrase of the pkcs12 certificate. (**Default:** No default, optional)
 
+`passphrase_check`:
+This will only check the passphrase and returns a bool in the results. If enabled it won't return any certificate information, only the passphrase_check result. (**Default:** False, optional)
 
 ### Returns
 All keys and values that will be returned with the results variable of the module:
@@ -101,12 +103,15 @@ The serial number of the certificate as **str** which represents an integer.
 - `critical`: The value of critical as **str** which represents a bool.
 - `values`: The keys and their values of the extension as **str**. (See: Supported extensions)
 
+`passphrase_check`:
+A **bool** that will be `True` if the passphrase check was positive and `False`, if not. It's also possible that it returns `False` if the certificate is corrupted, since Python can't differentiate it and handles exceptions like this as a "VauleError".
+
 ### Example
 ```
 - name: Test
   cert_info:
     path: /opt/es-ca/elasticsearch-ca.pkcs12
-    password: PleaseChangeMe
+    passphrase: PleaseChangeMe
   register: test
 
 - name: Debug
@@ -156,3 +161,39 @@ ok: [localhost] => {
     }
 }
 ```
+
+### Example of passphrase_check
+```
+- name: Test correct passphrase wit passphrase_check parameter
+  cert_info:
+    path: /opt/es-ca/elasticsearch-ca.pkcs12
+    passphrase: PleaseChangeMe
+    passphrase_check: True
+  register: test
+
+- name: Debug
+  debug:
+    msg: "{{ test }}"
+```
+
+**Output**:
+```
+TASK [Test correct passphrase wit passphrase_check parameter] ******************
+ok: [localhost]
+
+TASK [Debug] *******************************************************************
+ok: [localhost] => {
+    "msg": {
+        "changed": false,
+        "extensions": {},
+        "failed": false,
+        "issuer": "",
+        "not_valid_after": "",
+        "not_valid_before": "",
+        "passphrase_check": true,
+        "serial_number": "",
+        "subject": "",
+        "version": ""
+    }
+}
+```