Skip to content

Latest commit

 

History

History
836 lines (815 loc) · 36.8 KB

avi_sslkeyandcertificate.rst

File metadata and controls

836 lines (815 loc) · 36.8 KB

vmware.alb.avi_sslkeyandcertificate

Module for setup of SSLKeyAndCertificate Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
ca_certs
list
- Ca certificates in certificate chain.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
certificate
dict
required: true
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
certificate_base64
bool
- States if the certificate is base64 encoded.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
certificate_management_profile_ref
str
- It is a reference to an object of type certificatemanagementprofile.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
created_by
str
- Creator name.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
dynamic_params
list
- Dynamic parameters needed for certificate management profile.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
enable_ocsp_stapling
bool
- Enables ocsp stapling.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- false), basic edition(allowed values- false), enterprise with
- cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enckey_base64
str
- Encrypted private key corresponding to the private key (e.g.
- Those generated by an hsm such as thales nshield).
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enckey_name
str
- Name of the encrypted private key (e.g.
- Those generated by an hsm such as thales nshield).
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
format
str
- Format of the key/certificate file.
- Enum options - SSL_PEM, SSL_PKCS12.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as SSL_PEM.
hardwaresecuritymodulegroup_ref
str
- It is a reference to an object of type hardwaresecuritymodulegroup.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
import_key_to_hsm
bool
- Flag to enable private key import to hsm while importing the certificate.
- Field introduced in 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
is_federated
bool
- It specifies whether the object has to be replicated to the gslb followers.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
key
str
- Private key.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
key_base64
bool
- States if the private key is base64 encoded.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
key_params
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
key_passphrase
str
- Passphrase used to encrypt the private key.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
name
str
required: true
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ocsp_config
dict
- Configuration related to ocsp.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ocsp_error_status
str
- Error reported during ocsp status query.
- Enum options - OCSP_ERR_CERTSTATUS_GOOD, OCSP_ERR_CERTSTATUS_REVOKED, OCSP_ERR_CERTSTATUS_UNKNOWN, OCSP_ERR_CERTSTATUS_SERVERFAIL_ERR,
- OCSP_ERR_CERTSTATUS_JOBDB, OCSP_ERR_CERTSTATUS_DISABLED, OCSP_ERR_CERTSTATUS_GETCERT, OCSP_ERR_CERTSTATUS_NONVSCERT,
- OCSP_ERR_CERTSTATUS_SELFSIGNED, OCSP_ERR_CERTSTATUS_CERTFINISH, OCSP_ERR_CERTSTATUS_CACERT, OCSP_ERR_CERTSTATUS_REQUEST,
- OCSP_ERR_CERTSTATUS_ISSUER_REVOKED, OCSP_ERR_CERTSTATUS_PARSE_CERT, OCSP_ERR_CERTSTATUS_HTTP_REQ, OCSP_ERR_CERTSTATUS_URL_LIST,
- OCSP_ERR_CERTSTATUS_HTTP_SEND, OCSP_ERR_CERTSTATUS_HTTP_RECV, OCSP_ERR_CERTSTATUS_HTTP_RESP.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- ocsp_err_certstatus_disabled), basic edition(allowed values-
- ocsp_err_certstatus_disabled), enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as OCSP_ERR_CERTSTATUS_DISABLED.
ocsp_responder_url_list_from_certs
list
- This is an internal field to store the ocsp responder urls contained in the certificate.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ocsp_response_info
dict
- Information related to ocsp response.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
status
str
- Enum options - SSL_CERTIFICATE_FINISHED, SSL_CERTIFICATE_PENDING.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as SSL_CERTIFICATE_FINISHED.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
type
str
- Enum options - SSL_CERTIFICATE_TYPE_VIRTUALSERVICE, SSL_CERTIFICATE_TYPE_SYSTEM, SSL_CERTIFICATE_TYPE_CA.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create a SSL Key and Certificate
      avi_sslkeyandcertificate:
        avi_credentials: "{{ avi_credentials }}"
        key: |
            -----BEGIN PRIVATE KEY-----
            ....
            -----END PRIVATE KEY-----
        certificate:
            self_signed: true
            certificate: |
              -----BEGIN CERTIFICATE-----
              ....
              -----END CERTIFICATE-----
        type: SSL_CERTIFICATE_TYPE_VIRTUALSERVICE
        name: MyTestCert

Authors