oracle.oci.oci_waas_certificate_facts – Fetches details about one or multiple WaasCertificate resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_waas_certificate_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple WaasCertificate resources in Oracle Cloud Infrastructure

  • Gets a list of SSL certificates that can be used in a WAAS policy.

  • If certificate_id is specified, the details of a single WaasCertificate will be returned.

Requirements

The below requirements are needed on the host that executes this module.

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_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
certificate_id
string
The OCID of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy.
Required to get a specific waas_certificate.

aliases: id
compartment_id
string
The OCID of the compartment. This number is generated when the compartment is created.
Required to list multiple waas_certificates.
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 / elements=string
Filter certificates using a list of display names.

aliases: name
lifecycle_state
list / elements=string
    Choices:
  • CREATING
  • ACTIVE
  • FAILED
  • UPDATING
  • DELETING
  • DELETED
Filter certificates using a list of lifecycle states.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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
    Choices:
  • id
  • compartmentId
  • displayName
  • notValidAfter
  • timeCreated
The value by which certificate summaries are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`.
sort_order
string
    Choices:
  • ASC
  • DESC
The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
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.

Examples

- name: Get a specific waas_certificate
  oci_waas_certificate_facts:
    # required
    certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"

- name: List waas_certificates
  oci_waas_certificate_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_by: id
    sort_order: ASC
    display_name: [ "display_name_example" ]
    lifecycle_state: [ "CREATING" ]
    time_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_created_less_than: 2013-10-20T19:20:30+01:00

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 WaasCertificate resources

Sample:
[{'certificate_data': 'this-is-not-the-secret', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'extensions': [{'is_critical': True, 'name': 'name_example', 'value': 'value_example'}], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_trust_verification_disabled': True, 'issued_by': 'issued_by_example', 'issuer_name': {'common_name': 'common_name_example', 'country': 'country_example', 'email_address': 'email_address_example', 'locality': 'locality_example', 'organization': 'organization_example', 'organizational_unit': 'organizational_unit_example', 'state_province': 'state_province_example'}, 'lifecycle_state': 'CREATING', 'public_key_info': {'algorithm': 'algorithm_example', 'exponent': 56, 'key_size': 56}, 'serial_number': 'serial_number_example', 'signature_algorithm': 'signature_algorithm_example', 'subject_name': {'common_name': 'common_name_example', 'country': 'country_example', 'email_address': 'email_address_example', 'locality': 'locality_example', 'organization': 'organization_example', 'organizational_unit': 'organizational_unit_example', 'state_province': 'state_province_example'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_not_valid_after': '2013-10-20T19:20:30+01:00', 'time_not_valid_before': '2013-10-20T19:20:30+01:00', 'version': 56}]
 
certificate_data
string
on success
The data of the SSL certificate.
Returned for get operation

Sample:
this-is-not-the-secret
 
compartment_id
string
on success
The OCID of the certificate's compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-friendly name of the certificate.

Sample:
display_name_example
 
extensions
complex
on success
Additional attributes associated with users or public keys for managing relationships between Certificate Authorities.
Returned for get operation
   
is_critical
boolean
on success
The critical flag of the extension. Critical extensions must be processed, non-critical extensions can be ignored.

Sample:
True
   
name
string
on success
The certificate extension name.

Sample:
name_example
   
value
string
on success
The certificate extension value.

Sample:
value_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the certificate.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_trust_verification_disabled
boolean
on success
This indicates whether trust verification was disabled during the creation of SSL certificate. If `true` SSL certificate trust verification was disabled and this SSL certificate is most likely self-signed.
Returned for get operation

Sample:
True
 
issued_by
string
on success
Returned for get operation

Sample:
issued_by_example
 
issuer_name
complex
on success
Returned for get operation
   
common_name
string
on success
The Certificate Authority (CA) name.

Sample:
common_name_example
   
country
string
on success
ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see ISO's website.

Sample:
country_example
   
email_address
string
on success
The email address of the server's administrator.

Sample:
email_address_example
   
locality
string
on success
The city in which the organization is located.

Sample:
locality_example
   
organization
string
on success
The organization name.

Sample:
organization_example
   
organizational_unit
string
on success
The field to differentiate between divisions within an organization.

Sample:
organizational_unit_example
   
state_province
string
on success
The province where the organization is located.

Sample:
state_province_example
 
lifecycle_state
string
on success
The current lifecycle state of the SSL certificate.

Sample:
CREATING
 
public_key_info
complex
on success
Returned for get operation
   
algorithm
string
on success
The algorithm identifier and parameters for the public key.

Sample:
algorithm_example
   
exponent
integer
on success
The private key exponent.

Sample:
56
   
key_size
integer
on success
The number of bits in a key used by a cryptographic algorithm.

Sample:
56
 
serial_number
string
on success
A unique, positive integer assigned by the Certificate Authority (CA). The issuer name and serial number identify a unique certificate.
Returned for get operation

Sample:
serial_number_example
 
signature_algorithm
string
on success
The identifier for the cryptographic algorithm used by the Certificate Authority (CA) to sign this certificate.
Returned for get operation

Sample:
signature_algorithm_example
 
subject_name
complex
on success
Returned for get operation
   
common_name
string
on success
The fully qualified domain name used for DNS lookups of the server.

Sample:
common_name_example
   
country
string
on success
ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see ISO's website.

Sample:
country_example
   
email_address
string
on success
The email address of the server's administrator.

Sample:
email_address_example
   
locality
string
on success
The city in which the organization is located.

Sample:
locality_example
   
organization
string
on success
The organization name.

Sample:
organization_example
   
organizational_unit
string
on success
The field to differentiate between divisions within an organization.

Sample:
organizational_unit_example
   
state_province
string
on success
The province where the organization is located.

Sample:
state_province_example
 
time_created
string
on success
The date and time the certificate was created, expressed in RFC 3339 timestamp format.

Sample:
2013-10-20T19:20:30+01:00
 
time_not_valid_after
string
on success
The date and time the certificate will expire, expressed in RFC 3339 timestamp format.

Sample:
2013-10-20T19:20:30+01:00
 
time_not_valid_before
string
on success
The date and time the certificate will become valid, expressed in RFC 3339 timestamp format.
Returned for get operation

Sample:
2013-10-20T19:20:30+01:00
 
version
integer
on success
The version of the encoded certificate.
Returned for get operation

Sample:
56


Authors

  • Oracle (@oracle)