Try SpotterManage a PreferredCredential resource 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.0This module allows the user to update and delete a PreferredCredential resource in Oracle Cloud Infrastructure
This resource has the following action operations in the M(oracle.oci.oci_database_management_preferred_credential_actions) module: test.
- name: Update preferred_credential with type = BASIC
oci_database_management_preferred_credential:
# required
type: BASIC
# optional
user_name: user_name_example
role: NORMAL
password_secret_id: "ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx"
- name: Delete preferred_credential
oci_database_management_preferred_credential:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
credential_name: credential_name_example
state: absent
role:
choices:
- NORMAL
- SYSDBA
description:
- The role of the database user.
- This parameter is updatable.
type: str
type:
choices:
- BASIC
description:
- The type of preferred credential.
- Required for update using I(state=present) with credential_name present.
type: str
state:
choices:
- present
- absent
default: present
description:
- The state of the PreferredCredential.
- Use I(state=present) to update an existing a PreferredCredential.
- Use I(state=absent) to delete a PreferredCredential.
required: false
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
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
user_name:
description:
- The user name used to connect to the database.
- This parameter is updatable.
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
credential_name:
description:
- The name of the preferred credential.
required: true
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
password_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Vault service secret that contains the database user password.
- This parameter is updatable.
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
managed_database_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Managed Database.
required: true
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
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
preferred_credential:
contains:
credential_name:
description:
- The name of the preferred credential.
returned: on success
sample: credential_name_example
type: str
is_accessible:
description:
- Indicates whether the preferred credential is accessible.
returned: on success
sample: true
type: bool
password_secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Vault service secret that contains the database user password.
returned: on success
sample: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
type: str
role:
description:
- The role of the database user.
returned: on success
sample: NORMAL
type: str
status:
description:
- The status of the preferred credential.
returned: on success
sample: SET
type: str
type:
description:
- The type of preferred credential. Only 'BASIC' is supported currently.
returned: on success
sample: BASIC
type: str
user_name:
description:
- The user name used to connect to the database.
returned: on success
sample: user_name_example
type: str
description:
- Details of the PreferredCredential resource acted upon by the current operation
returned: on success
sample:
credential_name: credential_name_example
is_accessible: true
password_secret_id: ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
role: NORMAL
status: SET
type: BASIC
user_name: user_name_example
type: complex