community.network.avi_sslkeyandcertificate – Module for setup of SSLKeyAndCertificate Avi RESTful Object
Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.avi_sslkeyandcertificate
.
Synopsis
This module is used to configure SSLKeyAndCertificate object
more examples at https://github.com/avinetworks/devops
Parameters
Parameter |
Comments |
---|---|
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. |
|
Avi API version of to use for Avi API and objects. Default: “16.4.4” |
|
Patch operation to use when using avi_api_update_method as patch. Choices:
|
|
Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. Choices:
|
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. |
|
Avi controller version Default: “16.4.4” |
|
Avi controller IP or SQDN |
|
Avi controller API csrftoken to reuse existing session with session id |
|
Avi controller password |
|
Avi controller port |
|
Avi controller API session id to reuse existing session with csrftoken |
|
Avi controller tenant Default: “admin” |
|
Avi controller tenant UUID |
|
Avi controller request timeout Default: 300 |
|
Avi controller API token |
|
Avi controller username |
|
It disables avi session information to be cached as a fact. Choices:
|
|
Ca certificates in certificate chain. |
|
Sslcertificate settings for sslkeyandcertificate. |
|
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. Choices:
|
|
It is a reference to an object of type certificatemanagementprofile. |
|
IP address or hostname of the controller. The default value is the environment variable Default: “” |
|
Creator name. |
|
Dynamic parameters needed for certificate management profile. |
|
Encrypted private key corresponding to the private key (e.g. Those generated by an hsm such as thales nshield). |
|
Name of the encrypted private key (e.g. Those generated by an hsm such as thales nshield). |
|
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. |
|
It is a reference to an object of type hardwaresecuritymodulegroup. |
|
Private key. |
|
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. Choices:
|
|
Sslkeyparams settings for sslkeyandcertificate. |
|
Passphrase used to encrypt the private key. Field introduced in 18.1.2, 18.2.1. |
|
Name of the object. |
|
Password of Avi user in Avi controller. The default value is the environment variable Default: “” |
|
The state that should be applied on the entity. Choices:
|
|
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. |
|
Name of tenant used for all Avi API calls and context of object. Default: “admin” |
|
It is a reference to an object of type tenant. |
|
UUID of tenant used for all Avi API calls and context of object. Default: “” |
|
Enum options - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca. |
|
Avi controller URL of the object. |
|
Username used for accessing Avi controller. The default value is the environment variable Default: “” |
|
Unique object identifier of the object. |
Notes
Note
For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
SSLKeyAndCertificate (api/sslkeyandcertificate) object Returned: success, changed |
Authors
Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>