oracle / oracle.oci / 4.32.0 / module / oci_database_software_image_facts Fetches details about one or multiple DatabaseSoftwareImage resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_software_image_facts (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
Fetches details about one or multiple DatabaseSoftwareImage resources in Oracle Cloud Infrastructure
Gets a list of the database software images in the specified compartment.
If I(database_software_image_id) is specified, the details of a single DatabaseSoftwareImage will be returned.
- name: Get a specific database_software_image oci_database_software_image_facts: # required database_software_image_id: "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx"
- name: List database_software_images oci_database_software_image_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional sort_by: TIMECREATED sort_order: ASC lifecycle_state: PROVISIONING display_name: display_name_example image_type: GRID_IMAGE image_shape_family: VM_BM_SHAPE is_upgrade_supported: true
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 sort_by: choices: - TIMECREATED - DISPLAYNAME description: - The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME 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 image_type: choices: - GRID_IMAGE - DATABASE_IMAGE description: - A filter to return only resources that match the given image type exactly. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). 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 display_name: aliases: - name description: - A filter to return only resources that match the entire display name given. The match is not case sensitive. type: str compartment_id: description: - The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to list multiple database_software_images. type: str lifecycle_state: choices: - PROVISIONING - AVAILABLE - DELETING - DELETED - FAILED - TERMINATING - TERMINATED - UPDATING description: - A filter to return only resources that match the given lifecycle state exactly. 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 image_shape_family: choices: - VM_BM_SHAPE - EXADATA_SHAPE - EXACC_SHAPE description: - A filter to return only resources that match the given image shape family exactly. 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 is_upgrade_supported: description: - If provided, filters the results to the set of database versions which are supported for Upgrade. type: bool 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 database_software_image_id: aliases: - id description: - The DB system L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to get a specific database_software_image. 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
database_software_images: 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 database_software_image_included_patches: description: - List of one-off patches for Database Homes. returned: on success sample: [] type: list database_software_image_one_off_patches: description: - List of one-off patches for Database Homes. returned: on success sample: [] type: list database_version: description: - The database version with which the database software image is to be built. returned: on success sample: database_version_example type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - The user-friendly name for the database software image. The name does not have to be unique. returned: on success sample: display_name_example type: str freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database software image. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str image_shape_family: description: - To what shape the image is meant for. returned: on success sample: VM_BM_SHAPE type: str image_type: description: - The type of software image. Can be grid or database. returned: on success sample: GRID_IMAGE type: str included_patches_summary: description: - The patches included in the image and the version of the image. returned: on success sample: included_patches_summary_example type: str is_upgrade_supported: description: - True if this Database software image is supported for Upgrade. returned: on success sample: true type: bool lifecycle_details: description: - Detailed message for the lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the database software image. returned: on success sample: PROVISIONING type: str ls_inventory: description: - The output from the OPatch lsInventory command, which is passed as a string. returned: on success sample: ls_inventory_example type: str patch_set: description: - The PSU or PBP or Release Updates. To get a list of supported versions, use the L(ListDbVersions,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/DbVersionSummary/ListDbVersions) operation. returned: on success sample: patch_set_example type: str time_created: description: - The date and time the database software image was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - List of DatabaseSoftwareImage resources returned: on success sample: - compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx database_software_image_included_patches: [] database_software_image_one_off_patches: [] database_version: database_version_example defined_tags: Operations: CostCenter: US display_name: display_name_example freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx image_shape_family: VM_BM_SHAPE image_type: GRID_IMAGE included_patches_summary: included_patches_summary_example is_upgrade_supported: true lifecycle_details: lifecycle_details_example lifecycle_state: PROVISIONING ls_inventory: ls_inventory_example patch_set: patch_set_example time_created: '2013-10-20T19:20:30+01:00' type: complex