Oracle Documentation

https://docs.oracle.com/
Admin
The official documentation portal for Oracle products and services, offering comprehensive guides,...
Tokens:5,745,887
Snippets:48,908
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Installer output example

Source: https://docs.oracle.com/en-us/iaas/management-agents/doc/install-management-agent-chapter.html

Example output from running installer.sh, showing the installation and configuration steps and the final success message.

```bash
Checking pre-requisites
Checking if any previous agent service exists
Checking if OS has systemd or initd
Checking available disk space for agent install
Checking if /opt/oracle/mgmt_agent directory exists
Checking if 'mgmt_agent' user exists
'mgmt_agent' user already exists, the agent will proceed installation without creating a new one.
Checking Java version
Trying /opt/jre21
Java version: found at /opt/jre21/bin/java
Checking agent version
Executing install
Unpacking oracle.mgmt_agent-260722.4208.aix.zip using custom utility
Java environment validated: /opt/jre21
Copying files to destination dir (/opt/oracle/mgmt_agent)
Initializing software from template
Checking if JavaScript engine is available to use
Creating mgmt_agent daemon
Agent Install Logs: /opt/oracle/mgmt_agent/installer-logs/installer.log.0
Agent install successful
Executing configure
Parsing input response file
Validating install key
Generating communication wallet
Generating security artifacts
Registering Management Agent
Starting agent...
Agent started successfully
Agent setup completed and the agent is running.
In the future agent can be started by directly running: sudo startsrc -s mgmt_agent
Please use OCI CLI or OCI Management Agent console to validate the successful activation of your agent.
Please make sure that you delete /full/path/to/input.rsp or store it in secure location.
```

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

### Example using required parameter for hosted-application get

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/hosted-application/get.html

Example script that creates a hosted application and then gets its information. Requires a POSIX-compliant bash-like 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/generative-ai/hosted-application/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/generative-ai/hosted-application/create.html#cmdoption-display-name

    hosted_application_id=$(oci generative-ai hosted-application create --compartment-id $compartment_id --display-name $display_name --inbound-auth-config file://inbound-auth-config.json --query data.id --raw-output)

    oci generative-ai hosted-application get --hosted-application-id $hosted_application_id

```

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

### Example: oci os ns get --enable-dual-stack

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

Example of using the --enable-dual-stack flag with the oci os ns get command.

```bash
oci os ns get –enable-dual-stack

```

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

### 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

```

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

### curl GET example

Source: https://docs.oracle.com/en-us/iaas/Content/APIGateway/Tasks/apigatewayinvokingdeployedapi.htm

Example curl command using the GET method to call a deployed API.

```bash
curl -k -X GET https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/marketing/hello/
```

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

### Example installer.sh command

Source: https://docs.oracle.com/en-us/iaas/management-agents/doc/install-management-agent-chapter.html

Example of running installer.sh with a response file and a specific service identifier.

```bash
sudo ./installer.sh /tmp/input.rsp mgmt_agent-oc1_phx-abc123
```

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

### Ingest and retrieve document with k-NN index

Source: https://docs.oracle.com/en-us/iaas/Content/search-opensearch/Concepts/ocigenaiconnector.htm

Ingests a document into the index using the ingestion pipeline, then retrieves it with a GET request and starts ingesting a second document. The document text is an example passage about antibiotic resistance.

```json
PUT /conversation-demo-index-knn/_doc/1
{
    "text": "The emergence of resistance of bacteria to antibiotics is a common phenomenon. Emergence of resistance often reflects evolutionary processes that take place during antibiotic therapy. The antibiotic treatment may select for bacterial strains with physiologically or genetically enhanced capacity to survive high doses of antibiotics. Under certain conditions, it may result in preferential growth of resistant bacteria, while growth of susceptible bacteria is inhibited by the drug. For example, antibacterial selection for strains having previously acquired antibacterial-resistance genes was demonstrated in 1943 by the Luria–Delbrück experiment. Antibiotics such as penicillin and erythromycin, which used to have a high efficacy against many bacterial species and strains, have become less effective, due to the increased resistance of many bacterial strains."
   
}
GET /conversation-demo-index-knn/_doc/1
PUT /conversation-demo-index-knn/_doc/2
```

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

### Installer output for successful agent setup

Source: https://docs.oracle.com/en-us/iaas/management-agents/doc/install-management-agent-chapter.html

Sample output from a successful installation and configuration. Shows pre-requisite checks, installation steps, and final confirmation. Also notes that the response file should be deleted or stored securely.

```text
sudo ./installer.sh <user_home_directory>/input.rsp mgmt_agent-oc1_phx-abc123
Checking pre-requisites
	Checking if any previous agent service exists
	Checking if OS has systemd or initd
	Checking available disk space for agent install
	Checking if /opt/oracle/mgmt_agent-oc1_phx-abc123 directory exists
	Checking if 'mgmt_agent' user exists
	Checking Java version
		JAVA_HOME is not set or not readable to root
		Trying default path /usr/bin/java
		Java version: 1.8.0_282 found at /usr/bin/java
	Checking agent version

Executing install
	Unpacking software zip
	Copying files to destination dir (/opt/oracle/mgmt_agent-oc1_phx-abc123)
	Initializing software from template
	Checking if JavaScript engine is available to use
	Creating mgmt_agent-oc1_phx-abc123 daemon
	Agent Install Logs: /opt/oracle/mgmt_agent-oc1_phx-abc123/installer-logs/installer.log.0

Agent install successful

Executing configure

	Parsing input response file
	Validating install key
	Generating communication wallet
	Generating security artifacts
	Registering Management Agent

Starting agent...
Agent started successfully


Agent setup completed and the agent is running.
In the future agent can be started by directly running: sudo systemctl start mgmt_agent-oc1_phx-abc123

Please make sure that you delete <user_home_directory>/input.rsp or store it in secure location.
```

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

### Get Dataflow History with Query Parameters

Source: https://docs.oracle.com/en/cloud/paas/analytics-cloud/acapi/op-20210901-catalog-dataflows-dataflowid-history-get.html

Returns specific run history by applying query parameters to filter results by job status or start time, exclude task history, and limit the number of jobs returned. This example filters for jobs with status SUCCEEDED, from start time 2024-05-01, and excludes task information.

```bash
curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET 'https://<hostname>/api/20210901/catalog/dataflows/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhRmxvdzogRW5yaWNoIE15U2FsZXMgUmVwb3J0Jw/history?jobStatus=SUCCEEDED&fromStartTime=2024-05-01&includeTasks=false'
```

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

### Example using required parameter for oci fs mount-target get

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

Complete example that creates a mount target and then retrieves its information. Copy these commands into a file named example.sh and run with 'bash example.sh', replacing the example parameters with your own. Requires a POSIX-compliant bash-like shell and OCI configuration with appropriate security policies.

```bash
    export availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/fs/mount-target/create.html#cmdoption-availability-domain
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/fs/mount-target/create.html#cmdoption-compartment-id
    export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/fs/mount-target/create.html#cmdoption-subnet-id

    mount_target_id=$(oci fs mount-target create --availability-domain $availability_domain --compartment-id $compartment_id --subnet-id $subnet_id --query data.id --raw-output)

    oci fs mount-target get --mount-target-id $mount_target_id

```

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

### CLI: Get image details using OCID (example)

Source: https://docs.oracle.com/en-us/iaas/Content/Registry/Tasks/registryviewingimagedetails.htm

Example of the oci artifacts container image get command with a sample OCID.

```bash
oci artifacts container image get --image-id ocid1.containerimage.oc1.phx.0.ansh81vru1zp.aaaaaaaalqzjyks...
```

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

### Bash example: install addon with required parameters

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/install-addon.html

Copy these commands into a file named example.sh and run with 'bash example.sh', replacing the example parameters. Requires a POSIX-compliant bash-like shell, OCI configuration, and appropriate security policies. The script exports required parameter values, creates a cluster, and installs the addon.

```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/ce/cluster/create.html#cmdoption-compartment-id
    export kubernetes_version=<substitute-value-of-kubernetes_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-kubernetes-version
    export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-name
    export vcn_id=<substitute-value-of-vcn_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-vcn-id
    export addon_name=<substitute-value-of-addon_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/install-addon.html#cmdoption-addon-name

    cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)

    oci ce cluster install-addon --addon-name $addon_name --cluster-id $cluster_id

```

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

### Run setup.sh with response file

Source: https://docs.oracle.com/en-us/iaas/osmh/doc/register-non-oci-instance.htm

Runs the setup script with the response file to configure the Management Agent. A successful setup returns the message 'Agent setup completed and the agent is running'; the OS Management Hub plugin setup can take a few more minutes in the background.

```bash
sudo /opt/oracle/mgmt_agent/agent_inst/bin/setup.sh opts=/tmp/input.rsp
```

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

### Example using required parameter

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/list-addons.html

Example script that creates a cluster and then lists its addons. Requires setting up OCI configuration and 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/ce/cluster/create.html#cmdoption-compartment-id
    export kubernetes_version=<substitute-value-of-kubernetes_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-kubernetes-version
    export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-name
    export vcn_id=<substitute-value-of-vcn_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-vcn-id

    cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)

    oci ce cluster list-addons --cluster-id $cluster_id

```

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

### Example using required parameter for oci ce cluster get

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

Example script that creates a cluster and then gets its details. Requires POSIX-compliant bash 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/ce/cluster/create.html#cmdoption-compartment-id
    export kubernetes_version=<substitute-value-of-kubernetes_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-kubernetes-version
    export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-name
    export vcn_id=<substitute-value-of-vcn_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ce/cluster/create.html#cmdoption-vcn-id

    cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)

    oci ce cluster get --cluster-id $cluster_id

```

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

### Example Output of dbcs-agent Installation

Source: https://docs.oracle.com/en-us/iaas/Content/knownissues.htm

Example output from installing the dbcs-agent RPM. Shows the expected progress and service startup messages, including the dbaastools_exa version check and the initdbcsagent/initdbcsadmin processes.

```bash
[root@<node_n>~]# rpm -ivh dbcs-agent-2.5-3.x86_64.rpm
Preparing...                ########################################### [100%]
Checking for dbaastools_exa rpm on the system
Current dbaastools_exa version = dbaastools_exa-1.0-1+18.1.4.1.0_180725.0000.x86_64
dbaastools_exa version dbaastools_exa-1.0-1+18.1.4.1.0_180725.0000.x86_64 is good. Continuing with dbcs-agent installation
   1:dbcs-agent             ########################################### [100%]
initctl: Unknown instance:
initctl: Unknown instance:
initzookeeper start/running, process 85821
initdbcsagent stop/waiting
initdbcsadmin stop/waiting
initdbcsagent start/running, process 85833
initdbcsadmin start/running, process 85836
```

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

### Example using required parameters

Source: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/hosted-deployment/delete-hosted-deployment-artifact.html

Example shell script that creates a hosted deployment, retrieves its ID, and deletes the artifact. Requires POSIX-compliant bash and OCI configuration.

```bash
export artifact_id=<substitute-value-of-artifact_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/hosted-deployment/delete-hosted-deployment-artifact.html#cmdoption-artifact-id

hosted_deployment_id=$(oci generative-ai hosted-deployment create --active-artifact file://active-artifact.json --query data.id --raw-output)

oci generative-ai hosted-deployment delete-hosted-deployment-artifact --artifact-id $artifact_id --hosted-deployment-id $hosted_deployment_id

```

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

### Expected installation output for Linux ZIP file installation

Source: https://docs.oracle.com/en-us/iaas/management-agents/doc/install-management-agent-chapter.html

Shows the expected output when installing the Management Agent using the Linux ZIP file. The output confirms successful installation and configuration, and notes that the agent can be started with 'sudo /etc/init.d/mgmt_agent start'. It also reminds to delete or securely store the input response file.

```text
Checking pre-requisites
Checking if any previous agent service exists
Checking if OS has systemd or initd
Checking available disk space for agent install
Checking if environment variable SUDO_PATH is set
Checking if /opt/oracle/mgmt_agent directory exists
Checking if 'mgmt_agent' user exists
'mgmt_agent' user already exists, the agent will proceed installation without creating a new one.
Checking agent version
Executing install
Unpacking oracle.mgmt_agent-260722.4208.solaris.zip using custom utility
Solaris detected. Using static JDK path: /opt/oracle/mgmt_agent/jdk1.8.0_501-b08
Installing new JDK: jdk1.8.0_501-b08
Java environment validated: /opt/oracle/mgmt_agent/jdk1.8.0_501-b08
Copying files to destination dir (/opt/oracle/mgmt_agent)
Initializing software from template
Checking if JavaScript engine is available to use
Creating mgmt_agent daemon
Agent Install Logs: /opt/oracle/mgmt_agent/installer-logs/installer.log.0
Agent install successful
Executing configure
Parsing input response file
Validating install key
Generating communication wallet
Generating security artifacts
Registering Management Agent
Starting agent...
Agent started successfully
Agent setup completed and the agent is running.
In the future agent can be started by directly running: sudo /etc/init.d/mgmt_agent start
Please use OCI CLI or OCI Management Agent console to validate the successful activation of your agent.
Please make sure that you delete /full/path/to/input.rsp or store it in secure location.
```

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

### Run installer.sh with response file

Source: https://docs.oracle.com/en-us/iaas/management-agents/doc/install-management-agent-chapter.html

Run the installer script with the full path to a response file. Example: sudo ./installer.sh /tmp/input.rsp. The output shows pre-requisite checks and successful installation.

```bash
sudo ./installer.sh <full_path_of_response_file>

```

```bash
sudo ./installer.sh                                 /tmp/input.rsp

```
Tokens:
Raw