New in version 2.3.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| ca_certs |
no | List of certificate authorities (root and intermediate) trusted that is used for certificate validation. | ||
| controller |
no | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. | ||
| created_by |
no | Creator name. | ||
| crl_check |
no | When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. Default value when not specified in API or module is interpreted by Avi Controller as True. | ||
| crls |
no | Certificate revocation lists. | ||
| ignore_peer_chain |
no | When enabled, avi will not trust intermediate and root certs presented by a client. Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. Default value when not specified in API or module is interpreted by Avi Controller as False. | ||
| name |
yes | Name of the pki profile. | ||
| password |
no | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD. | ||
| state |
no | present |
|
The state that should be applied on the entity. |
| 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. | ||
| 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. | ||
| validate_only_leaf_crl |
no | When enabled, avi will only validate the revocation status of the leaf certificate using crl. To enable validation for the entire chain, disable this option and provide all the relevant crls. Default value when not specified in API or module is interpreted by Avi Controller as True. |
- name: Example to create PKIProfile object avi_pkiprofile: controller: 10.10.25.42 username: admin password: something state: present name: sample_pkiprofile
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| obj | PKIProfile (api/pkiprofile) object | success, changed | dict |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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, Helping Testing PRs and Developing Modules.