Add workload information to Rover Cluster


oci rover cluster add-workload [OPTIONS]

Required Parameters

--cluster-id [text]

Unique RoverCluster identifier

--compartment-id, -c [text]

Compartment Id of Bucket

--type [text]

Type of workload

Accepted values are:


Optional Parameters

--bucket-id [text]

Object Store Bucket OCID for the workload

--bucket-name [text]

Object Store Bucket name for the workload


Perform update without prompting for confirmation.

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

--image-id [text]

Object Store Image OCID for the workload

--prefix [text]

List of objects with names matching this prefix would be part of this export job.

--range-end [text]

Object names returned by a list query must be strictly less than this parameter.

--range-start [text]

Object names returned by a list query must be greater or equal to this parameter.


Copy the following CLI commands into a file named Run the command by typing “bash” 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 cluster_size=<substitute-value-of-cluster_size> #
    export compartment_id=<substitute-value-of-compartment_id> #
    export display_name=<substitute-value-of-display_name> #
    export type=<substitute-value-of-type> #

    cluster_id=$(oci rover cluster create --cluster-size $cluster_size --compartment-id $compartment_id --display-name $display_name --query --raw-output)

    oci rover cluster add-workload --cluster-id $cluster_id --compartment-id $compartment_id --type $type