community / community.network / 5.0.2 / module / avi_sslkeyandcertificate Module for setup of SSLKeyAndCertificate Avi RESTful Object Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>community.network.avi_sslkeyandcertificate (5.0.2) — module
Install with ansible-galaxy collection install community.network:==5.0.2
collections: - name: community.network version: 5.0.2
This module is used to configure SSLKeyAndCertificate object
more examples at U(https://github.com/avinetworks/devops)
- name: Create a SSL Key and Certificate community.network.avi_sslkeyandcertificate: controller: 10.10.27.90 username: admin password: AviNetworks123! key: | -----BEGIN PRIVATE KEY----- .... -----END PRIVATE KEY----- certificate: self_signed: true certificate: | -----BEGIN CERTIFICATE----- .... -----END CERTIFICATE----- type: SSL_CERTIFICATE_TYPE_VIRTUALSERVICE name: MyTestCert
key: description: - Private key. url: description: - Avi controller URL of the object. name: description: - Name of the object. required: true type: description: - Enum options - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca. uuid: description: - Unique object identifier of the object. state: choices: - absent - present default: present description: - The state that should be applied on the entity. format: description: - Format of the key/certificate file. - Enum options - SSL_PEM, SSL_PKCS12. - Field introduced in 18.1.2, 18.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as SSL_PEM. status: description: - Enum options - ssl_certificate_finished, ssl_certificate_pending. - Default value when not specified in API or module is interpreted by Avi Controller as SSL_CERTIFICATE_FINISHED. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str ca_certs: description: - Ca certificates in certificate chain. password: description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str controller: 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. key_base64: description: - States if the private key is base64 encoded. - Field introduced in 18.1.2, 18.2.1. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool key_params: description: - Sslkeyparams settings for sslkeyandcertificate. 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 certificate: description: - Sslcertificate settings for sslkeyandcertificate. required: true enckey_name: description: - Name of the encrypted private key (e.g. - Those generated by an hsm such as thales nshield). tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str enckey_base64: description: - Encrypted private key corresponding to the private key (e.g. - Those generated by an hsm such as thales nshield). dynamic_params: description: - Dynamic parameters needed for certificate management profile. key_passphrase: description: - Passphrase used to encrypt the private key. - Field introduced in 18.1.2, 18.2.1. 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: default: '' description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: default: '' description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: default: '' description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: default: '' 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. certificate_base64: description: - States if the certificate is base64 encoded. - Field introduced in 18.1.2, 18.2.1. - 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. hardwaresecuritymodulegroup_ref: description: - It is a reference to an object of type hardwaresecuritymodulegroup. avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool certificate_management_profile_ref: description: - It is a reference to an object of type certificatemanagementprofile.
obj: description: SSLKeyAndCertificate (api/sslkeyandcertificate) object returned: success, changed type: dict