community.network.avi_sslkeyandcertificate – Module for setup of SSLKeyAndCertificate Avi RESTful Object

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.avi_sslkeyandcertificate.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module is used to configure SSLKeyAndCertificate object
more examples at https://github.com/avinetworks/devops

Requirements

The below requirements are needed on the host that executes this module.

avisdk

Parameters

Parameter		Choices/Defaults	Comments
api_context dictionary			Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session.
api_version string		Default: "16.4.4"	Avi API version of to use for Avi API and objects.
avi_api_patch_op string		add replace delete	Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method string		put ← patch	Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials dictionary			Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
	api_version string	Default: "16.4.4"	Avi controller version
	controller string		Avi controller IP or SQDN
	csrftoken string		Avi controller API csrftoken to reuse existing session with session id
	password string		Avi controller password
	port string		Avi controller port
	session_id string		Avi controller API session id to reuse existing session with csrftoken
	tenant string	Default: "admin"	Avi controller tenant
	tenant_uuid string		Avi controller tenant UUID
	timeout string	Default: 300	Avi controller request timeout
	token string		Avi controller API token
	username string		Avi controller username
avi_disable_session_cache_as_fact boolean		no ← yes	It disables avi session information to be cached as a fact.
ca_certs string			Ca certificates in certificate chain.
certificate string / required			Sslcertificate settings for sslkeyandcertificate.
certificate_base64 boolean		no yes	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.
certificate_management_profile_ref string			It is a reference to an object of type certificatemanagementprofile.
controller string		Default: ""	IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
created_by string			Creator name.
dynamic_params string			Dynamic parameters needed for certificate management profile.
enckey_base64 string			Encrypted private key corresponding to the private key (e.g. Those generated by an hsm such as thales nshield).
enckey_name string			Name of the encrypted private key (e.g. Those generated by an hsm such as thales nshield).
format string			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.
hardwaresecuritymodulegroup_ref string			It is a reference to an object of type hardwaresecuritymodulegroup.
key string			Private key.
key_base64 boolean		no yes	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.
key_params string			Sslkeyparams settings for sslkeyandcertificate.
key_passphrase string			Passphrase used to encrypt the private key. Field introduced in 18.1.2, 18.2.1.
name string / required			Name of the object.
password string		Default: ""	Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
state string		absent present ←	The state that should be applied on the entity.
status string			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 string		Default: "admin"	Name of tenant used for all Avi API calls and context of object.
tenant_ref string			It is a reference to an object of type tenant.
tenant_uuid string		Default: ""	UUID of tenant used for all Avi API calls and context of object.
type string			Enum options - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca.
url string			Avi controller URL of the object.
username string		Default: ""	Username used for accessing Avi controller. The default value is the environment variable `AVI_USERNAME`.
uuid string			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	Returned	Description
obj dictionary	success, changed	SSLKeyAndCertificate (api/sslkeyandcertificate) object

Authors

Gaurav Rastogi (@grastogi23) <[email protected]>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_sslkeyandcertificate_module.html