2.43. hammer job-template

创建作业模板

Usage:
    hammer job-template create [OPTIONS]

Options:
 --audit-comment AUDIT_COMMENT
 --current-user CURRENT_USER               Whether the current user login should be used as the effective user
                                           One of true/false, yes/no, 1/0.
 --description DESCRIPTION
 --description-format DESCRIPTION_FORMAT   This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.
 --file TEMPLATE                           Path to a file that contains the template
 --job-category JOB_CATEGORY               Job category
 --location LOCATION_NAME                  Set the current location context for the request
 --location-id LOCATION_ID                 Set the current location context for the request
 --location-ids LOCATION_IDS               REPLACE locations with given ids
                                           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-title LOCATION_TITLE           Set the current location context for the request
 --location-titles LOCATION_TITLES         Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --locked LOCKED                           Whether or not the template is locked for editing
                                           One of true/false, yes/no, 1/0.
 --name NAME                               Template name
 --organization ORGANIZATION_NAME          Set the current organization context for the request
 --organization-id ORGANIZATION_ID         Set the current organization context for the request
 --organization-ids ORGANIZATION_IDS       REPLACE organizations with given ids.
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --organization-title ORGANIZATION_TITLE   Set the current organization context for the request
 --organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --overridable OVERRIDABLE                 Whether it should be allowed to override the effective user from the invocation form.
                                           One of true/false, yes/no, 1/0.
 --provider-type PROVIDER_TYPE             Provider type
                                           Possible value(s): 'SSH', 'Ansible'
 --snippet SNIPPET                         One of true/false, yes/no, 1/0.
 --value VALUE                             What user should be used to run the script (using sudo-like mechanisms)
 -h, --help                                Print help

删除作业模板

Usage:
    hammer job-template <delete|destroy> [OPTIONS]

Options:
 --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 help

查看作业模板内容

Usage:
    hammer job-template dump [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 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 help

Predefined field sets:
  ------
  FIELDS
  ------

导出包括所有元数据的模板

Usage:
    hammer job-template export [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 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 help

Predefined field sets:
  ------
  FIELDS
  ------

从 ERB 导入作业模板

Usage:
    hammer job-template import [OPTIONS]

Options:
 --file TEMPLATE                         Path to a file that contains the template - must include ERB metadata
 --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
 --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
 --overwrite OVERWRITE                   Overwrite template if it already exists
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help

显示作业模板详情

Usage:
    hammer job-template <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 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 help

Predefined field sets:
  ---------------|-----|---------|-----
  FIELDS         | ALL | DEFAULT | THIN
  ---------------|-----|---------|-----
  Id             | x   | x       | x
  Name           | x   | x       | x
  Job category   | x   | x       |
  Provider       | x   | x       |
  Type           | x   | x       |
  Description    | x   | x       |
  Inputs         | x   | x       |
  Locations/     | x   | x       |
  Organizations/ | x   | x       |
  ---------------|-----|---------|-----

列出作业模板

Usage:
    hammer job-template <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               Scope by locations
 --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       Scope by organizations
 --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 | THIN
  -------------|-----|---------|-----
  Id           | x   | x       | x
  Name         | x   | x       | x
  Job category | x   | x       |
  Provider     | x   | x       |
  Type         | x   | x       |
  -------------|-----|---------|-----

更新作业模板

Usage:
    hammer job-template update [OPTIONS]

Options:
 --audit-comment AUDIT_COMMENT
 --current-user CURRENT_USER               Whether the current user login should be used as the effective user
                                           One of true/false, yes/no, 1/0.
 --description DESCRIPTION
 --description-format DESCRIPTION_FORMAT   This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.
 --file TEMPLATE                           Path to a file that contains the template
 --id ID
 --job-category JOB_CATEGORY               Job category
 --location LOCATION_NAME                  Set the current location context for the request
 --location-id LOCATION_ID                 Set the current location context for the request
 --location-ids LOCATION_IDS               REPLACE locations with given ids
                                           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-title LOCATION_TITLE           Set the current location context for the request
 --location-titles LOCATION_TITLES         Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --locked LOCKED                           Whether or not the template is locked for editing
                                           One of true/false, yes/no, 1/0.
 --name NAME                               Name to search by
 --new-name NEW_NAME                       Template name
 --organization ORGANIZATION_NAME          Set the current organization context for the request
 --organization-id ORGANIZATION_ID         Set the current organization context for the request
 --organization-ids ORGANIZATION_IDS       REPLACE organizations with given ids.
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --organization-title ORGANIZATION_TITLE   Set the current organization context for the request
 --organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                                           JSON is acceptable and preferred way for complex parameters
 --overridable OVERRIDABLE                 Whether it should be allowed to override the effective user from the invocation form.
                                           One of true/false, yes/no, 1/0.
 --provider-type PROVIDER_TYPE             Provider type
                                           Possible value(s): 'SSH', 'Ansible'
 --snippet SNIPPET                         One of true/false, yes/no, 1/0.
 --value VALUE                             What user should be used to run the script (using sudo-like mechanisms)
 -h, --help                                Print help