Chapter 2. Reference
This chapter provides a list of Hammer usage statements. These usage statements are current to the versions of Hammer and its components released for Satellite 6.9.
2.1. hammer
Usage:
hammer [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
activation-key Manipulate activation keys
admin Administrative server-side tasks
ansible Manage foreman ansible
architecture Manipulate architectures
arf-report Manipulate compliance reports
audit Search audit trails.
auth Foreman connection login/logout
auth-source Manipulate auth sources
bookmark Manage bookmarks
bootdisk Download boot disks
capsule Manipulate capsule
compute-profile Manipulate compute profiles
compute-resource Manipulate compute resources
config-group Manipulate config groups
config-report Browse and read reports
content-credentials Manipulate content credentials on the server
content-view Manipulate content views
deb-package Manipulate deb packages
defaults Defaults management
discovery Manipulate discovered hosts.
discovery-rule Manipulate discovered rules.
docker Manipulate docker content
domain Manipulate domains
environment Manipulate environments
erratum Manipulate errata
export-templates Export templates to a git repo or a directory on the server
fact Search facts
file Manipulate files
filter Manage permission filters
foreign-input-set Manage foreign input sets
full-help Print help for all hammer commands
global-parameter Manipulate global parameters
gpg Manipulate GPG Key actions on the server
host Manipulate hosts
host-collection Manipulate host collections
hostgroup Manipulate hostgroups
http-proxy Manipulate http proxies
import-templates Import templates from a git repo or a directory on the server
job-invocation Manage job invocations
job-template Manage job templates
lifecycle-environment Manipulate lifecycle_environments on the server
location Manipulate locations
mail-notification Manage mail notifications
medium Manipulate installation media
model Manipulate hardware models
module-stream View Module Streams
organization Manipulate organizations
os Manipulate operating system
ostree-branch Manipulate ostree branches
package Manipulate packages
package-group Manipulate package groups
partition-table Manipulate partition tables
ping Get the status of the server and/or it's subcomponents
policy Manipulate policies
prebuild-bash-completion Prepare map of options and subcommands for Bash completion
product Manipulate products
proxy Manipulate smart proxies
puppet-class Search puppet modules
puppet-environment Manipulate Puppet environments
puppet-module View Puppet Module details
realm Manipulate realms
recurring-logic Recurring logic related actions
remote-execution-feature Manage remote execution features
report Browse and read reports
report-template Manipulate report templates
repository Manipulate repositories
repository-set Manipulate repository sets on the server
role Manage user roles
sc-param Manipulate smart class parameters
scap-content Manipulate SCAP contents
scap-content-profile Manipulate Scap Content Profiles
settings Change server settings
shell Interactive shell
srpm Manipulate source RPMs
status Get the complete status of the server and/or it's subcomponents
subnet Manipulate subnets
subscription Manipulate subscriptions
sync-plan Manipulate sync plans
tailoring-file Manipulate Tailoring files
task Tasks related actions.
template Manipulate provisioning templates
template-input Manage template inputs
user Manipulate users
user-group Manage user groups
virt-who-config Manage Virt Who configurations
Options:
--[no-]use-defaults Enable/disable stored defaults. Enabled by default
--autocomplete LINE Get list of possible endings
--csv Output as CSV (same as --output=csv)
--csv-separator SEPARATOR Character to separate the values
--fetch-ca-cert SERVER Fetch CA certificate from server and exit
--interactive INTERACTIVE Explicitly turn interactive mode on/off
One of true/false, yes/no, 1/0.
--no-headers Hide headers from output
--output ADAPTER Set output format
Possible value(s): 'base', 'table', 'silent', 'csv', 'yaml', 'json'
--output-file OUTPUT_FILE Path to custom output file
--show-ids Show ids of associated resources
--ssl-ca-file CA_FILE Configure the file containing the CA certificates
--ssl-ca-path CA_PATH Configure the directory containing the CA certificates
--ssl-client-cert CERT_FILE Configure the client's public certificate
--ssl-client-key KEY_FILE Configure the client's private key
--ssl-with-basic-auth Use standard authentication in addition to client certificate authentication
--verify-ssl VERIFY_SSL Configure SSL verification of remote system
One of true/false, yes/no, 1/0.
--version Show version
-c, --config CFG_FILE Path to custom config file
-d, --debug Show debugging output
-h, --help Print help
-p, --password PASSWORD Password to access the remote system
-q, --quiet Completely silent
-r, --reload-cache Force reload of Apipie cache
-s, --server SERVER Remote system address
-u, --username USERNAME Username to access the remote system
-v, --[no-]verbose Be verbose (or not). True by default2.2. 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 Destroy an activation key
host-collections List associated host collections
info, show Show an activation key
list, index 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 help2.2.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
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.2. hammer activation-key add-subscription
Add subscription
Usage:
hammer activation-key add-subscription [OPTIONS]
Options:
--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-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--quantity QUANTITY Quantity of this subscription to add
--subscription SUBSCRIPTION_NAME Subscription name to search by
--subscription-id SUBSCRIPTION_ID Subscription identifier
--subscriptions SUBSCRIPTIONS Array of subscriptions to add
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--subscriptions "id=<string>\,quantity=<numeric>, ... "2.2.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
--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-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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
-h, --help Print help2.2.4. hammer activation-key copy
Copy an activation key
Usage:
hammer activation-key copy [OPTIONS]
Options:
--id ID ID of the activation key
--name NAME Activation key name to search by
--new-name NEW_NAME Name of new activation key
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.5. hammer activation-key create
Create an activation key
Usage:
hammer activation-key create [OPTIONS]
Options:
--auto-attach AUTO_ATTACH Auto attach subscriptions upon registration
One of true/false, yes/no, 1/0.
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view id
--description DESCRIPTION Description
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--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-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--purpose-addons PURPOSE_ADDONS Sets the system add-ons
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--purpose-role PURPOSE_ROLE Sets the system purpose usage
--purpose-usage PURPOSE_USAGE Sets the system purpose usage
--release-version RELEASE_VERSION Content release version
--service-level SERVICE_LEVEL Service level
--unlimited-hosts Set hosts max to unlimited
-h, --help Print help2.2.6. hammer activation-key delete
Destroy an activation key
Usage:
hammer activation-key <delete|destroy> [OPTIONS]
Options:
--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-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.7. hammer activation-key host-collections
List associated host collections
Usage:
hammer activation-key host-collections [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.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--sort-by SORT_BY Field to sort the results on
--sort-order SORT_ORDER How to order the sorted results (e.g. ASC for ascending)
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----2.2.8. hammer activation-key info
Show an activation key
Usage:
hammer activation-key <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID 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 identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------------------|-----|---------|-----
Name | x | x | x
ID | x | x | x
Description | x | x |
Host Limit | x | x |
Auto Attach | x | x |
Release Version | x | x |
Lifecycle Environment | x | x |
Content View | x | x |
Host Collections/ID | x | x |
Host Collections/Name | x | x |
System Purpose/Service Level | x | x |
System Purpose/Purpose Usage | x | x |
System Purpose/Purpose Role | x | x |
System Purpose/Purpose Addons | x | x |
------------------------------|-----|---------|-----2.2.9. hammer activation-key list
List activation keys
Usage:
hammer activation-key <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Activation key name to filter by
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Host Limit | x | x |
Lifecycle Environment | x | x |
Content View | x | x |
----------------------|-----|---------|-----
Search / Order fields:
addon string
content_view string
content_view_id integer
description text
environment string
name string
organization_id integer
role string
subscription_id string
subscription_name string
usage string2.2.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.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID 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-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Type | x | x |
URL | x | x |
GPG Key | x | x |
Label | x | x |
Default Enabled? | x | x |
Override | x | x |
-----------------|-----|---------|-----2.2.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
--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
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.12. hammer activation-key remove-subscription
Remove subscription
Usage:
hammer activation-key remove-subscription [OPTIONS]
Options:
--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-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--subscription-id SUBSCRIPTION_ID ID of subscription
-h, --help Print help2.2.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 Activation key ID
--available-for AVAILABLE_FOR Object to show subscriptions available for, either 'host' or
'activation_key'
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID Id of a host
--id ACTIVATION_KEY_ID ID of the activation key
--match-host MATCH_HOST Ignore subscriptions that are unavailable to the specified host
One of true/false, yes/no, 1/0.
--match-installed MATCH_INSTALLED Return subscriptions that match installed products of the specified host
One of true/false, yes/no, 1/0.
--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
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-----------|-----|--------
FIELDS | ALL | DEFAULT
-----------|-----|--------
ID | x | x
Name | x | x
Attached | x | x
Quantity | x | x
Start Date | x | x
End Date | x | x
Support | x | x
Contract | x | x
Account | x | x
-----------|-----|--------2.2.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.
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view id
--description DESCRIPTION Description
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID ID of the activation key
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--max-hosts MAX_HOSTS Maximum number of registered content hosts
--name NAME Activation key name to search by
--new-name NEW_NAME Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--purpose-addons PURPOSE_ADDONS Sets the system add-ons
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--purpose-role PURPOSE_ROLE Sets the system purpose usage
--purpose-usage PURPOSE_USAGE Sets the system purpose usage
--release-version RELEASE_VERSION Content release version
--service-level SERVICE_LEVEL Service level
--unlimited-hosts Set hosts max to unlimited
-h, --help Print help2.3. hammer admin
Administrative server-side tasks
Usage:
hammer admin [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
logging Logging verbosity level setup
Options:
-h, --help Print help2.3.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.
JSON is acceptable and preferred way for complex parameters
-d, --level-debug Increase verbosity level to debug.
-h, --help Print help
-l, --list List available components.
-n, --dry-run Do not apply specified changes.
-p, --level-production Decrease verbosity level to standard.2.4. hammer ansible
Manage foreman ansible
Usage:
hammer ansible [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
roles Manage ansible roles
variables Manage ansible variables
Options:
-h, --help Print help2.4.1. hammer ansible roles
Manage ansible roles
Usage:
hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Deletes Ansible role
fetch Fetch Ansible roles available to be imported
import Import Ansible roles
info, show Show role
list, index List Ansible roles
obsolete Obsolete Ansible roles
play-hostgroups Runs all Ansible roles on hostgroups
play-hosts Runs all Ansible roles on hosts
Options:
-h, --help Print help2.4.1.1. hammer ansible roles delete
Deletes Ansible role
Usage:
hammer ansible roles <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.1.2. hammer ansible roles fetch
Fetch Ansible roles available to be imported
Usage:
hammer ansible roles fetch [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to fetch from
-h, --help Print help2.4.1.3. hammer ansible roles import
Import Ansible roles
Usage:
hammer ansible roles import [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
--role-names ROLE_NAMES Ansible role names to import
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.4.1.4. hammer ansible roles info
Show role
Usage:
hammer ansible roles <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Imported at | x | x |
------------|-----|---------|-----2.4.1.5. hammer ansible roles list
List Ansible roles
Usage:
hammer ansible roles <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Imported at | x | x |
------------|-----|---------|-----
Search / Order fields:
host string
host_id integer
hostgroup string
hostgroup_id integer
id integer
name string
updated_at datetime2.4.1.6. hammer ansible roles obsolete
Obsolete Ansible roles
Usage:
hammer ansible roles obsolete [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
-h, --help Print help2.4.1.7. hammer ansible roles play-hostgroups
Runs all Ansible roles on hostgroups
Usage:
hammer ansible roles play-hostgroups [OPTIONS]
Options:
--hostgroup-ids HOSTGROUP_IDS IDs of hostgroups to play roles on
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.1.8. hammer ansible roles play-hosts
Runs all Ansible roles on hosts
Usage:
hammer ansible roles play-hosts [OPTIONS]
Options:
--host-ids HOST_IDS IDs of hosts to play roles on
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.2. hammer ansible variables
Manage ansible variables
Usage:
hammer ansible variables [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-matcher Create an override value for a specific ansible variable
create Create Ansible variable
delete, destroy Deletes Ansible variable
import Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles
info, show Show variable
list, index List Ansible variables
obsolete Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles
remove-matcher Destroy an override value
update Updates Ansible variable
Options:
-h, --help Print help2.4.2.1. hammer ansible variables add-matcher
Create an override value for a specific ansible variable
Usage:
hammer ansible variables add-matcher [OPTIONS]
Options:
--ansible-variable ANSIBLE_VARIABLE_NAME Name to search by
--ansible-variable-id ANSIBLE_VARIABLE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--match MATCH Override match
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--value VALUE Override value, required if omit is false
-h, --help Print help2.4.2.2. hammer ansible variables create
Create Ansible variable
Usage:
hammer ansible variables create [OPTIONS]
Options:
--ansible-role ANSIBLE_ROLE_NAME Name to search by
--ansible-role-id ANSIBLE_ROLE_ID Role ID
--avoid-duplicates AVOID_DUPLICATES Remove duplicate values (only array type)
One of true/false, yes/no, 1/0.
--default-value DEFAULT_VALUE Default value of variable
--description DESCRIPTION Description of variable
--hidden-value HIDDEN_VALUE When enabled the parameter is hidden in the UI
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--merge-default MERGE_DEFAULT Include default value when merging all matching values
One of true/false, yes/no, 1/0.
--merge-overrides MERGE_OVERRIDES Merge all matching values (only array/hash type)
One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--override OVERRIDE Whether to override variable or not
One of true/false, yes/no, 1/0.
--override-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
--validator-rule VALIDATOR_RULE Used to enforce certain values for the parameter values
--validator-type VALIDATOR_TYPE Types of validation values
Possible value(s): 'regexp', 'list'
--variable VARIABLE Name of variable
--variable-type VARIABLE_TYPE Types of variable values
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
-h, --help Print help2.4.2.3. hammer ansible variables delete
Deletes Ansible variable
Usage:
hammer ansible variables <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.2.4. hammer ansible variables import
Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles
Usage:
hammer ansible variables import [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
-h, --help Print help2.4.2.5. hammer ansible variables info
Show variable
Usage:
hammer ansible variables <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------------------|-----|--------
Id | x | x
Variable | x | x
Default Value | x | x
Type | x | x
Role | x | x
Role Id | x | x
Description | x | x
Hidden Value? | x | x
Validator/Type | x | x
Validator/Rule | x | x
Override values/Override | x | x
Override values/Merge overrides | x | x
Override values/Merge default value | x | x
Override values/Avoid duplicates | x | x
Override values/Order | x | x
Override values/Values/Id | x | x
Override values/Values/Match | x | x
Override values/Values/Value | x | x
Created at | x | x
Updated at | x | x
------------------------------------|-----|--------2.4.2.6. hammer ansible variables list
List Ansible variables
Usage:
hammer ansible variables <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Variable | x | x
Default Value | x | x
Type | x | x
Role | x | x
Role Id | x | x
--------------|-----|--------
Search / Order fields:
ansible_role string
avoid_duplicates Values: true, false
imported Values: true, false
key string
merge_default Values: true, false
merge_overrides Values: true, false
name string
override Values: true, false
parameter string2.4.2.7. hammer ansible variables obsolete
Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles
Usage:
hammer ansible variables obsolete [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
-h, --help Print help2.4.2.8. hammer ansible variables remove-matcher
Destroy an override value
Usage:
hammer ansible variables remove-matcher [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.2.9. hammer ansible variables update
Updates Ansible variable
Usage:
hammer ansible variables update [OPTIONS]
Options:
--ansible-role ANSIBLE_ROLE_NAME Name to search by
--ansible-role-id ANSIBLE_ROLE_ID Role ID
--avoid-duplicates AVOID_DUPLICATES Remove duplicate values (only array type)
One of true/false, yes/no, 1/0.
--default-value DEFAULT_VALUE Default value of variable
--description DESCRIPTION Description of variable
--hidden-value HIDDEN_VALUE When enabled the parameter is hidden in the UI
One of true/false, yes/no, 1/0.
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--merge-default MERGE_DEFAULT Include default value when merging all matching values
One of true/false, yes/no, 1/0.
--merge-overrides MERGE_OVERRIDES Merge all matching values (only array/hash type)
One of true/false, yes/no, 1/0.
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--override OVERRIDE Whether to override variable or not
One of true/false, yes/no, 1/0.
--override-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
--validator-rule VALIDATOR_RULE Used to enforce certain values for the parameter values
--validator-type VALIDATOR_TYPE Types of validation values
Possible value(s): 'regexp', 'list'
--variable VARIABLE Name of variable
--variable-type VARIABLE_TYPE Types of variable values
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
-h, --help Print help2.5. hammer architecture
Manipulate architectures
Usage:
hammer architecture [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-operatingsystem Associate an operating system
create Create an architecture
delete, destroy Delete an architecture
info, show Show an architecture
list, index List all architectures
remove-operatingsystem Disassociate an operating system
update Update an architecture
Options:
-h, --help Print help2.5.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
-h, --help Print help2.5.2. hammer architecture create
Create an architecture
Usage:
hammer architecture create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Operating system IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.5.3. hammer architecture delete
Delete an architecture
Usage:
hammer architecture <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Architecture name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.5.4. hammer architecture info
Show an architecture
Usage:
hammer architecture <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Architecture name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating systems/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
-------------------|-----|---------|-----2.5.5. hammer architecture list
List all architectures
Usage:
hammer architecture <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
name string2.5.6. hammer architecture remove-operatingsystem
Disassociate an operating system
Usage:
hammer architecture remove-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Architecture name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.5.7. hammer architecture update
Update an architecture
Usage:
hammer architecture update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Architecture name
--new-name NEW_NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Operating system IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.6. hammer arf-report
Manipulate compliance reports
Usage:
hammer arf-report [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete an ARF Report
download Download bzipped ARF report
download-html Download ARF report in HTML
info, show Show an ARF report
list, index List ARF reports
Options:
-h, --help Print help2.6.1. hammer arf-report delete
Delete an ARF Report
Usage:
hammer arf-report <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help2.6.2. hammer arf-report download
Download bzipped ARF report
Usage:
hammer arf-report download [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--path PATH Path to directory where downloaded file will be saved
-h, --help Print help2.6.3. hammer arf-report download-html
Download ARF report in HTML
Usage:
hammer arf-report download-html [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--path PATH Path to directory where downloaded file will be saved
-h, --help Print help2.6.4. hammer arf-report info
Show an ARF report
Usage:
hammer arf-report <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
Id | x | x | x
Reported at | x | x |
Host name | x | x | x
OpenSCAP proxy name | x | x |
Policy name | x | x |
Passed | x | x |
Failed | x | x |
Othered | x | x |
Host Id | x | x |
OpenSCAP proxy Id | x | x |
Policy Id | x | x |
Locations/ | x | x |
Organizations/ | x | x |
--------------------|-----|---------|-----2.6.5. hammer arf-report list
List ARF reports
Usage:
hammer arf-report <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
Id | x | x | x
Reported at | x | x |
Host name | x | x | x
OpenSCAP proxy name | x | x |
Policy name | x | x |
Passed | x | x |
Failed | x | x |
Othered | x | x |
--------------------|-----|---------|-----
Search / Order fields:
compliance_policy string
compliance_status Values: compliant, incompliant, inconclusive
comply_with string
environment string
eventful Values: true, false
host string
host_collection string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
inconclusive_with string
last_for Values: host, policy
last_report datetime
lifecycle_environment string
location string
location_id integer
log text
not_comply_with string
openscap_proxy string
organization string
organization_id integer
origin string
policy string
reported datetime
resource text
xccdf_rule_failed string
xccdf_rule_name text
xccdf_rule_othered string
xccdf_rule_passed string2.7. hammer audit
Search audit trails.
Usage:
hammer audit [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show an audit
list, index List all audits
Options:
-h, --help Print help2.7.1. hammer audit info
Show an audit
Usage:
hammer audit <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
Id | x | x | x
At | x | x |
IP | x | x |
User | x | x |
Action | x | x |
Audit type | x | x |
Audit record | x | x |
Request UUID | x | x |
Audited changes/Attribute | x | x |
Audited changes/Value | x | x |
Audited changes/Old | x | x |
Audited changes/New | x | x |
--------------------------|-----|---------|-----2.7.2. hammer audit list
List all audits
Usage:
hammer audit <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
At | x | x |
IP | x | x |
User | x | x |
Action | x | x |
Audit type | x | x |
Audit record | x | x |
Request UUID | x | |
-------------|-----|---------|-----
Search / Order fields:
action string
auditable_id integer
changes text
comment string
host string
hostgroup string
hostgroup_title string
id integer
interface_fqdn string
interface_ip string
interface_mac string
location string
location_id integer
organization string
organization_id integer
os string
os_title string
parameter string
partition_table string
provisioning_template string
puppetclass string
remote_address string
request_uuid string
setting string
time datetime
type Values: role, ptable, provisioning_template, user, filter, subnet, hostgroup, katello/repository, smart_proxy, katello/host/content_facet, katello/hostgroup/content_facet, katello/host/subscription_facet, remote_execution_feature, usergroup, katello/content_view, katello/kt_environment, architecture, bookmark, compute_profile, config_group, domain, environment, host_class, http_proxy, image, key_pair, medium, model, personal_access_token, report_template, puppetclass, realm, ssh_key, job_template, job_invocation, ansible_role, discovery_rule, katello/activation_key, katello/gpg_key, katello/host_collection, katello/product, katello/sync_plan, foreman_virt_who_configure/config, foreman_openscap/policy, foreman_openscap/scap_content, foreman_openscap/tailoring_file, lookup_value, hostgroup_class, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, setting, smart_class_parameter
user string
username string2.8. hammer auth
Foreman connection login/logout
Usage:
hammer auth [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
login Set credentials
logout Wipe your credentials
status Information about current connections
Options:
-h, --help Print help2.8.1. hammer auth login
Set credentials
Usage:
hammer auth login [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
basic Provide username and password
oauth Supports for both with/without 2fa
Options:
-h, --help Print help2.8.1.1. hammer auth login basic
provide username and password
Usage:
hammer auth login basic [OPTIONS]
Options:
-h, --help Print help
-p, --password PASSWORD Password to access the remote system
-u, --username USERNAME Username to access the remote system2.8.1.2. hammer auth login oauth
supports for both with/without 2fa
Usage:
hammer auth login oauth [OPTIONS]
Options:
-a, --oidc-authorization-endpoint OPENIDC_AUTHORIZATION_ENDPOINT Openidc provider URL which issues authentication code (two factor only)
-c, --oidc-client-id OPENIDC_CLIENT_ID Client id used in the Openidc provider
-f, --two-factor Authenticate with two factor
-h, --help Print help
-p, --password PASSWORD Password to access the remote system
-r, --oidc-redirect-uri OPENIDC_REDIRECT_URI Redirect URI for the authentication code grant flow
-t, --oidc-token-endpoint OPENIDC_TOKEN_ENDPOINT Openidc provider URL which issues access token
-u, --username USERNAME Username to access the remote system2.8.2. hammer auth logout
Wipe your credentials
Usage:
hammer auth logout [OPTIONS]
Options:
-h, --help Print help2.8.3. hammer auth status
Information about current connections
Usage:
hammer auth status [OPTIONS]
Options:
-h, --help Print help2.9. hammer auth-source
Manipulate auth sources
Usage:
hammer auth-source [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
external Manage external auth sources
ldap Manage LDAP auth sources
list, index List all auth sources
Options:
-h, --help Print help2.9.1. hammer auth-source external
Manage external auth sources
Usage:
hammer auth-source external [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show an external authentication source
list, index List external authentication sources
update Update organization and location for Auth Source
Options:
-h, --help Print help2.9.1.1. hammer auth-source external info
Show an external authentication source
Usage:
hammer auth-source external <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Locations/ | x | x |
Organizations/ | x | x |
---------------|-----|---------|-----2.9.1.2. hammer auth-source external list
List external authentication sources
Usage:
hammer auth-source external <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer2.9.1.3. hammer auth-source external update
Update organization and location for Auth Source
Usage:
hammer auth-source external update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.9.2. hammer auth-source ldap
Manage LDAP auth sources
Usage:
hammer auth-source ldap [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an LDAP authentication source
delete, destroy Delete an LDAP authentication source
info, show Show an LDAP authentication source
list, index List all LDAP authentication sources
update Update an LDAP authentication source
Options:
-h, --help Print help2.9.2.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 LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--onthefly-register ONTHEFLY_REGISTER One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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 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
One of true/false, yes/no, 1/0.
-h, --help Print help2.9.2.2. hammer auth-source ldap delete
Delete an LDAP authentication source
Usage:
hammer auth-source ldap <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.9.2.3. hammer auth-source ldap info
Show an LDAP authentication source
Usage:
hammer auth-source ldap <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
-------------------------------------------|-----|--------
Server/Id | x | x
Server/Name | x | x
Server/Server | x | x
Server/LDAPS | x | x
Server/Port | x | x
Server/Server Type | x | x
Account/Account Username | x | x
Account/Base DN | x | x
Account/Groups base DN | x | x
Account/Use Netgroups | x | x
Account/LDAP filter | x | x
Account/Automatically Create Accounts? | x | x
Account/Usergroup sync | x | x
Attribute mappings/Login Name Attribute | x | x
Attribute mappings/First Name Attribute | x | x
Attribute mappings/Last Name Attribute | x | x
Attribute mappings/Email Address Attribute | x | x
Attribute mappings/Photo Attribute | x | x
Locations/ | x | x
Organizations/ | x | x
-------------------------------------------|-----|--------2.9.2.4. hammer auth-source ldap list
List all LDAP authentication sources
Usage:
hammer auth-source ldap <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Server | x | x |
Port | x | x |
LDAPS? | x | x |
-------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer2.9.2.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
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME
--onthefly-register ONTHEFLY_REGISTER One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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 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
One of true/false, yes/no, 1/0.
-h, --help Print help2.9.3. hammer auth-source list
List all auth sources
Usage:
hammer auth-source <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Type of auth source | x | x |
--------------------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer2.10. hammer bookmark
Manage bookmarks
Usage:
hammer bookmark [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a bookmark
delete, destroy Delete a bookmark
info, show Show a bookmark
list, index List all bookmarks
update Update a bookmark
Options:
-h, --help Print help2.10.1. hammer bookmark create
Create a bookmark
Usage:
hammer bookmark create [OPTIONS]
Options:
--controller CONTROLLER
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--public PUBLIC One of true/false, yes/no, 1/0.
--query QUERY
-h, --help Print help2.10.2. hammer bookmark delete
Delete a bookmark
Usage:
hammer bookmark <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.10.3. hammer bookmark info
Show a bookmark
Usage:
hammer bookmark <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Controller | x | x |
Search Query | x | x |
Public | x | x |
Owner Id | x | x |
Owner Type | x | x |
-------------|-----|---------|-----2.10.4. hammer bookmark list
List all bookmarks
Usage:
hammer bookmark <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Controller | x | x |
Search Query | x | x |
Public | x | x |
Owner Id | x | x |
Owner Type | x | x |
-------------|-----|---------|-----
Search / Order fields:
controller string
name string2.10.5. hammer bookmark update
Update a bookmark
Usage:
hammer bookmark update [OPTIONS]
Options:
--controller CONTROLLER
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--public PUBLIC One of true/false, yes/no, 1/0.
--query QUERY
-h, --help Print help2.11. hammer bootdisk
Download boot disks
Usage:
hammer bootdisk [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
generic Download generic image
host Download host image
subnet Download subnet generic image
Options:
-h, --help Print help2.11.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.)
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--sudo Use sudo to write to device
-h, --help Print help2.11.2. hammer bootdisk host
Download host image
Usage:
hammer bootdisk host [OPTIONS]
Options:
--file PATH File or device to write image to
--force Force writing to existing destination (device etc.)
--full FULL True for full, false for basic reusable image
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--sudo Use sudo to write to device
-h, --help Print help2.11.3. hammer bootdisk subnet
Download subnet generic image
Usage:
hammer bootdisk subnet [OPTIONS]
Options:
--file PATH File or device to write image to
--force Force writing to existing destination (device etc.)
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--sudo Use sudo to write to device
-h, --help Print help2.12. hammer capsule
Manipulate capsule
Usage:
hammer capsule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
content Manage the capsule content
create Create a capsule
delete, destroy Delete a capsule
import-classes Import puppet classes from puppet Capsule
info, show Show a capsule
list, index List all capsules
refresh-features Refresh capsule features
update Update a capsule
Options:
-h, --help Print help2.12.1. hammer capsule content
Manage the capsule content
Usage:
hammer capsule content [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
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:
-h, --help Print help2.12.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 Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
-h, --help Print help2.12.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:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to limit environments on
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
-------------|-----|---------|-----2.12.1.3. hammer capsule content cancel-synchronization
Cancel running capsule synchronization
Usage:
hammer capsule content cancel-synchronization [OPTIONS]
Options:
--id ID Id of the capsule
--name NAME Name to search by
-h, --help Print help2.12.1.4. hammer capsule content info
Get current capsule synchronization status
Usage:
hammer capsule content info [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to get the status for
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------------------------------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
-------------------------------------------------------------------|-----|--------
Lifecycle Environments/Name | x | x
Lifecycle Environments/Organization | x | x
Lifecycle Environments/Content Views/Name | x | x
Lifecycle Environments/Content Views/Composite | x | x
Lifecycle Environments/Content Views/Last Published | x | x
Lifecycle Environments/Content Views/Content/Hosts | x | x
Lifecycle Environments/Content Views/Content/Products | x | x
Lifecycle Environments/Content Views/Content/Yum repos | x | x
Lifecycle Environments/Content Views/Content/Container Image repos | x | x
Lifecycle Environments/Content Views/Content/Packages | x | x
Lifecycle Environments/Content Views/Content/Package groups | x | x
Lifecycle Environments/Content Views/Content/Errata | x | x
Lifecycle Environments/Content Views/Content/Puppet modules | x | x
-------------------------------------------------------------------|-----|--------2.12.1.5. hammer capsule content lifecycle-environments
List the lifecycle environments attached to the capsule
Usage:
hammer capsule content lifecycle-environments [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to limit environments on
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
-------------|-----|---------|-----2.12.1.6. hammer capsule content remove-lifecycle-environment
Remove lifecycle environments from the capsule
Usage:
hammer capsule content remove-lifecycle-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
-h, --help Print help2.12.1.7. hammer capsule content synchronization-status
Get current capsule synchronization status
Usage:
hammer capsule content synchronization-status [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to get the status for
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
--------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
--------------------------------------|-----|--------
Last sync | x | x
Status | x | x
Currently running sync tasks/Task id | x | x
Currently running sync tasks/Progress | x | x
Last failure/Task id | x | x
Last failure/Messages | x | x
--------------------------------------|-----|--------2.12.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
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
--skip-metadata-check SKIP_METADATA_CHECK Skip metadata check on each repository on the capsule
One of true/false, yes/no, 1/0.
-h, --help Print help2.12.2. hammer capsule create
Create a capsule
Usage:
hammer capsule create [OPTIONS]
Options:
--download-policy DOWNLOAD_POLICY Download Policy of the capsule, must be one of immediate, on_demand,
Background, inherit
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--url URL
-h, --help Print help2.12.3. hammer capsule delete
Delete a capsule
Usage:
hammer capsule <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.12.4. hammer capsule import-classes
Import puppet classes from puppet Capsule
Usage:
hammer capsule import-classes [OPTIONS]
Options:
--dryrun Do not run the import
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--except EXCEPT Optional comma-delimited string containing either 'new',
'updated', or 'obsolete' that is used to limit the imported
Puppet classes
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
-h, --help Print help2.12.5. hammer capsule info
Show a capsule
Usage:
hammer capsule <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
URL | x | x |
Features | x | x |
Features/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.12.6. hammer capsule list
List all capsules
Usage:
hammer capsule <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
Id | x | x | x
Name | x | x | x
URL | x | x |
Features | x | x |
---------|-----|---------|-----
Search / Order fields:
feature string
location string
location_id integer
name string
organization string
organization_id integer
url string2.12.7. hammer capsule refresh-features
Refresh capsule features
Usage:
hammer capsule refresh-features [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.12.8. hammer capsule update
Update a capsule
Usage:
hammer capsule update [OPTIONS]
Options:
--download-policy DOWNLOAD_POLICY Download Policy of the capsule, must be one of immediate, on_demand,
Background, inherit
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--url URL
-h, --help Print help2.13. hammer compute-profile
Manipulate compute profiles
Usage:
hammer compute-profile [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a compute profile
delete, destroy Delete a compute profile
info, show Show a compute profile
list, index List of compute profiles
update Update a compute profile
values Create update and delete Compute profile values
Options:
-h, --help Print help2.13.1. hammer compute-profile create
Create a compute profile
Usage:
hammer compute-profile create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.2. hammer compute-profile delete
Delete a compute profile
Usage:
hammer compute-profile <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute profile name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.3. hammer compute-profile info
Show a compute profile
Usage:
hammer compute-profile <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute profile name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
Compute attributes/Id | x | x |
Compute attributes/Name | x | x |
Compute attributes/Compute Resource | x | x |
Compute attributes/VM attributes | x | x |
------------------------------------|-----|---------|-----2.13.4. hammer compute-profile list
List of compute profiles
Usage:
hammer compute-profile <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
name string2.13.5. hammer compute-profile update
Update a compute profile
Usage:
hammer compute-profile update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute profile name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.6. hammer compute-profile values
Create update and delete Compute profile values
Usage:
hammer compute-profile values [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-interface Add interface for Compute Profile
add-volume Add volume for Compute Profile
create Create compute profile set of values
remove-interface Remove compute profile interface
remove-volume Remove compute profile volume
update Update compute profile values
update-interface Update compute profile interface
update-volume Update compute profile volume
Options:
-h, --help Print help2.13.6.1. hammer compute-profile values add-interface
Add interface for Compute Profile
Usage:
hammer compute-profile values add-interface [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface SET_VALUES Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--interface:
GCE:
--interface:
Libvirt:
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
OpenStack:
--interface:
oVirt:
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
Rackspace:
--interface:
VMware:
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
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 or Network Name from VMware
AzureRM:
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)2.13.6.2. hammer compute-profile values add-volume
Add volume for Compute Profile
Usage:
hammer compute-profile values add-volume [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
GCE:
--volume:
size_gb Volume size in GB, integer value
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
OpenStack:
--volume:
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
Rackspace:
--volume:
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)2.13.6.3. hammer compute-profile values create
Create compute profile set of values
Usage:
hammer compute-profile values create [OPTIONS]
Options:
--compute-attributes COMPUTE_ATTRS Compute resource attributes
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface INTERFACE Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
--interface:
--compute-attributes:
availability_zone
flavor_id
groups
security_group_ids
managed_ip
GCE:
--volume:
size_gb Volume size in GB, integer value
--interface:
--compute-attributes:
machine_type
network
associate_external_ip
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
--compute-attributes:
cpus Number of CPUs
memory String, amount of memory, value in bytes
cpu_mode Possible values: default, host-model, host-passthrough
OpenStack:
--volume:
--interface:
--compute-attributes:
availability_zone
boot_from_volume
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
--compute-attributes:
cluster ID or name of cluster to use
template Hardware profile to use
cores Integer value, number of cores
sockets Integer value, number of sockets
memory Amount of memory, integer value in bytes
ha Boolean, set 1 to high availability
display_type Possible values: VNC, SPICE
keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.
Rackspace:
--volume:
--interface:
--compute-attributes:
flavor_id
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
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 or Network Name from VMware
--compute-attributes:
cluster Cluster ID from VMware
corespersocket Number of cores per socket (applicable to hardware versions < 10 only)
cpus CPU count
memory_mb Integer number, amount of memory in MB
path Path to folder
resource_pool Resource Pool ID from VMware
firmware automatic/bios/efi
guest_id Guest OS ID form VMware
hardware_version Hardware version ID from VMware
memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on
cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on
add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
annotation Annotation Notes
scsi_controllers List with SCSI controllers definitions
type - ID of the controller from VMware
key - Key of the controller (e.g. 1000)
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)
--compute-attributes:
resource_group Existing Azure Resource Group of user
vm_size VM Size, eg. Standard_A0 etc.
username The Admin username
password The Admin password
platform OS type eg. Linux
ssh_key_data SSH key for passwordless authentication
os_disk_caching OS disk caching
premium_os_disk Premium OS Disk, Boolean as 0 or 1
script_command Custom Script Command
script_uris Comma seperated file URIs2.13.6.4. hammer compute-profile values remove-interface
Remove compute profile interface
Usage:
hammer compute-profile values remove-interface [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface-id INTERFACE ID Interface id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.6.5. hammer compute-profile values remove-volume
Remove compute profile volume
Usage:
hammer compute-profile values remove-volume [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume-id VOLUME_ID Volume id
-h, --help Print help2.13.6.6. hammer compute-profile values update
Update compute profile values
Usage:
hammer compute-profile values update [OPTIONS]
Options:
--compute-attributes COMPUTE_ATTRS Compute resource attributes, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface INTERFACE Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
--interface:
--compute-attributes:
availability_zone
flavor_id
groups
security_group_ids
managed_ip
GCE:
--volume:
size_gb Volume size in GB, integer value
--interface:
--compute-attributes:
machine_type
network
associate_external_ip
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
--compute-attributes:
cpus Number of CPUs
memory String, amount of memory, value in bytes
cpu_mode Possible values: default, host-model, host-passthrough
OpenStack:
--volume:
--interface:
--compute-attributes:
availability_zone
boot_from_volume
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
--compute-attributes:
cluster ID or name of cluster to use
template Hardware profile to use
cores Integer value, number of cores
sockets Integer value, number of sockets
memory Amount of memory, integer value in bytes
ha Boolean, set 1 to high availability
display_type Possible values: VNC, SPICE
keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.
Rackspace:
--volume:
--interface:
--compute-attributes:
flavor_id
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
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 or Network Name from VMware
--compute-attributes:
cluster Cluster ID from VMware
corespersocket Number of cores per socket (applicable to hardware versions < 10 only)
cpus CPU count
memory_mb Integer number, amount of memory in MB
path Path to folder
resource_pool Resource Pool ID from VMware
firmware automatic/bios/efi
guest_id Guest OS ID form VMware
hardware_version Hardware version ID from VMware
memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on
cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on
add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
annotation Annotation Notes
scsi_controllers List with SCSI controllers definitions
type - ID of the controller from VMware
key - Key of the controller (e.g. 1000)
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)
--compute-attributes:
resource_group Existing Azure Resource Group of user
vm_size VM Size, eg. Standard_A0 etc.
username The Admin username
password The Admin password
platform OS type eg. Linux
ssh_key_data SSH key for passwordless authentication
os_disk_caching OS disk caching
premium_os_disk Premium OS Disk, Boolean as 0 or 1
script_command Custom Script Command
script_uris Comma seperated file URIs2.13.6.7. hammer compute-profile values update-interface
Update compute profile interface
Usage:
hammer compute-profile values update-interface [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface SET_VALUES Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--interface-id INTERFACE_ID Interface id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--interface:
GCE:
--interface:
Libvirt:
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
OpenStack:
--interface:
oVirt:
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
Rackspace:
--interface:
VMware:
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
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 or Network Name from VMware
AzureRM:
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)2.13.6.8. hammer compute-profile values update-volume
Update compute profile volume
Usage:
hammer compute-profile values update-volume [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--volume-id VOLUME_ID Volume id
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
GCE:
--volume:
size_gb Volume size in GB, integer value
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
OpenStack:
--volume:
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
Rackspace:
--volume:
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)2.14. hammer compute-resource
Manipulate compute resources
Usage:
hammer compute-resource [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
clusters List available clusters for a compute resource
create Create a compute resource
delete, destroy Delete a compute resource
flavors List available flavors for a compute resource
folders List available folders for a compute resource
image View and manage compute resource's images
images List available images for a compute resource
info, show Show a compute resource
list, index List all compute resources
networks List available networks for a compute resource
resource-pools List resource pools for a compute resource cluster
security-groups List available security groups for a compute resource
storage-domains List storage domains for a compute resource
storage-pods List storage pods for a compute resource
update Update a compute resource
virtual-machine View and manage compute resource's virtual machines
virtual-machines List available virtual machines for a compute resource
zones List available zone for a compute resource
Options:
-h, --help Print help2.14.1. hammer compute-resource clusters
List available clusters for a compute resource
Usage:
hammer compute-resource clusters [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.2. hammer compute-resource create
Create a compute resource
Usage:
hammer compute-resource create [OPTIONS]
Options:
--app-ident APP_IDENT Client ID for AzureRm
--caching-enabled CACHING_ENABLED Enable caching, for VMware only
One of true/false, yes/no, 1/0.
--datacenter DATACENTER For RHEV, VMware Datacenter
--description DESCRIPTION
--display-type DISPLAY_TYPE For Libvirt and RHEV only
Possible value(s): 'VNC', 'SPICE'
--domain DOMAIN For RHEL OpenStack Platform (v3) only
--email EMAIL Email for GCE only
--key-path KEY_PATH Certificate path for GCE only
--keyboard-layout KEYBOARD_LAYOUT For RHEV only
Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ovirt-quota OVIRT_QUOTA For RHEV only, ID or Name of quota to use
--password PASSWORD Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2
--project PROJECT Project id for GCE only
--project-domain-id PROJECT_DOMAIN_ID For RHEL OpenStack Platform (v3) only
--project-domain-name PROJECT_DOMAIN_NAME For RHEL OpenStack Platform (v3) only
--provider PROVIDER Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm
--public-key PUBLIC_KEY For RHEV only
--public-key-path PUBLIC_KEY_PATH Path to a file that contains oVirt public key (For oVirt only)
--region REGION For AzureRm eg. 'eastus' and for EC2 only. Use
'us-gov-west-1' for EC2 GovCloud region
--secret-key SECRET_KEY Client Secret for AzureRm
--server SERVER For VMware
--set-console-password SET_CONSOLE_PASSWORD For Libvirt and VMware only
One of true/false, yes/no, 1/0.
--sub-id SUB_ID Subscription ID for AzureRm
--tenant TENANT For RHEL OpenStack Platform and AzureRm only
--url URL URL for Libvirt, RHEV and RHEL OpenStack Platform
--use-v4 USE_V4 For RHEV only
One of true/false, yes/no, 1/0.
--user USER Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for
EC2.
--zone ZONE For GCE only
-h, --help Print help2.14.3. hammer compute-resource delete
Delete a compute resource
Usage:
hammer compute-resource <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.14.4. hammer compute-resource flavors
List available flavors for a compute resource
Usage:
hammer compute-resource flavors [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.5. hammer compute-resource folders
List available folders for a compute resource
Usage:
hammer compute-resource folders [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.6. hammer compute-resource image
View and manage compute resource’s images
Usage:
hammer compute-resource image [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
available Show images available for addition
create Create an image
delete, destroy Delete an image
info, show Show an image
list, index List all images for a compute resource
update Update an image
Options:
-h, --help Print help2.14.6.1. hammer compute-resource image available
Show images available for addition
Usage:
hammer compute-resource image available [OPTIONS]
Options:
--compute-resource NAME Compute resource name
--compute-resource-id ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Name | x | x | x
UUID | x | x |
-------|-----|---------|-----2.14.6.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 ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--password PASSWORD
--user-data USER_DATA Whether or not the image supports user data
One of true/false, yes/no, 1/0.
--username USERNAME
--uuid UUID Template ID in the compute resource
-h, --help Print help2.14.6.3. hammer compute-resource image delete
Delete an image
Usage:
hammer compute-resource image <delete|destroy> [OPTIONS]
Options:
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.14.6.4. hammer compute-resource image info
Show an image
Usage:
hammer compute-resource image <info|show> [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID ID of compute resource
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating System | x | x |
Username | x | x |
UUID | x | x |
User Data | x | x |
Architecture | x | x |
IAM role | x | x |
Created at | x | x |
Updated at | x | x |
-----------------|-----|---------|-----2.14.6.5. hammer compute-resource image list
List all images for a compute resource
Usage:
hammer compute-resource image <list|index> [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID ID of compute resource
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating System | x | x |
Username | x | x |
UUID | x | x |
User Data | x | x |
-----------------|-----|---------|-----
Search / Order fields:
architecture integer
compute_resource string
name string
operatingsystem integer
user_data Values: true, false
username string2.14.6.6. hammer compute-resource image update
Update an image
Usage:
hammer compute-resource image update [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--password PASSWORD
--user-data USER_DATA Whether or not the image supports user data
One of true/false, yes/no, 1/0.
--username USERNAME
--uuid UUID Template ID in the compute resource
-h, --help Print help2.14.7. hammer compute-resource images
List available images for a compute resource
Usage:
hammer compute-resource images [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Uuid | x | x |
Name | x | x | x
-------|-----|---------|-----2.14.8. hammer compute-resource info
Show a compute resource
Usage:
hammer compute-resource <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Provider | x | x |
Description | x | x |
User | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.14.9. hammer compute-resource list
List all compute resources
Usage:
hammer compute-resource <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Provider | x | x |
---------|-----|---------|-----
Search / Order fields:
id integer
location string
location_id integer
name string
organization string
organization_id integer
type string2.14.10. hammer compute-resource networks
List available networks for a compute resource
Usage:
hammer compute-resource networks [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.11. hammer compute-resource resource-pools
List resource pools for a compute resource cluster
Usage:
hammer compute-resource resource-pools [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.12. hammer compute-resource security-groups
List available security groups for a compute resource
Usage:
hammer compute-resource security-groups [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.13. hammer compute-resource storage-domains
List storage domains for a compute resource
Usage:
hammer compute-resource storage-domains [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--storage-domain STORAGE_DOMAIN
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.14. hammer compute-resource storage-pods
List storage pods for a compute resource
Usage:
hammer compute-resource storage-pods [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--storage-pod STORAGE_POD
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.15. hammer compute-resource update
Update a compute resource
Usage:
hammer compute-resource update [OPTIONS]
Options:
--app-ident APP_IDENT Client ID for AzureRm
--caching-enabled CACHING_ENABLED Enable caching, for VMware only
One of true/false, yes/no, 1/0.
--datacenter DATACENTER For RHEV, VMware Datacenter
--description DESCRIPTION
--display-type DISPLAY_TYPE For Libvirt and RHEV only
Possible value(s): 'VNC', 'SPICE'
--domain DOMAIN For RHEL OpenStack Platform (v3) only
--email EMAIL Email for GCE only
--id ID
--key-path KEY_PATH Certificate path for GCE only
--keyboard-layout KEYBOARD_LAYOUT For RHEV only
Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Compute resource name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ovirt-quota OVIRT_QUOTA For RHEV only, ID or Name of quota to use
--password PASSWORD Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2
--project PROJECT Project id for GCE only
--project-domain-id PROJECT_DOMAIN_ID For RHEL OpenStack Platform (v3) only
--project-domain-name PROJECT_DOMAIN_NAME For RHEL OpenStack Platform (v3) only
--provider PROVIDER Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm
--public-key PUBLIC_KEY For RHEV only
--public-key-path PUBLIC_KEY_PATH Path to a file that contains oVirt public key (For oVirt only)
--region REGION For AzureRm eg. 'eastus' and for EC2 only. Use
'us-gov-west-1' for EC2 GovCloud region
--secret-key SECRET_KEY Client Secret for AzureRm
--server SERVER For VMware
--set-console-password SET_CONSOLE_PASSWORD For Libvirt and VMware only
One of true/false, yes/no, 1/0.
--sub-id SUB_ID Subscription ID for AzureRm
--tenant TENANT For RHEL OpenStack Platform and AzureRm only
--url URL URL for Libvirt, RHEV and RHEL OpenStack Platform
--use-v4 USE_V4 For RHEV only
One of true/false, yes/no, 1/0.
--user USER Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for
EC2.
--zone ZONE For GCE only
-h, --help Print help2.14.16. hammer compute-resource virtual-machine
View and manage compute resource’s virtual machines
Usage:
hammer compute-resource virtual-machine [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete a Virtual Machine
info, show Show a virtual machine
power Power a Virtual Machine
Options:
-h, --help Print help2.14.16.1. hammer compute-resource virtual-machine delete
Delete a Virtual Machine
Usage:
hammer compute-resource virtual-machine <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vm-id VM-ID Virtual machine id, for gce use virtual machine name
-h, --help Print help2.14.16.2. hammer compute-resource virtual-machine info
Show a virtual machine
Usage:
hammer compute-resource virtual-machine <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vm-id VM-ID Virtual machine id, for gce use virtual machine name
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.16.3. hammer compute-resource virtual-machine power
Power a Virtual Machine
Usage:
hammer compute-resource virtual-machine power [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vm-id VM-ID Virtual machine id, for gce use virtual machine name
-h, --help Print help2.14.17. hammer compute-resource virtual-machines
List available virtual machines for a compute resource
Usage:
hammer compute-resource virtual-machines [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.18. hammer compute-resource zones
List available zone for a compute resource
Usage:
hammer compute-resource zones [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.15. hammer config-group
Manipulate config groups
Usage:
hammer config-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a config group
delete, destroy Delete a config group
info, show Show a config group
list, index List of config groups
update Update a config group
Options:
-h, --help Print help2.15.1. hammer config-group create
Create a config group
Usage:
hammer config-group create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.15.2. hammer config-group delete
Delete a config group
Usage:
hammer config-group <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.15.3. hammer config-group info
Show a config group
Usage:
hammer config-group <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Puppetclasses/ | x | x |
---------------|-----|---------|-----2.15.4. hammer config-group list
List of config groups
Usage:
hammer config-group <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
class string
name string2.15.5. hammer config-group update
Update a config group
Usage:
hammer config-group update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.16. hammer config-report
Browse and read reports
Usage:
hammer config-report [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete a report
info, show Show a report
list, index List all reports
Options:
-h, --help Print help2.16.1. hammer config-report delete
Delete a report
Usage:
hammer config-report <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.16.2. hammer config-report info
Show a report
Usage:
hammer config-report <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Reported at | x | x |
Report status/Applied | x | x |
Report status/Restarted | x | x |
Report status/Failed | x | x |
Report status/Restart Failures | x | x |
Report status/Skipped | x | x |
Report status/Pending | x | x |
Report metrics/config_retrieval | x | x |
Report metrics/exec | x | x |
Report metrics/file | x | x |
Report metrics/package | x | x |
Report metrics/service | x | x |
Report metrics/user | x | x |
Report metrics/yumrepo | x | x |
Report metrics/filebucket | x | x |
Report metrics/cron | x | x |
Report metrics/total | x | x |
Logs/Resource | x | x |
Logs/Message | x | x |
--------------------------------|-----|---------|-----2.16.3. hammer config-report list
List all reports
Usage:
hammer config-report <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Last report | x | x |
Applied | x | x |
Restarted | x | x |
Failed | x | x |
Restart Failures | x | x |
Skipped | x | x |
Pending | x | x |
-----------------|-----|---------|-----
Search / Order fields:
applied integer
environment string
eventful Values: true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer2.17. hammer content-credentials
Manipulate content credentials on the server
Usage:
hammer content-credentials [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a content credential
delete, destroy Destroy a content credential
info, show Show a content credential
list, index List content credentials
update Update a content credential
Options:
-h, --help Print help2.17.1. hammer content-credentials create
Create a content credential
Usage:
hammer content-credentials create [OPTIONS]
Options:
--content-type CONTENT_TYPE Type of content: "cert", "gpg_key"
--key GPG_KEY_FILE GPG Key file
--name NAME Identifier of the content credential
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.17.2. hammer content-credentials delete
Destroy a content credential
Usage:
hammer content-credentials <delete|destroy> [OPTIONS]
Options:
--id ID Content credential numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.17.3. hammer content-credentials info
Show a content credential
Usage:
hammer content-credentials <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content credential numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Content Type | x | x |
Repositories/Product | x | x |
Content | x | x |
--------------------------|-----|---------|-----2.17.4. hammer content-credentials list
List content credentials
Usage:
hammer content-credentials <list|index> [OPTIONS]
Options:
--content-type CONTENT_TYPE Type of content
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the Content Credential
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----2.17.5. hammer content-credentials update
Update a content credential
Usage:
hammer content-credentials update [OPTIONS]
Options:
--content-type CONTENT_TYPE Type of content
--id ID Content credential numeric identifier
--key GPG_KEY_FILE GPG Key file
--name NAME Name to search by
--new-name NEW_NAME Identifier of the content credential
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.18. hammer content-view
Manipulate content views
Usage:
hammer content-view [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
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 Show a content view
list, index 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:
-h, --help Print help2.18.1. hammer content-view add-repository
Associate a resource
Usage:
hammer content-view add-repository [OPTIONS]
Options:
--id ID Content view numeric identifier
--name NAME Content view name to search by
--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
--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
-h, --help Print help2.18.2. hammer content-view add-version
Add a content view version to a composite view
Usage:
hammer content-view add-version [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier to search by
--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
--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 help2.18.3. hammer content-view component
View and manage components
Usage:
hammer content-view component [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add Add components to the content view
list, index List components attached to this content view
remove Remove components from the content view
update Update a component associated with the content view
Options:
-h, --help Print help2.18.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 help2.18.3.2. hammer content-view component list
List components attached to this content view
Usage:
hammer content-view component <list|index> [OPTIONS]
Options:
--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
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Id | x | x | x
Name | x | x |
Version | x | x |
Current Version | x | x |
Version Id | x | x |
----------------|-----|---------|-----2.18.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.
JSON is acceptable and preferred way for complex parameters
--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
-h, --help Print help2.18.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 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
--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 help2.18.4. hammer content-view copy
Copy a content view
Usage:
hammer content-view copy [OPTIONS]
Options:
--id ID Content view numeric identifier
--name NAME Content view name to search by
--new-name NEW_NAME New content view name
--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 help2.18.5. hammer content-view create
Create a content view
Usage:
hammer content-view create [OPTIONS]
Options:
--auto-publish AUTO_PUBLISH Enable/Disable auto publish of composite view
One of true/false, yes/no, 1/0.
--component-ids COMPONENT_IDS List of component content view version ids for composite views
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--composite Create a composite content view
--description DESCRIPTION Description for the content view
--label LABEL Content view label
--name NAME Name of the content view
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--solve-dependencies SOLVE_DEPENDENCIES Solve RPM dependencies by default on Content View publish, defaults to
False
One of true/false, yes/no, 1/0.
-h, --help Print help2.18.6. hammer content-view delete
Delete a content view
Usage:
hammer content-view delete [OPTIONS]
Options:
--async Do not wait for the task
--id ID Content view numeric identifier
--name NAME Content view name to search by
--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 help2.18.7. hammer content-view filter
View and manage filters
Usage:
hammer content-view filter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-repository Associate a resource
create Create a filter for a content view
delete, destroy Delete a filter
info, show Show filter info
list, index List filters
remove-repository Disassociate a resource
rule View and manage filter rules
update Update a filter
Options:
-h, --help Print help2.18.7.1. hammer content-view filter add-repository
Associate a resource
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
--name NAME Name to search by
--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
--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
-h, --help Print help2.18.7.2. hammer content-view filter create
create a filter for a content view
Usage:
hammer content-view filter create [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--description DESCRIPTION Description of the filter
--inclusion INCLUSION Specifies if content should be included or excluded, default:
Inclusion=false
One of true/false, yes/no, 1/0.
--name NAME Name of the filter
--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
--original-module-streams ORIGINAL_MODULE_STREAMS Add all module streams without errata to the included/excluded list.
(module stream filter only)
One of true/false, yes/no, 1/0.
--original-packages ORIGINAL_PACKAGES Add all packages without errata to the included/excluded list. (package
Filter only)
One of true/false, yes/no, 1/0.
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repositories REPOSITORY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--type TYPE Type of filter (e.g. rpm, package_group, erratum, docker, modulemd)
-h, --help Print help2.18.7.3. hammer content-view filter delete
delete a filter
Usage:
hammer content-view filter <delete|destroy> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--id ID Filter identifier
--name NAME Name to search by
--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 help2.18.7.4. hammer content-view filter info
show filter info
Usage:
hammer content-view filter <info|show> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Filter identifier
--name NAME Name to search by
--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
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
Filter ID | x | x | x
Name | x | x | x
Type | x | x |
Inclusion | x | x |
Description | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Label | x | x |
Rules/ID | x | x |
Rules/Name | x | x |
Rules/Version | x | x |
Rules/Minimum Version | x | x |
Rules/Maximum Version | x | x |
Rules/Errata ID | x | x |
Rules/Start Date | x | x |
Rules/End Date | x | x |
Rules/Types | x | x |
Rules/Created | x | x |
Rules/Updated | x | x |
----------------------|-----|---------|-----2.18.7.5. hammer content-view filter list
list filters
Usage:
hammer content-view filter <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Filter content view filters by name
--order ORDER Sort field and order, eg. 'id DESC'
--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
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--types TYPES Types of filters
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Filter ID | x | x | x
Name | x | x | x
Description | x | x |
Type | x | x |
Inclusion | x | x |
------------|-----|---------|-----
Search / Order fields:
content_type Values: rpm, package_group, erratum, docker, modulemd
inclusion_type Values: include, exclude
name string2.18.7.6. hammer content-view filter remove-repository
Disassociate a resource
Usage:
hammer content-view filter remove-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
--name NAME Name to search by
--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
--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
-h, --help Print help2.18.7.7. hammer content-view filter rule
View and manage filter rules
Usage:
hammer content-view filter rule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a filter rule. The parameters included should be based upon the filter type.
delete, destroy Delete a filter rule
info, show Show filter rule info
list, index List filter rules
update Update a filter rule. The parameters included should be based upon the filter type.
Options:
-h, --help Print help2.18.7.7.1. 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
--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
--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.
JSON is acceptable and preferred way for complex parameters
--max-version MAX_VERSION Package: maximum version
--min-version MIN_VERSION Package: minimum version
--module-stream-ids MODULE_STREAM_IDS Module stream ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Package, package group, or docker tag names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--names NAMES Package and package group names
--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
--start-date START_DATE Erratum: start date (YYYY-MM-DD)
--types TYPES Erratum: types (enhancement, bugfix, security)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--uuid UUID Package group: uuid
--version VERSION Package: version
-h, --help Print help2.18.7.7.2. hammer content-view filter rule delete
Delete a filter rule
Usage:
hammer content-view filter rule <delete|destroy> [OPTIONS]
Options:
--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
--id ID Rule identifier
--name NAME Name to search by
--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 help2.18.7.7.3. hammer content-view filter rule info
Show filter rule info
Usage:
hammer content-view filter rule <info|show> [OPTIONS]
Options:
--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
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Rule identifier
--name NAME Name to search by
--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
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Rule ID | x | x | x
Filter ID | x | x |
Name | x | x | x
Version | x | x |
Minimum Version | x | x |
Maximum Version | x | x |
Architecture | x | x |
Errata ID | x | x |
Start Date | x | x |
End Date | x | x |
Date Type | x | x |
Types | x | x |
Created | x | x |
Updated | x | x |
----------------|-----|---------|-----2.18.7.7.4. hammer content-view filter rule list
List filter rules
Usage:
hammer content-view filter rule <list|index> [OPTIONS]
Options:
--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
--errata-id ERRATA_ID Errata_id of the content view filter rule
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the content view filter rule
--order ORDER Sort field and order, eg. 'id DESC'
--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
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Rule ID | x | x | x
Filter ID | x | x |
Name | x | x | x
Version | x | x |
Minimum Version | x | x |
Maximum Version | x | x |
Architecture | x | x |
Errata ID | x | x |
Start Date | x | x |
End Date | x | x |
----------------|-----|---------|-----2.18.7.7.5. 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
--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
--end-date END_DATE Erratum: end date (YYYY-MM-DD)
--errata-id ERRATA_ID Erratum: id
--id ID Rule identifier
--max-version MAX_VERSION Package: maximum version
--min-version MIN_VERSION Package: minimum version
--name NAME Name to search by
--new-name NEW_NAME Package, package group, or docker tag: name
--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
--start-date START_DATE Erratum: start date (YYYY-MM-DD)
--types TYPES Erratum: types (enhancement, bugfix, security)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--version VERSION Package: version
-h, --help Print help2.18.7.8. hammer content-view filter update
update a filter
Usage:
hammer content-view filter update [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--description DESCRIPTION Description of the filter
--id ID Filter identifier
--inclusion INCLUSION Specifies if content should be included or excluded, default:
Inclusion=false
One of true/false, yes/no, 1/0.
--name NAME Name to search by
--new-name NEW_NAME New name for the filter
--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
--original-module-streams ORIGINAL_MODULE_STREAMS Add all module streams without errata to the included/excluded list.
(module stream filter only)
One of true/false, yes/no, 1/0.
--original-packages ORIGINAL_PACKAGES Add all packages without errata to the included/excluded list. (package
Filter only)
One of true/false, yes/no, 1/0.
--repositories REPOSITORY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.18.8. hammer content-view info
Show a content view
Usage:
hammer content-view <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content view numeric identifier
--name NAME Content view name to search by
--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
Predefined field sets:
-----------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Label | x | x |
Composite | x | x |
Description | x | x |
Content Host Count | x | x |
Force Puppet | x | x |
Solve Dependencies | x | x |
Organization | x | x |
Yum Repositories/ID | x | x |
Yum Repositories/Name | x | x |
Yum Repositories/Label | x | x |
Container Image Repositories/ID | x | x |
Container Image Repositories/Name | x | x |
Container Image Repositories/Label | x | x |
OSTree Repositories/ID | x | x |
OSTree Repositories/Name | x | x |
OSTree Repositories/Label | x | x |
Puppet Modules/ID | x | x |
Puppet Modules/UUID | x | x |
Puppet Modules/Name | x | x |
Puppet Modules/Author | x | x |
Lifecycle Environments/ID | x | x |
Lifecycle Environments/Name | x | x |
Versions/ID | x | x |
Versions/Version | x | x |
Versions/Published | x | x |
Components/ID | x | x |
Components/Name | x | x |
Activation Keys/ | x | x |
-----------------------------------|-----|---------|-----2.18.9. hammer content-view list
List content views
Usage:
hammer content-view <list|index> [OPTIONS]
Options:
--composite COMPOSITE Filter only composite content views
One of true/false, yes/no, 1/0.
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--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.
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--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.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Content View ID | x | x | x
Name | x | x | x
Label | x | x |
Composite | x | x |
Last Published | x | x |
Repository IDs | x | x |
----------------|-----|---------|-----
Search / Order fields:
composite boolean
label string
name string
organization_id integer2.18.10. hammer content-view publish
Publish a content view
Usage:
hammer content-view publish [OPTIONS]
Options:
--async Do not wait for the task
--description DESCRIPTION Description for the new published content view version
--id ID Content view identifier
--major MAJOR Override the major version number
--minor MINOR Override the minor version number
--name NAME Content view name to search by
--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
--repos-units REPOS_UNITS Specify the list of units in each repo
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--repos-units "label=<string>\,rpm_filenames=<array>, ... "2.18.11. hammer content-view puppet-module
View and manage puppet modules
Usage:
hammer content-view puppet-module [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add Add a puppet module to the content view
list, index List content view puppet modules
remove Remove a puppet module from the content view
Options:
-h, --help Print help2.18.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 by
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--id ID The id of the puppet module to associate
--name NAME Puppet module name to search by
--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
--uuid UUID Puppet module's UUID to search by
-h, --help Print help2.18.11.2. hammer content-view puppet-module list
List content view puppet modules
Usage:
hammer content-view puppet-module <list|index> [OPTIONS]
Options:
--author AUTHOR Author of the puppet module
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the puppet module
--order ORDER Sort field and order, eg. 'id DESC'
--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
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--uuid UUID Uuid of the puppet module
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
UUID | x | x | x
Name | x | x | x
Author | x | x | x
Version | x | x |
--------|-----|---------|-----
Search / Order fields:
author string
content_view_name string
name string
uuid string2.18.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
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--id ID Puppet module ID
--name NAME Puppet module name to search by
--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
--uuid UUID Puppet module's UUID to search by
-h, --help Print help2.18.12. hammer content-view purge
Delete old versions of a content view
Usage:
hammer content-view purge [OPTIONS]
Options:
--async Do not wait for the task
--count COUNT Count of unused versions to keep
Default: 3
--id ID Content View numeric identifier
--name NAME Content View name
--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 help2.18.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 Version ids to remove
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--content-view-versions CONTENT_VIEW_VERSION_VERSIONS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environment-ids ENVIRONMENT_IDS (--environment-ids is deprecated: Use --lifecycle-environment-ids instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environments ENVIRONMENT_NAMES (--environments is deprecated: Use --lifecycle-environments instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content view 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
--lifecycle-environment-ids LIFECYCLE_ENVIRONMENT_IDS Environment ids to remove
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environments LIFECYCLE_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Content view name to search by
--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
--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
-h, --help Print help2.18.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
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Content view numeric identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Content view name to search by
--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 help2.18.15. hammer content-view remove-repository
Disassociate a resource
Usage:
hammer content-view remove-repository [OPTIONS]
Options:
--id ID Content view numeric identifier
--name NAME Content view name to search by
--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
--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
-h, --help Print help2.18.16. hammer content-view remove-version
Remove a content view version from a composite view
Usage:
hammer content-view remove-version [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--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
--id ID Content view numeric identifier
--name NAME Content view name to search by
--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 help2.18.17. hammer content-view update
Update a content view
Usage:
hammer content-view update [OPTIONS]
Options:
--auto-publish AUTO_PUBLISH Enable/Disable auto publish of composite view
One of true/false, yes/no, 1/0.
--component-ids COMPONENT_IDS List of component content view version ids for composite views
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION Description for the content view
--id ID Content view identifier
--name NAME Content view name to search by
--new-name NEW_NAME New name for the content view
--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
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--solve-dependencies SOLVE_DEPENDENCIES Solve RPM dependencies by default on Content View publish, defaults to
False
One of true/false, yes/no, 1/0.
-h, --help Print help2.18.18. hammer content-view version
View and manage content view versions
Usage:
hammer content-view version [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete Remove content view version
export Export a content view version
export-default Export the library default content view
export-legacy Export a content view (legacy method)
import Import a content view version
incremental-update Perform an Incremental Update on one or more Content View Versions
info, show Show content view version
list, index List content view versions
promote Promote a content view version
republish-repositories Forces a republish of the version's repositories' metadata
update Update a content view version
Options:
-h, --help Print help2.18.18.1. hammer content-view version delete
Remove content view version
Usage:
hammer content-view version delete [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
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Content view version identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help2.18.18.2. hammer content-view version export
Export a content view version
Usage:
hammer content-view version export [OPTIONS]
Options:
--export-dir EXPORT_DIR Directory to put content view version export into.
--id ID Content View Version numeric identifier
-h, --help Print help2.18.18.3. hammer content-view version export-default
Export the library default content view
Usage:
hammer content-view version export-default [OPTIONS]
Options:
--export-dir EXPORT_DIR Directory to put content view version export into.
-h, --help Print help2.18.18.4. hammer content-view version export-legacy
Export a content view (legacy method)
Usage:
hammer content-view version export-legacy [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
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--export-to-iso EXPORT_TO_ISO Export to ISO format.
One of true/false, yes/no, 1/0.
--id ID Content view version identifier
--iso-mb-size ISO_MB_SIZE Maximum size of each ISO in MB. Relevant only for Pulp 2 repositories
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--since SINCE Optional date of last export (ex: 2010-01-01T12:00:00Z). Relevant only for
Pulp 2 repositories
--version VERSION Content view version number
-h, --help Print help2.18.18.5. hammer content-view version import
Import a content view version
Usage:
hammer content-view version import [OPTIONS]
Options:
--async Do not wait for the task
--export-tar EXPORT_TAR Location of export tar on disk
--organization-id ORGANIZATION_ID Organization numeric identifier
-h, --help Print help2.18.18.6. 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
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content View Version Ids to perform an incremental update on. May contain
Composites as well as one or more components to update.
--deb-ids DEB_IDS Deb Package ids to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--debs DEB_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION The description for the new generated Content View Versions
--errata-ids ERRATA_IDS Errata ids to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host-ids HOST_IDS IDs of hosts to update
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment-ids ENVIRONMENT_IDS List of lifecycle environment IDs to update the content view version in
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environments ENVIRONMENTS List of lifecycle environment names to update the content view version in
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Organization name for resolving lifecycle environment names
--organization-id ORGANIZATION_ID Organization id for resolving lifecycle environment names
--package-ids PACKAGE_IDS Package ids to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--packages PACKAGE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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 to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-modules PUPPET_MODULE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--resolve-dependencies RESOLVE_DEPENDENCIES If true, when adding the specified errata or packages, any needed
Dependencies will be copied as well. Defaults to true
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.
-h, --help Print help2.18.18.7. hammer content-view version info
Show content view version
Usage:
hammer content-view version <info|show> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content view version identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help
Predefined field sets:
-----------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------------|-----|---------|-----
ID | x | x | x
Name | x | x |
Version | x | x | x
Description | x | x |
Content View ID | x | x |
Content View Name | x | x |
Content View Label | x | x |
Lifecycle Environments/ID | x | x |
Lifecycle Environments/Name | x | x |
Lifecycle Environments/Label | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Label | x | x |
Puppet Modules/ID | x | x |
Puppet Modules/Name | x | x |
Puppet Modules/Author | x | x |
Puppet Modules/Version | x | x |
-----------------------------|-----|---------|-----2.18.18.8. hammer content-view version list
List content view versions
Usage:
hammer content-view version <list|index> [OPTIONS]
Options:
--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
--content-view-id CONTENT_VIEW_ID Content view identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--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 Filter versions by puppet module
--search SEARCH Search string
--triggered-by-id TRIGGERED_BY_ID Filter composite versions whose publish was triggered by the specified
Component version
--version VERSION Filter versions by version number
-h, --help Print help
Predefined field sets:
-----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------|-----|---------|-----
ID | x | x | x
Name | x | x |
Version | x | x | x
Description | x | x |
Lifecycle Environments | x | x |
-----------------------|-----|---------|-----
Search / Order fields:
content_view_id integer
repository string
version string2.18.18.9. 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
--force Force content view promotion and bypass lifecycle environment restriction
--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 ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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 help2.18.18.10. hammer content-view version republish-repositories
Forces a republish of the version’s repositories' metadata
Usage:
hammer content-view version republish-repositories [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
--id ID Content view version identifier
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help2.18.18.11. hammer content-view version update
Update a content view version
Usage:
hammer content-view version update [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 The description for the content view version
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Content view version identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--new-version NEW_VERSION
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help2.19. hammer deb-package
Manipulate deb packages
Usage:
hammer deb-package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a deb
list, index List debs
Options:
-h, --help Print help2.19.1. hammer deb-package info
Show a deb
Usage:
hammer deb-package <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A deb identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
ID | x | x | x
Pulp ID | x | x |
UUID | x | x |
Name | x | x | x
Version | x | x |
checksum | x | x |
Architecture | x | x |
Nav | x | x |
Nva | x | x |
Filename | x | x |
Available Host Count | x | x |
Applicable Host Count | x | x |
Description | x | x |
----------------------|-----|---------|-----2.19.2. hammer deb-package list
List debs
Usage:
hammer deb-package <list|index> [OPTIONS]
Options:
--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 Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule 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
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
---------|-----|--------
FIELDS | ALL | DEFAULT
---------|-----|--------
ID | x | x
Filename | x | x
---------|-----|--------2.20. hammer defaults
Defaults management
Usage:
hammer defaults [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
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:
-h, --help Print help2.20.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`
-h, --help Print help2.20.2. hammer defaults delete
Delete a default param
Usage:
hammer defaults delete [OPTIONS]
Options:
--param-name OPTION_NAME The name of the default option
-h, --help Print help2.20.3. hammer defaults list
List all the default parameters
Usage:
hammer defaults list [OPTIONS]
Options:
-h, --help Print help2.20.4. hammer defaults providers
List all the providers
Usage:
hammer defaults providers [OPTIONS]
Options:
-h, --help Print help2.21. hammer discovery
Manipulate discovered hosts.
Usage:
hammer discovery [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
auto-provision Auto provision a host
delete, destroy Delete a discovered host
facts List all fact values
info, show Show a discovered host
list, index List all discovered hosts
provision Provision a discovered host
reboot Reboot a host
refresh-facts Refresh the facts of a host
Options:
-h, --help Print help2.21.1. hammer discovery auto-provision
Auto provision a host
Usage:
hammer discovery auto-provision [OPTIONS]
Options:
--all Auto provision all discovered hosts
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.21.2. hammer discovery delete
Delete a discovered host
Usage:
hammer discovery <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.21.3. hammer discovery facts
List all fact values
Usage:
hammer discovery facts [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|--------
FIELDS | ALL | DEFAULT
-------|-----|--------
Fact | x | x
Value | x | x
-------|-----|--------
Search / Order fields:
fact string
fact_short_name string
facts string
host string
host.hostgroup string
host_id integer
location string
location_id integer
name string
organization string
organization_id integer
origin string
reported_at datetime
short_name string
type string
value string2.21.4. hammer discovery info
Show a discovered host
Usage:
hammer discovery <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
MAC | x | x |
CPUs | x | x |
Memory | x | x |
Disk count | x | x |
Disks size | x | x |
Subnet | x | x |
Last report | x | x |
IP | x | x |
Model | x | x |
Organization | x | x |
Location | x | x |
-------------|-----|---------|-----2.21.5. hammer discovery list
List all discovered hosts
Usage:
hammer discovery <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort results
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Paginate results
--per-page PER_PAGE Number of entries per request
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
MAC | x | x |
CPUs | x | x |
Memory | x | x |
Disk count | x | x |
Disks size | x | x |
Subnet | x | x |
Last report | x | x |
------------|-----|---------|-----2.21.6. hammer discovery provision
Provision a discovered host
Usage:
hammer discovery provision [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID Required if host is managed and value is not inherited from host group
--ask-root-password ASK_ROOT_PW One of true/false, yes/no, 1/0.
--build BUILD One of true/false, yes/no, 1/0.
--capabilities CAPABILITIES
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Required if host is managed and value is not inherited from host group
--enabled ENABLED One of true/false, yes/no, 1/0.
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--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.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--ip IP Not required if using a subnet with DHCP Capsule
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mac MAC Not required if it's a virtual machine
--managed MANAGED One of true/false, yes/no, 1/0.
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID Required if not imaged based provisioning and host is managed and value is
not inherited from host group
--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
--operatingsystem-id OPERATINGSYSTEM_ID Required if host is managed and value is not inherited from host group
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--overwrite OVERWRITE One of true/false, yes/no, 1/0.
--owner-id OWNER_ID
--owner-type OWNER_TYPE Host's owner type
Possible value(s): 'User', 'Usergroup'
--parameters PARAMS Host parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--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-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--puppet-proxy-id PUPPET_PROXY_ID
--puppetclass-ids PUPPETCLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--pxe-loader PXE_LOADER DHCP filename option (Grub2 or PXELinux by default)
Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
--root-password ROOT_PW
--sp-subnet-id SP_SUBNET_ID
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Required if host is managed and value is not inherited from host group
-h, --help Print help2.21.7. hammer discovery reboot
Reboot a host
Usage:
hammer discovery reboot [OPTIONS]
Options:
--all Reboot all discovered hosts
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.21.8. hammer discovery refresh-facts
Refresh the facts of a host
Usage:
hammer discovery refresh-facts [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.22. hammer discovery-rule
Manipulate discovered rules.
Usage:
hammer discovery-rule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a discovery rule
delete, destroy Delete a rule
info, show Show a discovery rule
list, index List all discovery rules
update Update a rule
Options:
-h, --help Print help2.22.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
One of true/false, yes/no, 1/0.
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID The hostgroup that is used to auto provision a host
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--hostname HOSTNAME Defines a pattern to assign human-readable hostnames to the matching hosts
--hosts-limit HOSTS_LIMIT
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Location ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--max-count MAX_COUNT Enables to limit maximum amount of provisioned hosts per rule
--name NAME Represents rule name shown to the users
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Organization ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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
-h, --help Print help2.22.2. hammer discovery-rule delete
Delete a rule
Usage:
hammer discovery-rule <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.22.3. hammer discovery-rule info
Show a discovery rule
Usage:
hammer discovery-rule <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Priority | x | x |
Search | x | x |
Host Group | x | x |
Hosts Limit | x | x |
Enabled | x | x |
Hostname template | x | x |
Hosts/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
------------------|-----|---------|-----2.22.4. hammer discovery-rule list
List all discovery rules
Usage:
hammer discovery-rule <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort results
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Paginate results
--per-page PER_PAGE Number of entries per request
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Priority | x | x |
Search | x | x |
Host Group | x | x |
Hosts Limit | x | x |
Enabled | x | x |
------------|-----|---------|-----2.22.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
One of true/false, yes/no, 1/0.
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID The hostgroup that is used to auto provision a host
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--hostname HOSTNAME Defines a pattern to assign human-readable hostnames to the matching hosts
--hosts-limit HOSTS_LIMIT
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Location ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--max-count MAX_COUNT Enables to limit maximum amount of provisioned hosts per rule
--name NAME Name to search by
--new-name NEW_NAME Represents rule name shown to the users
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Organization ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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
-h, --help Print help2.23. hammer docker
Manipulate docker content
Usage:
hammer docker [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
manifest Manage docker manifests
tag Manage docker tags
Options:
-h, --help Print help2.23.1. hammer docker manifest
Manage docker manifests
Usage:
hammer docker manifest [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a docker manifest
list, index List docker_manifests
Options:
-h, --help Print help2.23.1.1. hammer docker manifest info
Show a docker manifest
Usage:
hammer docker manifest <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A docker manifest identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Schema Version | x | x |
Digest | x | x |
Downloaded | x | x |
Tags/Name | x | x |
---------------|-----|---------|-----2.23.1.2. hammer docker manifest list
List docker_manifests
Usage:
hammer docker manifest <list|index> [OPTIONS]
Options:
--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 Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule 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
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Schema Version | x | x |
Digest | x | x |
Downloaded | x | x |
Tags | x | x |
---------------|-----|---------|-----2.23.2. hammer docker tag
Manage docker tags
Usage:
hammer docker tag [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a docker tag
list, index List docker_tags
Options:
-h, --help Print help2.23.2.1. hammer docker tag info
Show a docker tag
Usage:
hammer docker tag <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A docker tag identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
---------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------|-----|---------|-----
ID | x | x | x
Tag | x | x | x
Repository ID | x | x |
Docker Manifest ID | x | x |
Docker Manifest Name | x | x |
---------------------|-----|---------|-----2.23.2.2. hammer docker tag list
List docker_tags
Usage:
hammer docker tag <list|index> [OPTIONS]
Options:
--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 Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule 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
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
ID | x | x | x
Tag | x | x | x
Repository ID | x | x |
--------------|-----|---------|-----2.24. hammer domain
Manipulate domains
Usage:
hammer domain [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a domain
delete, destroy Delete a domain
delete-parameter Delete parameter for a domain
info, show Show a domain
list, index List of domains
set-parameter Create or update parameter for a domain
update Update a domain
Options:
-h, --help Print help2.24.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
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME The full DNS domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.24.2. hammer domain delete
Delete a domain
Usage:
hammer domain <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.24.3. hammer domain delete-parameter
Delete parameter for a domain
Usage:
hammer domain delete-parameter [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--name NAME Parameter name
-h, --help Print help2.24.4. hammer domain info
Show a domain
Usage:
hammer domain <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Numerical ID or domain name
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Description | x | x |
DNS Id | x | x |
Subnets/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Parameters/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.24.5. hammer domain list
List of domains
Usage:
hammer domain <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID ID of subnet
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
fullname string
location string
location_id integer
name string
organization string
organization_id integer
params string2.24.6. hammer domain set-parameter
Create or update parameter for a domain
Usage:
hammer domain set-parameter [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.24.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
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Domain name
--new-name NEW_NAME The full DNS domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.25. hammer environment
Manipulate environments
Usage:
hammer environment [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an environment
delete, destroy Delete an environment
info, show Show an environment
list, index List all environments
sc-params List all smart class parameters
update Update an environment
Options:
-h, --help Print help2.25.1. hammer environment create
Create an environment
Usage:
hammer environment create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.25.2. hammer environment delete
Delete an environment
Usage:
hammer environment <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Puppet environment name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.25.3. hammer environment info
Show an environment
Usage:
hammer environment <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Puppet environment name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Puppetclasses/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.25.4. hammer environment list
List all environments
Usage:
hammer environment <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
content_view string
lifecycle_environment string
location string
location_id integer
name string
organization string
organization_id integer2.25.5. hammer environment sc-params
List all smart class parameters
Usage:
hammer environment sc-params [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
Puppet class | x | x
Class Id | x | x
--------------|-----|--------
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string2.25.6. hammer environment update
Update an environment
Usage:
hammer environment update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Puppet environment name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.26. hammer erratum
Manipulate errata
Usage:
hammer erratum [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info Show an erratum
list, index List errata
Options:
-h, --help Print help2.26.1. hammer erratum info
Show an erratum
Usage:
hammer erratum info [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID An erratum identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------|-----|--------
Title | x | x
Version | x | x
Description | x | x
Status | x | x
ID | x | x
Errata ID | x | x
Reboot Suggested | x | x
Updated | x | x
Issued | x | x
Release | x | x
Solution | x | x
Packages | x | x
Module Streams/Name | x | x
Module Streams/Stream | x | x
Module Streams/Packages | x | x
------------------------|-----|--------2.26.2. hammer erratum list
List errata
Usage:
hammer erratum <list|index> [OPTIONS]
Options:
--available-for AVAILABLE_FOR Return errata that can be added to the specified object. The values
'content_view_version' and 'content_view_filter are supported.
--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 Content View 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
--errata-restrict-applicable ERRATA_RESTRICT_APPLICABLE Return errata that are applicable to one or more hosts (defaults to true if
Host_id is specified)
One of true/false, yes/no, 1/0.
--errata-restrict-installable ERRATA_RESTRICT_INSTALLABLE Return errata that are upgradable on one or more hosts
One of true/false, yes/no, 1/0.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID Host id to list applicable errata for
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
----------|-----|--------
FIELDS | ALL | DEFAULT
----------|-----|--------
ID | x | x
Errata ID | x | x
Type | x | x
Title | x | x
Issued | x | x
Updated | x | x
----------|-----|--------
Search / Order fields:
bug string
cve string
errata_id string
errata_type string
id string
issued date
modular Values: true, false
package string
package_name string
reboot_suggested boolean
repository string
severity string
title string
type string
updated date2.27. hammer export-templates
Export templates to a git repo or a directory on the server
Usage:
hammer export-templates [OPTIONS]
Options:
--branch BRANCH Branch in Git repo.
--commit-msg COMMIT_MSG Custom commit message for templates export
--dirname DIRNAME The directory within Git repo containing the templates
--filter FILTER Export templates with names matching this regex (case-insensitive; snippets
Are not filtered).
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--metadata-export-mode METADATA_EXPORT_MODE Specify how to handle metadata
Possible value(s): 'refresh', 'keep', 'remove'
--negate NEGATE Negate the prefix (for purging).
One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--repo REPO Override the default repo from settings.
--verbose BE_VERBOSE Be verbose
One of true/false, yes/no, 1/0.
-h, --help Print help2.28. hammer fact
Search facts
Usage:
hammer fact [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
list, index List all fact values
Options:
-h, --help Print help2.28.1. hammer fact list
List all fact values
Usage:
hammer fact <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|--------
FIELDS | ALL | DEFAULT
-------|-----|--------
Host | x | x
Fact | x | x
Value | x | x
-------|-----|--------
Search / Order fields:
fact string
fact_short_name string
facts string
host string
host.hostgroup string
host_id integer
location string
location_id integer
name string
organization string
organization_id integer
origin string
reported_at datetime
short_name string
type string
value string2.29. hammer file
Manipulate files
Usage:
hammer file [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a file
list, index List files
Options:
-h, --help Print help2.29.1. hammer file info
Show a file
Usage:
hammer file <info|show> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--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 ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A file identifier
--name NAME File name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
ID | x | x |
Name | x | x | x
Path | x | x |
UUID | x | x |
Checksum | x | x |
---------|-----|---------|-----2.29.2. hammer file list
List files
Usage:
hammer file <list|index> [OPTIONS]
Options:
--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 Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule 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
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--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
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x |
Name | x | x | x
Path | x | x |
-------|-----|---------|-----2.30. hammer filter
Manage permission filters
Usage:
hammer filter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
available-permissions List all permissions
available-resources List available resource types
create Create a filter
delete, destroy Delete a filter
info, show Show a filter
list, index List all filters
update Update a filter
Options:
-h, --help Print help2.30.1. hammer filter available-permissions
List all permissions
Usage:
hammer filter available-permissions [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Resource | x | x |
---------|-----|---------|-----
Search / Order fields:
name string
resource_type string2.30.2. hammer filter available-resources
List available resource types
Usage:
hammer filter available-resources [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Name | x | x | x
-------|-----|---------|-----2.30.3. hammer filter create
Create a filter
Usage:
hammer filter create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--override OVERRIDE One of true/false, yes/no, 1/0.
--permission-ids PERMISSION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--permissions PERMISSION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--role ROLE_NAME User role name
--role-id ROLE_ID
--search SEARCH
-h, --help Print help
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.2.30.4. hammer filter delete
Delete a filter
Usage:
hammer filter <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.30.5. hammer filter info
Show a filter
Usage:
hammer filter <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Resource type | x | x |
Search | x | x |
Unlimited? | x | x |
Override? | x | x |
Role | x | x |
Permissions | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.30.6. hammer filter list
List all filters
Usage:
hammer filter <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
Id | x | x | x
Resource type | x | x |
Search | x | x |
Unlimited? | x | x |
Override? | x | x |
Role | x | x |
Permissions | x | x |
--------------|-----|---------|-----
Search / Order fields:
limited Values: true, false
location string
location_id integer
organization string
organization_id integer
override Values: true, false
permission string
resource string
role string
role_id integer
search text
unlimited Values: true, false2.30.7. hammer filter update
Update a filter
Usage:
hammer filter update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--override OVERRIDE One of true/false, yes/no, 1/0.
--permission-ids PERMISSION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--permissions PERMISSION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--role ROLE_NAME User role name
--role-id ROLE_ID
--search SEARCH
-h, --help Print help
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.2.31. hammer foreign-input-set
Manage foreign input sets
Usage:
hammer foreign-input-set [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a foreign input set
delete, destroy Delete a foreign input set
info, show Show foreign input set details
list, index List foreign input sets
update Update a foreign input set
Options:
-h, --help Print help2.31.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 names to be included from the foreign
Template.
--include-all INCLUDE_ALL Include all inputs from the foreign template
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--target-template-id TARGET_TEMPLATE_ID Target template ID
--template-id TEMPLATE_ID
-h, --help Print help2.31.2. hammer foreign-input-set delete
Delete a foreign input set
Usage:
hammer foreign-input-set <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--template-id TEMPLATE_ID
-h, --help Print help2.31.3. hammer foreign-input-set info
Show foreign input set details
Usage:
hammer foreign-input-set <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--template-id TEMPLATE_ID
-h, --help Print help
Predefined field sets:
---------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Target template ID | x | x |
Target template name | x | x |
Include all | x | x |
Include | x | x |
Exclude | x | x |
---------------------|-----|---------|-----2.31.4. hammer foreign-input-set list
List foreign input sets
Usage:
hammer foreign-input-set <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--template-id TEMPLATE_ID
-h, --help Print help
Predefined field sets:
---------------------|-----|--------
FIELDS | ALL | DEFAULT
---------------------|-----|--------
ID | x | x
Target template ID | x | x
Target template name | x | x
---------------------|-----|--------2.31.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 names to be included from the foreign
Template.
--id ID
--include INCLUDE A comma separated list of input names to be included from the foreign
Template.
--include-all INCLUDE_ALL Include all inputs from the foreign template
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--target-template-id TARGET_TEMPLATE_ID Target template ID
--template-id TEMPLATE_ID
-h, --help Print help2.32. hammer full-help
Print help for all hammer commands
Usage:
hammer full-help [OPTIONS]
Options:
--md Format output in markdown
-h, --help Print help2.33. hammer global-parameter
Manipulate global parameters
Usage:
hammer global-parameter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete a global parameter
list, index List all global parameters
set Set a global parameter
Options:
-h, --help Print help2.33.1. hammer global-parameter delete
Delete a global parameter
Usage:
hammer global-parameter <delete|destroy> [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Common parameter name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.33.2. hammer global-parameter list
List all global parameters
Usage:
hammer global-parameter <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Name | x | x | x
Value | x | x |
Type | x | x |
-------|-----|---------|-----
Search / Order fields:
domain_name string
host_group_name string
host_name string
key_type string
location_name string
name string
organization_name string
os_name string
parameter_type string
subnet_name text
type string
value text2.33.3. hammer global-parameter set
Set a global parameter
Usage:
hammer global-parameter set [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.34. hammer gpg
Manipulate GPG Key actions on the server
Usage:
hammer gpg [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a gpg key
delete, destroy Destroy a gpg key
info, show Show a gpg key
list, index List gpg keys
update Update a repository
Options:
-h, --help Print help2.34.1. hammer gpg create
Create a gpg key
Usage:
hammer gpg create [OPTIONS]
Options:
--key GPG_KEY_FILE GPG Key file
--name NAME Identifier of the gpg key
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.34.2. hammer gpg delete
Destroy a gpg key
Usage:
hammer gpg <delete|destroy> [OPTIONS]
Options:
--id ID Gpg key numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.34.3. hammer gpg info
Show a gpg key
Usage:
hammer gpg <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Gpg key numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Content Type | x | x |
Repositories/Product | x | x |
Content | x | x |
--------------------------|-----|---------|-----2.34.4. hammer gpg list
List gpg keys
Usage:
hammer gpg <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the GPG key
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
name string
organization_id integer2.34.5. hammer gpg update
Update a repository
Usage:
hammer gpg update [OPTIONS]
Options:
--id ID Gpg key numeric identifier
--key GPG_KEY_FILE GPG Key file
--name NAME Name to search by
--new-name NEW_NAME Identifier of the gpg key
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.35. hammer host
Manipulate hosts
Usage:
hammer host [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
ansible-roles Manage Ansible roles on a host
boot Boot host from specified device
config-reports List all reports
create Create a host
deb-package Manage deb packages on your hosts
delete, destroy Delete a host
delete-parameter Delete parameter for a host
disassociate Disassociate a host
enc-dump Dump host's ENC YAML
errata Manage errata on your hosts
facts List all fact values
info, show Show a host
interface View and manage host's network interfaces
list, index List all hosts
package Manage packages on your hosts
package-group Manage package-groups on your hosts
policies-enc View policies ENC for host
puppet-classes List all Puppet classes
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
reset Reset a host
sc-params List all smart class parameters
set-parameter Create or append a parameter for a host
start Power a host on
status Get status of host
stop Power a host off
subscription Manage subscription information on your hosts
traces List traces on your hosts
update Update a host
Options:
-h, --help Print help2.35.1. hammer host ansible-roles
Manage Ansible roles on a host
Usage:
hammer host ansible-roles [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
assign Assigns Ansible roles to a host
list, index List all Ansible roles for a host
play Runs all Ansible roles on a host
Options:
-h, --help Print help2.35.1.1. hammer host ansible-roles assign
Assigns Ansible roles to a host
Usage:
hammer host ansible-roles assign [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS Ansible roles to assign to a host
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.1.2. hammer host ansible-roles list
List all Ansible roles for a host
Usage:
hammer host ansible-roles <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Imported at | x | x |
------------|-----|---------|-----2.35.1.3. hammer host ansible-roles play
Runs all Ansible roles on a host
Usage:
hammer host ansible-roles play [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.2. hammer host boot
Boot host from specified device
Usage:
hammer host boot [OPTIONS]
Options:
--device DEVICE Boot device, valid devices are disk, cdrom, pxe, bios
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.3. hammer host config-reports
List all reports
Usage:
hammer host config-reports [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Host id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Last report | x | x |
Applied | x | x |
Restarted | x | x |
Failed | x | x |
Restart Failures | x | x |
Skipped | x | x |
Pending | x | x |
-----------------|-----|---------|-----
Search / Order fields:
applied integer
environment string
eventful Values: true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer2.35.4. hammer host create
Create a host
Usage:
hammer host create [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS IDs of associated ansible roles
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID Required if host is managed and value is not inherited from host group
--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 information about this host
--compute-attributes COMPUTE_ATTRS Compute resource attributes
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID Nil means host is bare metal
--config-group-ids CONFIG_GROUP_IDS IDs of associated config groups
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--config-groups CONFIG_GROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--content-source CONTENT_SOURCE_NAME Content Source name
--content-source-id CONTENT_SOURCE_ID
--content-view CONTENT_VIEW_NAME Name to search by
--content-view-id CONTENT_VIEW_ID
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Required if host is managed and value is not inherited from host group
--enabled ENABLED Include this host within Satellite reporting
One of true/false, yes/no, 1/0.
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS List of hypervisor guest uuids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--image IMAGE_NAME Name to search by
--image-id IMAGE_ID
--installed-products-attributes INSTALLED_PRODUCTS_ATTRIBUTES List of products installed on the host
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--interface INTERFACE Interface parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--ip IP Not required if using a subnet with DHCP Capsule
--kickstart-repository REPOSITORY_NAME Kickstart repository name
--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
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mac MAC Required for managed host that is bare metal, not required if it's a
Virtual machine
--managed MANAGED True/False flag whether a host is managed or unmanaged. Note: this value
Also determines whether several parameters are required or not
One of true/false, yes/no, 1/0.
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID Required if not imaged based provisioning and host is managed and value is
Not inherited from host group
--model MODEL_NAME Model name
--model-id MODEL_ID
--name NAME
--openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID Required if host is managed and value is not inherited from host group
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--overwrite OVERWRITE 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 Replaces with new host parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--product PRODUCT_NAME Name to search by
--product-id PRODUCT_ID Product id as listed from a host's installed products, this is
Not the same product id as the products api returns
--progress-report-id PROGRESS_REPORT_ID UUID to track orchestration tasks status, GET
/api/orchestration/:UUID/tasks
--provision-method PROVISION_METHOD The method used to provision the host.
Possible value(s): 'build', 'image', 'bootdisk'
--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 of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--puppet-proxy PUPPET_PROXY_NAME
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID
--purpose-addons PURPOSE_ADDONS Sets the system add-ons
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--purpose-role PURPOSE_ROLE Sets the system purpose usage
--purpose-usage PURPOSE_USAGE Sets the system purpose usage
--pxe-loader PXE_LOADER DHCP filename option (Grub2/PXELinux by default)
Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
--realm REALM_NAME Name to search by
--realm-id REALM_ID
--release-version RELEASE_VERSION Release version for this Host to use (7Server, 7.1, etc)
--root-password ROOT_PW Required if host is managed and value is not inherited from host group or default password in settings
--service-level SERVICE_LEVEL Service level to be used for autoheal
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Required if host is managed and value is not inherited from host group
--typed-parameters TYPED_PARAMS Replaces with new host parameters (with type support)
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--volume VOLUME Volume parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--typed-parameters "name=<string>\,value=<string>\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\,hidden_value=[true|false|1|0], ... "
--installed-products-attributes "product_id=<string>\,product_name=<string>\,arch=<string>\,version=<string>, ... "
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:
tag VLAN tag, this attribute has precedence over the 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:
NOTE: Bold attributes are required.
EC2:
--volume:
--interface:
--compute-attributes:
availability_zone
flavor_id
groups
security_group_ids
managed_ip
GCE:
--volume:
size_gb Volume size in GB, integer value
--interface:
--compute-attributes:
machine_type
network
associate_external_ip
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
--compute-attributes:
cpus Number of CPUs
memory String, amount of memory, value in bytes
cpu_mode Possible values: default, host-model, host-passthrough
start Boolean (expressed as 0 or 1), whether to start the machine or not
OpenStack:
--volume:
--interface:
--compute-attributes:
availability_zone
boot_from_volume
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
--compute-attributes:
cluster ID or name of cluster to use
template Hardware profile to use
cores Integer value, number of cores
sockets Integer value, number of sockets
memory Amount of memory, integer value in bytes
ha Boolean, set 1 to high availability
display_type Possible values: VNC, SPICE
keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.
start Boolean, set 1 to start the vm
Rackspace:
--volume:
--interface:
--compute-attributes:
flavor_id
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
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 or Network Name from VMware
--compute-attributes:
cluster Cluster ID from VMware
corespersocket Number of cores per socket (applicable to hardware versions < 10 only)
cpus CPU count
memory_mb Integer number, amount of memory in MB
path Path to folder
resource_pool Resource Pool ID from VMware
firmware automatic/bios/efi
guest_id Guest OS ID form VMware
hardware_version Hardware version ID from VMware
memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on
cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on
add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
annotation Annotation Notes
scsi_controllers List with SCSI controllers definitions
type - ID of the controller from VMware
key - Key of the controller (e.g. 1000)
start Must be a 1 or 0, whether to start the machine or not
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)
--compute-attributes:
resource_group Existing Azure Resource Group of user
vm_size VM Size, eg. Standard_A0 etc.
username The Admin username
password The Admin password
platform OS type eg. Linux
ssh_key_data SSH key for passwordless authentication
os_disk_caching OS disk caching
premium_os_disk Premium OS Disk, Boolean as 0 or 1
script_command Custom Script Command
script_uris Comma seperated file URIs2.35.5. hammer host deb-package
Manage deb packages on your hosts
Usage:
hammer host deb-package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
list, index List deb packages installed on the host
Options:
-h, --help Print help2.35.5.1. hammer host deb-package list
List deb packages installed on the host
Usage:
hammer host deb-package <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--order ORDER Sort field and order, eg. 'id DESC'
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Version | x | x |
Arch | x | x |
--------|-----|---------|-----2.35.6. hammer host delete
Delete a host
Usage:
hammer host <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.7. hammer host delete-parameter
Delete parameter for a host
Usage:
hammer host delete-parameter [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID
--name NAME Parameter name
-h, --help Print help2.35.8. hammer host disassociate
Disassociate a host
Usage:
hammer host disassociate [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.9. hammer host enc-dump
Dump host’s ENC YAML
Usage:
hammer host enc-dump [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.10. hammer host errata
Manage errata on your hosts
Usage:
hammer host errata [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
apply Schedule errata for installation
info Retrieve a single errata for a host
list List errata available for the content host
recalculate Force regenerate applicability.
Options:
-h, --help Print help2.35.10.1. hammer host errata apply
Schedule errata for installation
Usage:
hammer host errata apply [OPTIONS]
Options:
--async Do not wait for the task
--errata-ids ERRATA_IDS List of Errata ids to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID Host ID
--ids IDS List of errata ids to perform an action on, (ex: RHSA-2019:1168)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--search SEARCH Search string for erratum to perform an action on
-h, --help Print help2.35.10.2. hammer host errata info
Retrieve a single errata for a host
Usage:
hammer host errata info [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID Host ID
--id ID Errata id of the erratum (RHSA-2012:108)
--name NAME Name to search by
-h, --help Print help
Predefined field sets:
------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------|-----|--------
Title | x | x
Version | x | x
Description | x | x
Status | x | x
ID | x | x
Errata ID | x | x
Reboot Suggested | x | x
Updated | x | x
Issued | x | x
Release | x | x
Solution | x | x
Packages | x | x
Module Streams/Name | x | x
Module Streams/Stream | x | x
Module Streams/Packages | x | x
------------------------|-----|--------2.35.10.3. hammer host errata list
List errata available for the content host
Usage:
hammer host errata list [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Calculate Applicable Errata based on a particular Content View
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID UUID of the content host
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--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
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
------------|-----|--------
FIELDS | ALL | DEFAULT
------------|-----|--------
ID | x | x
Erratum ID | x | x
Type | x | x
Title | x | x
Installable | x | x
------------|-----|--------2.35.10.4. hammer host errata recalculate
Force regenerate applicability.
Usage:
hammer host errata recalculate [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID Host ID
-h, --help Print help2.35.11. hammer host facts
List all fact values
Usage:
hammer host facts [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|--------
FIELDS | ALL | DEFAULT
-------|-----|--------
Fact | x | x
Value | x | x
-------|-----|--------
Search / Order fields:
fact string
fact_short_name string
facts string
host string
host.hostgroup string
host_id integer
location string
location_id integer
name string
organization string
organization_id integer
origin string
reported_at datetime
short_name string
type string
value string2.35.12. hammer host info
Show a host
Usage:
hammer host <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------------------------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------------------------------------|-----|---------|-----
Id | x | x | x
UUID | x | x |
Name | x | x | x
Organization | x | x |
Location | x | x |
Host Group | x | x |
Compute Resource | x | x |
Compute Profile | x | x |
Puppet Environment | x | x |
Puppet CA Proxy | x | x |
Puppet Master Proxy | x | x |
Cert name | x | x |
Managed | x | x |
Installed at | x | x |
Last report | x | x |
Uptime (seconds) | x | x |
Status/Global Status | x | x |
Status/Build Status | x | x |
Network/IPv4 address | x | x |
Network/IPv6 address | x | x |
Network/MAC | x | x |
Network/Subnet ipv4 | x | x |
Network/Subnet ipv6 | x | x |
Network/Domain | x | x |
Network/Service provider/SP Name | x | x |
Network/Service provider/SP IP | x | x |
Network/Service provider/SP MAC | x | x |
Network/Service provider/SP Subnet | x | x |
Network interfaces/Id | x | x |
Network interfaces/Identifier | x | x |
Network interfaces/Type | x | x |
Network interfaces/MAC address | x | x |
Network interfaces/IPv4 address | x | x |
Network interfaces/IPv6 address | x | x |
Network interfaces/FQDN | x | x |
Operating system/Architecture | x | x |
Operating system/Operating System | x | x |
Operating system/Build | x | x |
Operating system/Medium | x | x |
Operating system/Partition Table | x | x |
Operating system/PXE Loader | x | x |
Operating system/Custom partition table | x | x |
Operating system/Image | x | x |
Operating system/Image file | x | x |
Operating system/Use image | x | x |
Parameters/ | x | x |
All parameters/ | x | x |
Additional info/Owner | x | x |
Additional info/Owner Id | x | x |
Additional info/Owner Type | x | x |
Additional info/Enabled | x | x |
Additional info/Model | x | x |
Additional info/Comment | x | x |
OpenSCAP Proxy | x | x |
Content Information/Content View/ID | x | x |
Content Information/Content View/Name | x | x |
Content Information/Lifecycle Environment/ID | x | x |
Content Information/Lifecycle Environment/Name | x | x |
Content Information/Content Source/ID | x | x |
Content Information/Content Source/Name | x | x |
Content Information/Kickstart Repository/ID | x | x |
Content Information/Kickstart Repository/Name | x | x |
Content Information/Applicable Packages | x | x |
Content Information/Upgradable Packages | x | x |
Content Information/Applicable Errata/Enhancement | x | x |
Content Information/Applicable Errata/Bug Fix | x | x |
Content Information/Applicable Errata/Security | x | x |
Subscription Information/UUID | x | x |
Subscription Information/Last Checkin | x | x |
Subscription Information/Release Version | x | x |
Subscription Information/Autoheal | x | x |
Subscription Information/Registered To | x | x |
Subscription Information/Registered At | x | x |
Subscription Information/Registered by Activation Keys/ | x | x |
Subscription Information/System Purpose/Service Level | x | x |
Subscription Information/System Purpose/Purpose Usage | x | x |
Subscription Information/System Purpose/Purpose Role | x | x |
Subscription Information/System Purpose/Purpose Addons | x | x |
Trace Status | x | x |
Host Collections/Id | x | x |
Host Collections/Name | x | x |
--------------------------------------------------------|-----|---------|-----2.35.13. hammer host interface
View and manage host’s network interfaces
Usage:
hammer host interface [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an interface on a host
delete, destroy Delete a host's interface
info, show Show an interface for host
list, index List all interfaces for host
update Update a host's interface
Options:
-h, --help Print help2.35.13.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.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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.
JSON is acceptable and preferred way for complex parameters
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Satellite domain ID of interface. Required for primary interfaces on
Managed hosts.
--execution EXECUTION Should this interface be used for remote execution?
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--identifier IDENTIFIER Device identifier, e.g. eth0 or eth1.1
--ip IP IPv4 address of interface
--ip6 IP6 IPv6 address of interface
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--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?
One of true/false, yes/no, 1/0.
--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'
--mtu MTU MTU, this attribute has precedence over the subnet MTU.
--name NAME Interface's DNS name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--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'
--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
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Satellite subnet ID of IPv4 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
One of true/false, yes/no, 1/0.
-h, --help Print help2.35.13.2. hammer host interface delete
Delete a host’s interface
Usage:
hammer host interface <delete|destroy> [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--id ID ID of interface
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.13.3. hammer host interface info
Show an interface for host
Usage:
hammer host interface <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--id ID ID or name of interface
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
Id | x | x | x
Identifier | x | x |
Type | x | x |
MAC address | x | x |
IP address | x | x |
DNS name | x | x |
Subnet | x | x |
Domain | x | x |
Managed | x | x |
Primary | x | x |
Provision | x | x |
Virtual | x | x |
Tag | x | x |
Attached to | x | x |
BMC/Username | x | x |
BMC/Provider | x | x |
Bond/Mode | x | x |
Bond/Attached devices | x | x |
Bond/Bond options | x | x |
Execution | x | x |
----------------------|-----|---------|-----2.35.13.4. hammer host interface list
List all interfaces for host
Usage:
hammer host interface <list|index> [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID ID or name of domain
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID ID or name of subnet
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Identifier | x | x |
Type | x | x |
MAC address | x | x |
IP address | x | x |
DNS name | x | x |
------------|-----|---------|-----2.35.13.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.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--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.
JSON is acceptable and preferred way for complex parameters
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Satellite domain ID of interface. Required for primary interfaces on
Managed hosts.
--execution EXECUTION Should this interface be used for remote execution?
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--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
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--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?
One of true/false, yes/no, 1/0.
--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'
--mtu MTU MTU, this attribute has precedence over the subnet MTU.
--name NAME Interface's DNS name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--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'
--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
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Satellite subnet ID of IPv4 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
One of true/false, yes/no, 1/0.
-h, --help Print help2.35.14. hammer host list
List all hosts
Usage:
hammer host <list|index> [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID ID of location
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID ID of organization
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
--thin THIN Only list ID and name of hosts
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
-----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating System | x | x |
Host Group | x | x |
IP | x | x |
MAC | x | x |
Global Status | x | x |
Organization | x | |
Location | x | |
Additional Information | x | |
Content View | x | x |
Lifecycle Environment | x | x |
Security | x | |
Bugfix | x | |
Enhancement | x | |
Trace Status | x | x |
-----------------------|-----|---------|-----
Search / Order fields:
activation_key string
activation_key_id string
addon string
addons_status Values: mismatched, matched, not_specified
ansible_role string
applicable_errata string
applicable_errata_issued date
applicable_rpms string
architecture string
autoheal boolean
boot_time
build Values: true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
created_at datetime
domain string
domain_id integer
environment string
errata_status Values: security_needed, errata_needed, updated, unknown
execution_status Values: ok, error
facts string
global_status Values: ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
id integer
image string
insights_recommendations_count integer
installable_errata string
installed_at datetime
ip string
job_invocation.id string
job_invocation.result Values: cancelled, failed, pending, success
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed Values: true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
params_name string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status Values: mismatched, matched, not_specified
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
role text
role_status Values: mismatched, matched, not_specified
service_level string
sla_status Values: mismatched, matched, not_specified
smart_proxy string
status.applied integer
status.enabled Values: true, false
status.failed integer
status.failed_restarts integer
status.interesting Values: true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status Values: valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor
subscription_uuid string
trace_status Values: reboot_needed, process_restart_needed, updated
upgradable_rpms string
usage text
usage_status Values: mismatched, matched, not_specified
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string2.35.15. hammer host package
Manage packages on your hosts
Usage:
hammer host package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
install Install packages remotely
list, index List packages installed on the host
remove Uninstall packages remotely
upgrade Update packages remotely
upgrade-all Update packages remotely
Options:
-h, --help Print help2.35.15.1. hammer host package install
Install packages remotely
Usage:
hammer host package install [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--packages PACKAGES List of package names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.35.15.2. hammer host package list
List packages installed on the host
Usage:
hammer host package <list|index> [OPTIONS]
Options:
--fields FIELDS