oci_waas_certificate_facts – Retrieve details about WAAS certificates¶
New in version 2.5.
Synopsis¶
- This module retrieves information of a specific WAAS certificate or lists all the WAAS certificates in the given compartment.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.7
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location). |
|
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible` playbooks within an OCI compute instance. |
|
certificate_id
string
|
The OCID of the SSL certificate used in the WAAS policy. Required to get information of a specific certificate.
|
|
|
compartment_id
string
|
The OCID of the compartment.
|
|
|
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location. |
|
|
display_name
list
|
Filter certificates using a list of display names.
|
|
|
id
list
|
Filter certificates using a list of certificates OCIDs.
|
|
|
lifecycle_state
list
|
|
Filter certificates using a list of lifecycle states.
|
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
|
sort_by
string
|
|
The value by which certificate summaries are sorted in a paginated 'List' call. If unspecified, defaults to timeCreated.
|
|
sort_order
string
|
|
The order in which to sort the results.
|
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|
|
time_created_greater_than_or_equal_to
string
|
A filter that matches certificates created on or after the specified date-time.
|
|
|
time_created_less_than
string
|
A filter that matches certificates created before the specified date-time.
|
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get all the waas certificates in a compartment
oci_waas_certificate_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
- name: Get a specific waas certificate using its OCID
oci_waas_certificate_facts:
certificate_id: ocid1.waascertificate.oc1..xxxxxEXAMPLExxxxx
- name: Get waas certificate having the specified display name
oci_waas_certificate_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
display_name: examplewaascertificate
- name: Get waas certificates in a compartment with given display names
oci_waas_certificate_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
display_name:
- examplewaascertificate1
- examplewaascertificate2
- name: Filter waas certificates in a compartment using display_name, lifecycle_state and sort the results
oci_waas_certificate_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
display_name:
- examplewaascertificate1
- examplewaascertificate2
lifecycle_state:
- ACTIVE
sort_by: timeCreated
sort_order: DESC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
waas_certificates
complex
|
on success |
List of waas certificates
Sample:
[{'freeform_tags': None, 'issuer_name': {'organizational_unit': None, 'common_name': 'testcommonname', 'locality': 'Bangalore', 'organization': 'Ansible', 'state_province': 'KA', 'email_address': None, 'country': 'IN'}, 'public_key_info': {'algorithm': 'RSA', 'exponent': 65537, 'key_size': 2048}, 'serial_number': '9917593779878295042', 'display_name': 'test waas certificate', 'signature_algorithm': None, 'lifecycle_state': 'ACTIVE', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_not_valid_after': '2024-04-08T08:09:17+00:00', 'issued_by': 'Ansible', 'subject_name': {'organizational_unit': None, 'common_name': 'testcommonname', 'locality': 'Bangalore', 'organization': 'Ansible', 'state_province': 'KA', 'email_address': None, 'country': 'IN'}, 'version': None, 'extensions': None, 'defined_tags': None, 'time_not_valid_before': '2019-04-10T08:09:17+00:00', 'time_created': '2019-04-10T10:05:35.634000+00:00', 'id': 'ocid1.waascertificate.oc1..xxxxxEXAMPLExxxxx'}]
|
|
|
compartment_id
string
|
success |
The OCID of the certificate's compartment.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
|
|
|
defined_tags
string
|
success |
A key-value pair with a defined schema that restricts the values of tags. These predefined keys are scoped to namespaces.
Sample:
{'example_namespace': {'example_key': 'example_value'}}
|
|
|
display_name
string
|
success |
The user-friendly name of the certificate.
Sample:
testcertificate
|
|
|
extensions
list
|
success |
The extensions of this Certificate.
Sample:
[{'value': 'A6:B2:56:1X:1X:1X:1X:8C:F6', 'name': 'subjectKeyIdentifier', 'is_critical': None}]
|
|
|
freeform_tags
complex
|
success |
A simple key-value pair without any defined schema.
Sample:
{'example_freeform_key': 'example_freeform_value'}
|
|
|
id
string
|
success |
The OCID of the certificate.
Sample:
ocid1.waascertificate.oc1..xxxxxEXAMPLExxxxx
|
|
|
issued_by
string
|
success |
The issued_by of this Certificate.
Sample:
testissuer
|
|
|
issuer_name
complex
|
success |
The issuer_name of this Certificate.
Sample:
{'organizational_unit': 'testorgunit', 'common_name': 'testcommonname', 'locality': 'testlocality', 'organization': 'testorg', 'state_province': 'teststate', 'email_address': 'test.email@address.com', 'country': 'AU'}
|
|
|
lifecycle_state
string
|
success |
The current lifecycle state of the SSL certificate.
Sample:
ACTIVE
|
|
|
public_key_info
complex
|
success |
The public_key_info of this Certificate.
Sample:
{'algorithm': 'RSA', 'exponent': 65537, 'key_size': 2048}
|
|
|
serial_number
string
|
success |
The serial_number of this Certificate.
Sample:
100000000000710
|
|
|
signature_algorithm
string
|
success |
The signature_algorithm of this Certificate.
Sample:
SHA-1
|
|
|
subject_name
complex
|
success |
The subject_name of this Certificate.
Sample:
{'organizational_unit': 'testorgunit', 'common_name': 'testcommonname', 'locality': 'testlocality', 'organization': 'testorg', 'state_province': 'teststate', 'email_address': 'test.email@address.com', 'country': 'AU'}
|
|
|
time_created
string
|
success |
The date and time the certificate was created, expressed in RFC 3339 timestamp format.
Sample:
2019-04-02 17:12:42.454000+00:00
|
|
|
time_not_valid_after
string
|
success |
The date and time the certificate will expire, expressed in RFC 3339 timestamp format.
Sample:
2020-04-01 15:29:38+00:00
|
|
|
time_not_valid_before
string
|
success |
The time_not_valid_before of this Certificate.
Sample:
2019-04-02 15:29:38+00:00
|
|
|
version
integer
|
success |
The version of this Certificate.
Sample:
2
|
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Manoj Meda (@manojmeda)
Hint
If you notice any issues in this documentation you can edit this document to improve it.