get

Description

Gets a OpensearchCluster by identifier

Usage

oci opensearch opensearch-cluster opensearch-cluster get [OPTIONS]

Required Parameters

--opensearch-cluster-id [text]

unique OpensearchCluster identifier

Optional Parameters

--from-json [text]

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

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

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

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

Examples

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

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

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-compartment-id
    export data_node_count=<substitute-value-of-data_node_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-data-node-count
    export data_node_host_memory_gb=<substitute-value-of-data_node_host_memory_gb> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-data-node-host-memory-gb
    export data_node_host_ocpu_count=<substitute-value-of-data_node_host_ocpu_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-data-node-host-ocpu-count
    export data_node_host_type=<substitute-value-of-data_node_host_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-data-node-host-type
    export data_node_storage_gb=<substitute-value-of-data_node_storage_gb> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-data-node-storage-gb
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-display-name
    export master_node_count=<substitute-value-of-master_node_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-master-node-count
    export master_node_host_memory_gb=<substitute-value-of-master_node_host_memory_gb> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-master-node-host-memory-gb
    export master_node_host_ocpu_count=<substitute-value-of-master_node_host_ocpu_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-master-node-host-ocpu-count
    export master_node_host_type=<substitute-value-of-master_node_host_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-master-node-host-type
    export opendashboard_node_count=<substitute-value-of-opendashboard_node_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-opendashboard-node-count
    export opendashboard_node_host_memory_gb=<substitute-value-of-opendashboard_node_host_memory_gb> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-opendashboard-node-host-memory-gb
    export opendashboard_node_host_ocpu_count=<substitute-value-of-opendashboard_node_host_ocpu_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-opendashboard-node-host-ocpu-count
    export software_version=<substitute-value-of-software_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-software-version
    export subnet_compartment_id=<substitute-value-of-subnet_compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-subnet-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/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-subnet-id
    export vcn_compartment_id=<substitute-value-of-vcn_compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-vcn-compartment-id
    export vcn_id=<substitute-value-of-vcn_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/opensearch-cluster/opensearch-cluster/create.html#cmdoption-vcn-id

    opensearch_cluster_id=$(oci opensearch opensearch-cluster opensearch-cluster create --compartment-id $compartment_id --data-node-count $data_node_count --data-node-host-memory-gb $data_node_host_memory_gb --data-node-host-ocpu-count $data_node_host_ocpu_count --data-node-host-type $data_node_host_type --data-node-storage-gb $data_node_storage_gb --display-name $display_name --master-node-count $master_node_count --master-node-host-memory-gb $master_node_host_memory_gb --master-node-host-ocpu-count $master_node_host_ocpu_count --master-node-host-type $master_node_host_type --opendashboard-node-count $opendashboard_node_count --opendashboard-node-host-memory-gb $opendashboard_node_host_memory_gb --opendashboard-node-host-ocpu-count $opendashboard_node_host_ocpu_count --software-version $software_version --subnet-compartment-id $subnet_compartment_id --subnet-id $subnet_id --vcn-compartment-id $vcn_compartment_id --vcn-id $vcn_id --query data.id --raw-output)

    oci opensearch opensearch-cluster opensearch-cluster get --opensearch-cluster-id $opensearch_cluster_id