From f0cba249e06ed7db93664e71f329b66d290f959a Mon Sep 17 00:00:00 2001 From: Shlomo Heigh Date: Fri, 10 Mar 2023 10:13:49 -0500 Subject: [PATCH] Standardize on true/false for all booleans in docs Fixes #54 --- docs/cyberark_account.md | 4 ++-- docs/cyberark_authentication.md | 10 +++++----- docs/cyberark_credential.md | 4 ++-- docs/cyberark_user.md | 16 ++++++++-------- plugins/modules/cyberark_account.py | 4 ++-- plugins/modules/cyberark_authentication.py | 16 ++++++++-------- plugins/modules/cyberark_credential.py | 4 ++-- plugins/modules/cyberark_user.py | 14 +++++++------- roles/aimprovider/tasks/installAIMProvider.yml | 2 +- roles/aimprovider/tasks/main.yml | 2 +- roles/aimprovider/tasks/uninstallAIMProvider.yml | 2 +- tests/change_test.yml | 2 +- tests/changepolicy.yml | 2 +- tests/deprovision_account.yml | 2 +- tests/deprovision_user.yml | 2 +- tests/disable_user.yml | 2 +- tests/enable_user.yml | 2 +- tests/provision_account.yml | 2 +- tests/provision_user.yml | 2 +- tests/reset_user_password.yml | 2 +- tests/test.yml | 2 +- 21 files changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/cyberark_account.md b/docs/cyberark_account.md index d35e480..7ddb4e4 100644 --- a/docs/cyberark_account.md +++ b/docs/cyberark_account.md @@ -174,7 +174,7 @@ options: automatic_management_enabled: description: - Parameter that indicates whether the CPM will manage the password or not - default: True + default: true type: bool manual_management_reason: description: @@ -232,7 +232,7 @@ options: - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark.pas.cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/docs/cyberark_authentication.md b/docs/cyberark_authentication.md index 57a4663..7ea60d5 100644 --- a/docs/cyberark_authentication.md +++ b/docs/cyberark_authentication.md @@ -26,19 +26,19 @@ options: - A string containing the base URL of the server hosting CyberArk's Privileged Account Security Web Services SDK. validate_certs: type: bool - default: 'yes' + default: 'true' description: - If C(false), SSL certificates will not be validated. This should only set to C(false) used on personally controlled sites using self-signed certificates. use_shared_logon_authentication: type: bool - default: 'no' + default: 'false' description: - Whether or not Shared Logon Authentication will be used. use_radius_authentication: type: bool - default: 'no' + default: 'false' description: - Whether or not users will be authenticated via a RADIUS server. Valid values are true/false. cyberark_session: @@ -77,7 +77,7 @@ In addition to SSL, use Client Authentication to authenticate Ansible using a cl - name: Logon to CyberArk Vault using PAS Web Services SDK - use_shared_logon_authentication cyberark_authentication: api_base_url: "{{ web_services_base_url }}" - use_shared_logon_authentication: yes + use_shared_logon_authentication: true ``` **CyberArk Authentication**
@@ -91,7 +91,7 @@ Users can authenticate using **CyberArk**, **LDAP** or **RADIUS** authentication api_base_url: "{{ web_services_base_url }}" username: "{{ password_object.password }}" password: "{{ password_object.passprops.username }}" - use_shared_logon_authentication: no + use_shared_logon_authentication: false ``` **Logoff**
This method logs off the user and removes the Vault session. diff --git a/docs/cyberark_credential.md b/docs/cyberark_credential.md index b7b960c..046d8b2 100644 --- a/docs/cyberark_credential.md +++ b/docs/cyberark_credential.md @@ -110,14 +110,14 @@ options: - name: credential retrieval advanced cyberark_credential: api_base_url: "https://components.cyberark.local" - validate_certs: yes + validate_certs: true client_cert: /etc/pki/ca-trust/source/client.pem client_key: /etc/pki/ca-trust/source/priv-key.pem app_id: "TestID" query: "Safe=test;UserName=admin" connection_timeout: 60 query_format: Exact - fail_request_on_password_change: True + fail_request_on_password_change: true reason: "requesting credential for Ansible deployment" register: result diff --git a/docs/cyberark_user.md b/docs/cyberark_user.md index b1bfa1b..c61e173 100644 --- a/docs/cyberark_user.md +++ b/docs/cyberark_user.md @@ -27,7 +27,7 @@ options: description: - The name of the user who will be queried (for details), added, updated or deleted. type: str - required: True + required: true state: description: - Specifies the state needed for the user present for create user, absent for delete user. @@ -39,7 +39,7 @@ options: - Dictionary set by a CyberArk authentication containing the different values to perform actions on a logged-on CyberArk session, please see M(cyberark_authentication) module for an example of cyberark_session. type: dict - required: True + required: true initial_password: description: - The password that the new user will use to log on the first time. @@ -66,7 +66,7 @@ options: description: - Whether or not the user must change their password in their next logon. type: bool - default: no + default: false expiry_date: description: - The date and time when the user account will expire and become disabled. @@ -80,7 +80,7 @@ options: description: - Whether or not the user will be disabled. type: bool - default: no + default: false location: description: - The Vault Location for the user. @@ -98,7 +98,7 @@ This playbook will check if username `admin` exists, if it does not, it will pro - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: https://components.cyberark.local - use_shared_logon_authentication: yes + use_shared_logon_authentication: true - name: Create user, add to Group cyberark_user: @@ -108,7 +108,7 @@ This playbook will check if username `admin` exists, if it does not, it will pro email: "cyber.admin@ansibledev.com" initial_password: PA$$Word123 user_type_name: EPVUser - change_password_on_the_next_logon: yes + change_password_on_the_next_logon: true group_name: Auditors state: present cyberark_session: '{{ cyberark_session }}' @@ -126,7 +126,7 @@ This playbook will identify the user and delete it from the CyberArk Vault based - name: Logon to CyberArk Vault using PAS Web Services SDK - use_shared_logon_authentication cyberark_authentication: api_base_url: "{{ web_services_base_url }}" - use_shared_logon_authentication: yes + use_shared_logon_authentication: true - name: Removing a CyberArk User cyberark_user: @@ -147,7 +147,7 @@ This playbook is an example of disabling a user based on the `disabled: true` va api_base_url: "{{ web_services_base_url }}" username: "{{ password_object.password }}" password: "{{ password_object.passprops.username }}" - use_shared_logon_authentication: no + use_shared_logon_authentication: false - name: Disabling a CyberArk User cyberark_user: diff --git a/plugins/modules/cyberark_account.py b/plugins/modules/cyberark_account.py index 5e83efc..e23b493 100644 --- a/plugins/modules/cyberark_account.py +++ b/plugins/modules/cyberark_account.py @@ -138,7 +138,7 @@ description: - Parameter that indicates whether the CPM will manage the password or not. - default: False + default: false type: bool manual_management_reason: description: @@ -209,7 +209,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/plugins/modules/cyberark_authentication.py b/plugins/modules/cyberark_authentication.py index f57fab2..c8efae3 100644 --- a/plugins/modules/cyberark_authentication.py +++ b/plugins/modules/cyberark_authentication.py @@ -54,29 +54,29 @@ type: str validate_certs: type: bool - default: 'yes' + default: 'true' description: - If C(false), SSL certificates will not be validated. This should only set to C(false) used on personally controlled sites using self-signed certificates. use_ldap_authentication: type: bool - default: 'no' + default: 'false' description: - Whether or not LDAP will be used. use_windows_authentication: type: bool - default: 'no' + default: 'false' description: - Whether or not Windows will be used. use_cyberark_authentication: type: bool - default: 'no' + default: 'false' description: - Whether or not LDAP will be used. use_radius_authentication: type: bool - default: 'no' + default: 'false' description: - Whether or not users will be authenticated via a RADIUS server. Valid values are true/false. @@ -87,7 +87,7 @@ - different value for this parameter. concurrentSession: type: bool - default: False + default: false description: - Whether or not to allow concurrent sessions for the same user. cyberark_session: @@ -107,14 +107,14 @@ - name: Logon - use_shared_logon_authentication cyberark_authentication: api_base_url: "{{ web_services_base_url }}" - use_shared_logon_authentication: yes + use_shared_logon_authentication: true - name: Logon - Not use_shared_logon_authentication cyberark_authentication: api_base_url: "{{ web_services_base_url }}" username: "{{ password_object.password }}" password: "{{ password_object.passprops.username }}" - use_shared_logon_authentication: no + use_shared_logon_authentication: false - name: Logoff from CyberArk Vault cyberark_authentication: diff --git a/plugins/modules/cyberark_credential.py b/plugins/modules/cyberark_credential.py index d8f4a50..128d03b 100644 --- a/plugins/modules/cyberark_credential.py +++ b/plugins/modules/cyberark_credential.py @@ -112,14 +112,14 @@ - name: credential retrieval advanced cyberark_credential: api_base_url: "https://components.cyberark.local" - validate_certs: yes + validate_certs: true client_cert: /etc/pki/ca-trust/source/client.pem client_key: /etc/pki/ca-trust/source/priv-key.pem app_id: "TestID" query: "Safe=test;UserName=admin" connection_timeout: 60 query_format: Exact - fail_request_on_password_change: True + fail_request_on_password_change: true reason: "requesting credential for Ansible deployment" register: result diff --git a/plugins/modules/cyberark_user.py b/plugins/modules/cyberark_user.py index 5ac2318..2e4bedb 100644 --- a/plugins/modules/cyberark_user.py +++ b/plugins/modules/cyberark_user.py @@ -36,7 +36,7 @@ - The name of the user who will be queried (for details), added, updated or deleted. type: str - required: True + required: true state: description: - Specifies the state needed for the user present for create user, @@ -65,7 +65,7 @@ session, please see M(cyberark.pas.cyberark_authentication) module for an example of cyberark_session. type: dict - required: True + required: true initial_password: description: - The password that the new user will use to log on the first time. @@ -94,7 +94,7 @@ - Whether or not the user must change their password in their next logon. type: bool - default: no + default: false domain_name: description: - The name of the user domain. @@ -117,7 +117,7 @@ description: - Whether or not the user will be disabled. type: bool - default: no + default: false location: description: - The Vault Location for the user. @@ -155,14 +155,14 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: https://components.cyberark.local - use_shared_logon_authentication: yes + use_shared_logon_authentication: true - name: Create user & immediately add it to a group cyberark_user: username: username initial_password: password user_type_name: EPVUser - change_password_on_the_next_logon: no + change_password_on_the_next_logon: false group_name: GroupOfUser state: present cyberark_session: '{{ cyberark_session }}' @@ -171,7 +171,7 @@ cyberark_user: username: Username new_password: password - disabled: no + disabled: false state: present cyberark_session: '{{ cyberark_session }}' diff --git a/roles/aimprovider/tasks/installAIMProvider.yml b/roles/aimprovider/tasks/installAIMProvider.yml index 0c1e634..ea22172 100644 --- a/roles/aimprovider/tasks/installAIMProvider.yml +++ b/roles/aimprovider/tasks/installAIMProvider.yml @@ -58,7 +58,7 @@ - name: Verify status of service after installing Provider command: service aimprv status register: command_result - ignore_errors: yes + ignore_errors: true args: warn: false diff --git a/roles/aimprovider/tasks/main.yml b/roles/aimprovider/tasks/main.yml index 56c6426..9e65e1c 100644 --- a/roles/aimprovider/tasks/main.yml +++ b/roles/aimprovider/tasks/main.yml @@ -10,7 +10,7 @@ - name: Verify status of aimprv service initially command: service aimprv status register: service_already_running - ignore_errors: yes + ignore_errors: true changed_when: false args: warn: false diff --git a/roles/aimprovider/tasks/uninstallAIMProvider.yml b/roles/aimprovider/tasks/uninstallAIMProvider.yml index 9417e29..75c15f7 100644 --- a/roles/aimprovider/tasks/uninstallAIMProvider.yml +++ b/roles/aimprovider/tasks/uninstallAIMProvider.yml @@ -31,7 +31,7 @@ state: absent cyberark_session: "{{ cyberark_session }}" register: cyberarkaction - ignore_errors: yes + ignore_errors: true when: (cyberark_session.token is defined) # debug: diff --git a/tests/change_test.yml b/tests/change_test.yml index 8db42b4..8fc9e4a 100644 --- a/tests/change_test.yml +++ b/tests/change_test.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/changepolicy.yml b/tests/changepolicy.yml index 9875e13..7ec9045 100644 --- a/tests/changepolicy.yml +++ b/tests/changepolicy.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/deprovision_account.yml b/tests/deprovision_account.yml index 8aca477..6e5bb50 100644 --- a/tests/deprovision_account.yml +++ b/tests/deprovision_account.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/deprovision_user.yml b/tests/deprovision_user.yml index 18110c7..76e76cb 100644 --- a/tests/deprovision_user.yml +++ b/tests/deprovision_user.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/disable_user.yml b/tests/disable_user.yml index 8f0dec9..cad8d30 100644 --- a/tests/disable_user.yml +++ b/tests/disable_user.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/enable_user.yml b/tests/enable_user.yml index 7cad3f6..5b6c5a2 100644 --- a/tests/enable_user.yml +++ b/tests/enable_user.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/provision_account.yml b/tests/provision_account.yml index 5e9bdc3..753ae22 100644 --- a/tests/provision_account.yml +++ b/tests/provision_account.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/provision_user.yml b/tests/provision_user.yml index 64b6a23..e7bbbb7 100644 --- a/tests/provision_user.yml +++ b/tests/provision_user.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/reset_user_password.yml b/tests/reset_user_password.yml index 98fff96..d25a04c 100644 --- a/tests/reset_user_password.yml +++ b/tests/reset_user_password.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1" diff --git a/tests/test.yml b/tests/test.yml index 537d93e..7c08344 100644 --- a/tests/test.yml +++ b/tests/test.yml @@ -9,7 +9,7 @@ - name: Logon to CyberArk Vault using PAS Web Services SDK cyberark_authentication: api_base_url: "http://components.cyberark.local" - validate_certs: no + validate_certs: false username: "bizdev" password: "Cyberark1"