diff --git a/README.md b/README.md index 7f670b7d..86128776 100644 --- a/README.md +++ b/README.md @@ -228,6 +228,7 @@ Avatar URL: 'https://app.box.com/api/avatar/large/77777' * [`box retention-policies`](docs/retention-policies.md) - List all retention policies for your enterprise * [`box search`](docs/search.md) - Search for files and folders in your Enterprise * [`box shared-links`](docs/shared-links.md) - Manage shared links +* [`box shuttle`](docs/shuttle.md) - Manage Box Shuttle migrations (systems, jobs, mappings, runs, reports) * [`box sign-requests`](docs/sign-requests.md) - List sign requests * [`box sign-templates`](docs/sign-templates.md) - List sign templates * [`box storage-policies`](docs/storage-policies.md) - List storage policies diff --git a/docs/shuttle.md b/docs/shuttle.md new file mode 100644 index 00000000..9fc99969 --- /dev/null +++ b/docs/shuttle.md @@ -0,0 +1,2288 @@ +`box shuttle` +============= + +Manage Box Shuttle migrations (systems, jobs, mappings, runs, reports) + +* [`box shuttle:discovered-subjects`](#box-shuttlediscovered-subjects) +* [`box shuttle:discovered-subjects:list`](#box-shuttlediscovered-subjectslist) +* [`box shuttle:job-schedules`](#box-shuttlejob-schedules) +* [`box shuttle:job-schedules:create`](#box-shuttlejob-schedulescreate) +* [`box shuttle:job-schedules:delete ID`](#box-shuttlejob-schedulesdelete-id) +* [`box shuttle:job-schedules:get ID`](#box-shuttlejob-schedulesget-id) +* [`box shuttle:job-schedules:list`](#box-shuttlejob-scheduleslist) +* [`box shuttle:job-schedules:update ID`](#box-shuttlejob-schedulesupdate-id) +* [`box shuttle:jobs`](#box-shuttlejobs) +* [`box shuttle:jobs:create [NAME]`](#box-shuttlejobscreate-name) +* [`box shuttle:jobs:delete ID`](#box-shuttlejobsdelete-id) +* [`box shuttle:jobs:get ID`](#box-shuttlejobsget-id) +* [`box shuttle:jobs:list`](#box-shuttlejobslist) +* [`box shuttle:jobs:prepare-migration ID`](#box-shuttlejobsprepare-migration-id) +* [`box shuttle:jobs:start ID`](#box-shuttlejobsstart-id) +* [`box shuttle:jobs:stop ID`](#box-shuttlejobsstop-id) +* [`box shuttle:jobs:update ID`](#box-shuttlejobsupdate-id) +* [`box shuttle:mapping-errors`](#box-shuttlemapping-errors) +* [`box shuttle:mapping-errors:list`](#box-shuttlemapping-errorslist) +* [`box shuttle:path-entries`](#box-shuttlepath-entries) +* [`box shuttle:path-entries:list`](#box-shuttlepath-entrieslist) +* [`box shuttle:path-mapping-imports:create`](#box-shuttlepath-mapping-importscreate) +* [`box shuttle:path-mappings`](#box-shuttlepath-mappings) +* [`box shuttle:path-mappings:create`](#box-shuttlepath-mappingscreate) +* [`box shuttle:path-mappings:delete ID`](#box-shuttlepath-mappingsdelete-id) +* [`box shuttle:path-mappings:get ID`](#box-shuttlepath-mappingsget-id) +* [`box shuttle:path-mappings:list`](#box-shuttlepath-mappingslist) +* [`box shuttle:path-mappings:update ID`](#box-shuttlepath-mappingsupdate-id) +* [`box shuttle:reports`](#box-shuttlereports) +* [`box shuttle:reports:create`](#box-shuttlereportscreate) +* [`box shuttle:reports:get ID`](#box-shuttlereportsget-id) +* [`box shuttle:reports:list`](#box-shuttlereportslist) +* [`box shuttle:runs`](#box-shuttleruns) +* [`box shuttle:runs:get ID`](#box-shuttlerunsget-id) +* [`box shuttle:runs:list`](#box-shuttlerunslist) +* [`box shuttle:subject-mapping-imports:create`](#box-shuttlesubject-mapping-importscreate) +* [`box shuttle:subject-mappings`](#box-shuttlesubject-mappings) +* [`box shuttle:subject-mappings:create`](#box-shuttlesubject-mappingscreate) +* [`box shuttle:subject-mappings:delete ID`](#box-shuttlesubject-mappingsdelete-id) +* [`box shuttle:subject-mappings:get ID`](#box-shuttlesubject-mappingsget-id) +* [`box shuttle:subject-mappings:list`](#box-shuttlesubject-mappingslist) +* [`box shuttle:subject-mappings:update ID`](#box-shuttlesubject-mappingsupdate-id) +* [`box shuttle:systems`](#box-shuttlesystems) +* [`box shuttle:systems:create NAME`](#box-shuttlesystemscreate-name) +* [`box shuttle:systems:delete ID`](#box-shuttlesystemsdelete-id) +* [`box shuttle:systems:get ID`](#box-shuttlesystemsget-id) +* [`box shuttle:systems:issue-registration-token ID`](#box-shuttlesystemsissue-registration-token-id) +* [`box shuttle:systems:list`](#box-shuttlesystemslist) +* [`box shuttle:systems:update ID`](#box-shuttlesystemsupdate-id) + +## `box shuttle:discovered-subjects` + +List discovered subjects for shuttle jobs Requires a token with the manage_enterprise_properties scope (and Shuttle access for the enterprise). + +``` +USAGE + $ box shuttle:discovered-subjects --job-id [-t ] [--as-user ] [--no-color] [--json | --csv] [-s | + --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--max-items ] + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --fields= Comma separated list of fields to show + --job-id= (required) Shuttle job ID whose discovered subjects to list + --json Output formatted JSON + --max-items= A value that indicates the maximum number of results to return. This only specifies a + maximum boundary and will not guarantee the minimum number of results returned. When + the max-items (x) is greater than 1000, then the maximum ceil(x/1000) requests will + be made. + --no-color Turn off colors for logging + --save-to-file-path= Override default file path to save report + +DESCRIPTION + List discovered subjects for shuttle jobs Requires a token with the manage_enterprise_properties scope (and Shuttle + access for the enterprise). + +ALIASES + $ box shuttle:discovered-subjects:list + +EXAMPLES + $ box shuttle:discovered-subjects --job-id 6a315c0754833bfc5df067bf +``` + +_See code: [src/commands/shuttle/discovered-subjects/index.js](https://github.com/box/boxcli/blob/v4.10.1/src/commands/shuttle/discovered-subjects/index.js)_ + +## `box shuttle:discovered-subjects:list` + +List discovered subjects for shuttle jobs Requires a token with the manage_enterprise_properties scope (and Shuttle access for the enterprise). + +``` +USAGE + $ box shuttle:discovered-subjects:list --job-id [-t ] [--as-user ] [--no-color] [--json | --csv] [-s | + --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--max-items ] + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --fields= Comma separated list of fields to show + --job-id= (required) Shuttle job ID whose discovered subjects to list + --json Output formatted JSON + --max-items= A value that indicates the maximum number of results to return. This only specifies a + maximum boundary and will not guarantee the minimum number of results returned. When + the max-items (x) is greater than 1000, then the maximum ceil(x/1000) requests will + be made. + --no-color Turn off colors for logging + --save-to-file-path= Override default file path to save report + +DESCRIPTION + List discovered subjects for shuttle jobs Requires a token with the manage_enterprise_properties scope (and Shuttle + access for the enterprise). + +ALIASES + $ box shuttle:discovered-subjects:list + +EXAMPLES + $ box shuttle:discovered-subjects --job-id 6a315c0754833bfc5df067bf +``` + +## `box shuttle:job-schedules` + +List shuttle job schedules Requires a token with the manage_enterprise_properties scope (and Shuttle access for the enterprise). + +``` +USAGE + $ box shuttle:job-schedules --job-id [-t ] [--as-user ] [--no-color] [--json | --csv] [-s | + --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--max-items ] + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --fields= Comma separated list of fields to show + --job-id= (required) Shuttle job ID whose schedules to list + --json Output formatted JSON + --max-items= A value that indicates the maximum number of results to return. This only specifies a + maximum boundary and will not guarantee the minimum number of results returned. When + the max-items (x) is greater than 1000, then the maximum ceil(x/1000) requests will + be made. + --no-color Turn off colors for logging + --save-to-file-path= Override default file path to save report + +DESCRIPTION + List shuttle job schedules Requires a token with the manage_enterprise_properties scope (and Shuttle access for the + enterprise). + +ALIASES + $ box shuttle:job-schedules:list + +EXAMPLES + $ box shuttle:job-schedules --job-id 6a315c0754833bfc5df067bf +``` + +_See code: [src/commands/shuttle/job-schedules/index.js](https://github.com/box/boxcli/blob/v4.10.1/src/commands/shuttle/job-schedules/index.js)_ + +## `box shuttle:job-schedules:create` + +Create a shuttle job schedule Requires a token with the manage_enterprise_properties scope (and Shuttle access for the enterprise). + +``` +USAGE + $ box shuttle:job-schedules:create [-t ] [--as-user ] [--no-color] [--json | --csv] [-s | --save-to-file-path + ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--body-file | --body ] + [--job-id ] [--run-mode transfer|simulation|analysis] [--state enabled|paused] [--description ] + [--trigger-type by_time|by_job] [--start-at ] [--time-zone ] [--repeat + none|daily|weekly|weekdays|weekends] [--triggered-by-job-id ] [--last-run-condition + always|on_success|on_finish] + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --body= Escape hatch: full JSON request body (snake_case or camelCase). When set, other + body-building flags are ignored. + --body-file= Escape hatch: path to a JSON file used as the full request body. + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --description= Optional schedule description + --fields= Comma separated list of fields to show + --job-id= Shuttle job ID (required unless --body / --body-file) + --json Output formatted JSON + --last-run-condition=