Change the connection details of a co-managed database insight. When provided, If-Match is checked against ETag values of the resource.


oci opsi database-insights change-pe-comanaged-database-detail [OPTIONS]

Required Parameters

--credential-details-credential-source-name [text]

Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service.

--database-insight-id [text]

Unique database insight identifier

--opsi-private-endpoint-id [text]

The OCID of the OPSI private endpoint

--service-name [text]

Database service name used for connection requests.

Optional Parameters

--connection-details [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--credential-details-password-secret-id [text]

The secret OCID mapping to the database credentials.

--credential-details-role [text]

database user role.

Accepted values are:

--credential-details-user-name [text]

database user name.

--credential-details-wallet-secret-id [text]

The OCID of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--if-match [text]

Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> #
    export display_name=<substitute-value-of-display_name> #
    export is_used_for_rac_dbs=<substitute-value-of-is_used_for_rac_dbs> #
    export subnet_id=<substitute-value-of-subnet_id> #
    export vcn_id=<substitute-value-of-vcn_id> #
    export credential_details_credential_source_name=<substitute-value-of-credential_details_credential_source_name> #
    export database_insight_id=<substitute-value-of-database_insight_id> #
    export service_name=<substitute-value-of-service_name> #

    opsi_private_endpoint_id=$(oci opsi opsi-private-endpoint create --compartment-id $compartment_id --display-name $display_name --is-used-for-rac-dbs $is_used_for_rac_dbs --subnet-id $subnet_id --vcn-id $vcn_id --query --raw-output)

    oci opsi database-insights change-pe-comanaged-database-detail --credential-details-credential-source-name $credential_details_credential_source_name --database-insight-id $database_insight_id --opsi-private-endpoint-id $opsi_private_endpoint_id --service-name $service_name