Red Hat Satellite-6.3-Hammer CLI Guide-en-US

Red Hat Satellite 6.
Hammer CLI Guide
Using Hammer, the Satellite's CLI tool
Last Updated: 2019-03-12

Red Hat Satellite 6.3 Hammer CLI Guide
Using Hammer, the Satellite's CLI tool
Red Hat Satellite Documentation Team

satellite-doc-list@redhat.com
Legal Notice
Copyright © 2019 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons
Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is
available at
http://creativecommons.org/licenses/by-sa/3.0/
. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must
provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,
Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity
logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other
countries.
Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.
Java ® is a registered trademark of Oracle and/or its affiliates.
XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States
and/or other countries.
MySQL ® is a registered trademark of MySQL AB in the United States, the European Union and
other countries.
Node.js ® is an official trademark of Joyent. Red Hat Software Collections is not formally related to
or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marks
or trademarks/service marks of the OpenStack Foundation, in the United States and other countries
and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or
sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Abstract
This document describes how to use the Hammer CLI tool to configure and manage Red Hat
Satellite.
Table of Contents
Table of Contents
.CHAPTER
. . . . . . . . .1.. .INTRODUCTION
. . . . . . . . . . . . . . TO
. . . HAMMER
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
...........
1.1. GETTING HELP 16
1.2. AUTHENTICATION 16
1.2.1. Hammer Authentication Session 17
1.2.2. Hammer Configuration File 17
1.2.3. Command Line 18
1.3. USING STANDALONE HAMMER 18
1.4. SETTING A DEFAULT ORGANIZATION 19
1.5. CONFIGURING HAMMER 19
1.6. CONFIGURING HAMMER LOGGING 20
1.7. INVOKING THE HAMMER SHELL 21
1.8. GENERATING FORMATTED OUTPUT 21
1.9. TROUBLESHOOTING WITH HAMMER 21
. . . . . . . . . .2.. .MANAGING
CHAPTER . . . . . . . . . . ORGANIZATIONS,
. . . . . . . . . . . . . . . . LOCATIONS,
. . . . . . . . . . . . AND
. . . . REPOSITORIES
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
...........
2.1. ORGANIZATIONS 23
2.1.1. Creating an Organization 23
2.1.2. Identifying an Organization in a Hammer Command 24
2.1.3. Uploading a Manifest 24
2.2. LOCATIONS 24
2.2.1. Creating a Location 24
2.3. REPOSITORIES 25
2.3.1. Enabling a Repository 25
2.3.2. Synchronizing a Repository 26
2.3.3. Creating a Synchronization Plan 27
2.3.4. Creating a Custom Repository 28
.CHAPTER
. . . . . . . . .3.. .MANAGING
. . . . . . . . . . CONTENT
. . . . . . . . . LIFE
. . . . .CYCLE
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
...........
3.1. CREATING A LIFE CYCLE ENVIRONMENT 30
3.2. CREATING A CONTENT VIEW 30
3.2.1. Adding Repositories to a Content View 31
3.2.2. Adding Puppet Modules to a Content View 33
3.2.3. Adding Docker Images to a Content View 34
3.3. PUBLISHING A CONTENT VIEW 34
3.4. PROMOTING A CONTENT VIEW 35
3.5. PERFORMING AN INCREMENTAL UPDATE OF A CONTENT VIEW 35
. . . . . . . . . .4.. .MANAGING
CHAPTER . . . . . . . . . . ACTIVATION
. . . . . . . . . . . .KEYS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
...........
.CHAPTER
. . . . . . . . .5.. .CONFIGURING
. . . . . . . . . . . . . PROVISIONING
. . . . . . . . . . . . . .ENVIRONMENT
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
...........
5.1. DOMAINS 40
5.2. SUBNETS 40
5.3. ARCHITECTURES 40
5.4. COMPUTE RESOURCES 41
5.5. INSTALLATION MEDIA 41
5.6. PARTITION TABLES 41
5.7. PROVISIONING TEMPLATES 41
5.8. OPERATING SYSTEMS 42
5.9. PARAMETERS 43
.CHAPTER
. . . . . . . . .6.. .MANAGING
. . . . . . . . . . HOSTS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
...........
6.1. CREATING A HOST GROUP 45
6.2. CREATING A HOST 46
1
6.3. CREATING A HOST COLLECTION 49

6.4. RUNNING REMOTE JOBS ON HOSTS 50
. . . . . . . . . .7.. .MANAGING
CHAPTER . . . . . . . . . . USERS
. . . . . . .AND
. . . . PERMISSIONS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
...........
7.1. CREATING USERS 52
7.2. CREATING USER GROUPS 52
7.3. CREATING ROLES 52
7.4. ASSIGNING ROLES TO USERS 53
7.5. ADDING SSH KEYS TO A USER 53
7.6. DELETING SSH KEYS FROM A USER 54
7.7. VIEWING SSH KEYS OF A USER 54
.CHAPTER
. . . . . . . . .8.. .MANAGING
. . . . . . . . . . ERRATA
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
...........
8.1. INSPECTING AVAILABLE ERRATA 55
8.2. APPLYING ERRATA TO A HOST 55
8.3. APPLYING ERRATA TO A HOST COLLECTION 57
. . . . . . . . . .9.. .MANAGING
CHAPTER . . . . . . . . . . DOCKER
. . . . . . . . .CONTAINERS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
...........
.CHAPTER
. . . . . . . . .10.
. . .REFERENCE
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
...........
10.1. HAMMER ACTIVATION-KEY 59
10.1.1. hammer activation-key add-host-collection 59
10.1.2. hammer activation-key add-subscription 59
10.1.3. hammer activation-key content-override 60
10.1.4. hammer activation-key copy 60
10.1.5. hammer activation-key create 61
10.1.6. hammer activation-key delete 61
10.1.7. hammer activation-key host-collections 61
10.1.8. hammer activation-key info 62
10.1.9. hammer activation-key list 62
10.1.10. hammer activation-key product-content 63
10.1.11. hammer activation-key remove-host-collection 63
10.1.12. hammer activation-key remove-subscription 64
10.1.13. hammer activation-key subscriptions 64
10.1.14. hammer activation-key update 65
10.2. HAMMER ADMIN 65
10.2.1. hammer admin logging 66
10.3. HAMMER ARCHITECTURE 66
10.3.1. hammer architecture add-operatingsystem 67
10.3.2. hammer architecture create 67
10.3.3. hammer architecture delete 67
10.3.4. hammer architecture info 67
10.3.5. hammer architecture list 68
10.3.6. hammer architecture remove-operatingsystem 68
10.3.7. hammer architecture update 68
10.4. HAMMER ARF-REPORT 68
10.4.1. hammer arf-report delete 69
10.4.2. hammer arf-report download 69
10.4.3. hammer arf-report download-html 69
10.4.4. hammer arf-report info 70
10.4.5. hammer arf-report list 70
10.5. HAMMER AUTH 70
10.5.1. hammer auth login 70
10.5.2. hammer auth logout 71
2
Table of Contents
10.5.3. hammer auth status 71

10.6. HAMMER AUTH-SOURCE 71
10.6.1. hammer auth-source ldap 71
10.6.1.1. hammer auth-source ldap create 72
10.6.1.2. hammer auth-source ldap delete 73
10.6.1.3. hammer auth-source ldap info 73
10.6.1.4. hammer auth-source ldap list 73
10.6.1.5. hammer auth-source ldap update 74
10.7. HAMMER BOOTDISK 75
10.7.1. hammer bootdisk generic 75
10.7.2. hammer bootdisk host 75
10.7.3. hammer bootdisk subnet 76
10.8. HAMMER CAPSULE 76
10.8.1. hammer capsule content 76
10.8.1.1. hammer capsule content add-lifecycle-environment 77
10.8.1.2. hammer capsule content available-lifecycle-environments 77
10.8.1.3. hammer capsule content cancel-synchronization 78
10.8.1.4. hammer capsule content info 78
10.8.1.5. hammer capsule content lifecycle-environments 78
10.8.1.6. hammer capsule content remove-lifecycle-environment 78
10.8.1.7. hammer capsule content synchronization-status 79
10.8.1.8. hammer capsule content synchronize 79
10.8.2. hammer capsule create 79
10.8.3. hammer capsule delete 80
10.8.4. hammer capsule import-classes 80
10.8.5. hammer capsule info 81
10.8.6. hammer capsule list 81
10.8.7. hammer capsule refresh-features 81
10.8.8. hammer capsule update 81
10.9. HAMMER COMPUTE-RESOURCE 82
10.9.1. hammer compute-resource create 82
10.9.2. hammer compute-resource delete 83
10.9.3. hammer compute-resource image 84
10.9.3.1. hammer compute-resource image available 84
10.9.3.2. hammer compute-resource image create 84
10.9.3.3. hammer compute-resource image delete 85
10.9.3.4. hammer compute-resource image info 85
10.9.3.5. hammer compute-resource image list 85
10.9.3.6. hammer compute-resource image update 86
10.9.4. hammer compute-resource info 86
10.9.5. hammer compute-resource list 86
10.9.6. hammer compute-resource networks 87
10.9.7. hammer compute-resource update 87
10.10. HAMMER CONFIG-GROUP 88
10.10.1. hammer config-group create 89
10.10.2. hammer config-group delete 89
10.10.3. hammer config-group info 89
10.10.4. hammer config-group list 89
10.10.5. hammer config-group update 90
10.11. HAMMER CONTENT-VIEW 90
10.11.1. hammer content-view add-repository 91
10.11.2. hammer content-view add-version 91
10.11.3. hammer content-view component 91
3
10.11.3.1. hammer content-view component add 92

10.11.3.2. hammer content-view component list 92
10.11.3.3. hammer content-view component remove 93
10.11.3.4. hammer content-view component update 93
10.11.4. hammer content-view copy 94
10.11.5. hammer content-view create 94
10.11.6. hammer content-view delete 95
10.11.7. hammer content-view filter 95
10.11.7.1. hammer content-view filter add-repository 96
10.11.7.2. hammer content-view filter create 96
10.11.7.3. hammer content-view filter delete 97
10.11.7.4. hammer content-view filter info 97
10.11.7.5. hammer content-view filter list 97
10.11.7.6. hammer content-view filter remove-repository 98
10.11.7.7. hammer content-view filter rule 98
10.11.7.8. hammer content-view filter update 102
10.11.8. hammer content-view info 102
10.11.9. hammer content-view list 103
10.11.10. hammer content-view publish 103
10.11.11. hammer content-view puppet-module 104
10.11.11.1. hammer content-view puppet-module add 104
10.11.11.2. hammer content-view puppet-module list 105
10.11.11.3. hammer content-view puppet-module remove 105
10.11.12. hammer content-view purge 106
10.11.13. hammer content-view remove 106
10.11.14. hammer content-view remove-from-environment 107
10.11.15. hammer content-view remove-repository 107
10.11.16. hammer content-view remove-version 108
10.11.17. hammer content-view update 108
10.11.18. hammer content-view version 109
10.11.18.1. hammer content-view version delete 109
10.11.18.2. hammer content-view version export 109
10.11.18.3. hammer content-view version incremental-update 110
10.11.18.4. hammer content-view version info 111
10.11.18.5. hammer content-view version list 112
10.11.18.6. hammer content-view version promote 112
10.11.18.7. hammer content-view version republish-repositories 113
10.12. HAMMER CSV 113
10.12.1. hammer csv activation-keys 114
10.12.2. hammer csv content-hosts 114
10.12.3. hammer csv export 115
10.12.4. hammer csv import 116
10.12.5. hammer csv settings 116
10.12.6. hammer csv subscriptions 116
10.13. HAMMER DEFAULTS 117
10.13.1. hammer defaults add 117
10.13.2. hammer defaults delete 117
10.13.3. hammer defaults list 118
10.13.4. hammer defaults providers 118
10.14. HAMMER DISCOVERY 118
10.14.1. hammer discovery auto-provision 118
10.14.2. hammer discovery delete 119
10.14.3. hammer discovery facts 119
4
Table of Contents
10.14.4. hammer discovery info 119

10.14.5. hammer discovery list 119
10.14.6. hammer discovery provision 120
10.14.7. hammer discovery reboot 121
10.14.8. hammer discovery refresh-facts 121
10.15. HAMMER DISCOVERY-RULE 122
10.15.1. hammer discovery-rule create 122
10.15.2. hammer discovery-rule delete 123
10.15.3. hammer discovery-rule info 123
10.15.4. hammer discovery-rule list 123
10.15.5. hammer discovery-rule update 124
10.16. HAMMER DOCKER 124
10.16.1. hammer docker container 125
10.16.1.1. hammer docker container create 125
10.16.1.2. hammer docker container delete 126
10.16.1.3. hammer docker container info 127
10.16.1.4. hammer docker container list 127
10.16.1.5. hammer docker container logs 127
10.16.1.6. hammer docker container start 128
10.16.1.7. hammer docker container status 128
10.16.1.8. hammer docker container stop 128
10.16.2. hammer docker manifest 128
10.16.2.1. hammer docker manifest info 129
10.16.2.2. hammer docker manifest list 129
10.16.3. hammer docker registry 130
10.16.3.1. hammer docker registry create 130
10.16.3.2. hammer docker registry delete 131
10.16.3.3. hammer docker registry info 131
10.16.3.4. hammer docker registry list 131
10.16.3.5. hammer docker registry update 132
10.16.4. hammer docker tag 132
10.16.4.1. hammer docker tag info 132
10.16.4.2. hammer docker tag list 133
10.17. HAMMER DOMAIN 134
10.17.1. hammer domain create 134
10.17.2. hammer domain delete 135
10.17.3. hammer domain delete-parameter 135
10.17.4. hammer domain info 135
10.17.5. hammer domain list 135
10.17.6. hammer domain set-parameter 136
10.17.7. hammer domain update 136
10.18. HAMMER ENVIRONMENT 137
10.18.1. hammer environment create 137
10.18.2. hammer environment delete 138
10.18.3. hammer environment info 138
10.18.4. hammer environment list 138
10.18.5. hammer environment sc-params 139
10.18.6. hammer environment update 139
10.19. HAMMER ERRATUM 139
10.19.1. hammer erratum info 140
10.19.2. hammer erratum list 140
10.20. HAMMER FACT 141
10.20.1. hammer fact list 142
5
10.21. HAMMER FILE 142

10.21.1. hammer file info 142
10.21.2. hammer file list 143
10.22. HAMMER FILTER 144
10.22.1. hammer filter available-permissions 144
10.22.2. hammer filter available-resources 144
10.22.3. hammer filter create 145
10.22.4. hammer filter delete 145
10.22.5. hammer filter info 146
10.22.6. hammer filter list 146
10.22.7. hammer filter update 146
10.23. HAMMER FOREIGN-INPUT-SET 147
10.23.1. hammer foreign-input-set create 147
10.23.2. hammer foreign-input-set delete 148
10.23.3. hammer foreign-input-set info 148
10.23.4. hammer foreign-input-set list 148
10.23.5. hammer foreign-input-set update 148
10.24. HAMMER FULL-HELP 149
10.25. HAMMER GLOBAL-PARAMETER 149
10.25.1. hammer global-parameter delete 149
10.25.2. hammer global-parameter list 150
10.25.3. hammer global-parameter set 150
10.26. HAMMER GPG 150
10.26.1. hammer gpg create 150
10.26.2. hammer gpg delete 151
10.26.3. hammer gpg info 151
10.26.4. hammer gpg list 151
10.26.5. hammer gpg update 152
10.27. HAMMER HOST 152
10.27.1. hammer host create 153
10.27.2. hammer host delete 158
10.27.3. hammer host delete-parameter 158
10.27.4. hammer host errata 158
10.27.4.1. hammer host errata apply 159
10.27.4.2. hammer host errata info 159
10.27.4.3. hammer host errata list 159
10.27.5. hammer host facts 160
10.27.6. hammer host info 160
10.27.7. hammer host interface 160
10.27.7.1. hammer host interface create 161
10.27.7.2. hammer host interface delete 162
10.27.7.3. hammer host interface info 162
10.27.7.4. hammer host interface list 162
10.27.7.5. hammer host interface update 163
10.27.8. hammer host list 164
10.27.9. hammer host package 164
10.27.9.1. hammer host package install 165
10.27.9.2. hammer host package list 165
10.27.9.3. hammer host package remove 165
10.27.9.4. hammer host package upgrade 166
10.27.9.5. hammer host package upgrade-all 166
10.27.10. hammer host package-group 166
10.27.10.1. hammer host package-group install 167
6
Table of Contents
10.27.10.2. hammer host package-group remove 167

10.27.11. hammer host puppet-classes 167
10.27.12. hammer host puppetrun 168
10.27.13. hammer host reboot 168
10.27.14. hammer host rebuild-config 168
10.27.15. hammer host reports 168
10.27.16. hammer host sc-params 169
10.27.17. hammer host set-parameter 169
10.27.18. hammer host smart-variables 169
10.27.19. hammer host start 170
10.27.20. hammer host status 170
10.27.21. hammer host stop 170
10.27.22. hammer host subscription 170
10.27.22.1. hammer host subscription attach 171
10.27.22.2. hammer host subscription auto-attach 171
10.27.22.3. hammer host subscription content-override 171
10.27.22.4. hammer host subscription product-content 172
10.27.22.5. hammer host subscription register 172
10.27.22.6. hammer host subscription remove 173
10.27.22.7. hammer host subscription unregister 173
10.27.23. hammer host update 173
10.28. HAMMER HOST-COLLECTION 178
10.28.1. hammer host-collection add-host 179
10.28.2. hammer host-collection copy 179
10.28.3. hammer host-collection create 179
10.28.4. hammer host-collection delete 180
10.28.5. hammer host-collection erratum 180
10.28.5.1. hammer host-collection erratum install 180
10.28.6. hammer host-collection hosts 181
10.28.7. hammer host-collection info 181
10.28.8. hammer host-collection list 182
10.28.9. hammer host-collection package 182
10.28.9.1. hammer host-collection package install 183
10.28.9.2. hammer host-collection package remove 183
10.28.9.3. hammer host-collection package update 183
10.28.10. hammer host-collection package-group 184
10.28.10.1. hammer host-collection package-group install 184
10.28.10.2. hammer host-collection package-group remove 185
10.28.10.3. hammer host-collection package-group update 185
10.28.11. hammer host-collection remove-host 185
10.28.12. hammer host-collection update 186
10.29. HAMMER HOSTGROUP 186
10.29.1. hammer hostgroup create 187
10.29.2. hammer hostgroup delete 189
10.29.3. hammer hostgroup delete-parameter 189
10.29.4. hammer hostgroup info 189
10.29.5. hammer hostgroup list 190
10.29.6. hammer hostgroup puppet-classes 190
10.29.7. hammer hostgroup sc-params 190
10.29.8. hammer hostgroup set-parameter 191
10.29.9. hammer hostgroup smart-variables 191
10.29.10. hammer hostgroup update 191
10.30. HAMMER JOB-INVOCATION 194
7
10.30.1. hammer job-invocation create 194

10.30.2. hammer job-invocation info 195
10.30.3. hammer job-invocation list 196
10.30.4. hammer job-invocation output 196
10.31. HAMMER JOB-TEMPLATE 196
10.31.1. hammer job-template create 197
10.31.2. hammer job-template delete 198
10.31.3. hammer job-template dump 198
10.31.4. hammer job-template export 198
10.31.5. hammer job-template import 198
10.31.6. hammer job-template info 198
10.31.7. hammer job-template list 199
10.31.8. hammer job-template update 199
10.32. HAMMER LIFECYCLE-ENVIRONMENT 200
10.32.1. hammer lifecycle-environment create 201
10.32.2. hammer lifecycle-environment delete 201
10.32.3. hammer lifecycle-environment info 201
10.32.4. hammer lifecycle-environment list 202
10.32.5. hammer lifecycle-environment paths 202
10.32.6. hammer lifecycle-environment update 202
10.33. HAMMER LOCATION 203
10.33.1. hammer location add-compute-resource 203
10.33.2. hammer location add-config-template 204
10.33.3. hammer location add-domain 204
10.33.4. hammer location add-environment 204
10.33.5. hammer location add-hostgroup 205
10.33.6. hammer location add-medium 205
10.33.7. hammer location add-organization 205
10.33.8. hammer location add-smart-proxy 206
10.33.9. hammer location add-subnet 206
10.33.10. hammer location add-user 206
10.33.11. hammer location create 206
10.33.12. hammer location delete 208
10.33.13. hammer location delete-parameter 209
10.33.14. hammer location info 209
10.33.15. hammer location list 209
10.33.16. hammer location remove-compute-resource 209
10.33.17. hammer location remove-config-template 210
10.33.18. hammer location remove-domain 210
10.33.19. hammer location remove-environment 210
10.33.20. hammer location remove-hostgroup 211
10.33.21. hammer location remove-medium 211
10.33.22. hammer location remove-organization 211
10.33.23. hammer location remove-smart-proxy 211
10.33.24. hammer location remove-subnet 212
10.33.25. hammer location remove-user 212
10.33.26. hammer location set-parameter 212
10.33.27. hammer location update 213
10.34. HAMMER MEDIUM 215
10.34.1. hammer medium add-operatingsystem 215
10.34.2. hammer medium create 215
10.34.3. hammer medium delete 216
10.34.4. hammer medium info 217
8
Table of Contents
10.34.5. hammer medium list 217

10.34.6. hammer medium remove-operatingsystem 217
10.34.7. hammer medium update 217
10.35. HAMMER MODEL 218
10.35.1. hammer model create 219
10.35.2. hammer model delete 219
10.35.3. hammer model info 219
10.35.4. hammer model list 219
10.35.5. hammer model update 220
10.36. HAMMER ORGANIZATION 220
10.36.1. hammer organization add-compute-resource 221
10.36.2. hammer organization add-config-template 221
10.36.3. hammer organization add-domain 221
10.36.4. hammer organization add-environment 222
10.36.5. hammer organization add-hostgroup 222
10.36.6. hammer organization add-location 222
10.36.7. hammer organization add-medium 223
10.36.8. hammer organization add-smart-proxy 223
10.36.9. hammer organization add-subnet 223
10.36.10. hammer organization add-user 223
10.36.11. hammer organization create 224
10.36.12. hammer organization delete 226
10.36.13. hammer organization delete-parameter 226
10.36.14. hammer organization info 226
10.36.15. hammer organization list 226
10.36.16. hammer organization remove-compute-resource 227
10.36.17. hammer organization remove-config-template 227
10.36.18. hammer organization remove-domain 227
10.36.19. hammer organization remove-environment 228
10.36.20. hammer organization remove-hostgroup 228
10.36.21. hammer organization remove-location 228
10.36.22. hammer organization remove-medium 228
10.36.23. hammer organization remove-smart-proxy 229
10.36.24. hammer organization remove-subnet 229
10.36.25. hammer organization remove-user 229
10.36.26. hammer organization set-parameter 230
10.36.27. hammer organization update 230
10.37. HAMMER OS 232
10.37.1. hammer os add-architecture 233
10.37.2. hammer os add-config-template 233
10.37.3. hammer os add-ptable 233
10.37.4. hammer os create 234
10.37.5. hammer os delete 235
10.37.6. hammer os delete-default-template 235
10.37.7. hammer os delete-parameter 235
10.37.8. hammer os info 235
10.37.9. hammer os list 236
10.37.10. hammer os remove-architecture 236
10.37.11. hammer os remove-config-template 237
10.37.12. hammer os remove-ptable 237
10.37.13. hammer os set-default-template 237
10.37.14. hammer os set-parameter 237
10.37.15. hammer os update 238
9
10.38. HAMMER OSTREE-BRANCH 239

10.38.1. hammer ostree-branch info 239
10.38.2. hammer ostree-branch list 239
10.39. HAMMER PACKAGE 240
10.39.1. hammer package info 241
10.39.2. hammer package list 241
10.40. HAMMER PACKAGE-GROUP 242
10.40.1. hammer package-group info 242
10.40.2. hammer package-group list 243
10.41. HAMMER PARTITION-TABLE 244
10.41.1. hammer partition-table add-operatingsystem 244
10.41.2. hammer partition-table create 244
10.41.3. hammer partition-table delete 245
10.41.4. hammer partition-table dump 246
10.41.5. hammer partition-table info 246
10.41.6. hammer partition-table list 246
10.41.7. hammer partition-table remove-operatingsystem 247
10.41.8. hammer partition-table update 247
10.42. HAMMER PING 248
10.43. HAMMER POLICY 248
10.43.1. hammer policy create 248
10.43.2. hammer policy delete 249
10.43.3. hammer policy info 250
10.43.4. hammer policy list 250
10.43.5. hammer policy update 250
10.44. HAMMER PRODUCT 251
10.44.1. hammer product create 252
10.44.2. hammer product delete 252
10.44.3. hammer product info 252
10.44.4. hammer product list 253
10.44.5. hammer product remove-sync-plan 253
10.44.6. hammer product set-sync-plan 254
10.44.7. hammer product synchronize 254
10.44.8. hammer product update 255
10.45. HAMMER PROXY 255
10.45.1. hammer proxy content 255
10.45.1.1. hammer proxy content add-lifecycle-environment 256
10.45.1.2. hammer proxy content available-lifecycle-environments 256
10.45.1.3. hammer proxy content cancel-synchronization 256
10.45.1.4. hammer proxy content info 257
10.45.1.5. hammer proxy content lifecycle-environments 257
10.45.1.6. hammer proxy content remove-lifecycle-environment 257
10.45.1.7. hammer proxy content synchronization-status 258
10.45.1.8. hammer proxy content synchronize 258
10.45.2. hammer proxy create 258
10.45.3. hammer proxy delete 259
10.45.4. hammer proxy import-classes 259
10.45.5. hammer proxy info 259
10.45.6. hammer proxy list 260
10.45.7. hammer proxy refresh-features 260
10.45.8. hammer proxy update 260
10.46. HAMMER PUPPET-CLASS 261
10.46.1. hammer puppet-class info 261
10
Table of Contents
10.46.2. hammer puppet-class list 262

10.46.3. hammer puppet-class sc-params 262
10.46.4. hammer puppet-class smart-variables 262
10.47. HAMMER PUPPET-MODULE 263
10.47.1. hammer puppet-module info 263
10.47.2. hammer puppet-module list 263
10.48. HAMMER REALM 264
10.48.1. hammer realm create 265
10.48.2. hammer realm delete 265
10.48.3. hammer realm info 266
10.48.4. hammer realm list 266
10.48.5. hammer realm update 266
10.49. HAMMER RECURRING-LOGIC 267
10.49.1. hammer recurring-logic cancel 267
10.49.2. hammer recurring-logic info 267
10.49.3. hammer recurring-logic list 268
10.50. HAMMER REMOTE-EXECUTION-FEATURE 268
10.50.1. hammer remote-execution-feature info 268
10.50.2. hammer remote-execution-feature list 268
10.50.3. hammer remote-execution-feature update 269
10.51. HAMMER REPORT 269
10.51.1. hammer report delete 269
10.51.2. hammer report info 269
10.51.3. hammer report list 270
10.52. HAMMER REPOSITORY 270
10.52.1. hammer repository create 270
10.52.2. hammer repository delete 272
10.52.3. hammer repository export 272
10.52.4. hammer repository info 273
10.52.5. hammer repository list 273
10.52.6. hammer repository remove-content 274
10.52.7. hammer repository synchronize 274
10.52.8. hammer repository update 275
10.52.9. hammer repository upload-content 276
10.53. HAMMER REPOSITORY-SET 277
10.53.1. hammer repository-set available-repositories 277
10.53.2. hammer repository-set disable 277
10.53.3. hammer repository-set enable 278
10.53.4. hammer repository-set info 278
10.53.5. hammer repository-set list 279
10.54. HAMMER ROLE 279
10.54.1. hammer role clone 279
10.54.2. hammer role create 280
10.54.3. hammer role delete 280
10.54.4. hammer role filters 281
10.54.5. hammer role info 281
10.54.6. hammer role list 281
10.54.7. hammer role update 282
10.55. HAMMER SC-PARAM 282
10.55.1. hammer sc-param add-override-value 282
10.55.2. hammer sc-param info 283
10.55.3. hammer sc-param list 283
10.55.4. hammer sc-param remove-override-value 284
11
10.55.5. hammer sc-param update 284

10.56. HAMMER SCAP-CONTENT 285
10.56.1. hammer scap-content create 286
10.56.2. hammer scap-content delete 286
10.56.3. hammer scap-content download 286
10.56.4. hammer scap-content info 287
10.56.5. hammer scap-content list 287
10.56.6. hammer scap-content update 287
10.57. HAMMER SETTINGS 287
10.57.1. hammer settings list 288
10.57.2. hammer settings set 288
10.58. HAMMER SHELL 288
10.59. HAMMER SMART-VARIABLE 289
10.59.1. hammer smart-variable add-override-value 289
10.59.2. hammer smart-variable create 289
10.59.3. hammer smart-variable delete 290
10.59.4. hammer smart-variable info 290
10.59.5. hammer smart-variable list 291
10.59.6. hammer smart-variable remove-override-value 291
10.59.7. hammer smart-variable update 291
10.60. HAMMER SUBNET 292
10.60.1. hammer subnet create 293
10.60.2. hammer subnet delete 294
10.60.3. hammer subnet delete-parameter 294
10.60.4. hammer subnet info 294
10.60.5. hammer subnet list 295
10.60.6. hammer subnet set-parameter 295
10.60.7. hammer subnet update 295
10.61. HAMMER SUBSCRIPTION 296
10.61.1. hammer subscription delete-manifest 297
10.61.2. hammer subscription list 297
10.61.3. hammer subscription manifest-history 298
10.61.4. hammer subscription refresh-manifest 298
10.61.5. hammer subscription upload 298
10.62. HAMMER SYNC-PLAN 299
10.62.1. hammer sync-plan create 299
10.62.2. hammer sync-plan delete 300
10.62.3. hammer sync-plan info 300
10.62.4. hammer sync-plan list 300
10.62.5. hammer sync-plan update 301
10.63. HAMMER TAILORING-FILE 301
10.63.1. hammer tailoring-file create 302
10.63.2. hammer tailoring-file delete 302
10.63.3. hammer tailoring-file download 302
10.63.4. hammer tailoring-file info 303
10.63.5. hammer tailoring-file list 303
10.63.6. hammer tailoring-file update 303
10.64. HAMMER TASK 304
10.64.1. hammer task list 304
10.64.2. hammer task progress 304
10.64.3. hammer task resume 304
10.65. HAMMER TEMPLATE 305
10.65.1. hammer template add-operatingsystem 305
12
Table of Contents
10.65.2. hammer template build-pxe-default 306

10.65.3. hammer template clone 306
10.65.4. hammer template create 306
10.65.5. hammer template delete 307
10.65.6. hammer template dump 307
10.65.7. hammer template info 307
10.65.8. hammer template kinds 308
10.65.9. hammer template list 308
10.65.10. hammer template remove-operatingsystem 308
10.65.11. hammer template update 308
10.66. HAMMER TEMPLATE-INPUT 309
10.66.1. hammer template-input create 310
10.66.2. hammer template-input delete 310
10.66.3. hammer template-input info 310
10.66.4. hammer template-input list 311
10.67. HAMMER USER 311
10.67.1. hammer user add-role 311
10.67.2. hammer user create 312
10.67.3. hammer user delete 313
10.67.4. hammer user info 314
10.67.5. hammer user list 314
10.67.6. hammer user remove-role 314
10.67.7. hammer user ssh-keys 314
10.67.7.1. hammer user ssh-keys add 315
10.67.7.2. hammer user ssh-keys delete 315
10.67.7.3. hammer user ssh-keys info 315
10.67.7.4. hammer user ssh-keys list 316
10.67.8. hammer user update 316
10.68. HAMMER USER-GROUP 318
10.68.1. hammer user-group add-role 318
10.68.2. hammer user-group add-user 318
10.68.3. hammer user-group add-user-group 319
10.68.4. hammer user-group create 319
10.68.5. hammer user-group delete 319
10.68.6. hammer user-group external 320
10.68.6.1. hammer user-group external create 320
10.68.6.2. hammer user-group external delete 320
10.68.6.3. hammer user-group external info 321
10.68.6.4. hammer user-group external list 321
10.68.6.5. hammer user-group external refresh 321
10.68.6.6. hammer user-group external update 321
10.68.7. hammer user-group info 322
10.68.8. hammer user-group list 322
10.68.9. hammer user-group remove-role 322
10.68.10. hammer user-group remove-user 323
10.68.11. hammer user-group remove-user-group 323
10.68.12. hammer user-group update 323
10.69. HAMMER VIRT-WHO-CONFIG 324
10.69.1. hammer virt-who-config create 324
10.69.2. hammer virt-who-config delete 325
10.69.3. hammer virt-who-config deploy 325
10.69.4. hammer virt-who-config fetch 325
10.69.5. hammer virt-who-config info 326
13
10.69.6. hammer virt-who-config list 326

10.69.7. hammer virt-who-config update 326
14
Table of Contents
15
CHAPTER 1. INTRODUCTION TO HAMMER

Hammer is a powerful command-line tool provided with Red Hat Satellite 6. You can use Hammer to
configure and manage a Red Hat Satellite Server either through CLI commands or automation in shell
scripts. Hammer also provides an interactive shell.
Hammer compared to Satellite web UI

Compared to navigating the web UI, using Hammer can result in much faster interaction with the Satellite
Server, as common shell features such as environment variables and aliases are at your disposal. You
can also incorporate Hammer commands into reusable scripts for automating tasks of various
complexity. Output from Hammer commands can be redirected to other tools, which allows for
integration with your existing environment. You can issue Hammer commands directly on the base
operating system running Red Hat Satellite.
Access to Satellite Server’s base operating system is required to issue Hammer commands, which can
limit the number of potential users compared to the web UI. Although the parity between Hammer and
the web UI is almost complete, the web UI has development priority and can be ahead especially for
newly introduced features.
Hammer compared to Satellite API

For many tasks, both Hammer and Satellite API are equally applicable. Hammer can be used as a
human friendly interface to Satellite API, for example to test responses to API calls before applying them
in a script (use the -d option to inspect API calls issued by Hammer, for example hammer -d
organization list). Changes in the API are automatically reflected in Hammer, while scripts using
the API directly have to be updated manually.
In the background, each Hammer command first establishes a binding to the API, then sends a request.
This can have performance implications when executing a large number of Hammer commands in
sequence. In contrast, a script communicating directly with the API establishes the binding only once.
See the API Guide for more information.
1.1. GETTING HELP

View the full list of hammer options and subcommands by executing:
$ hammer --help
Use --help to inspect any subcommand, for example:
$ hammer organization --help
You can search the help output using grep, or redirect it to a text viewer, for example:
$ hammer | less
1.2. AUTHENTICATION
A Satellite user must prove their identity to Red Hat Satellite when entering hammer commands.
Hammer commands can be run manually or automatically. In either case, hammer requires Satellite
credentials for authentication. There are three methods of hammer authentication:
Hammer authentication session
16
Storing credentials in the hammer configuration file
Providing credentials with each hammer command
The hammer configuration file method is recommended when running commands automatically. For
example, running Satellite maintenance commands from a cron job. When running commands manually,
the hammer authentication session and providing credentials with each command are recommended.
1.2.1. Hammer Authentication Session

Hammer authentication session is a cache that stores your credentials, and you have to provide them
only once, at the beginning of the session. This method is suited to running several hammer commands
in succession, for example a script containing hammer commands. In this scenario, you enter your
Satellite credentials once, and the script runs as expected. By using the hammer authentication session,
you avoid storing your credentials in the script itself and in the
~/.hammer/cli.modules.d/foreman.yml hammer configuration file.
See the instructions on how to use the sessions:
To enable sessions, add :use_sessions: true to the

~/.hammer/cli.modules.d/foreman.yml file:
:foreman:
:use_sessions: true
Note that if you enable sessions, credentials stored in the configuration file will be ignored.
To start a session, enter the following command:
# hammer auth login
You are prompted for your Satellite credentials, and logged in. You will not be prompted for the
credentials again until your session expires.
The default length of a session is 60 minutes. You can change the time to suit your preference.
For example, to change it to 30 minutes, enter the following command:
# hammer settings set --name idle_timeout --value 30

Setting [idle_timeout] updated to [30]
To see the current status of the session, enter the following command:
# hammer auth status
To end the session, enter the following command:
# hammer auth logout
1.2.2. Hammer Configuration File

If you ran the Satellite installation with --foreman-admin-username and --foreman-admin-
password options, credentials you entered are stored in the
~/.hammer/cli.modules.d/foreman.yml configuration file, and hammer does not prompt for your
credentials.
17
You can also add your credentials to the ~/.hammer/cli.modules.d/foreman.yml configuration

file manually:
:foreman:
:username: 'username'
:password: 'password'
IMPORTANT
Use only spaces for indentation in hammer configuration files. Do not use tabs for
indentation in hammer configuration files.
1.2.3. Command Line

If you do not have your Satellite credentials saved in the ~/.hammer/cli.modules.d/foreman.yml
configuration file, hammer prompts you for them each time you enter a command. You can specify your
credentials when executing a command as follows:
$ hammer -u username -p password subcommands
NOTE
Examples in this guide assume having saved credentials in the configuration file, or using
a hammer authentication session.
1.3. USING STANDALONE HAMMER

You can install hammer on a host that has no Satellite Server Server installed, and use it to connect the
host to a remote Satellite.
Prerequisites
Ensure that you register the host to Satellite Server or Capsule Server. For more information,
see Registering a Host in the Provisioning Guide.
Ensure that you synchronize the following repositories on Satellite Server or Capsule Server. For
more information, see Synchronizing Red Hat Repositories in the Content Management Guide.
rhel-7-server-rpms
rhel-server-rhscl-7-rpms
rhel-7-server-satellite-tools-6.3-rpms
Procedure
On a host, complete the following steps to install hammer:
1. Enable the Red Hat Enterprise Linux, Red Hat Software Collections and Red Hat Satellite Tools
repositories:
18
# subscription-manager repos --enable=rhel-7-server-rpms \

--enable=rhel-server-rhscl-7-rpms \
--enable=rhel-7-server-satellite-tools-6.3-rpms
2. Install hammer:
# yum install tfm-rubygem-hammer_cli_katello
3. Edit the :host: entry in the /etc/hammer/cli.modules.d/foreman.yml file to include the

Satellite IP address or FQDN.
:host: 'https://satellite.example.com'
1.4. SETTING A DEFAULT ORGANIZATION

Many hammer commands are organization specific. You can set a default organization for hammer
commands so that you do not have to specify it every time using the --organization or --
organization-id parameter. To set a default organization, enter one of the following commands:
$ hammer defaults add --param-name organization --param-value org_name

$ hammer defaults add --param-name organization_id --param-value org_ID
You can find org_ID in the output of the hammer organization list command.
Similarly, you can set the default location by specifying its name or ID. To do so, enter one of the
following commands:
$ hammer defaults add --param-name location --param-value loc_name

$ hammer defaults add --param-name location_id --param-value loc_ID
To view the currently specified default settings, enter the following command:
$ hammer defaults list
Specifying a default organization is useful when you mostly manage a single organization, as it makes
your commands shorter. However, when switching to a different organization, you still have to use a
command-line option to specify it. Examples in this guide do not assume a saved default organization,
instead they use the shell variable approach described in Section 2.1.2, “Identifying an Organization in a
Hammer Command”.
1.5. CONFIGURING HAMMER

The default location for global hammer configuration is:
/etc/hammer/cli_config.yml for general hammer settings.
/etc/hammer/cli.modules.d/ for CLI module configuration files.
You can set user specific directives for hammer (in ~/.hammer/cli_config.yml) as well as for CLI
modules (in respective .yml files under ~/.hammer/cli.modules.d/).
To see the order in which configuration files are loaded, as well as versions of loaded modules, issue:
19
$ hammer -d --version
NOTE
Loading configuration for many CLI modules can slow down the execution of hammer
commands. In such a case, consider disabling CLI modules that are not regularly used.
Apart from saving credentials as described in Section 1.2, “Authentication”, you can set several other
options in the ~/.hammer/ configuration directory. For example, you can change the default log level and
set log rotation with the following directives in ~/.hammer/cli_config.yml. Note that these directives
affect only the current user and are not applied globally.
:log_level: 'warning'
:log_size: 5 #in MB
Similarly, you can set the number of lines displayed at once in the hammer output (equivalent of the --
per-page option):
:per-page: 30
1.6. CONFIGURING HAMMER LOGGING

You can set hammer to log debugging information for various Satellite components.
You can set debug or normal configuration options for all Satellite components.
NOTE
After changing hammer’s logging behavior, you must restart Satellite services.
# katello-service restart
To set debug level for all components, use the following command:
# hammer admin logging --all --level-debug

To set production level logging, use the following command:
# hammer admin logging --all --level-production

To list the currently recognized components, that you can set logging for:
# hammer admin logging --list
To list all available logging options:
# hammer admin logging --help
20
Usage:
hammer admin logging [OPTIONS]
1.7. INVOKING THE HAMMER SHELL

You can issue hammer commands through the interactive shell. To invoke the shell, issue the following
command:
$ hammer shell
In the shell, you can enter subcommands directly without typing "hammer", which can be useful for
testing commands before using them in a script. To exit the shell, type exit or press [Ctrl + D].
1.8. GENERATING FORMATTED OUTPUT

You can modify the default formatting of the output of hammer commands to simplify the processing of
this output by other command line tools and applications. For example, to list organizations in a CSV
format with a custom separator (in this case a semicolon), issue the following command:
$ hammer --csv --csv-separator ";" organization list
Output in CSV format is useful for example when you need to parse IDs and use them in a for loop (see
Example 2.6, “Synchronizing All Repositories in ACME Organization” or Example 2.8, “Assigning a
Synchronization Plan to Multiple Products”).
Several other formatting options are available with the --output option:
$ hammer --output output_format organization list
Replace output_format with one of:
table — generates output in the form of a human readable table (default).
base — generates output in the form of key-value pairs.
yaml — generates output in the YAML format.
csv — generates output in the Comma Separated Values format. To define a custom separator,
use the --csv and --csv-separator options instead.
json — generates output in the JavaScript Object Notation format.
silent — suppresses the output.
1.9. TROUBLESHOOTING WITH HAMMER

You can use the hammer ping command to check the status of core Satellite services. Together with
the katello-service status command, this can help you to diagnose and troubleshoot Satellite
issues. If all services are running as expected, the output looks as follows:
$ hammer ping
candlepin:
21
Status: ok
Server Response: Duration: 22ms
candlepin_auth:
Status: ok
pulp:
Status: ok
pulp_auth:
Status: ok
foreman_tasks:
Status: ok
22
CHAPTER 2. MANAGING ORGANIZATIONS, LOCATIONS, AND REPOSITORIES
CHAPTER 2. MANAGING ORGANIZATIONS, LOCATIONS, AND

REPOSITORIES
You can use hammer to create, edit, and manage organizations, locations, and repositories. For web UI
equivalents of the following procedures see Creating Organizations and Importing Red Hat Content in
the Content Management Guide.
2.1. ORGANIZATIONS
Organization in Red Hat Satellite is an isolated collection of systems, content, and other functionality
within a Satellite deployment. This section shows how to create and modify organizations using hammer.
2.1.1. Creating an Organization

Use the following command to create an organization:
$ hammer organization create \

--name "org_name" \
--label "org_label" \
--description "org_description"
Where:
org_name is the name of the organization. This parameter is required.
org_label is the organization label used in command-line applications such as subscription-

manager. Labels cannot contain white space and you cannot change them later. If not specified,
label is generated automatically from the organization name (white space is replaced with
underscores).
org_description is a short description of the organization. This parameter is not required, but it
can help you to manage a large number of organizations.
You can fully configure an organization while creating it (issue hammer organization create --
help to see the options). Also, you can modify an existing organization using the hammer
organization update command.
Example 2.1. Creating and Updating ACME Organization
The following example shows how to create an organization named ACME:
$ ORG="ACME"
$ hammer organization create \
--name $ORG \
--description "Example_organization"
This command assigns a compute resource to the organization:
$ hammer organization update \

--name $ORG \
--compute-resource-ids 1
23
2.1.2. Identifying an Organization in a Hammer Command

Many tasks you can perform in the Satellite Server are specific to an organization. Hammer commands
provide three ways to identify an organization: by using the organization, organization-label, or
organization-id option. To find the organization ID, use the following command:
$ hammer organization list
If your organization name is long, consider storing it in a shell variable. You can use this variable in
Hammer commands. For example:
$ ORG = "Red Hat Enterprise Linux Developer Team"

$ hammer product list --organization $ORG
This approach is used in examples in this guide.
If you mostly manage a single organization, you can set it as default. For information on how to do that,
see Section 1.4, “Setting a Default Organization”.
2.1.3. Uploading a Manifest

A Subscription Manifest transfers subscriptions from the Red Hat Customer Portal to Satellite Server.
First, generate the manifest on the Red Hat Customer portal as described in the Creating a Subscription
Manifest in the Content Management Guide. Then upload the manifest to the organization as follows:
$ hammer subscription upload \

--organization-label org_label \
--file path_to_manifest
Example 2.2. Uploading a Manifest to ACME Organization
The following example shows how to upload a Subscription Manifest file to the ACME organization
(assuming the organization name is stored in a shell variable):
$ hammer subscription upload --organization $ORG --file

/tmp/manifest.zip
To view the subscriptions imported with the manifest, issue:
$ hammer subscription list --organization $ORG
2.2. LOCATIONS
Location in Red Hat Satellite is collection of default settings that represent a physical place. This section
shows how to create locations using hammer.
2.2.1. Creating a Location

Use the following command to create a location:
$ hammer location create --name location_name
24
Example 2.3. Creating Multiple Locations Using a Script
The following Bash script creates three locations (london, munich, boston), and assigns them to the
ACME organization.
ORG="ACME"
LOCATIONS="london munich boston"
for LOC in ${LOCATIONS}

do
hammer location create --name "${LOC}"
hammer location add-organization --name "${LOC}" --organization
"${ORG}"
done
Run hammer location --help to view all possible location related operations.
2.3. REPOSITORIES
Repository provides storage for a collection of content. This section shows how to enable and
synchronize repositories using hammer.
2.3.1. Enabling a Repository

Before enabling a Red Hat repository, you need to know its name, the name of the product it provides,
the base architecture, and the release version. Use the following command to enable a repository:
$ hammer repository-set enable \

--product "product_name" \
--basearch "base_architecture" \
--releasever "release_version" \
--name "repository_name"
Example 2.4. Enabling a Red Hat Enterprise Linux Repository
The following command enables the Red Hat Enterprise Linux 7 Server repository for the
organization:
$ hammer repository-set enable \

--organization $ORG \
--product "Red Hat Enterprise Linux Server" \
--basearch "x86_64" \
--releasever "7Server" \
--name "Red Hat Enterprise Linux 7 Server (RPMs)"
Run hammer repository-set --help to view all possible repository related operations. Also see
hammer repository --help.
25
2.3.2. Synchronizing a Repository

By synchronizing a repository you pull its content from Red Hat Customer Portal to the Satellite Server.
To synchronize a repository you need to specify its name and a product name:
$ hammer repository synchronize \

--name "repo_name" \
--async
Note that if you have created Content Views, multiple repositories with the same name can exist within a
single organization. In such a case, use the --id option to identify the repository you want to
synchronize (issue hammer repository list to find repository IDs).
Example 2.5. Synchronizing a Red Hat Enterprise Linux Repository
The following command performs a single synchronization of the Red Hat Enterprise Linux 7 Server
repository in the organization:
$ hammer repository synchronize \

--product "Red Hat Enterprise Linux Server" \
--name "Red Hat Enterprise Linux 7 Server (RPMs)" \
--async
The task ID is displayed after executing the above command:
Repository is being synchronized in task 640bb71f-0ce5-40a3-a675-

425a4acacceb
To view the progress of the task, issue:
$ hammer task progress --id 640bb71f-0ce5-40a3-a675-425a4acacceb
After finishing the first synchronization, the repository is added to the list of repositories mirrored on
Satellite Server. Execute the following command to see the list:
$ hammer repository list --organization $ORG
You can also synchronize all repositories within a product as follows:
$ hammer product synchronize \

--name "product_name" \
--async
With the --async option, the repository synchronization runs in the background, which for example
allows you to enable and synchronize several repositories in parallel.
Example 2.6. Synchronizing All Repositories in ACME Organization
26
The following Bash script synchronizes all repositories within the ACME organization.
ORG="ACME"
for i in $(hammer --csv repository list --organization $ORG | grep -vi

'ÎD' | awk -F, {'print $1'})
do
hammer repository synchronize --id ${i} --organization $ORG --async
done
2.3.3. Creating a Synchronization Plan

Product in Red Hat Satellite is a collection of repositories that acts as the smallest unit of the
synchronization process. You can create a synchronization plan to automatically update repositories of a
selected product in a given time interval.
To define a synchronization plan, issue the following command:
$ hammer sync-plan create \

--name "sync_plan_name" \
--enabled=true \
--interval repetition_interval \
--sync-date "initial_sync"
Replace repetition_interval with hourly, daily, or weekly. Replace initial_sync with the date and time
of the initial synchronization in the form of "YYYY-MM-DD HH:MM:SS".
Example 2.7. Creating a Synchronization Plan
The following command creates a daily synchronization schedule for the ACME organization, that
runs at 3 a.m., starting from 15 January 2016:
$ hammer sync-plan create \

--name "daily sync at 3 a.m." \
--enabled=true \
--interval daily \
--sync-date "2016-01-15 03:00:00"
To associate the synchronization plan with a product, issue the following command:
$ hammer product set-sync-plan \

--name "product_name" \
--sync-plan "sync_plan_name"
Example 2.8. Assigning a Synchronization Plan to Multiple Products
27
The following Bash script selects the products in the ACME organization that have been synchronized
at least once and contain at least one repository and assigns them a synchronization plan named
"daily sync at 3 a.m.".
ORG="ACME"
SYNC_PLAN="daily sync at 3 a.m."
for i in $(hammer --csv product list --organization $ORG --per-page 999

| grep -vi 'ÎD' | grep -vi not_synced | awk -F, {'{ if ($5!=0) print
$1}'})
do
hammer product set-sync-plan --sync-plan $SYNC_PLAN --organization
$ORG --id $i
done
After executing the script, issue the following command to see which products have been assigned
the synchronization plan:
$ hammer product list --organization $ORG --sync-plan "daily sync at 3

a.m."
To view synchronization plans available for a selected organization, issue the following command:
$ hammer sync-plan list --organization-label org_label
For more details on working with products and synchronization plans see the output of hammer sync-
plan --help and hammer product --help.
2.3.4. Creating a Custom Repository

After enabling a Red Hat repository, the corresponding product is created automatically. To enable a
repository with custom packages, you first need to manually create a product for this repository.
Use the following command to create a custom product:
$ hammer product create --name "product_name" --organization-label

org_label
The following command creates a new repository under the custom product:
$ hammer repository create \

--name "repo_name" \
--content-type cont_type --publish-via-http true \
--url "repo_url"
Replace the example values with your own details, in particular:
cont_type specifies the type of content in the repository, choose one of yum, puppet, or
docker.
28
repo_url specifies the URL on which the repository will be available, valid only if ` --publish-via-
http` is enabled.
To upload packages to a custom repository, issue the following command:
$ hammer repository upload-content \

--id "repo_id" \
--path path_to_dir
Replace path_to_dir with the path to the directory with content (RPM packages, Puppet modules, or
Docker images) to be added to the custom repository.
29
CHAPTER 3. MANAGING CONTENT LIFE CYCLE

This section shows how to use hammer to create Content Views and to promote them through life cycle
environments.
3.1. CREATING A LIFE CYCLE ENVIRONMENT

Life cycle environments represent stages of the content life cycle. This section shows how to view and
create life cycle environments with hammer. By default, the Library environment is present for each
organization. Use the following syntax to create a new life cycle environment:
$ hammer lifecycle-environment create \

--name env_name \
--description "env_description" \
--prior prior_env_name
Example 3.1. Creating a Life Cycle Environment
This example shows how to create a new environment based on Library for the ACME organization
(assuming the organization name is stored in a shell variable):
$ hammer lifecycle-environment create \

--name Development \
--description "Initial testing" \
--prior Library
You can create another life cycle environment based on Development using the --prior option.
To view existing life cycle environments, issue the following command:
$ hammer lifecycle-environment list --organization-label org_label
The output of the above command can look as follows:
---|-------------|------------
ID | NAME | PRIOR
---|-------------|------------
2 | Library |
5 | Development | Library
6 | Testing | Development
---|-------------|------------
For more information on commands related to life cycle environments, see the output of hammer
lifecycle-environment --help.
3.2. CREATING A CONTENT VIEW
30
Content Views are subsets of content from the Library created by intelligent filtering. You can publish and
promote Content Views into life cycle environments that make content available for different uses
(typically Dev, QA, and Production). To create a Content View, issue the following command:
$ hammer content-view create \

--name cv_name \
--repository-ids repo_ID1,repo_ID2,repo_ID3 \
--description "cv_description" \
--organization-label org_label
The --repository-ids option adds the selected repositories to the Content View, use the hammer
repository list command to find the IDs. It is also possible to omit this option to create an empty
Content View that you can modify later using the update or add-repository subcommands.
Example 3.2. Creating a Content View
The following example creates a Content View under the ACME organization and assigns it three
repositories:

--name cv-rhel7-server \
--repository-ids 1,2,3 \
--description "Initial CV for RHEL 7" \
--organization $ORG
Example 3.3. Creating a Composite Content View
A Composite Content View is comprised of one or more Content Views. This example shows how to
create a Composite Content View from two existing Content Views:

--name ccv-rhel7-server-scl \
--description "CCV for RHEL7 and Software Collections" \
--composite --component-ids 2,6
Find the IDs for the --component-ids option by executing hammer content-view list.
There are three content types you can add to the Content View: RPM packages, Puppet modules, and
Docker images.
3.2.1. Adding Repositories to a Content View

Use the following command to add repositories to an existing Content View:
$ hammer content-view update \

--repository-ids repo_ID1,repo_ID2... \
--name cv_name \
--organization-label org_label
31
The above command is useful for populating an empty Content View with repositories. Note that it will
overwrite any existing repositories, therefore to increase the number of repositories in a Content View,
use:
$ hammer content-view add-repository \

--name cv_name \
--repository-id repo_ID
Similarly, you can use the remove-repository subcommand to remove a repository from the Content
View. Use hammer content-view info to inspect repositories in a Content View.
Example 3.4. Filtering Packages for a Content View – Excluding a Package
Filters allow you to select a subset of packages from a repository (either by including or excluding) to
create customized Content Views. This example shows how to create a filter to exclude the emacs
package from the cv-rhel7-server Content View.
First create a filter for the Content View in the organization:
$ hammer content-view filter create \

--type rpm \
--name exclude-emacs \
--description "Excluding emacs package" \
--inclusion false \
--content-view cv-rhel7-server
Find the repository IDs by executing hammer repository list. Create a rule to exclude
packages with name starting with "emacs" and add it to the filter as follows:
$ hammer content-view filter rule create \

--name "emacs*" \
--content-view cv-rhel7-server \
--content-view-filter exclude-emacs
As a result, hosts using the cv-rhel7-server Content View will not have access to the emacs package.
You can add multiple rules to a filter, see the output hammer content-view rule create --
help for the full list of filtering parameters. To inspect rules present in a filter, issue the following
command:
$ hammer content-view filter rule list \

--content-view-filter exclude-emacs \
--organization $ORG
Example 3.5. Filtering Packages for a Content View – Limiting Errata by Date
32
This example shows how to create a filter to exclude errata released before a specific date from the
cv-rhel7-server Content View. For more information on errata management see Chapter 8,
Managing Errata. Create a filter for the Content View as follows:
$ hammer content-view filter create \

--type erratum \
--name limit-errata-by-date \
--description "Excluding errata by date" \
--inclusion false \
--content-view cv-rhel7-server
Create a rule to exclude errata with a name starting with "emacs" and add it to the filter as follows:
$ hammer content-view filter rule create \

--end-date YYYY-MM-DD \
--content-view-filter limit-errata-by-date \
--types enhancement,bugfix,security
3.2.2. Adding Puppet Modules to a Content View

To add a Puppet module to a Content View, first upload this module to a Puppet repository within a
custom product. Use the commands from Section 2.3.4, “Creating a Custom Repository” to create a
product with a repository, and to upload a Puppet module to the repository.
To add a Puppet module to a Content View, issue the following command:
$ hammer content-view puppet-module add \

--content-view cv_name \
--name module_name
Example 3.6. Adding a Puppet Module to a Content View
This example shows how to add a Puppet module from an external source to the cv-rhel7-server
Content View.
1. Download the concat module (that constructs files from multiple text fragments) from Puppet
Forge:
$ wget -O /tmp/puppetlabs-concat-1.2.5.tar.gz
https://forgeapi.puppetlabs.com
/v3/files/puppetlabs-concat-1.2.3.tar.gz
2. Create a Puppet repository under the ACME-puppet product and upload the module to this
repository (the example assumes repository ID is 6):
$ hammer product create \

--name "ACME-puppet" \
--organization $ORG
33
$ hammer repository create \

--product ACME-puppet \
--name "ACME Puppet Repository" \
--content-type puppet \
--url "https://forge.puppetlabs.com/"
$ hammer repository upload-content \

--product ACME-puppet \
--id 6 \
--path /tmp/puppetlabs-concat-1.2.5.tar.gz
3. Add the module to the Content View using the id, name, or author parameters. To find the
exact values, enter:
$ hammer puppet-module list --organization $ORG

---|--------|------------|--------
ID | NAME | AUTHOR | VERSION
---|--------|------------|--------
1 | concat | puppetlabs | 1.2.3
---|--------|------------|--------
To add the module to the Content View, issue:
$ hammer content-view puppet-module add \

--name concat \
--organization $ORG
To verify if the module has been added successfully, issue the following command:
$ hammer content-view puppet-module list \

--organization $ORG
3.2.3. Adding Docker Images to a Content View

You can upload Docker images directly to the dedicated repository as follows:
$ hammer repository upload-content --path image_archive --id repo_id
Replace image_archive with a path to the archive containing the Docker image. Use repo_id to identify
the repository of docker content type. Then you can add this repository to the Content View.
3.3. PUBLISHING A CONTENT VIEW

By publishing a Content View you make it visible and usable by hosts. Use the following command to
publish a selected Content View:
$ hammer content-view publish \
34
--id cv_ID \
--async
Find the cv_ID of the Content View to be published in the output of the hammer content-view list
command. Published Content Views become available in the Library environment. To verify the Content
View status, issue the following command:
$ hammer content-view info --id cv_ID
3.4. PROMOTING A CONTENT VIEW

Promoting is the act of moving a Content View from one life cycle environment to another. To do so,
issue the following command.
$ hammer content-view version promote \

--to-lifecycle-environment env_name
Here, env_name stands for the name of target life cycle environment.
Example 3.7. Promoting a Content View Through the Life Cycle Environment Path
The following Bash script promotes the selected Content View from Library through all life cycle
environments in the ACME organization:
ORG="ACME"
CV_ID=1
for i in $(hammer --csv lifecycle-environment list --organization $ORG |

grep -vi 'ÎD' | awk -F, {'print $1'} | sort -n)
do
hammer content-view version promote --organization $ORG --to-
lifecycle-environment-id $i --id $CV_ID
done
To verify if the Content View has been promoted correctly, issue the following command:
$ hammer content-view version info --id 1
3.5. PERFORMING AN INCREMENTAL UPDATE OF A CONTENT VIEW

Incremental updates enable modifying a published Content View without the need to promote a new
Content View version through the life cycle environment. As a result of the incremental update, a new
minor Content View version is created. Incremental updates are useful for fast emergency updates, you
can use them to add errata, packages, or Puppet modules.
To create an incremental update adding new packages to a Content View, issue:
$ hammer content-view version incremental-update \
35
--content-view-version-id cv_ID \
--packages pkg_name1,pkg_name2 \
--lifecycle-environment-ids env_ID1, env_ID2,... \
--organization-id org_ID
Find the Content View version ID in the output of hammer Content View version list. Instead of
supplying packages with the --packages option, you can add Puppet modules with --puppet-
modules, or errata with --errata-ids (see Example 3.8, “Adding Errata to a Content View using an
Incremental Update”). For more information on working with incremental updates issue hammer
content-view version incremental-update --help.
Example 3.8. Adding Errata to a Content View using an Incremental Update
This example shows how to apply an erratum to a host (named auth01.example.com) by creating an
incremental update of its Content View:
$ hammer content-view version incremental-update \

--content-view-version-id 4 \
--errata-ids 8c3801f6-12a7-4a62-83f4-addbb1f34ce6 \
--lifecycle-environments Infrastructure \
--organization $ORG
To find the required information for the above command, perform the following steps:
1. Find the Organization ID and name by executing:
$ hammer organization list
2. Find the Content View your host is registered to as well as its life cycle environment by
executing:
$ hammer host info --name auth01.example.com
3. Then find the current version of the Content View (assuming Content View name
RHEL7_Infra):
$ hammer content-view info --name "RHEL7_Infra" --organization

$ORG
4. Find the IDs of errata you want to apply in the list of applicable errata in Library:
$ hammer erratum list --content-view-version-id 4 --organization

$ORG
$ hammer host errata list --host auth01.example.com
36
CHAPTER 4. MANAGING ACTIVATION KEYS

Activation keys define the subscription properties of a host. Using an activation key improves the speed
of host registration. For web UI equivalents of the following procedures see Managing Activation Keys in
the Content Management Guide.
There are three possible use cases for activation keys:
Activation key with no subscriptions specified – hosts using the activation key search for the
best fitting subscription. This is akin to running subscription-manager --auto-attach.
See Example 4.1, “Creating an Empty Activation Key”.
Activation key providing a custom subscription pool for auto attach – hosts using the
activation key select the best fitting subscription from the list specified in the activation key. See
Example 4.2, “Creating an Activation Key with Custom Subscription Pool”.
Activation key with the exact set of subscriptions – hosts using the activation key are
associated with all subscriptions specified in the activation key. See Example 4.3, “Creating an
Activation Key with Mandatory Subscription List”.
NOTE
Activation keys are only used when hosts are registered. If changes are made to an
activation key, it is only applicable to hosts that are registered with the amended activation
key in the future. The changes are not made to existing hosts.
To create an activation key, issue the following command:
$ hammer activation-key create --name ak_name \

--lifecycle-environment lc_name
Note that the Content View has to be published. To see the full list of operations related to activation
keys, use the hammer activation-key --help command.
To add a subscription to the activation key, issue the following command:
$ hammer activation-key add-subscription \

--id ak_ID \
--subscription-id sub_ID
To find the activation key ID, use hammer activation-key list; to find the subscription ID, use
hammer subscription list.
Example 4.1. Creating an Empty Activation Key
This example shows how to create an activation key that directs the associated hosts to automatically
attach a best fitting subscription:
$ hammer activation-key create \

--name "automatically attach key" \
37
--lifecycle-environment Testing
As a result, hosts registered in the cv-rhel7-server Content View are associated with this activation
key.
Example 4.2. Creating an Activation Key with Custom Subscription Pool
This example shows how to create an activation key that will direct the associated hosts to
automatically attach a best fitting subscription from the list specified in the activation key.
First create an empty activation key:
$ hammer activation-key create \

--name "custom pool key" \
--lifecycle-environment Testing
Add a subscription to the activation key:
$ hammer activation-key add-subscription \

--name "custom pool key" \
--subscription-id 1
Keep repeating this step to add all required subscriptions to the activation key.
Example 4.3. Creating an Activation Key with Mandatory Subscription List
This example shows how to create an activation key that will direct the associated hosts to attach all
subscriptions specified in the activation key.
First, create an activation key and add all required subscriptions to it. Follow the steps from
Example 4.2, “Creating an Activation Key with Custom Subscription Pool”.
Then disable the auto-attach property of the activation key:
$ hammer activation-key update \

--name "mandatory subs key" \
--auto-attach false
38
IMPORTANT
You can assign several activation keys to a Content View. In case of conflicting settings,
the values from the last specified key take precedence. You can specify the order of
precedence by setting a host group parameter as follows:
$ hammer hostgroup set-parameter \

--name kt_activation_keys \
--value name_of_first_key, name_of_second_key,... \
--hostgroup hostgroup_name
39
CHAPTER 5. CONFIGURING PROVISIONING ENVIRONMENT

This section shows how to configure various stages of your provisioning environment using hammer. For
web UI equivalents of the following procedures see Configuring Provisioning Resources in the
Provisioning Guide.
5.1. DOMAINS
Domains in Red Hat Satellite represent DNS zones. Satellite has the ability to assign domain names with
Red Hat Satellite Capsule Server DNS. This provides users with a means to group and name hosts
within a particular domain and associate them with parameters and Puppet variables.
To create a new domain, issue the following command:
$ hammer domain create --name domain_name
You can associate the newly created domain to organizations and locations using the hammer
organization add-domain or hammer location add-domain commands. To view the status of
a domain, issue the following command:
$ hammer domain info --name domain_name
5.2. SUBNETS
Subnets in Red Hat Satellite define networks specified for groups of systems. Subnets use standard IP-
address settings to define the network and use the Red Hat Satellite Capsule Server’s DHCP features to
assign IP addresses to systems within the subnet. The following command contains the minimal set of
options required for subnet creation:
$ hammer subnet create \

--name subnet_name \
--organization-ids org_ID1,org_ID2... \
--location-ids loc_ID1,loc_ID2... \
--domain-ids dom_ID1,dom_ID2... \
--boot-mode boot_mode \
--network network_address \
--mask netmask \
--ipam ipam
Here, boot_mode is one of Static or DHCP, ipam is one of DHCP, Internal DB, or None. If using
DHCP, you can set the IP range with the --from and --to options. For the full list of configurable
options, see the output of the hammer subnet create --help command.
5.3. ARCHITECTURES
Architecture in Satellite represents a logical grouping of hosts and operating systems. To view the
architectures, issue the following command:
$ hammer architecture list
Architectures are created by Satellite automatically when hosts are registered in Puppet, therefore it is
rarely needed to create them manually (even though hammer provides this option).
40
5.4. COMPUTE RESOURCES

Compute resources are hardware abstractions from virtualization and cloud providers. Satellite uses
compute resources to provision virtual machines and containers. Run the following command to create a
compute resource:
$ hammer compute-resource create \

--name cr_name \
--provider provider
Here, provider is one of: RHEV, RHEL OpenStack Platform, Libvirt, Docker, Rackspace,
Google, EC2, or VMware. Depending on the provider type, other options such as --url, or --user
may be required. See the output of the hammer compute-resource create --help command for
details.
5.5. INSTALLATION MEDIA

Installation media (ISO images) provide content for kickstart trees and new host installations in Red Hat
Satellite. To list the media, issue the following command:
$ hammer medium list
To add a new medium, issue the following command:
$ hammer medium create --name medium_name --path path_to_medium
You can make the medium available to organizations and locations directly when adding it (see the
output of the hammer medium create --help command), or later by using the hammer
organization add-medium or hammer location add-medium commands.
5.6. PARTITION TABLES

Partition tables define the partitions and file system layout for new installations when provisioning
systems. Red Hat Satellite provides default partition tables associated with operating system families, to
view them, issue the following command:
$ hammer partition-table list
To create a new partition table, issue the following command:
$ hammer partition-table create \

--name table_name \
--file path_to_layout_file \
--os-family os_family
See the output of the hammer partition-table --help command for other subcommands.
5.7. PROVISIONING TEMPLATES
41
Provisioning templates provide the systematic means to run unattended installations. To view the
provisioning templates provided by Satellite, issue the following command:
$ hammer template list
To add a new template, issue the following command:
$ hammer template create --name template_name --file path_to_template_file
See the output of the hammer template --help command for other subcommands.
5.8. OPERATING SYSTEMS

Operating systems define combinations of installation methods and media and are grouped within
families. As a default, Red Hat Satellite uses a Red Hat family. Families allow Satellite to change certain
behaviors when provisioning hosts. To list operating systems, issue the following command:
$ hammer os list
To create a new operating system, issue the following command:
$ hammer os create --name os_name --major version_number
Then you can add architectures, partition tables, installation media, and configuration templates to the
operating system. See the output of the hammer os --help command for details.
Example 5.1. Updating Multiple Operating Systems
The following Bash script assigns each operating system a partition table (Kickstart default),
configuration template (Kickstart default PXELinux), and provisioning template (Satellite Kickstart
Default).
PARTID=$(hammer --csv partition-table list | grep "Kickstart default" |

cut -d, -f1)
PXEID=$(hammer --csv template list --per-page=1000 | grep "Kickstart
default PXELinux" | cut -d, -f1)
SATID=$(hammer --csv template list --per-page=1000 | grep "provision" |
grep "Satellite Kickstart Default" | cut -d, -f1)
for i in $(hammer --csv os list | grep -vi 'ÎD' | awk -F, {'print $1'})
do
hammer partition-table add-operatingsystem --id="${PARTID}" --
operatingsystem-id="${i}"
hammer template add-operatingsystem --id="${PXEID}" --
operatingsystem-id="${i}"
hammer os set-default-template --id="${i}" --config-template-
id="${PXEID}"
hammer os add-config-template --id="${i}" --config-template-
id="${SATID}"
hammer os set-default-template --id="${i}" --config-template-
id="${SATID}"
done
42
You can add grep commands to the for statement to further specify the affected operating systems.
To verify if the assignment was performed correctly, use the hammer os info command.
5.9. PARAMETERS
Parameters define the behavior of Red Hat Satellite during provisioning. There are several types of
parameters, see Parameters in the Puppet Guide for details. Use the following example to set a global
parameter:
$ hammer global-parameter set --name param_name --value param_value
Example 5.2. Setting a Global Parameter to Disable the Firewall
Run the following command to set the firewall global option to disabled:
$ hammer global-parameter set --name firewall --value --disabled
To verify the setting, issue the following command:
$ hammer global-parameter list

---------|-------------
NAME | VALUE
---------|-------------
firewall | --disabled
---------|-------------
Similarly, you can use hammer to set other parameter types:
To set domain parameters, use:
$ hammer domain set-parameter \

--name param_name \
--value param_value \
--domain domain_name
To set host group parameters, use:

--name param_name \
--hostgroup hg_name
To set host parameters, use:
$ hammer host set-parameter \

--name param_name \
--host h_name
To update smart class parameters, use:
43
$ hammer sc-param \
--name param_name \
--default-value param_value
44
CHAPTER 6. MANAGING HOSTS

Host refers to any physical or virtual system Red Hat Satellite manages. This section shows how to
create and configure hosts and host groups using hammer. For web UI equivalents of the following
procedures see Managing Hosts.
6.1. CREATING A HOST GROUP

A host group is a collection of hosts or host groups. It is recommended to create host groups to hold
shared host parameters. Members of the host group inherit these parameters, therefore you do not have
to set them individually during host creation. Note that you can nest host groups in a hierarchical
manner.
The following command demonstrates a basic set of options for creating a host group:
$ hammer hostgroup create \

--name "hostgroup_name" \
--environment "environment_name" \
--architecture "architecture_name" \
--domain domain_name \
--subnet subnet_name \
--puppet-proxy proxy_name \
--puppet-ca-proxy ca-proxy_name \
--operatingsystem "os_name" \
--partition-table "table_name" \
--medium "medium_name" \
--location-ids loc_ID1,loc_ID2...
See hammer hostgroup create --help for the full list of configurable options. There are two
settings that cannot be configured during host group creation:
An activation key has to be added afterwards using:

--hostgroup "hostgroup_name" \
--name "kt_activation_keys" \
--value key_name
Run hammer activation-key list to find the activation key name (see Chapter 4, Managing
Activation Keys for details on activation keys).
The root password has to be specified when adding a host to the host group.
Example 6.1. Creating Host Groups for Multiple Content Views
The following Bash script creates a host group for each life cycle environment.
MAJOR="7"
OS=$(hammer --output csv os list | awk -F "," "/RedHat ${MAJOR}/ {print
\$2;exit}")
ARCH="x86_64"
ORG="ACME"
LOCATIONS="london,munich"
45
PTABLE_NAME="ptable-acme-os-rhel-server"
DOMAIN="example.com"
hammer lifecycle-environment list --organization "${ORG}" | awk -F "|"

'/[[:digit:]]/ {print $2}' | sed s'/ //' | while read LC_ENV
do
if [[ ${LC_ENV} == "Library" ]]; then
continue
fi
LC_ENV_LOWER=$(echo ${LC_ENV} | tr '[[:upper:]' '[[:lower:]]')

ParentID=$(hammer --output csv hostgroup list --per-page 999 | awk -
F"," "(\$3 ~ /^${LC_ENV_LOWER}$/) {print \$1}")
hammer hostgroup create --name "rhel-${MAJOR}server-${ARCH}" \

--medium
"${ORG}/Library/Red_Hat_Server/Red_Hat_Enterprise_Linux_${MAJOR}_Server_
Kickstart_${ARCH}_${MAJOR}
Server" \
--parent-id ${ParentID} \
--architecture "${ARCH}" \
--operatingsystem "${OS}" \
--partition-table "${PTABLE_NAME}" \
--subnet "${DOMAIN}" \
--domain "${DOMAIN}" \
--organizations "${ORG}" \
--locations "${LOCATIONS}" \
--content-view "cv-os-rhel-${MAJOR}Server" \
--environment-id $(hammer --output csv environment list --per-page
999 | awk -F "," "/KT_$ {ORG}_${LC_ENV}_cv_os_rhel_${MAJOR}Server/
{print \$1}")
HgID=$(hammer --output csv hostgroup list --per-page 999 | awk -F"," "
(\$3 ~ /^${LC_ENV_LOWER}\/rhel-${MAJOR}server-${ARCH}$/) {print \$1}")
hammer hostgroup set-parameter \

--hostgroup-id "${HgID}" \
--name "kt_activation_keys" \
--value "act-${LC_ENV_LOWER}-os-rhel-${MAJOR}server-${ARCH}"
done
6.2. CREATING A HOST

It is recommended to set general parameters in a host group to reduce the number of required options
when creating a host. The following command creates a basic host associated to a host group:
$ hammer host create \

--name "host_name" \
--hostgroup "hostgroup_name" \
--interface="primary=true, \
provision=true, \
mac=mac_address, \
ip=ip_address" \
46
--organization-id org_ID \
--location-id loc_ID \
--ask-root-password yes
After executing the above command you will be prompted to specify the root password. It is required to
specify the host’s IP and MAC address, other properties of the primary network interface can be inherited
from the host group or set using the subnet, and domain parameters. You can set additional interfaces
using the --interface option, which accepts a list of key-value pairs. For the list of available interface
settings, see Table 6.1, “Available Keys for the --interface Option”.
If you decide to create a host without host group membership, specify additional options described in
Section 6.1, “Creating a Host Group”. There is a wide range of available host parameters, for details see
the output of hammer host create --help. The value of certain parameters depends on the type of
compute resource the host is provisioned on, see Table 6.2, “Host Options Specific to Provider” for
reference.
Table 6.1. Available Keys for the --interface Option
Keys Description
type Defines the interface type, one of Nic::Managed,

Nic::BMC, Nic::Bond.
name, identifier Identification of the interface.
mac, ip, domain (or domain_id), subnet (or Network settings, domain and subnet identification
subnet_id) can be inherited from the host group.
primary, provision, managed, virtual Accept true or false. Managed hosts needs to
have one primary and provisioning interface.
Specific to virtual interfaces
tag VLAN tag, this attribute has precedence over the

subnet VLAN ID.
attached_to Identifier of the interface to which the virtual interface

belongs, for example eth1.
Specific to bonded interfaces
mode Bonding mode, one of balance-rr, active-

backup , balance-xor , broadcast,
802.3ad, balance-tlb , balance-alb .
Specific to BMC interfaces
provider BMC provider, set to IPMI.
username, password BMC access credentials.
47
Keys Description
Specific to hosts provisioned on Libvirt
compute_type Interface type, one of bridge , network.
compute_network or compute_bridge Specifies interface name, pick one depending on the

interface type.
compute_model One of virtio , rtl8139, ne2k_pci, pcnet,

e1000.
Specific to hosts provisioned on RHEV
compute_name Interface name, for example eth0.
compute_network Select one of the available networks for a cluster, use

UUID from RHEV.
Specific to hosts provisioned on VMware
compute_type Type of the network adapter, depends on your

version of vSphere.
compute_network Network ID form VMware.
Table 6.2. Host Options Specific to Provider
Provider Keys
Keys for the --compute-attributes option
EC2 flavor_id, image_id, availability_zone,

security_group_ids, managed_ip
GCE machine_type, image_id, network, external_ip
Libvirt cpus, memory, start
OpenStack flavor_ref, image_ref, tenant_id, security_groups,

network
RHEV cluster, template, cores, memory, start
VMware cpus, corespersocket, memory_mb, cluster, path,

guest_id, scsi_controller_type, hardware_version,
start
48
Provider Keys
Keys for the --volume option
Libvirt poll_name, capacity, format_type
RHEV size_gb, storage_domain, bootable
VMware datastore, name, size_gb, thin, eager_zero
Example 6.2. Creating a Host with a Bonded Interface Pair
The following example shows how to create a host with a bonded interface pair. For more information
on interface bonding see Configure Network Bonding in the Red Hat Enterprise Linux Networking
Guide.
$ hammer host create --name bondtest \

--hostgroup-id 1 \
--ip=192.168.100.123 \
--mac=52:54:00:14:92:2a \
--subnet-id=1 \
--managed true \
--interface="identifier=eth1, \
mac=52:54:00:62:43:06, \
managed=true, \
type=Nic::Managed, \
domain_id=1, \
subnet_id=1" \
--interface="identifier=eth2, \
mac=52:54:00:d3:87:8f, \
managed=true, \
type=Nic::Managed, \
domain_id=1, \
subnet_id=1" \
--interface="identifier=bond0, \
ip=172.25.18.123, \
type=Nic::Bond, \
mode=active-backup, \
attached_devices=[eth1,eth2], \
managed=true, \
domain_id=1, \
subnet_id=1" \
--organization-id 1 \
--location-id 1 \
--ask-root-password yes
6.3. CREATING A HOST COLLECTION

A host collection in Red Hat Satellite is a group of hosts. The following command shows the minimal set
of options required to create a host collection:
49
$ hammer host-collection create \

--name hc_name
To add hosts to a host collection, issue the following command:
$ hammer host-collection add-host \

--id hc_ID \
--host-ids ch_ID1,ch_ID2...
Run the following command to associate a host collection with an activation key (see Chapter 4,
Managing Activation Keys for details on activation keys):
$ hammer activation-key add-host-collection \

--id ak_ID \
--host-collection hc_name
Hosts grouped in the host collection now inherit the configuration from the activation key.
6.4. RUNNING REMOTE JOBS ON HOSTS

The remote execution feature enables defining arbitrary commands on the Satellite Server and executing
them on remote hosts. Commands are defined in job templates that are similar to provisioning templates.
Several job templates are included by default, you can use them or define a custom template for
example to manipulate software packages or start a Puppet process on remote hosts. To use this feature
in Hammer, install the remote execution CLI module by executing the following command as root:
# yum install tfm-rubygem-hammer_cli_foreman_remote_execution
To list job templates available, issue:
$ hammer job-template list
To create a job template using a template-definition file, use a command as follows:
$ hammer job-template create \

--file "template" \
--name "template_name" \
--provider-type SSH \
--job-category "category_name"
Replace template with the path to the file containing the template definition. Specify a custom
category_name or select one of the existing categories (Commands, Katello, Packages, Power,
Puppet, or Services). See the output of hammer job-template create --help for information
on other available parameters.
To invoke a job with custom parameters, issue:
$ hammer job-invocation create \

--job-template "template_name" \
--inputs key1="value",key2="value",... \
--search-query "query"
50
Specify the template name you want to use for the remote job. Specify inputs as a comma separated list
of key-value pairs. Run hammer job-template info to see what parameters are required by your
template. Replace query with the filter expression defining which hosts will be affected (for example
"name ~ rex01").
Example 6.3. Starting the httpd Service on Selected Hosts
This example shows how to execute a remote job based on the default Service Action - SSH
Default template, that will start the httpd service on hosts that have a name that contains "target".
$ hammer job-invocation create \

--job-template "Service Action - SSH Default" \
--inputs service="httpd",action="start" \
--search-query "name ~ target"
To monitor the job output, issue:
$ hammer job-invocation output \

--id job_ID \
--host host_name
Find the job_ID in the output of hammer job-invocation list. For more information on executing
remote commands with hammer, issue hammer job-template --help or hammer job-
invocation --help.
51
CHAPTER 7. MANAGING USERS AND PERMISSIONS

For the administrator, Red Hat Satellite provides the ability to create, modify, and remove users. Also, it
is possible to configure access permissions through assigning roles to users. This section shows how to
perform these tasks using hammer. For web UI equivalents of the following procedures see Managing
Users and Roles in Administering Red Hat Satellite.
7.1. CREATING USERS

User in Red Hat Satellite defines a set of details for individuals using the system. To configure a user in
Red Hat Satellite, hammer provides the user create and user update commands. Create a new
user with the following command:
$ hammer user create \

--login user_name \
--password user_password \
--mail user_mail \
--auth-source-id 1 \
--organization-ids org_ID1,org_ID2...
The --auth-source-id 1 setting means that the user is authenticated internally, you can specify an
external authentication source as an alternative. Add the --admin option to grant administrator
privileges to the user. Specifying organization IDs is not required, you can modify the user details later
using the update subcommand.
For more information on user related subcommands see the output of hammer user --help.
7.2. CREATING USER GROUPS

You can manage permissions of several users at once by organizing them into user groups. User groups
themselves can be further grouped to create a hierarchy of permissions. Use the following command to
create a new user group:
$ hammer user-group create --name usergroup_name
To add a user to a user group, issue the following command:
$ hammer user-group add-user --user user_name --id usergroup_id
Find the user group ID by executing hammer user-group list. Similarly, you can add user groups
using the add-user-group subcommand. For more information on operations related to user groups
see the output of hammer user-group --help.
7.3. CREATING ROLES

Roles in Red Hat Satellite define a set of permissions and access levels. Satellite provides a number of
predefined roles, to view them, enter the following command:
$ hammer role list
To view permissions associated with a role, issue the following command:
52
CHAPTER 7. MANAGING USERS AND PERMISSIONS
$ hammer role filters --id role_id
Here, role_id is the ID of the role from the output of hammer role list.
To create a custom role, issue the following command:
$ hammer role create --name role_name
Add a permission filter to the role with the following command:
$ hammer filter create \

--role role_name \
--permission-ids perm_ID1,perm_ID2...
Find the permissions to be added to the role by using hammer filter available-permissions.
For details on roles and permissions see the output of hammer role --help and hammer filter -
-help.
Example 7.1. Granular Permission Filtering
Red Hat Satellite provides the ability to limit the configured user permissions to selected instances of
a resource type. Use the --search option to limit permission filters, for example:
$ hammer filter create \

--permission-ids 91 \
--search "name ~ ccv*" \
--role qa-user
The above command adds to the qa-user role a permission to view, create, edit, and destroy Content
Views that only applies to Content Views with name starting with ccv. See Granular Permission
Filtering in Administering Red Hat Satellite for more information.
7.4. ASSIGNING ROLES TO USERS

To assign a role to a user, issue the following command:
$ hammer user add-role --id user_id --role role_name
Similarly, you can assign a role to a user group:
$ hammer user-group add-role --id usergroup_id --role role_name
7.5. ADDING SSH KEYS TO A USER

The following steps show how to add public SSH keys to an existing user using the hammer. To create
SSH keys or for more information, see Generating Key Pairs in the Red Hat Enterprise Linux 7 System
Administrator’s Guide.
For web UI equivalents of the following procedures see Adding SSH keys to a User in Administering Red
Hat Satellite.
53
Prerequisite
You need either the path to the public SSH key file, or the content of the public SSH key copied to the
clipboard.
If you have the public SSH key file:
$ hammer user ssh-keys add --user-id user_id --name key_name --key-file

~/.ssh/id_rsa.pub
If you have the content of the public SSH key:
$ hammer user ssh-keys add --user-id user_id --name key_name --key ecdsa-
sha2-nistp256
AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNtYAAABBBHHS2KmNyIYa27Qaa7EHp+
2l99ucGStx4P77e03ZvE3yVRJEFikpoP3MJtYYfIe8k 1/46MTIZo9CPTX4CYUHeN8=
host@user
7.6. DELETING SSH KEYS FROM A USER

To delete an SSH key from a user:
$ hammer user ssh-keys delete --id key_id --user-id user_id
7.7. VIEWING SSH KEYS OF A USER

To view an SSH key attached to a user:
$ hammer user ssh-keys info --id key_id --user-id user_id
To list SSH keys attached to a user:
$ hammer user ssh-keys list --user-id user_id
54
CHAPTER 8. MANAGING ERRATA

Software packages in Red Hat products are subject to updates, referred to as errata, that are released at
regular intervals as well as asynchronously. This section shows how to inspect and apply errata using
hammer. For web UI equivalents of the following procedures see Managing Errata in the Content
Management Guide.
8.1. INSPECTING AVAILABLE ERRATA

To view errata that are available for all organizations, issue the following command:
$ hammer erratum list
Example 8.1. Filtering Errata
The hammer erratum list command provides numerous options for filtering and ordering the
output list. For example, to find an erratum that contains a specific security fix, issue:
$ hammer erratum list --cve CVE-2014-0453
The following command displays applicable errata for the selected product that contain the specified
bugs ordered so that the security errata are displayed on top:
$ hammer erratum list \

--product-id 7 \
--search "bug = 1213000 or bug = 1207972" \
--errata-restrict-applicable 1 \
--order "type desc"
For more information on syntax used in the --search option, see Inspecting Available Errata in the
Content Management Guide. For more information on filtering options implemented in hammer, see
the output of hammer erratum list --help.
To view details of a specific erratum, issue the following command:
$ hammer erratum info --id erratum_ID
Replace erratum_ID with a unique identifier of the erratum found in the output of the hammer erratum
list command. You can identify errata also by name and repository name, see the output of hammer
erratum info --help for details.
8.2. APPLYING ERRATA TO A HOST

To list errata available for a host, issue the following command:
$ hammer host errata list --host hostname
To apply selected errata to the host, issue the following command:
$ hammer host errata apply \

--host hostname \
55
--errata-ids erratum_ID1,erratum_ID2...
Example 8.2. Applying All Available Errata to a Host
The following Bash script applies all errata available to a host (auth01.example.com):
HOST="auth01.example.com"
for i in $(hammer --csv host errata list --host $HOST | grep -vi 'ÎD' |
awk -F, {'print $2'})
do
hammer host errata apply --host $HOST --errata-ids $i
done
Example 8.3. Applying a Security Advisory
This example shows how to apply a security fix to hosts using hammer:
1. Find the erratum that contains a fix for a selected issue (CVE-2015-3238):
$ hammer erratum list --cve CVE-2015-3238

-------|----------------|----------|--------------------------
----
ID | ERRATA ID | TYPE | TITLE
-------|----------------|----------|--------------------------
----
f30e66 | RHSA-2015:1640 | security | Moderate: pam security update
-------|----------------|----------|--------------------------
----
2. Verify if the security erratum (RHSA-2015:1640) is applicable for your host

(auth01.example.com):
$ hammer host errata list \

--host auth01.example.com \
--search "RHSA-2015:1640"
3. Apply the erratum to the host:
$ hammer host errata apply \

--host auth01.example.com \
--errata-ids "RHSA-2015:1640"
You can use the following Bash script to apply a security erratum (for example RHSA-2015:1640) to
all hosts where it is applicable:
ORG="ACME"
RHSA="RHSA-2015:1640"
for i in $(hammer --csv host list --organization $ORG | grep -vi 'ÎD' |
awk -F, {'print $2'})
56
do
hammer host errata apply --host $i --errata-ids $RHSA
done
To see if errata were applied successfully, find the corresponding task in the output of the following
command:
$ hammer task list
To review the state of a selected task, issue the following command:
$ hammer task progress --id task_ID
8.3. APPLYING ERRATA TO A HOST COLLECTION

To apply selected errata to a Host Collection, enter a command as follows:
$ hammer host-collection erratum install \

--errata "erratum_ID1,erratum_ID2,..." \
--name "my-collection" --organization $ORG
This command is available in Red Hat Satellite 6.2.8 or later.
57
CHAPTER 9. MANAGING DOCKER CONTAINERS

A Docker container is a sandbox for isolating applications. The container image stores the configuration
for the container. This section shows how to use hammer to provision Docker containers. For web UI
equivalents of the following procedures see Managing Containers in Managing Hosts.
In Red Hat Satellite, you can deploy containers only on a compute resource of the Docker provider type.
See Preparing Container Hosts in Managing Hosts for instructions on how to prepare a container host.
To register this host as a compute resource, issue the following command:
$ hammer compute-resource create

--name cr_name \
--url cr_url \
--provider docker
Use the following syntax to provision a container on the compute resource:
$ hammer docker container create \

--name container_name \
--compute-resource-id cr_ID \
--repository-name repo_name \
--tag tag \
--command command
Find the compute resource ID in the output of hammer compute-resource list. Replace
repo_name with the name of the synchronized repository that contains your docker images. This can be
a custom repository pointing to Docker Hub or your internal registry (see Section 2.3.4, “Creating a
Custom Repository”), or the official Red Hat image repository. If you provision from a Content View,
replace repo_name with the name of the Content View. See Section 3.2.3, “Adding Docker Images to a
Content View” for details on adding images to a Content View.
By starting a container you start the process specified with the --command option during the container
creation. To start a container, issue the following command:
$ hammer docker container start --id container_ID
For the full list of container related options, see the output of the hammer docker container --
help command.
58
CHAPTER 10. REFERENCE

This chapter provides a list of Hammer usage statements. These usage statements were current to the
versions of Hammer and its components released for Satellite 6.3.
10.1. HAMMER ACTIVATION-KEY

Manipulate activation keys.
Usage:
hammer activation-key [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
add-host-collection Associate a resource
add-subscription Add subscription
content-override Override product content defaults
copy Copy an activation key
create Create an activation key
delete Destroy an activation key
host-collections List associated host collections
info Show an activation key
list List activation keys
product-content List associated products
remove-host-collection Disassociate a resource
remove-subscription Remove subscription
subscriptions List associated subscriptions
update Update an activation key
Options:
-h, --help print help
10.1.1. hammer activation-key add-host-collection

Associate a resource
Usage:
hammer activation-key add-host-collection [OPTIONS]
Options:
--host-collection HOST_COLLECTION_NAME Host collection name to search by
--host-collection-id HOST_COLLECTION_ID Id of the host collection
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
10.1.2. hammer activation-key add-subscription
59
Add subscription
Usage:
hammer activation-key add-subscription [OPTIONS]
Options:
--quantity QUANTITY Quantity of this subscription to
add
--subscription-id SUBSCRIPTION_ID ID of subscription
10.1.3. hammer activation-key content-override

Override product content defaults
Usage:
hammer activation-key content-override [OPTIONS]
Options:
--content-label CONTENT_LABEL Label of the content
--override-name OVERRIDE_NAME Override parameter key or name.
To enable or disable a repo
select 'enabled'.
Default value: enabled
Default: "enabled"
--remove Remove a content override
--value VALUE Override value. Note for repo
enablement you can use a boolean value
10.1.4. hammer activation-key copy

Copy an activation key
Usage:
hammer activation-key copy [OPTIONS]
Options:
--new-name NEW_NAME Name of new activation key
60

10.1.5. hammer activation-key create

Create an activation key
Usage:
hammer activation-key create [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to
search by
--content-view-id CONTENT_VIEW_ID content view numeric
identifier
--description DESCRIPTION description
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Environment name
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--max-hosts MAX_HOSTS maximum number of
registered content hosts
--name NAME name
--organization ORGANIZATION_NAME Organization name to
search by
--organization-label ORGANIZATION_LABEL Organization label
to search by
--unlimited-hosts Set hosts max to
unlimited
10.1.6. hammer activation-key delete

Destroy an activation key
Usage:
hammer activation-key delete [OPTIONS]
Options:
10.1.7. hammer activation-key host-collections

List associated host collections
Usage:
hammer activation-key host-collections [OPTIONS]
61
Options:
--available-for AVAILABLE_FOR Interpret specified object to
return only Host Collections that can be
associated with specified
object. The value 'host' is supported.
--full-result FULL_RESULT Whether or not to show all
results
One of true/false, yes/no, 1/0.
--host-id HOST_ID Filter products by host id
--id ID ID of activation key
--name NAME Name of activation key
10.1.8. hammer activation-key info

Show an activation key
Usage:
hammer activation-key info [OPTIONS]
Options:
10.1.9. hammer activation-key list

List activation keys
Usage:
hammer activation-key list [OPTIONS]
Options:
--by BY Field to sort the
results on
search by
identifier
--full-result FULL_RESULT Whether or not to
show all results
One of true/false,
yes/no, 1/0.
--name NAME activation key name
to filter by
--order ORDER Sort field and
62
order, eg. 'name DESC'

search by
to search by
--page PAGE Page number,
starting at 1
--per-page PER_PAGE Number of results
per page to return
--search SEARCH Search string
10.1.10. hammer activation-key product-content

List associated products
Usage:
hammer activation-key product-content [OPTIONS]
Options:
--content-access-mode-all CONTENT_ACCESS_MODE_ALL Get all content
available, not just that provided by subscriptions
One of true/false,
yes/no, 1/0.
--content-access-mode-env CONTENT_ACCESS_MODE_ENV Limit content to just
that available in the activation key's content
view version
One of true/false,
yes/no, 1/0.
--id ID ID of the activation
key
--name NAME Activation key name
to search by
search by
--organization-label ORGANIZATION_LABEL Organization label to
search by
10.1.11. hammer activation-key remove-host-collection

Disassociate a resource
Usage:
hammer activation-key remove-host-collection [OPTIONS]
Options:
--host-collection HOST_COLLECTION_NAME Host collection name to search by
--host-collection-id HOST_COLLECTION_ID Id of the host collection
63

10.1.12. hammer activation-key remove-subscription

Remove subscription
Usage:
hammer activation-key remove-subscription [OPTIONS]
Options:
10.1.13. hammer activation-key subscriptions

List associated subscriptions
Usage:
hammer activation-key subscriptions [OPTIONS]
Options:
--activation-key ACTIVATION_KEY_NAME Activation key name to search by
--activation-key-id ACTIVATION_KEY_ID ID of the activation key
--available-for AVAILABLE_FOR Object to show subscriptions
available for, either 'host' or
'activation_key'
--by BY Field to sort the results on
results
--host HOST_NAME Host name
--host-id HOST_ID
--id ACTIVATION_KEY_ID ID of the activation key
--match-host MATCH_HOST Ignore subscriptions that are
unavailable to the specified host
--match-installed MATCH_INSTALLED Return subscriptions that match
installed products of the specified host
--name ACTIVATION_KEY_NAME Activation key name to search by
--no-overlap NO_OVERLAP Return subscriptions which do
not overlap with a currently-attached
subscription
--order ORDER Sort field and order, eg. 'name
DESC'
64

--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to
return
10.1.14. hammer activation-key update

Update an activation key
Usage:
hammer activation-key update [OPTIONS]
Options:
--auto-attach AUTO_ATTACH auto attach
subscriptions upon registration
One of true/false,
yes/no, 1/0.
search by
identifier
--id ID ID of the
activation key
--max-hosts MAX_HOSTS maximum number of
registered content hosts
--name NAME Activation key name
to search by
--new-name NEW_NAME name
search by
to search by
--release-version RELEASE_VERSION content release
version
--service-level SERVICE_LEVEL service level
--unlimited-hosts set hosts max to
unlimited
10.2. HAMMER ADMIN

Administrative server-side tasks
Usage:
hammer admin [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
65
Subcommands:
logging Logging verbosity level setup
Options:
10.2.1. hammer admin logging

Logging verbosity level setup
Usage:
hammer admin logging [OPTIONS]
Options:
--no-backup Skip configuration backups creation.
--prefix PATH Operate on prefixed environment (e.g.
chroot).
-a, --all Apply to all components.
-c, --components COMPONENTS Components to apply, use --list to get
them.
Comma separated list of values. Values
containing comma should be quoted or escaped with backslash
-d, --level-debug Increase verbosity level to debug.
-l, --list List available components.
-n, --dry-run Do not apply specified changes.
-p, --level-production Decrease verbosity level to standard.
10.3. HAMMER ARCHITECTURE

Manipulate architectures.
Usage:
hammer architecture [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-operatingsystem Associate an operating system
create Create an architecture
delete Delete an architecture
info Show an architecture
list List all architectures
remove-operatingsystem Disassociate an operating system
update Update an architecture
Options:
66
10.3.1. hammer architecture add-operatingsystem

Associate an operating system
Usage:
hammer architecture add-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Architecture name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
10.3.2. hammer architecture create

Create an architecture
Usage:
hammer architecture create [OPTIONS]
Options:
--name NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Operating system IDs
Comma separated list of
values. Values containing comma should be quoted or escaped with backslash
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values.
Values containing comma should be quoted or escaped with backslash
10.3.3. hammer architecture delete

Delete an architecture
Usage:
hammer architecture delete [OPTIONS]
Options:
--id ID
10.3.4. hammer architecture info

Show an architecture
Usage:
hammer architecture info [OPTIONS]
Options:
--id ID
67
10.3.5. hammer architecture list

List all architectures
Usage:
hammer architecture list [OPTIONS]
Options:
--order ORDER sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--search SEARCH filter results
10.3.6. hammer architecture remove-operatingsystem

Disassociate an operating system
Usage:
hammer architecture remove-operatingsystem [OPTIONS]
Options:
--id ID
10.3.7. hammer architecture update

Update an architecture
Usage:
hammer architecture update [OPTIONS]
Options:
--id ID
--new-name NEW_NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Operating system IDs
10.4. HAMMER ARF-REPORT

Manipulate compliance reports
Usage:
68
hammer arf-report [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
delete Delete an ARF Report
download Download bzipped ARF report
download-html Download ARF report in HTML
info Show an ARF report
list List ARF reports
Options:
10.4.1. hammer arf-report delete

Delete an ARF Report
Usage:
hammer arf-report delete [OPTIONS]
Options:
--id ID
10.4.2. hammer arf-report download

Download bzipped ARF report
Usage:
hammer arf-report download [OPTIONS]
Options:
--id ID
--path PATH Path to directory where downloaded file
will be saved
10.4.3. hammer arf-report download-html

Download ARF report in HTML
Usage:
hammer arf-report download-html [OPTIONS]
Options:
--id ID
will be saved
69
10.4.4. hammer arf-report info

Show an ARF report
Usage:
hammer arf-report info [OPTIONS]
Options:
--id ID
10.4.5. hammer arf-report list

List ARF reports
Usage:
hammer arf-report list [OPTIONS]
Options:
10.5. HAMMER AUTH

Foreman connection login/logout.
Usage:
hammer auth [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
login Set credentials
logout Wipe your credentials
status Information about current connections
Options:
10.5.1. hammer auth login

Set credentials
Usage:
hammer auth login [OPTIONS]
Options:
70

-p, --password PASSWORD password to access the remote system
-u, --username USERNAME username to access the remote system
10.5.2. hammer auth logout

Wipe your credentials
Usage:
hammer auth logout [OPTIONS]
Options:
10.5.3. hammer auth status

Information about current connections
Usage:
hammer auth status [OPTIONS]
Options:
10.6. HAMMER AUTH-SOURCE

Manipulate auth sources.
Usage:
hammer auth-source [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
ldap Manage LDAP auth sources.
Options:
10.6.1. hammer auth-source ldap

Manage LDAP auth sources.
Usage:
hammer auth-source ldap [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
71
Subcommands:
create Create an LDAP authentication source
delete Delete an LDAP authentication source
info Show an LDAP authentication source
list List all LDAP authentication sources
update Update an LDAP authentication source
Options:
10.6.1.1. hammer auth-source ldap create
Create an LDAP authentication source
Usage:
hammer auth-source ldap create [OPTIONS]
Options:
--account ACCOUNT
--account-password ACCOUNT_PASSWORD required if onthefly_register
is true
--attr-firstname ATTR_FIRSTNAME required if onthefly_register
is true
--attr-lastname ATTR_LASTNAME required if onthefly_register
is true
--attr-login ATTR_LOGIN required if onthefly_register
is true
--attr-mail ATTR_MAIL required if onthefly_register
is true
--attr-photo ATTR_PHOTO
--base-dn BASE_DN
--groups-base GROUPS_BASE groups base DN
--host HOST
--ldap-filter LDAP_FILTER LDAP filter
--location-ids LOCATION_IDS REPLACE locations with given
ids
--location-titles LOCATION_TITLES Comma separated list of values.
--locations LOCATION_NAMES Comma separated list of
--name NAME
--onthefly-register ONTHEFLY_REGISTER One of true/false, yes/no, 1/0.
--organization-ids ORGANIZATION_IDS REPLACE organizations with
given ids.
--organization-titles ORGANIZATION_TITLES Comma separated list of values.
--organizations ORGANIZATION_NAMES Comma separated list of values.
--port PORT defaults to 389
--server-type SERVER_TYPE type of the LDAP server
Possible value(s):
72
'free_ipa', 'active_directory', 'posix'

--tls TLS One of true/false, yes/no,
1/0.
--use-netgroups USE_NETGROUPS use NIS netgroups instead of
posix groups, applicable only when server_type
is posix or free_ipa
One of true/false, yes/no,
1/0.
--usergroup-sync USERGROUP_SYNC sync external user groups on
login
1/0.
10.6.1.2. hammer auth-source ldap delete
Delete an LDAP authentication source
Usage:
hammer auth-source ldap delete [OPTIONS]
Options:
--id ID
--name NAME Name to search by
10.6.1.3. hammer auth-source ldap info
Show an LDAP authentication source
Usage:
hammer auth-source ldap info [OPTIONS]
Options:
--id ID
10.6.1.4. hammer auth-source ldap list
List all LDAP authentication sources
Usage:
hammer auth-source ldap list [OPTIONS]
Options:
--location LOCATION_NAME Location name
--location-id LOCATION_ID
--location-title LOCATION_TITLE Location title
--organization ORGANIZATION_NAME Organization name
--organization-title ORGANIZATION_TITLE Organization title
73

10.6.1.5. hammer auth-source ldap update
Update an LDAP authentication source
Usage:
hammer auth-source ldap update [OPTIONS]
Options:
--account ACCOUNT
--account-password ACCOUNT_PASSWORD required if onthefly_register
is true
--attr-firstname ATTR_FIRSTNAME required if onthefly_register
is true
--attr-lastname ATTR_LASTNAME required if onthefly_register
is true
--attr-login ATTR_LOGIN required if onthefly_register
is true
--attr-mail ATTR_MAIL required if onthefly_register
is true
--attr-photo ATTR_PHOTO
--base-dn BASE_DN
--groups-base GROUPS_BASE groups base DN
--host HOST
--id ID
--ldap-filter LDAP_FILTER LDAP filter
ids
--new-name NEW_NAME
--onthefly-register ONTHEFLY_REGISTER One of true/false, yes/no, 1/0.
given ids.
--port PORT defaults to 389
--server-type SERVER_TYPE type of the LDAP server
Possible value(s):
'free_ipa', 'active_directory', 'posix'
--tls TLS One of true/false, yes/no,
1/0.
--use-netgroups USE_NETGROUPS use NIS netgroups instead of
74
posix groups, applicable only when server_type

is posix or free_ipa
1/0.
--usergroup-sync USERGROUP_SYNC sync external user groups on
login
1/0.
10.7. HAMMER BOOTDISK

Download boot disks
Usage:
hammer bootdisk [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
generic Download generic image
host Download host image
subnet Download subnet generic image
Options:
10.7.1. hammer bootdisk generic

Download generic image
Usage:
hammer bootdisk generic [OPTIONS]
Options:
--file PATH File or device to write image to
--force Force writing to existing destination
(device etc.)
--sudo Use sudo to write to device
10.7.2. hammer bootdisk host

Download host image
Usage:
hammer bootdisk host [OPTIONS]
Options:
75
(device etc.)
--full FULL True for full, false for basic reusable
image
--host-id HOST_ID
10.7.3. hammer bootdisk subnet

Download subnet generic image
Usage:
hammer bootdisk subnet [OPTIONS]
Options:
(device etc.)
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
10.8. HAMMER CAPSULE

Manipulate capsule
Usage:
hammer capsule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
content Manage the capsule content
create Create a capsule
delete Delete a capsule
import-classes Import puppet classes from puppet Capsule.
info Show a capsule
list List all capsules
refresh-features Refresh capsule features
update Update a capsule
Options:
10.8.1. hammer capsule content

Manage the capsule content
76
Usage:
hammer capsule content [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-lifecycle-environment Add lifecycle environments to the
capsule
available-lifecycle-environments List the lifecycle environments not
attached to the capsule
cancel-synchronization Cancel running capsule synchronization.
info Get current capsule synchronization
status
lifecycle-environments List the lifecycle environments attached
to the capsule
remove-lifecycle-environment Remove lifecycle environments from the
capsule
synchronization-status Get current capsule synchronization
status
synchronize Synchronize the content to the capsule
Options:
10.8.1.1. hammer capsule content add-lifecycle-environment
Add lifecycle environments to the capsule
Usage:
hammer capsule content add-lifecycle-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name
--environment-id ENVIRONMENT_ID
--id ID Id of the capsule
--organization NAME Organization name
--organization-id ID Organization ID
10.8.1.2. hammer capsule content available-lifecycle-environments
List the lifecycle environments not attached to the capsule
Usage:
hammer capsule content available-lifecycle-environments [OPTIONS]
Options:
77

10.8.1.3. hammer capsule content cancel-synchronization
Cancel running capsule synchronization.
Usage:
hammer capsule content cancel-synchronization [OPTIONS]
Options:
10.8.1.4. hammer capsule content info
Get current capsule synchronization status
Usage:
hammer capsule content info [OPTIONS]
Options:
10.8.1.5. hammer capsule content lifecycle-environments
List the lifecycle environments attached to the capsule
Usage:
hammer capsule content lifecycle-environments [OPTIONS]
Options:
10.8.1.6. hammer capsule content remove-lifecycle-environment
Remove lifecycle environments from the capsule
Usage:
hammer capsule content remove-lifecycle-environment [OPTIONS]
78
Options:
10.8.1.7. hammer capsule content synchronization-status
Usage:
hammer capsule content synchronization-status [OPTIONS]
Options:
10.8.1.8. hammer capsule content synchronize
Synchronize the content to the capsule
Usage:
hammer capsule content synchronize [OPTIONS]
Options:
--async Do not wait for the task
--skip-metadata-check SKIP_METADATA_CHECK Skip metadata check on each
repository on the capsule
1/0.
10.8.2. hammer capsule create

Create a capsule
Usage:
hammer capsule create [OPTIONS]
Options:
--download-policy DOWNLOAD_POLICY Download Policy of the capsule,
79
must be one of immediate, on_demand,

background, inherit
ids
--name NAME
given ids.
--url URL
10.8.3. hammer capsule delete

Delete a capsule
Usage:
hammer capsule delete [OPTIONS]
Options:
--id ID
10.8.4. hammer capsule import-classes

Import puppet classes from puppet Capsule.
Usage:
hammer capsule import-classes [OPTIONS]
Options:
--dryrun Do not run the import
--except EXCEPT Optional comma-delimited string
containing either 'new',
'updated', or 'obsolete' that is used
to limit the imported
Puppet classes
--id ID
80
10.8.5. hammer capsule info

Show a capsule
Usage:
hammer capsule info [OPTIONS]
Options:
--id ID
10.8.6. hammer capsule list

List all capsules
Usage:
hammer capsule list [OPTIONS]
Options:
10.8.7. hammer capsule refresh-features

Refresh capsule features
Usage:
hammer capsule refresh-features [OPTIONS]
Options:
--id ID
10.8.8. hammer capsule update

Update a capsule
Usage:
hammer capsule update [OPTIONS]
Options:
81

background, inherit
--id ID
ids
--new-name NEW_NAME
given ids.
--url URL
10.9. HAMMER COMPUTE-RESOURCE

Manipulate compute resources.
Usage:
hammer compute-resource [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a compute resource
delete Delete a compute resource
image View and manage compute resource's images
info Show a compute resource
list List all compute resources
networks Show available networks
update Update a compute resource
Options:
10.9.1. hammer compute-resource create

Create a compute resource
Usage:
hammer compute-resource create [OPTIONS]
82
Options:
--caching-enabled CACHING_ENABLED enable caching, for VMware
only
1/0.
--datacenter DATACENTER for RHEV, VMware Datacenter
--description DESCRIPTION
--display-type DISPLAY_TYPE for Libvirt only
Possible value(s): 'VNC',
'SPICE'
--domain DOMAIN for RHEL OpenStack Platform
only
ids
--location-titles LOCATION_TITLES Comma separated list of
--name NAME
given ids.
--organization-titles ORGANIZATION_TITLES Comma separated list of
--organizations ORGANIZATION_NAMES Comma separated list of
--password PASSWORD Password for RHEV, EC2,
VMware, OpenStack. Secret key for EC2
--provider PROVIDER Providers include Libvirt,
Ovirt, EC2, Vmware, Openstack, Rackspace, GCE,
Docker
--region REGION for EC2 only
--server SERVER for VMware
--set-console-password SET_CONSOLE_PASSWORD for Libvirt and VMware only
1/0.
--tenant TENANT for RHEL OpenStack Platform
only
--url URL URL for Docker, Libvirt,
RHEV, OpenStack and Rackspace
--user USER Username for RHEV, EC2,
VMware, OpenStack. Access Key for EC2.
--uuid UUID Deprecated, please use
datacenter
10.9.2. hammer compute-resource delete

Delete a compute resource
Usage:
hammer compute-resource delete [OPTIONS]
83
Options:
--id ID
--name NAME Compute resource name
10.9.3. hammer compute-resource image

View and manage compute resource’s images
Usage:
hammer compute-resource image [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
available Show images available for addition
create Create an image
delete Delete an image
info Show an image
list List all images for a compute resource
update Update an image
Options:
10.9.3.1. hammer compute-resource image available
Show images available for addition
Usage:
hammer compute-resource image available [OPTIONS]
Options:
--compute-resource NAME
--compute-resource-id ID
--id ID
10.9.3.2. hammer compute-resource image create
Create an image
Usage:
hammer compute-resource image create [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
84
--name NAME
--password PASSWORD
--user-data USER_DATA Whether or not the image
supports user data
1/0.
--username USERNAME
--uuid UUID
10.9.3.3. hammer compute-resource image delete
Delete an image
Usage:
hammer compute-resource image delete [OPTIONS]
Options:
--id ID
10.9.3.4. hammer compute-resource image info
Show an image
Usage:
hammer compute-resource image info [OPTIONS]
Options:
--id ID
10.9.3.5. hammer compute-resource image list
List all images for a compute resource
Usage:
hammer compute-resource image list [OPTIONS]
Options:
85
10.9.3.6. hammer compute-resource image update
Update an image
Usage:
hammer compute-resource image update [OPTIONS]
Options:
--id ID
--new-name NEW_NAME
--password PASSWORD
--user-data USER_DATA Whether or not the image
supports user data
1/0.
--username USERNAME
--uuid UUID
10.9.4. hammer compute-resource info

Show a compute resource
Usage:
hammer compute-resource info [OPTIONS]
Options:
--id ID
10.9.5. hammer compute-resource list

List all compute resources
86
Usage:
hammer compute-resource list [OPTIONS]
Options:
10.9.6. hammer compute-resource networks

Show available networks
Usage:
hammer compute-resource networks [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--id ID
10.9.7. hammer compute-resource update

Update a compute resource
Usage:
hammer compute-resource update [OPTIONS]
Options:
--caching-enabled CACHING_ENABLED enable caching, for VMware
only
1/0.
--datacenter DATACENTER for RHEV, VMware Datacenter
--display-type DISPLAY_TYPE for Libvirt only
Possible value(s): 'VNC',
'SPICE'
--domain DOMAIN for RHEL OpenStack Platform
only
--id ID
ids
87

--new-name NEW_NAME
given ids.
--password PASSWORD Password for RHEV, EC2,
VMware, OpenStack. Secret key for EC2
--provider PROVIDER Providers include Libvirt,
Ovirt, EC2, Vmware, Openstack, Rackspace, GCE,
Docker
--region REGION for EC2 only
--server SERVER for VMware
--set-console-password SET_CONSOLE_PASSWORD for Libvirt and VMware only
1/0.
--tenant TENANT for RHEL OpenStack Platform
only
--url URL URL for Docker, Libvirt,
RHEV, OpenStack and Rackspace
--user USER Username for RHEV, EC2,
VMware, OpenStack. Access Key for EC2.
--uuid UUID Deprecated, please use
datacenter
10.10. HAMMER CONFIG-GROUP

Manipulate config groups.
Usage:
hammer config-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a config group
delete Delete a config group
info Show a config group
list List of config groups
update Update a config group
Options:
88
10.10.1. hammer config-group create

Create a config group
Usage:
hammer config-group create [OPTIONS]
Options:
--name NAME
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values.
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values.
10.10.2. hammer config-group delete

Delete a config group
Usage:
hammer config-group delete [OPTIONS]
Options:
--id ID
10.10.3. hammer config-group info

Show a config group
Usage:
hammer config-group info [OPTIONS]
Options:
--id ID
10.10.4. hammer config-group list

List of config groups
Usage:
hammer config-group list [OPTIONS]
Options:
89
10.10.5. hammer config-group update

Update a config group
Usage:
hammer config-group update [OPTIONS]
Options:
--id ID
--new-name NEW_NAME
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values.
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values.
10.11. HAMMER CONTENT-VIEW

Manipulate content views.
Usage:
hammer content-view [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-repository Associate a resource
add-version Add a content view version to a composite
view
component View and manage components
copy Copy a content view
create Create a content view
delete Delete a content view
filter View and manage filters
info Show a content view
list List content views
publish Publish a content view
puppet-module View and manage puppet modules
purge Delete old versions of a content view
remove Remove versions and/or environments from a
content view and reassign systems and keys
remove-from-environment Remove a content view from an environment
remove-repository Disassociate a resource
remove-version Remove a content view version from a
composite view
update Update a content view
version View and manage content view versions
Options:
90
10.11.1. hammer content-view add-repository

Usage:
hammer content-view add-repository [OPTIONS]
Options:
--id ID content view numeric identifier
--name NAME Content view name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID repository ID
10.11.2. hammer content-view add-version

Add a content view version to a composite view
Usage:
hammer content-view add-version [OPTIONS]
Options:
search by
identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version
number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version
identifier
--id ID content view
numeric identifier
--name NAME Content view name
to search by
search by
--organization-id ORGANIZATION_ID Organization ID to
search by
to search by
10.11.3. hammer content-view component

View and manage components
Usage:
hammer content-view component [OPTIONS] SUBCOMMAND [ARG] ...
91
Parameters:
Subcommands:
add Add components to the content view
list List components attached to this content
view
remove Remove components from the content view
update Update a component associated with the
content view
Options:
10.11.3.1. hammer content-view component add
Add components to the content view
Usage:
hammer content-view component add [OPTIONS]
Options:
--component-content-view COMPONENT_CONTENT_VIEW_NAME
Content View name of the component who's latest version is desired
--component-content-view-id COMPONENT_CONTENT_VIEW_ID
Content View identifier of the component who's latest version is desired
--component-content-view-version COMPONENT_CONTENT_VIEW_VERSION_VERSION
Content View Version number of the component. Either use this or --
component-content-view-version-id option
--component-content-view-version-id COMPONENT_CONTENT_VIEW_VERSION_ID
Content View Version identifier of the component
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME
Name of the composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID
composite content view identifier
--latest
Select the latest version of the components content view is desired
--organization ORGANIZATION_NAME
Organization name to search by
--organization-id ORGANIZATION_ID
Organization ID to search by
--organization-label ORGANIZATION_LABEL
Organization label to search by
-h, --help
print help
10.11.3.2. hammer content-view component list
List components attached to this content view
Usage:
hammer content-view component list [OPTIONS]
Options:
92
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME Name of the

composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID composite content
view identifier
to search by
search by
to search by
10.11.3.3. hammer content-view component remove
Remove components from the content view
Usage:
hammer content-view component remove [OPTIONS]
Options:
--component-content-view-ids COMPONENT_CONTENT_VIEW_IDs Array of
component content view identfiers to remove. Comma separated list of
values
--component-content-views COMPONENT_CONTENT_VIEW_NAMES Array of
component content view names to remove. Comma separated list of values
--component-ids COMPONENT_IDS Array of content
view component IDs to remove. Identifier of the component
association
Comma
separated list of values. Values containing comma should be quoted or
escaped with backslash
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME Name of the
composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID composite content
view identifier
--organization ORGANIZATION_NAME Organization
name to search by
--organization-id ORGANIZATION_ID Organization ID
to search by
--organization-label ORGANIZATION_LABEL Organization
label to search by
10.11.3.4. hammer content-view component update
Update a component associated with the content view
Usage:
hammer content-view component update [OPTIONS]
Options:
--component-content-view COMPONENT_CONTENT_VIEW_NAME
Content View name of the component who's latest version is desired
--component-content-view-id COMPONENT_CONTENT_VIEW_ID
93
Content View identifier of the component who's latest version is desired

--component-content-view-version COMPONENT_CONTENT_VIEW_VERSION_VERSION
Content View Version number of the component. Either use this or --
component-content-view-version-id option
--component-content-view-version-id COMPONENT_CONTENT_VIEW_VERSION_ID
Content View Version identifier of the component
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME
Name of the composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID
composite content view identifier
--id ID
content view component ID. Identifier of the component association
--latest
Select the latest version of the components content view is desired
-h, --help
print help
10.11.4. hammer content-view copy

Copy a content view
Usage:
hammer content-view copy [OPTIONS]
Options:
--id ID Content view numeric identifier
--new-name NEW_NAME New content view name
10.11.5. hammer content-view create

Create a content view
Usage:
hammer content-view create [OPTIONS]
Options:
--component-ids COMPONENT_IDS List of component content view
version ids for composite views
Comma separated list of values.
--composite Create a composite content view
--description DESCRIPTION Description for the content view
--label LABEL Content view label
94
--name NAME Name of the content view

--repositories REPOSITORY_NAMES Comma separated list of values.
--repository-ids REPOSITORY_IDS List of repository ids
10.11.6. hammer content-view delete

Delete a content view
Usage:
hammer content-view delete [OPTIONS]
Options:
10.11.7. hammer content-view filter

View and manage filters
Usage:
hammer content-view filter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-repository Associate a resource
create create a filter for a content view
delete delete a filter
info show filter info
list list filters
remove-repository Disassociate a resource
rule View and manage filter rules
update update a filter
Options:
95
10.11.7.1. hammer content-view filter add-repository
Usage:
hammer content-view filter add-repository [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID content view numeric identifier
--id ID filter identifier
10.11.7.2. hammer content-view filter create
create a filter for a content view
Usage:
hammer content-view filter create [OPTIONS]
Options:
--description DESCRIPTION description of the filter
--inclusion INCLUSION specifies if content should be
included or excluded, default:
inclusion=false
--name NAME name of the filter
--original-packages ORIGINAL_PACKAGES add all packages without errata
to the included/excluded list. (package
filter only)
--repository-ids REPOSITORY_IDS list of repository ids
--type TYPE type of filter (e.g. rpm,
package_group, erratum, docker)
96
10.11.7.3. hammer content-view filter delete
delete a filter
Usage:
hammer content-view filter delete [OPTIONS]
Options:
10.11.7.4. hammer content-view filter info
show filter info
Usage:
hammer content-view filter info [OPTIONS]
Options:
10.11.7.5. hammer content-view filter list
list filters
Usage:
hammer content-view filter list [OPTIONS]
Options:
results
--name NAME filter content view filters by
name
DESC'
97

return
--types TYPES types of filters
10.11.7.6. hammer content-view filter remove-repository
Usage:
hammer content-view filter remove-repository [OPTIONS]
Options:
10.11.7.7. hammer content-view filter rule
View and manage filter rules
Usage:
hammer content-view filter rule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a filter rule. The parameters
included should be based upon the filter type.
delete Delete a filter rule
info Show filter rule info
list List filter rules
update Update a filter rule. The parameters
included should be based upon the filter type.
Options:
98
# ===== hammer content-view filter rule create
Create a filter rule. The parameters included should be based upon the filter type.
Usage:
hammer content-view filter rule create [OPTIONS]
Options:
--architecture ARCHITECTURE package: architecture
search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID filter identifier
identifier
--date-type DATE_TYPE erratum: search using
the 'Issued On' or 'Updated On'
column of the errata.
Values are 'issued'/'updated'
--end-date END_DATE erratum: end date (YYYY-
MM-DD)
--errata-id ERRATA_ID erratum: id
--errata-ids ERRATA_IDS erratum: IDs or a select
all object
Comma separated list
of values. Values containing comma should be quoted or escaped with
backslash
--max-version MAX_VERSION package: maximum version
--min-version MIN_VERSION package: minimum version
--name NAME package, package group,
or docker tag names
backslash
--names NAMES Package and package
group names
search by
search by
search by
--start-date START_DATE erratum: start date
(YYYY-MM-DD)
--types TYPES erratum: types
(enhancement, bugfix, security)
backslash
--uuid UUID package group: uuid
--version VERSION package: version
# ===== hammer content-view filter rule delete
Delete a filter rule
99
Usage:
hammer content-view filter rule delete [OPTIONS]
Options:
search by
identifier
--id ID rule identifier
search by
search by
search by
# ===== hammer content-view filter rule info
Show filter rule info
Usage:
hammer content-view filter rule info [OPTIONS]
Options:
search by
identifier
search by
search by
search by
# ===== hammer content-view filter rule list
List filter rules
Usage:
hammer content-view filter rule list [OPTIONS]
Options:
results on
100
search by
identifier
--full-result FULL_RESULT Whether or not to show
all results
One of true/false,
yes/no, 1/0.
--order ORDER Sort field and order,
eg. 'name DESC'
search by
search by
search by
--page PAGE Page number, starting
at 1
--per-page PER_PAGE Number of results per
page to return
# ===== hammer content-view filter rule update
Update a filter rule. The parameters included should be based upon the filter type.
Usage:
hammer content-view filter rule update [OPTIONS]
Options:
--architecture ARCHITECTURE package: architecture
search by
identifier
--end-date END_DATE erratum: end date (YYYY-
MM-DD)
--errata-id ERRATA_ID erratum: id
--max-version MAX_VERSION package: maximum version
--min-version MIN_VERSION package: minimum version
--new-name NEW_NAME package, package group,
or docker tag: name
search by
search by
search by
--start-date START_DATE erratum: start date
(YYYY-MM-DD)
101
--types TYPES erratum: types

(enhancement, bugfix, security)
backslash
--version VERSION package: version
10.11.7.8. hammer content-view filter update
update a filter
Usage:
hammer content-view filter update [OPTIONS]
Options:
--inclusion INCLUSION specifies if content should be
included or excluded, default:
inclusion=false
--new-name NEW_NAME new name for the filter
--original-packages ORIGINAL_PACKAGES add all packages without errata
to the included/excluded list. (package
filter only)
--repository-ids REPOSITORY_IDS list of repository ids
10.11.8. hammer content-view info

Show a content view
Usage:
hammer content-view info [OPTIONS]
Options:
102
10.11.9. hammer content-view list

List content views
Usage:
hammer content-view list [OPTIONS]
Options:
results on
--composite COMPOSITE Filter only
composite content views
One of true/false,
yes/no, 1/0.
show all results
One of true/false,
yes/no, 1/0.
--name NAME Name of the content
view
--noncomposite NONCOMPOSITE Filter out composite
content views
One of true/false,
yes/no, 1/0.
--nondefault NONDEFAULT Filter out default
content views
One of true/false,
yes/no, 1/0.
search by
to search by
starting at 1
per page to return
--without WITHOUT Do not include this
array of content views
Comma separated
list of values. Values containing comma should be quoted or escaped with
backslash
10.11.10. hammer content-view publish

Publish a content view
Usage:
hammer content-view publish [OPTIONS]
103
Options:
--async Do
not wait for the task
Description for the new published content view version
--force-yum-metadata-regeneration FORCE_YUM_METADATA_REGENERATION Force
yum metadata regeneration on the repositories in the content view
version
One
of true/false, yes/no, 1/0.
--id ID
Content view identifier
--name NAME
Content view name to search by
-h, --help
print help
10.11.11. hammer content-view puppet-module

View and manage puppet modules
Usage:
hammer content-view puppet-module [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add Add a puppet module to the content view
list List content view puppet modules
remove Remove a puppet module from the content
view
Options:
10.11.11.1. hammer content-view puppet-module add
Add a puppet module to the content view
Usage:
hammer content-view puppet-module add [OPTIONS]
Options:
--author AUTHOR Puppet module's author to search
104
by
--id ID the id of the puppet module to
associate
--name NAME Puppet module name to search by
--uuid UUID Puppet module's UUID to search
by
10.11.11.2. hammer content-view puppet-module list
List content view puppet modules
Usage:
hammer content-view puppet-module list [OPTIONS]
Options:
--author AUTHOR author of the puppet module
results
--name NAME name of the puppet module
DESC'
return
--uuid UUID the uuid of the puppet module to
associate
10.11.11.3. hammer content-view puppet-module remove
Remove a puppet module from the content view
Usage:
hammer content-view puppet-module remove [OPTIONS]
Options:
--author AUTHOR Puppet module's author to search
by
--id ID puppet module ID
105
--name NAME Puppet module name to search by

--uuid UUID Puppet module's UUID to search
by
10.11.12. hammer content-view purge

Delete old versions of a content view
Usage:
hammer content-view purge [OPTIONS]
Options:
--count COUNT count of unused versions to keep
Default: 3
--id ID Content View numeric identifier
--name NAME Content View name
10.11.13. hammer content-view remove

Remove versions and/or environments from a content view and reassign systems and keys
Usage:
hammer content-view remove [OPTIONS]
Options:
--async Do not wait for
the task
--content-view-version-ids VERSION_IDS Comma separated
list of version ids to remove
--content-view-versions CONTENT_VIEW_VERSION_VERSIONS Comma separated
backslash
--environment-ids ENVIRONMENT_IDS Comma separated
list of environment ids to remove
--environments ENVIRONMENT_NAMES Comma separated
backslash
numeric identifier
--key-content-view-id KEY_CONTENT_VIEW_ID content view to
reassign orphaned activation keys to
--key-environment-id KEY_ENVIRONMENT_ID environment to
reassign orphaned activation keys to
to search by
106

to search by
search by
to search by
--system-content-view-id SYSTEM_CONTENT_VIEW_ID content view to
reassign orphaned systems to
--system-environment-id SYSTEM_ENVIRONMENT_ID environment to
reassign orphaned systems to
10.11.14. hammer content-view remove-from-environment

Remove a content view from an environment
Usage:
hammer content-view remove-from-environment [OPTIONS]
Options:
--async Do not wait for the
task
numeric identifier
to search by
search by
search by
to search by
10.11.15. hammer content-view remove-repository

Usage:
hammer content-view remove-repository [OPTIONS]
Options:
107
10.11.16. hammer content-view remove-version

Remove a content view version from a composite view
Usage:
hammer content-view remove-version [OPTIONS]
Options:
search by
identifier
number
identifier
numeric identifier
to search by
search by
search by
to search by
10.11.17. hammer content-view update

Update a content view
Usage:
hammer content-view update [OPTIONS]
Options:
--component-ids COMPONENT_IDS List of component content view
version ids for composite views
--description DESCRIPTION Description for the content view
--id ID Content view identifier
--new-name NEW_NAME New name for the content view
--repository-ids REPOSITORY_IDS List of repository ids
108
10.11.18. hammer content-view version

View and manage content view versions
Usage:
hammer content-view version [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
delete Remove content view version
export Export a content view version
incremental-update Perform an Incremental Update on one or
more Content View Versions
info Show content view version
list List content view versions
promote Promote a content view version
republish-repositories Forces a republish of the version's
repositories' metadata.
Options:
10.11.18.1. hammer content-view version delete
Remove content view version
Usage:
hammer content-view version delete [OPTIONS]
Options:
--id ID Content view version identifier
--version VERSION Content view version number
10.11.18.2. hammer content-view version export
Export a content view version
Usage:
hammer content-view version export [OPTIONS]
Options:
109

--export-to-iso EXPORT_TO_ISO Export to ISO format
--iso-mb-size ISO_MB_SIZE maximum size of each ISO in MB
--since SINCE Optional date of last export
(ex: 2010-01-01T12:00:00Z)
10.11.18.3. hammer content-view version incremental-update
Perform an Incremental Update on one or more Content View Versions
Usage:
hammer content-view version incremental-update [OPTIONS]
Options:
--async Do not wait for the
task
number
identifier
--description DESCRIPTION The description for
the new generated Content View Versions
--errata-ids ERRATA_IDS Errata ids or uuids
to copy into the new versions.
Comma separated
backslash
--host-ids HOST_IDS IDs of hosts to
update
Comma separated
backslash
--lifecycle-environment-ids ENVIRONMENT_IDS list of lifecycle
environment IDs to update the content view version in
Comma separated
backslash
--lifecycle-environments ENVIRONMENTS list of lifecycle
environment names to update the content view version in
Comma separated
backslash
for resolving lifecycle environment names
--organization-id ORGANIZATION_ID Organization id for
110
resolving lifecycle environment names

--package-ids PACKAGE_IDS Package ids or uuids
to copy into the new versions.
Comma separated
backslash
--packages PACKAGE_NAMES Comma separated list
backslash
--propagate-all-composites PROPAGATE_ALL_COMPOSITES If true, will publish
a new composite version using any specified
content_view_version_id that has been promoted to a lifecycle environment.

One of true/false,
yes/no, 1/0.
--puppet-module-ids PUPPET_MODULE_IDS Puppet Module ids or
uuids to copy into the new versions.
Comma separated
backslash
--puppet-modules PUPPET_MODULE_NAMES Comma separated list
backslash
--resolve-dependencies RESOLVE_DEPENDENCIES If true, when adding
the specified errata or packages, any needed
dependencies will
be copied as well.
One of true/false,
yes/no, 1/0.
--update-all-hosts UPDATE Update all editable
and applicable hosts within the specified Content View and \
Lifecycle Environments
One of true/false,
yes/no, 1/0.
10.11.18.4. hammer content-view version info
Show content view version
Usage:
hammer content-view version info [OPTIONS]
Options:
111
10.11.18.5. hammer content-view version list
List content view versions
Usage:
hammer content-view version list [OPTIONS]
Options:
--by BY Field to sort the results
on
--composite-version-id COMPOSITE_VERSION_ID Filter versions that are
components in the specified composite version
--content-view CONTENT_VIEW_NAME Content view name to search
by
identifier
results
1/0.
--order ORDER Sort field and order, eg.
'name DESC'
--organization ORGANIZATION_NAME Organization name to search
by
--organization-label ORGANIZATION_LABEL Organization label to search
by
--per-page PER_PAGE Number of results per page
to return
--puppet-module PUPPET_MODULE_NAME Name to search by
--puppet-module-id PUPPET_MODULE_ID a puppet module identifier
--version VERSION Filter versions by version
number
10.11.18.6. hammer content-view version promote
Promote a content view version
Usage:
hammer content-view version promote [OPTIONS]
Options:
--async Do
not wait for the task
--content-view CONTENT_VIEW_NAME
Content view name to search by
--content-view-id CONTENT_VIEW_ID
content view numeric identifier
--description DESCRIPTION The
description for the content view version promotion
112
--environment-ids ENVIRONMENT_IDS
Identifiers for Lifecycle Environment
Comma separated list of values. Values containing comma should be quoted

or escaped with backslash
--force
force content view promotion and bypass lifecycle environment restriction
--force-yum-metadata-regeneration FORCE_YUM_METADATA_REGENERATION Force
metadata regeneration on the repositories in the content view version
One
of true/false, yes/no, 1/0.
--from-lifecycle-environment FROM_ENVIRONMENT_ID
Environment name from where to promote its version from (if version is
unknown)
--from-lifecycle-environment-id FROM_ENVIRONMENT_ID Id of
the environment from where to promote its version from (if version is
unknown)
--id ID
Content view version identifier
organization ID
--to-lifecycle-environment TO_ENVIRONMENT Name
of the target environment
--to-lifecycle-environment-id TO_ENVIRONMENT_ID Id of
the target environment
--version VERSION
Content view version number
-h, --help
print help
10.11.18.7. hammer content-view version republish-repositories
Forces a republish of the version’s repositories' metadata.
Usage:
hammer content-view version republish-repositories [OPTIONS]
Options:
10.12. HAMMER CSV
113
import to or export from a running foreman server
Usage:
hammer csv [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
activation-keys import or export activation keys
content-hosts import or export content hosts
export export into directory
import import by directory
settings import or export settings
subscriptions import or export subscriptions
Options:
10.12.1. hammer csv activation-keys

import or export activation keys
Usage:
hammer csv activation-keys [OPTIONS]
Options:
--continue-on-error Continue processing even if individual
resource error
--export Export current data instead of importing
--file FILE_NAME CSV file (default to /dev/stdout with --
export, otherwise required)
--itemized-subscriptions Export one subscription per row, only
process update subscriptions on import
--organization ORGANIZATION Only process organization matching this
name
--search SEARCH Only export search results
-v, --verbose be verbose
10.12.2. hammer csv content-hosts

import or export content hosts
Usage:
hammer csv content-hosts [OPTIONS]
Options:
--clear-subscriptions When processing --itemized-subscriptions,
clear existing subscriptions first
--columns COLUMN_NAMES Comma separated list of column names to
export
114
resource error
--itemized-subscriptions Export one subscription per row, only
process update subscriptions on import
name
Columns:
Name - Name of resource
Search - Search for matching names during import (overrides 'Name'
column)
Organization - Organization name
Environment - Lifecycle environment name
Content View - Content view name
Host Collections - Comma separated list of host collection names
Virtual - Is a virtual host, Yes or No
Guest of Host - Hypervisor host name for virtual hosts
OS - Operating system
Arch - Architecture
Sockets - Number of sockets
RAM - Quantity of RAM in bytes
Cores - Number of cores
SLA - Service Level Agreement value
Products - Comma separated list of products, each of the format "<sku>|
<name>"
Subscriptions - Comma separated list of subscriptions, each of the format
"<quantity>|<sku>|<name>|<contract>|<account>"
Subscription Name - Subscription name (only applicable for --itemized-
subscriptions)
Subscription Type - Subscription type (only applicable for --itemized-
subscriptions)
Subscription Quantity - Subscription quantity (only applicable for --
itemized-subscriptions)
Subscription SKU - Subscription SKU (only applicable for --itemized-
subscriptions)
Subscription Contract - Subscription contract number (only applicable for
--itemized-subscriptions)
Subscription Account - Subscription account number (only applicable for -
-itemized-subscriptions)
Subscription Start - Subscription start date (only applicable for --
itemized-subscriptions)
Subscription End - Subscription end date (only applicable for --itemized-
subscriptions)
10.12.3. hammer csv export

export into directory
Usage:
hammer csv export [OPTIONS]
115
Options:
--dir DIRECTORY directory to export to
name
--settings FILE csv file for settings
10.12.4. hammer csv import

import by directory
Usage:
hammer csv import [OPTIONS]
Options:
--dir DIRECTORY directory to import from
name
--settings FILE csv file for settings
10.12.5. hammer csv settings

import or export settings
Usage:
hammer csv settings [OPTIONS]
Options:
resource error
name
10.12.6. hammer csv subscriptions

import or export subscriptions
Usage:
hammer csv subscriptions [OPTIONS]
Options:
resource error
116

name
10.13. HAMMER DEFAULTS

Defaults management
Usage:
hammer defaults [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add Add a default parameter to config
delete Delete a default param
list List all the default parameters
providers List all the providers
Options:
10.13.1. hammer defaults add

Add a default parameter to config
Usage:
hammer defaults add [OPTIONS]
Options:
--param-name OPTION_NAME The name of the default option (e.g.
organization_id).
--param-value OPTION_VALUE The value for the default option
--provider OPTION_PROVIDER The name of the provider providing the
value. For list available providers see `hammer defaults providers`.
10.13.2. hammer defaults delete

Delete a default param
Usage:
hammer defaults delete [OPTIONS]
117
Options:
--param-name OPTION_NAME The name of the default option
10.13.3. hammer defaults list

List all the default parameters
Usage:
hammer defaults list [OPTIONS]
Options:
10.13.4. hammer defaults providers

List all the providers
Usage:
hammer defaults providers [OPTIONS]
Options:
10.14. HAMMER DISCOVERY

Manipulate discovered hosts.
Usage:
hammer discovery [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
auto-provision Auto provision a host
delete Delete a discovered host
facts List all fact values
info Show a discovered host
list List all discovered hosts
provision Provision a discovered host
reboot Reboot a host
refresh-facts Refresh the facts of a host
Options:
10.14.1. hammer discovery auto-provision

Auto provision a host
118
Usage:
hammer discovery auto-provision [OPTIONS]
Options:
--id ID
10.14.2. hammer discovery delete

Delete a discovered host
Usage:
hammer discovery delete [OPTIONS]
Options:
--id ID
10.14.3. hammer discovery facts

List all fact values
Usage:
hammer discovery facts [OPTIONS]
Options:
--id ID
10.14.4. hammer discovery info

Show a discovered host
Usage:
hammer discovery info [OPTIONS]
Options:
--id ID
10.14.5. hammer discovery list

List all discovered hosts
119
Usage:
hammer discovery list [OPTIONS]
Options:
10.14.6. hammer discovery provision

Provision a discovered host
Usage:
hammer discovery provision [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture
name
--ask-root-password ASK_ROOT_PW One of
true/false, yes/no, 1/0.
--build BUILD One of
--capabilities CAPABILITIES
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or
domain name
--enabled ENABLED One of
--host-parameters-attributes HOST_PARAMETERS_ATTRIBUTES Comma separated
backslash
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID
--image IMAGE_NAME Name to search
by
--image-id IMAGE_ID
--interface INTERFACE Interface
parameters
Comma-
separated list of key=value.
Can be
specified multiple times.
--ip IP not required
if using a subnet with DHCP Capsule
--mac MAC not required if
it's a virtual machine
--managed MANAGED One of
120
--medium MEDIUM_NAME Medium name

--medium-id MEDIUM_ID
--model MODEL_NAME Model name
--model-id MODEL_ID
--name NAME Name to search
by
--new-name NEW_NAME
--operatingsystem OPERATINGSYSTEM_TITLE Operating system
title
--overwrite OVERWRITE One of
--owner-id OWNER_ID
--parameters PARAMS Host parameters
Comma-
--partition-table PARTITION_TABLE_NAME Partition table
name
--partition-table-id PARTITION_TABLE_ID
--progress-report-id PROGRESS_REPORT_ID UUID to track
orchestration tasks status, GET
/api/orchestration/:UUID/tasks
--provision-method METHOD Possible
value(s): 'build', 'image'
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID
--puppet-proxy-id PUPPET_PROXY_ID
--puppetclass-ids PUPPETCLASS_IDS Comma separated
backslash
--pxe-loader PXE_LOADER DHCP filename
option (Grub2 or PXELinux by default)
Possible
value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub
UEFI SecureBoot', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot'
--root-password ROOT_PW
--sp-subnet-id SP_SUBNET_ID
10.14.7. hammer discovery reboot

Reboot a host
Usage:
hammer discovery reboot [OPTIONS]
Options:
--id ID
10.14.8. hammer discovery refresh-facts
121
Refresh the facts of a host
Usage:
hammer discovery refresh-facts [OPTIONS]
Options:
--id ID
10.15. HAMMER DISCOVERY-RULE

Manipulate discovered rules.
Usage:
hammer discovery-rule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a discovery rule
delete Delete a rule
info Show a discovery rule
list List all discovery rules
update Update a rule
Options:
10.15.1. hammer discovery-rule create

Create a discovery rule
Usage:
hammer discovery-rule create [OPTIONS]
Options:
--enabled ENABLED flag is used for temporary
shutdown of rules
1/0.
--hostname HOSTNAME defines a pattern to assign
human-readable hostnames to the matching hosts
--hosts-limit HOSTS_LIMIT
ids
122

--max-count MAX_COUNT enables to limit maximum
amount of provisioned hosts per rule
--name NAME represents rule name shown to
the users
given ids.
--priority PRIORITY puts the rules in order, low
numbers go first. Must be greater then zero
--search SEARCH query to match discovered
hosts for the particular rule
10.15.2. hammer discovery-rule delete

Delete a rule
Usage:
hammer discovery-rule delete [OPTIONS]
Options:
--id ID
10.15.3. hammer discovery-rule info

Show a discovery rule
Usage:
hammer discovery-rule info [OPTIONS]
Options:
--id ID
10.15.4. hammer discovery-rule list

List all discovery rules
Usage:
hammer discovery-rule list [OPTIONS]
Options:
123

10.15.5. hammer discovery-rule update

Update a rule
Usage:
hammer discovery-rule update [OPTIONS]
Options:
--enabled ENABLED flag is used for temporary
shutdown of rules
1/0.
--hostname HOSTNAME defines a pattern to assign
human-readable hostnames to the matching hosts
--hosts-limit HOSTS_LIMIT
--id ID
ids
--max-count MAX_COUNT enables to limit maximum
amount of provisioned hosts per rule
--new-name NEW_NAME represents rule name shown to
the users
given ids.
--priority PRIORITY puts the rules in order, low
numbers go first. Must be greater then zero
--search SEARCH query to match discovered
hosts for the particular rule
10.16. HAMMER DOCKER
124
Manipulate docker content
Usage:
hammer docker [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
container Manage docker containers
manifest Manage docker manifests
registry Manage docker registries
tag Manage docker tags
Options:
10.16.1. hammer docker container

Manage docker containers
Usage:
hammer docker container [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a container
delete Delete a container
info Show a container
list List all containers
logs Show container logs
start Power a container on
status Run power operation on a container
stop Power a container off
Options:
10.16.1.1. hammer docker container create
Create a container
Usage:
hammer docker container create [OPTIONS]
Options:
--attach-stderr ATTACH_STDERR One of true/false, yes/no,
1/0.
--attach-stdin ATTACH_STDIN One of true/false, yes/no,
1/0.
125
--attach-stdout ATTACH_STDOUT One of true/false, yes/no,

1/0.
--capsule CAPSULE_NAME Name to search by
--capsule-id CAPSULE_ID Id of the capsule
--command COMMAND
--cpu-set CPU_SET
--cpu-shares CPU_SHARES
--entrypoint ENTRYPOINT
--environment-variables ENVIRONMENT_VARIABLES Optional array of
environment variables hashes. e.g.
'environment_variables':
[{'name' => 'example',
'value' => '123'}]
--location-ids LOCATION_IDS REPLACE locations with
given ids
--memory MEMORY
--name NAME
given ids.
--registry REGISTRY_NAME Name to search by
--registry-id REGISTRY_ID
--repository-name REPOSITORY_NAME Name of the repository to
use to create the container. e.g. centos
--tag TAG Tag to use to create the
container. e.g. latest
--tty TTY One of true/false,
yes/no, 1/0.
10.16.1.2. hammer docker container delete
Delete a container
Usage:
hammer docker container delete [OPTIONS]
Options:
126
--id ID
10.16.1.3. hammer docker container info
Show a container
Usage:
hammer docker container info [OPTIONS]
Options:
--id ID
10.16.1.4. hammer docker container list
List all containers
Usage:
hammer docker container list [OPTIONS]
Options:
10.16.1.5. hammer docker container logs
Show container logs
Usage:
hammer docker container logs [OPTIONS]
Options:
--id ID
--stderr STDERR One of true/false, yes/no,
1/0.
--stdout STDOUT One of true/false, yes/no,
1/0.
--tail TAIL Number of lines to tail.
Default: 100
127
10.16.1.6. hammer docker container start
Power a container on
Usage:
hammer docker container start [OPTIONS]
Options:
--id ID
10.16.1.7. hammer docker container status
Run power operation on a container
Usage:
hammer docker container status [OPTIONS]
Options:
--id ID
10.16.1.8. hammer docker container stop
Power a container off
Usage:
hammer docker container stop [OPTIONS]
Options:
--id ID
10.16.2. hammer docker manifest

Manage docker manifests
Usage:
hammer docker manifest [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
128
Subcommands:
info Show a docker manifest
list List docker_manifests
Options:
10.16.2.1. hammer docker manifest info
Show a docker manifest
Usage:
hammer docker manifest info [OPTIONS]
Options:
--id ID a docker manifest identifier
10.16.2.2. hammer docker manifest list
List docker_manifests
Usage:
hammer docker manifest list [OPTIONS]
Options:
results on
search by
identifier
number
identifier
show all results
One of true/false,
yes/no, 1/0.
--ids IDS ids to filter
content by
Comma separated
backslash
129
search by
to search by
starting at 1
per page to return
--product PRODUCT_NAME Product name to
search by
--product-id PRODUCT_ID product numeric
identifier
--repository REPOSITORY_NAME Repository name to
search by
10.16.3. hammer docker registry

Manage docker registries
Usage:
hammer docker registry [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a docker registry
delete Delete a docker registry
info Show a docker registry
list List all docker registries
update Update a docker registry
Options:
10.16.3.1. hammer docker registry create
Create a docker registry
Usage:
hammer docker registry create [OPTIONS]
Options:
ids
130

--name NAME
given ids.
--password PASSWORD
--url URL
--username USERNAME
10.16.3.2. hammer docker registry delete
Delete a docker registry
Usage:
hammer docker registry delete [OPTIONS]
Options:
--id ID
10.16.3.3. hammer docker registry info
Show a docker registry
Usage:
hammer docker registry info [OPTIONS]
Options:
--id ID
10.16.3.4. hammer docker registry list
List all docker registries
Usage:
hammer docker registry list [OPTIONS]
Options:
131
10.16.3.5. hammer docker registry update
Update a docker registry
Usage:
hammer docker registry update [OPTIONS]
Options:
--id ID
ids
--new-name NEW_NAME
given ids.
--password PASSWORD
--url URL
--username USERNAME
10.16.4. hammer docker tag

Manage docker tags
Usage:
hammer docker tag [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show a docker tag
list List docker_tags
Options:
10.16.4.1. hammer docker tag info
Show a docker tag
132
Usage:
hammer docker tag info [OPTIONS]
Options:
--id ID a docker tag identifier
10.16.4.2. hammer docker tag list
List docker_tags
Usage:
hammer docker tag list [OPTIONS]
Options:
results on
search by
identifier
number
identifier
show all results
One of true/false,
yes/no, 1/0.
content by
Comma separated
backslash
search by
to search by
starting at 1
per page to return
search by
133
identifier
search by
10.17. HAMMER DOMAIN

Manipulate domains.
Usage:
hammer domain [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a domain
delete Delete a domain
delete-parameter Delete parameter for a domain.
info Show a domain
list List of domains
set-parameter Create or update parameter for a domain.
update Update a domain
Options:
10.17.1. hammer domain create

Create a domain
Usage:
hammer domain create [OPTIONS]
Options:
--description DESC Full name describing the
domain
--dns DNS_NAME Name of DNS proxy to use
within this domain
--dns-id DNS_ID ID of DNS proxy to use within
this domain
ids
--name NAME The full DNS domain name
134
given ids.
10.17.2. hammer domain delete

Delete a domain
Usage:
hammer domain delete [OPTIONS]
Options:
--id ID
--name NAME Domain name
10.17.3. hammer domain delete-parameter

Delete parameter for a domain.
Usage:
hammer domain delete-parameter [OPTIONS]
Options:
--domain-id DOMAIN_ID Numerical ID or domain name
--name NAME parameter name
10.17.4. hammer domain info

Show a domain
Usage:
hammer domain info [OPTIONS]
Options:
--id ID Numerical ID or domain
name
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter
values
One of true/false,
yes/no, 1/0.
10.17.5. hammer domain list
135
List of domains
Usage:
hammer domain list [OPTIONS]
Options:
10.17.6. hammer domain set-parameter

Create or update parameter for a domain.
Usage:
hammer domain set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE should the value be hidden
--value VALUE parameter value
10.17.7. hammer domain update

Update a domain
Usage:
hammer domain update [OPTIONS]
Options:
--description DESC Full name describing the
domain
--dns DNS_NAME Name of DNS proxy to use
within this domain
--dns-id DNS_ID ID of DNS proxy to use within
this domain
--id ID
ids
136

--new-name NEW_NAME The full DNS domain name
given ids.
10.18. HAMMER ENVIRONMENT

Manipulate environments.
Usage:
hammer environment [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create an environment
delete Delete an environment
info Show an environment
list List all environments
sc-params List all smart class parameters
update Update an environment
Options:
10.18.1. hammer environment create

Create an environment
Usage:
hammer environment create [OPTIONS]
Options:
ids
137

--name NAME
given ids.
10.18.2. hammer environment delete

Delete an environment
Usage:
hammer environment delete [OPTIONS]
Options:
--id ID
--name NAME Environment name
10.18.3. hammer environment info

Show an environment
Usage:
hammer environment info [OPTIONS]
Options:
--id ID
10.18.4. hammer environment list

List all environments
Usage:
hammer environment list [OPTIONS]
Options:
138
--puppet-class PUPPET_CLASS_NAME Puppet class name

--puppet-class-id PUPPET_CLASS_ID ID of Puppet class
10.18.5. hammer environment sc-params

List all smart class parameters
Usage:
hammer environment sc-params [OPTIONS]
Options:
--show-hidden SHOW_HIDDEN Display hidden values
10.18.6. hammer environment update

Update an environment
Usage:
hammer environment update [OPTIONS]
Options:
--id ID
ids
--new-name NEW_NAME
given ids.
10.19. HAMMER ERRATUM
139
Manipulate errata
Usage:
hammer erratum [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show an erratum
list List errata
Options:
10.19.1. hammer erratum info

Show an erratum
Usage:
hammer erratum info [OPTIONS]
Options:
--id ID an erratum identifier
10.19.2. hammer erratum list

List errata
Usage:
hammer erratum list [OPTIONS]
Options:
--by BY Field to
sort the results on
--content-view CONTENT_VIEW_NAME Content view
name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search
by
--content-view-filter-id CONTENT_VIEW_FILTER_ID filter
identifier
--content-view-id CONTENT_VIEW_ID content view
numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view
version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view
version identifier
--cve CVE CVE
identifier
140
--environment ENVIRONMENT_NAME Environment

name
--errata-restrict-applicable ERRATA_RESTRICT_APPLICABLE show only
errata with one or more applicable hosts
One of
--errata-restrict-installable ERRATA_RESTRICT_INSTALLABLE show only
errata with one or more installable hosts
One of
--full-result FULL_RESULT Whether or
not to show all results
One of
--order ORDER Sort field
and order, eg. 'name DESC'
name to search by
--organization-id ORGANIZATION_ID organization
ID
label to search by
starting at 1
--per-page PER_PAGE Number of
results per page to return
--product PRODUCT_NAME Product name
to search by
--product-id PRODUCT_ID product
numeric identifier
--repository REPOSITORY_NAME Repository
name to search by
10.20. HAMMER FACT

Search facts.
Usage:
hammer fact [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
list List all fact values
Options:
141
10.20.1. hammer fact list

Usage:
hammer fact list [OPTIONS]
Options:
10.21. HAMMER FILE

Manipulate files
Usage:
hammer file [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show a file
list List files
Options:
10.21.1. hammer file info

Show a file
Usage:
hammer file info [OPTIONS]
Options:
search by
identifier
number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content View Version
ID
--id ID a file identifier
--name NAME File name to search
by
search by
142

to search by
search by
identifier
search by
--repository-id REPOSITORY_ID Repository ID
10.21.2. hammer file list

List files
Usage:
hammer file list [OPTIONS]
Options:
results on
search by
identifier
number
identifier
show all results
One of true/false,
yes/no, 1/0.
content by
Comma separated
backslash
search by
to search by
starting at 1
per page to return
search by
143

identifier
search by
10.22. HAMMER FILTER

Manage permission filters.
Usage:
hammer filter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
available-permissions List all permissions
available-resources List available resource types.
create Create a filter
delete Delete a filter
info Show a filter
list List all filters
update Update a filter
Options:
10.22.1. hammer filter available-permissions

List all permissions
Usage:
hammer filter available-permissions [OPTIONS]
Options:
--name NAME
--resource-type RESOURCE_TYPE
10.22.2. hammer filter available-resources

List available resource types.
Usage:
hammer filter available-resources [OPTIONS]
144
Options:
10.22.3. hammer filter create

Create a filter
Usage:
hammer filter create [OPTIONS]
Options:
--location-ids LOCATION_IDS Comma separated list of
--organization-ids ORGANIZATION_IDS Comma separated list of values.
--override OVERRIDE One of true/false, yes/no,
1/0.
--permission-ids PERMISSION_IDS Comma separated list of
--permissions PERMISSION_NAMES Comma separated list of
--role ROLE_NAME User role name
--role-id ROLE_ID
--search SEARCH
Overriding organizations and locations:
Filters inherit organizations and locations from its role by default. This
behavior can be changed by setting --override=true
Therefore options --organization[s|-ids] and --location[s|-ids] are
applicable only when the override flag is set.
10.22.4. hammer filter delete

Delete a filter
Usage:
hammer filter delete [OPTIONS]
Options:
--id ID
145
10.22.5. hammer filter info

Show a filter
Usage:
hammer filter info [OPTIONS]
Options:
--id ID
10.22.6. hammer filter list

List all filters
Usage:
hammer filter list [OPTIONS]
Options:
10.22.7. hammer filter update

Update a filter
Usage:
hammer filter update [OPTIONS]
Options:
--id ID
--location-ids LOCATION_IDS Comma separated list of
--organization-ids ORGANIZATION_IDS Comma separated list of values.
--override OVERRIDE One of true/false, yes/no,
1/0.
--permission-ids PERMISSION_IDS Comma separated list of
--permissions PERMISSION_NAMES Comma separated list of
--role-id ROLE_ID
146
--search SEARCH
Overriding organizations and locations:
Filters inherit organizations and locations from its role by default. This
behavior can be changed by setting --override=true
Therefore options --organization[s|-ids] and --location[s|-ids] are
applicable only when the override flag is set.
10.23. HAMMER FOREIGN-INPUT-SET

Manage foreign input sets
Usage:
hammer foreign-input-set [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a foreign input set
delete Delete a foreign input set
info Show foreign input set details
list List foreign input sets
update Update a foreign input set
Options:
10.23.1. hammer foreign-input-set create

Create a foreign input set
Usage:
hammer foreign-input-set create [OPTIONS]
Options:
--description DESCRIPTION Input set description
--exclude EXCLUDE A comma separated list of input
names to be included from the foreign
template.
--include INCLUDE A comma separated list of input
template.
--include-all INCLUDE_ALL Include all inputs from the
foreign template
--target-template-id TARGET_TEMPLATE_ID Target template ID
--template-id TEMPLATE_ID
147
10.23.2. hammer foreign-input-set delete

Delete a foreign input set
Usage:
hammer foreign-input-set delete [OPTIONS]
Options:
--id ID
10.23.3. hammer foreign-input-set info

Show foreign input set details
Usage:
hammer foreign-input-set info [OPTIONS]
Options:
--id ID
10.23.4. hammer foreign-input-set list

List foreign input sets
Usage:
hammer foreign-input-set list [OPTIONS]
Options:
10.23.5. hammer foreign-input-set update

Update a foreign input set
Usage:
hammer foreign-input-set update [OPTIONS]
Options:
--description DESCRIPTION Input set description
--exclude EXCLUDE A comma separated list of input
template.
148
--id ID
--include INCLUDE A comma separated list of input
template.
--include-all INCLUDE_ALL Include all inputs from the
foreign template
--new-name NEW_NAME
--target-template-id TARGET_TEMPLATE_ID Target template ID
10.24. HAMMER FULL-HELP

Print help for all hammer commands
Usage:
hammer full-help [OPTIONS]
Options:
--md Format output in markdown
10.25. HAMMER GLOBAL-PARAMETER

Manipulate global parameters.
Usage:
hammer global-parameter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
delete Delete a global parameter
list List all global parameters.
set Set a global parameter.
Options:
10.25.1. hammer global-parameter delete

Delete a global parameter
Usage:
hammer global-parameter delete [OPTIONS]
Options:
--name NAME Common parameter name
149
10.25.2. hammer global-parameter list

List all global parameters.
Usage:
hammer global-parameter list [OPTIONS]
Options:
10.25.3. hammer global-parameter set

Set a global parameter.
Usage:
hammer global-parameter set [OPTIONS]
Options:
10.26. HAMMER GPG

Manipulate GPG Key actions on the server
Usage:
hammer gpg [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a gpg key
delete Destroy a gpg key
info Show a gpg key
list List gpg keys
update Update a repository
Options:
10.26.1. hammer gpg create
150
Create a gpg key
Usage:
hammer gpg create [OPTIONS]
Options:
--key GPG_KEY_FILE GPG Key file
--name NAME identifier of the gpg key
10.26.2. hammer gpg delete

Destroy a gpg key
Usage:
hammer gpg delete [OPTIONS]
Options:
--id ID gpg key numeric identifier
10.26.3. hammer gpg info

Show a gpg key
Usage:
hammer gpg info [OPTIONS]
Options:
10.26.4. hammer gpg list

List gpg keys
Usage:
hammer gpg list [OPTIONS]
Options:
151
results
--name NAME name of the GPG key
DESC'
return
10.26.5. hammer gpg update

Update a repository
Usage:
hammer gpg update [OPTIONS]
Options:
--key GPG_KEY_FILE GPG Key file
--new-name NEW_NAME identifier of the gpg key
10.27. HAMMER HOST

Manipulate hosts.
Usage:
hammer host [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a host
delete Delete a host
delete-parameter Delete parameter for a host.
errata Manage errata on your hosts
facts List all fact values
info Show a host
interface View and manage host's network interfaces
list List all hosts
package Manage packages on your hosts
package-group Manage package-groups on your hosts
puppet-classes List all Puppet classes
152
puppetrun Force a Puppet agent run on the host

reboot Reboot a host
rebuild-config Rebuild orchestration related
configurations for host
reports List all reports
set-parameter Create or update parameter for a host.
smart-variables List all smart variables
start Power a host on
status Get configuration status of host
stop Power a host off
subscription Manage subscription information on your
hosts
update Update a host
Options:
10.27.1. hammer host create

Create a host
Usage:
hammer host create [OPTIONS]
Options:
--ask-root-password ASK_ROOT_PW One of true/false,
yes/no, 1/0.
--autoheal AUTOHEAL Sets whether the
Host will autoheal subscriptions upon checkin
One of true/false,
yes/no, 1/0.
--build BUILD One of true/false,
yes/no, 1/0.
Default: "true"
--comment COMMENT Additional
information about this host
--compute-attributes COMPUTE_ATTRS Compute resource
attributes.
Comma-separated
list of key=value.
--compute-profile COMPUTE_PROFILE_NAME Name to search by
--compute-profile-id COMPUTE_PROFILE_ID
--config-group-ids CONFIG_GROUP_IDS IDs of associated
config groups
Comma separated
backslash
--config-groups CONFIG_GROUP_NAMES Comma separated list
backslash
153
--content-source-id CONTENT_SOURCE_ID
--content-view CONTENT_VIEW_NAME Name to search by
identifier
domain name
--enabled ENABLED One of true/false,
yes/no, 1/0.
Default: "true"
--hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS List of hypervisor
guest uuids
Comma separated
backslash
--image IMAGE_NAME Name to search by
--image-id IMAGE_ID
parameters.
Comma-separated
list of key=value.
Can be specified
multiple times.
--ip IP not required if
using a subnet with DHCP Capsule
--kickstart-repository-id KICKSTART_REPOSITORY_ID Repository Id
associated with the kickstart repo used for provisioning
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID ID of the environment
--mac MAC required for
managed host that is bare metal, not required if it's a
virtual machine
--managed MANAGED One of true/false,
yes/no, 1/0.
Default: "true"
--model-id MODEL_ID
--name NAME
--openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP
Capsule
title
154
--overwrite OVERWRITE One of true/false,

yes/no, 1/0.
Default: "true"
--owner OWNER_LOGIN Login of the owner
--owner-id OWNER_ID ID of the owner
--owner-type OWNER_TYPE Host's owner type
Possible value(s):
'User', 'Usergroup'
--parameters PARAMS Host parameters.
Comma-separated
list of key=value.
--partition-table PARTITION_TABLE_NAME Partition table name
--provision-method METHOD Possible value(s):
'build', 'image'
--puppet-ca-proxy PUPPET_CA_PROXY_NAME
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list
backslash
--puppet-classes PUPPET_CLASS_NAMES Comma separated list
backslash
--puppet-proxy PUPPET_PROXY_NAME
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID
--pxe-loader PXE_LOADER DHCP filename option
(Grub2/PXELinux by default)
Possible value(s):
'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub UEFI
SecureBoot', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot'
--realm REALM_NAME Name to search by
--realm-id REALM_ID Numerical ID or
realm name
--release-version RELEASE_VERSION Release version for
this Host to use (7Server, 7.1, etc)
--root-password, --root-pass ROOT_PW Required if host is
managed and value is not inherited from host group or default password in
settings (--root-pass is deprecated: Use --root-password instead)
--service-level SERVICE_LEVEL Service level to be
used for autoheal.
--volume VOLUME Volume parameters
Comma-separated
list of key=value.
Can be specified
multiple times.
Available keys for --interface:

mac
ip
155
type Possible values: interface, bmc, bond, bridge

name
subnet_id
domain_id
identifier
managed true/false
primary true/false, each managed hosts needs to have one
primary interface.
provision true/false
virtual true/false
For virtual=true:
subnet VLAN ID. Only for virtual interfaces.
attached_to Identifier of the interface to which this
interface belongs, e.g. eth1.
For type=bond:
mode Possible values: balance-rr, active-backup,
balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb
attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2]
bond_options
For type=bmc:
provider always IPMI
username
password
Provider specific options:

EC2:
--compute-attributes:
flavor_id
image_id
availability_zone
security_group_ids
managed_ip
GCE:
machine_type
image_id
network
external_ip
Libvirt:
cpus Number of CPUs
memory String, amount of memory, value in bytes
start Boolean (expressed as 0 or 1), whether to start
the machine or not
--interface:
compute_type Possible values: bridge, network
compute_network / compute_bridge Name of interface according to
type
compute_model Possible values: virtio, rtl8139,
156
ne2k_pci, pcnet, e1000
--volume:
pool_name One of available storage pools
capacity String value, eg. 10G
format_type Possible values: raw, qcow2
OpenStack:
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
cluster
template Hardware profile to use
cores Integer value, number of cores
memory Amount of memory, integer value in bytes
the machine or not
--interface:
compute_name Eg. eth0
compute_network Select one of available networks for a cluster
--volume:
size_gb Volume size in GB, integer value
storage_domain Select one of available storage domains
bootable Boolean, only one volume can be bootable
Rackspace:
flavor_id
image_id
VMWare:
cpus Cpu count
corespersocket Number of cores per socket (applicable to
hardware versions < 10 only)
memory_mb Integer number, amount of memory in MB
cluster Cluster id from VMware
path Path to folder
guest_id Guest OS id form VMware
scsi_controller_type Id of the controller from VMware
hardware_version Hardware version id from VMware
start Must be a 1 or 0, whether to start the
machine or not
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet,
VirtualVmxnet2,
157
VirtualVmxnet3,
VirtualE1000,
VirtualE1000e,
VirtualPCNet32
See documentation center for your version of
vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network id from VMware
--volume:
name
datastore Datastore id from VMware
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
10.27.2. hammer host delete

Delete a host
Usage:
hammer host delete [OPTIONS]
Options:
--id ID
--name NAME Host name
10.27.3. hammer host delete-parameter

Delete parameter for a host.
Usage:
hammer host delete-parameter [OPTIONS]
Options:
--host-id HOST_ID
10.27.4. hammer host errata

Manage errata on your hosts
Usage:
hammer host errata [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
158
apply Schedule errata for installation

info Retrieve a single errata for a host
list List errata available for the content host
Options:
10.27.4.1. hammer host errata apply
Schedule errata for installation
Usage:
hammer host errata apply [OPTIONS]
Options:
--errata-ids ERRATA_IDS List of Errata ids to install
--host-id HOST_ID
10.27.4.2. hammer host errata info
Retrieve a single errata for a host
Usage:
hammer host errata info [OPTIONS]
Options:
--host-id HOST_ID
--id ID Errata id of the erratum (RHSA-2012:108)
10.27.4.3. hammer host errata list
List errata available for the content host
Usage:
hammer host errata list [OPTIONS]
Options:
--full-result FULL_RESULT Whether or not to show all results
--host-id HOST_ID
159
--order ORDER Sort field and order, eg. 'name DESC'

--per-page PER_PAGE Number of results per page to return
10.27.5. hammer host facts

Usage:
hammer host facts [OPTIONS]
Options:
--id ID
10.27.6. hammer host info

Show a host
Usage:
hammer host info [OPTIONS]
Options:
--id ID
values
One of true/false,
yes/no, 1/0.
10.27.7. hammer host interface

View and manage host’s network interfaces
Usage:
hammer host interface [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create an interface on a host
delete Delete a host's interface
info Show an interface for host
160
list List all interfaces for host

update Update a host's interface
Options:
10.27.7.1. hammer host interface create
Create an interface on a host
Usage:
hammer host interface create [OPTIONS]
Options:
--attached-devices ATTACHED_DEVICES Identifiers of attached interfaces,
e.g. `['eth1',
'eth2']`. For bond interfaces those
are the slaves. Only for bond
and bridges interfaces.
--attached-to ATTACHED_TO Identifier of the interface to which
this interface belongs, e.g. eth1.
Only for virtual interfaces.
--bond-options BOND_OPTIONS Space separated options, e.g.
miimon=100. Only for bond interfaces.
--compute-attributes COMPUTE_ATTRS Compute resource specific attributes.
Comma-separated list of key=value.
--host-id HOST_ID
--identifier IDENTIFIER Device identifier, e.g. eth0 or
eth1.1
--ip IP IPv4 address of interface
--ip6 IP6 IPv6 address of interface
--mac MAC MAC address of interface. Required
for managed interfaces on bare metal.
--managed MANAGED Should this interface be managed via
DHCP and DNS capsule and should it be
configured during provisioning?
--mode MODE Bond mode of the interface, e.g.
balance-rr. Only for bond interfaces.
Possible value(s): 'balance-rr',
'active-backup', 'balance-xor', 'broadcast', '802.3ad', 'balance-tlb',
'balance-alb'
--name NAME Interface's DNS name
--password PASSWORD Only for BMC interfaces.
--primary Should this interface be used for
constructing the FQDN of the host? Each managed hosts needs to have one
primary interface.
--provider PROVIDER Interface provider, e.g. IPMI. Only
for BMC interfaces.
Possible value(s): 'IPMI', 'SSH'
161
--provision Should this interface be used for

TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs
to have one provision interface.
--subnet6-id SUBNET6_ID Satellite subnet ID of IPv6
interface
--tag TAG VLAN tag, this attribute has
precedence over the subnet VLAN ID. Only for
virtual interfaces.
--type TYPE Interface type, e.g. bmc. Default is
interface
Possible value(s): 'interface',
'bmc', 'bond', 'bridge'
--username USERNAME Only for BMC interfaces.
--virtual VIRTUAL Alias or VLAN device
10.27.7.2. hammer host interface delete
Delete a host’s interface
Usage:
hammer host interface delete [OPTIONS]
Options:
--host-id HOST_ID
--id ID ID of interface
10.27.7.3. hammer host interface info
Show an interface for host
Usage:
hammer host interface info [OPTIONS]
Options:
--host-id HOST_ID
--id ID ID or name of interface
10.27.7.4. hammer host interface list
List all interfaces for host
Usage:
hammer host interface list [OPTIONS]
Options:
162

--host-id HOST_ID
10.27.7.5. hammer host interface update
Update a host’s interface
Usage:
hammer host interface update [OPTIONS]
Options:
--attached-devices ATTACHED_DEVICES Identifiers of attached interfaces,
e.g. `['eth1',
'eth2']`. For bond interfaces those
are the slaves. Only for bond
and bridges interfaces.
--attached-to ATTACHED_TO Identifier of the interface to which
this interface belongs, e.g. eth1.
Only for virtual interfaces.
--bond-options BOND_OPTIONS Space separated options, e.g.
miimon=100. Only for bond interfaces.
--compute-attributes COMPUTE_ATTRS Compute resource specific attributes.
Comma-separated list of key=value.
--host-id HOST_ID
--id ID ID of interface
--identifier IDENTIFIER Device identifier, e.g. eth0 or
eth1.1
--ip IP IPv4 address of interface
--ip6 IP6 IPv6 address of interface
--mac MAC MAC address of interface. Required
for managed interfaces on bare metal.
--managed MANAGED Should this interface be managed via
DHCP and DNS capsule and should it be
configured during provisioning?
--mode MODE Bond mode of the interface, e.g.
balance-rr. Only for bond interfaces.
Possible value(s): 'balance-rr',
'active-backup', 'balance-xor', 'broadcast', '802.3ad', 'balance-tlb',
'balance-alb'
--name NAME Interface's DNS name
--password PASSWORD Only for BMC interfaces.
--primary Should this interface be used for
constructing the FQDN of the host? Each managed hosts needs to have one
163
primary interface.
--provider PROVIDER Interface provider, e.g. IPMI. Only
for BMC interfaces.
Possible value(s): 'IPMI', 'SSH'
--provision Should this interface be used for
TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs
to have one provision interface.
--subnet6-id SUBNET6_ID Satellite subnet ID of IPv6
interface
--tag TAG VLAN tag, this attribute has
precedence over the subnet VLAN ID. Only for
virtual interfaces.
--type TYPE Interface type, e.g. bmc. Default is
interface
Possible value(s): 'interface',
'bmc', 'bond', 'bridge'
--username USERNAME Only for BMC interfaces.
--virtual VIRTUAL Alias or VLAN device
10.27.8. hammer host list

List all hosts
Usage:
hammer host list [OPTIONS]
Options:
10.27.9. hammer host package

Manage packages on your hosts
Usage:
hammer host package [OPTIONS] SUBCOMMAND [ARG] ...
164
Parameters:
Subcommands:
install Install packages remotely
list List packages installed on the host
remove Uninstall packages remotely
upgrade Update packages remotely
upgrade-all Update packages remotely
Options:
10.27.9.1. hammer host package install
Install packages remotely
Usage:
hammer host package install [OPTIONS]
Options:
--host-id HOST_ID
--packages PACKAGES List of package names
10.27.9.2. hammer host package list
List packages installed on the host
Usage:
hammer host package list [OPTIONS]
Options:
--host-id HOST_ID
10.27.9.3. hammer host package remove
Uninstall packages remotely
165
Usage:
hammer host package remove [OPTIONS]
Options:
--host-id HOST_ID
--packages PACKAGES List of package names
10.27.9.4. hammer host package upgrade
Update packages remotely
Usage:
hammer host package upgrade [OPTIONS]
Options:
--host-id HOST_ID
--packages PACKAGES list of packages names
10.27.9.5. hammer host package upgrade-all
Update packages remotely
Usage:
hammer host package upgrade-all [OPTIONS]
Options:
--host-id HOST_ID
10.27.10. hammer host package-group

Manage package-groups on your hosts
Usage:
hammer host package-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
166
install Install packages remotely

remove Uninstall packages remotely
Options:
10.27.10.1. hammer host package-group install
Install packages remotely
Usage:
hammer host package-group install [OPTIONS]
Options:
--groups GROUPS List of package group names
--host-id HOST_ID
10.27.10.2. hammer host package-group remove
Uninstall packages remotely
Usage:
hammer host package-group remove [OPTIONS]
Options:
--groups GROUPS List of package group names
--host-id HOST_ID
10.27.11. hammer host puppet-classes

List all Puppet classes
Usage:
hammer host puppet-classes [OPTIONS]
Options:
--host-id HOST_ID
167
10.27.12. hammer host puppetrun

Force a Puppet agent run on the host
Usage:
hammer host puppetrun [OPTIONS]
Options:
--id ID
10.27.13. hammer host reboot

Reboot a host
Usage:
hammer host reboot [OPTIONS]
Options:
--id ID
10.27.14. hammer host rebuild-config

Rebuild orchestration related configurations for host
Usage:
hammer host rebuild-config [OPTIONS]
Options:
--id ID
--only ONLY Limit rebuild steps, valid steps are DHCP,
DNS, TFTP
10.27.15. hammer host reports

List all reports
Usage:
hammer host reports [OPTIONS]
Options:
--id ID Host id
168

10.27.16. hammer host sc-params

Usage:
hammer host sc-params [OPTIONS]
Options:
--host-id HOST_ID
10.27.17. hammer host set-parameter

Create or update parameter for a host.
Usage:
hammer host set-parameter [OPTIONS]
Options:
--host-id HOST_ID
10.27.18. hammer host smart-variables

List all smart variables
Usage:
hammer host smart-variables [OPTIONS]
Options:
--host-id HOST_ID
169

10.27.19. hammer host start

Power a host on
Usage:
hammer host start [OPTIONS]
Options:
--id ID
10.27.20. hammer host status

Get configuration status of host
Usage:
hammer host status [OPTIONS]
Options:
--id ID
10.27.21. hammer host stop

Power a host off
Usage:
hammer host stop [OPTIONS]
Options:
--force Force turning off a host
--id ID
10.27.22. hammer host subscription

Manage subscription information on your hosts
Usage:
hammer host subscription [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
170
Subcommands:
attach Add a subscription to a host
auto-attach Trigger an auto-attach of subscriptions
content-override Override product content defaults
product-content List associated products
register Register a host with subscription and
information.
remove
unregister Unregister the host as a subscription
consumer
Options:
10.27.22.1. hammer host subscription attach
Add a subscription to a host
Usage:
hammer host subscription attach [OPTIONS]
Options:
--host-id HOST_ID
--quantity Quantity Quantity of this subscriptions to add.
Defaults to 1
10.27.22.2. hammer host subscription auto-attach
Trigger an auto-attach of subscriptions
Usage:
hammer host subscription auto-attach [OPTIONS]
Options:
--host-id HOST_ID
10.27.22.3. hammer host subscription content-override
Override product content defaults
Usage:
hammer host subscription content-override [OPTIONS]
Options:
--content-label CONTENT_LABEL Label of the content
--host-id HOST_ID
--override-name OVERRIDE_NAME Override parameter key or name.
To enable or disable a repo select
171
'enabled'.
Default value: enabled
Default: "enabled"
--remove Remove a content override
--value VALUE Override value. Note for repo enablement
you can use a boolean value
10.27.22.4. hammer host subscription product-content
List associated products
Usage:
hammer host subscription product-content [OPTIONS]
Options:
--content-access-mode-all CONTENT_ACCESS_MODE_ALL Get all content
available, not just that provided by subscriptions
One of true/false,
yes/no, 1/0.
--content-access-mode-env CONTENT_ACCESS_MODE_ENV Limit content to just
that available in the host's content view version
One of true/false,
yes/no, 1/0.
--host-id HOST_ID
10.27.22.5. hammer host subscription register
Register a host with subscription and information.
Usage:
hammer host subscription register [OPTIONS]
Options:
search by
identifier
--hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS UUIDs of the virtual
guests from the host's hypervisor
Comma separated
backslash
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment
name to search by
--name NAME Name of the host
search by
search by
172
to search by
--release-version RELEASE_VERSION Release version of
the content host
--service-level SERVICE_LEVEL A service level for
auto-healing process, e.g. SELF-SUPPORT
--uuid UUID UUID to use for
registered host, random uuid is generated if not provided
10.27.22.6. hammer host subscription remove
Usage:
hammer host subscription remove [OPTIONS]
Options:
--host-id HOST_ID
--quantity Quantity Remove the first instance of a
subscription with matching id and quantity
10.27.22.7. hammer host subscription unregister
Unregister the host as a subscription consumer
Usage:
hammer host subscription unregister [OPTIONS]
Options:
--host-id HOST_ID
10.27.23. hammer host update

Update a host
Usage:
hammer host update [OPTIONS]
Options:
--ask-root-password ASK_ROOT_PW One of true/false,
yes/no, 1/0.
--autoheal AUTOHEAL Sets whether the
Host will autoheal subscriptions upon checkin
One of true/false,
yes/no, 1/0.
--build BUILD One of true/false,
yes/no, 1/0.
--comment COMMENT Additional
173
information about this host

--compute-attributes COMPUTE_ATTRS Compute resource
attributes.
Comma-separated
list of key=value.
--compute-profile COMPUTE_PROFILE_NAME Name to search by
--config-group-ids CONFIG_GROUP_IDS IDs of associated
config groups
Comma separated
backslash
--config-groups CONFIG_GROUP_NAMES Comma separated list
backslash
--content-source-id CONTENT_SOURCE_ID
--content-view CONTENT_VIEW_NAME Name to search by
identifier
domain name
--enabled ENABLED One of true/false,
yes/no, 1/0.
--hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS List of hypervisor
guest uuids
Comma separated
backslash
--id ID
--image IMAGE_NAME Name to search by
--image-id IMAGE_ID
parameters.
Comma-separated
list of key=value.
Can be specified
multiple times.
--ip IP not required if
using a subnet with DHCP Capsule
--kickstart-repository-id KICKSTART_REPOSITORY_ID Repository Id
associated with the kickstart repo used for provisioning
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
--mac MAC required for
managed host that is bare metal, not required if it's a
174
virtual machine
--managed MANAGED One of true/false,
yes/no, 1/0.
--model-id MODEL_ID
--new-name NEW_NAME
Capsule
title
--overwrite OVERWRITE One of true/false,
yes/no, 1/0.
--owner OWNER_LOGIN Login of the owner
--owner-id OWNER_ID ID of the owner
--owner-type OWNER_TYPE Host's owner type
Possible value(s):
'User', 'Usergroup'
--parameters PARAMS Host parameters.
Comma-separated
list of key=value.
--provision-method METHOD Possible value(s):
'build', 'image'
--puppet-ca-proxy PUPPET_CA_PROXY_NAME
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list
backslash
--puppet-classes PUPPET_CLASS_NAMES Comma separated list
backslash
--puppet-proxy PUPPET_PROXY_NAME
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID
--pxe-loader PXE_LOADER DHCP filename option
(Grub2/PXELinux by default)
Possible value(s):
'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub UEFI
SecureBoot', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot'
--realm REALM_NAME Name to search by
--realm-id REALM_ID Numerical ID or
realm name
--release-version RELEASE_VERSION Release version for
this Host to use (7Server, 7.1, etc)
--root-password, --root-pass ROOT_PW Required if host is
175
managed and value is not inherited from host group or default password in
settings (--root-pass is deprecated: Use --root-password instead)
--service-level SERVICE_LEVEL Service level to be
used for autoheal.
--volume VOLUME Volume parameters
Comma-separated
list of key=value.
Can be specified
multiple times.
Available keys for --interface:

mac
ip
type Possible values: interface, bmc, bond, bridge
name
subnet_id
domain_id
identifier
managed true/false
primary true/false, each managed hosts needs to have one
primary interface.
provision true/false
virtual true/false
For virtual=true:
subnet VLAN ID. Only for virtual interfaces.
attached_to Identifier of the interface to which this
interface belongs, e.g. eth1.
For type=bond:
mode Possible values: balance-rr, active-backup,
balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb
attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2]
bond_options
For type=bmc:
provider always IPMI
username
password
Provider specific options:

EC2:
flavor_id
image_id
availability_zone
security_group_ids
managed_ip
GCE:
machine_type
176
image_id
network
external_ip
Libvirt:
cpus Number of CPUs
memory String, amount of memory, value in bytes
the machine or not
--interface:
compute_type Possible values: bridge, network
compute_network / compute_bridge Name of interface according to
type
compute_model Possible values: virtio, rtl8139,
ne2k_pci, pcnet, e1000
--volume:
pool_name One of available storage pools
capacity String value, eg. 10G
format_type Possible values: raw, qcow2
OpenStack:
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
cluster
template Hardware profile to use
cores Integer value, number of cores
memory Amount of memory, integer value in bytes
the machine or not
--interface:
compute_name Eg. eth0
compute_network Select one of available networks for a cluster
--volume:
size_gb Volume size in GB, integer value
storage_domain Select one of available storage domains
bootable Boolean, only one volume can be bootable
Rackspace:
flavor_id
image_id
VMWare:
177
cpus Cpu count

corespersocket Number of cores per socket (applicable to
hardware versions < 10 only)
memory_mb Integer number, amount of memory in MB
cluster Cluster id from VMware
path Path to folder
guest_id Guest OS id form VMware
scsi_controller_type Id of the controller from VMware
hardware_version Hardware version id from VMware
start Must be a 1 or 0, whether to start the
machine or not
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet,
VirtualVmxnet2,
VirtualVmxnet3,
VirtualE1000,
VirtualE1000e,
VirtualPCNet32
See documentation center for your version of
vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network id from VMware
--volume:
name
datastore Datastore id from VMware
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
10.28. HAMMER HOST-COLLECTION

Manipulate host collections
Usage:
hammer host-collection [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-host Add host to the host collection
copy Copy a host collection
create Create a host collection
delete Destroy a host collection
erratum Manipulate errata for a host collection
hosts List all hosts
info Show a host collection
list List host collections
package Manipulate packages for a host collection
package-group Manipulate package-groups for a host
collection
178
remove-host Remove hosts from the host collection

update Update a host collection
Options:
10.28.1. hammer host-collection add-host

Add host to the host collection
Usage:
hammer host-collection add-host [OPTIONS]
Options:
--host-ids HOST_IDS Array of host ids
--hosts HOST_NAMES Comma separated list of values.
--id ID Id of the host collection
--name NAME Host collection name to search
by
10.28.2. hammer host-collection copy

Copy a host collection
Usage:
hammer host-collection copy [OPTIONS]
Options:
--id ID ID of the host collection
by
--new-name NEW_NAME New host collection name
10.28.3. hammer host-collection create

Create a host collection
Usage:
hammer host-collection create [OPTIONS]
Options:
179
--host-ids HOST_IDS List of host ids to replace the

hosts in host collection
--max-hosts MAX_HOSTS Maximum number of hosts in the
host collection
--name NAME Host Collection name
--unlimited-hosts UNLIMITED_HOSTS Whether or not the host
collection may have unlimited hosts
10.28.4. hammer host-collection delete

Destroy a host collection
Usage:
hammer host-collection delete [OPTIONS]
Options:
by
10.28.5. hammer host-collection erratum

Manipulate errata for a host collection
Usage:
hammer host-collection erratum [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
install Install errata on content hosts contained
within a host collection
Options:
10.28.5.1. hammer host-collection erratum install
Install errata on content hosts contained within a host collection
180
Usage:
hammer host-collection erratum install [OPTIONS]
Options:
--errata ERRATA List of Errata to install
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
10.28.6. hammer host-collection hosts

List all hosts
Usage:
hammer host-collection hosts [OPTIONS]
Options:
--include INCLUDE Array of extra information types
to include
--thin THIN Only list ID and name of hosts
10.28.7. hammer host-collection info

Show a host collection
Usage:
hammer host-collection info [OPTIONS]
181
Options:
by
10.28.8. hammer host-collection list

List host collections
Usage:
hammer host-collection list [OPTIONS]
Options:
--available-for AVAILABLE_FOR Interpret specified object to
return only Host Collections that can be
associated with specified
object. The value 'host' is supported.
results
--host-id HOST_ID
--name NAME host collection name to filter
by
DESC'
return
10.28.9. hammer host-collection package

Manipulate packages for a host collection
Usage:
hammer host-collection package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
182
install Install packages on content hosts

contained within a host collection
remove Remove packages on content hosts contained
update Update packages on content hosts contained
Options:
10.28.9.1. hammer host-collection package install
Install packages on content hosts contained within a host collection
Usage:
hammer host-collection package install [OPTIONS]
Options:
--packages PACKAGES comma-separated list of packages
to install
10.28.9.2. hammer host-collection package remove
Remove packages on content hosts contained within a host collection
Usage:
hammer host-collection package remove [OPTIONS]
Options:
to install
10.28.9.3. hammer host-collection package update
Update packages on content hosts contained within a host collection
Usage:
hammer host-collection package update [OPTIONS]
183
Options:
to install
10.28.10. hammer host-collection package-group

Manipulate package-groups for a host collection
Usage:
hammer host-collection package-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
install Install package-groups on content hosts
remove Remove package-groups on content hosts
update Update package-groups on content hosts
Options:
10.28.10.1. hammer host-collection package-group install
Install package-groups on content hosts contained within a host collection
Usage:
hammer host-collection package-group install [OPTIONS]
Options:
--package-groups PACKAGE-GROUPS comma-separated list of package-
groups to install
184
10.28.10.2. hammer host-collection package-group remove
Remove package-groups on content hosts contained within a host collection
Usage:
hammer host-collection package-group remove [OPTIONS]
Options:
groups to install
10.28.10.3. hammer host-collection package-group update
Update package-groups on content hosts contained within a host collection
Usage:
hammer host-collection package-group update [OPTIONS]
Options:
groups to install
10.28.11. hammer host-collection remove-host

Remove hosts from the host collection
Usage:
hammer host-collection remove-host [OPTIONS]
Options:
--host-ids HOST_IDS Array of host ids
by
185

10.28.12. hammer host-collection update

Update a host collection
Usage:
hammer host-collection update [OPTIONS]
Options:
--host-ids HOST_IDS List of host ids to replace the
hosts in host collection
--max-hosts MAX_HOSTS Maximum number of hosts in the
host collection
by
--new-name NEW_NAME Host Collection name
--unlimited-hosts UNLIMITED_HOSTS Whether or not the host
collection may have unlimited hosts
10.29. HAMMER HOSTGROUP

Manipulate hostgroups.
Usage:
hammer hostgroup [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a host group
delete Delete a host group
delete-parameter Delete parameter for a hostgroup.
info Show a host group
list List all host groups
puppet-classes List all Puppet classes
set-parameter Create or update parameter for a
186
hostgroup.
update Update a host group
Options:
10.29.1. hammer hostgroup create

Create a host group
Usage:
hammer hostgroup create [OPTIONS]
Options:
name
--ask-root-pass ASK_ROOT_PW One of
--compute-profile COMPUTE_PROFILE_NAME Name to search
by
--config-group-ids CONFIG_GROUP_IDS IDs of
associated config groups
Comma
--config-groups CONFIG_GROUP_NAMES Comma
--content-source-id CONTENT_SOURCE_ID Content source
ID
--content-view CONTENT_VIEW_NAME Name to search
by
numeric identifier
--domain-id DOMAIN_ID Numerical ID
or domain name
name
--group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of
parameters
Comma
--kickstart-repository-id KICKSTART_REPOSITORY_ID Kickstart
repository ID
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search
by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID ID of the
environment
--location-ids LOCATION_IDS REPLACE
187
locations with given ids

Comma
--location-titles LOCATION_TITLES Comma
--locations LOCATION_NAMES Comma
--name NAME Name of the
host group
Capsule
--operatingsystem OPERATINGSYSTEM_TITLE Operating
system title
--organization-ids ORGANIZATION_IDS REPLACE
organizations with given ids.
Comma
--organization-titles ORGANIZATION_TITLES Comma
--organizations ORGANIZATION_NAMES Comma
--parent PARENT_NAME Name of
parent hostgroup
--parent-id PARENT_ID Parent ID of
the host group
--partition-table PARTITION_TABLE_NAME Partition
table name
--puppet-ca-proxy PUPPET_CA_PROXY_NAME Name of puppet
CA proxy
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA
Capsule ID
--puppet-class-ids PUPPETCLASS_IDS List of
puppetclass ids
Comma
--puppet-classes PUPPET_CLASS_NAMES Comma
--puppet-proxy PUPPET_PROXY_NAME Name of puppet
proxy
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule
ID
option (Grub2/PXELinux by default)
Possible
188

--query-organization ORGANIZATION_NAME Organization
name to search by
--query-organization-id ORGANIZATION_ID Organization
ID to search by
--query-organization-label ORGANIZATION_LABEL Organization
label to search by
--realm REALM_NAME Name to
search by
--realm-id REALM_ID Numerical ID
or realm name
--root-pass ROOT_PASSWORD Root password
10.29.2. hammer hostgroup delete

Delete a host group
Usage:
hammer hostgroup delete [OPTIONS]
Options:
--id ID
--name NAME Hostgroup name
--title TITLE Hostgroup title
10.29.3. hammer hostgroup delete-parameter

Delete parameter for a hostgroup.
Usage:
hammer hostgroup delete-parameter [OPTIONS]
Options:
10.29.4. hammer hostgroup info

Show a host group
Usage:
hammer hostgroup info [OPTIONS]
Options:
--id ID
189
--name NAME Hostgroup name

values
One of true/false,
yes/no, 1/0.
--title TITLE Hostgroup title
10.29.5. hammer hostgroup list

List all host groups
Usage:
hammer hostgroup list [OPTIONS]
Options:
10.29.6. hammer hostgroup puppet-classes

Usage:
hammer hostgroup puppet-classes [OPTIONS]
Options:
10.29.7. hammer hostgroup sc-params

Usage:
hammer hostgroup sc-params [OPTIONS]
190
Options:
10.29.8. hammer hostgroup set-parameter

Create or update parameter for a hostgroup.
Usage:
hammer hostgroup set-parameter [OPTIONS]
Options:
10.29.9. hammer hostgroup smart-variables

Usage:
hammer hostgroup smart-variables [OPTIONS]
Options:
10.29.10. hammer hostgroup update

Update a host group
191
Usage:
hammer hostgroup update [OPTIONS]
Options:
name
--ask-root-pass ASK_ROOT_PW One of
--compute-profile COMPUTE_PROFILE_NAME Name to search
by
--config-group-ids CONFIG_GROUP_IDS IDs of
associated config groups
Comma
--config-groups CONFIG_GROUP_NAMES Comma
--content-source-id CONTENT_SOURCE_ID Content source
ID
--content-view CONTENT_VIEW_NAME Name to search
by
numeric identifier
--domain-id DOMAIN_ID Numerical ID
or domain name
name
--group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of
parameters
Comma
--id ID
--kickstart-repository-id KICKSTART_REPOSITORY_ID Kickstart
repository ID
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search
by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID ID of the
environment
--location-ids LOCATION_IDS REPLACE
locations with given ids
Comma
--location-titles LOCATION_TITLES Comma
--locations LOCATION_NAMES Comma
192
--name NAME Hostgroup
name
--new-name NEW_NAME Name of the
host group
Capsule
--operatingsystem OPERATINGSYSTEM_TITLE Operating
system title
Comma
--organization-titles ORGANIZATION_TITLES Comma
--organizations ORGANIZATION_NAMES Comma
--parent PARENT_NAME Name of
parent hostgroup
--parent-id PARENT_ID Parent ID of
the host group
--partition-table PARTITION_TABLE_NAME Partition
table name
--puppet-ca-proxy PUPPET_CA_PROXY_NAME Name of puppet
CA proxy
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA
Capsule ID
--puppet-class-ids PUPPETCLASS_IDS List of
puppetclass ids
Comma
--puppet-classes PUPPET_CLASS_NAMES Comma
--puppet-proxy PUPPET_PROXY_NAME Name of puppet
proxy
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule
ID
option (Grub2/PXELinux by default)
Possible
--query-organization ORGANIZATION_NAME Organization
name to search by
--query-organization-id ORGANIZATION_ID Organization
ID to search by
--query-organization-label ORGANIZATION_LABEL Organization
label to search by
--realm REALM_NAME Name to
193
search by
--realm-id REALM_ID Numerical ID
or realm name
--root-pass ROOT_PASSWORD Root password
--title TITLE Hostgroup
title
10.30. HAMMER JOB-INVOCATION

Manage job invocations
Usage:
hammer job-invocation [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a job invocation
info Show job invocation
list List job invocations
output View the output for a host
Options:
10.30.1. hammer job-invocation create

Create a job invocation
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
194
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
--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-
--job-template JOB_TEMPLATE_NAME Name to search
by
--job-template-id JOB_TEMPLATE_ID
--max-iteration MAX_ITERATION Repeat a maximum
of N times
--search-query SEARCH_QUERY
--start-at DATETIME Schedule the
execution for a later time
Date and time
--start-before DATETIME Execution
should be cancelled if it cannot be started before --start-at
Date and time
--time-span TIME_SPAN Distribute
tasks over N seconds
10.30.2. hammer job-invocation info

Show job invocation
Usage:
hammer job-invocation info [OPTIONS]
Options:
--id ID
195
10.30.3. hammer job-invocation list

List job invocations
Usage:
hammer job-invocation list [OPTIONS]
Options:
10.30.4. hammer job-invocation output

View the output for a host
Usage:
hammer job-invocation output [OPTIONS]
Options:
--async Do not wait for job to complete, shows
current output only
--host-id HOST_ID
--id ID
10.31. HAMMER JOB-TEMPLATE

Manage job templates
Usage:
hammer job-template [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a job template
delete Delete a job template
dump View job template content
export Export a template including all metadata
import Import a job template from ERB
info Show job template details
list List job templates
update Update a job template
Options:
196
10.31.1. hammer job-template create

Create a 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
1/0.
--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
ids
--locked LOCKED Whether or not the template is
locked for editing
1/0.
--name NAME Template name
given ids.
--overridable OVERRIDABLE Whether it should be allowed
to override the effective user from the
invocation form.
1/0.
--provider-type PROVIDER_TYPE Provider type
Possible value(s): 'SSH'
--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)
197
10.31.2. hammer job-template delete

Delete a job template
Usage:
hammer job-template delete [OPTIONS]
Options:
--id ID
10.31.3. hammer job-template dump

View job template content
Usage:
hammer job-template dump [OPTIONS]
Options:
--id ID
10.31.4. hammer job-template export

Export a template including all metadata
Usage:
hammer job-template export [OPTIONS]
Options:
--id ID
10.31.5. hammer job-template import

Import a job template from ERB
Usage:
hammer job-template import [OPTIONS]
Options:
--file TEMPLATE Path to a file that contains the template -
must include ERB metadata
--overwrite OVERWRITE Overwrite template if it already exists
10.31.6. hammer job-template info
198
Show job template details
Usage:
hammer job-template info [OPTIONS]
Options:
--id ID
10.31.7. hammer job-template list

List job templates
Usage:
hammer job-template list [OPTIONS]
Options:
10.31.8. hammer job-template update

Update a job template
Usage:
hammer job-template update [OPTIONS]
Options:
--current-user CURRENT_USER Whether the current user login
should be used as the effective user
1/0.
--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}.
the template
--id ID
--job-category JOB_CATEGORY Job category
199
ids
locked for editing
1/0.
--new-name NEW_NAME Template name
given ids.
--overridable OVERRIDABLE Whether it should be allowed
to override the effective user from the
invocation form.
1/0.
--provider-type PROVIDER_TYPE Provider type
Possible value(s): 'SSH'
1/0.
--value VALUE What user should be used to
run the script (using sudo-like mechanisms)
10.32. HAMMER LIFECYCLE-ENVIRONMENT

Manipulate lifecycle_environments on the server
Usage:
hammer lifecycle-environment [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create an environment
delete Destroy an environment
info Show an environment
list List environments in an organization
paths List environment paths
update Update an environment
Options:
200
10.32.1. hammer lifecycle-environment create

Create an environment
Usage:
hammer lifecycle-environment create [OPTIONS]
Options:
--description DESCRIPTION description of the environment
--label LABEL label of the environment
--name NAME name of the environment
--prior PRIOR Name of the prior environment
--prior-id PRIOR_ID ID of an environment that is
prior to the new environment in the chain. It
has to be either the ID of
Library or the ID of an environment at the end
of a chain.
10.32.2. hammer lifecycle-environment delete

Destroy an environment
Usage:
hammer lifecycle-environment delete [OPTIONS]
Options:
--id ID ID of the environment
--name NAME Lifecycle environment name to
search by
10.32.3. hammer lifecycle-environment info

Show an environment
Usage:
hammer lifecycle-environment info [OPTIONS]
Options:
search by
201
10.32.4. hammer lifecycle-environment list

List environments in an organization
Usage:
hammer lifecycle-environment list [OPTIONS]
Options:
results
--library LIBRARY set true if you want to see only
library environments
Possible value(s): 'true',
'false'
--name NAME filter only environments
containing this name
DESC'
return
10.32.5. hammer lifecycle-environment paths

List environment paths
Usage:
hammer lifecycle-environment paths [OPTIONS]
Options:
--permission-type PERMISSION_TYPE The associated permission type.
One of (readable | promotable) Default:
readable
10.32.6. hammer lifecycle-environment update

Update an environment
Usage:
hammer lifecycle-environment update [OPTIONS]
Options:
--description DESCRIPTION description of the environment
202

search by
--new-name NEW_NAME new name to be given to the
environment
10.33. HAMMER LOCATION

Manipulate locations.
Usage:
hammer location [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-compute-resource Associate a compute resource
add-config-template Associate a configuration template
add-domain Associate a domain
add-environment Associate an environment
add-hostgroup Associate a hostgroup
add-medium Associate a medium
add-organization Associate an organization
add-smart-proxy Associate a smart proxy
add-subnet Associate a subnet
add-user Associate an user
create Create a location
delete Delete a location
delete-parameter Delete parameter for a location.
info Show a location
list List all locations
remove-compute-resource Disassociate a compute resource
remove-config-template Disassociate a configuration template
remove-domain Disassociate a domain
remove-environment Disassociate an environment
remove-hostgroup Disassociate a hostgroup
remove-medium Disassociate a medium
remove-organization Disassociate an organization
remove-smart-proxy Disassociate a smart proxy
remove-subnet Disassociate a subnet
remove-user Disassociate an user
set-parameter Create or update parameter for a location.
update Update a location
Options:
10.33.1. hammer location add-compute-resource
203
Associate a compute resource
Usage:
hammer location add-compute-resource [OPTIONS]
Options:
--id ID
--name NAME Location name
--title TITLE Location title
10.33.2. hammer location add-config-template

Associate a configuration template
Usage:
hammer location add-config-template [OPTIONS]
Options:
--config-template CONFIG_TEMPLATE_NAME Name to search by
--config-template-id CONFIG_TEMPLATE_ID
--id ID
10.33.3. hammer location add-domain

Associate a domain
Usage:
hammer location add-domain [OPTIONS]
Options:
--id ID
10.33.4. hammer location add-environment

Associate an environment
Usage:
hammer location add-environment [OPTIONS]
Options:
204
--id ID
10.33.5. hammer location add-hostgroup

Associate a hostgroup
Usage:
hammer location add-hostgroup [OPTIONS]
Options:
--id ID
10.33.6. hammer location add-medium

Associate a medium
Usage:
hammer location add-medium [OPTIONS]
Options:
--id ID
10.33.7. hammer location add-organization

Associate an organization
Usage:
hammer location add-organization [OPTIONS]
Options:
--id ID
205
10.33.8. hammer location add-smart-proxy

Associate a smart proxy
Usage:
hammer location add-smart-proxy [OPTIONS]
Options:
--id ID
--smart-proxy SMART_PROXY_NAME Name to search by
--smart-proxy-id SMART_PROXY_ID
10.33.9. hammer location add-subnet

Associate a subnet
Usage:
hammer location add-subnet [OPTIONS]
Options:
--id ID
10.33.10. hammer location add-user

Associate an user
Usage:
hammer location add-user [OPTIONS]
Options:
--id ID
--user USER_LOGIN User's login to search by
--user-id USER_ID
10.33.11. hammer location create

Create a location
Usage:
hammer location create [OPTIONS]
Options:
206
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource

IDs
Comma separated
backslash
--compute-resources COMPUTE_RESOURCE_NAMES Comma separated
backslash
--config-template-ids CONFIG_TEMPLATE_IDS Provisioning
template IDs
Comma separated
backslash
--config-templates CONFIG_TEMPLATE_NAMES Comma separated
backslash
--domain-ids DOMAIN_IDS Domain IDs
Comma separated
backslash
--domains DOMAIN_NAMES Comma separated
backslash
--environment-ids ENVIRONMENT_IDS Environment IDs
Comma separated
backslash
backslash
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated
backslash
--hostgroup-titles HOSTGROUP_TITLES Comma separated
backslash
--hostgroups HOSTGROUP_NAMES Comma separated
backslash
--ignore-types IGNORE_TYPES List of resources
types that will be automatically associated
Comma separated
backslash
--media MEDIUM_NAMES Comma separated
backslash
--medium-ids MEDIUM_IDS Medium IDs
Comma separated
backslash
--name NAME
--parent-id PARENT_ID Parent ID
--partition-table-ids PARTITION_TABLE_IDS Partition template
207
IDs
Comma separated
backslash
--partition-tables PARTITION_TABLE_NAMES Comma separated
backslash
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning
template IDs
Comma separated
backslash
--provisioning-templates PROVISIONING_TEMPLATE_NAMES Comma separated
backslash
--realm-ids REALM_IDS Realm IDs
Comma separated
backslash
--realms REALM_NAMES Comma separated
backslash
--smart-proxies SMART_PROXY_NAMES Comma separated
backslash
--smart-proxy-ids SMART_PROXY_IDS Capsule IDs
Comma separated
backslash
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated
backslash
--subnets SUBNET_NAMES Comma separated
backslash
--user-ids USER_IDS User IDs
Comma separated
backslash
--users USER_LOGINS Comma separated
backslash
10.33.12. hammer location delete

Delete a location
Usage:
hammer location delete [OPTIONS]
Options:
--id ID Location numeric id to search by
208
--name NAME Organization name

--title TITLE Organization title
10.33.13. hammer location delete-parameter

Delete parameter for a location.
Usage:
hammer location delete-parameter [OPTIONS]
Options:
10.33.14. hammer location info

Show a location
Usage:
hammer location info [OPTIONS]
Options:
--id ID Location numeric id to
search by
values
One of true/false,
yes/no, 1/0.
10.33.15. hammer location list

List all locations
Usage:
hammer location list [OPTIONS]
Options:
10.33.16. hammer location remove-compute-resource

Disassociate a compute resource
209
Usage:
hammer location remove-compute-resource [OPTIONS]
Options:
--id ID
10.33.17. hammer location remove-config-template

Disassociate a configuration template
Usage:
hammer location remove-config-template [OPTIONS]
Options:
--id ID
10.33.18. hammer location remove-domain

Disassociate a domain
Usage:
hammer location remove-domain [OPTIONS]
Options:
--id ID
10.33.19. hammer location remove-environment

Disassociate an environment
Usage:
hammer location remove-environment [OPTIONS]
Options:
--id ID
210

10.33.20. hammer location remove-hostgroup

Disassociate a hostgroup
Usage:
hammer location remove-hostgroup [OPTIONS]
Options:
--id ID
10.33.21. hammer location remove-medium

Disassociate a medium
Usage:
hammer location remove-medium [OPTIONS]
Options:
--id ID
10.33.22. hammer location remove-organization

Disassociate an organization
Usage:
hammer location remove-organization [OPTIONS]
Options:
--id ID
10.33.23. hammer location remove-smart-proxy
211
Disassociate a smart proxy
Usage:
hammer location remove-smart-proxy [OPTIONS]
Options:
--id ID
10.33.24. hammer location remove-subnet

Disassociate a subnet
Usage:
hammer location remove-subnet [OPTIONS]
Options:
--id ID
10.33.25. hammer location remove-user

Disassociate an user
Usage:
hammer location remove-user [OPTIONS]
Options:
--id ID
--user-id USER_ID
10.33.26. hammer location set-parameter

Create or update parameter for a location.
Usage:
hammer location set-parameter [OPTIONS]
Options:
212

10.33.27. hammer location update

Update a location
Usage:
hammer location update [OPTIONS]
Options:
IDs
Comma separated
backslash
backslash
template IDs
Comma separated
backslash
backslash
Comma separated
backslash
backslash
Comma separated
backslash
backslash
Comma separated
backslash
backslash
213
backslash
--id ID Location numeric
id to search by
Comma separated
backslash
backslash
Comma separated
backslash
--new-name NEW_NAME
IDs
Comma separated
backslash
backslash
template IDs
Comma separated
backslash
backslash
Comma separated
backslash
backslash
backslash
Comma separated
backslash
Comma separated
backslash
backslash
214

Comma separated
backslash
backslash
10.34. HAMMER MEDIUM

Manipulate installation media.
Usage:
hammer medium [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a medium
delete Delete a medium
info Show a medium
list List all installation media
update Update a medium
Options:
10.34.1. hammer medium add-operatingsystem

Usage:
hammer medium add-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Medium name
10.34.2. hammer medium create

Create a medium
Usage:
hammer medium create [OPTIONS]
215
Options:
ids
--name NAME Name of media
--operatingsystem-ids OPERATINGSYSTEM_IDS Comma separated list of values.
given ids.
--os-family OS_FAMILY Operating system family,
available values: AIX, Altlinux, Archlinux,
Coreos, Debian, Freebsd,
Gentoo, Junos, NXOS, Redhat, Solaris, Suse,
Windows, Xenserver
--path PATH The path to the medium, can be
a URL or a valid NFS server (exclusive of
the architecture).
for example
mirror.centos.org/centos/$version/os/$arch
where $arch will be
substituted for the host's actual OS architecture
and $version, $major and
$minor will be substituted for the version of the
operating system.
Solaris and Debian media may

also use $release.
10.34.3. hammer medium delete

Delete a medium
Usage:
hammer medium delete [OPTIONS]
Options:
--id ID
216
10.34.4. hammer medium info

Show a medium
Usage:
hammer medium info [OPTIONS]
Options:
--id ID
10.34.5. hammer medium list

List all installation media
Usage:
hammer medium list [OPTIONS]
Options:
10.34.6. hammer medium remove-operatingsystem

Usage:
hammer medium remove-operatingsystem [OPTIONS]
Options:
--id ID
10.34.7. hammer medium update

Update a medium
Usage:
217
hammer medium update [OPTIONS]
Options:
--id ID
ids
--new-name NEW_NAME Name of media
--operatingsystem-ids OPERATINGSYSTEM_IDS Comma separated list of values.
given ids.
--os-family OS_FAMILY Operating system family,
available values: AIX, Altlinux, Archlinux,
Coreos, Debian, Freebsd,
Gentoo, Junos, NXOS, Redhat, Solaris, Suse,
Windows, Xenserver
--path PATH The path to the medium, can be
a URL or a valid NFS server (exclusive of
the architecture).
for example
mirror.centos.org/centos/$version/os/$arch
where $arch will be
substituted for the host's actual OS architecture
and $version, $major and
$minor will be substituted for the version of the
operating system.
Solaris and Debian media may

also use $release.
10.35. HAMMER MODEL

Manipulate hardware models.
Usage:
hammer model [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
218
Subcommands:
create Create a hardware model
delete Delete a hardware model
info Show a hardware model
list List all hardware models
update Update a hardware model
Options:
10.35.1. hammer model create

Create a hardware model
Usage:
hammer model create [OPTIONS]
Options:
--hardware-model HARDWARE_MODEL
--info INFO
--name NAME
--vendor-class VENDOR_CLASS
10.35.2. hammer model delete

Delete a hardware model
Usage:
hammer model delete [OPTIONS]
Options:
--id ID
--name NAME Model name
10.35.3. hammer model info

Show a hardware model
Usage:
hammer model info [OPTIONS]
Options:
--id ID
10.35.4. hammer model list
219
List all hardware models
Usage:
hammer model list [OPTIONS]
Options:
10.35.5. hammer model update

Update a hardware model
Usage:
hammer model update [OPTIONS]
Options:
--hardware-model HARDWARE_MODEL
--id ID
--info INFO
--new-name NEW_NAME
--vendor-class VENDOR_CLASS
10.36. HAMMER ORGANIZATION

Manipulate organizations
Usage:
hammer organization [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-compute-resource Associate a compute resource
add-domain Associate a domain
add-environment Associate an environment
add-hostgroup Associate a hostgroup
add-location Associate a location
add-medium Associate a medium
add-smart-proxy Associate a smart proxy
add-subnet Associate a subnet
create Create organization
delete Delete an organization
delete-parameter Delete parameter for an organization.
info Show organization
220
list List all organizations

remove-compute-resource Disassociate a compute resource
remove-domain Disassociate a domain
remove-environment Disassociate an environment
remove-hostgroup Disassociate a hostgroup
remove-location Disassociate a location
remove-medium Disassociate a medium
remove-smart-proxy Disassociate a smart proxy
remove-subnet Disassociate a subnet
set-parameter Create or update parameter for an
organization.
update Update organization
Options:
10.36.1. hammer organization add-compute-resource

Associate a compute resource
Usage:
hammer organization add-compute-resource [OPTIONS]
Options:
--id ID organization ID
10.36.2. hammer organization add-config-template

Usage:
hammer organization add-config-template [OPTIONS]
Options:
10.36.3. hammer organization add-domain

Associate a domain
Usage:
221
hammer organization add-domain [OPTIONS]
Options:
10.36.4. hammer organization add-environment

Associate an environment
Usage:
hammer organization add-environment [OPTIONS]
Options:
10.36.5. hammer organization add-hostgroup

Associate a hostgroup
Usage:
hammer organization add-hostgroup [OPTIONS]
Options:
10.36.6. hammer organization add-location

Associate a location
Usage:
hammer organization add-location [OPTIONS]
Options:
222

10.36.7. hammer organization add-medium

Associate a medium
Usage:
hammer organization add-medium [OPTIONS]
Options:
10.36.8. hammer organization add-smart-proxy

Associate a smart proxy
Usage:
hammer organization add-smart-proxy [OPTIONS]
Options:
10.36.9. hammer organization add-subnet

Associate a subnet
Usage:
hammer organization add-subnet [OPTIONS]
Options:
10.36.10. hammer organization add-user

Associate an user
223
Usage:
hammer organization add-user [OPTIONS]
Options:
--user-id USER_ID
10.36.11. hammer organization create

Create organization
Usage:
hammer organization create [OPTIONS]
Options:
IDs
Comma separated
backslash
backslash
template IDs
Comma separated
backslash
backslash
Comma separated
backslash
backslash
Comma separated
backslash
backslash
Comma separated
backslash
224

backslash
backslash
--label LABEL unique label
backslash
Comma separated
backslash
--name NAME name
template IDs
Comma separated
backslash
backslash
--ptable-ids PTABLE_IDS Partition
template IDs
Comma separated
backslash
--ptables PTABLE_NAMES Comma separated
backslash
Comma separated
backslash
backslash
backslash
Comma separated
backslash
Comma separated
backslash
backslash
Comma separated
backslash
--users USER_NAMES Comma separated
225

backslash
10.36.12. hammer organization delete

Delete an organization
Usage:
hammer organization delete [OPTIONS]
Options:
--id ID
--label LABEL Organization label to search by
10.36.13. hammer organization delete-parameter

Delete parameter for an organization.
Usage:
hammer organization delete-parameter [OPTIONS]
Options:
10.36.14. hammer organization info

Show organization
Usage:
hammer organization info [OPTIONS]
Options:
--id ID
--label LABEL Organization label to search by
10.36.15. hammer organization list

List all organizations
Usage:
226
hammer organization list [OPTIONS]
Options:
10.36.16. hammer organization remove-compute-resource

Disassociate a compute resource
Usage:
hammer organization remove-compute-resource [OPTIONS]
Options:
10.36.17. hammer organization remove-config-template

Usage:
hammer organization remove-config-template [OPTIONS]
Options:
10.36.18. hammer organization remove-domain

Disassociate a domain
Usage:
hammer organization remove-domain [OPTIONS]
Options:
227

10.36.19. hammer organization remove-environment

Disassociate an environment
Usage:
hammer organization remove-environment [OPTIONS]
Options:
10.36.20. hammer organization remove-hostgroup

Disassociate a hostgroup
Usage:
hammer organization remove-hostgroup [OPTIONS]
Options:
10.36.21. hammer organization remove-location

Disassociate a location
Usage:
hammer organization remove-location [OPTIONS]
Options:
10.36.22. hammer organization remove-medium
228
Disassociate a medium
Usage:
hammer organization remove-medium [OPTIONS]
Options:
10.36.23. hammer organization remove-smart-proxy

Disassociate a smart proxy
Usage:
hammer organization remove-smart-proxy [OPTIONS]
Options:
10.36.24. hammer organization remove-subnet

Disassociate a subnet
Usage:
hammer organization remove-subnet [OPTIONS]
Options:
10.36.25. hammer organization remove-user

Usage:
hammer organization remove-user [OPTIONS]
Options:
229

--user-id USER_ID
10.36.26. hammer organization set-parameter

Create or update parameter for an organization.
Usage:
hammer organization set-parameter [OPTIONS]
Options:
10.36.27. hammer organization update

Update organization
Usage:
hammer organization update [OPTIONS]
Options:
IDs
Comma separated
backslash
backslash
template IDs
Comma separated
backslash
backslash
Comma separated
backslash
backslash
230

Comma separated
backslash
backslash
Comma separated
backslash
backslash
backslash
--id ID
Comma separated
backslash
--label LABEL Organization
label to search by
backslash
Comma separated
backslash
--new-name NEW_NAME
IDs
Comma separated
backslash
backslash
template IDs
Comma separated
backslash
backslash
--ptable-ids PTABLE_IDS Partition
template IDs
Comma separated
backslash
231
--ptables PTABLE_NAMES Comma separated

backslash
Comma separated
backslash
backslash
--redhat-repository-url REDHAT_REPOSITORY_URL Red Hat CDN URL
backslash
Comma separated
backslash
Comma separated
backslash
backslash
--title TITLE Organization
title
Comma separated
backslash
backslash
10.37. HAMMER OS
Manipulate operating system.
Usage:
hammer os [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-architecture Associate an architecture
add-ptable Associate a partition table
create Create an operating system
delete Delete an operating system
delete-default-template
delete-parameter Delete parameter for an operating system.
232
info Show an operating system

list List all operating systems
remove-architecture Disassociate an architecture
remove-ptable Disassociate a partition table
set-default-template
set-parameter Create or update parameter for an
operating system.
update Update an operating system
Options:
10.37.1. hammer os add-architecture

Associate an architecture
Usage:
hammer os add-architecture [OPTIONS]
Options:
--id ID
--title TITLE Operating system title
10.37.2. hammer os add-config-template

Usage:
hammer os add-config-template [OPTIONS]
Options:
--id ID
10.37.3. hammer os add-ptable

Associate a partition table
Usage:
hammer os add-ptable [OPTIONS]
Options:
--id ID
233
10.37.4. hammer os create

Create an operating system
Usage:
hammer os create [OPTIONS]
Options:
--architecture-ids ARCHITECTURE_IDS IDs of associated
architectures
Comma separated
backslash
--architectures ARCHITECTURE_NAMES Comma separated
backslash
--config-template-ids CONFIG_TEMPLATE_IDS IDs of associated
provisioning templates
Comma separated
backslash
backslash
--family FAMILY
--major MAJOR
backslash
--medium-ids MEDIUM_IDS IDs of associated
media
Comma separated
backslash
--minor MINOR
--name NAME
--os-parameters-attributes OS_PARAMETERS_ATTRIBUTES Array of parameters
Comma separated
backslash
--partition-table-ids PARTITION_TABLE_IDS IDs of associated
partition tables
Comma separated
backslash
backslash
--password-hash PASSWORD_HASH Root password hash
function to use, one of MD5, SHA256, SHA512, Base64
234
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated

Comma separated
backslash
backslash
--release-name RELEASE_NAME
10.37.5. hammer os delete

Delete an operating system
Usage:
hammer os delete [OPTIONS]
Options:
--id ID
10.37.6. hammer os delete-default-template
Usage:
hammer os delete-default-template [OPTIONS]
Options:
--id OS ID operatingsystem id
--type TPL TYPE Type of the config template
10.37.7. hammer os delete-parameter

Delete parameter for an operating system.
Usage:
hammer os delete-parameter [OPTIONS]
Options:
10.37.8. hammer os info

Show an operating system
Usage:
hammer os info [OPTIONS]
235
Options:
--id ID
values
One of true/false,
yes/no, 1/0.
10.37.9. hammer os list

List all operating systems
Usage:
hammer os list [OPTIONS]
Options:
Comma separated
backslash
--per-page PER_PAGE number of entries
per request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID
10.37.10. hammer os remove-architecture

Disassociate an architecture
Usage:
hammer os remove-architecture [OPTIONS]
Options:
--id ID
236
10.37.11. hammer os remove-config-template

Usage:
hammer os remove-config-template [OPTIONS]
Options:
--id ID
10.37.12. hammer os remove-ptable

Disassociate a partition table
Usage:
hammer os remove-ptable [OPTIONS]
Options:
--id ID
10.37.13. hammer os set-default-template
Usage:
hammer os set-default-template [OPTIONS]
Options:
--config-template-id TPL ID config template id to be set
--id OS ID operatingsystem id
10.37.14. hammer os set-parameter

Create or update parameter for an operating system.
Usage:
hammer os set-parameter [OPTIONS]
Options:
237
10.37.15. hammer os update

Update an operating system
Usage:
hammer os update [OPTIONS]
Options:
--architecture-ids ARCHITECTURE_IDS IDs of associated
architectures
Comma separated
backslash
--architectures ARCHITECTURE_NAMES Comma separated
backslash
--config-template-ids CONFIG_TEMPLATE_IDS IDs of associated
Comma separated
backslash
backslash
--family FAMILY
--id ID
--major MAJOR
backslash
--medium-ids MEDIUM_IDS IDs of associated
media
Comma separated
backslash
--minor MINOR
--name NAME
Comma separated
backslash
--partition-table-ids PARTITION_TABLE_IDS IDs of associated
partition tables
Comma separated
backslash
backslash
--password-hash PASSWORD_HASH Root password hash
function to use, one of MD5, SHA256, SHA512, Base64
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated
Comma separated
238
backslash
backslash
--release-name RELEASE_NAME
--title TITLE Operating system
title
10.38. HAMMER OSTREE-BRANCH

Manipulate ostree branches
Usage:
hammer ostree-branch [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show an ostree branch
list List ostree_branches
Options:
10.38.1. hammer ostree-branch info

Show an ostree branch
Usage:
hammer ostree-branch info [OPTIONS]
Options:
--id ID an ostree branch identifier
10.38.2. hammer ostree-branch list

List ostree_branches
Usage:
hammer ostree-branch list [OPTIONS]
Options:
results on
search by
239

identifier
number
identifier
show all results
One of true/false,
yes/no, 1/0.
content by
Comma separated
backslash
search by
to search by
starting at 1
per page to return
search by
identifier
search by
10.39. HAMMER PACKAGE

Manipulate packages.
Usage:
hammer package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show a package
list List packages
240
Options:
10.39.1. hammer package info

Show a package
Usage:
hammer package info [OPTIONS]
Options:
--id ID a package identifier
10.39.2. hammer package list

List packages
Usage:
hammer package list [OPTIONS]
Options:
--by BY Field to
sort the results on
--content-view CONTENT_VIEW_NAME Content view
name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to
search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID filter
identifier
numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view
version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view
version identifier
name
--full-result FULL_RESULT Whether or
not to show all results
One of
--host-id HOST_ID
--ids IDS ids to
filter content by
Comma
241
--order ORDER Sort field

and order, eg. 'name DESC'
name to search by
ID
label to search by
--packages-restrict-applicable PACKAGES_RESTRICT_APPLICABLE Only show
packages that are applicable to hosts (defaults to true if
host_id is
specified)
One of
--packages-restrict-upgradable PACKAGES_RESTRICT_UPGRADABLE Only show
packages that are upgradable in the host(s) Content View.
One of
--page PAGE Page
number, starting at 1
--per-page PER_PAGE Number of
results per page to return
--product PRODUCT_NAME Product
name to search by
numeric identifier
--repository REPOSITORY_NAME Repository
name to search by
--repository-id REPOSITORY_ID repository
ID
--search SEARCH Search
string
10.40. HAMMER PACKAGE-GROUP

Manipulate package groups
Usage:
hammer package-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show a package group
list List package_groups
Options:
10.40.1. hammer package-group info
242
Show a package group
Usage:
hammer package-group info [OPTIONS]
Options:
--id ID a package group identifier
10.40.2. hammer package-group list

List package_groups
Usage:
hammer package-group list [OPTIONS]
Options:
results on
search by
identifier
number
identifier
show all results
One of true/false,
yes/no, 1/0.
content by
Comma separated
backslash
search by
to search by
starting at 1
per page to return
243
search by
identifier
search by
10.41. HAMMER PARTITION-TABLE

Manipulate partition tables.
Usage:
hammer partition-table [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a partition table
delete Delete a partition table
dump View partition table content.
info Show a partition table
list List all partition tables
update Update a partition table
Options:
10.41.1. hammer partition-table add-operatingsystem

Usage:
hammer partition-table add-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Partition table name
10.41.2. hammer partition-table create

Create a partition table
Usage:
hammer partition-table create [OPTIONS]
244
Options:
--file LAYOUT Path to a file that contains
the partition layout
--host-ids HOST_IDS Array of host IDs to associate
with the partition table
--hostgroup-ids HOSTGROUP_IDS Array of host group IDs to
associate with the partition table
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values.
--hostgroups HOSTGROUP_NAMES Comma separated list of
--hosts HOST_NAMES Comma separated list of
ids
locked for editing
1/0.
--name NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs
to associate with the partition table
given ids.
--os-family OS_FAMILY
1/0.
10.41.3. hammer partition-table delete

Delete a partition table
245
Usage:
hammer partition-table delete [OPTIONS]
Options:
--id ID
10.41.4. hammer partition-table dump

View partition table content.
Usage:
hammer partition-table dump [OPTIONS]
Options:
--id ID
10.41.5. hammer partition-table info

Show a partition table
Usage:
hammer partition-table info [OPTIONS]
Options:
--id ID
10.41.6. hammer partition-table list

List all partition tables
Usage:
hammer partition-table list [OPTIONS]
Options:
246
10.41.7. hammer partition-table remove-operatingsystem

Usage:
hammer partition-table remove-operatingsystem [OPTIONS]
Options:
--id ID
10.41.8. hammer partition-table update

Update a partition table
Usage:
hammer partition-table update [OPTIONS]
Options:
--file LAYOUT Path to a file that contains
the partition layout
--host-ids HOST_IDS Array of host IDs to associate
with the partition table
--hostgroup-ids HOSTGROUP_IDS Array of host group IDs to
associate with the partition table
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values.
--hostgroups HOSTGROUP_NAMES Comma separated list of
--hosts HOST_NAMES Comma separated list of
--id ID
ids
locked for editing
1/0.
--new-name NEW_NAME
247
to associate with the partition table

given ids.
--os-family OS_FAMILY
1/0.
10.42. HAMMER PING

Get the status of the server
Usage:
hammer ping [OPTIONS]
Options:
10.43. HAMMER POLICY

Manipulate policies
Usage:
hammer policy [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a Policy
delete Delete a Policy
info Show a Policy
list List Policies
update Update a Policy
Options:
10.43.1. hammer policy create

Create a Policy
248
Usage:
hammer policy create [OPTIONS]
Options:
--cron-line CRON_LINE Policy schedule
cron line (only if period == “custom”)
--day-of-month DAY_OF_MONTH Policy schedule
day of month (only if period == “monthly”)
--description DESCRIPTION Policy description
--hostgroup-ids HOSTGROUP_IDS Apply policy to
host groups
Comma separated
backslash
backslash
--location-ids LOCATION_IDS REPLACE locations
with given ids
Comma separated
backslash
--locations LOCATION_NAMES Comma separated
backslash
--name NAME Policy name
Comma separated
backslash
--organizations ORGANIZATION_NAMES Comma separated
backslash
--period PERIOD Policy schedule
period (weekly, monthly, custom)
--scap-content SCAP_CONTENT_TITLE SCAP content title
--scap-content-id SCAP_CONTENT_ID
--scap-content-profile-id SCAP_CONTENT_PROFILE_ID Policy SCAP content
profile ID
--tailoring-file TAILORING_FILE_NAME Tailoring file
name
--tailoring-file-id TAILORING_FILE_ID
--tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file
profile ID
--weekday WEEKDAY Policy schedule
weekday (only if period == “weekly”)
10.43.2. hammer policy delete

Delete a Policy
Usage:
hammer policy delete [OPTIONS]
249
Options:
--id ID
10.43.3. hammer policy info

Show a Policy
Usage:
hammer policy info [OPTIONS]
Options:
--id ID
10.43.4. hammer policy list

List Policies
Usage:
hammer policy list [OPTIONS]
Options:
10.43.5. hammer policy update

Update a Policy
Usage:
hammer policy update [OPTIONS]
Options:
--cron-line CRON_LINE Policy schedule
cron line (only if period == “custom”)
--day-of-month DAY_OF_MONTH Policy schedule
day of month (only if period == “monthly”)
--description DESCRIPTION Policy description
--hostgroup-ids HOSTGROUP_IDS Apply policy to
host groups
Comma separated
backslash
backslash
250
--id ID
--location-ids LOCATION_IDS REPLACE locations
with given ids
Comma separated
backslash
--locations LOCATION_NAMES Comma separated
backslash
--name NAME Policy name
--new-name NEW_NAME Policy name
Comma separated
backslash
--organizations ORGANIZATION_NAMES Comma separated
backslash
--period PERIOD Policy schedule
period (weekly, monthly, custom)
--scap-content SCAP_CONTENT_TITLE SCAP content title
--scap-content-id SCAP_CONTENT_ID
--scap-content-profile-id SCAP_CONTENT_PROFILE_ID Policy SCAP content
profile ID
--tailoring-file TAILORING_FILE_NAME Tailoring file
name
--tailoring-file-id TAILORING_FILE_ID
--tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file
profile ID
--weekday WEEKDAY Policy schedule
weekday (only if period == “weekly”)
10.44. HAMMER PRODUCT

Manipulate products.
Usage:
hammer product [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a product
delete Destroy a product
info Show a product
list List products
remove-sync-plan Delete assignment sync plan and product.
set-sync-plan Assign sync plan to product.
synchronize Sync all repositories for a product
update Updates a product
251
Options:
10.44.1. hammer product create

Create a product
Usage:
hammer product create [OPTIONS]
Options:
--description DESCRIPTION Product description
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID gpg key numeric identifier
--label LABEL
--name NAME Product name
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID sync plan numeric identifier
10.44.2. hammer product delete

Destroy a product
Usage:
hammer product delete [OPTIONS]
Options:
--id ID product numeric identifier
--name NAME Product name to search by
10.44.3. hammer product info

Show a product
Usage:
hammer product info [OPTIONS]
Options:
252
10.44.4. hammer product list

List products
Usage:
hammer product list [OPTIONS]
Options:
--available-for AVAILABLE_FOR Interpret
specified object to return only Products that can be associated
with specified
object. Only 'sync_plan' is supported.
--by BY Field to sort
the results on
--custom CUSTOM Filter products
by custom
One of
--enabled ENABLED Filter products
by enabled or disabled
One of
show all results
One of
--include-available-content INCLUDE_AVAILABLE_CONTENT Whether to include
available content attribute in results
One of
--name NAME Filter products
by name
to search by
to search by
starting at 1
per page to return
--subscription SUBSCRIPTION_NAME Subscription name
to search by
--subscription-id SUBSCRIPTION_ID Subscription
identifier
--sync-plan SYNC_PLAN_NAME Sync plan name to
search by
--sync-plan-id SYNC_PLAN_ID sync plan numeric
identifier
10.44.5. hammer product remove-sync-plan
253
Delete assignment sync plan and product.
Usage:
hammer product remove-sync-plan [OPTIONS]
Options:
--new-name NEW_NAME Product name
10.44.6. hammer product set-sync-plan

Assign sync plan to product.
Usage:
hammer product set-sync-plan [OPTIONS]
Options:
10.44.7. hammer product synchronize

Sync all repositories for a product
Usage:
hammer product synchronize [OPTIONS]
Options:
--id ID product ID
254
10.44.8. hammer product update

Updates a product
Usage:
hammer product update [OPTIONS]
Options:
10.45. HAMMER PROXY

Manipulate smart proxies.
Usage:
hammer proxy [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
content Manage the capsule content
create Create a capsule
delete Delete a capsule
import-classes Import puppet classes from puppet Capsule.
info Show a capsule
list List all capsules
refresh-features Refresh capsule features
update Update a capsule
Options:
10.45.1. hammer proxy content

Manage the capsule content
Usage:
hammer proxy content [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
255
Subcommands:
add-lifecycle-environment Add lifecycle environments to the
capsule
available-lifecycle-environments List the lifecycle environments not
attached to the capsule
cancel-synchronization Cancel running capsule synchronization.
info Get current capsule synchronization
status
lifecycle-environments List the lifecycle environments attached
to the capsule
remove-lifecycle-environment Remove lifecycle environments from the
capsule
synchronization-status Get current capsule synchronization
status
synchronize Synchronize the content to the capsule
Options:
10.45.1.1. hammer proxy content add-lifecycle-environment
Add lifecycle environments to the capsule
Usage:
hammer proxy content add-lifecycle-environment [OPTIONS]
Options:
10.45.1.2. hammer proxy content available-lifecycle-environments
List the lifecycle environments not attached to the capsule
Usage:
hammer proxy content available-lifecycle-environments [OPTIONS]
Options:
10.45.1.3. hammer proxy content cancel-synchronization
256
Cancel running capsule synchronization.
Usage:
hammer proxy content cancel-synchronization [OPTIONS]
Options:
10.45.1.4. hammer proxy content info
Usage:
hammer proxy content info [OPTIONS]
Options:
10.45.1.5. hammer proxy content lifecycle-environments
List the lifecycle environments attached to the capsule
Usage:
hammer proxy content lifecycle-environments [OPTIONS]
Options:
10.45.1.6. hammer proxy content remove-lifecycle-environment
Remove lifecycle environments from the capsule
Usage:
hammer proxy content remove-lifecycle-environment [OPTIONS]
Options:
257

10.45.1.7. hammer proxy content synchronization-status
Usage:
hammer proxy content synchronization-status [OPTIONS]
Options:
10.45.1.8. hammer proxy content synchronize
Synchronize the content to the capsule
Usage:
hammer proxy content synchronize [OPTIONS]
Options:
--skip-metadata-check SKIP_METADATA_CHECK Skip metadata check on each
repository on the capsule
1/0.
10.45.2. hammer proxy create

Create a capsule
Usage:
hammer proxy create [OPTIONS]
Options:
background, inherit
ids
258

--name NAME
given ids.
--url URL
10.45.3. hammer proxy delete

Delete a capsule
Usage:
hammer proxy delete [OPTIONS]
Options:
--id ID
10.45.4. hammer proxy import-classes

Import puppet classes from puppet Capsule.
Usage:
hammer proxy import-classes [OPTIONS]
Options:
--dryrun Do not run the import
--except EXCEPT Optional comma-delimited string
containing either 'new',
'updated', or 'obsolete' that is used
to limit the imported
Puppet classes
--id ID
10.45.5. hammer proxy info

Show a capsule
259
Usage:
hammer proxy info [OPTIONS]
Options:
--id ID
10.45.6. hammer proxy list

List all capsules
Usage:
hammer proxy list [OPTIONS]
Options:
10.45.7. hammer proxy refresh-features

Refresh capsule features
Usage:
hammer proxy refresh-features [OPTIONS]
Options:
--id ID
10.45.8. hammer proxy update

Update a capsule
Usage:
hammer proxy update [OPTIONS]
Options:
background, inherit
--id ID
260
ids
--new-name NEW_NAME
given ids.
--url URL
10.46. HAMMER PUPPET-CLASS

Search puppet modules.
Usage:
hammer puppet-class [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show a Puppet class
list List all Puppet classes
Options:
10.46.1. hammer puppet-class info

Show a Puppet class
Usage:
hammer puppet-class info [OPTIONS]
Options:
--host-id HOST_ID
261

--id ID ID of Puppet class
--name NAME Puppet class name
10.46.2. hammer puppet-class list

Usage:
hammer puppet-class list [OPTIONS]
Options:
--host-id HOST_ID
10.46.3. hammer puppet-class sc-params

Usage:
hammer puppet-class sc-params [OPTIONS]
Options:
10.46.4. hammer puppet-class smart-variables

Usage:
hammer puppet-class smart-variables [OPTIONS]
Options:
262

10.47. HAMMER PUPPET-MODULE

View Puppet Module details.
Usage:
hammer puppet-module [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show a puppet module
list List puppet_modules
Options:
10.47.1. hammer puppet-module info

Show a puppet module
Usage:
hammer puppet-module info [OPTIONS]
Options:
--id ID a puppet module identifier
10.47.2. hammer puppet-module list

List puppet_modules
Usage:
hammer puppet-module list [OPTIONS]
Options:
263
results on
search by
identifier
number
identifier
show all results
One of true/false,
yes/no, 1/0.
content by
Comma separated
backslash
search by
to search by
starting at 1
per page to return
search by
identifier
search by
10.48. HAMMER REALM

Manipulate realms.
Usage:
hammer realm [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
264
create Create a realm

delete Delete a realm
info Show a realm
list List of realms
update Update a realm
Options:
10.48.1. hammer realm create

Create a realm
Usage:
hammer realm create [OPTIONS]
Options:
ids
--name NAME The realm name, e.g.
EXAMPLE.COM
given ids.
--realm-proxy-id REALM_PROXY_ID Capsule ID to use within this
realm
--realm-type REALM_TYPE Realm type, e.g. Red Hat
Identity Management or Active Directory
10.48.2. hammer realm delete

Delete a realm
Usage:
hammer realm delete [OPTIONS]
Options:
--id ID
265
10.48.3. hammer realm info

Show a realm
Usage:
hammer realm info [OPTIONS]
Options:
--id ID Numerical ID or realm name
10.48.4. hammer realm list

List of realms
Usage:
hammer realm list [OPTIONS]
Options:
10.48.5. hammer realm update

Update a realm
Usage:
hammer realm update [OPTIONS]
Options:
--id ID
ids
--new-name NEW_NAME The realm name, e.g.
EXAMPLE.COM
given ids.
266

--realm-proxy-id REALM_PROXY_ID Capsule ID to use within this
realm
--realm-type REALM_TYPE Realm type, e.g. Red Hat
Identity Management or Active Directory
10.49. HAMMER RECURRING-LOGIC

Recurring logic related actions.
Usage:
hammer recurring-logic [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
cancel Cancel recurring logic
info Show recurring logic details
list List recurring logics
Options:
10.49.1. hammer recurring-logic cancel

Cancel recurring logic
Usage:
hammer recurring-logic cancel [OPTIONS]
Options:
--id ID ID of the recurring logic
10.49.2. hammer recurring-logic info

Show recurring logic details
Usage:
hammer recurring-logic info [OPTIONS]
Options:
267
--id ID ID of the recurring logic

10.49.3. hammer recurring-logic list

List recurring logics
Usage:
hammer recurring-logic list [OPTIONS]
Options:
10.50. HAMMER REMOTE-EXECUTION-FEATURE

Manage remote execution features
Usage:
hammer remote-execution-feature [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
info Show remote execution feature
list List remote execution features
update Update a job template
Options:
10.50.1. hammer remote-execution-feature info

Show remote execution feature
Usage:
hammer remote-execution-feature info [OPTIONS]
Options:
--id ID
10.50.2. hammer remote-execution-feature list

List remote execution features
Usage:
hammer remote-execution-feature list [OPTIONS]
268
Options:
10.50.3. hammer remote-execution-feature update

Update a job template
Usage:
hammer remote-execution-feature update [OPTIONS]
Options:
--id ID
--job-template JOB_TEMPLATE_NAME Name to search by
--job-template-id JOB_TEMPLATE_ID
--new-name NEW_NAME
10.51. HAMMER REPORT

Browse and read reports.
Usage:
hammer report [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
delete Delete a report
info Show a report
list List all reports
Options:
10.51.1. hammer report delete

Delete a report
Usage:
hammer report delete [OPTIONS]
Options:
--id ID
10.51.2. hammer report info

Show a report
269
Usage:
hammer report info [OPTIONS]
Options:
--id ID
10.51.3. hammer report list

List all reports
Usage:
hammer report list [OPTIONS]
Options:
10.52. HAMMER REPOSITORY

Manipulate repositories
Usage:
hammer repository [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a custom repository
delete Destroy a custom repository
export Export content from a repository to the
configured directory
info Show a repository
list List of enabled repositories
remove-content Remove content from a repository
synchronize Sync a repository
update Update a repository
upload-content Upload content into the repository
Options:
10.52.1. hammer repository create

Create a custom repository
Usage:
hammer repository create [OPTIONS]
270
Options:
--checksum-type CHECKSUM_TYPE checksum of
the repository, currently 'sha1' & 'sha256'
are
supported.
--content-type CONTENT_TYPE type of repo
(either 'yum', 'puppet', 'docker', or
'ostree')
Possible
value(s): 'docker', 'file', 'puppet', 'yum', 'ostree'
--docker-upstream-name DOCKER_UPSTREAM_NAME name of the
upstream docker repository
--download-policy DOWNLOAD_POLICY download
policy for yum repos (either 'immediate',
'on_demand',
or 'background')
Possible
value(s): 'immediate', 'on_demand', 'background'
--gpg-key GPG_KEY_NAME Name to
search by
--gpg-key-id GPG_KEY_ID gpg key
numeric identifier
--ignore-global-proxy IGNORE_GLOBAL_PROXY if true, will
ignore the globally configured Capsule when syncing.
One of
--label LABEL
--mirror-on-sync MIRROR_ON_SYNC true if this
repository when synced has to be mirrored from the source and
stale rpms
removed.
One of
--name NAME
name to search by
ID
label to search by
--ostree-upstream-sync-depth OSTREE_UPSTREAM_SYNC_DEPTH if a custom
sync policy is chosen for ostree repositories then a
'depth'
value must be provided.
--ostree-upstream-sync-policy OSTREE_UPSTREAM_SYNC_POLICY policies for
syncing upstream ostree repositories.
Possible
value(s): 'latest', 'all', 'custom'
to search by
numeric identifier
--publish-via-http ENABLE Publish Via
HTTP
One of
271

--upstream-password UPSTREAM_PASSWORD Password of
the upstream repository user used for authentication
--upstream-username UPSTREAM_USERNAME Username of
the upstream repository user used for authentication
--url URL repository
source url
--verify-ssl-on-sync VERIFY_SSL_ON_SYNC if true,
Katello will verify the upstream url's SSL certifcates are
signed by a
trusted CA.
One of
10.52.2. hammer repository delete

Destroy a custom repository
Usage:
hammer repository delete [OPTIONS]
Options:
--id ID
--name NAME Repository name to search by
10.52.3. hammer repository export

Export content from a repository to the configured directory
Usage:
hammer repository export [OPTIONS]
Options:
--export-to-iso EXPORT_TO_ISO Export to ISO format
--id ID Repository identifier
--iso-mb-size ISO_MB_SIZE maximum size of each ISO in MB
--since SINCE Optional date of last export
(ex: 2010-01-01T12:00:00Z)
272
10.52.4. hammer repository info

Show a repository
Usage:
hammer repository info [OPTIONS]
Options:
--id ID repository ID
10.52.5. hammer repository list

List of enabled repositories
Usage:
hammer repository list [OPTIONS]
Options:
--available-for AVAILABLE_FOR interpret specified
object to return only Repositories that can be
associated with
specified object. Only 'content_view' is
supported.
results on
--content-type CONTENT_TYPE limit to only
repositories of this type
Possible value(s):
'docker', 'file', 'puppet', 'yum', 'ostree'
search by
identifier
number
identifier
--erratum-id ERRATUM_ID Id of an erratum to
find repositories that contain the erratum
show all results
One of true/false,
yes/no, 1/0.
--library LIBRARY show repositories
in Library and the default content view
One of true/false,
273
yes/no, 1/0.
--name NAME name of the
repository
search by
to search by
--ostree-branch OSTREE_BRANCH_NAME Name to search by
--ostree-branch-id OSTREE_BRANCH_ID an ostree branch
identifier
starting at 1
per page to return
search by
identifier
--rpm-id RPM_ID Id of a package to
find repositories that contain the rpm
10.52.6. hammer repository remove-content

Remove content from a repository
Usage:
hammer repository remove-content [OPTIONS]
Options:
--ids IDS Array of content ids to remove
--sync-capsule SYNC_CAPSULE Whether or not to sync an
external capsule after upload. Default: true
10.52.7. hammer repository synchronize

Sync a repository
Usage:
274
hammer repository synchronize [OPTIONS]
Options:
--incremental INCREMENTAL perform an incremental import
1/0.
--skip-metadata-check SKIP_METADATA_CHECK Force sync even if no upstream
changes are detected. Only used with yum
repositories.
1/0.
--source-url SOURCE_URL temporarily override feed URL
for sync
--validate-contents VALIDATE_CONTENTS Force a sync and validate the
checksums of all content. Only used with yum
repositories.
1/0.
10.52.8. hammer repository update

Update a repository
Usage:
hammer repository update [OPTIONS]
Options:
--checksum-type CHECKSUM_TYPE checksum of
the repository, currently 'sha1' & 'sha256'
are
supported.'
--docker-upstream-name DOCKER_UPSTREAM_NAME name of the
upstream docker repository
--download-policy DOWNLOAD_POLICY download
policy for yum repos (either 'immediate',
'on_demand',
or 'background')
Possible
value(s): 'immediate', 'on_demand', 'background'
--gpg-key GPG_KEY_NAME Name to
search by
--gpg-key-id GPG_KEY_ID gpg key
numeric identifier
--id ID repository
ID
--mirror-on-sync MIRROR_ON_SYNC true if this
275
repository when synced has to be mirrored from the source and

stale rpms
removed.
One of
--name NAME Repository
name to search by
--new-name NEW_NAME New name for
the repository
name to search by
--organization-id ORGANIZATION_ID Organization
ID to search by
label to search by
--ostree-upstream-sync-depth OSTREE_UPSTREAM_SYNC_DEPTH if a custom
sync policy is chosen for ostree repositories then a
'depth'
value must be provided.
--ostree-upstream-sync-policy OSTREE_UPSTREAM_SYNC_POLICY policies for
syncing upstream ostree repositories.
Possible
value(s): 'latest', 'all', 'custom'
to search by
numeric identifier
--publish-via-http ENABLE Publish Via
HTTP
One of
--upstream-password UPSTREAM_PASSWORD Password of
the upstream repository user for authentication
--upstream-username UPSTREAM_USERNAME Username of
the upstream repository user for authentication
--url URL the feed url
of the original repository
--verify-ssl-on-sync VERIFY_SSL_ON_SYNC if true,
Katello will verify the upstream url's SSL certifcates are
signed by a
trusted CA.
One of
10.52.9. hammer repository upload-content

Upload content into the repository
Usage:
hammer repository upload-content [OPTIONS]
Options:
276

--path PATH Upload file, directory of files,
or glob of files as content for a repository.
Globs must be escaped by single
or double quotes.
10.53. HAMMER REPOSITORY-SET

Manipulate repository sets on the server
Usage:
hammer repository-set [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
available-repositories Get list of available repositories for the
repository set
disable Disable a repository from the set
enable Enable a repository from the set
info Get info about a repository set
list List repository sets for a product.
Options:
10.53.1. hammer repository-set available-repositories

Get list of available repositories for the repository set
Usage:
hammer repository-set available-repositories [OPTIONS]
Options:
--id ID ID of the repository set
--name NAME Repository set name to search by
10.53.2. hammer repository-set disable

Disable a repository from the set
277
Usage:
hammer repository-set disable [OPTIONS]
Options:
--basearch BASEARCH Basearch to disable
--id ID ID of the repository set to
disable
--releasever RELEASEVER Releasever to disable
10.53.3. hammer repository-set enable

Enable a repository from the set
Usage:
hammer repository-set enable [OPTIONS]
Options:
--basearch BASEARCH Basearch to enable
--id ID ID of the repository set to
enable
--releasever RELEASEVER Releasever to enable
10.53.4. hammer repository-set info

Get info about a repository set
Usage:
hammer repository-set info [OPTIONS]
Options:
--id ID ID of the repository set
278
10.53.5. hammer repository-set list

List repository sets for a product.
Usage:
hammer repository-set list [OPTIONS]
Options:
results
--name NAME Repository set name to search on
DESC'
return
10.54. HAMMER ROLE

Manage user roles.
Usage:
hammer role [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
clone Clone a role
create Create a role
delete Delete a role
filters List all filters
info Show a role
list List all roles
update Update a role
Options:
10.54.1. hammer role clone

Clone a role
Usage:
279
hammer role clone [OPTIONS]
Options:
--description DESCRIPTION Role description
--id ID
ids
--name NAME User role name
--new-name NEW_NAME
given ids.
10.54.2. hammer role create

Create a role
Usage:
hammer role create [OPTIONS]
Options:
ids
--name NAME
given ids.
10.54.3. hammer role delete
280
Delete a role
Usage:
hammer role delete [OPTIONS]
Options:
--id ID
10.54.4. hammer role filters

List all filters
Usage:
hammer role filters [OPTIONS]
Options:
--id ID User role id
10.54.5. hammer role info

Show a role
Usage:
hammer role info [OPTIONS]
Options:
--id ID
10.54.6. hammer role list

List all roles
Usage:
hammer role list [OPTIONS]
Options:
281
10.54.7. hammer role update

Update a role
Usage:
hammer role update [OPTIONS]
Options:
--id ID
ids
--new-name NEW_NAME
given ids.
10.55. HAMMER SC-PARAM

Manipulate smart class parameters.
Usage:
hammer sc-param [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-override-value Create an override value for a specific
smart variable
info Show a smart class parameter
list List all smart class parameters
remove-override-value Delete an override value for a specific
smart variable
update Update a smart class parameter
Options:
10.55.1. hammer sc-param add-override-value
282
Create an override value for a specific smart variable
Usage:
hammer sc-param add-override-value [OPTIONS]
Options:
--match MATCH Override match
--omit OMIT Satellite will not
send this parameter in classification output, replaces
use_puppet_default
One of true/false,
yes/no, 1/0.
--smart-class-parameter SMART_CLASS_PARAMETER_NAME Smart class parameter
name
--smart-class-parameter-id SMART_CLASS_PARAMETER_ID
--use-puppet-default USE_PUPPET_DEFAULT Deprecated, please
use omit
One of true/false,
yes/no, 1/0.
--value VALUE Override value,
required if omit is false
10.55.2. hammer sc-param info

Show a smart class parameter
Usage:
hammer sc-param info [OPTIONS]
Options:
--id ID
--name NAME Smart class parameter name
10.55.3. hammer sc-param list

Usage:
hammer sc-param list [OPTIONS]
Options:
--host-id HOST_ID
283
10.55.4. hammer sc-param remove-override-value

Delete an override value for a specific smart variable
Usage:
hammer sc-param remove-override-value [OPTIONS]
Options:
--id ID
--smart-class-parameter SMART_CLASS_PARAMETER_NAME Smart class parameter
name
--smart-class-parameter-id SMART_CLASS_PARAMETER_ID
10.55.5. hammer sc-param update

Update a smart class parameter
Usage:
hammer sc-param update [OPTIONS]
Options:
--avoid-duplicates AVOID_DUPLICATES Remove duplicate values (only
array type)
1/0.
--default-value DEFAULT_VALUE Value to use when there is
no match
--description DESCRIPTION Description of smart class
--hidden-value HIDDEN_VALUE When enabled the parameter
is hidden in the UI
1/0.
--id ID
--merge-default MERGE_DEFAULT Include default value when
merging all matching values
1/0.
--merge-overrides MERGE_OVERRIDES Merge all matching values
(only array/hash type)
284

1/0.
--name NAME Smart class parameter name
--omit OMIT Satellite will not send
this parameter in classification output. Puppet
will use the value defined
in the Puppet manifest for this parameter
1/0.
--override OVERRIDE Override this parameter.
1/0.
--override-value-order OVERRIDE_VALUE_ORDER The order in which values are
resolved
--parameter-type PARAMETER_TYPE Type of the parameter.
Possible value(s):
'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
--path PATH The order in which values
are resolved
--required REQUIRED This parameter is required.
1/0.
--use-puppet-default USE_PUPPET_DEFAULT Deprecated, please use omit
1/0.
--validator-rule VALIDATOR_RULE Used to enforce certain
values for the parameter values
--validator-type VALIDATOR_TYPE Type of the validator.
Possible value(s):
'regexp', 'list', ''
10.56. HAMMER SCAP-CONTENT

Manipulate SCAP contents
Usage:
hammer scap-content [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create SCAP content
delete Deletes an SCAP content
download Show an SCAP content as XML
info Show an SCAP content
list List SCAP contents
update Update an SCAP content
285
Options:
10.56.1. hammer scap-content create

Create SCAP content
Usage:
hammer scap-content create [OPTIONS]
Options:
--location-ids LOCATION_IDS REPLACE locations with given ids
--locations LOCATION_NAMES Comma separated list of values.
--organization-ids ORGANIZATION_IDS REPLACE organizations with given
ids.
--original-filename ORIGINAL_FILENAME Original file name of the XML file
--scap-file SCAP_FILE SCAP content file
--title TITLE SCAP content name
10.56.2. hammer scap-content delete

Deletes an SCAP content
Usage:
hammer scap-content delete [OPTIONS]
Options:
--id ID
--title TITLE SCAP content title
10.56.3. hammer scap-content download

Show an SCAP content as XML
Usage:
hammer scap-content download [OPTIONS]
Options:
--id ID
will be saved
286
10.56.4. hammer scap-content info

Show an SCAP content
Usage:
hammer scap-content info [OPTIONS]
Options:
--id ID
10.56.5. hammer scap-content list

List SCAP contents
Usage:
hammer scap-content list [OPTIONS]
Options:
10.56.6. hammer scap-content update

Update an SCAP content
Usage:
hammer scap-content update [OPTIONS]
Options:
--id ID
--new-title NEW_TITLE SCAP content name
ids.
--scap-file SCAP_FILE SCAP content file
10.57. HAMMER SETTINGS
287
Change server settings.
Usage:
hammer settings [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
list List all settings
set Update a setting
Options:
10.57.1. hammer settings list

List all settings
Usage:
hammer settings list [OPTIONS]
Options:
10.57.2. hammer settings set

Update a setting
Usage:
hammer settings set [OPTIONS]
Options:
--id ID
--name NAME Setting name
--value VALUE
10.58. HAMMER SHELL

Interactive shell
Usage:
hammer shell [OPTIONS]
Options:
288
10.59. HAMMER SMART-VARIABLE

Manipulate smart variables.
Usage:
hammer smart-variable [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-override-value Create an override value for a specific
smart variable
create Create a smart variable
delete Delete a smart variable
info Show a smart variable
list List all smart variables
remove-override-value Delete an override value for a specific
smart variable
update Update a smart variable
Options:
10.59.1. hammer smart-variable add-override-value

Create an override value for a specific smart variable
Usage:
hammer smart-variable add-override-value [OPTIONS]
Options:
--match MATCH Override match
--omit OMIT Satellite will not send this
parameter in classification output, replaces
use_puppet_default
1/0.
--smart-variable SMART_VARIABLE_VARIABLE Smart variable name
--smart-variable-id SMART_VARIABLE_ID
--use-puppet-default USE_PUPPET_DEFAULT Deprecated, please use omit
1/0.
--value VALUE Override value, required if
omit is false
10.59.2. hammer smart-variable create

Create a smart variable
Usage:
hammer smart-variable create [OPTIONS]
289
Options:
array type)
1/0.
--default-value DEFAULT_VALUE Default value of variable
--description DESCRIPTION Description of variable
is hidden in the UI
1/0.
1/0.
1/0.
resolved
Possible value(s):
--variable VARIABLE Name of variable
--variable-type VARIABLE_TYPE Type of the variable.
Possible value(s):
10.59.3. hammer smart-variable delete

Delete a smart variable
Usage:
hammer smart-variable delete [OPTIONS]
Options:
--id ID
--name NAME Smart variable name (Deprecated: Use --
variable instead)
--variable VARIABLE Smart variable name
10.59.4. hammer smart-variable info

Show a smart variable
290
Usage:
hammer smart-variable info [OPTIONS]
Options:
--id ID
--name NAME Smart variable name (Deprecated: Use --
variable instead)
10.59.5. hammer smart-variable list

Usage:
hammer smart-variable list [OPTIONS]
Options:
--host-id HOST_ID
10.59.6. hammer smart-variable remove-override-value

Delete an override value for a specific smart variable
Usage:
hammer smart-variable remove-override-value [OPTIONS]
Options:
--id ID
--smart-variable SMART_VARIABLE_VARIABLE Smart variable name
--smart-variable-id SMART_VARIABLE_ID
10.59.7. hammer smart-variable update

Update a smart variable
Usage:
291
hammer smart-variable update [OPTIONS]
Options:
array type)
1/0.
--default-value DEFAULT_VALUE Default value of variable
--description DESCRIPTION Description of variable
is hidden in the UI
1/0.
--id ID
1/0.
1/0.
--new-variable NEW_VARIABLE Name of variable
resolved
Possible value(s):
--variable-type VARIABLE_TYPE Type of the variable.
Possible value(s):
10.60. HAMMER SUBNET

Manipulate subnets.
Usage:
hammer subnet [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a subnet
delete Delete a subnet
delete-parameter Delete parameter for a subnet.
292
info Show a subnet

list List of subnets
set-parameter Create or update parameter for a subnet.
update Update a subnet
Options:
10.60.1. hammer subnet create

Create a subnet
Usage:
hammer subnet create [OPTIONS]
Options:
--boot-mode BOOT_MODE Default boot mode for
interfaces assigned to this subnet, valid values are
“Static”, “DHCP”
--dhcp-id DHCP_ID DHCP Capsule ID to use within
this subnet
--discovery-id DISCOVERY_ID ID of Discovery Capsule to use
within this subnet for managing connection
to discovered hosts
--dns-id DNS_ID DNS Capsule ID to use within
this subnet
--dns-primary DNS_PRIMARY Primary DNS for this subnet
--dns-secondary DNS_SECONDARY Secondary DNS for this subnet
--domain-ids DOMAIN_IDS Domains in which this subnet
is part
--domains DOMAIN_NAMES Comma separated list of
--from FROM Starting IP Address for IP
auto suggestion
--gateway GATEWAY Primary DNS for this subnet
--ipam IPAM IP Address auto suggestion
mode for this subnet, valid values are “DHCP”,
“Internal DB”, “None”
ids
--mask MASK Netmask for this subnet
--name NAME Subnet name
--network NETWORK Subnet network
--network-type NETWORK_TYPE Type or protocol, IPv4 or
IPv6, defaults to IPv4
Possible value(s): 'IPv4',
'IPv6'
293

given ids.
--tftp-id TFTP_ID TFTP Capsule ID to use within
this subnet
--to TO Ending IP Address for IP auto
suggestion
--vlanid VLANID VLAN ID for this subnet
10.60.2. hammer subnet delete

Delete a subnet
Usage:
hammer subnet delete [OPTIONS]
Options:
--id ID Subnet numeric identifier
10.60.3. hammer subnet delete-parameter

Delete parameter for a subnet.
Usage:
hammer subnet delete-parameter [OPTIONS]
Options:
10.60.4. hammer subnet info

Show a subnet
Usage:
hammer subnet info [OPTIONS]
Options:
--id ID
values
294
One of true/false,
yes/no, 1/0.
10.60.5. hammer subnet list

List of subnets
Usage:
hammer subnet list [OPTIONS]
Options:
10.60.6. hammer subnet set-parameter

Create or update parameter for a subnet.
Usage:
hammer subnet set-parameter [OPTIONS]
Options:
10.60.7. hammer subnet update

Update a subnet
Usage:
hammer subnet update [OPTIONS]
Options:
--boot-mode BOOT_MODE Default boot mode for
interfaces assigned to this subnet, valid values are
“Static”, “DHCP”
295
--dhcp-id DHCP_ID DHCP Capsule ID to use within

this subnet
--discovery-id DISCOVERY_ID ID of Discovery Capsule to use
within this subnet for managing connection
to discovered hosts
--dns-id DNS_ID DNS Capsule ID to use within
this subnet
--dns-primary DNS_PRIMARY Primary DNS for this subnet
--dns-secondary DNS_SECONDARY Secondary DNS for this subnet
--domain-ids DOMAIN_IDS Domains in which this subnet
is part
--domains DOMAIN_NAMES Comma separated list of
--from FROM Starting IP Address for IP
auto suggestion
--gateway GATEWAY Primary DNS for this subnet
--id ID Subnet numeric identifier
--ipam IPAM IP Address auto suggestion
mode for this subnet, valid values are “DHCP”,
“Internal DB”, “None”
ids
--mask MASK Netmask for this subnet
--network NETWORK Subnet network
--network-type NETWORK_TYPE Type or protocol, IPv4 or
IPv6, defaults to IPv4
Possible value(s): 'IPv4',
'IPv6'
--new-name NEW_NAME Subnet name
given ids.
--tftp-id TFTP_ID TFTP Capsule ID to use within
this subnet
--to TO Ending IP Address for IP auto
suggestion
--vlanid VLANID VLAN ID for this subnet
10.61. HAMMER SUBSCRIPTION
296
Manipulate subscriptions.
Usage:
hammer subscription [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
delete-manifest Delete manifest from Red Hat provider
list List organization subscriptions
manifest-history obtain manifest history for subscriptions
refresh-manifest Refresh previously imported manifest for
Red Hat provider
upload Upload a subscription manifest
Options:
10.61.1. hammer subscription delete-manifest

Delete manifest from Red Hat provider
Usage:
hammer subscription delete-manifest [OPTIONS]
Options:
10.61.2. hammer subscription list

List organization subscriptions
Usage:
hammer subscription list [OPTIONS]
Options:
--available-for AVAILABLE_FOR Object to show subscriptions
available for, either 'host' or
'activation_key'
results
--host-id HOST_ID
--match-host MATCH_HOST Ignore subscriptions that are
297
unavailable to the specified host

--match-installed MATCH_INSTALLED Return subscriptions that match
installed products of the specified host
--no-overlap NO_OVERLAP Return subscriptions which do
not overlap with a currently-attached
subscription
DESC'
return
10.61.3. hammer subscription manifest-history

obtain manifest history for subscriptions
Usage:
hammer subscription manifest-history [OPTIONS]
Options:
10.61.4. hammer subscription refresh-manifest

Refresh previously imported manifest for Red Hat provider
Usage:
hammer subscription refresh-manifest [OPTIONS]
Options:
10.61.5. hammer subscription upload

Upload a subscription manifest
Usage:
hammer subscription upload [OPTIONS]
298
Options:
--file MANIFEST Subscription manifest file
--repository-url REPOSITORY_URL repository url
10.62. HAMMER SYNC-PLAN

Manipulate sync plans
Usage:
hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a sync plan
delete Destroy a sync plan
info Show a sync plan
list List sync plans
update Update a sync plan
Options:
10.62.1. hammer sync-plan create

Create a sync plan
Usage:
hammer sync-plan create [OPTIONS]
Options:
--description DESCRIPTION sync plan description
--enabled ENABLED enables or disables
synchronization
--interval INTERVAL how often synchronization should
run
Possible value(s): 'hourly',
'daily', 'weekly'
--name NAME sync plan name
--sync-date SYNC_DATE Start date and time for the sync
plan.Time is optional, if kept blank current system time will be
considered
299
Date and time in YYYY-MM-DD

HH:MM:SS or ISO 8601 format
10.62.2. hammer sync-plan delete

Destroy a sync plan
Usage:
hammer sync-plan delete [OPTIONS]
Options:
--id ID sync plan numeric identifier
--name NAME Sync plan name to search by
10.62.3. hammer sync-plan info

Show a sync plan
Usage:
hammer sync-plan info [OPTIONS]
Options:
10.62.4. hammer sync-plan list

List sync plans
Usage:
hammer sync-plan list [OPTIONS]
Options:
results
--interval INTERVAL filter by interval
'daily', 'weekly'
--name NAME filter by name
DESC'
300

return
--sync-date SYNC_DATE filter by sync date
10.62.5. hammer sync-plan update

Update a sync plan
Usage:
hammer sync-plan update [OPTIONS]
Options:
--description DESCRIPTION sync plan description
--enabled ENABLED enables or disables
synchronization
--interval INTERVAL how often synchronization should
run
'daily', 'weekly'
--new-name NEW_NAME sync plan name
--sync-date SYNC_DATE start date and time of the
synchronization
Date and time in YYYY-MM-DD
HH:MM:SS or ISO 8601 format
10.63. HAMMER TAILORING-FILE

Manipulate Tailoring files
Usage:
hammer tailoring-file [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a Tailoring file
delete Deletes a Tailoring file
download Show a Tailoring file as XML
info Show a Tailoring file
list List Tailoring files
301
update Update a Tailoring file
Options:
10.63.1. hammer tailoring-file create

Create a Tailoring file
Usage:
hammer tailoring-file create [OPTIONS]
Options:
--name NAME Tailoring file name
ids.
--scap-file SCAP_FILE Tailoring file content
10.63.2. hammer tailoring-file delete

Deletes a Tailoring file
Usage:
hammer tailoring-file delete [OPTIONS]
Options:
--id ID
10.63.3. hammer tailoring-file download

Show a Tailoring file as XML
Usage:
hammer tailoring-file download [OPTIONS]
Options:
--id ID
302

will be saved
10.63.4. hammer tailoring-file info

Show a Tailoring file
Usage:
hammer tailoring-file info [OPTIONS]
Options:
--id ID
10.63.5. hammer tailoring-file list

List Tailoring files
Usage:
hammer tailoring-file list [OPTIONS]
Options:
10.63.6. hammer tailoring-file update

Update a Tailoring file
Usage:
hammer tailoring-file update [OPTIONS]
Options:
--id ID
--new-name NEW_NAME Tailoring file name
ids.
303

--scap-file SCAP_FILE Tailoring file content
10.64. HAMMER TASK

Tasks related actions.
Usage:
hammer task [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
list List tasks
progress Show the progress of the task
resume Resume all tasks paused in error state
Options:
10.64.1. hammer task list

List tasks
Usage:
hammer task list [OPTIONS]
Options:
--order ORDER Sort field and order, e.g. 'name DESC'
10.64.2. hammer task progress

Show the progress of the task
Usage:
hammer task progress [OPTIONS]
Options:
--id ID UUID of the task
10.64.3. hammer task resume
304
Resume all tasks paused in error state
Usage:
hammer task resume [OPTIONS]
Options:
--search SEARCH Resume tasks matching search string
--task-ids TASK_IDS Resume specific tasks by ID
--tasks TASK_NAMES Comma separated list of values. Values
10.65. HAMMER TEMPLATE

Manipulate config templates.
Usage:
hammer template [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
build-pxe-default Update the default PXE menu on all
configured TFTP servers
clone Clone a provision template
create Create a provisioning template
delete Delete a provisioning template
dump View provisioning template content.
info Show provisioning template details
kinds List available provisioning template
kinds.
list List provisioning templates
update Update a provisioning template
Options:
10.65.1. hammer template add-operatingsystem

Usage:
hammer template add-operatingsystem [OPTIONS]
Options:
--id ID
305

10.65.2. hammer template build-pxe-default

Update the default PXE menu on all configured TFTP servers
Usage:
hammer template build-pxe-default [OPTIONS]
Options:
10.65.3. hammer template clone

Clone a provision template
Usage:
hammer template clone [OPTIONS]
Options:
--id ID
--new-name NEW_NAME template name
10.65.4. hammer template create

Create a provisioning template
Usage:
hammer template create [OPTIONS]
Options:
the template
ids
locked for editing
1/0.
--name NAME template name
to associate with the template
306

given ids.
--type TYPE Template type. Eg. snippet,
script, provision
10.65.5. hammer template delete

Delete a provisioning template
Usage:
hammer template delete [OPTIONS]
Options:
--id ID
10.65.6. hammer template dump

View provisioning template content.
Usage:
hammer template dump [OPTIONS]
Options:
--id ID
10.65.7. hammer template info

Show provisioning template details
Usage:
hammer template info [OPTIONS]
Options:
--id ID
307
10.65.8. hammer template kinds

List available provisioning template kinds.
Usage:
hammer template kinds [OPTIONS]
Options:
10.65.9. hammer template list

List provisioning templates
Usage:
hammer template list [OPTIONS]
Options:
10.65.10. hammer template remove-operatingsystem

Usage:
hammer template remove-operatingsystem [OPTIONS]
Options:
--id ID
10.65.11. hammer template update

Update a provisioning template
Usage:
hammer template update [OPTIONS]
308
Options:
the template
--id ID
ids
locked for editing
1/0.
--new-name NEW_NAME template name
to associate with the template
given ids.
--type TYPE Template type. Eg. snippet,
script, provision
10.66. HAMMER TEMPLATE-INPUT

Manage template inputs
Usage:
hammer template-input [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a template input
delete Delete a template input
info Show template input details
list List template inputs
309
Options:
10.66.1. hammer template-input create

Create a template input
Usage:
hammer template-input create [OPTIONS]
Options:
--advanced ADVANCED Input is advanced
One of true/false,
yes/no, 1/0.
--description DESCRIPTION Input description
--fact-name FACT_NAME Fact name, used when
input type is fact
--input-type INPUT_TYPE Input type
Possible value(s):
'user', 'fact', 'variable', 'puppet_parameter'
--name NAME Input name
--options OPTIONS Selectable values for
user inputs
backslash
--puppet-parameter-class PUPPET_PARAMETER_CLASS Puppet class name, used
when input type is puppet_parameter
--puppet-parameter-name PUPPET_PARAMETER_NAME Puppet parameter name,
used when input type is puppet_parameter
--required REQUIRED Input is required
One of true/false,
yes/no, 1/0.
--variable-name VARIABLE_NAME Variable name, used when
input type is variable
10.66.2. hammer template-input delete

Delete a template input
Usage:
hammer template-input delete [OPTIONS]
Options:
--id ID
10.66.3. hammer template-input info
310
Show template input details
Usage:
hammer template-input info [OPTIONS]
Options:
--id ID
10.66.4. hammer template-input list

List template inputs
Usage:
hammer template-input list [OPTIONS]
Options:
10.67. HAMMER USER

Manipulate users.
Usage:
hammer user [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-role Assign a user role
create Create a user
delete Delete a user
info Show a user
list List all users
remove-role Remove a user role
ssh-keys Managing User SSH Keys.
update Update a user
Options:
10.67.1. hammer user add-role

Assign a user role
311
Usage:
hammer user add-role [OPTIONS]
Options:
--id ID
--login LOGIN User's login to search by
--role-id ROLE_ID
10.67.2. hammer user create

Create a user
Usage:
hammer user create [OPTIONS]
Options:
--admin ADMIN is an admin account
One of true/false,
yes/no, 1/0.
--ask-password ASK_PW One of true/false,
yes/no, 1/0.
--auth-source-id AUTH_SOURCE_ID
--default-location DEFAULT_LOCATION_NAME Default location name
--default-location-id DEFAULT_LOCATION_ID
--default-organization DEFAULT_ORGANIZATION_NAME Default organization
name
--default-organization-id DEFAULT_ORGANIZATION_ID
--firstname FIRSTNAME
--lastname LASTNAME
--locale LOCALE User's preferred
locale
Possible value(s):
'ca', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'pl',
'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW'
given ids
backslash
--location-titles LOCATION_TITLES Comma separated list
backslash
--locations LOCATION_NAMES Comma separated list
backslash
--login LOGIN
--mail MAIL
--organization-ids ORGANIZATION_IDS REPLACE organizations
with given ids.
backslash
312

--organizations ORGANIZATION_NAMES Comma separated list
backslash
--password PASSWORD
--role-ids ROLE_IDS Comma separated list
backslash
--roles ROLE_NAMES Comma separated list
backslash
--timezone TIMEZONE User's timezone
Possible value(s):
'American Samoa', 'International Date Line West', 'Midway Island',
'Samoa', 'Hawaii', 'Alaska', 'Pacific Time (US & Canada)', 'Tijuana',
'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US & Canada)',
'Central America', 'Central Time (US & Canada)', 'Guadalajara', 'Mexico
City', 'Monterrey', 'Saskatchewan', 'Bogota', 'Eastern Time (US &
Canada)', 'Indiana (East)', 'Lima', 'Quito', 'Atlantic Time (Canada)',
'Caracas', 'Georgetown', 'La Paz', 'Santiago', 'Newfoundland', 'Brasilia',
'Buenos Aires', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape
Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London',
'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern',
'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid',
'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna',
'Warsaw', 'West Central Africa', 'Zagreb', 'Athens', 'Bucharest', 'Cairo',
'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria',
'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait',
'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Volgograd',
'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Yerevan',
'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai',
'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu',
'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi',
'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong
Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei',
'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk',
'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart',
'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New
Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji',
'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku'alofa',
'Tokelau Is.'
10.67.3. hammer user delete

Delete a user
Usage:
hammer user delete [OPTIONS]
Options:
--id ID
313
10.67.4. hammer user info

Show a user
Usage:
hammer user info [OPTIONS]
Options:
--id ID
10.67.5. hammer user list

List all users
Usage:
hammer user list [OPTIONS]
Options:
--auth-source-ldap AUTH_SOURCE_LDAP_NAME Name to search by
--auth-source-ldap-id AUTH_SOURCE_LDAP_ID
--role-id ROLE_ID
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
10.67.6. hammer user remove-role

Remove a user role
Usage:
hammer user remove-role [OPTIONS]
Options:
--id ID
--role-id ROLE_ID
10.67.7. hammer user ssh-keys
314
Managing User SSH Keys.
Usage:
hammer user ssh-keys [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add Create an SSH key for a user
delete Delete an SSH key for a user
info Show an SSH key from a user
list List all SSH keys for a user
Options:
10.67.7.1. hammer user ssh-keys add
Create an SSH key for a user
Usage:
hammer user ssh-keys add [OPTIONS]
Options:
--key KEY Public SSH key
--key-file KEY_FILE Path to a SSH public key
--name NAME
--user-id USER_ID
10.67.7.2. hammer user ssh-keys delete
Delete an SSH key for a user
Usage:
hammer user ssh-keys delete [OPTIONS]
Options:
--id ID
--user-id USER_ID
10.67.7.3. hammer user ssh-keys info
Show an SSH key from a user
Usage:
hammer user ssh-keys info [OPTIONS]
315
Options:
--id ID
--user-id USER_ID
10.67.7.4. hammer user ssh-keys list
List all SSH keys for a user
Usage:
hammer user ssh-keys list [OPTIONS]
Options:
--user-id USER_ID
10.67.8. hammer user update

Update a user
Usage:
hammer user update [OPTIONS]
Options:
--admin ADMIN is an admin account
One of true/false,
yes/no, 1/0.
--ask-password ASK_PW One of true/false,
yes/no, 1/0.
--auth-source-id AUTH_SOURCE_ID
--current-password CURRENT_PASSWORD Required when user
want to change own password
--default-location DEFAULT_LOCATION_NAME Default location name
--default-location-id DEFAULT_LOCATION_ID
--default-organization DEFAULT_ORGANIZATION_NAME Default organization
name
--default-organization-id DEFAULT_ORGANIZATION_ID
--firstname FIRSTNAME
--id ID
--lastname LASTNAME
--locale LOCALE User's preferred
locale
Possible value(s):
'ca', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'pl',
'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW'
316

given ids
backslash
--location-titles LOCATION_TITLES Comma separated list
backslash
--locations LOCATION_NAMES Comma separated list
backslash
--login LOGIN User's login to
search by
--mail MAIL
--new-login NEW_LOGIN
--organization-ids ORGANIZATION_IDS REPLACE organizations
with given ids.
backslash
--organizations ORGANIZATION_NAMES Comma separated list
backslash
--password PASSWORD
--role-ids ROLE_IDS Comma separated list
backslash
--roles ROLE_NAMES Comma separated list
backslash
--timezone TIMEZONE User's timezone
Possible value(s):
'American Samoa', 'International Date Line West', 'Midway Island',
'Samoa', 'Hawaii', 'Alaska', 'Pacific Time (US & Canada)', 'Tijuana',
'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US & Canada)',
'Central America', 'Central Time (US & Canada)', 'Guadalajara', 'Mexico
City', 'Monterrey', 'Saskatchewan', 'Bogota', 'Eastern Time (US &
Canada)', 'Indiana (East)', 'Lima', 'Quito', 'Atlantic Time (Canada)',
'Caracas', 'Georgetown', 'La Paz', 'Santiago', 'Newfoundland', 'Brasilia',
'Buenos Aires', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape
Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London',
'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern',
'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid',
'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna',
'Warsaw', 'West Central Africa', 'Zagreb', 'Athens', 'Bucharest', 'Cairo',
'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria',
'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait',
'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Volgograd',
'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Yerevan',
'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai',
'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu',
'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi',
'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong
Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei',
317
'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk',

'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart',
'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New
Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji',
'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku'alofa',
'Tokelau Is.'
10.68. HAMMER USER-GROUP

Manage user groups.
Usage:
hammer user-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
add-role Assign a user role
add-user-group Associate an user group
create Create a user group
delete Delete a user group
external View and manage user group's external user
groups
info Show a user group
list List all user groups
remove-role Remove a user role
remove-user-group Disassociate an user group
update Update a user group
Options:
10.68.1. hammer user-group add-role

Assign a user role
Usage:
hammer user-group add-role [OPTIONS]
Options:
--id ID
--role-id ROLE_ID
10.68.2. hammer user-group add-user
318
Associate an user
Usage:
hammer user-group add-user [OPTIONS]
Options:
--id ID
--user-id USER_ID
10.68.3. hammer user-group add-user-group

Associate an user group
Usage:
hammer user-group add-user-group [OPTIONS]
Options:
--id ID
10.68.4. hammer user-group create

Create a user group
Usage:
hammer user-group create [OPTIONS]
Options:
--admin ADMIN is an admin user group
--name NAME
--role-ids ROLE_IDS Comma separated list of values. Values
--roles ROLE_NAMES Comma separated list of values. Values
--user-group-ids USER_GROUP_IDS Comma separated list of values. Values
--user-groups USER_GROUP_NAMES Comma separated list of values. Values
--user-ids USER_IDS Comma separated list of values. Values
--users USER_LOGINS Comma separated list of values. Values
10.68.5. hammer user-group delete
319
Delete a user group
Usage:
hammer user-group delete [OPTIONS]
Options:
--id ID
10.68.6. hammer user-group external

View and manage user group’s external user groups
Usage:
hammer user-group external [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create an external user group linked to a
user group
delete Delete an external user group
info Show an external user group for user group
list List all external user groups for user
group
refresh Refresh external user group
update Update external user group
Options:
10.68.6.1. hammer user-group external create
Create an external user group linked to a user group
Usage:
hammer user-group external create [OPTIONS]
Options:
--auth-source-id AUTH_SOURCE_ID ID of linked authentication source
--name NAME External user group name
10.68.6.2. hammer user-group external delete
Delete an external user group
Usage:
320
hammer user-group external delete [OPTIONS]
Options:
--id ID ID or name external user group
10.68.6.3. hammer user-group external info
Show an external user group for user group
Usage:
hammer user-group external info [OPTIONS]
Options:
--id ID ID or name of external user group
10.68.6.4. hammer user-group external list
List all external user groups for user group
Usage:
hammer user-group external list [OPTIONS]
Options:
10.68.6.5. hammer user-group external refresh
Refresh external user group
Usage:
hammer user-group external refresh [OPTIONS]
Options:
10.68.6.6. hammer user-group external update
Update external user group
321
Usage:
hammer user-group external update [OPTIONS]
Options:
--auth-source-id AUTH_SOURCE_ID ID of linked authentication source
--new-name NEW_NAME External user group name
10.68.7. hammer user-group info

Show a user group
Usage:
hammer user-group info [OPTIONS]
Options:
--id ID
10.68.8. hammer user-group list

List all user groups
Usage:
hammer user-group list [OPTIONS]
Options:
10.68.9. hammer user-group remove-role

Remove a user role
Usage:
hammer user-group remove-role [OPTIONS]
Options:
--id ID
--role-id ROLE_ID
322
10.68.10. hammer user-group remove-user

Usage:
hammer user-group remove-user [OPTIONS]
Options:
--id ID
--user-id USER_ID
10.68.11. hammer user-group remove-user-group

Disassociate an user group
Usage:
hammer user-group remove-user-group [OPTIONS]
Options:
--id ID
10.68.12. hammer user-group update

Update a user group
Usage:
hammer user-group update [OPTIONS]
Options:
--admin ADMIN is an admin user group
--id ID
--new-name NEW_NAME
--role-ids ROLE_IDS Comma separated list of values. Values
--roles ROLE_NAMES Comma separated list of values. Values
--user-group-ids USER_GROUP_IDS Comma separated list of values. Values
--user-groups USER_GROUP_NAMES Comma separated list of values. Values
--user-ids USER_IDS Comma separated list of values. Values
--users USER_LOGINS Comma separated list of values. Values
323
10.69. HAMMER VIRT-WHO-CONFIG

Manage Virt Who configurations
Usage:
hammer virt-who-config [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
Subcommands:
create Create a virt-who configuration
delete Delete a virt-who configuration
deploy Download and execute script for the
specified virt-who configuration
fetch Renders a deploy script for the specified
virt-who configuration
info Show a virt-who configuration
list List of virt-who configurations
update Update a virt-who configuration
Options:
10.69.1. hammer virt-who-config create

Create a virt-who configuration
Usage:
hammer virt-who-config create [OPTIONS]
Options:
--blacklist BLACKLIST Hypervisor blacklist,
applicable only when filtering mode is set to 2.
Wildcards and regular
expressions are supported, multiple records must be
separated by comma.
--debug DEBUG Enable debugging output
1/0.
--filtering-mode MODE Hypervisor filtering mode
Possible value(s): 'none',
'whitelist', 'blacklist'
--hypervisor-id HYPERVISOR_ID Specifies how the hypervisor
will be identified.
Possible value(s):
'hostname', 'uuid', 'hwuuid'
--hypervisor-password HYPERVISOR_PASSWORD Hypervisor password, required
for all hypervisor types except for libvirt
--hypervisor-server HYPERVISOR_SERVER Fully qualified host name or IP
address of the hypervisor
--hypervisor-type HYPERVISOR_TYPE Hypervisor type
Possible value(s): 'esx',
'rhevm', 'hyperv', 'xen', 'libvirt'
324
--hypervisor-username HYPERVISOR_USERNAME Account name by which virt-who

is to connect to the hypervisor.
--interval INTERVAL Configuration interval in
minutes
Possible value(s): '60',
'120', '240', '480', '720'
--name NAME Configuration name
--no-proxy NO_PROXY Ignore Proxy. A comma-
separated list of hostnames or domains or ip
addresses to ignore proxy
settings for. Optionally this may be set to * to
bypass proxy settings for all
hostnames domains or ip addresses.
--proxy PROXY HTTP Proxy that should be
used for communication between the server on
which virt-who is running and
the hypervisors and virtualization managers.
--satellite-url SATELLITE_URL Satellite server FQDN
--whitelist WHITELIST Hypervisor whitelist,
separated by comma.
10.69.2. hammer virt-who-config delete

Delete a virt-who configuration
Usage:
hammer virt-who-config delete [OPTIONS]
Options:
--id ID Configuration numeric identifier
10.69.3. hammer virt-who-config deploy

Download and execute script for the specified virt-who configuration
Usage:
hammer virt-who-config deploy [OPTIONS]
Options:
--id ID
10.69.4. hammer virt-who-config fetch
325
Renders a deploy script for the specified virt-who configuration
Usage:
hammer virt-who-config fetch [OPTIONS]
Options:
--id ID
--output, -o FILE File where the script will be written.
10.69.5. hammer virt-who-config info

Show a virt-who configuration
Usage:
hammer virt-who-config info [OPTIONS]
Options:
--id ID
10.69.6. hammer virt-who-config list

List of virt-who configurations
Usage:
hammer virt-who-config list [OPTIONS]
Options:
10.69.7. hammer virt-who-config update

Update a virt-who configuration
Usage:
hammer virt-who-config update [OPTIONS]
Options:
--blacklist BLACKLIST Hypervisor blacklist,
separated by comma.
--debug DEBUG Enable debugging output
1/0.
326
--filtering-mode MODE Hypervisor filtering mode

Possible value(s): 'none',
'whitelist', 'blacklist'
--hypervisor-id HYPERVISOR_ID Specifies how the hypervisor
will be identified.
Possible value(s):
'hostname', 'uuid', 'hwuuid'
--hypervisor-password HYPERVISOR_PASSWORD Hypervisor password, required
for all hypervisor types except for libvirt
--hypervisor-server HYPERVISOR_SERVER Fully qualified host name or IP
address of the hypervisor
--hypervisor-type HYPERVISOR_TYPE Hypervisor type
Possible value(s): 'esx',
'rhevm', 'hyperv', 'xen', 'libvirt'
--hypervisor-username HYPERVISOR_USERNAME Account name by which virt-who
is to connect to the hypervisor.
--id ID Configuration numeric
identifier
--interval INTERVAL Configuration interval in
minutes
Possible value(s): '60',
'120', '240', '480', '720'
--new-name NEW_NAME Configuration name
--no-proxy NO_PROXY Ignore Proxy. A comma-
separated list of hostnames or domains or ip
addresses to ignore proxy
settings for. Optionally this may be set to * to
bypass proxy settings for all
hostnames domains or ip addresses.
--proxy PROXY HTTP Proxy that should be
used for communication between the server on
which virt-who is running and
the hypervisors and virtualization managers.
--satellite-url SATELLITE_URL Satellite server FQDN
--whitelist WHITELIST Hypervisor whitelist,
separated by comma.
327

Red Hat Satellite-6.3-Hammer CLI Guide-en-US

Uploaded by

Copyright:

Available Formats

Red Hat Satellite-6.3-Hammer CLI Guide-en-US

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Red Hat Satellite-6.3-Hammer CLI Guide-en-US

Uploaded by

Copyright:

Available Formats

Red Hat Satellite 6.

Hammer CLI Guide

Using Hammer, the Satellite's CLI tool

Last Updated: 2019-03-12

Red Hat Satellite Documentation Team

Java ® is a registered trademark of Oracle and/or its affiliates.

All other trademarks are the property of their respective owners.

6.3. CREATING A HOST COLLECTION 49

10.5.3. hammer auth status 71

10.11.3.1. hammer content-view component add 92

10.14.4. hammer discovery info 119

10.21. HAMMER FILE 142

10.27.10.2. hammer host package-group remove 167

10.30.1. hammer job-invocation create 194

10.34.5. hammer medium list 217

10.38. HAMMER OSTREE-BRANCH 239

10.46.2. hammer puppet-class list 262

10.55.5. hammer sc-param update 284

10.65.2. hammer template build-pxe-default 306

10.69.6. hammer virt-who-config list 326

CHAPTER 1. INTRODUCTION TO HAMMER

Hammer compared to Satellite web UI

Hammer compared to Satellite API

1.1. GETTING HELP

Use --help to inspect any subcommand, for example:

$ hammer organization --help

Hammer authentication session

Storing credentials in the hammer configuration file

Providing credentials with each hammer command

1.2.1. Hammer Authentication Session

See the instructions on how to use the sessions:

To enable sessions, add :use_sessions: true to the

To start a session, enter the following command:

# hammer auth login

# hammer settings set --name idle_timeout --value 30

# hammer auth status

To end the session, enter the following command:

# hammer auth logout

1.2.2. Hammer Configuration File

You can also add your credentials to the ~/.hammer/cli.modules.d/foreman.yml configuration

1.2.3. Command Line

$ hammer -u username -p password subcommands

1.3. USING STANDALONE HAMMER

# subscription-manager repos --enable=rhel-7-server-rpms \

# yum install tfm-rubygem-hammer_cli_katello

3. Edit the :host: entry in the /etc/hammer/cli.modules.d/foreman.yml file to include the

1.4. SETTING A DEFAULT ORGANIZATION

$ hammer defaults add --param-name organization --param-value org_name

$ hammer defaults add --param-name location --param-value loc_name

$ hammer defaults list

1.5. CONFIGURING HAMMER

/etc/hammer/cli_config.yml for general hammer settings.

/etc/hammer/cli.modules.d/ for CLI module configuration files.

1.6. CONFIGURING HAMMER LOGGING

# hammer admin logging --all --level-debug

To set production level logging, use the following command:

# hammer admin logging --all --level-production

# hammer admin logging --list

To list all available logging options: