New in version 2.3.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
api_context
(added in 2.5) |
|
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
|
Default:
16.4.4
|
Avi API version of to use for Avi API and objects.
|
avi_api_patch_op
(added in 2.5) |
|
Patch operation to use when using avi_api_update_method as patch.
|
avi_api_update_method
(added in 2.5) |
|
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
|
avi_credentials
(added in 2.5) |
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
ca_certs
|
|
Ca certificates in certificate chain.
|
certificate
required |
|
Sslcertificate settings for sslkeyandcertificate.
|
certificate_management_profile_ref
|
|
It is a reference to an object of type certificatemanagementprofile.
|
controller
|
Default:
|
IP address or hostname of the controller. The default value is the environment variable
AVI_CONTROLLER . |
created_by
|
|
Creator name.
|
dynamic_params
|
|
Dynamic parameters needed for certificate management profile.
|
enckey_base64
|
|
Encrypted private key corresponding to the private key (e.g.
Those generated by an hsm such as thales nshield).
|
enckey_name
|
|
Name of the encrypted private key (e.g.
Those generated by an hsm such as thales nshield).
|
hardwaresecuritymodulegroup_ref
|
|
It is a reference to an object of type hardwaresecuritymodulegroup.
|
key
|
|
Private key.
|
key_params
|
|
Sslkeyparams settings for sslkeyandcertificate.
|
name
required |
|
Name of the object.
|
password
|
Default:
|
Password of Avi user in Avi controller. The default value is the environment variable
AVI_PASSWORD . |
state
|
|
The state that should be applied on the entity.
|
status
|
|
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
|
Name of tenant used for all Avi API calls and context of object.
|
tenant_ref
|
|
It is a reference to an object of type tenant.
|
tenant_uuid
|
Default:
|
UUID of tenant used for all Avi API calls and context of object.
|
type
|
|
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
|
|
Avi controller URL of the object.
|
username
|
Default:
|
Username used for accessing Avi controller. The default value is the environment variable
AVI_USERNAME . |
uuid
|
|
Unique object identifier of the object.
|
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
obj
dict
|
success, changed |
SSLKeyAndCertificate (api/sslkeyandcertificate) object
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.