Oracle Cloud Infrastructure

https://docs.oracle.com/en-us/iaas/
Admin
Oracle Cloud Infrastructure (OCI) is a suite of cloud computing services that runs on the Oracle...
Tokens:36,653,446
Snippets:221,729
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example using required parameter for install-key get

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/install-key/get.html

Example script that creates an install key and then retrieves its details. Requires a POSIX-compliant bash shell, OCI configuration, and appropriate security policies. Replace the substitute values with your own.

```bash
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/install-key/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/install-key/create.html#cmdoption-display-name

    install_key_id=$(oci management-agent install-key create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)

    oci management-agent install-key get --install-key-id $install_key_id

```

--------------------------------

### Create and get support account example

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/my-support-account/get.html

Example script that creates a support account and then gets it. Requires a POSIX-compliant bash-like shell, OCI configuration, and appropriate security policies. Replace the example parameters with your own.

```bash
export token=<substitute-value-of-token> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/my-support-account/create.html#cmdoption-token

my_support_account_id=$(oci identity-domains my-support-account create --schemas file://schemas.json --token $token --query data.id --raw-output)

oci identity-domains my-support-account get --my-support-account-id $my_support_account_id

```

--------------------------------

### Example using required parameter for get

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/resource-manager/configuration-source-provider/get.html

Example script that creates a configuration source provider and then gets its details. Requires a POSIX-compliant bash shell, OCI configuration, and appropriate security policies. Replace the example parameters with your own values.

```bash
    export config_source_provider_type=<substitute-value-of-config_source_provider_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/resource-manager/configuration-source-provider/create.html#cmdoption-config-source-provider-type

    configuration_source_provider_id=$(oci resource-manager configuration-source-provider create --config-source-provider-type $config_source_provider_type --query data.id --raw-output)

    oci resource-manager configuration-source-provider get --configuration-source-provider-id $configuration_source_provider_id

```

--------------------------------

### Example using required parameter: create and get subscription

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/self/subscription/subscription/get.html

Complete example that creates a subscription, captures its ID, and then retrieves it with the get command. Requires a POSIX-compliant bash shell, OCI configuration, and appropriate security policies. Replace the example parameters with your own.

```bash
export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/self/subscription/subscription/create.html#cmdoption-compartment-id
    export product_id=<substitute-value-of-product_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/self/subscription/subscription/create.html#cmdoption-product-id
    export seller_id=<substitute-value-of-seller_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/self/subscription/subscription/create.html#cmdoption-seller-id
    export tenant_id=<substitute-value-of-tenant_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/self/subscription/subscription/create.html#cmdoption-tenant-id

    subscription_id=$(oci self subscription subscription create --compartment-id $compartment_id --product-id $product_id --seller-id $seller_id --subscription-details file://subscription-details.json --tenant-id $tenant_id --query data.id --raw-output)

    oci self subscription subscription get --subscription-id $subscription_id
```

--------------------------------

### Example: oci setup instance-principal

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/setup/instance-principal.html

Runs the interactive setup script for instance principal authentication. Copy this command into a file named example.sh and run with 'bash example.sh'. Requires a POSIX-compliant bash-like shell, OCI configuration, and appropriate security policies.

```bash
oci setup instance-principal

```

--------------------------------

### Create and get DR protection group example

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/disaster-recovery/dr-protection-group/get.html

A complete example that creates a DR protection group, captures its ID, and then calls get to retrieve it. Requires a POSIX-compliant bash-like shell material; setup OCI configuration and security policies first.

```bash
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/disaster-recovery/dr-protection-group/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/disaster-recovery/dr-protection-group/create.html#cmdoption-display-name

    dr_protection_group_id=$(oci disaster-recovery dr-protection-group create --compartment-id $compartment_id --display-name $display_name --log-location file://log-location.json --query data.id --raw-output)

    oci disaster-recovery dr-protection-group get --dr-protection-group-id $dr_protection_group_id

```

--------------------------------

### JavaScript: Get start and end time for URL

Source: https://docs.oracle.com/en-us/iaas/log-analytics/doc/log-explorer-url-parameters.html

JavaScript code to generate start and end time values (in milliseconds) for use in the startTime and endTime URL parameters. This example sets a 30-minute window.

```javascript
var now = new Date();
```

```javascript
var startTime = now.getTime() - (1000*60)                                     *30;
```

```javascript
var endTime = now.getTime();
```

--------------------------------

### Example: Get Base64-encoded CA Certificate with CLI

Source: https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengcloudinitforselfmanagednodes.htm

Example of the CLI command to obtain the base64-encoded CA certificate, using a sample cluster OCID and region. The output is a long alphanumeric string starting with `LS0t`.

```bash
oci ce cluster create-kubeconfig --cluster-id ocid1.cluster.oc1.phx.aaaaaaaa______ivq --region us-phoenix-1 --file - | grep -oE "LS0t.*"
```

--------------------------------

### Example using required parameters for sign-upload

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/container/image-signature/sign-upload.html

Complete example that sets required environment variables and runs the sign-upload command. Save as example.sh and run with 'bash example.sh'. Requires POSIX-compliant bash shell and OCI configuration with appropriate security policies.

```bash
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/container/image-signature/sign-upload.html#cmdoption-compartment-id
    export image_id=<substitute-value-of-image_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/container/image-signature/sign-upload.html#cmdoption-image-id
    export kms_key_id=<substitute-value-of-kms_key_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/container/image-signature/sign-upload.html#cmdoption-kms-key-id
    export kms_key_version_id=<substitute-value-of-kms_key_version_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/container/image-signature/sign-upload.html#cmdoption-kms-key-version-id
    export signing_algorithm=<substitute-value-of-signing_algorithm> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/container/image-signature/sign-upload.html#cmdoption-signing-algorithm

    oci artifacts container image-signature sign-upload --compartment-id $compartment_id --image-id $image_id --kms-key-id $kms_key_id --kms-key-version-id $kms_key_version_id --signing-algorithm $signing_algorithm

```

--------------------------------

### Install Spark and Dependencies

Source: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/hdfsconnectorspark.htm

Install Spark and its dependencies (Java 1.8, Scala 2.12.4) on Oracle Linux 7.4, then start a Spark master. Requires sudo access and wget. The example installs Spark into the current user's home directory, which is not recommended for production.

```bash
# We'll use wget to download some of the artifacts that need to be installed
sudo yum install wget
 
# First install Java
sudo yum install java-1.8.0-openjdk.x86_64
export JAVA_HOME=/usr/lib/jvm/jre-1.8.0-openjdk
# Should be something like: OpenJDK Runtime Environment (build 1.8.0_161-b14)
java -version
 
# Then install Scala
wget https://downloads.lightbend.com/scala/2.12.4/scala-2.12.4.rpm
sudo yum install scala-2.12.4.rpm
# Should be something like: Scala code runner version 2.12.4 -- Copyright 2002-2017, LAMP/EPFL and Lightbend, Inc.
scala -version
 
# Then download Spark
wget https://archive.apache.org/dist/spark/spark-2.2.1/spark-2.2.1-bin-hadoop2.7.tgz
tar xvf spark-2.2.1-bin-hadoop2.7.tgz
export SPARK_HOME=$HOME/spark-2.2.1-bin-hadoop2.7
export PATH=$PATH:$SPARK_HOME/bin
 
# Start a Spark master
cd $SPARK_HOME
./sbin/start-master.sh
```

--------------------------------

### Run create-deploy-compute-instance-group-canary-stage with required parameters

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/deploy-stage/create-deploy-compute-instance-group-canary-stage.html

Copy these commands into a file named example.sh and run with 'bash example.sh'. This sample works only in POSIX-compliant bash-like shells. Set up OCI configuration and security policies before running. Replace the example parameters with your own.

```bash
export compute_instance_group_environment_id=<substitute-value-of-compute_instance_group_environment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/deploy-stage/create-deploy-compute-instance-group-canary-stage.html#cmdoption-compute-instance-group-environment-id
export deployment_spec_artifact_id=<substitute-value-of-deployment_spec_artifact_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/deploy-stage/create-deploy-compute-instance-group-canary-stage.html#cmdoption-deployment-spec-artifact-id
export pipeline_id=<substitute-value-of-pipeline_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/deploy-stage/create-deploy-compute-instance-group-canary-stage.html#cmdoption-pipeline-id

oci devops deploy-stage create-deploy-compute-instance-group-canary-stage --compute-instance-group-environment-id $compute_instance_group_environment_id --deployment-spec-artifact-id $deployment_spec_artifact_id --pipeline-id $pipeline_id --production-load-balancer-config file://production-load-balancer-config.json --rollout-policy file://rollout-policy.json --stage-predecessor-collection file://stage-predecessor-collection.json
```

--------------------------------

### Example using required parameter

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/resource-manager/configuration-source-provider/list.html

Example command to list configuration source providers. Copy into a file named example.sh and run with 'bash example.sh'. Works only in POSIX-compliant bash-like shell. Requires OCI configuration and security policies.

```bash
oci resource-manager configuration-source-provider list

```

--------------------------------

### Custom Dockerfile with Oracle Instant Client

Source: https://docs.oracle.com/en-us/iaas/Content/Functions/Tasks/functionsusingcustomdockerfiles.htm

Example of a custom Dockerfile that installs Oracle Instant Client from an oraclelinux:7-slim base image. This is a starting point for a custom Dockerfile.

```dockerfile
FROM oraclelinux:7-slim

RUN  yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
     yum-config-manager --disable ol7_developer_EPEL && \
     yum -y install oracle-instantclient19.3-basiclite nodejs && \
     rm -rf /var/cache/yum

WORKDIR /function
ADD . /function/
RUN npm install

CMD exec node func.js

```

--------------------------------

### Create and get key example

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/get.html

A complete example that sets environment variables, creates a key, and then retrieves it with the get command. Requires a POSIX-compliant shell and OCI configuration with appropriate security policies.

```bash
export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-display-name

    key_id=$(oci kms management key create --compartment-id $compartment_id --display-name $display_name --endpoint https://region.domain.com --key-shape file://key-shape.json --query data.id --raw-output)

    oci kms management key get --key-id $key_id

```

--------------------------------

### List my support accounts using required parameters

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/my-support-accounts/list.html

Copy this command into a file named example.sh and run with 'bash example.sh'. This sample works only in POSIX-compliant bash-like shells. Set up OCI configuration and appropriate security policies before running.

```bash
oci identity-domains my-support-accounts list
```

--------------------------------

### DirectivesConfig.acml command chain example

Source: https://docs.oracle.com/en-us/iaas/application-performance-monitoring/doc/modify-probe-settings.html

Example of a command chain in the DirectivesConfig.acml file. The exampleVar chain starts with the User object, then calls getAddress(), gets the street field, replaces 'Pk' with 'This' (all), and replaces the first 'This' with 'That', resulting in 'OracleThatway'.

```text
test:  class_name: "com.test.beans.User"
  method_name: "incAge"
  span_name: "${short_class_name}.${method_name}"
  tags:
    t: "${this}"
    params: "${param1}"
    r: "${return}"
    exampleVarTag: "${exampleVar}"
  variables:
    exampleVar:  before this | method (public getAddress ()) | field(private street) |  regex(Pk,This, all) | regex(This, That, first) 
```

--------------------------------

### Get add-on details with example output

Source: https://docs.oracle.com/en-us/iaas/compute-cloud-at-customer/cmn/oke/viewing-oke-cluster-add-ons.htm

Gets details for a specific add-on, showing configuration values. The output includes the add-on name, current installed version, lifecycle state, and configuration parameters. If the lifecycle state is NEEDS_ATTENTION, see Add-on Reconciliation.

```bash
$ oci ce cluster get-addon --cluster-id ocid1.cluster._unique_ID_ \
--addon-name WeblogicKubernetesOperator
{
  "data": {
    "addon-error": {
        "code": null,
        "message": null,
        "status": null
    },
    "configurations": [
      {
        "key": "numOfReplicas",
        "value": "0"
      },
      {
        "key": "weblogic-operator.ContainerResources",
        "value": "{'limits': {'cpu': '500m', 'memory': '200Mi'}}"
      },
      {
        "key": "weblogic-operator-webhook.ContainerResources",
        "value": "{'limits': {'cpu': '200m', 'memory': '300Mi'}}"
      }
    ],
    "current-installed-version": "v4.2.13",
    "lifecycle-state": "ACTIVE",
    "name": "WeblogicKubernetesOperator",
    "time-created": "2025-02-26T01:41:52.020696+00:00",
    "version": null
  },
  "etag": "5f3eef22-eb32-5c2c-774c-c7a98836a13a"
}
```

--------------------------------

### Example using required parameter: create key and list key versions

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key-version/list.html

A complete example that sets environment variables, creates a key, and then lists key versions for that key. Requires a POSIX-compliant bash shell and OCI configuration with appropriate security policies.

```bash
export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-display-name

    key_id=$(oci kms management key create --compartment-id $compartment_id --display-name $display_name --endpoint https://region.domain.com --key-shape file://key-shape.json --query data.id --raw-output)

    oci kms management key-version list --key-id $key_id
```

--------------------------------

### Get Object with GET

Source: https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/usingpreauthenticatedrequests_topic-Working_with_PreAuthenticated_Requests.htm

Getting an object using a pre-authenticated request. The example shows a GET command with a unique PAR URL and a concrete example URL.

```bash
$ curl -X GET unique_PAR_URL
                
```

```bash
$ curl -X GET https://objectstorage.us-phoenix-1.oraclecloud.com/p/MR7rGASetBbu4L1R5ZH91meUZJjVkOGmd4rtnjDhazP9o6s2KzLyFUxILQzSamEp/n/MyNamespace/b/MyParBucket/o/OCI_User_Guide.pdf
'@data.1''@data.2''@data.3'
```

--------------------------------

### Example using required parameters for key-version get

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key-version/get.html

Complete example script that creates a key and a key version, then retrieves the key version. Requires a POSIX-compliant shell, OCI configuration, and appropriate security policies. Replace the example parameters with your own values.

```bash
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-display-name
    export key_id=<substitute-value-of-key_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key-version/create.html#cmdoption-key-id

    key_id=$(oci kms management key create --compartment-id $compartment_id --display-name $display_name --endpoint https://region.domain.com --key-shape file://key-shape.json --query data.id --raw-output)

    key_version_id=$(oci kms management key-version create --key-id $key_id --query data.id --raw-output)

    oci kms management key-version get --key-id $key_id --key-version-id $key_version_id

```

--------------------------------

### Run create-db-system-point-in-time-db-system-source-details with required parameters

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details.html

Copy these commands into a file named example.sh and run with 'bash example.sh'. This sample works only in POSIX-compliant bash-like shells. Set up OCI configuration and security policies before running.

```bash
export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details.html#cmdoption-compartment-id
export db_version=<substitute-value-of-db_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details.html#cmdoption-db-version
export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details.html#cmdoption-display-name
export shape=<substitute-value-of-shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details.html#cmdoption-shape
export source_db_system_id=<substitute-value-of-source_db_system_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details.html#cmdoption-source-db-system-id
export source_time_to_restore=<substitute-value-of-source_time_to_restore> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details.html#cmdoption-source-time-to-restore

oci psql db-system create-db-system-point-in-time-db-system-source-details --compartment-id $compartment_id --db-version $db_version --display-name $display_name --network-details file://network-details.json --shape $shape --source-db-system-id $source_db_system_id --source-time-to-restore $source_time_to_restore --storage-details file://storage-details.json
```

--------------------------------

### dbaascli database start example

Source: https://docs.oracle.com/en-us/iaas/exadatacloud/doc/ecs-using-dbaascli.html

Example of starting a database in mount mode.

```bash
dbaascli database start --dbname dbname --mode mount
```

--------------------------------

### List SDKs - Example using Required Parameter

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/api-gateway/sdk/list.html

Example command using the required parameter. Copy this into a file named example.sh and run with 'bash example.sh'. Requires POSIX-compliant bash-like shell and OCI configuration with appropriate security policies.

```bash
    oci api-gateway sdk list

```

--------------------------------

### Get installed package info with rpm

Source: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/dotnetsdkgettingstarted.htm

Gets information about the installed oci-dotnet-sdk package.

```bash
rpm  -qi oci-dotnet-sdk
```

--------------------------------

### Example: get primary group

Source: https://docs.oracle.com/en-us/iaas/management-agents/doc/management-gateway-administration-tasks.html

Example showing how to get the primary group for a valid user.

```shell
id -gn myexistinguser
```
Tokens:
Raw