ansible / ansible.builtin / v2.9.3 / module / avi_pkiprofile Module for setup of PKIProfile Avi RESTful Object | "added in version" 2.3 of ansible.builtin" Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communityansible.builtin.avi_pkiprofile (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
This module is used to configure PKIProfile object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create PKIProfile object avi_pkiprofile: controller: 10.10.25.42 username: admin password: something state: present name: sample_pkiprofile
url: description: - Avi controller URL of the object. crls: description: - Certificate revocation lists. name: description: - Name of the pki profile. required: true uuid: description: - Unique object identifier of the object. state: choices: - absent - present default: present description: - The state that should be applied on the entity. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str ca_certs: description: - List of certificate authorities (root and intermediate) trusted that is used for certificate validation. password: default: '' description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: default: '' description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str crl_check: description: - When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. - Default value when not specified in API or module is interpreted by Avi Controller as True. type: bool controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str created_by: description: - Creator name. tenant_ref: description: - It is a reference to an object of type tenant. api_context: description: - Avi API context that includes current session ID and CSRF Token. - This allows user to perform single login and re-use the session. type: dict api_version: default: 16.4.4 description: - Avi API version of to use for Avi API and objects. type: str tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str is_federated: description: - This field describes the object's replication scope. - If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. - If the field is set to true, then the object is replicated across the federation. - Field introduced in 17.1.3. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool version_added: '2.4' version_added_collection: ansible.builtin avi_credentials: description: - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. suboptions: api_version: default: 16.4.4 description: - Avi controller version controller: description: - Avi controller IP or SQDN csrftoken: description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: description: - Avi controller API token username: description: - Avi controller username type: dict avi_api_patch_op: choices: - add - replace - delete description: - Patch operation to use when using avi_api_update_method as patch. version_added: '2.5' version_added_collection: ansible.builtin ignore_peer_chain: description: - When enabled, avi will not trust intermediate and root certs presented by a client. - Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool avi_api_update_method: choices: - put - patch default: put description: - Default method for object update is HTTP PUT. - Setting to patch will override that behavior to use HTTP PATCH. version_added: '2.5' version_added_collection: ansible.builtin validate_only_leaf_crl: description: - When enabled, avi will only validate the revocation status of the leaf certificate using crl. - To enable validation for the entire chain, disable this option and provide all the relevant crls. - Default value when not specified in API or module is interpreted by Avi Controller as True. type: bool avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool
obj: description: PKIProfile (api/pkiprofile) object returned: success, changed type: dict