Red Hat SummitHammer Cheat Sheet
Hammer CLI Cheat Sheet for Red Hat Satellite
Abstract
Providing Feedback on Red Hat Documentation
We appreciate your feedback on our documentation. Let us know how we can improve it.
Use the Create Issue form in Red Hat Jira to provide your feedback. The Jira issue is created in the Red Hat Satellite Jira project, where you can track its progress.
Prerequisites
- Ensure you have registered a Red Hat account.
Procedure
- Click the following link: Create Issue. If Jira displays a login error, log in and proceed after you are redirected to the form.
- Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form.
- Click Create.
Chapter 1. Introduction
Hammer is a command-line tool provided with Red Hat Satellite 6. You can use Hammer to configure and manage a Red Hat Satellite Server by using either CLI commands or shell script automation. The following cheat sheet provides a condensed overview of essential Hammer commands.
For more information about Hammer, see the Red Hat Hammer CLI Guide.
Chapter 2. General Information
| Subcommand | Description and tasks |
|---|---|
|
| Display hammer commands and options, append after a subcommand to get more information |
| org |
The setting is organization-specific, append hammer defaults add \ --param-name organization_id \ --param-value org_ID |
| loc |
The setting is location-specific, append hammer defaults add \ --param-name location_id \ --param-value loc_ID |
Note: This cheat sheet assumes saved credentials in ~/.hammer/cli_config.yml. For more information, see Authentication in the Red Hat Hammer CLI Guide.
Chapter 3. Organizations, Locations, and Repositories
| Subcommand | Description and tasks |
|---|---|
|
| Create an organization: hammer organization create \ --name org_name List organizations: hammer organization list |
|
| See the options for organization |
|
| Upload a subscription manifest: hammer subscription upload \ --file path |
|
| Enable a repository: hammer repository-set enable \ --product prod_name \ --basearch base_arch \ --releasever rel_v \ --name repo_name |
|
| Synchronize a repository: hammer repository synchronize \ --product prod_name \ --name repo_name Create a custom repository: Upload content to a custom repository: hammer repository upload-content \ --product prod_name \ --id repo_id \ --path path_to_dir |
Chapter 4. Content Life Cycles
| Subcommand | Description and tasks |
|---|---|
|
| Create a life cycle environment: hammer lifecycle-environment create \ --name env_name --description env_desc --prior prior_env_name List life cycle environments: hammer lifecycle-environment list |
|
| Create a content view: hammer content-view create \ --name cv_n \ --repository-ids repo_ID1,... \ --description cv_description Add repositories to a content view: hammer content-view add-repository \ --name cv_n \ --repository-id repo_ID Add Puppet modules to a content view: hammer content-view puppet-module add \ --content-view cv_n \ --name module_name Publishing a content view: hammer content-view publish \ --id cv_ID Promoting a content view: hammer content-view version promote \ --content-view cv_n \ --to-lifecycle-environment env_name Incremental update of a content view: hammer content-view version incremental-update \ --content-view-version-id cv_ID \ --packages pkg_n1,... \ --lifecycle-environment-ids env_ID1,... |
Chapter 5. Provisioning Environments
| Subcommand | Description and tasks |
|---|---|
|
| Create a domain: hammer domain create \ --name domain_name |
|
| Add a subnet: |
|
| Create a compute resource: hammer compute-resource create \ --name cr_name \ --organization-ids org_ID1,... \ --location-ids loc_ID1,... \ --provider provider_name |
|
| Add an installation medium: hammer medium create \ --name med_name \ --path path_to_medium |
|
| Add a partition table: hammer partition-table create \ --name tab_name \ --path path_to_file \ --os-family os_family |
|
| Add a provisioning template: hammer template create \ --name tmp_name \ --file path_to_template |
|
| Add an operating system: hammer os create \ --name os_name \ --version version_num |
Chapter 6. Activation Keys
| Subcommand | Description and tasks |
|---|---|
|
| Create an activation key: hammer activation-key create \ --name ak_name \ --content-view cv_n \ --lifecycle-environment lc_name Add a subscription to the activation key: hammer activation-key add-subscription \ --id ak_ID \ --subscription-id sub_ID |
Chapter 7. Users and Permissions
| Subcommand | Description and tasks |
|---|---|
|
| Create a user: hammer user create \ --login user_name \ --mail user_mail \ --auth-source-id 1 \ --organization-ids org_ID1,org_ID2,... Add a role to a user: hammer user add-role \ --id user_id \ --role role_name |
|
| Create a user group: hammer user-group create \ --name ug_name Add a role to a user group: hammer user-group add-role \ --id ug_id \ --role role_name |
|
| Create a role: hammer role create \ --name role_name |
|
| Create a filter and add it to a role: hammer filter create \ --role role_name \ --permission-ids perm_ID1,perm_ID2,... |
Chapter 8. Errata
| Subcommand | Description and tasks |
|---|---|
|
| List errata: hammer erratum list Find erratum by CVE: hammer erratum list --cve CVE Inspect erratum: hammer erratum info --id err_ID |
|
| List errata applicable to a host: hammer host errata list \ --host host_name Apply errata to a host: hammer host errata apply \ --host host_name \ --errata-ids err_ID1,err_ID2,... |
Chapter 9. Hosts
| Subcommand | Description and tasks |
|---|---|
|
| Create a host group: Add an activation key to a host group: hammer hostgroup set-parameter \ --hostgroup "hg_name" \ --name "kt_activation_keys" \ --value key_name |
|
| Create a host (inheriting parameters from a host group): Remove the host from host group: hammer host update --name host_name --hostgroup NIL |
|
| Add a job template for remote execution: hammer job-template create \ --file path \ --name template_name \ --provider-type SSH \ --job-category category_name |
|
| Invoke a remote job: hammer job-invocation create \ --job-template template_name \ --inputs key1=value,... \ --search-query query Monitor the remote job: hammer job-invocation output \ --id job_id --host host_name |
Chapter 10. Tasks
| Subcommand | Description and tasks |
|---|---|
|
| List all tasks: hammer task list Monitor progress of a running task: hammer task progress \ --id task_ID |
'%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}