Red Hat SummitEste conteúdo não está disponível no idioma selecionado.
Chapter 90. template
Manipulate provisioning templates
Usage
hammer template [OPTIONS] SUBCOMMAND [ARG] ...
# hammer template [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
90.1. template add-operatingsystem
Associate an operating system
Usage
hammer template add-operatingsystem [OPTIONS]
# hammer template add-operatingsystem [OPTIONS]Options
-
--id VALUE -
--name VALUE– Name to search by -
--operatingsystem VALUE– Operating system title -
--operatingsystem-id NUMBER -
-h,--help– Print help
90.2. template build-pxe-default
Update the default PXE menu on all configured TFTP servers
Usage
hammer template build-pxe-default [OPTIONS]
# hammer template build-pxe-default [OPTIONS]Options
-
--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 -
-h,--help– Print help
90.3. template clone
Clone a provision template
Usage
hammer template clone [OPTIONS]
# hammer template clone [OPTIONS]Options
-
--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– Template name -
--new-name VALUE– Template name -
--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
90.4. template combination
Manage template combinations
Usage
hammer template combination [OPTIONS] SUBCOMMAND [ARG] ...
# hammer template combination [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
90.4.1. template combination create
Add a template combination
Usage
hammer template combination create [OPTIONS]
# hammer template combination create [OPTIONS]Options
-
--environment VALUE– Name to search by -
--environment-id NUMBER– Environment id -
--hostgroup VALUE– Hostgroup name -
--hostgroup-id VALUE– ID of host group -
--hostgroup-title VALUE– Hostgroup title -
--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 -
--provisioning-template VALUE– Name to search by -
--provisioning-template-id VALUEID of config template -
--puppet-environment VALUE– Name of associated Puppet environment -
--puppet-environment-id NUMBER– ID of associated Puppet environment -
-h,--help– Print help
90.4.2. template combination delete
Delete a template combination
Usage
hammer template combination <delete|destroy> [OPTIONS]
# hammer template combination <delete|destroy> [OPTIONS]Options
-
--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 -
--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
90.4.3. template combination info
Show template combination
Usage
hammer template combination <info|show> [OPTIONS]
# hammer template combination <info|show> [OPTIONS]Options
-
--environment VALUE– Name to search by -
--environment-id VALUE– ID of Puppet environment -
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--hostgroup VALUE– Hostgroup name -
--hostgroup-id VALUE– ID of host group -
--hostgroup-title VALUE– Hostgroup title -
--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 -
--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 -
--provisioning-template VALUE– Name to search by -
--provisioning-template-id VALUEID of config template -
--puppet-environment VALUE– Name of associated Puppet environment -
--puppet-environment-id NUMBER– ID of associated Puppet environment -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Provisioning template id | x | x | |
| Provisioning template name | x | x | |
| Hostgroup id | x | x | |
| Hostgroup name | x | x | |
| Puppet environment | x | x | |
| Puppet environment id | x | x | |
| Puppet environment name | x | x | |
| Locations/ | x | x | |
| Organizations/ | x | x | |
| Created at | x | x | |
| Updated at | x | x |
90.4.4. template combination list
List template combination
Usage
hammer template combination <list|index> [OPTIONS]
# hammer template combination <list|index> [OPTIONS]Options
-
--environment VALUE– Name to search by -
--environment-id VALUE– ID of Puppet environment -
--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 -
--provisioning-template VALUE– Name to search by -
--provisioning-template-id VALUEID of config template -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Provisioning template | x | x | |
| Hostgroup | x | x | |
| Puppet environment | x | x |
90.4.5. template combination update
Update template combination
Usage
hammer template combination update [OPTIONS]
# hammer template combination update [OPTIONS]Options
-
--environment VALUE– Name to search by -
--environment-id NUMBER– Environment id -
--hostgroup VALUE– Hostgroup name -
--hostgroup-id VALUE– ID of host group -
--hostgroup-title VALUE– Hostgroup title -
--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 -
--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 -
--provisioning-template VALUE– Name to search by -
--provisioning-template-id VALUEID of config template -
--puppet-environment VALUE– Name of associated Puppet environment -
--puppet-environment-id NUMBER– ID of associated Puppet environment -
-h,--help– Print help
90.5. template create
Create a provisioning template
Usage
hammer template create [OPTIONS]
# hammer template create [OPTIONS]Options
-
--audit-comment VALUE -
--description VALUE -
--file FILE– Path to a file that contains the template -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-ids LIST– REPLACE locations with given ids -
--location-title VALUE– Set the current location context for the request -
--location-titles LIST -
--locations LIST -
--locked BOOLEAN– Whether or not the template is locked for editing -
--name VALUE– Template name -
--operatingsystem-ids LIST– Array of operating system IDs to associate with the template -
--operatingsystems LIST -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-ids LIST– REPLACE organizations with given ids. -
--organization-title VALUE– Set the current organization context for the request -
--organization-titles LIST -
--organizations LIST -
--type VALUE– Template type. Eg. snippet, script, provision -
-h,--help– Print help
90.6. template delete
Delete a provisioning template
Usage
hammer template <delete|destroy> [OPTIONS]
# hammer template <delete|destroy> [OPTIONS]Options
-
--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
90.7. template dump
View provisioning template content
Usage
hammer template dump [OPTIONS]
# hammer template dump [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--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
Predefined field sets
| FIELDS |
90.8. template export
Export a provisioning template to ERB
Usage
hammer template export [OPTIONS]
# hammer template export [OPTIONS]Options
-
--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 -
--path VALUE– Path to directory where downloaded content will be saved -
-h,--help– Print help
90.9. template import
Import a provisioning template
Usage
hammer template import [OPTIONS]
# hammer template import [OPTIONS]Options
-
--associate ENUM– Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s):new,always,never -
--default BOOLEAN– Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) -
--file FILE– Path to a file that contains the template content including metadata -
--force BOOLEAN– Use if you want update locked templates -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-ids LIST– REPLACE locations with given ids -
--location-title VALUE– Set the current location context for the request -
--location-titles LIST -
--locations LIST -
--lock BOOLEAN– Lock imported templates (false by default) -
--name VALUE– Template name -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-ids LIST– REPLACE organizations with given ids. -
--organization-title VALUE– Set the current organization context for the request -
--organization-titles LIST -
--organizations LIST -
-h,--help– Print help
90.10. template info
Show provisioning template details
Usage
hammer template <info|show> [OPTIONS]
# hammer template <info|show> [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--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
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
| Type | x | x | |
| Description | x | x | |
| Locked | x | x | |
| Operating systems/ | x | x | |
| Locations/ | x | x | |
| Organizations/ | x | x | |
| Template combinations/hostgroup name | x | x | |
| Template combinations/environment name | x | x |
90.11. template kinds
List available provisioning template kinds
Usage
hammer template kinds [OPTIONS]
# hammer template kinds [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Name | x | x | x |
90.12. template list
List provisioning templates
Usage
hammer template <list|index> [OPTIONS]
# hammer template <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– Scope by locations -
--location-title VALUE– Set the current location context for the request -
--operatingsystem VALUE– Operating system title -
--operatingsystem-id NUMBER– ID of operating system -
--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– Scope by organizations -
--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,allto return all results -
--search VALUE– Filter results -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
| Type | x | x |
Search and order fields
-
default_template– Values: true, false -
environment– string -
hostgroup– string -
id– integer -
kind– string -
location– string -
location_id– integer -
locked– Values: true, false -
name– string -
operatingsystem– string -
organization– string -
organization_id– integer -
snippet– Values: true, false -
supported– Values: true, false -
template– text -
vendor– string
90.13. template remove-operatingsystem
Disassociate an operating system
Usage
hammer template remove-operatingsystem [OPTIONS]
# hammer template remove-operatingsystem [OPTIONS]Options
-
--id VALUE -
--name VALUE– Name to search by -
--operatingsystem VALUE– Operating system title -
--operatingsystem-id NUMBER -
-h,--help– Print help
90.14. template update
Update a provisioning template
Usage
hammer template update [OPTIONS]
# hammer template update [OPTIONS]Options
-
--audit-comment VALUE -
--description VALUE -
--file FILE– Path to a file that contains the template -
--id VALUE -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-ids LIST– REPLACE locations with given ids -
--location-title VALUE– Set the current location context for the request -
--location-titles LIST -
--locations LIST -
--locked BOOLEAN– Whether or not the template is locked for editing -
--name VALUE– Template name -
--new-name VALUE– Template name -
--operatingsystem-ids LIST– Array of operating system IDs to associate with the template -
--operatingsystems LIST -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-ids LIST– REPLACE organizations with given ids. -
--organization-title VALUE– Set the current organization context for the request -
--organization-titles LIST -
--organizations LIST -
--type VALUE– Template type. Eg. snippet, script, provision -
-h,--help– Print help
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}