2.78. hammer task
タスクに関連するアクションを実行します。
Usage:
hammer task [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show task details
list, index List tasks
progress Show the progress of the task
resume Resume all tasks paused in error state
Options:
-h, --help Print help2.78.1. hammer task info
タスクの詳細を表示します。
Usage:
hammer task <info|show> [OPTIONS]
Options:
--fields LIST Show specified fields or predefined field sets only. (See below)
--id VALUE UUID of the task
--location-id NUMBER Set the current location context for the request
--organization-id NUMBER Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------|-----|--------
FIELDS | ALL | DEFAULT
------------|-----|--------
Id | x | x
Action | x | x
State | x | x
Result | x | x
Started at | x | x
Ended at | x | x
Duration | x | x
Owner | x | x
Task errors | x | x
------------|-----|--------
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.78.2. hammer task list
タスクのリストを表示します。
Usage:
hammer task <list|index> [OPTIONS]
Options:
--fields LIST Show specified fields or predefined field sets only. (See below)
--location-id NUMBER Set the current location context for the request
--order VALUE Sort and order by a searchable field, e.g. '<field> DESC'
--organization-id NUMBER Set the current organization context for the request
--page NUMBER Page number, starting at 1
--parent-task-id VALUE UUID of the task
--per-page VALUE Number of results per page to return, 'all' to return all results
--search VALUE Filter results
-h, --help Print help
Predefined field sets:
------------|-----|--------
FIELDS | ALL | DEFAULT
------------|-----|--------
Id | x | x
Action | x | x
State | x | x
Result | x | x
Started at | x | x
Ended at | x | x
Duration | x | x
Owner | x | x
Task errors | x | x
------------|-----|--------
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.78.3. hammer task progress
タスクの進捗状況を表示します。
Usage:
hammer task progress [OPTIONS]
Options:
--id VALUE UUID of the task
--location VALUE Set the current location context for the request
--location-id NUMBER Set the current location context for the request
--location-title VALUE Set the current location context for the request
--name VALUE Name to search by
--organization VALUE Set the current organization context for the request
--organization-id NUMBER Set the current organization context for the request
--organization-title VALUE Set the current organization context for the request
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.78.4. hammer task resume
エラー状態で一時停止しているタスクをすべて再開します。
Usage:
hammer task resume [OPTIONS]
Options:
--fields LIST Show specified fields or predefined field sets only. (See below)
--location VALUE Set the current location context for the request
--location-id NUMBER Set the current location context for the request
--location-title VALUE Set the current location context for the request
--organization VALUE Set the current organization context for the request
--organization-id NUMBER Set the current organization context for the request
--organization-title VALUE Set the current organization context for the request
--search VALUE Resume tasks matching search string
--task-ids LIST Resume specific tasks by ID
--tasks LIST
-h, --help Print help
Predefined field sets:
----------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
----------------------------------------|-----|--------
Total tasks found paused in error state | x | x
Total tasks resumed | x | x
Resumed tasks/task identifier | x | x
Resumed tasks/task action | x | x
Resumed tasks/task errors | x | x
Total tasks failed to resume | x | x
Failed tasks/task identifier | x | x
Failed tasks/task action | x | x
Failed tasks/task errors | x | x
Total tasks skipped | x | x
Skipped tasks/task identifier | x | x
Skipped tasks/task action | x | x
Skipped tasks/task errors | x | x
----------------------------------------|-----|--------
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string