enable-pluggable-database-management

Description

Enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. This service allows the pluggable database to access tools including Metrics and Performance hub. Database Management is enabled at the pluggable database (PDB) level.

Usage

oci db pluggable-database enable-pluggable-database-management [OPTIONS]

Required Parameters

--password-secret-id [text]

The OCID of the Oracle Cloud Infrastructure secret.

--pluggable-database-id [text]

The database OCID.

--private-end-point-id [text]

The OCID of the private endpoint.

--service-name [text]

The name of the Oracle Database service that will be used to connect to the database.

--user-name [text]

The name of the Oracle Database user that will be used to connect to the database.

Optional Parameters

--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: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--if-match [text]

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST 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 resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--port [integer]

The port used to connect to the pluggable database.

--protocol [text]

Protocol used by the database connection.

Accepted values are:

TCP, TCPS
--role [text]

The role of the user that will be connecting to the pluggable database.

Accepted values are:

NORMAL, SYSDBA, SYSDG
--ssl-secret-id [text]

The OCID of the Oracle Cloud Infrastructure secret.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle 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:

AVAILABLE, BACKUP_IN_PROGRESS, DISABLED, FAILED, PROVISIONING, REFRESHING, RELOCATED, RELOCATING, RESTORE_FAILED, RESTORE_IN_PROGRESS, TERMINATED, TERMINATING, UPDATING
--wait-interval-seconds [integer]

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

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” 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 container_database_id=<substitute-value-of-container_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/pluggable-database/create.html#cmdoption-container-database-id
    export pdb_name=<substitute-value-of-pdb_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/pluggable-database/create.html#cmdoption-pdb-name
    export password_secret_id=<substitute-value-of-password_secret_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/pluggable-database/enable-pluggable-database-management.html#cmdoption-password-secret-id
    export private_end_point_id=<substitute-value-of-private_end_point_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/pluggable-database/enable-pluggable-database-management.html#cmdoption-private-end-point-id
    export service_name=<substitute-value-of-service_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/pluggable-database/enable-pluggable-database-management.html#cmdoption-service-name
    export user_name=<substitute-value-of-user_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/pluggable-database/enable-pluggable-database-management.html#cmdoption-user-name

    pluggable_database_id=$(oci db pluggable-database create --container-database-id $container_database_id --pdb-name $pdb_name --query data.id --raw-output)

    oci db pluggable-database enable-pluggable-database-management --password-secret-id $password_secret_id --pluggable-database-id $pluggable_database_id --private-end-point-id $private_end_point_id --service-name $service_name --user-name $user_name