copy-job
Manage copy jobs (data movement)
Authentication scope: fabric
List copy jobs in a workspace
fabio copy-job list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a copy job
fabio copy-job show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Copy job ID |
Read-only · Returns object
create
Section titled “create”Create a new copy job
fabio copy-job create --workspace <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--name |
string |
Yes | Copy job display name |
--description |
string |
No | Optional description |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Mutates state · Returns object
update
Section titled “update”Update copy job properties (name and/or description)
fabio copy-job update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Copy job ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a copy job
fabio copy-job delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Copy job ID |
--hard-delete |
bool |
No | Permanently delete (cannot be recovered) |
Mutates state · Destructive · Returns void
get-definition
Section titled “get-definition”Get the definition of a copy job
fabio copy-job get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Copy job ID |
--decode |
bool |
No | Decode base64 payloads inline (adds decodedPayload field) |
Read-only · Long-running operation · Returns object
Reset a copy job (all entities or selected entities)
fabio copy-job reset --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Copy job ID |
--all-entities |
bool |
No | Reset all copy job entities (mutually exclusive with –entity-ids) |
--entity-ids |
string |
No | Comma-separated list of entity IDs to reset (mutually exclusive with –all-entities) |
Mutates state · Destructive · Returns object
update-definition
Section titled “update-definition”Update the definition of a copy job
fabio copy-job update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Copy job ID |
--file |
string |
No | Definition file path (reads file content) |
--content |
string |
No | Definition content (inline) |
Mutates state · Long-running operation · Returns void
Run a copy job on demand
fabio copy-job run --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Copy job ID |
--wait |
bool |
No | Wait for the job to complete (poll the job instance) |
--timeout |
string |
No | Max seconds to wait when –wait is set |
--cancel-on-timeout |
bool |
No | Cancel the job instance if the wait times out |
Mutates state · Long-running operation · Returns object