start
¶
Description¶
Start Task
Required Parameters¶
-
--task-definition-id
[text]
¶
The OCID of the Task Definition that is to be executed.
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
-
--multipart-threads
[integer]
¶
Number of threads to process multiparts per file. Default to 1.
-
--threads
[integer]
¶
Number of threads to copy files concurrently. Default to 1.
Global Parameters¶
Use oci --help
for help on global parameters.
--auth-purpose
, --auth
, --cert-bundle
, --cli-auto-prompt
, --cli-rc-file
, --config-file
, --connection-timeout
, --debug
, --defaults-file
, --endpoint
, --generate-full-command-json-input
, --generate-param-json-input
, --help
, --latest-version
, --max-retries
, --no-retry
, --opc-client-request-id
, --opc-request-id
, --output
, --profile
, --proxy
, --query
, --raw-output
, --read-timeout
, --realm-specific-endpoint
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -i
, -v
Example using required parameter¶
Copy and paste the following example into a JSON file, replacing the example parameters with your own.
oci rover device data-sync task-definition create --generate-param-json-input destination > destination.json
oci rover device data-sync task-definition create --generate-param-json-input source > source.json
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 name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/rover/device/data-sync/task-definition/create.html#cmdoption-name
task_definition_id=$(oci rover device data-sync task-definition create --destination file://destination.json --name $name --source file://source.json --query data.id --raw-output)
oci rover device data-sync task start --task-definition-id $task_definition_id