``get``
=======
.. contents:: :local:
 :depth: 1
Description
------------
Retrieves the specified Redis cluster. A Redis cluster is a memory-based storage solution. For more information, see `OCI Caching Service with Redis <https://docs.cloud.oracle.com/iaas/Content/redis/home.htm>`__. 


Usage
-----
.. code-block:: none

  oci redis redis-cluster get [OPTIONS]

Required Parameters
--------------------
.. option:: --redis-cluster-id [text]

The `OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle>`__ of the Redis cluster.


Optional Parameters
--------------------
.. option:: --from-json [text]

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

The :option:`--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



Global Parameters
------------------
Use ``oci --help`` for help on global parameters.

:option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v`



Example using required parameter
------------------

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

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up `the OCI configuration  <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile>`__ and `appropriate security policies  <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm>`__ before trying the examples.

.. code-block:: none
    :class: copy-code-block

    
	export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/redis/redis-cluster/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/redis/redis-cluster/create.html#cmdoption-display-name
	export node_count=<substitute-value-of-node_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/redis/redis-cluster/create.html#cmdoption-node-count
	export node_memory_in_gbs=<substitute-value-of-node_memory_in_gbs> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/redis/redis-cluster/create.html#cmdoption-node-memory-in-gbs
	export software_version=<substitute-value-of-software_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/redis/redis-cluster/create.html#cmdoption-software-version
	export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/redis/redis-cluster/create.html#cmdoption-subnet-id
	
	redis_cluster_id=$(oci redis redis-cluster create --compartment-id $compartment_id --display-name $display_name --node-count $node_count --node-memory-in-gbs $node_memory_in_gbs --software-version $software_version --subnet-id $subnet_id --query data.id --raw-output)
	
	oci redis redis-cluster get --redis-cluster-id $redis_cluster_id