W3cubDocs

/Ansible

avi_sslkeyandcertificate - Module for setup of SSLKeyAndCertificate Avi RESTful Object

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • avisdk

Options

parameter required default choices comments
api_version
no
Avi API version of to use for Avi API and objects.
ca_certs
no
Ca certificates in certificate chain.
certificate
yes
Sslcertificate settings for sslkeyandcertificate.
certificate_management_profile_ref
no
It is a reference to an object of type certificatemanagementprofile.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
created_by
no
Creator name.
dynamic_params
no
Dynamic parameters needed for certificate management profile.
enckey_base64
no
Encrypted private key corresponding to the private key (e.g.
Those generated by an hsm such as thales nshield).
enckey_name
no
Name of the encrypted private key (e.g.
Those generated by an hsm such as thales nshield).
hardwaresecuritymodulegroup_ref
no
It is a reference to an object of type hardwaresecuritymodulegroup.
key
no
Private key.
key_params
no
Sslkeyparams settings for sslkeyandcertificate.
name
yes
Name of the object.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
no present
  • absent
  • present
The state that should be applied on the entity.
status
no
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
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
type
no
Enum options - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca.
Default value when not specified in API or module is interpreted by Avi Controller as SSL_CERTIFICATE_TYPE_VIRTUALSERVICE.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Unique object identifier of the object.

Examples

- name: Create a SSL Key and Certificate
  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 Return Values, the following are the fields unique to this module:

name description returned type sample
obj SSLKeyAndCertificate (api/sslkeyandcertificate) object success, changed dict

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/avi_sslkeyandcertificate_module.html