2.42. 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.42.1. hammer job-invocation cancel
取消作业
Usage:
hammer job-invocation cancel [OPTIONS]
Options:
--force FORCE One of true/false, yes/no, 1/0.
--id ID
--location-id LOCATION_ID Set the current location context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help2.42.2. hammer job-invocation create
创建作业调用
Usage:
hammer job-invocation create [OPTIONS]
Options:
--async Do not wait for the task
--bookmark BOOKMARK_NAME Name to search by
--bookmark-id BOOKMARK_ID
--concurrency-level CONCURRENCY_LEVEL Run at most N tasks at a time
--cron-line CRONLINE 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 DESCRIPTION_FORMAT Override the description format from the template for this invocation only
--dynamic Dynamic search queries are evaluated at run time
--effective-user EFFECTIVE_USER What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.
--end-time DATETIME Perform no more executions after this time, used with --cron-line
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
--execution-timeout-interval EXECUTION_TIMEOUT_INTERVAL Override the timeout interval from the template for this invocation only
--feature FEATURE Remote execution feature label that should be triggered, job template assigned to this feature will be used
--input-files INPUT FILES Read input values from files
Comma-separated list of key=file, where file is a path to a text file to be read
--inputs INPUTS Specify inputs from command line
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--job-template JOB_TEMPLATE_NAME Name to search by
--job-template-id JOB_TEMPLATE_ID The job template to use, parameter is required unless feature was specified
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--max-iteration MAX_ITERATION Repeat a maximum of N times
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--randomized-ordering RANDOMIZED_ORDERING Execute the jobs on hosts in randomized order
One of true/false, yes/no, 1/0.
--search-query SEARCH_QUERY
--start-at DATETIME Schedule the execution for a later time
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
--start-before DATETIME Execution should be cancelled if it cannot be started before --start-at
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
--time-span TIME_SPAN Distribute tasks over N seconds
-h, --help Print help2.42.3. hammer job-invocation info
显示任务调用
Usage:
hammer job-invocation <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location-id LOCATION_ID Set the current location context for the request
--organization-id ORGANIZATION_ID 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
--------------------|-----|--------2.42.4. hammer job-invocation list
列出任务调用
Usage:
hammer job-invocation <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH 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
--------------------|-----|--------2.42.5. hammer job-invocation 输出
查看主机的输出
Usage:
hammer job-invocation output [OPTIONS]
Options:
--async Do not wait for job to complete, shows current output only
--host HOST_NAME Host name
--host-id HOST_ID
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.42.6. hammer job-invocation 重新运行
重新运行作业
Usage:
hammer job-invocation rerun [OPTIONS]
Options:
--failed-only FAILED_ONLY One of true/false, yes/no, 1/0.
--id ID
--location-id LOCATION_ID Set the current location context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help