Oracle Cloud Infrastructure SDK for TypeScript and JavaScript

https://docs.oracle.com/en-us/iaas/Content/API/
Admin
The Oracle Cloud Infrastructure SDK for TypeScript and JavaScript enables developers to write code...
Tokens:108,514
Snippets:627
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run OCI CLI Setup Dialog

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

Initiates the OCI CLI setup process, guiding the user through creating the configuration file and generating API keys. This command prompts for necessary information like user OCID, tenancy OCID, region, and fingerprint.

```bash
oci setup config
```

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

### Example OCI Configuration File

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

Demonstrates the structure and required entries for a valid OCI configuration file. It includes essential parameters like user, fingerprint, key_file, tenancy, and region, along with an example of how to add comments.

```ini
[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
# Some comment
region=us-ashburn-1
```

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

### Copy OCI Java SDK Example (Shell)

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_java

This command copies a pre-installed Java example file, 'ListDBVersionExample.java', from the OCI Java SDK examples directory to the current working directory. This assumes the SDK environment variables are set.

```shell
cp $OCI_JAVA_SDK_LOCATION/examples/ListDBVersionExample.java .
```

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

### Install OCI CLI on Linux/UNIX using Bash Script

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

Installs the OCI CLI on Linux and UNIX-like systems by downloading and executing an installation script using bash and curl. This script handles the installation of the CLI and its dependencies like Python and virtualenv.

```bash
bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
```

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

### Install ts-node for Running TypeScript Examples

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

This command installs `ts-node` globally, a tool that allows you to run TypeScript files directly without pre-compilation. This simplifies the process of executing the SDK examples.

```bash
npm install -g ts-node
```

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

### Install OCI Modules for PowerShell

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

This snippet shows how to start a PowerShell session and install the base OCI modules for PowerShell. It covers installation on Windows, Linux, and MacOS. The note explains the uninstallation behavior of the OCI.PSModules.

```powershell
$pwsh

PowerShell 7.1.0
Copyright (c) Microsoft Corporation. All rights reserved.

https://aka.ms/powershell
Type 'help' to get help.

PS /Users/username>
```

```powershell
Install-Module OCI.PSModules
```

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

### Verify OCI CLI Installation

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

Checks if the OCI CLI is installed correctly by running the 'oci --version' command. This command should output the installed version of the CLI if the installation was successful.

```bash
oci --version
```

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

### Run OCI CLI Installer Script with Prompts in PowerShell

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

Executes the OCI CLI installation script in PowerShell, allowing the user to respond to prompts during the installation process. This method provides flexibility in configuring the installation.

```powershell
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))
```

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

### Download OCI CLI Installer Script for Windows PowerShell

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

Downloads the OCI CLI installation script from GitHub to the local system using PowerShell's Invoke-WebRequest cmdlet. This script is used to install the CLI on Windows.

```powershell
Invoke-WebRequest https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1 -OutFile install.ps1
```

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

### Run OCI CLI Installer Script with Default Settings in PowerShell

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

Executes the OCI CLI installation script in PowerShell, automatically accepting all default settings without prompting the user. This is a non-interactive installation method.

```powershell
./install.ps1 -AcceptAllDefaults
```

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

### Example Output of jms-java-download.sh

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

This is an example of the output generated when running the `jms-java-download.sh` script. It lists the available Java versions, their types, security status, release dates, end-of-support-life dates, and links to release notes. The user is prompted to enter the number corresponding to the desired Java version for installation.

```text
<username>@cloudshell:jms (oci_region_id)$ jms-java-download.sh 
Fetching Java releases.
Current Java Versions:
    Version         Type       Security status      Release date         EOSL date            Release notes                           
1)  24.0.1          CPU        UP_TO_DATE           Apr 15, 2025         Sep 18, 2025         https://www.oracle.com/java/technologies/javase/24-0-1-relnotes.html
2)  21.0.7          CPU        UP_TO_DATE           Apr 15, 2025         Sep 19, 2031         https://www.oracle.com/java/technologies/javase/21-0-7-relnotes.html
3)  17.0.15         CPU        UP_TO_DATE           Apr 15, 2025         Sep 18, 2029         https://www.oracle.com/java/technologies/javase/17-0-15-relnotes.html
4)  11.0.27         CPU        UP_TO_DATE           Apr 15, 2025         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-27-relnotes.html
5)  1.8.0_451       CPU        UP_TO_DATE           Apr 15, 2025         Dec 31, 2030         https://www.oracle.com/java/technologies/javase/8u451-relnotes.html
6)  Show Archived Versions
Enter the number corresponding to the version to install (or 6 to view archived versions):
```

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

### Start PowerShell Session

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

This command starts a PowerShell session. It is a prerequisite for registering local repositories and installing modules within a Linux environment.

```bash
$ pwsh
```

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

### Run OCI .NET SDK Examples

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

These commands demonstrate how to navigate to the .NET examples directory within the cloned OCI SDK repository and execute the examples using the .NET CLI. An environment variable `OCI_COMPARTMENT_ID` must be set before running the examples.

```bash
cd ./oci-dotnet-sdk/Examples/
dotnet run 
```

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

### Run OCI Java SDK Example (Shell)

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_java

This command executes the compiled 'ListDBVersionExample' Java application. It requires the same classpath as compilation and accepts OCI tenancy OCID and a region/compartment OCID as command-line arguments.

```shell
java -cp .:$OCI_JAVA_SDK_FULL_JAR_LOCATION:$OCI_JAVA_SDK_LOCATION/third-party/lib/*:$OCI_JAVA_SDK_LOCATION/lib/jersey/*:$OCI_JAVA_SDK_LOCATION/third-party/jersey/lib/* ListDBVersionExample $OCI_TENANCY BM.HighIO1.36
```

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

### OCI CLI Get Authentication Policy Example

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

This snippet shows an example of a CLI command to retrieve an authentication policy for a specific compartment. It's used in the context of troubleshooting a missing configuration file.

```bash
oci iam authentication-policy get --compartment-id <tenancy_OCID>
```

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

### Clone OCI .NET SDK Repository

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

This command clones the Oracle Cloud Infrastructure SDK for .NET repository from GitHub. This is a prerequisite for accessing and running the provided SDK examples. Ensure you have Git installed and configured.

```bash
git clone https://github.com/oracle/oci-dotnet-sdk.git
```

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

### Install, Upgrade, and Uninstall OCI CLI on macOS using Homebrew

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

Manages the OCI CLI installation on macOS using the Homebrew package manager. This includes commands to update Homebrew, install the CLI, upgrade an existing installation, and uninstall the CLI.

```bash
brew update && brew install oci-cli
```

```bash
brew update && brew upgrade oci-cli
```

```bash
brew uninstall oci-cli
```

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

### Install TypeScript SDK Dependencies

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

These commands are used to install the necessary Node.js dependencies for the OCI SDK for TypeScript and JavaScript after cloning the repository. It includes installing project dependencies and optionally installing TypeScript globally if not already present.

```bash
cd ./oci-typescript-sdk
npm install
npm run build
```

```bash
npm install -g typescript@4.1.3
```

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

### Install OCI CLI on Oracle Linux 9 using DNF

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

Installs the OCI CLI on Oracle Linux 9 using the `dnf` package manager. It first installs the developer release repository and then the CLI package. The command also shows how to uninstall the CLI.

```bash
sudo dnf -y install oraclelinux-developer-release-el9
sudo dnf install python39-oci-cli
```

```bash
sudo dnf remove python39-oci-cli
```

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

### Navigate to OCI PowerShell Examples Folder

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

This command navigates the user into the Examples directory within the cloned OCI PowerShell Modules repository. This is a necessary step before running any example scripts.

```powershell
cd ./oci-powershell-modules/Examples
```

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

### Compile OCI Java SDK Example (Shell)

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_java

This command compiles the 'ListDBVersionExample.java' file. It includes necessary JAR files from the OCI Java SDK and its third-party dependencies in the classpath for successful compilation. The `$OCI_JAVA_SDK_FULL_JAR_LOCATION` variable points to the main SDK JAR.

```shell
javac -cp .:$OCI_JAVA_SDK_FULL_JAR_LOCATION:$OCI_JAVA_SDK_LOCATION/third-party/lib/*:$OCI_JAVA_SDK_LOCATION/lib/jersey/*:$OCI_JAVA_SDK_LOCATION/third-party/jersey/lib/* ListDBVersionExample.java
```

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

### Run OCI SDK for Java Examples

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

This command executes a compiled Java example class for the OCI SDK for Java. It requires the examples directory, SDK full JAR, and third-party libraries to be in the classpath. Ensure you replace '<version>' with the actual SDK version.

```shell
java -cp examples:lib/oci-java-sdk-full-<version>.jar:third-party/lib/* ObjectStorageSyncExample
```

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

### Install OCI CLI on Oracle Linux 7 using yum

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

Installs the OCI CLI on Oracle Linux 7 using the yum package manager. This command installs the necessary Python packages and CLI components. The CLI will be installed to the Python site-packages directory.

```bash
sudo yum install python36-oci-cli
```

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

### Install OCI CLI on Oracle Linux 8 using DNF

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

Installs the OCI CLI on Oracle Linux 8 using the `dnf` package manager. It first installs the developer release repository and then the CLI package. The command also shows how to uninstall the CLI. This method assumes Python 3.6 is installed.

```bash
sudo dnf -y install oraclelinux-developer-release-el8
sudo dnf install python36-oci-cli
```

```bash
sudo dnf remove python36-oci-cli
```

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

### Link OCI SDK Globally

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_typescriptandjavascript

Links the globally installed oci-sdk and @types/node packages to the current project, making them available for use. This step is crucial before using the SDK in your project.

```bash
npm link oci-sdk
npm link @types/node
```

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

### Get Information about Installed OCI SDK Package

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

Retrieves detailed information about the installed OCI SDK package using the rpm query command.

```shell
rpm  -qi oci-dotnet-sdk
```

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

### Clone OCI TypeScript SDK Repository

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

This command clones the OCI SDK for TypeScript and JavaScript repository from GitHub. Ensure you have Git installed to use this command. This is the first step to access and run the provided examples.

```bash
git clone https://github.com/oracle/oci-typescript-sdk.git
```

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

### Run TypeScript Example with Node.js

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_typescriptandjavascript

Executes the compiled JavaScript file (`region_subscriptions_example.js`) using the Node.js runtime. This will run the script to fetch and display the subscribed OCI regions.

```bash
# run the example using node
node region_subscriptions_example.js
```

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

### OCI SDK for Go: List Availability Domains in Cloud Shell

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_go

This Go code snippet lists the availability domains within your tenancy using the OCI SDK for Go. It requires the `oci-go-sdk` to be installed and configured. The code authenticates using default configuration providers and fetches the list of availability domains for the specified compartment.

```go
package main
  
import (
    "context"
    "fmt"
 
    "github.com/oracle/oci-go-sdk/common"
    "github.com/oracle/oci-go-sdk/identity"
)
  
func main() {
    c, err := identity.NewIdentityClientWithConfigurationProvider(common.DefaultConfigProvider())
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
  
    // The OCID of the tenancy containing the compartment.
    tenancyID, err := common.DefaultConfigProvider().TenancyOCID()
    if err != nil {
        fmt.Println("Error:", err)
        return
        }
  
    request := identity.ListAvailabilityDomainsRequest{
        CompartmentId: &tenancyID,
    }
  
    r, err := c.ListAvailabilityDomains(context.Background(), request)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
  
    fmt.Printf("List of available domains: %v", r.Items)
    return
}
```

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

### Run OCI Waiter Core Example Script

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

This command executes the Waiter_Core.ps1 script located in the OCI PowerShell Examples folder. This script is an example of using OCI cmdlets, likely demonstrating instance creation with waiters.

```powershell
./Waiter_Core.ps1
```

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

### Run JavaScript OCI SDK Examples

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

This command demonstrates how to run a JavaScript example from the OCI SDK for TypeScript and JavaScript repository. After navigating to the JavaScript examples directory, you can execute the 'identity.js' file using Node.js.

```bash
node "./identity.js"
```

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

### Compile Java code with OCI SDK using yum installation path

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

Example of how to compile a Java file using the `javac` command, including the OCI SDK for Java and its third-party libraries in the classpath. This assumes the SDK was installed via yum on Oracle Linux.

```java
javac -cp "/usr/lib64/java-oci-sdk/third-party/lib/*:/usr/lib64/java-oci-sdk/lib/oci-java-sdk-full-1.8.2.jar" MyFile.java
```

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

### Compile TypeScript Example

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_typescriptandjavascript

Uses the TypeScript compiler (tsc) to transpile the `region_subscriptions_example.ts` file into a JavaScript file that can be executed by Node.js. This is a standard step in TypeScript development.

```bash
# use the TypeScript compiler to compile the example
tsc region_subscriptions_example.ts
```

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

### Run TypeScript OCI SDK Examples

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

These commands demonstrate how to navigate to the TypeScript examples directory and execute a specific example, 'identity.ts'. It shows execution using `ts-node` for direct execution or alternatively using `tsc` to compile and `node` to run the JavaScript output.

```bash
cd ./oci-typescript-sdk/examples/typescript/
ts-node "./identity.ts"
```

```bash
tsc ./identity.ts
node ./identity.js
```

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

### Generate OCI API Key Pair

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

Generates a new API public and private key pair for OCI authentication. The private key is typically stored in a specified file path.

```bash
oci setup keys
```

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

### PL/SQL SDK Examples

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

This section contains examples of how to use the PL/SQL SDK for Oracle Cloud Infrastructure.

```APIDOC
## PL/SQL SDK Examples

### Description
This section contains examples of how to use the PL/SQL SDK for Oracle Cloud Infrastructure.

### Method
N/A (Documentation examples)

### Endpoint
N/A (Documentation examples)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Build OCI Authentication Provider from Config File

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

Demonstrates constructing an `AuthenticationDetailsProvider` by extracting details directly from a parsed OCI configuration file. This simplifies authentication setup when using standard config file entries.

```java
AuthenticationDetailsProvider provider 
    = SimpleAuthenticationDetailsProvider.builder()
        .tenantId(config.get("tenancy"))
        .userId(config.get("user"))
        .fingerprint(config.get("fingerprint"))
        .privateKeySupplier(privateKeySupplier)
        .build();
```

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

### Install OCI Object Storage Module from Local Repository

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

This command installs the OCI Object Storage service module from the 'LocalRepo'. The '-Verbose' flag provides detailed output during installation. This also installs the OCI.PSModules.Common dependency.

```powershell
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```

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

### Get Help for OCI Object Storage Bulk Operations

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

These commands provide detailed help information for the OCI CLI's bulk operations in Object Storage. Running these commands will display usage details, available options, and examples for each specific bulk operation (upload, download, delete).

```bash
# bulk-upload
oci os object bulk-upload -h

# bulk-download
oci os object bulk-download -h

# bulk-delete
oci os object bulk-delete -h
```

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

### Install OCI SDK for Go on Oracle Linux 7

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

Installs the OCI SDK for Go on Oracle Linux 7 using the yum package manager. This command also installs GoLang 1.16.3.

```bash
sudo yum-config-manager --enable ol7_developer
sudo yum install go-oci-sdk
```

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

### PL/SQL SDK Examples for Oracle Cloud Infrastructure

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

This snippet contains examples of how to use the PL/SQL SDK for Oracle Cloud Infrastructure. These examples illustrate common operations and best practices for interacting with OCI services using PL/SQL.

```PL/SQL
-- Example 1: Basic OCI Service Interaction
-- Replace with your specific service and operation
DECLARE
  l_request  oci_request_type;
  l_response oci_response_type;
BEGIN
  -- Initialize request parameters
  l_request := oci_request_type(param1 => 'value1', param2 => 'value2');

  -- Call OCI SDK function
  l_response := oci_sdk_package.call_service(p_request => l_request);

  -- Process the response
  DBMS_OUTPUT.PUT_LINE('Response status: ' || l_response.status);
EXCEPTION
  WHEN OTHERS THEN
    DBMS_OUTPUT.PUT_LINE('An error occurred: ' || SQLERRM);
END;
/ 

-- Example 2: Handling OCI API Errors
-- This example demonstrates error handling for OCI API calls.
DECLARE
  l_request  oci_request_type;
  l_response oci_response_type;
BEGIN
  -- Initialize request parameters
  l_request := oci_request_type(param1 => 'invalid_value'); -- Intentionally invalid input

  -- Call OCI SDK function, expecting an error
  l_response := oci_sdk_package.call_service_with_error(p_request => l_request);

  -- This part might not be reached if an error is expected and handled
  DBMS_OUTPUT.PUT_LINE('Operation succeeded unexpectedly. Status: ' || l_response.status);
EXCEPTION
  WHEN oci_custom_error THEN -- Assuming a custom exception for OCI errors
    DBMS_OUTPUT.PUT_LINE('OCI API Error caught!');
    -- Access specific error details from l_response or a dedicated error object
  WHEN OTHERS THEN
    DBMS_OUTPUT.PUT_LINE('An unexpected error occurred: ' || SQLERRM);
END;
/
```

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

### Manage Java Download Token (CLI Example)

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

This snippet illustrates the command-line interaction for managing Java download tokens. It covers scenarios where an active token exists and needs to be reused, as well as the process of creating a new token with specified details.

```bash
Enter the number corresponding to the version to install (or 6 to view archived versions): 1
Use an existing download token? (Y/N): Y
Active Tokens for Java Version 24 with license type NFTC:
    Name                  Description                    License Type Expiry        Created By    OCID
1)  JDK24NFTCToken        Token for downloading JDK 24   NFTC         Sep 18, 2027  <username>    {token_ocid}

Enter the number corresponding to the token to use or enter 'N' to create a new token: 1

Enter the number corresponding to the version to install (or 6 to view archived versions): 1
No active tokens found for Java version 24. Creating a new token.

JDK 24 is licensed under Oracle No-Fee Terms and Conditions (NFTC).
Read the full agreement here: https://java.com/freeuselicense

Enter details for new Java Download token.
Enter name (max 64 characters): JDK24NFTCToken
Enter description (max 255 characters): Token for downloading JDK 24 releases
Enter expiry date (UTC) (YYYY-MM-DD, leave blank for default: 2025-09-18. Minimum: 2025-05-20, Maximum: 2027-09-18): 2027-09-18
```

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

### System-wide Pip Installation Error Example

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

This example shows a potential error message encountered when attempting to install the OCI CLI using `sudo pip install oci-cli` in a system-wide Python environment, highlighting conflicts with distutils-installed packages like 'requests'.

```shell
sudo pip install oci-cli
...
...
Cannot uninstall 'requests'. It is a distutils installed project and thus we cannot accurately determine which files belong to it which would lead to only a partial uninstall.

```

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

### Install OCI Identity Service Module

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

This command installs the service module for the OCI Identity service from the PowerShell Gallery. It requires the OCI.PSModules.Common module to be installed as a dependency.

```powershell
PS /> Install-Module -Name OCI.PSModules.Identity
```

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

### Install OCI CLI from PyPI

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

This command installs the Oracle Cloud Infrastructure Command Line Interface (OCI CLI) directly from the Python Package Index (PyPI) using pip. This is the recommended method for online installations.

```shell
pip install oci-cli
```

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

### Install OCI CLI from GitHub Wheel File

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

This command installs the Oracle Cloud Infrastructure Command Line Interface (OCI CLI) from a downloaded wheel file. Ensure the wheel file name (including version) is correct. This command uses pip, the Python package installer.

```shell
pip install oci_cli-*-py3-none-any.whl
```

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

### Install OCI SDK for Java using yum on Oracle Linux 7

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

Installs the Oracle Cloud Infrastructure SDK for Java on Oracle Linux 7 using the yum package manager. This command enables the developer repository and then installs the SDK. The SDK and its dependencies are placed in specific directories.

```bash
sudo yum-config-manager --enable ol7_developer
sudo yum install java-oci-sdk
```

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

### GET /20160918/instances

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests

Example GET request for instances with query parameters and expected Authorization header.

```APIDOC
## GET /20160918/instances

### Description
Retrieves a list of instances with specified filtering criteria.

### Method
GET

### Endpoint
https://iaas.us-phoenix-1.oraclecloud.com/20160918/instances

### Query Parameters
- **availabilityDomain** (string) - Required - The availability domain to filter instances by.
- **compartmentId** (string) - Required - The OCID of the compartment to filter instances by.
- **displayName** (string) - Optional - The display name to filter instances by.
- **volumeId** (string) - Optional - The OCID of the volume to filter instances by.

### Request Example
```
GET https://iaas.us-phoenix-1.oraclecloud.com/20160918/instances?availabilityDomain=PHX-AD-1&compartmentId=ocid1.compartment.oc1...<unique_ID>&displayName=TeamXInstances&volumeId=ocid1.volume.oc1.phx.<unique_ID> HTTP/1.1
Date: Thu, 05 Jan 2014 21:31:40 GMT
Host: iaas.us-phoenix-1.oraclecloud.com

```

### Response
#### Success Response (200)
- **instances** (array) - A list of instance objects.

#### Response Example
```json
{
  "instances": [
    {
      "id": "ocid1.instance.oc1.phx.<unique_ID>",
      "displayName": "TeamXInstance1"
      ...
    }
  ]
}
```

### Authentication
Requests must be signed using the `Authorization` header with `rsa-sha256` algorithm. The signing string includes `date`, `(request-target)`, and `host` headers.
```

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

### Install OCI SDK for Java using yum on Oracle Linux 8

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

Installs the Oracle Cloud Infrastructure SDK for Java on Oracle Linux 8 using the yum package manager. This command enables the developer repository and then installs the SDK. The SDK and its dependencies are placed in specific directories.

```bash
sudo yum-config-manager --enable ol8_developer
sudo yum install java-oci-sdk
```

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

### Offline Installation of OCI CLI

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

These commands initiate an offline installation of the OCI CLI on Unix/Linux and Windows systems after downloading and unzipping the release. The `--offline-install` flag is used for this purpose.

```shell
bash install.sh --offline-install
# or for Windows
install.ps1 -OfflineInstall
```

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

### OCI CLI Command Syntax and Example

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

Demonstrates the general syntax for OCI CLI commands, which follows the pattern 'oci <service> <type> <action> <options>'. It includes a specific example of launching a compute instance with various options.

```bash
oci <service> <type> <action> <options>
```

```bash
oci compute instance launch --availability-domain "EMIr:PHX-AD-1" -c ocid1.compartment.oc1..aaaaaaaal3gzijdlieqeyg35nz5zxil26astxxhqol2pgeyqdrggnx7jnhwa --shape "VM.Standard1.1"   --display-name "Instance 1 for sandbox" --image-id ocid1.image.oc1.phx.aaaaaaaaqutj4qjxihpl4mboabsa27mrpusygv6gurp47kat5z7vljmq3puq --subnet-id  ocid1.subnet.oc1.phx.aaaaaaaaypsr25bzjmjyn6xwgkcrgxd3dbhiha6lodzus3gafscirbhj5bpa
```

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

### Select Java Version (CLI Example)

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

This snippet demonstrates interacting with a command-line tool to select a Java version, including the option to view archived versions. It shows input prompts for version selection and handling of archived releases.

```bash
Enter the number corresponding to the version to install (or 6 to view archived versions): 6
JDK major versions:
1)  24                  
2)  23                  
3)  22                  
4)  21                  
5)  20                  
6)  17                  
7)  11                  
8)  8
Enter the number corresponding to the JDK version to view archived versions:


Choose the JDK major version you are interested in.
Enter the number corresponding to the JDK version to view archived versions: 7
Archived Java 11 Versions:
    Version         Type       Security status      Release date         EOSL date            Release notes                           
1)  11.0.26         CPU        UPDATE_REQUIRED      Jan 21, 2025         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-26-relnotes.html
2)  11.0.25         CPU        UPDATE_REQUIRED      Oct 15, 2024         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-25-relnotes.html
3)  11.0.24         CPU        UPDATE_REQUIRED      Jul 16, 2024         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-24-relnotes.html
4)  11.0.23         CPU        UPDATE_REQUIRED      Apr 16, 2024         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-23-relnotes.html
5)  11.0.22         CPU        UPDATE_REQUIRED      Jan 16, 2024         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-22-relnotes.html
6)  11.0.21         CPU        UPDATE_REQUIRED      Oct 17, 2023         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-21-relnotes.html
7)  11.0.20         CPU        UPDATE_REQUIRED      Jul 18, 2023         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-20-relnotes.html
8)  11.0.19         CPU        UPDATE_REQUIRED      Apr 18, 2023         Jan 30, 2032         https://www.oracle.com/java/technologies/javase/11-0-19-relnotes.html
Enter the number corresponding to the version to install:
```

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

### Create and Navigate Working Directory (Shell)

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_java

This snippet creates a new directory named 'java_demo' and then changes the current directory to the newly created one. This is a standard practice for organizing project files.

```shell
mkdir java_demo
cd java_demo
```

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

### Oracle Cloud Infrastructure API Signing - GET Request Example

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests

Example of constructing the signing string and Authorization header for a GET request to the Oracle Cloud Infrastructure API. This involves concatenating specific headers and encoding the request target.

```text
date: Thu, 05 Jan 2014 21:31:40 GMT
(request-target): get /20160918/instances?availabilityDomain=Pjwf%3A%20PHX-AD-1&compartmentId=ocid1.compartment.oc1..aaaaaaaam3we6vgnherjq5q2idnccdflvjsnog7mlr6rtdb25gilchfeyjxa&displayName=TeamXInstances&volumeId=ocid1.volume.oc1.phx.abyhqljrgvttnlx73nmrwfaux7kcvzfs3s66izvxf2h4lgvyndsdsnoiwr5q
host: iaas.us-phoenix-1.oraclecloud.com
```

```text
Signature version="1",headers="date (request-target) host",keyId="ocid1.tenancy.oc1..<unique_ID>/ocid1.user.oc1..<unique_ID>/<key_fingerprint>",algorithm="rsa-sha256",signature="<your_signature>"
```

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

### Get OCI Object Storage Namespace with Python SDK

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_python

This Python code snippet shows how to use the Oracle Cloud Infrastructure SDK for Python to retrieve the current Object Storage namespace. It requires the `oci` library to be installed and configured. The output is the identifier for the object storage namespace.

```python
import oci
object_storage_client = oci.object_storage.ObjectStorageClient(oci.config.from_file())
result = object_storage_client.get_namespace()
print("Current object storage namespace: {}".format(result.data))
```

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

### Compile OCI SDK for Java Examples

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

This command compiles a Java example class for the OCI SDK for Java. It requires the SDK full JAR and third-party libraries to be in the classpath. Ensure you replace '<version>' with the actual SDK version.

```shell
javac -cp lib/oci-java-sdk-full-<version>.jar:third-party/lib/* examples/ObjectStorageSyncExample.java
```

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

### Force PowerShell to use TLS 1.2 for OCI CLI Installation

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

Configures PowerShell to use TLS 1.2 for Windows 2012 and Windows 2016, ensuring secure communication during the OCI CLI installation download process. This is a prerequisite for downloading the installation script.

```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
```

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

### Download OCI HDFS Connector and Configure Spark

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

This snippet covers downloading the HDFS connector, setting up configuration directories and files, and preparing Spark for OCI Object Storage access. It involves using `wget` and `unzip` for downloads, `mkdir` for directory creation, and `cp` for configuration file copying. It also highlights the need to configure `spark-defaults.conf`.

```shell
wget https://github.com/oracle/oci-hdfs-connector/releases/download/v2.9.2.1/oci-hdfs.zip
unzip oci-hdfs.zip -d oci-hdfs

cd $HOME
mkdir .oci
# Create or copy your API key into the $HOME/.oci directory

cd $SPARK_HOME/conf
# Create a core-site.xml (e.g. by transferring one you have, using vi etc.). Consult
# https://docs.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#Properties
# for what this should look like

# Create a spark-defaults.conf file from the template
cp spark-defaults.conf.template spark-defaults.conf

```

```properties
spark.sql.hive.metastore.sharedPrefixes= shaded.oracle,com.oracle.bmc
```

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

### Create .NET Project and Add OCI SDK Package

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_dotnet

This snippet shows how to create a new .NET console application and add the OCI Object Storage SDK package using the .NET CLI. It also explains the optional `--source` parameter for specifying package locations.

```bash
mkdir DotnetDemo && cd DotnetDemo 
dotnet new console
dotnet add package OCI.DotnetSDK.Objectstorage --source /usr/lib/dotnet/NuPkgs/
```

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

### Configure PowerShell Execution Policy for OCI CLI Installation

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

Sets the PowerShell execution policy to RemoteSigned, which is required to run the OCI CLI installer script on Windows. This allows local scripts and signed remote scripts to be executed.

```powershell
Set-ExecutionPolicy RemoteSigned
```

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

### Find OCI CLI Installation Locations

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

This command is used to locate all installed OCI CLI package locations. It's particularly useful when encountering upgrade errors, as it helps identify previous installations that might need to be removed before re-installing the latest version.

```bash
oci setup find-installations
```

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

### Update pip to Latest Version

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

This snippet provides the command to update the pip package installer to its latest version. This is often a prerequisite for resolving issues related to installing wheel files or other packages.

```bash
pip install -U pip
```

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

### Java Example: Get Instance Details

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests

This Java code demonstrates how to make a GET request to retrieve details of a specific instance using the OCI API. It includes request signing and response handling.

```APIDOC
## GET /20160918/instances/{instanceId}

### Description
Retrieves details of a specific compute instance.

### Method
GET

### Endpoint
`https://iaas.us-phoenix-1.oraclecloud.com/20160918/instances/{instanceId}`

### Parameters
#### Path Parameters
- **instanceId** (string) - Required - The OCID of the instance.

### Request Example
```java
// Java code snippet provided in the input text
```

### Response
#### Success Response (200)
- **(Object)** - A JSON object containing instance details.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Displaying Help for csreset

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/devcloudshellgettingstarted

Displays the usage options and help information for the `csreset` command using the `--help` or `-h` option. This is useful for understanding available commands and their syntax.

```bash
csreset -h
```

```bash
csreset --help
```

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

### Troubleshoot OCI CLI Installation SSL Certificate Errors

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

This code snippet illustrates a common SSL certificate verification error encountered during OCI CLI installation via pip. It suggests checking network connectivity and firewall rules, or opting for offline installation or container images if external access is restricted.

```text
Could not fetch URL https://pypi.org/simple/oci-cli/: There was a problem confirming the ssl certificate:
            HTTPSConnectionPool(host='pypi.org', port=443): Max retries exceeded with url: /simple/oci-cli/ (Caused by
          SSLError(SSLError(1, '[SSL: 
          CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:877)'),)) - skipping
```

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

### Get OCI Ansible Module Documentation

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

Retrieves detailed documentation for a specific Oracle Cloud Infrastructure Ansible module directly from the command line using the `ansible-doc` utility. This example shows how to get documentation for the `oci_object_storage_bucket_facts` module.

```bash
$ ansible-doc oracle.oci.oci_object_storage_bucket_facts

```

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

### Uninstall OCI CLI on Oracle Linux 7 using yum

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

Removes the OCI CLI from Oracle Linux 7 using the yum package manager. This command uninstalls the Python packages and CLI components previously installed.

```bash
sudo yum remove python36-oci-cli
```

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

### Install OCI CLI for Python 2 (Legacy)

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

This snippet indicates the command to install older versions of the OCI CLI that support Python 2. This is relevant for users who must continue using Python 2 and cannot upgrade to Python 3.

```bash
# For Python 2 environments, use CLI versions starting with 2.x.x
# Example: pip install oci-cli==2.x.x
```

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

### OCI CLI: Get Specific Command Help

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

This command displays detailed help for a specific OCI CLI command, in this case, 'oci os bucket create'. It outlines all available options and parameters for that command.

```bash
oci os bucket create -?
```

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

### Run Toolkit for Java Download Script

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

This script, `jms-java-download.sh`, is used to install Oracle Java releases within Oracle Cloud Shell. It fetches available Java versions, displays their details including security status and release dates, and prompts the user to select a version for installation. Ensure you are signed into your OCI account and have Cloud Shell launched before execution.

```bash
jms-java-download.sh
```

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

### GET /n/{namespaceName}/b/ - List Buckets

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests

Retrieves a list of buckets within a specified Object Storage namespace and compartment. This example is demonstrated using C#.

```APIDOC
## GET /n/{namespaceName}/b/

### Description
Retrieves a list of buckets within a specified Object Storage namespace and compartment. This operation is useful for managing storage resources.

### Method
GET

### Endpoint
`https://objectstorage.us-phoenix-1.oraclecloud.com/n/{namespaceName}/b/`

### Parameters
#### Path Parameters
- **namespaceName** (string) - Required - The Object Storage namespace.

#### Query Parameters
- **compartmentId** (string) - Required - The OCID of the compartment to list buckets from.

### Request Example
(No request body for GET requests. Parameters are typically in the URL or headers.)

### Response
#### Success Response (200)
- **items** (array) - An array of bucket objects.
  - **name** (string) - The name of the bucket.
  - **namespace** (string) - The namespace the bucket belongs to.
  - **compartmentId** (string) - The OCID of the compartment containing the bucket.
  - **timeCreated** (string) - The timestamp when the bucket was created.

#### Response Example
```json
{
  "items": [
    {
      "name": "my-first-bucket",
      "namespace": "examplenamespace",
      "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
      "timeCreated": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

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

### Run with Shaded OCI SDK JAR

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

Executes Java code using the shaded version of the OCI SDK JAR. This command sets the classpath to include the example directory, the shaded SDK JAR, and its third-party libraries, enabling the application to run without external dependency conflicts.

```shell
java -cp examples:shaded/lib/oci-java-sdk-full-shaded-<version>.jar:shaded/third-party/lib/* ObjectStorageSyncExample
```

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

### OCI API POST Request Example (Bash)

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi

Example of a POST request to create a new Virtual Cloud Network (VCN) using an OCI API endpoint. This demonstrates the base path structure including the API version and the regional endpoint.

```Bash
POST https://iaas.us-ashburn-1.oraclecloud.com/20160918/vcns

```

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

### Configure Credentials using ConfigFileAuthenticationDetailsProvider

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

Demonstrates how to create an authentication provider using `ConfigFileAuthenticationDetailsProvider` for standard or custom OCI configuration files and profiles.

```csharp
using Oci.Common.Auth;

// uses DEFAULT profile in default file location: i.e ~/.oci/config
var provider = new ConfigFileAuthenticationDetailsProvider("DEFAULT");
// uses custom configuration
var provider = new ConfigFileAuthenticationDetailsProvider("custom_file_location", "CUSTOM_PROFILE");
```

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

### Windows Configuration Example for OCI SDK/CLI

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig

This snippet shows a configuration file example for Oracle Cloud Infrastructure SDKs and CLIs on Windows. It mirrors the Linux/Mac OS structure but uses Windows-style paths for the key file.

```INI
[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=%HOMEPATH%\.oci\oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys\admin_key.pem
pass_phrase=<your_passphrase>
```

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

### Verify OpenSSL Version (Linux)

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

Checks if the installed OpenSSL library on a Linux system is FIPS-compliant by examining its version string. A FIPS-compliant version will typically include 'fips' in its name.

```shell
openssl version
```

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

### Get Help for OCI Cmdlets

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

This example demonstrates how to retrieve help information for an OCI cmdlet, specifically `Get-OCIObjectStorageNamespace`. The `Get-Help` cmdlet is used, and the `-Full` parameter can be added for more detailed information.

```powershell
PS /> Get-Help Get-OCIObjectStorageNamespace
 
NAME
    Get-OCIObjectStorageNamespace
     
SYNOPSIS
    Invokes ObjectStorage service - GetNamespace operation.    
   
   
SYNTAX
    Get-OCIObjectStorageNamespace [-OpcClientRequestId <String>] [-CompartmentId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry
    <SwitchParameter>] [-Profile <String>] [-Region <String>] [-FullResponse <SwitchParameter>] [-TimeOutInMillis <Int32>] [<CommonParameters>]
     
     
DESCRIPTION
    Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace   is a system-generated string
    assigned during account creation. For some older tenancies, the namespace string may be   the tenancy name in all lower-case letters. You cannot edit a
    namespace.   GetNamespace returns the name of the Object Storage namespace for the user making the request.   If an optional compartmentId query parameter
    is provided, GetNamespace returns the namespace name of the corresponding   tenancy, provided the user has access to it.   
 
RELATED LINKS
    APIReference https://docs.cloud.oracle.com/en-us/iaas/api/ 
 
REMARKS
    To see the examples, type: "Get-Help Get-OCIObjectStorageNamespace -Examples"
    For more information, type: "Get-Help Get-OCIObjectStorageNamespace -Detailed"
    For technical information, type: "Get-Help Get-OCIObjectStorageNamespace -Full"
    For online help, type: "Get-Help Get-OCIObjectStorageNamespace -Online
```

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

### Display OCI Inventory Plugin Documentation (CLI)

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

Command to display the Ansible documentation for the OCI inventory plugin. This is useful for getting the latest information and usage examples directly from the Ansible environment.

```bash
ansible-doc -t inventory oracle.oci.oci
```

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

### List All Available Modules

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

This command lists all available modules in all configured PowerShell repositories, including those installed locally or from the PowerShell Gallery. It helps in managing and identifying installed modules.

```powershell
PS /> Get-Module -ListAvailable
```

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

### OCI SDK for TypeScript/JavaScript Cloud Shell Quick Start

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cloudshellquickstart_typescriptandjavascript

Demonstrates how to use the OCI SDK for TypeScript and JavaScript in Cloud Shell to list subscribed regions. It requires the 'oci-sdk' npm package and assumes the user is signed into the OCI Console.

```javascript
const identity = require("oci-sdk/node_modules/oci-identity");
const common = require("oci-sdk/node_modules/oci-common");

const provider = new common.ConfigFileAuthenticationDetailsProvider();
const compartmentId = provider.getTenantId() || "";

let identityClient;

async function getSubscriptionRegions(tenancyId) {
  const regions = await identityClient.listRegionSubscriptions({
    tenancyId: tenancyId
  });
  return regions.items.map(region => {
    return region.regionName;
  });
}

(async () => {
  identityClient = await new identity.IdentityClient({
    authenticationDetailsProvider: provider
  });

  const regions = await getSubscriptionRegions(compartmentId);
  console.log("Currently subscribed to the following region(s): ", regions)
})();
```

```bash
npm link oci-sdk
```

```bash
node region_subscriptions_example.js
```

```bash
# create a new project folder and move into it
mkdir ts_demo
cd ts_demo

# initialize a new javascript/typescript project
npm init --y
```

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

### Get First Page of Compute Images - PowerShell

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

Demonstrates how to retrieve the first page of compute images using the `Get-OCIComputeImagesList` cmdlet. This example implicitly uses default pagination settings and shows how to count the results.

```powershell
PS /> Get-OCIComputeImagesList -CompartmentId $Env:CompartmentId | Measure-Object
 
Count             : 100

```

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

### Enable OCI CLI Auto-complete

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

Provides commands to enable auto-completion (tab completion) for the OCI CLI. This enhances usability by suggesting commands and options as you type. It covers both manual installation and session-based activation.

```bash
# To enable auto-complete on a session by session basis, run the following command.
eval "$(_OCI_COMPLETE=source oci)"
```

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

### TypeScript Example: Get User Details

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests

This TypeScript code demonstrates how to retrieve details of a specific user using the OCI Identity API. It uses 'oci-common' for request signing and 'isomorphic-fetch' for making the HTTP call.

```APIDOC
## GET /20160918/users/{userID}

### Description
Retrieves details of a specific user.

### Method
GET

### Endpoint
`https://identity.us-phoenix-1.oraclecloud.com/20160918/users/{userID}`

### Parameters
#### Path Parameters
- **userID** (string) - Required - The OCID of the user.

### Request Example
```typescript
// TypeScript code snippet provided in the input text
```

### Response
#### Success Response (200)
- **(Object)** - A JSON object containing user details.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### OCI CLI: Get Help Command

Source: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts

This command allows users to access immediate help for any OCI CLI command. It's a fundamental step for learning and using the CLI effectively.

```bash
oci --help
```
Tokens:
Raw