2.41. hammer job-invocation
ジョブ呼び出しを管理します。
Usage:
hammer job-invocation [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
cancel Cancel the job
create Create a job invocation
info, show Show job invocation
list, index List job invocations
output View the output for a host
rerun Rerun the job
Options:
-h, --help Print help2.41.1. hammer job-invocation cancel
ジョブをキャンセルします。
Usage:
hammer job-invocation cancel [OPTIONS]
Options:
--force BOOLEAN
--id VALUE
--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
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.41.2. hammer job-invocation create
ジョブ呼び出しを作成します。
Usage:
hammer job-invocation create [OPTIONS]
Options:
--async Do not wait for the task
--bookmark VALUE Name to search by
--bookmark-id NUMBER
--concurrency-level NUMBER Run at most N tasks at a time
--cron-line VALUE Create a recurring execution
Cron line format 'a b c d e', where:
a. is minute (range: 0-59)
b. is hour (range: 0-23)
c. is day of month (range: 1-31)
d. is month (range: 1-12)
e. is day of week (range: 0-6)
--description-format VALUE Override the description format from the template for this invocation only
--dynamic Dynamic search queries are evaluated at run time
--effective-user VALUE What user should be used to run the script (using sudo-like mechanisms).
Defaults to a template parameter or global setting.
--effective-user-password VALUE Set password for effective user (using sudo-like mechanisms)
--end-time DATETIME Perform no more executions after this time, used with --cron-line
--execution-timeout-interval NUMBER Override the timeout interval from the template for this invocation only
--feature VALUE Remote execution feature label that should be triggered, job template assigned
to this feature will be used
--input-files KEY_VALUE_LIST Read input values from files
Comma-separated list of key=file, where file is a path to a text file to be read
--inputs KEY_VALUE_LIST Specify inputs from command line
--job-template VALUE Name to search by
--job-template-id VALUE The job template to use, parameter is required unless feature was specified
--key-passphrase VALUE Set SSH key passphrase
--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
--max-iteration NUMBER Repeat a maximum of N times
--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
--password VALUE Set SSH password
--purpose VALUE Designation of a special purpose
--randomized-ordering BOOLEAN Execute the jobs on hosts in randomized order
--search-query VALUE
--start-at DATETIME Schedule the execution for a later time
--start-before DATETIME Execution should be cancelled if it cannot be started before --start-at
--tags VALUE A comma separated list of tags to use for Ansible run
--tags-flag ENUM IncludeExclude tags for Ansible run
Possible value(s): 'include', 'exclude'
--time-span NUMBER Distribute tasks over N seconds
-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.41.3. hammer job-invocation info
ジョブ呼び出しを表示します。
Usage:
hammer job-invocation <info|show> [OPTIONS]
Options:
--fields LIST Show specified fields or predefined field sets only. (See below)
--id VALUE
--location-id NUMBER Set the current location context for the request
--organization-id NUMBER Set the current organization context for the request
--show-host-status Show job status for the hosts
--show-inputs Show the complete input of the job
-h, --help Print help
Predefined field sets:
--------------------|-----|--------
FIELDS | ALL | DEFAULT
--------------------|-----|--------
Id | x | x
Description | x | x
Status | x | x
Success | x | x
Failed | x | x
Pending | x | x
Missing | x | x
Total | x | x
Start | x | x
Randomized ordering | x | x
Inputs | x | x
Job category | x | x
Mode | x | x
Cron line | x | x
Recurring logic id | x | x
Hosts | 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.41.4. hammer job-invocation list
ジョブ呼び出しのリストを表示します。
Usage:
hammer job-invocation <list|index> [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
--order VALUE Sort and order by a searchable field, e.g. '<field> DESC'
--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
--page NUMBER Page number, starting at 1
--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
Description | x | x
Status | x | x
Success | x | x
Failed | x | x
Pending | x | x
Total | x | x
Start | x | x
Randomized ordering | x | x
Inputs | 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.41.5. hammer job-invocation output
ホストの出力を表示します。
Usage:
hammer job-invocation output [OPTIONS]
Options:
--async Do not wait for job to complete, shows current output only
--host VALUE Host name
--host-id VALUE
--id VALUE
--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.41.6. hammer job-invocation rerun
ジョブを再実行します。
Usage:
hammer job-invocation rerun [OPTIONS]
Options:
--failed-only BOOLEAN
--id VALUE
--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
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