Try SpotterFetches details about one or multiple DbManagementPrivateEndpoint resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple DbManagementPrivateEndpoint resources in Oracle Cloud Infrastructure
Gets a list of Database Management private endpoints.
If I(db_management_private_endpoint_id) is specified, the details of a single DbManagementPrivateEndpoint will be returned.
- name: Get a specific db_management_private_endpoint
oci_database_management_db_management_private_endpoint_facts:
# required
db_management_private_endpoint_id: "ocid1.dbmanagementprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
- name: List db_management_private_endpoints
oci_database_management_db_management_private_endpoint_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
name: name_example
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
is_cluster: true
lifecycle_state: CREATING
sort_order: ASC
sort_by: TIMECREATED
name:
description:
- A filter to return only resources that match the entire name.
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
vcn_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the VCN.
type: str
sort_by:
choices:
- TIMECREATED
- NAME
description:
- The field to sort information by. Only one sortOrder can be used. The default sort
order for 'TIMECREATED' is descending and the default sort order for 'NAME' is ascending.
The 'NAME' sort order is case-sensitive.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
is_cluster:
description:
- The option to filter Database Management private endpoints that can used for Oracle
Databases in a cluster. This should be used along with the vcnId query parameter.
type: bool
sort_order:
choices:
- ASC
- DESC
description:
- The option to sort information in ascending ('ASC') or descending ('DESC') order.
Ascending order is the default order.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required to list multiple db_management_private_endpoints.
type: str
lifecycle_state:
choices:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
description:
- The lifecycle state of a resource.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
db_management_private_endpoint_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Database Management private endpoint.
- Required to get a specific db_management_private_endpoint.
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
db_management_private_endpoints:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
description:
- The description of the Database Management private endpoint.
returned: on success
sample: description_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Database Management private endpoint.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_cluster:
description:
- Specifies whether the Database Management private endpoint can be used for
Oracle Databases in a cluster.
- Returned for get operation
returned: on success
sample: true
type: bool
lifecycle_state:
description:
- The current lifecycle state of the Database Management private endpoint.
returned: on success
sample: CREATING
type: str
name:
description:
- The display name of the Database Management private endpoint.
returned: on success
sample: name_example
type: str
nsg_ids:
description:
- The OCIDs of the Network Security Groups to which the Database Management
private endpoint belongs.
- Returned for get operation
returned: on success
sample: []
type: list
private_ip:
description:
- The IP addresses assigned to the Database Management private endpoint.
- Returned for get operation
returned: on success
sample: private_ip_example
type: str
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the subnet.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time the Database Managament private endpoint was created, in
the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339).
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
vcn_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the VCN.
returned: on success
sample: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- List of DbManagementPrivateEndpoint resources
returned: on success
sample:
- compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
description: description_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
is_cluster: true
lifecycle_state: CREATING
name: name_example
nsg_ids: []
private_ip: private_ip_example
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
vcn_id: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
type: complex