### Start Integration Instance Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_integration_instance_actions_module.rst Example of how to start an OCI Integration Instance. ```APIDOC ## Start Integration Instance ### Description Performs the action to start an OCI Integration Instance. ### Method oci_integration_instance_actions ### Parameters #### Path Parameters - **integration_instance_id** (string) - Required - The OCID of the integration instance. - **action** (string) - Required - The action to perform, which is 'start'. ### Request Example ```yaml - name: Perform action start on integration_instance oci_integration_instance_actions: # required integration_instance_id: "ocid1.integrationinstance.oc1..xxxxxxEXAMPLExxxxxx" action: start ``` ``` -------------------------------- ### Start SQL Tuning Task Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_database_management_managed_database_actions_module.rst This example demonstrates how to start a new SQL tuning task. ```APIDOC ## Start SQL Tuning Task ### Description Performs the action to start a new SQL tuning task. ### Method POST ### Endpoint /managedDatabases/{managedDatabaseId}/actions ### Parameters #### Path Parameters - **managedDatabaseId** (string) - Required - The OCID of the managed database. #### Request Body - **action** (string) - Required - The action to perform, which is 'start_sql_tuning_task'. - **task_name** (string) - Required - The name of the SQL tuning task. - **credential_details** (object) - Required - The database credential details. - **username** (string) - Required - The database username. - **password_secret_id** (string) - Required - The OCID of the Oracle Cloud Infrastructure secret containing the database password. - **sql_tuning_task_credential_type** (string) - Required - The type of SQL tuning task credential. Supported values are SECRET and BASIC. - **role** (string) - Optional - The database role for the SQL tuning task. Supported values are NORMAL and SYSDBA. - **total_time_limit_in_minutes** (integer) - Required - The time limit for running the SQL tuning task in minutes. - **scope** (string) - Optional - The scope of the SQL tuning task. Supported values are LIMITED and RESTRICTED. - **time_started** (string) - Optional - The start time of the period in which SQL statements are running. - **time_ended** (string) - Optional - The end time of the period in which SQL statements are running. ``` -------------------------------- ### Start Autonomous Database Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_database_autonomous_database_actions_module.rst This example demonstrates how to start an Autonomous Database. This action only requires the Autonomous Database OCID. ```APIDOC ## Perform action start on autonomous_database ### Description Starts the Autonomous Database. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **autonomous_database_id** (string) - Required - The OCID of the Autonomous Database. - **action** (string) - Required - The action to perform, must be 'start'. ``` -------------------------------- ### Create Management Agent Install Key Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_management_agent_install_key_module.rst Example of creating a new management agent install key. ```APIDOC ## Create management_agent_install_key ### Description Creates a new management agent install key. ### Parameters #### Required Parameters - **compartment_id** (string) - The OCID of the compartment to create the key in. - **display_name** (string) - The display name for the install key. #### Optional Parameters - **allowed_key_install_count** (integer) - The total number of installs allowed for this key. - **time_expires** (string) - The expiration date for the install key. - **is_unlimited** (boolean) - Whether the key has unlimited install count. ### Request Example ```yaml - name: Create management_agent_install_key oci_management_agent_install_key: compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: "display_name_example" allowed_key_install_count: 56 time_expires: "time_expires_example" is_unlimited: true ``` ### Response #### Success Response (200) - **management_agent_install_key** (complex) - Details of the ManagementAgentInstallKey resource acted upon by the current operation. - **allowed_key_install_count** (integer) - Total number of installs for this key. - **compartment_id** (string) - The OCID of the compartment. - **created_by_principal_id** (string) - The OCID of the principal that created the resource. - **current_key_install_count** (integer) - The number of current installs for this key. - **display_name** (string) - The display name for the install key. - **id** (string) - The OCID of the management agent install key. - **is_unlimited** (boolean) - Whether the key has unlimited install count. - **key** (string) - The content of the key. - **lifecycle_details** (string) - Additional information about the current lifecycle state. - **lifecycle_state** (string) - The current state of the management agent install key. - **time_created** (string) - The date and time the management agent install key was created. - **time_expires** (string) - The date and time the management agent install key expires. - **time_updated** (string) - The date and time the management agent install key was updated. ### Response Example ```json { "management_agent_install_key": { "allowed_key_install_count": 56, "compartment_id": "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx", "created_by_principal_id": "ocid1.createdbyprincipal.oc1..xxxxxxEXAMPLExxxxxx", "current_key_install_count": 56, "display_name": "display_name_example", "id": "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx", "is_unlimited": true, "key": "key_example", "lifecycle_details": "lifecycle_details_example", "lifecycle_state": "CREATING", "time_created": "2013-10-20T19:20:30+01:00", "time_expires": "2013-10-20T19:20:30+01:00", "time_updated": "2013-10-20T19:20:30+01:00" } } ``` ``` -------------------------------- ### Start ODA Instance Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_oda_instance_actions_module.rst This example demonstrates how to start an ODA instance using the Ansible module. The ODA instance OCID is the only required parameter. ```yaml - name: Perform action start on oda_instance oci_oda_instance_actions: # required oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx" action: start ``` -------------------------------- ### Start Action for Data Flow Pool Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_data_flow_pool_actions_module.rst This example demonstrates how to start a Data Flow pool. Only the pool_id is required for this action. ```yaml - name: Perform action start on pool oci_data_flow_pool_actions: # required pool_id: "ocid1.pool.oc1..xxxxxxEXAMPLExxxxxx" action: start ``` -------------------------------- ### List installed packages Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_os_management_hub_installed_package_facts_module.rst This example demonstrates how to list installed packages using the oci_os_management_hub_installed_package_facts module. It shows required and optional parameters for filtering and sorting the results. ```APIDOC ## List installed packages ### Description Retrieves a list of installed packages in OCI OS Management Hub, with options for filtering and sorting. ### Method Uses the `oci_os_management_hub_installed_package_facts` module. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters (Module Arguments) - **lifecycle_stage_id** (string) - Required - The OCID of the lifecycle stage to filter by. - **compartment_id** (string) - Optional - The OCID of the compartment to filter by. - **display_name** (list of strings) - Optional - A list of display names to filter by. - **display_name_contains** (string) - Optional - A string to filter display names that contain this value. - **lifecycle_state** (string) - Optional - The lifecycle state to filter by. Choices: CREATING, SUCCEEDED, FAILED, DELETING, DELETED. - **sort_order** (string) - Optional - The sort order to use. Choices: ASC, DESC. Default order for displayName is ascending. - **sort_by** (string) - Optional - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. - **tenancy** (string) - Optional - 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. ### Request Example ```yaml - name: List installed_packages oci_os_management_hub_installed_package_facts: # required lifecycle_stage_id: "ocid1.lifecyclestage.oc1..xxxxxxEXAMPLExxxxxx" # optional compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: [ "display_name_example" ] display_name_contains: display_name_contains_example lifecycle_state: CREATING sort_order: ASC sort_by: timeCreated ``` ### Response #### Success Response - **installed_packages** (list) - A list of installed packages matching the criteria. ``` -------------------------------- ### List Managed Instance Group Installed Packages Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_os_management_hub_managed_instance_group_installed_package_facts_module.rst This example demonstrates how to list installed packages for a specific managed instance group. It shows required parameters like `managed_instance_group_id` and optional filters such as `display_name`, `time_install_date_start`, `time_install_date_end`, `compartment_id`, `sort_order`, and `sort_by`. ```yaml - name: List managed_instance_group_installed_packages oci_os_management_hub_managed_instance_group_installed_package_facts: # required managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx" # optional display_name: [ "display_name_example" ] display_name_contains: display_name_contains_example time_install_date_start: 2013-10-20T19:20:30+01:00 time_install_date_end: 2013-10-20T19:20:30+01:00 compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" sort_order: ASC sort_by: timeInstalled ``` -------------------------------- ### Launch Instance from Configuration with Instance Options Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_compute_management_instance_configuration_actions_module.rst This example demonstrates launching an instance using instance options from an instance configuration. It includes detailed configurations for block volumes and launch details. ```yaml - name: Perform action launch on instance_configuration with instance_type = instance_options oci_compute_management_instance_configuration_actions: # required instance_type: instance_options # optional options: - # required instance_type: instance_type_example # optional block_volumes: - # optional attach_details: # required type: iscsi # optional use_chap: true display_name: display_name_example is_read_only: true device: device_example is_shareable: true create_details: # optional availability_domain: Uocm:PHX-AD-1 backup_policy_id: "ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx" compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" is_auto_tune_enabled: true block_volume_replicas: - # required availability_domain: Uocm:PHX-AD-1 # optional display_name: display_name_example defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx" vpus_per_gb: 56 size_in_gbs: 56 source_details: # required type: volumeBackup # optional id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" autotune_policies: - # required max_vpus_per_gb: 56 autotune_type: PERFORMANCE_BASED volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx" launch_details: # optional availability_domain: Uocm:PHX-AD-1 capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx" compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" create_vnic_details: # optional assign_public_ip: true assign_private_dns_record: true defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} hostname_label: hostname_label_example nsg_ids: [ "nsg_ids_example" ] private_ip: private_ip_example skip_source_dest_check: true subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx" defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example extended_metadata: null freeform_tags: {'Department': 'Finance'} ipxe_script: ipxe_script_example metadata: null shape: shape_example shape_config: # optional ocpus: 3.4 vcpus: 56 memory_in_gbs: 3.4 baseline_ocpu_utilization: BASELINE_1_8 nvmes: 56 platform_config: # required type: AMD_MILAN_BM # optional percentage_of_cores_enabled: 56 numa_nodes_per_socket: NPS0 is_symmetric_multi_threading_enabled: true is_access_control_service_enabled: true are_virtual_instructions_enabled: true is_input_output_memory_management_unit_enabled: true is_secure_boot_enabled: true is_trusted_platform_module_enabled: true is_measured_boot_enabled: true is_memory_encryption_enabled: true source_details: # required source_type: image ``` -------------------------------- ### Get a specific management_agent_install_key Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_management_agent_install_key_facts_module.rst This example demonstrates how to retrieve a specific management agent install key using its OCID. ```APIDOC ## Get a specific management_agent_install_key ### Description Retrieves details for a specific OCI Management Agent Install Key. ### Method GET (Implicit) ### Endpoint Not explicitly defined, module-based operation. ### Parameters #### Path Parameters None #### Query Parameters - **management_agent_install_key_id** (string) - Required - The OCID of the management agent install key to retrieve facts for. - **sort_by** (string) - Optional - The field to sort by. Choices: timeCreated, displayName. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. - **sort_order** (string) - Optional - The sort order to use, either 'ASC' or 'DESC'. - **tenancy** (string) - Optional - 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. ### Request Example ```yaml - name: Get a specific management_agent_install_key oci_management_agent_install_key_facts: # required management_agent_install_key_id: "ocid1.managementagentinstallkey.oc1..xxxxxxEXAMPLExxxxxx" ``` ### Response #### Success Response (200) - **management_agent_install_key** (object) - Information about the management agent install key. - **id** (string) - The OCID of the management agent install key. - **display_name** (string) - The display name of the management agent install key. - **time_created** (string) - The date and time the management agent install key was created. - **compartment_id** (string) - The OCID of the compartment that contains the management agent install key. - **key** (string) - The content of the install key. #### Response Example ```json { "management_agent_install_key": { "id": "ocid1.managementagentinstallkey.oc1..xxxxxxEXAMPLExxxxxx", "display_name": "MyInstallKey", "time_created": "2023-10-27T10:00:00Z", "compartment_id": "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx", "key": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\n-----END PUBLIC KEY-----" } } ``` ``` -------------------------------- ### Perform action start on vb_instance Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_visual_builder_vb_instance_actions_module.rst This example shows how to start an OCI Visual Builder instance. It requires the `vb_instance_id` and specifies the `action` as 'start'. ```APIDOC ## Perform action start on vb_instance ### Description This task initiates the 'start' action for an OCI Visual Builder instance. It requires the unique identifier of the VB instance. ### Method POST (Implicit, as it's an action) ### Endpoint Not explicitly defined, assumed to be part of the `oci_visual_builder_vb_instance_actions` module. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **vb_instance_id** (string) - Required - The unique OCID of the VB instance. - **action** (string) - Required - The action to perform, set to 'start'. - **wait** (boolean) - Optional - Whether to wait for the operation to complete. Defaults to 'yes'. - **wait_timeout** (integer) - Optional - Time in seconds to wait for the operation to complete when `wait` is true. Defaults to 1200. ### Request Example ```yaml - name: Perform action start on vb_instance oci_visual_builder_vb_instance_actions: # required vb_instance_id: "ocid1.vbinstance.oc1..xxxxxxEXAMPLExxxxxx" action: start ``` ### Response #### Success Response (200) - **message** (string) - A message indicating the success of the operation. #### Response Example ```json { "message": "Start operation initiated successfully." } ``` ``` -------------------------------- ### Create DB System from Scratch Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_database_db_system_module.rst This example demonstrates how to create a new OCI DB System from scratch, specifying all necessary configuration details including database home, storage, networking, and maintenance windows. ```APIDOC ## Create DB System from Scratch ### Description This section details the parameters for creating a new OCI DB System from scratch. It covers essential configurations like compartment, availability domain, subnet, hostname, and database home details. ### Parameters #### Required Parameters - **compartment_id** (string) - The OCID of the compartment to create the DB system in. - **availability_domain** (string) - The availability domain where the DB system will be created. - **subnet_id** (string) - The OCID of the subnet for the DB system. - **hostname** (string) - The hostname for the DB system. - **source** (string) - Set to 'NONE' to create a new DB system. - **db_home** (object) - Configuration for the database home. - **database** (object) - Configuration for the database within the home. - **admin_password** (string) - The password for the database administrator. #### Optional Parameters - **fault_domains** (list of strings) - List of fault domains for the DB system. - **display_name** (string) - A user-friendly name for the DB system. - **backup_subnet_id** (string) - The OCID of the subnet for backups. - **time_zone** (string) - The time zone for the DB system. - **db_system_options** (object) - Options for the DB system. - **storage_management** (string) - Storage management type (e.g., 'ASM'). - **storage_volume_performance_mode** (string) - Performance mode for storage volumes (e.g., 'BALANCED'). - **sparse_diskgroup** (boolean) - Whether to use sparse disk groups. - **domain** (string) - The domain for the DB system. - **cluster_name** (string) - The name of the cluster. - **data_storage_percentage** (integer) - Percentage of data storage to allocate. - **kms_key_id** (string) - OCID of the KMS key for encryption. - **kms_key_version_id** (string) - OCID of the KMS key version for encryption. - **node_count** (integer) - The number of nodes in the DB system. - **private_ip** (string) - The private IP address for the DB system. - **disk_redundancy** (string) - Disk redundancy level (e.g., 'HIGH'). - **data_storage_size_in_gbs** (integer) - Size of data storage in GBs. - **freeform_tags** (object) - Freeform tags to apply to the DB system. - **defined_tags** (object) - Defined tags to apply to the DB system. - **nsg_ids** (list of strings) - List of network security group OCIDs. - **backup_network_nsg_ids** (list of strings) - List of backup network security group OCIDs. - **license_model** (string) - License model for the database (e.g., 'LICENSE_INCLUDED'). - **maintenance_window_details** (object) - Details for maintenance windows. - **preference** (string) - Maintenance window preference (e.g., 'NO_PREFERENCE'). - **patching_mode** (string) - Patching mode (e.g., 'ROLLING'). - **is_custom_action_timeout_enabled** (boolean) - Whether custom action timeout is enabled. - **custom_action_timeout_in_mins** (integer) - Custom action timeout in minutes. - **is_monthly_patching_enabled** (boolean) - Whether monthly patching is enabled. - **months** (list of objects) - Months for maintenance. - **name** (string) - Name of the month (e.g., 'JANUARY'). - **weeks_of_month** (list of strings) - Weeks of the month for maintenance. - **days_of_week** (list of objects) - Days of the week for maintenance. - **name** (string) - Name of the day (e.g., 'MONDAY'). - **hours_of_day** (list of strings) - Hours of the day for maintenance. - **lead_time_in_weeks** (integer) - Lead time for maintenance in weeks. - **data_collection_options** (object) - Options for data collection. - **is_diagnostics_events_enabled** (boolean) - Whether diagnostics events are enabled. - **is_health_monitoring_enabled** (boolean) - Whether health monitoring is enabled. - **is_incident_logs_enabled** (boolean) - Whether incident logs are enabled. ### DB Home and Database Parameters #### Required DB Home Parameters - **db_home.database.admin_password** (string) - The administrator password for the database. #### Optional DB Home Parameters - **db_home.database.database_software_image_id** (string) - OCID of the database software image. - **db_home.database.pdb_name** (string) - Pluggable database name. - **db_home.database.tde_wallet_password** (string) - TDE wallet password. - **db_home.database.character_set** (string) - Character set for the database. - **db_home.database.ncharacter_set** (string) - National character set for the database. - **db_home.database.db_workload** (string) - Database workload type (e.g., 'OLTP'). - **db_home.database.kms_key_id** (string) - OCID of the KMS key for TDE. - **db_home.database.kms_key_version_id** (string) - OCID of the KMS key version for TDE. - **db_home.database.vault_id** (string) - OCID of the Vault for TDE. - **db_home.database.db_domain** (string) - Domain for the database. - **db_home.database.db_backup_config** (object) - Backup configuration for the database. - **auto_backup_enabled** (boolean) - Whether automatic backup is enabled. - **recovery_window_in_days** (integer) - Recovery window in days. - **auto_backup_window** (string) - Automatic backup window (e.g., 'SLOT_ONE'). - **auto_full_backup_window** (string) - Automatic full backup window. - **auto_full_backup_day** (string) - Day for automatic full backup. - **run_immediate_full_backup** (boolean) - Whether to run an immediate full backup. - **backup_destination_details** (list of objects) - Details for backup destinations. - **type** (string) - Type of backup destination (e.g., 'NFS'). - **id** (string) - OCID of the backup destination. - **vpc_user** (string) - VPC user for the backup destination. - **vpc_password** (string) - VPC password for the backup destination. - **internet_proxy** (string) - Internet proxy for the backup destination. - **dbrs_policy_id** (string) - OCID of the DBRS policy. - **backup_deletion_policy** (string) - Policy for backup deletion (e.g., 'DELETE_IMMEDIATELY'). - **db_home.database.freeform_tags** (object) - Freeform tags for the database. - **db_home.database.defined_tags** (object) - Defined tags for the database. - **db_home.database.database_id** (string) - OCID of the database. - **db_home.database.time_stamp_for_point_in_time_recovery** (string) - Timestamp for point-in-time recovery. - **db_home.database.backup_id** (string) - OCID of the backup. - **db_home.database.backup_tde_password** (string) - Backup TDE password. - **db_home.database.db_unique_name** (string) - Unique name for the database. - **db_home.database.db_name** (string) - Name of the database. - **db_home.database.sid_prefix** (string) - SID prefix for the database. - **db_home.database.pluggable_databases** (list of strings) - List of pluggable databases. - **db_home.db_version** (string) - Database version. - **db_home.display_name** (string) - Display name for the database home. - **db_home.database_software_image_id** (string) - OCID of the database software image for the home. ### Other Parameters - **cpu_core_count** (integer) - Number of CPU cores for the DB system. - **ssh_public_keys** (list of strings) - List of SSH public keys. - **shape** (string) - The shape of the DB system. ### Request Example ```json { "fault_domains": [ "fault_domains_example" ], "display_name": "display_name_example", "backup_subnet_id": "ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx", "time_zone": "time_zone_example", "db_system_options": { "storage_management": "ASM" }, "storage_volume_performance_mode": "BALANCED", "sparse_diskgroup": true, "domain": "domain_example", "cluster_name": "cluster_name_example", "data_storage_percentage": 56, "kms_key_id": "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx", "kms_key_version_id": "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx", "node_count": 56, "source": "NONE", "private_ip": "private_ip_example", "disk_redundancy": "HIGH", "data_storage_size_in_gbs": 56, "freeform_tags": {"Department": "Finance"}, "defined_tags": {"Operations": {"CostCenter": "US"}}, "nsg_ids": [ "nsg_ids_example" ], "backup_network_nsg_ids": [ "backup_network_nsg_ids_example" ], "license_model": "LICENSE_INCLUDED", "maintenance_window_details": { "preference": "NO_PREFERENCE", "patching_mode": "ROLLING", "is_custom_action_timeout_enabled": true, "custom_action_timeout_in_mins": 56, "is_monthly_patching_enabled": true, "months": [ { "name": "JANUARY" } ], "weeks_of_month": [ "weeks_of_month_example" ], "days_of_week": [ { "name": "MONDAY" } ], "hours_of_day": [ "hours_of_day_example" ], "lead_time_in_weeks": 56 }, "data_collection_options": { "is_diagnostics_events_enabled": true, "is_health_monitoring_enabled": true, "is_incident_logs_enabled": true }, "compartment_id": "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx", "availability_domain": "Uocm:PHX-AD-1", "subnet_id": "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx", "hostname": "hostname_example", "db_home": { "database": { "admin_password": "example-password", "database_software_image_id": "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx", "pdb_name": "pdb_name_example", "tde_wallet_password": "example-password", "character_set": "character_set_example", "ncharacter_set": "ncharacter_set_example", "db_workload": "OLTP", "kms_key_id": "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx", "kms_key_version_id": "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx", "vault_id": "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx", "db_domain": "db_domain_example", "db_backup_config": { "auto_backup_enabled": true, "recovery_window_in_days": 56, "auto_backup_window": "SLOT_ONE", "auto_full_backup_window": "SLOT_ONE", "auto_full_backup_day": "SUNDAY", "run_immediate_full_backup": true, "backup_destination_details": [ { "type": "NFS", "id": "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx", "vpc_user": "vpc_user_example", "vpc_password": "example-password", "internet_proxy": "internet_proxy_example", "dbrs_policy_id": "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx" } ], "backup_deletion_policy": "DELETE_IMMEDIATELY" }, "freeform_tags": {"Department": "Finance"}, "defined_tags": {"Operations": {"CostCenter": "US"}}, "database_id": "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx", "time_stamp_for_point_in_time_recovery": "time_stamp_for_point_in_time_recovery_example", "backup_id": "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx", "backup_tde_password": "example-password", "db_unique_name": "db_unique_name_example", "db_name": "db_name_example", "sid_prefix": "sid_prefix_example", "pluggable_databases": [ "pluggable_databases_example" ] }, "db_version": "db_version_example", "display_name": "display_name_example", "database_software_image_id": "ocid1.databasesoftwareimage.oc1..xxxxxxEXAMPLExxxxxx" }, "cpu_core_count": 56, "ssh_public_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..." ], "shape": "shape_example" } ``` ``` -------------------------------- ### Create Instance Configuration with Source NONE Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_compute_management_instance_configuration_module.rst Example of creating an instance configuration using the `oci_compute_management_instance_configuration` module. This snippet demonstrates setting up instance details, including block volume configurations with `iscsi` type and source from a backup, as well as launch details with custom shape configurations and platform settings. ```yaml+jinja - name: Create instance_configuration with source = NONE oci_compute_management_instance_configuration: # required instance_details: # required instance_type: instance_options # optional options: - # required instance_type: instance_type_example # optional block_volumes: - # optional attach_details: # required type: iscsi # optional use_chap: true display_name: display_name_example is_read_only: true device: device_example is_shareable: true create_details: # optional availability_domain: Uocm:PHX-AD-1 backup_policy_id: "ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx" compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" is_auto_tune_enabled: true block_volume_replicas: - # required availability_domain: Uocm:PHX-AD-1 # optional display_name: display_name_example defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx" vpus_per_gb: 56 size_in_gbs: 56 source_details: # required type: volumeBackup # optional id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" autotune_policies: - # required max_vpus_per_gb: 56 autotune_type: PERFORMANCE_BASED volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx" launch_details: # optional availability_domain: Uocm:PHX-AD-1 capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx" compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" create_vnic_details: # optional assign_public_ip: true assign_private_dns_record: true defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} hostname_label: hostname_label_example nsg_ids: [ "nsg_ids_example" ] private_ip: private_ip_example skip_source_dest_check: true subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx" defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example extended_metadata: null freeform_tags: {'Department': 'Finance'} ipxe_script: ipxe_script_example metadata: null shape: shape_example shape_config: # optional ocpus: 3.4 vcpus: 56 memory_in_gbs: 3.4 baseline_ocpu_utilization: BASELINE_1_8 nvmes: 56 platform_config: # required type: AMD_MILAN_BM # optional percentage_of_cores_enabled: 56 numa_nodes_per_socket: NPS0 is_symmetric_multi_threading_enabled: true is_access_control_service_enabled: true are_virtual_instructions_enabled: true is_input_output_memory_management_unit_enabled: true is_secure_boot_enabled: true is_trusted_platform_module_enabled: true is_measured_boot_enabled: true is_memory_encryption_enabled: true source_details: # required source_type: image ``` -------------------------------- ### Delete Management Agent Install Key Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_management_agent_install_key_module.rst Example of deleting a management agent install key. ```APIDOC ## Delete management_agent_install_key ### Description Deletes a management agent install key. ### Parameters #### Required Parameters - **management_agent_install_key_id** (string) - The OCID of the management agent install key to delete. #### Optional Parameters - **state** (string) - Set to `absent` to delete the resource. ### Request Example ```yaml - name: Delete management_agent_install_key oci_management_agent_install_key: management_agent_install_key_id: "ocid1.managementagentinstallkey.oc1..xxxxxxEXAMPLExxxxxx" state: absent ``` ### Response #### Success Response (200) - **management_agent_install_key** (complex) - Details of the ManagementAgentInstallKey resource acted upon by the current operation. - **allowed_key_install_count** (integer) - Total number of installs for this key. - **compartment_id** (string) - The OCID of the compartment. - **created_by_principal_id** (string) - The OCID of the principal that created the resource. - **current_key_install_count** (integer) - The number of current installs for this key. - **display_name** (string) - The display name for the install key. - **id** (string) - The OCID of the management agent install key. - **is_unlimited** (boolean) - Whether the key has unlimited install count. - **key** (string) - The content of the key. - **lifecycle_details** (string) - Additional information about the current lifecycle state. - **lifecycle_state** (string) - The current state of the management agent install key. - **time_created** (string) - The date and time the management agent install key was created. - **time_expires** (string) - The date and time the management agent install key expires. - **time_updated** (string) - The date and time the management agent install key was updated. ### Response Example ```json { "management_agent_install_key": { "allowed_key_install_count": 56, "compartment_id": "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx", "created_by_principal_id": "ocid1.createdbyprincipal.oc1..xxxxxxEXAMPLExxxxxx", "current_key_install_count": 56, "display_name": "display_name_example", "id": "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx", "is_unlimited": true, "key": "key_example", "lifecycle_details": "lifecycle_details_example", "lifecycle_state": "CREATING", "time_created": "2013-10-20T19:20:30+01:00", "time_expires": "2013-10-20T19:20:30+01:00", "time_updated": "2013-10-20T19:20:30+01:00" } } ``` ``` -------------------------------- ### Update Management Agent Install Key Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_management_agent_install_key_module.rst Example of updating an existing management agent install key. ```APIDOC ## Update management_agent_install_key ### Description Updates an existing management agent install key. ### Parameters #### Required Parameters - **management_agent_install_key_id** (string) - The OCID of the management agent install key to update. #### Optional Parameters - **is_key_active** (boolean) - Whether the key is active. - **display_name** (string) - The display name for the install key. ### Request Example ```yaml - name: Update management_agent_install_key oci_management_agent_install_key: management_agent_install_key_id: "ocid1.managementagentinstallkey.oc1..xxxxxxEXAMPLExxxxxx" is_key_active: true display_name: "display_name_example" ``` ### Response #### Success Response (200) - **management_agent_install_key** (complex) - Details of the ManagementAgentInstallKey resource acted upon by the current operation. - **allowed_key_install_count** (integer) - Total number of installs for this key. - **compartment_id** (string) - The OCID of the compartment. - **created_by_principal_id** (string) - The OCID of the principal that created the resource. - **current_key_install_count** (integer) - The number of current installs for this key. - **display_name** (string) - The display name for the install key. - **id** (string) - The OCID of the management agent install key. - **is_unlimited** (boolean) - Whether the key has unlimited install count. - **key** (string) - The content of the key. - **lifecycle_details** (string) - Additional information about the current lifecycle state. - **lifecycle_state** (string) - The current state of the management agent install key. - **time_created** (string) - The date and time the management agent install key was created. - **time_expires** (string) - The date and time the management agent install key expires. - **time_updated** (string) - The date and time the management agent install key was updated. ### Response Example ```json { "management_agent_install_key": { "allowed_key_install_count": 56, "compartment_id": "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx", "created_by_principal_id": "ocid1.createdbyprincipal.oc1..xxxxxxEXAMPLExxxxxx", "current_key_install_count": 56, "display_name": "display_name_example", "id": "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx", "is_unlimited": true, "key": "key_example", "lifecycle_details": "lifecycle_details_example", "lifecycle_state": "CREATING", "time_created": "2013-10-20T19:20:30+01:00", "time_expires": "2013-10-20T19:20:30+01:00", "time_updated": "2013-10-20T19:20:30+01:00" } } ``` ``` -------------------------------- ### Create Instance Configuration from Existing Instance Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_compute_management_instance_configuration_module.rst This example demonstrates creating an instance configuration by referencing an existing instance's ID. This is useful for replicating instance setups. ```yaml oci_compute_management_instance_configuration: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" source: INSTANCE instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx" # optional defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} ``` -------------------------------- ### OCI PostgreSQL Configuration Example Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_psql_configuration_module.rst Example demonstrating how to configure OCI PostgreSQL with tenancy, wait, and wait_timeout parameters. ```yaml --- - name: Create OCI PostgreSQL instance oci_psql_configuration_module: tenancy: "ocid1.tenancy.oc1..aaaaaaa..." wait: yes wait_timeout: 1800 ``` -------------------------------- ### Create Instance Configuration from Scratch Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_compute_management_instance_configuration_module.rst Use this snippet to create a new instance configuration with detailed specifications, including boot volume, networking, and agent configurations. Ensure all required parameters like compartment_id are provided. ```yaml oci_compute_management_instance_configuration: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" source: NONE defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example freeform_tags: {'Department': 'Finance'} ``` -------------------------------- ### Example Usage of OCI OPSI Summarize Host Insights Module Source: https://github.com/oracle/oci-ansible-collection/blob/master/docs/collections/oracle/oci/oci_opsi_summarize_host_insights_top_processes_usage_trend_facts_module.rst This example demonstrates how to use the OCI OPSI module to retrieve summarized host insights and top processes usage trend facts. It shows how to set parameters like tenancy, time interval start and end, and the metric name. ```yaml --- - name: Summarize host insights top processes usage trend facts oci_opsi_summarize_host_insights_top_processes_usage_trend_facts: tenancy: "{{ tenancy_ocid }}" time_interval_start: "{{ time_interval_start }}" time_interval_end: "{{ time_interval_end }}" metric_name: "CPU_UTILIZATION" ```