ansible / ansible.builtin / v2.9.27 / module / ipa_subca Manage FreeIPA Lightweight Sub Certificate Authorities. | "added in version" 2.5 of ansible.builtin" Authors: Abhijeet Kasurde (@Akasurde) preview | supported by communityansible.builtin.ipa_subca (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
Add, modify, enable, disable and delete an IPA Lightweight Sub Certificate Authorities using IPA API.
# Ensure IPA Sub CA is present - ipa_subca: ipa_host: spider.example.com ipa_pass: Passw0rd! state: present subca_name: AnsibleSubCA1 subca_subject: 'CN=AnsibleSubCA1,O=example.com' subca_desc: Ansible Sub CA
# Ensure that IPA Sub CA is removed - ipa_subca: ipa_host: spider.example.com ipa_pass: Passw0rd! state: absent subca_name: AnsibleSubCA1
# Ensure that IPA Sub CA is disabled - ipa_subca: ipa_host: spider.example.com ipa_pass: Passw0rd! state: disable subca_name: AnsibleSubCA1
state: choices: - present - absent - enabled - disabled default: present description: - State to ensure - State 'disable' and 'enable' is available for FreeIPA 4.4.2 version and onwards required: false ipa_host: default: ipa.example.com description: - IP or hostname of IPA server. - If the value is not specified in the task, the value of environment variable C(IPA_HOST) will be used instead. - If both the environment variable C(IPA_HOST) and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server. - The relevant entry needed in FreeIPA is the 'ipa-ca' entry. - If neither the DNS entry, nor the environment C(IPA_HOST), nor the value are available in the task, then the default value will be used. - Environment variable fallback mechanism is added in Ansible 2.5. type: str ipa_pass: description: - Password of administrative user. - If the value is not specified in the task, the value of environment variable C(IPA_PASS) will be used instead. - Note that if the 'urllib_gssapi' library is available, it is possible to use GSSAPI to authenticate to FreeIPA. - If the environment variable C(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server. - If the environment variable C(KRB5_CLIENT_KTNAME) is available, and C(KRB5CCNAME) is not; the module will use this kerberos keytab to authenticate. - If GSSAPI is not available, the usage of 'ipa_pass' is required. - Environment variable fallback mechanism is added in Ansible 2.5. type: str ipa_port: default: 443 description: - Port of FreeIPA / IPA server. - If the value is not specified in the task, the value of environment variable C(IPA_PORT) will be used instead. - If both the environment variable C(IPA_PORT) and the value are not specified in the task, then default value is set. - Environment variable fallback mechanism is added in Ansible 2.5. type: int ipa_prot: choices: - http - https default: https description: - Protocol used by IPA server. - If the value is not specified in the task, the value of environment variable C(IPA_PROT) will be used instead. - If both the environment variable C(IPA_PROT) and the value are not specified in the task, then default value is set. - Environment variable fallback mechanism is added in Ansible 2.5. type: str ipa_user: default: admin description: - Administrative account used on IPA server. - If the value is not specified in the task, the value of environment variable C(IPA_USER) will be used instead. - If both the environment variable C(IPA_USER) and the value are not specified in the task, then default value is set. - Environment variable fallback mechanism is added in Ansible 2.5. type: str subca_desc: description: - The Sub Certificate Authority's description. required: true subca_name: aliases: - name description: - The Sub Certificate Authority name which needs to be managed. required: true ipa_timeout: default: 10 description: - Specifies idle timeout (in seconds) for the connection. - For bulk operations, you may want to increase this in order to avoid timeout from IPA server. - If the value is not specified in the task, the value of environment variable C(IPA_TIMEOUT) will be used instead. - If both the environment variable C(IPA_TIMEOUT) and the value are not specified in the task, then default value is set. type: int subca_subject: description: - The Sub Certificate Authority's Subject. e.g., 'CN=SampleSubCA1,O=testrelm.test' required: true validate_certs: default: true description: - This only applies if C(ipa_prot) is I(https). - If set to C(no), the SSL certificates will not be validated. - This should only set to C(no) used on personally controlled sites using self-signed certificates. type: bool
subca: description: IPA Sub CA record as returned by IPA API. returned: always type: dict