Hammer CLI Guide
Using Hammer, the Satellite's CLI tool
Red Hat Satellite Documentation Team
satellite-doc-list@redhat.com
Abstract
Chapter 1. Introduction to Hammer
Hammer is a powerful command-line tool provided with Red Hat Satellite 6. You can use Hammer to configure and manage a Red Hat Satellite Server either through CLI commands or automation in shell scripts. Hammer also provides an interactive shell.
Hammer compared to Satellite web UI
Compared to navigating the web UI, using Hammer can result in much faster interaction with the Satellite Server, as common shell features such as environment variables and aliases are at your disposal. You can also incorporate Hammer commands into reusable scripts for automating tasks of various complexity. Output from Hammer commands can be redirected to other tools, which allows for integration with your existing environment. You can issue Hammer commands directly on the base operating system running Red Hat Satellite.
Access to Satellite Server’s base operating system is required to issue Hammer commands, which can limit the number of potential users compared to the web UI. Although the parity between Hammer and the web UI is almost complete, the web UI has development priority and can be ahead especially for newly introduced features.
Hammer compared to Satellite API
For many tasks, both Hammer and Satellite API are equally applicable. Hammer can be used as a human friendly interface to Satellite API, for example to test responses to API calls before applying them in a script (use the -d
option to inspect API calls issued by Hammer, for example hammer -d organization list
). Changes in the API are automatically reflected in Hammer, while scripts using the API directly have to be updated manually.
In the background, each Hammer command first establishes a binding to the API, then sends a request. This can have performance implications when executing a large number of Hammer commands in sequence. In contrast, a script communicating directly with the API establishes the binding only once. See the API Guide for more information.
1.1. Getting Help
View the full list of hammer
options and subcommands by executing:
$ hammer --help
Use --help
to inspect any subcommand, for example:
$ hammer organization --help
You can search the help output using grep
, or redirect it to a text viewer, for example:
$ hammer | less
1.2. Authentication
A Satellite user must prove their identity to Red Hat Satellite when entering hammer commands. Hammer commands can be run manually or automatically. In either case, hammer requires Satellite credentials for authentication. There are three methods of hammer authentication:
- Hammer authentication session
- Storing credentials in the hammer configuration file
- Providing credentials with each hammer command
The hammer configuration file method is recommended when running commands automatically. For example, running Satellite maintenance commands from a cron job. When running commands manually, the hammer authentication session and providing credentials with each command are recommended.
1.2.1. Hammer Authentication Session
Hammer authentication session is a cache that stores your credentials, and you have to provide them only once, at the beginning of the session. This method is suited to running several hammer commands in succession, for example a script containing hammer commands. In this scenario, you enter your Satellite credentials once, and the script runs as expected. By using the hammer authentication session, you avoid storing your credentials in the script itself and in the ~/.hammer/cli.modules.d/foreman.yml
hammer configuration file.
See the instructions on how to use the sessions:
To enable sessions, add
:use_sessions: true
to the~/.hammer/cli.modules.d/foreman.yml
file::foreman: :use_sessions: true
Note that if you enable sessions, credentials stored in the configuration file will be ignored.
To start a session, enter the following command:
# hammer auth login
You are prompted for your Satellite credentials, and logged in. You will not be prompted for the credentials again until your session expires.
The default length of a session is 60 minutes. You can change the time to suit your preference. For example, to change it to 30 minutes, enter the following command:
# hammer settings set --name idle_timeout --value 30 Setting [idle_timeout] updated to [30]
To see the current status of the session, enter the following command:
# hammer auth status
To end the session, enter the following command:
# hammer auth logout
1.2.2. Hammer Configuration File
If you ran the Satellite installation with --foreman-initial-admin-username
and --foreman-initial-admin-password
options, credentials you entered are stored in the ~/.hammer/cli.modules.d/foreman.yml
configuration file, and hammer does not prompt for your credentials.
You can also add your credentials to the ~/.hammer/cli.modules.d/foreman.yml
configuration file manually:
:foreman: :username: 'username' :password: 'password'
Use only spaces for indentation in hammer configuration files. Do not use tabs for indentation in hammer configuration files.
1.2.3. Command Line
If you do not have your Satellite credentials saved in the ~/.hammer/cli.modules.d/foreman.yml
configuration file, hammer prompts you for them each time you enter a command. You can specify your credentials when executing a command as follows:
$ hammer -u username -p password subcommands
Examples in this guide assume having saved credentials in the configuration file, or using a hammer authentication session.
1.3. Using Standalone Hammer
You can install hammer
on a host that has no Satellite Server Server installed, and use it to connect the host to a remote Satellite.
Prerequisites
- Ensure that you register the host to Satellite Server or Capsule Server. For more information, see Registering a Host in the Provisioning Guide.
Ensure that you synchronize the following repositories on Satellite Server or Capsule Server. For more information, see Synchronizing Red Hat Repositories in the Content Management Guide.
- rhel-7-server-rpms
- rhel-server-rhscl-7-rpms
- rhel-7-server-satellite-tools-6.6-rpms
Procedure
On a host, complete the following steps to install hammer
:
Enable the Red Hat Enterprise Linux, Red Hat Software Collections and Red Hat Satellite Tools repositories:
# subscription-manager repos --enable=rhel-7-server-rpms \ --enable=rhel-server-rhscl-7-rpms \ --enable=rhel-7-server-satellite-tools-6.6-rpms
Install
hammer
:# yum install tfm-rubygem-hammer_cli_katello
Edit the
:host:
entry in the/etc/hammer/cli.modules.d/foreman.yml
file to include the Satellite IP address or FQDN.:host: 'https://satellite.example.com'
1.4. Setting a Default Organization and Location
Many hammer
commands are organization specific. You can set a default organization and location for hammer
commands so that you do not have to specify them every time with the --organization
and --location
options.
Specifying a default organization is useful when you mostly manage a single organization, as it makes your commands shorter. However, when you switch to a different organization, you must use hammer
with the --organization
option to specify it.
Procedure
To set a default organization and location, complete the following steps:
To set a default organization, enter the following command:
# hammer defaults add --param-name organization \ --param-value "Your_Organization"
You can find the name of your organization with the
hammer organization list
command.Optional: To set a default location, enter the following command:
# hammer defaults add --param-name location \ --param-value 'Your_Location"
You can find the name of your location with the
hammer location list
command.To verify the currently specified default settings, enter the following command:
# hammer defaults list
1.5. Configuring Hammer
The default location for global hammer
configuration is:
-
/etc/hammer/cli_config.yml for general
hammer
settings - /etc/hammer/cli.modules.d/ for CLI module configuration files
You can set user specific directives for hammer
(in ~/.hammer/cli_config.yml) as well as for CLI modules (in respective .yml files under ~/.hammer/cli.modules.d/).
To see the order in which configuration files are loaded, as well as versions of loaded modules, issue:
$ hammer -d --version
Loading configuration for many CLI modules can slow down the execution of hammer
commands. In such a case, consider disabling CLI modules that are not regularly used.
Apart from saving credentials as described in Section 1.2, “Authentication”, you can set several other options in the ~/.hammer/ configuration directory. For example, you can change the default log level and set log rotation with the following directives in ~/.hammer/cli_config.yml. Note that these directives affect only the current user and are not applied globally.
:log_level: 'warning' :log_size: 5 #in MB
Similarly, you can configure user interface settings. For example, set the number of entries displayed per request in the Hammer output by changing the following line:
:per_page: 30
This setting is an equivalent of the --per-page
Hammer option.
1.6. Configuring Hammer Logging
You can set hammer
to log debugging information for various Satellite components.
You can set debug or normal configuration options for all Satellite components.
After changing hammer’s logging behavior, you must restart Satellite services.
# satellite-maintain service restart
To set debug level for all components, use the following command:
# hammer admin logging --all --level-debug # satellite-maintain service restart
To set production level logging, use the following command:
# hammer admin logging --all --level-production # satellite-maintain service restart
To list the currently recognized components, that you can set logging for:
# hammer admin logging --list
To list all available logging options:
# hammer admin logging --help Usage: hammer admin logging [OPTIONS]
1.7. Invoking the Hammer Shell
You can issue hammer
commands through the interactive shell. To invoke the shell, issue the following command:
$ hammer shell
In the shell, you can enter subcommands directly without typing "hammer", which can be useful for testing commands before using them in a script. To exit the shell, type exit
or press [Ctrl + D].
1.8. Generating Formatted Output
You can modify the default formatting of the output of hammer
commands to simplify the processing of this output by other command line tools and applications. For example, to list organizations in a CSV format with a custom separator (in this case a semicolon), issue the following command:
$ hammer --csv --csv-separator ";" organization list
Output in CSV format is useful for example when you need to parse IDs and use them in a for loop.
Several other formatting options are available with the --output
option:
$ hammer --output output_format organization list
Replace output_format with one of:
-
table
— generates output in the form of a human readable table (default). -
base
— generates output in the form of key-value pairs. -
yaml
— generates output in the YAML format. -
csv
— generates output in the Comma Separated Values format. To define a custom separator, use the--csv
and--csv-separator
options instead. -
json
— generates output in the JavaScript Object Notation format. -
silent
— suppresses the output.
1.9. Hiding Header Output from Hammer Commands
When you use any hammer command, you have the option of hiding headers from the output. If you want to pipe or use the output in custom scripts, hiding the output is useful.
-
To hide the header output, add the
--no-headers
option to any hammer command.
1.10. Troubleshooting with Hammer
You can use the hammer ping
command to check the status of core Satellite services. Together with the satellite-maintain service status
command, this can help you to diagnose and troubleshoot Satellite issues. If all services are running as expected, the output looks as follows:
$ hammer ping candlepin: Status: ok Server Response: Duration: 22ms candlepin_auth: Status: ok Server Response: Duration: 17ms pulp: Status: ok Server Response: Duration: 41ms pulp_auth: Status: ok Server Response: Duration: 23ms foreman_tasks: Status: ok Server Response: Duration: 33ms
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.6.
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 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-view Manipulate content views 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 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 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 policy Manipulate policies 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 settings Change server settings shell Interactive shell smart-variable Manipulate smart variables subnet Manipulate subnets subscription Manipulate subscriptions sync-plan Manipulate sync plans tailoring-file Manipulate Tailoring files task Tasks related actions. template Manipulate config 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. One of [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 default
2.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 an activation key host-collections List associated host collections info Show an activation key list List activation keys product-content List associated products remove-host-collection Disassociate a resource remove-subscription Remove subscription subscriptions List associated subscriptions update Update an activation key Options: -h, --help Print help
2.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 -h, --help Print help
2.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 ID --organization-label ORGANIZATION_LABEL Organization label to search by --quantity QUANTITY Quantity of this subscription to add --subscription-id SUBSCRIPTION_ID ID of subscription -h, --help Print help
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 ID --organization-label ORGANIZATION_LABEL Organization label to search by --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 help
2.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 ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.2.5. hammer activation-key create
Create an activation key
Usage: hammer activation-key create [OPTIONS] Options: --content-view CONTENT_VIEW_NAME Content view name to search by --content-view-id CONTENT_VIEW_ID Content view numeric identifier --description DESCRIPTION Description --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 ID --organization-label ORGANIZATION_LABEL Organization label to search by --unlimited-hosts Set hosts max to unlimited -h, --help Print help
2.2.6. hammer activation-key delete
Destroy an activation key
Usage: hammer activation-key delete [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 ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.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. --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 ID --organization-label ORGANIZATION_LABEL Organization label to search by --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
2.2.8. hammer activation-key info
Show an activation key
Usage: hammer activation-key info [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 ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.2.9. hammer activation-key list
List activation keys
Usage: hammer activation-key list [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) --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 ID --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
2.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. --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 -h, --help Print help
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 -h, --help Print help
2.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 ID --organization-label ORGANIZATION_LABEL Organization label to search by --subscription-id SUBSCRIPTION_ID ID of subscription -h, --help Print help
2.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 ID of the activation key --available-for AVAILABLE_FOR Object to show subscriptions available for, either 'host' or 'activation_key' --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 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 --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
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 numeric identifier --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 ID --organization-label ORGANIZATION_LABEL Organization label to search by --release-version RELEASE_VERSION Content release version --service-level SERVICE_LEVEL Service level --unlimited-hosts Set hosts max to unlimited -h, --help Print help
2.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 help
2.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 help
2.4.1. hammer ansible roles
Manage ansible roles
Usage: hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete Deletes Ansible role fetch Fetch Ansible roles available to be imported import Import Ansible roles info Show role list List Ansible roles obsolete Obsolete Ansible roles play-hostgroups Plays Ansible roles on hostgroups play-hosts Plays Ansible roles on hosts Options: -h, --help Print help
2.4.1.1. hammer ansible roles delete
Deletes Ansible role
Usage: hammer ansible roles delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.4.1.2. hammer ansible roles fetch
Fetch Ansible roles available to be imported
Usage: hammer ansible roles fetch [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --proxy-id PROXY_ID Capsule to fetch from -h, --help Print help
2.4.1.3. hammer ansible roles import
Import Ansible roles
Usage: hammer ansible roles import [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.4.1.4. hammer ansible roles info
Show role
Usage: hammer ansible roles info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.4.1.5. hammer ansible roles list
List Ansible roles
Usage: hammer ansible roles list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: host string host_id integer hostgroup string hostgroup_id integer id integer name string updated_at datetime
2.4.1.6. hammer ansible roles obsolete
Obsolete Ansible roles
Usage: hammer ansible roles obsolete [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --proxy-id PROXY_ID Capsule to import from -h, --help Print help
2.4.1.7. hammer ansible roles play-hostgroups
Plays 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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.4.1.8. hammer ansible roles play-hosts
Plays 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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.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 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 variable list 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 help
2.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --match MATCH Override match --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --value VALUE Override value, required if omit is false -h, --help Print help
2.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 --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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.4.2.3. hammer ansible variables delete
Deletes Ansible variable
Usage: hammer ansible variables delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --proxy-id PROXY_ID Capsule to import from -h, --help Print help
2.4.2.5. hammer ansible variables info
Show variable
Usage: hammer ansible variables info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.4.2.6. hammer ansible variables list
List Ansible variables
Usage: hammer ansible variables list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 string
2.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --proxy-id PROXY_ID Capsule to import from -h, --help Print help
2.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.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 --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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.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 Delete an architecture info Show an architecture list List all architectures remove-operatingsystem Disassociate an operating system update Update an architecture Options: -h, --help Print help
2.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 help
2.5.2. hammer architecture create
Create an architecture
Usage: hammer architecture create [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.5.3. hammer architecture delete
Delete an architecture
Usage: hammer architecture delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Architecture name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.5.4. hammer architecture info
Show an architecture
Usage: hammer architecture info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Architecture name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.5.5. hammer architecture list
List all architectures
Usage: hammer architecture list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: name string
2.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 help
2.5.7. hammer architecture update
Update an architecture
Usage: hammer architecture update [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.6. hammer arf-report
Manipulate compliance reports
Usage: hammer arf-report [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete Delete an ARF Report download Download bzipped ARF report download-html Download ARF report in HTML info Show an ARF report list List ARF reports Options: -h, --help Print help
2.6.1. hammer arf-report delete
Delete an ARF Report
Usage: hammer arf-report delete [OPTIONS] Options: --id ID --location LOCATION_NAME Name to search by --location-id LOCATION_ID --organization ORGANIZATION_NAME Name to search by --organization-id ORGANIZATION_ID Organization ID -h, --help Print help
2.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 --organization ORGANIZATION_NAME Name to search by --organization-id ORGANIZATION_ID Organization ID --path PATH Path to directory where downloaded file will be saved -h, --help Print help
2.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 --organization ORGANIZATION_NAME Name to search by --organization-id ORGANIZATION_ID Organization ID --path PATH Path to directory where downloaded file will be saved -h, --help Print help
2.6.4. hammer arf-report info
Show an ARF report
Usage: hammer arf-report info [OPTIONS] Options: --id ID --location LOCATION_NAME Name to search by --location-id LOCATION_ID --organization ORGANIZATION_NAME Name to search by --organization-id ORGANIZATION_ID Organization ID -h, --help Print help
2.6.5. hammer arf-report list
List ARF reports
Usage: hammer arf-report list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 string
2.7. hammer audit
Search audit trails.
Usage: hammer audit [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show an audit list List all audits Options: -h, --help Print help
2.7.1. hammer audit info
Show an audit
Usage: hammer audit info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.7.2. hammer audit list
List all audits
Usage: hammer audit list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: action Values: create, update, delete 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 setting string time datetime type Values: role, ptable, provisioning_template, user, filter, subnet, hostgroup, smart_proxy, katello/host/content_facet, katello/host/subscription_facet, remote_execution_feature, usergroup, katello/content_view, katello/kt_environment, realm, job_template, bookmark, lookup_value, model, domain, environment, architecture, image, ansible_role, hostgroup_class, puppetclass, medium, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, setting, smart_class_parameter, smart_variable user string username string
2.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 help
2.8.1. hammer auth login
Set credentials
Usage: hammer auth login [OPTIONS] Options: -h, --help Print help -p, --password PASSWORD Password to access the remote system -u, --username USERNAME Username to access the remote system
2.8.2. hammer auth logout
Wipe your credentials
Usage: hammer auth logout [OPTIONS] Options: -h, --help Print help
2.8.3. hammer auth status
Information about current connections
Usage: hammer auth status [OPTIONS] Options: -h, --help Print help
2.9. hammer auth-source
Manipulate auth sources
Usage: hammer auth-source [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: ldap Manage LDAP auth sources list List all auth sources Options: -h, --help Print help
2.9.1. 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 Delete an LDAP authentication source info Show an LDAP authentication source list List all LDAP authentication sources update Update an LDAP authentication source Options: -h, --help Print help
2.9.1.1. hammer auth-source ldap create
Create an LDAP authentication source
Usage: hammer auth-source ldap create [OPTIONS] Options: --account ACCOUNT --account-password ACCOUNT_PASSWORD Required if onthefly_register is true --attr-firstname ATTR_FIRSTNAME Required if onthefly_register is true --attr-lastname ATTR_LASTNAME Required if onthefly_register is true --attr-login ATTR_LOGIN Required if onthefly_register is true --attr-mail ATTR_MAIL Required if onthefly_register is true --attr-photo ATTR_PHOTO --base-dn BASE_DN --groups-base GROUPS_BASE Groups base DN --host HOST --ldap-filter LDAP_FILTER LDAP filter --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.9.1.2. hammer auth-source ldap delete
Delete an LDAP authentication source
Usage: hammer auth-source ldap delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.9.1.3. hammer auth-source ldap info
Show an LDAP authentication source
Usage: hammer auth-source ldap info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.9.1.4. hammer auth-source ldap list
List all LDAP authentication sources
Usage: hammer auth-source ldap list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: location string location_id integer name string organization string organization_id integer
2.9.1.5. hammer auth-source ldap update
Update an LDAP authentication source
Usage: hammer auth-source ldap update [OPTIONS] Options: --account ACCOUNT --account-password ACCOUNT_PASSWORD Required if onthefly_register is true --attr-firstname ATTR_FIRSTNAME Required if onthefly_register is true --attr-lastname ATTR_LASTNAME Required if onthefly_register is true --attr-login ATTR_LOGIN Required if onthefly_register is true --attr-mail ATTR_MAIL Required if onthefly_register is true --attr-photo ATTR_PHOTO --base-dn BASE_DN --groups-base GROUPS_BASE Groups base DN --host HOST --id ID --ldap-filter LDAP_FILTER LDAP filter --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.9.2. hammer auth-source list
List all auth sources
Usage: hammer auth-source list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help
2.10. 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 help
2.10.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --sudo Use sudo to write to device -h, --help Print help
2.10.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --sudo Use sudo to write to device -h, --help Print help
2.10.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID --sudo Use sudo to write to device -h, --help Print help
2.11. 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 Delete a capsule import-classes Import puppet classes from puppet Capsule info Show a capsule list List all capsules refresh-features Refresh capsule features update Update a capsule Options: -h, --help Print help
2.11.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 help
2.11.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 help
2.11.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: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.11.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 help
2.11.1.4. hammer capsule content info
Get current capsule synchronization status
Usage: hammer capsule content info [OPTIONS] Options: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.11.1.5. hammer capsule content lifecycle-environments
List the lifecycle environments attached to the capsule
Usage: hammer capsule content lifecycle-environments [OPTIONS] Options: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.11.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 help
2.11.1.7. hammer capsule content synchronization-status
Get current capsule synchronization status
Usage: hammer capsule content synchronization-status [OPTIONS] Options: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.11.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 help
2.11.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 Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.11.3. hammer capsule delete
Delete a capsule
Usage: hammer capsule delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.11.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 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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name --puppet-environment-id PUPPET_ENVIRONMENT_ID -h, --help Print help
2.11.5. hammer capsule info
Show a capsule
Usage: hammer capsule info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.11.6. hammer capsule list
List all capsules
Usage: hammer capsule list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: feature string location string location_id integer name string organization string organization_id integer url string
2.11.7. hammer capsule refresh-features
Refresh capsule features
Usage: hammer capsule refresh-features [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.11.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 Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.12. 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 Delete a compute profile info Show a compute profile list List of compute profiles update Update a compute profile values Create update and delete Compute profile values Options: -h, --help Print help
2.12.1. hammer compute-profile create
Create a compute profile
Usage: hammer compute-profile create [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.12.2. hammer compute-profile delete
Delete a compute profile
Usage: hammer compute-profile delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute profile name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.12.3. hammer compute-profile info
Show a compute profile
Usage: hammer compute-profile info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute profile name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.12.4. hammer compute-profile list
List of compute profiles
Usage: hammer compute-profile list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: name string
2.12.5. hammer compute-profile update
Update a compute profile
Usage: hammer compute-profile update [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute profile name --new-name NEW_NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.12.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 help
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help Provider specific options: 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 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 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 from VMware
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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: ec2: --volume: gce: --volume: libvirt: --volume: pool_name One of available storage pools capacity String value, eg. 10G format_type Possible values: raw, qcow2 openstack: --volume: ovirt: --volume: size_gb Volume size in GB, integer value storage_domain ID of storage domain bootable Boolean, only one volume can be bootable rackspace: --volume: vmware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware size_gb Integer number, volume size in GB thin true/false eager_zero true/false mode persistent/independent_persistent/independent_nonpersistent
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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: ec2: --volume: --interface: --compute-attributes: flavor_id image_id availability_zone security_group_ids managed_ip gce: --volume: --interface: --compute-attributes: machine_type image_id network external_ip libvirt: --volume: pool_name One of available storage pools capacity String value, eg. 10G 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-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes start Boolean (expressed as 0 or 1), whether to start the machine or not openstack: --volume: --interface: --compute-attributes: flavor_ref image_ref tenant_id security_groups network ovirt: --volume: size_gb Volume size in GB, integer value storage_domain ID of storage domain bootable Boolean, only one volume can be bootable --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID compute_interface Interface type --compute-attributes: cluster ID of cluster to use template Hardware profile to use cores Integer value, number of cores memory Amount of memory, integer value in bytes rackspace: --volume: --interface: --compute-attributes: flavor_id image_id vmware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware size_gb Integer number, volume size in GB thin true/false eager_zero true/false mode persistent/independent_persistent/independent_nonpersistent --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 from VMware --compute-attributes: cpus CPU count corespersocket Number of cores per socket (applicable to hardware versions < 10 only) memory_mb Integer number, amount of memory in MB firmware automatic/bios/efi cluster Cluster ID from VMware resource_pool Resource Pool ID from VMware path Path to folder guest_id Guest OS ID form VMware scsi_controller_type ID of the controller from VMware hardware_version Hardware version ID from VMware add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine cpuHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on memoryHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on annotation Annotation Notes
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --volume-id VOLUME_ID Volume id -h, --help Print help
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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: ec2: --volume: --interface: --compute-attributes: flavor_id image_id availability_zone security_group_ids managed_ip gce: --volume: --interface: --compute-attributes: machine_type image_id network external_ip libvirt: --volume: pool_name One of available storage pools capacity String value, eg. 10G 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-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes start Boolean (expressed as 0 or 1), whether to start the machine or not openstack: --volume: --interface: --compute-attributes: flavor_ref image_ref tenant_id security_groups network ovirt: --volume: size_gb Volume size in GB, integer value storage_domain ID of storage domain bootable Boolean, only one volume can be bootable --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID compute_interface Interface type --compute-attributes: cluster ID of cluster to use template Hardware profile to use cores Integer value, number of cores memory Amount of memory, integer value in bytes rackspace: --volume: --interface: --compute-attributes: flavor_id image_id vmware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware size_gb Integer number, volume size in GB thin true/false eager_zero true/false mode persistent/independent_persistent/independent_nonpersistent --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 from VMware --compute-attributes: cpus CPU count corespersocket Number of cores per socket (applicable to hardware versions < 10 only) memory_mb Integer number, amount of memory in MB firmware automatic/bios/efi cluster Cluster ID from VMware resource_pool Resource Pool ID from VMware path Path to folder guest_id Guest OS ID form VMware scsi_controller_type ID of the controller from VMware hardware_version Hardware version ID from VMware add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine cpuHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on memoryHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on annotation Annotation Notes
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help Provider specific options: 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 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 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 from VMware
2.12.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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: ec2: --volume: gce: --volume: libvirt: --volume: pool_name One of available storage pools capacity String value, eg. 10G format_type Possible values: raw, qcow2 openstack: --volume: ovirt: --volume: size_gb Volume size in GB, integer value storage_domain ID of storage domain bootable Boolean, only one volume can be bootable rackspace: --volume: vmware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware size_gb Integer number, volume size in GB thin true/false eager_zero true/false mode persistent/independent_persistent/independent_nonpersistent
2.13. 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 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 a compute resource list 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 zones List available zone for a compute resource Options: -h, --help Print help
2.13.1. hammer compute-resource clusters
List available clusters for a compute resource
Usage: hammer compute-resource clusters [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.2. hammer compute-resource create
Create a compute resource
Usage: hammer compute-resource create [OPTIONS] Options: --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 only Possible value(s): 'VNC', 'SPICE' --domain DOMAIN For RHEL OpenStack Platform (v3) only --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 of quota to use --password PASSWORD Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 --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, Rackspace, GCE --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 EC2 only, use 'us-gov-west-1' for GovCloud region --server SERVER For VMware --set-console-password SET_CONSOLE_PASSWORD For Libvirt and VMware only One of true/false, yes/no, 1/0. --tenant TENANT For RHEL OpenStack Platform only --url URL URL for Libvirt, RHEV, RHEL OpenStack Platform and Rackspace --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. --uuid UUID Deprecated, please use datacenter -h, --help Print help
2.13.3. hammer compute-resource delete
Delete a compute resource
Usage: hammer compute-resource delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.4. hammer compute-resource flavors
List available flavors for a compute resource
Usage: hammer compute-resource flavors [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.5. hammer compute-resource folders
List available folders for a compute resource
Usage: hammer compute-resource folders [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.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 Delete an image info Show an image list List all images for a compute resource update Update an image Options: -h, --help Print help
2.13.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 --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.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 --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.13.6.3. hammer compute-resource image delete
Delete an image
Usage: hammer compute-resource image delete [OPTIONS] Options: --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.6.4. hammer compute-resource image info
Show an image
Usage: hammer compute-resource image info [OPTIONS] Options: --architecture ARCHITECTURE_NAME Architecture name --architecture-id ARCHITECTURE_ID --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.6.5. hammer compute-resource image list
List all images for a compute resource
Usage: hammer compute-resource image list [OPTIONS] Options: --architecture ARCHITECTURE_NAME Architecture name --architecture-id ARCHITECTURE_ID --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: architecture integer compute_resource string name string operatingsystem integer user_data Values: true, false username string
2.13.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 --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --new-name NEW_NAME --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.13.7. hammer compute-resource images
List available images for a compute resource
Usage: hammer compute-resource images [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.8. hammer compute-resource info
Show a compute resource
Usage: hammer compute-resource info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.9. hammer compute-resource list
List all compute resources
Usage: hammer compute-resource list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: id integer location string location_id integer name string organization string organization_id integer type string
2.13.10. hammer compute-resource networks
List available networks for a compute resource
Usage: hammer compute-resource networks [OPTIONS] Options: --cluster-id CLUSTER_ID --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.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 --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.12. hammer compute-resource security-groups
List available security groups for a compute resource
Usage: hammer compute-resource security-groups [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.13.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 --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --storage-domain STORAGE_DOMAIN -h, --help Print help
2.13.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 --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --storage-pod STORAGE_POD -h, --help Print help
2.13.15. hammer compute-resource update
Update a compute resource
Usage: hammer compute-resource update [OPTIONS] Options: --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 only Possible value(s): 'VNC', 'SPICE' --domain DOMAIN For RHEL OpenStack Platform (v3) only --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 of quota to use --password PASSWORD Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 --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, Rackspace, GCE --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 EC2 only, use 'us-gov-west-1' for GovCloud region --server SERVER For VMware --set-console-password SET_CONSOLE_PASSWORD For Libvirt and VMware only One of true/false, yes/no, 1/0. --tenant TENANT For RHEL OpenStack Platform only --url URL URL for Libvirt, RHEV, RHEL OpenStack Platform and Rackspace --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. --uuid UUID Deprecated, please use datacenter -h, --help Print help
2.13.16. hammer compute-resource zones
List available zone for a compute resource
Usage: hammer compute-resource zones [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Compute resource name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.14. 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 Delete a config group info Show a config group list List of config groups update Update a config group Options: -h, --help Print help
2.14.1. hammer config-group create
Create a config group
Usage: hammer config-group create [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.14.2. hammer config-group delete
Delete a config group
Usage: hammer config-group delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.14.3. hammer config-group info
Show a config group
Usage: hammer config-group info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.14.4. hammer config-group list
List of config groups
Usage: hammer config-group list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: class string name string
2.14.5. hammer config-group update
Update a config group
Usage: hammer config-group update [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --new-name NEW_NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.15. hammer config-report
Browse and read reports
Usage: hammer config-report [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete Delete a report info Show a report list List all reports Options: -h, --help Print help
2.15.1. hammer config-report delete
Delete a report
Usage: hammer config-report delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.15.2. hammer config-report info
Show a report
Usage: hammer config-report info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.15.3. hammer config-report list
List all reports
Usage: hammer config-report list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 integer
2.16. 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 a content view list List content views publish Publish a content view puppet-module View and manage puppet modules purge Delete old versions of a content view remove Remove versions and/or environments from a content view and reassign systems and keys remove-from-environment Remove a content view from an environment remove-repository Disassociate a resource remove-version Remove a content view version from a composite view update Update a content view version View and manage content view versions Options: -h, --help Print help
2.16.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 help
2.16.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 --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 help
2.16.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 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 help
2.16.3.1. hammer content-view component add
Add components to the content view
Usage: hammer content-view component add [OPTIONS] Options: --component-content-view COMPONENT_CONTENT_VIEW_NAME Content View name of the component who's latest version is desired --component-content-view-id COMPONENT_CONTENT_VIEW_ID Content View identifier of the component who's latest version is desired --component-content-view-version COMPONENT_CONTENT_VIEW_VERSION_VERSION Content View Version number of the component. Either use this or --component-content-view-version-id option --component-content-view-version-id COMPONENT_CONTENT_VIEW_VERSION_ID Content View Version identifier of the component --composite-content-view COMPOSITE_CONTENT_VIEW_NAME Name of the composite content view --composite-content-view-id COMPOSITE_CONTENT_VIEW_ID Composite content view identifier --latest Select the latest version of the components content view is desired --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID to search by --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.16.3.2. hammer content-view component list
List components attached to this content view
Usage: hammer content-view component list [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 --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
2.16.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 help
2.16.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 help
2.16.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 help
2.16.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 ID --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 help
2.16.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 help
2.16.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 Delete a filter info Show filter info list List filters remove-repository Disassociate a resource rule View and manage filter rules update Update a filter Options: -h, --help Print help
2.16.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 help
2.16.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 numeric 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-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) -h, --help Print help
2.16.7.3. hammer content-view filter delete
delete a filter
Usage: hammer content-view filter delete [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 -h, --help Print help
2.16.7.4. hammer content-view filter info
show filter info
Usage: hammer content-view filter info [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 -h, --help Print help
2.16.7.5. hammer content-view filter list
list filters
Usage: hammer content-view filter list [OPTIONS] Options: --content-view CONTENT_VIEW_NAME Content view name to search by --content-view-id CONTENT_VIEW_ID Content view numeric identifier --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
2.16.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 help
2.16.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 Delete a filter rule info Show filter rule info list List filter rules update Update a filter rule. The parameters included should be based upon the filter type. Options: -h, --help Print help
2.16.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 Content view numeric identifier --date-type DATE_TYPE Erratum: search using the 'Issued On' or 'Updated On' Column of the errata. Values are 'issued'/'updated' --end-date END_DATE Erratum: end date (YYYY-MM-DD) --errata-id ERRATA_ID Erratum: id --errata-ids ERRATA_IDS Erratum: IDs or a select all object Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --max-version MAX_VERSION Package: maximum version --min-version MIN_VERSION Package: minimum version --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 help
2.16.7.7.2. hammer content-view filter rule delete
Delete a filter rule
Usage: hammer content-view filter rule delete [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 Content view numeric identifier --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
2.16.7.7.3. hammer content-view filter rule info
Show filter rule info
Usage: hammer content-view filter rule info [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 Content view numeric identifier --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
2.16.7.7.4. hammer content-view filter rule list
List filter rules
Usage: hammer content-view filter rule list [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 Content view numeric identifier --errata-id ERRATA_ID Errata_id of the content view filter rule --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
2.16.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 Content view numeric identifier --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 help
2.16.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 numeric identifier --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-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 help
2.16.8. hammer content-view info
Show a content view
Usage: hammer content-view info [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 -h, --help Print help
2.16.9. hammer content-view list
List content views
Usage: hammer content-view list [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) --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 ID --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 --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
2.16.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): --repos-units "label=string\,rpm_filenames=array, ... "
2.16.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 List content view puppet modules remove Remove a puppet module from the content view Options: -h, --help Print help
2.16.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 numeric 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 help
2.16.11.2. hammer content-view puppet-module list
List content view puppet modules
Usage: hammer content-view puppet-module list [OPTIONS] Options: --author AUTHOR Author of the puppet module --content-view CONTENT_VIEW_NAME Content view name to search by --content-view-id CONTENT_VIEW_ID Content view numeric identifier --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
2.16.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 numeric 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 help
2.16.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 help Unfortunately the server does not support such operation.
2.16.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 help
2.16.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 help
2.16.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 help
2.16.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 help
2.16.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 help
2.16.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-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 content view version list List content view versions promote Promote a content view version republish-repositories Forces a republish of the version's repositories' metadata Options: -h, --help Print help
2.16.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 --version VERSION Content view version number -h, --help Print help
2.16.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 help
2.16.18.3. 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 --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 --since SINCE Optional date of last export (ex: 2010-01-01T12:00:00Z) --version VERSION Content view version number -h, --help Print help
2.16.18.4. 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 help
2.16.18.5. 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 identifier --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 help
2.16.18.6. hammer content-view version info
Show content view version
Usage: hammer content-view version info [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) --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 --version VERSION Content view version number -h, --help Print help
2.16.18.7. hammer content-view version list
List content view versions
Usage: hammer content-view version list [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 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) --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 ID --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 --puppet-module PUPPET_MODULE_NAME Name to search by --puppet-module-id PUPPET_MODULE_ID A puppet module identifier --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
2.16.18.8. 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 --environment-ids ENVIRONMENT_IDS Identifiers for Lifecycle Environment (--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 --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 --lifecycle-environment-ids LIFECYCLE_ENVIRONMENT_IDS Identifiers for Lifecycle Environment 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 --organization-label ORGANIZATION_LABEL Organization label to search by --to-lifecycle-environment TO_ENVIRONMENT Name of the target environment --to-lifecycle-environment-id TO_ENVIRONMENT_ID Id of the target environment --version VERSION Content view version number -h, --help Print help
2.16.18.9. 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 --version VERSION Content view version number -h, --help Print help
2.17. 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 help
2.17.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 help
2.17.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 help
2.17.3. hammer defaults list
List all the default parameters
Usage: hammer defaults list [OPTIONS] Options: -h, --help Print help
2.17.4. hammer defaults providers
List all the providers
Usage: hammer defaults providers [OPTIONS] Options: -h, --help Print help
2.18. 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 Delete a discovered host facts List all fact values info Show a discovered host list List all discovered hosts provision Provision a discovered host reboot Reboot a host refresh-facts Refresh the facts of a host Options: -h, --help Print help
2.18.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.18.2. hammer discovery delete
Delete a discovered host
Usage: hammer discovery delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.18.3. hammer discovery facts
List all fact values
Usage: hammer discovery facts [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 string
2.18.4. hammer discovery info
Show a discovered host
Usage: hammer discovery info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.18.5. hammer discovery list
List all discovered hosts
Usage: hammer discovery list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort results --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help
2.18.6. hammer discovery provision
Provision a discovered host
Usage: hammer discovery provision [OPTIONS] Options: --architecture ARCHITECTURE_NAME Architecture name --architecture-id ARCHITECTURE_ID --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 Numerical ID or domain name --enabled ENABLED One of true/false, yes/no, 1/0. --host-parameters-attributes HOST_PARAMETERS_ATTRIBUTES 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 --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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 --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 --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --overwrite OVERWRITE One of true/false, yes/no, 1/0. --owner-id OWNER_ID --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', 'iPXE Embedded', '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 -h, --help Print help
2.18.7. hammer discovery reboot
Reboot a host
Usage: hammer discovery reboot [OPTIONS] Options: --all Reboot all discovered hosts --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.18.8. hammer discovery refresh-facts
Refresh the facts of a host
Usage: hammer discovery refresh-facts [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.19. 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 Delete a rule info Show a discovery rule list List all discovery rules update Update a rule Options: -h, --help Print help
2.19.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 --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 Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.19.2. hammer discovery-rule delete
Delete a rule
Usage: hammer discovery-rule delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.19.3. hammer discovery-rule info
Show a discovery rule
Usage: hammer discovery-rule info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.19.4. hammer discovery-rule list
List all discovery rules
Usage: hammer discovery-rule list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort results --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help
2.19.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 --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 Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.20. 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 help
2.20.1. hammer docker manifest
Manage docker manifests
Usage: hammer docker manifest [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show a docker manifest list List docker_manifests Options: -h, --help Print help
2.20.1.1. hammer docker manifest info
Show a docker manifest
Usage: hammer docker manifest info [OPTIONS] Options: --id ID A docker manifest identifier --name NAME Name to search by --repository REPOSITORY_NAME Repository name to search by --repository-id REPOSITORY_ID Repository ID -h, --help Print help
2.20.1.2. hammer docker manifest list
List docker_manifests
Usage: hammer docker manifest list [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 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) --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 ID --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 --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 --search SEARCH Search string -h, --help Print help
2.20.2. hammer docker tag
Manage docker tags
Usage: hammer docker tag [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show a docker tag list List docker_tags Options: -h, --help Print help
2.20.2.1. hammer docker tag info
Show a docker tag
Usage: hammer docker tag info [OPTIONS] Options: --id ID A docker tag identifier --name NAME Name to search by --repository REPOSITORY_NAME Repository name to search by --repository-id REPOSITORY_ID Repository ID -h, --help Print help
2.20.2.2. hammer docker tag list
List docker_tags
Usage: hammer docker tag list [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 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) --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 ID --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 --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 --search SEARCH Search string -h, --help Print help
2.21. hammer domain
Manipulate domains
Usage: hammer domain [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a domain delete Delete a domain delete-parameter Delete parameter for a domain info Show a domain list List of domains set-parameter Create or update parameter for a domain update Update a domain Options: -h, --help Print help
2.21.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 Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.21.2. hammer domain delete
Delete a domain
Usage: hammer domain delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Domain name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.21.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 help
2.21.4. hammer domain info
Show a domain
Usage: hammer domain info [OPTIONS] Options: --id ID Numerical ID or domain name --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Domain name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values One of true/false, yes/no, 1/0. -h, --help Print help
2.21.5. hammer domain list
List of domains
Usage: hammer domain list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID -h, --help Print help Search / Order fields: fullname string location string location_id integer name string organization string organization_id integer params text
2.21.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 help
2.21.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 Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.22. hammer environment
Manipulate environments
Usage: hammer environment [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create an environment delete Delete an environment info Show an environment list List all environments sc-params List all smart class parameters update Update an environment Options: -h, --help Print help
2.22.1. hammer environment create
Create an environment
Usage: hammer environment create [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.22.2. hammer environment delete
Delete an environment
Usage: hammer environment delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Puppet environment name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.22.3. hammer environment info
Show an environment
Usage: hammer environment info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Puppet environment name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.22.4. hammer environment list
List all environments
Usage: hammer environment list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --puppet-class PUPPET_CLASS_NAME Puppet class name --puppet-class-id PUPPET_CLASS_ID ID of Puppet class --search SEARCH Filter results -h, --help Print help Search / Order fields: content_view string lifecycle_environment string location string location_id integer name string organization string organization_id integer
2.22.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 instead) --environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment-id instead) --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --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 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 string
2.22.6. hammer environment update
Update an environment
Usage: hammer environment update [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.23. hammer erratum
Manipulate errata
Usage: hammer erratum [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show an erratum list List errata Options: -h, --help Print help
2.23.1. hammer erratum info
Show an erratum
Usage: hammer erratum info [OPTIONS] Options: --id ID An erratum identifier --name NAME Name to search by --repository REPOSITORY_NAME Repository name to search by --repository-id REPOSITORY_ID Repository ID -h, --help Print help
2.23.2. hammer erratum list
List errata
Usage: hammer erratum list [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 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 --environment ENVIRONMENT_NAME Lifecycle environment name to search by --environment-id ENVIRONMENT_ID --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. --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 --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 --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 ID --search SEARCH Search string -h, --help Print help
2.24. 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. --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 Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.25. hammer fact
Search facts
Usage: hammer fact [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: list List all fact values Options: -h, --help Print help
2.25.1. hammer fact list
List all fact values
Usage: hammer fact list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 string
2.26. hammer file
Manipulate files
Usage: hammer file [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show a file list List files Options: -h, --help Print help
2.26.1. hammer file info
Show a file
Usage: hammer file info [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 --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 ID --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 help
2.26.2. hammer file list
List files
Usage: hammer file list [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 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-id ENVIRONMENT_ID --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 --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 --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 ID --search SEARCH Search string -h, --help Print help
2.27. 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 Delete a filter info Show a filter list List all filters update Update a filter Options: -h, --help Print help
2.27.1. hammer filter available-permissions
List all permissions
Usage: hammer filter available-permissions [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --resource-type RESOURCE_TYPE --search SEARCH Filter results -h, --help Print help Search / Order fields: name string resource_type string
2.27.2. hammer filter available-resources
List available resource types
Usage: hammer filter available-resources [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.27.3. hammer filter create
Create a filter
Usage: hammer filter create [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 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. Overriding organizations and locations:
2.27.4. hammer filter delete
Delete a filter
Usage: hammer filter delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.27.5. hammer filter info
Show a filter
Usage: hammer filter info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.27.6. hammer filter list
List all filters
Usage: hammer filter list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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, false
2.27.7. hammer filter update
Update a filter
Usage: hammer filter update [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 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. Overriding organizations and locations:
2.28. 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 Delete a foreign input set info Show foreign input set details list List foreign input sets update Update a foreign input set Options: -h, --help Print help
2.28.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --target-template-id TARGET_TEMPLATE_ID Target template ID --template-id TEMPLATE_ID -h, --help Print help
2.28.2. hammer foreign-input-set delete
Delete a foreign input set
Usage: hammer foreign-input-set delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --template-id TEMPLATE_ID -h, --help Print help
2.28.3. hammer foreign-input-set info
Show foreign input set details
Usage: hammer foreign-input-set info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --template-id TEMPLATE_ID -h, --help Print help
2.28.4. hammer foreign-input-set list
List foreign input sets
Usage: hammer foreign-input-set list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results --template-id TEMPLATE_ID -h, --help Print help
2.28.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --new-name NEW_NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --target-template-id TARGET_TEMPLATE_ID Target template ID --template-id TEMPLATE_ID -h, --help Print help
2.29. hammer full-help
Print help for all hammer commands
Usage: hammer full-help [OPTIONS] Options: --md Format output in markdown -h, --help Print help
2.30. hammer global-parameter
Manipulate global parameters
Usage: hammer global-parameter [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete Delete a global parameter list List all global parameters set Set a global parameter Options: -h, --help Print help
2.30.1. hammer global-parameter delete
Delete a global parameter
Usage: hammer global-parameter delete [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Common parameter name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.30.2. hammer global-parameter list
List all global parameters
Usage: hammer global-parameter list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results --show-hidden SHOW_HIDDEN Display hidden values One of true/false, yes/no, 1/0. -h, --help Print help 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 text
2.30.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 help
2.31. 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 a gpg key info Show a gpg key list List gpg keys update Update a repository Options: -h, --help Print help
2.31.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 ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.31.2. hammer gpg delete
Destroy a gpg key
Usage: hammer gpg delete [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 ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.31.3. hammer gpg info
Show a gpg key
Usage: hammer gpg info [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 ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.31.4. hammer gpg list
List gpg keys
Usage: hammer gpg list [OPTIONS] Options: --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 ID --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
2.31.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 ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.32. 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 delete 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 a host interface View and manage host's network interfaces list List all hosts package Manage packages on your hosts package-group Manage package-groups on your hosts puppet-classes List all Puppet classes 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 smart-variables List all smart variables start Power a host on status Get configuration status of host stop Power a host off subscription Manage subscription information on your hosts update Update a host Options: -h, --help Print help
2.32.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 List all Ansible roles for a host play Plays Ansible roles on a host Options: -h, --help Print help
2.32.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.1.2. hammer host ansible-roles list
List all Ansible roles for a host
Usage: hammer host ansible-roles list [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.1.3. hammer host ansible-roles play
Plays Ansible roles on a host
Usage: hammer host ansible-roles play [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.3. hammer host config-reports
List all reports
Usage: hammer host config-reports [OPTIONS] Options: --id ID Host id --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 integer
2.32.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 --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 --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 Content view numeric identifier --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --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 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 ID of the environment --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 --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 --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 numeric identifier --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', 'iPXE Embedded', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --realm REALM_NAME Name to search by --realm-id REALM_ID Numerical ID or realm name --release-version RELEASE_VERSION Release version for this Host to use (7Server, 7.1, etc) --root-password ROOT_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 --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): --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: ec2: --volume: --interface: --compute-attributes: flavor_id image_id availability_zone security_group_ids managed_ip gce: --volume: --interface: --compute-attributes: machine_type image_id network external_ip libvirt: --volume: pool_name One of available storage pools capacity String value, eg. 10G 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 start Boolean (expressed as 0 or 1), whether to start the machine or not --compute-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes start Boolean (expressed as 0 or 1), whether to start the machine or not openstack: --volume: --interface: --compute-attributes: flavor_ref image_ref tenant_id security_groups network ovirt: --volume: size_gb Volume size in GB, integer value storage_domain ID of storage domain bootable Boolean, only one volume can be bootable --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID compute_interface Interface type start Boolean (expressed as 0 or 1), whether to start the machine or not --compute-attributes: cluster ID of cluster to use template Hardware profile to use cores Integer value, number of cores memory Amount of memory, integer value in bytes rackspace: --volume: --interface: --compute-attributes: flavor_id image_id vmware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware size_gb Integer number, volume size in GB thin true/false eager_zero true/false mode persistent/independent_persistent/independent_nonpersistent --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 from VMware start Must be a 1 or 0, whether to start the machine or not --compute-attributes: cpus CPU count corespersocket Number of cores per socket (applicable to hardware versions < 10 only) memory_mb Integer number, amount of memory in MB firmware automatic/bios/efi cluster Cluster ID from VMware resource_pool Resource Pool ID from VMware path Path to folder guest_id Guest OS ID form VMware scsi_controller_type ID of the controller from VMware hardware_version Hardware version ID from VMware add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine cpuHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on memoryHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on annotation Annotation Notes
2.32.5. hammer host delete
Delete a host
Usage: hammer host delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.6. 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 help
2.32.7. hammer host disassociate
Disassociate a host
Usage: hammer host disassociate [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.8. hammer host enc-dump
Dump host’s ENC YAML
Usage: hammer host enc-dump [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.9. 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 help Unfortunately the server does not support such operation.
2.32.9.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 --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 help
2.32.9.2. hammer host errata info
Retrieve a single errata for a host
Usage: hammer host errata info [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --id ID Errata id of the erratum (RHSA-2012:108) --name NAME Name to search by -h, --help Print help
2.32.9.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 Content view numeric identifier --environment ENVIRONMENT_NAME Lifecycle environment name to search by --environment-id ENVIRONMENT_ID --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 --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
2.32.9.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 -h, --help Print help
2.32.10. hammer host facts
List all fact values
Usage: hammer host facts [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 string
2.32.11. hammer host info
Show a host
Usage: hammer host info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values One of true/false, yes/no, 1/0. -h, --help Print help
2.32.12. 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 Delete a host's interface info Show an interface for host list List all interfaces for host update Update a host's interface Options: -h, --help Print help
2.32.12.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 Numerical ID or domain name --host HOST_NAME Host name --host-id HOST_ID --identifier IDENTIFIER Device identifier, e.g. eth0 or eth1.1 --ip IP IPv4 address of interface --ip6 IP6 IPv6 address of interface --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 --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 help
2.32.12.2. hammer host interface delete
Delete a host’s interface
Usage: hammer host interface delete [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --id ID ID of interface --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.12.3. hammer host interface info
Show an interface for host
Usage: hammer host interface info [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --id ID ID or name of interface --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.12.4. hammer host interface list
List all interfaces for host
Usage: hammer host interface list [OPTIONS] Options: --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --host HOST_NAME Host name --host-id HOST_ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID -h, --help Print help
2.32.12.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 Numerical ID or domain name --host HOST_NAME Host name --host-id HOST_ID --id ID ID of interface --identifier IDENTIFIER Device identifier, e.g. eth0 or eth1.1 --ip IP IPv4 address of interface --ip6 IP6 IPv6 address of interface --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 --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 help
2.32.13. hammer host list
List all hosts
Usage: hammer host list [OPTIONS] Options: --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment 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 --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --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 Search / Order fields: activation_key string activation_key_id string addon text addons_status Values: mismatched, matched, not_specified ansible_role string applicable_errata string applicable_rpms string architecture string autoheal boolean 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 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 Values: true, false hypervisor_host string image string 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, 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 string
2.32.14. 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 List packages installed on the host remove Uninstall packages remotely upgrade Update packages remotely upgrade-all Update packages remotely Options: -h, --help Print help Unfortunately the server does not support such operation.
2.32.14.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 --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 help
2.32.14.2. hammer host package list
List packages installed on the host
Usage: hammer host package list [OPTIONS] Options: --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 --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
2.32.14.3. hammer host package remove
Uninstall packages remotely
Usage: hammer host package remove [OPTIONS] Options: --async Do not wait for the task --host HOST_NAME Host name --host-id HOST_ID --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 help
2.32.14.4. hammer host package upgrade
Update packages remotely
Usage: hammer host package upgrade [OPTIONS] Options: --async Do not wait for the task --host HOST_NAME Host name --host-id HOST_ID --packages PACKAGES List of packages 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 help
2.32.14.5. hammer host package upgrade-all
Update packages remotely
Usage: hammer host package upgrade-all [OPTIONS] Options: --async Do not wait for the task --host HOST_NAME Host name --host-id HOST_ID -h, --help Print help
2.32.15. hammer host package-group
Manage package-groups on your hosts
Usage: hammer host package-group [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install packages remotely remove Uninstall packages remotely Options: -h, --help Print help Unfortunately the server does not support such operation.
2.32.15.1. hammer host package-group install
Install packages remotely
Usage: hammer host package-group install [OPTIONS] Options: --async Do not wait for the task --groups GROUPS List of package 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 --host HOST_NAME Host name --host-id HOST_ID -h, --help Print help
2.32.15.2. hammer host package-group remove
Uninstall packages remotely
Usage: hammer host package-group remove [OPTIONS] Options: --async Do not wait for the task --groups GROUPS List of package 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 --host HOST_NAME Host name --host-id HOST_ID -h, --help Print help
2.32.16. hammer host puppet-classes
List all Puppet classes
Usage: hammer host puppet-classes [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --location-id LOCATION_ID Scope by locations --order ORDER Sort field and order, eg. ‘id DESC’ --organization-id ORGANIZATION_ID Scope by organizations --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: config_group string environment string host string hostgroup string key string location string name string organization string
2.32.17. hammer host puppetrun
Force a Puppet agent run on the host
Usage: hammer host puppetrun [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.18. hammer host reboot
Reboot a host
Usage: hammer host reboot [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.19. hammer host rebuild-config
Rebuild orchestration related configurations for host
Usage: hammer host rebuild-config [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --only ONLY Limit rebuild steps, valid steps are DHCP, DNS, TFTP 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 --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.20. hammer host reports
List all reports
Usage: hammer host reports [OPTIONS] Options: --id ID Host id --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help 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 integer
2.32.21. hammer host reset
Reset a host
Usage: hammer host reset [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.22. hammer host sc-params
List all smart class parameters
Usage: hammer host sc-params [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results --show-hidden SHOW_HIDDEN Display hidden values One of true/false, yes/no, 1/0. -h, --help Print help 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 string
2.32.23. hammer host set-parameter
Create or append a parameter for a host
Usage: hammer host set-parameter [OPTIONS] Options: --hidden-value HIDDEN_VALUE Should the value be hidden One of true/false, yes/no, 1/0. --host HOST_NAME Host name --host-id HOST_ID --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 help
2.32.24. hammer host smart-variables
List all smart variables
Usage: hammer host smart-variables [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results --show-hidden SHOW_HIDDEN Display hidden values One of true/false, yes/no, 1/0. -h, --help Print help Search / Order fields: avoid_duplicates Values: true, false key string merge_default Values: true, false merge_overrides Values: true, false override Values: true, false parameter string puppetclass string
2.32.25. hammer host start
Power a host on
Usage: hammer host start [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.26. hammer host status
Get configuration status of host
Usage: hammer host status [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.27. hammer host stop
Power a host off
Usage: hammer host stop [OPTIONS] Options: --force Force turning off a host --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Host name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.32.28. hammer host subscription
Manage subscription information on your hosts
Usage: hammer host subscription [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: attach Add a subscription to a host auto-attach Trigger an auto-attach of subscriptions content-override Override product content defaults product-content List associated products register Register a host with subscription and information remove unregister Unregister the host as a subscription consumer Options: -h, --help Print help Unfortunately the server does not support such operation.
2.32.28.1. hammer host subscription attach
Add a subscription to a host
Usage: hammer host subscription attach [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --quantity Quantity Quantity of this subscriptions to add. Defaults to 1 --subscription-id SUBSCRIPTION_ID ID of subscription -h, --help Print help
2.32.28.2. hammer host subscription auto-attach
Trigger an auto-attach of subscriptions
Usage: hammer host subscription auto-attach [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID -h, --help Print help
2.32.28.3. hammer host subscription content-override
Override product content defaults
Usage: hammer host subscription content-override [OPTIONS] Options: --content-label CONTENT_LABEL Label of the content --host HOST_NAME Host name --host-id HOST_ID --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 help
2.32.28.4. hammer host subscription product-content
List associated products
Usage: hammer host subscription product-content [OPTIONS] Options: --content-access-mode-all CONTENT_ACCESS_MODE_ALL Get all content available, not just that provided by subscriptions One of true/false, yes/no, 1/0. --content-access-mode-env CONTENT_ACCESS_MODE_ENV Limit content to just that available in the host's content view version One of true/false, yes/no, 1/0. --host HOST_NAME Host name --host-id HOST_ID -h, --help Print help
2.32.28.5. hammer host subscription register
Register a host with subscription and information
Usage: hammer host subscription register [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) --hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS UUIDs of the virtual guests from the host's hypervisor 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 ID of the environment --name NAME Name of the host --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 --release-version RELEASE_VERSION Release version of the content host --service-level SERVICE_LEVEL A service level for auto-healing process, e.g. SELF-SUPPORT --uuid UUID UUID to use for registered host, random uuid is generated if not provided -h, --help Print help
2.32.28.6. hammer host subscription remove
Usage: hammer host subscription remove [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID --quantity Quantity Remove the first instance of a subscription with matching id and quantity --subscription-id SUBSCRIPTION_ID ID of subscription -h, --help Print help
2.32.28.7. hammer host subscription unregister
Unregister the host as a subscription consumer
Usage: hammer host subscription unregister [OPTIONS] Options: --host HOST_NAME Host name --host-id HOST_ID -h, --help Print help
2.32.29. hammer host update
Update a host
Usage: hammer host update [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 --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 --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 Content view numeric identifier --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --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 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 --id ID --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 ID of the environment --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 --model MODEL_NAME Model name --model-id MODEL_ID --name NAME Host name --new-location NEW_LOCATION_NAME Location name --new-location-id NEW_LOCATION_ID --new-location-title NEW_LOCATION_TITLE Location title --new-name NEW_NAME --new-organization NEW_ORGANIZATION_NAME Organization name --new-organization-id NEW_ORGANIZATION_ID Organization ID --new-organization-title NEW_ORGANIZATION_TITLE Organization title --openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --overwrite OVERWRITE One of true/false, yes/no, 1/0. --owner OWNER_LOGIN Login of the owner --owner-id OWNER_ID ID of the owner --owner-type OWNER_TYPE Host's owner type Possible value(s): 'User', 'Usergroup' --parameters PARAMS 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 numeric identifier --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', 'iPXE Embedded', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --realm REALM_NAME Name to search by --realm-id REALM_ID Numerical ID or realm name --release-version RELEASE_VERSION Release version for this Host to use (7Server, 7.1, etc) --root-password ROOT_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 --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): --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: ec2: --volume: --interface: --compute-attributes: flavor_id image_id availability_zone security_group_ids managed_ip gce: --volume: --interface: --compute-attributes: machine_type image_id network external_ip libvirt: --volume: pool_name One of available storage pools capacity String value, eg. 10G 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 start Boolean (expressed as 0 or 1), whether to start the machine or not --compute-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes start Boolean (expressed as 0 or 1), whether to start the machine or not openstack: --volume: --interface: --compute-attributes: flavor_ref image_ref tenant_id security_groups network ovirt: --volume: size_gb Volume size in GB, integer value storage_domain ID of storage domain bootable Boolean, only one volume can be bootable --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID compute_interface Interface type start Boolean (expressed as 0 or 1), whether to start the machine or not --compute-attributes: cluster ID of cluster to use template Hardware profile to use cores Integer value, number of cores memory Amount of memory, integer value in bytes rackspace: --volume: --interface: --compute-attributes: flavor_id image_id vmware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware size_gb Integer number, volume size in GB thin true/false eager_zero true/false mode persistent/independent_persistent/independent_nonpersistent --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 from VMware start Must be a 1 or 0, whether to start the machine or not --compute-attributes: cpus CPU count corespersocket Number of cores per socket (applicable to hardware versions < 10 only) memory_mb Integer number, amount of memory in MB firmware automatic/bios/efi cluster Cluster ID from VMware resource_pool Resource Pool ID from VMware path Path to folder guest_id Guest OS ID form VMware scsi_controller_type ID of the controller from VMware hardware_version Hardware version ID from VMware add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine cpuHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on memoryHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on annotation Annotation Notes
2.33. hammer host-collection
Manipulate host collections
Usage: hammer host-collection [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-host Add host to the host collection copy Copy a host collection create Create a host collection delete Destroy a host collection erratum Manipulate errata for a host collection hosts List all hosts info Show a host collection list List host collections package Manipulate packages for a host collection package-group Manipulate package-groups for a host collection remove-host Remove hosts from the host collection update Update a host collection Options: -h, --help Print help
2.33.1. hammer host-collection add-host
Add host to the host collection
Usage: hammer host-collection add-host [OPTIONS] Options: --host-ids HOST_IDS Array of host ids 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 --id ID Id of the host collection --name NAME Host collection 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 -h, --help Print help
2.33.2. hammer host-collection copy
Copy a host collection
Usage: hammer host-collection copy [OPTIONS] Options: --id ID ID of the host collection --name NAME Host collection name to search by --new-name NEW_NAME New host collection name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.33.3. hammer host-collection create
Create a host collection
Usage: hammer host-collection create [OPTIONS] Options: --description DESCRIPTION --host-ids HOST_IDS List of host ids to replace the hosts in host collection 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 --max-hosts MAX_HOSTS Maximum number of hosts in the host collection --name NAME Host Collection name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --unlimited-hosts UNLIMITED_HOSTS Whether or not the host collection may have unlimited hosts One of true/false, yes/no, 1/0. -h, --help Print help
2.33.4. hammer host-collection delete
Destroy a host collection
Usage: hammer host-collection delete [OPTIONS] Options: --id ID Id of the host collection --name NAME Host collection 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 -h, --help Print help
2.33.5. hammer host-collection erratum
Manipulate errata for a host collection
Usage: hammer host-collection erratum [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install errata on content hosts contained within a host collection Options: -h, --help Print help Unfortunately the server does not support such operation.
2.33.5.1. hammer host-collection erratum install
Install errata on content hosts contained within a host collection
Usage: hammer host-collection erratum install [OPTIONS] Options: --errata ERRATA List of Errata 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 --id HOST_COLLECTION_ID Host Collection ID --name HOST_COLLECTION_NAME Host Collection Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.33.6. hammer host-collection hosts
List all hosts
Usage: hammer host-collection hosts [OPTIONS] Options: --environment ENVIRONMENT_NAME Lifecycle environment name to search by --environment-id ENVIRONMENT_ID --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --id HOST_COLLECTION_ID Host Collection ID --include INCLUDE Array of extra information types to include Possible value(s): 'parameters', 'all_parameters' --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name HOST_COLLECTION_NAME Host Collection Name --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 --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --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 Search / Order fields: activation_key string activation_key_id string addon text addons_status Values: mismatched, matched, not_specified ansible_role string applicable_errata string applicable_rpms string architecture string autoheal boolean 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 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 Values: true, false hypervisor_host string image string 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, 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 string
2.33.7. hammer host-collection info
Show a host collection
Usage: hammer host-collection info [OPTIONS] Options: --id ID Id of the host collection --name NAME Host collection 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 -h, --help Print help
2.33.8. hammer host-collection list
List host collections
Usage: hammer host-collection list [OPTIONS] Options: --activation-key ACTIVATION_KEY_NAME Activation key name to search by --activation-key-id ACTIVATION_KEY_ID ID of the activation key --available-for AVAILABLE_FOR Interpret specified object to return only Host Collections that can be Associated with specified object. The value 'host' is supported. --full-result FULL_RESULT Whether or not to show all results One of true/false, yes/no, 1/0. --host HOST_NAME Host name --host-id HOST_ID --name NAME Host collection 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 ID --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
2.33.9. hammer host-collection package
Manipulate packages for a host collection
Usage: hammer host-collection package [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install packages on content hosts contained within a host collection remove Remove packages on content hosts contained within a host collection update Update packages on content hosts contained within a host collection Options: -h, --help Print help Unfortunately the server does not support such operation.
2.33.9.1. hammer host-collection package install
Install packages on content hosts contained within a host collection
Usage: hammer host-collection package install [OPTIONS] Options: --id HOST_COLLECTION_ID Host Collection ID --name HOST_COLLECTION_NAME Host Collection Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --packages PACKAGES Comma-separated list of packages 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 -h, --help Print help
2.33.9.2. hammer host-collection package remove
Remove packages on content hosts contained within a host collection
Usage: hammer host-collection package remove [OPTIONS] Options: --id HOST_COLLECTION_ID Host Collection ID --name HOST_COLLECTION_NAME Host Collection Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --packages PACKAGES Comma-separated list of packages 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 -h, --help Print help
2.33.9.3. hammer host-collection package update
Update packages on content hosts contained within a host collection
Usage: hammer host-collection package update [OPTIONS] Options: --id HOST_COLLECTION_ID Host Collection ID --name HOST_COLLECTION_NAME Host Collection Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --packages PACKAGES Comma-separated list of packages 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 -h, --help Print help
2.33.10. hammer host-collection package-group
Manipulate package-groups for a host collection
Usage: hammer host-collection package-group [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install package-groups on content hosts contained within a host collection remove Remove package-groups on content hosts contained within a host collection update Update package-groups on content hosts contained within a host collection Options: -h, --help Print help Unfortunately the server does not support such operation.
2.33.10.1. hammer host-collection package-group install
Install package-groups on content hosts contained within a host collection
Usage: hammer host-collection package-group install [OPTIONS] Options: --id HOST_COLLECTION_ID Host Collection ID --name HOST_COLLECTION_NAME Host Collection Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --package-groups PACKAGE-GROUPS Comma-separated list of package-groups 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 -h, --help Print help
2.33.10.2. hammer host-collection package-group remove
Remove package-groups on content hosts contained within a host collection
Usage: hammer host-collection package-group remove [OPTIONS] Options: --id HOST_COLLECTION_ID Host Collection ID --name HOST_COLLECTION_NAME Host Collection Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --package-groups PACKAGE-GROUPS Comma-separated list of package-groups 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 -h, --help Print help
2.33.10.3. hammer host-collection package-group update
Update package-groups on content hosts contained within a host collection
Usage: hammer host-collection package-group update [OPTIONS] Options: --id HOST_COLLECTION_ID Host Collection ID --name HOST_COLLECTION_NAME Host Collection Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --package-groups PACKAGE-GROUPS Comma-separated list of package-groups 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 -h, --help Print help
2.33.11. hammer host-collection remove-host
Remove hosts from the host collection
Usage: hammer host-collection remove-host [OPTIONS] Options: --host-ids HOST_IDS Array of host ids 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 --id ID Id of the host collection --name NAME Host collection 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 -h, --help Print help
2.33.12. hammer host-collection update
Update a host collection
Usage: hammer host-collection update [OPTIONS] Options: --description DESCRIPTION --host-ids HOST_IDS List of host ids to replace the hosts in host collection 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 --id ID Id of the host collection --max-hosts MAX_HOSTS Maximum number of hosts in the host collection --name NAME Host collection name to search by --new-name NEW_NAME Host Collection name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --unlimited-hosts UNLIMITED_HOSTS Whether or not the host collection may have unlimited hosts One of true/false, yes/no, 1/0. -h, --help Print help
2.34. hammer hostgroup
Manipulate hostgroups
Usage: hammer hostgroup [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: ansible-roles Manage Ansible roles on a hostgroup create Create a host group delete Delete a host group delete-parameter Delete parameter for a hostgroup info Show a host group list List all host groups puppet-classes List all Puppet classes rebuild-config Rebuild orchestration config sc-params List all smart class parameters set-parameter Create or update parameter for a hostgroup smart-variables List all smart variables update Update a host group Options: -h, --help Print help
2.34.1. hammer hostgroup ansible-roles
Manage Ansible roles on a hostgroup
Usage: hammer hostgroup ansible-roles [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: assign Assigns Ansible roles to a hostgroup list List all Ansible roles for a hostgroup play Plays Ansible roles on a hostgroup Options: -h, --help Print help
2.34.1.1. hammer hostgroup ansible-roles assign
Assigns Ansible roles to a hostgroup
Usage: hammer hostgroup ansible-roles assign [OPTIONS] Options: --ansible-role-ids ANSIBLE_ROLE_IDS Ansible roles to assign to a hostgroup 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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Hostgroup name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Hostgroup title -h, --help Print help
2.34.1.2. hammer hostgroup ansible-roles list
List all Ansible roles for a hostgroup
Usage: hammer hostgroup ansible-roles list [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Hostgroup name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Hostgroup title -h, --help Print help
2.34.1.3. hammer hostgroup ansible-roles play
Plays Ansible roles on a hostgroup
Usage: hammer hostgroup ansible-roles play [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Hostgroup name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Hostgroup title -h, --help Print help
2.34.2. hammer hostgroup create
Create a host group
Usage: hammer hostgroup 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 --ask-root-pass ASK_ROOT_PW One of true/false, yes/no, 1/0. --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 --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 source ID --content-view CONTENT_VIEW_NAME Name to search by --content-view-id CONTENT_VIEW_ID Content view numeric identifier --description DESCRIPTION Host group description --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment instead) --environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment-id instead) --group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of parameters Comma separated list of values defined by a schema. See Option details section below. JSON is acceptable and preferred way for complex parameters --kickstart-repository REPOSITORY_NAME Kickstart repository name --kickstart-repository-id KICKSTART_REPOSITORY_ID Kickstart repository ID --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by --lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID ID of the environment --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 --medium MEDIUM_NAME Medium name --medium-id MEDIUM_ID --name NAME Name of the host group --openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 --parent PARENT_NAME Name of parent hostgroup --parent-id PARENT_ID Parent ID of the host group --partition-table PARTITION_TABLE_NAME Partition table name --partition-table-id PARTITION_TABLE_ID --puppet-ca-proxy PUPPET_CA_PROXY_NAME Name of puppet CA proxy --puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID --puppet-class-ids PUPPETCLASS_IDS List of puppetclass ids Comma 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 Name of puppet proxy --puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID --pxe-loader PXE_LOADER DHCP filename option (Grub2/PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'iPXE Embedded', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --query-organization ORGANIZATION_NAME Organization name to search by --query-organization-id ORGANIZATION_ID Organization ID to search by --query-organization-label ORGANIZATION_LABEL Organization label to search by --realm REALM_NAME Name to search by --realm-id REALM_ID Numerical ID or realm name --root-pass ROOT_PASSWORD Root password --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID --subnet6 SUBNET6_NAME Subnet IPv6 name --subnet6-id SUBNET6_ID Subnet IPv6 ID -h, --help Print help Option details: Following parameters accept format defined by its schema (bold are required): --group-parameters-attributes "name=string\,value=string, ... "
2.34.3. hammer hostgroup delete
Delete a host group
Usage: hammer hostgroup delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Hostgroup name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Hostgroup title -h, --help Print help
2.34.4. hammer hostgroup delete-parameter
Delete parameter for a hostgroup
Usage: hammer hostgroup delete-parameter [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --name NAME Parameter name -h, --help Print help
2.34.5. hammer hostgroup info
Show a host group
Usage: hammer hostgroup info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Hostgroup name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values One of true/false, yes/no, 1/0. --title TITLE Hostgroup title -h, --help Print help
2.34.6. hammer hostgroup list
List all host groups
Usage: hammer hostgroup list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --puppet-class PUPPET_CLASS_NAME Puppet class name --puppet-class-id PUPPET_CLASS_ID ID of Puppet class --search SEARCH Filter results -h, --help Print help Search / Order fields: architecture string class string config_group string environment string host string id integer label string location string location_id integer medium string name string organization string organization_id integer os string os_description string os_id integer os_major string os_minor string os_title string params text template string title string
2.34.7. hammer hostgroup puppet-classes
List all Puppet classes
Usage: hammer hostgroup puppet-classes [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --location-id LOCATION_ID Scope by locations --order ORDER Sort field and order, eg. ‘id DESC’ --organization-id ORGANIZATION_ID Scope by organizations --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: config_group string environment string host string hostgroup string key string location string name string organization string
2.34.8. hammer hostgroup rebuild-config
Rebuild orchestration config
Usage: hammer hostgroup rebuild-config [OPTIONS] Options: --children-hosts CHILDREN_HOSTS Operate on child hostgroup hosts One of true/false, yes/no, 1/0. --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Hostgroup name --only ONLY Limit rebuild steps, valid steps are DHCP, DNS, TFTP 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 --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Hostgroup title -h, --help Print help
2.34.9. hammer hostgroup sc-params
List all smart class parameters
Usage: hammer hostgroup sc-params [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results --show-hidden SHOW_HIDDEN Display hidden values One of true/false, yes/no, 1/0. -h, --help Print help 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 string
2.34.10. hammer hostgroup set-parameter
Create or update parameter for a hostgroup
Usage: hammer hostgroup set-parameter [OPTIONS] Options: --hidden-value HIDDEN_VALUE Should the value be hidden One of true/false, yes/no, 1/0. --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --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 help
2.34.11. hammer hostgroup smart-variables
List all smart variables
Usage: hammer hostgroup smart-variables [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results --show-hidden SHOW_HIDDEN Display hidden values One of true/false, yes/no, 1/0. -h, --help Print help Search / Order fields: avoid_duplicates Values: true, false key string merge_default Values: true, false merge_overrides Values: true, false override Values: true, false parameter string puppetclass string
2.34.12. hammer hostgroup update
Update a host group
Usage: hammer hostgroup update [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 --ask-root-pass ASK_ROOT_PW One of true/false, yes/no, 1/0. --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 --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 source ID --content-view CONTENT_VIEW_NAME Name to search by --content-view-id CONTENT_VIEW_ID Content view numeric identifier --description DESCRIPTION Host group description --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment instead) --environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment-id instead) --group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of parameters Comma separated list of values defined by a schema. See Option details section below. JSON is acceptable and preferred way for complex parameters --id ID --kickstart-repository REPOSITORY_NAME Kickstart repository name --kickstart-repository-id KICKSTART_REPOSITORY_ID Kickstart repository ID --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by --lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID ID of the environment --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 --medium MEDIUM_NAME Medium name --medium-id MEDIUM_ID --name NAME Hostgroup name --new-name NEW_NAME Name of the host group --openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 --parent PARENT_NAME Name of parent hostgroup --parent-id PARENT_ID Parent ID of the host group --partition-table PARTITION_TABLE_NAME Partition table name --partition-table-id PARTITION_TABLE_ID --puppet-ca-proxy PUPPET_CA_PROXY_NAME Name of puppet CA proxy --puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID --puppet-class-ids PUPPETCLASS_IDS List of puppetclass ids Comma 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 Name of puppet proxy --puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID --pxe-loader PXE_LOADER DHCP filename option (Grub2/PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'iPXE Embedded', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --query-organization ORGANIZATION_NAME Organization name to search by --query-organization-id ORGANIZATION_ID Organization ID to search by --query-organization-label ORGANIZATION_LABEL Organization label to search by --realm REALM_NAME Name to search by --realm-id REALM_ID Numerical ID or realm name --root-pass ROOT_PASSWORD Root password --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID --subnet6 SUBNET6_NAME Subnet IPv6 name --subnet6-id SUBNET6_ID Subnet IPv6 ID --title TITLE Hostgroup title -h, --help Print help Option details: Following parameters accept format defined by its schema (bold are required): --group-parameters-attributes "name=string\,value=string, ... "
2.35. hammer import-templates
Import templates from a git repo or a directory on the server
Usage: hammer import-templates [OPTIONS] Options: --associate ASSOCIATE Associate to OS's, Locations & Organizations. Options are: always, New or never. Possible value(s): 'always', 'new', 'never' --branch BRANCH Branch in Git repo. --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). --force FORCE Update templates that are locked One of true/false, yes/no, 1/0. --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 --lock LOCK Lock imported templates One of true/false, yes/no, 1/0. --negate NEGATE Negate the prefix (for purging). One of true/false, yes/no, 1/0. --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 --prefix PREFIX The string all imported templates should begin with. --repo REPO Override the default repo from settings. --verbose VERBOSE Show template diff in response One of true/false, yes/no, 1/0. -h, --help Print help
2.36. hammer job-invocation
Manage job invocations
Usage: hammer job-invocation [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: cancel Cancel the job create Create a job invocation info Show job invocation list List job invocations output View the output for a host rerun Rerun the job Options: -h, --help Print help
2.36.1. hammer job-invocation cancel
Cancel the job
Usage: hammer job-invocation cancel [OPTIONS] Options: --force FORCE One of true/false, yes/no, 1/0. --id ID --location-id LOCATION_ID Scope by locations --organization-id ORGANIZATION_ID Scope by organizations -h, --help Print help
2.36.2. hammer job-invocation create
Create a job invocation
Usage: hammer job-invocation create [OPTIONS] Options: --async Do not wait for the task --bookmark BOOKMARK_NAME Name to search by --bookmark-id BOOKMARK_ID --concurrency-level CONCURRENCY_LEVEL Run at most N tasks at a time --cron-line CRONLINE Create a recurring execution Cron line format 'a b c d e', where: a. is minute (range: 0-59) b. is hour (range: 0-23) c. is day of month (range: 1-31) d. is month (range: 1-12) e. is day of week (range: 0-6) --description-format DESCRIPTION_FORMAT Override the description format from the template for this invocation only --dynamic Dynamic search queries are evaluated at run time --effective-user EFFECTIVE_USER What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting. --end-time DATETIME Perform no more executions after this time, used with --cron-line Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format --execution-timeout-interval EXECUTION_TIMEOUT_INTERVAL Override the timeout interval from the template for this invocation only --feature FEATURE Remote execution feature label that should be triggered, job template Assigned to this feature will be used --input-files INPUT FILES Read input values from files Comma-separated list of key=file, where file is a path to a text file to be read --inputs INPUTS Specify inputs from command line Comma-separated list of key=value. JSON is acceptable and preferred way for complex parameters --job-template JOB_TEMPLATE_NAME Name to search by --job-template-id JOB_TEMPLATE_ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --max-iteration MAX_ITERATION Repeat a maximum of N times --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --search-query SEARCH_QUERY --start-at DATETIME Schedule the execution for a later time Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format --start-before DATETIME Execution should be cancelled if it cannot be started before --start-at Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format --time-span TIME_SPAN Distribute tasks over N seconds -h, --help Print help
2.36.3. hammer job-invocation info
Show job invocation
Usage: hammer job-invocation info [OPTIONS] Options: --id ID --location-id LOCATION_ID Scope by locations --organization-id ORGANIZATION_ID Scope by organizations -h, --help Print help
2.36.4. hammer job-invocation list
List job invocations
Usage: hammer job-invocation list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help
2.36.5. hammer job-invocation output
View the output for a host
Usage: hammer job-invocation output [OPTIONS] Options: --async Do not wait for job to complete, shows current output only --host HOST_NAME Host name --host-id HOST_ID --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.36.6. hammer job-invocation rerun
Rerun the job
Usage: hammer job-invocation rerun [OPTIONS] Options: --failed-only FAILED_ONLY One of true/false, yes/no, 1/0. --id ID --location-id LOCATION_ID Scope by locations --organization-id ORGANIZATION_ID Scope by organizations -h, --help Print help
2.37. hammer job-template
Manage job templates
Usage: hammer job-template [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a job template delete Delete a job template dump View job template content export Export a template including all metadata import Import a job template from ERB info Show job template details list List job templates update Update a job template Options: -h, --help Print help
2.37.1. hammer job-template create
Create a job template
Usage: hammer job-template create [OPTIONS] Options: --audit-comment AUDIT_COMMENT --current-user CURRENT_USER Whether the current user login should be used as the effective user One of true/false, yes/no, 1/0. --description-format DESCRIPTION_FORMAT This template is used to generate the description. Input values can be used Using the syntax %{package}. You may also include the job category and Template name using %{job_category} and %{template_name}. --file TEMPLATE Path to a file that contains the template --job-category JOB_CATEGORY Job category --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locked LOCKED Whether or not the template is locked for editing One of true/false, yes/no, 1/0. --name NAME Template name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --overridable OVERRIDABLE Whether it should be allowed to override the effective user from the Invocation form. One of true/false, yes/no, 1/0. --provider-type PROVIDER_TYPE Provider type Possible value(s): 'SSH', 'Ansible' --snippet SNIPPET One of true/false, yes/no, 1/0. --value VALUE What user should be used to run the script (using sudo-like mechanisms) -h, --help Print help
2.37.2. hammer job-template delete
Delete a job template
Usage: hammer job-template delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.37.3. hammer job-template dump
View job template content
Usage: hammer job-template dump [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.37.4. hammer job-template export
Export a template including all metadata
Usage: hammer job-template export [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.37.5. hammer job-template import
Import a job template from ERB
Usage: hammer job-template import [OPTIONS] Options: --file TEMPLATE Path to a file that contains the template - must include ERB metadata --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --overwrite OVERWRITE Overwrite template if it already exists One of true/false, yes/no, 1/0. -h, --help Print help
2.37.6. hammer job-template info
Show job template details
Usage: hammer job-template info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.37.7. hammer job-template list
List job templates
Usage: hammer job-template list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help
2.37.8. hammer job-template update
Update a job template
Usage: hammer job-template update [OPTIONS] Options: --audit-comment AUDIT_COMMENT --current-user CURRENT_USER Whether the current user login should be used as the effective user One of true/false, yes/no, 1/0. --description-format DESCRIPTION_FORMAT This template is used to generate the description. Input values can be used Using the syntax %{package}. You may also include the job category and Template name using %{job_category} and %{template_name}. --file TEMPLATE Path to a file that contains the template --id ID --job-category JOB_CATEGORY Job category --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locked LOCKED Whether or not the template is locked for editing One of true/false, yes/no, 1/0. --name NAME Name to search by --new-name NEW_NAME Template name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --overridable OVERRIDABLE Whether it should be allowed to override the effective user from the Invocation form. One of true/false, yes/no, 1/0. --provider-type PROVIDER_TYPE Provider type Possible value(s): 'SSH', 'Ansible' --snippet SNIPPET One of true/false, yes/no, 1/0. --value VALUE What user should be used to run the script (using sudo-like mechanisms) -h, --help Print help
2.38. hammer lifecycle-environment
Manipulate lifecycle_environments on the server
Usage: hammer lifecycle-environment [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create an environment delete Destroy an environment info Show an environment list List environments in an organization paths List environment paths update Update an environment Options: -h, --help Print help
2.38.1. hammer lifecycle-environment create
Create an environment
Usage: hammer lifecycle-environment create [OPTIONS] Options: --description DESCRIPTION Description of the environment --label LABEL Label of the environment --name NAME Name of the environment --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --prior PRIOR Name of the prior environment --prior-id PRIOR_ID ID of an environment that is prior to the new environment in the chain. It Has to be either the ID of Library or the ID of an environment at the end Of a chain. --registry-name-pattern REGISTRY_NAME_PATTERN Pattern for container image names --registry-unauthenticated-pull REGISTRY_UNAUTHENTICATED_PULL Allow unauthenticed pull of container images One of true/false, yes/no, 1/0. -h, --help Print help
2.38.2. hammer lifecycle-environment delete
Destroy an environment
Usage: hammer lifecycle-environment delete [OPTIONS] Options: --id ID ID of the environment --name NAME Lifecycle environment name to search by --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.38.3. hammer lifecycle-environment info
Show an environment
Usage: hammer lifecycle-environment info [OPTIONS] Options: --id ID ID of the environment --name NAME Lifecycle environment 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 -h, --help Print help
2.38.4. hammer lifecycle-environment list
List environments in an organization
Usage: hammer lifecycle-environment list [OPTIONS] Options: --full-result FULL_RESULT Whether or not to show all results One of true/false, yes/no, 1/0. --library LIBRARY Set true if you want to see only library environments Possible value(s): 'true', 'false' --name NAME Filter only environments containing this name --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 --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
2.38.5. hammer lifecycle-environment paths
List environment paths
Usage: hammer lifecycle-environment paths [OPTIONS] Options: --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --permission-type PERMISSION_TYPE The associated permission type. One of (readable | promotable) Default: Readable -h, --help Print help
2.38.6. hammer lifecycle-environment update
Update an environment
Usage: hammer lifecycle-environment update [OPTIONS] Options: --async ASYNC Do not wait for the update action to finish. Default: true One of true/false, yes/no, 1/0. --description DESCRIPTION Description of the environment --id ID ID of the environment --name NAME Lifecycle environment name to search by --new-name NEW_NAME New name to be given to the environment --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --registry-name-pattern REGISTRY_NAME_PATTERN Pattern for container image names --registry-unauthenticated-pull REGISTRY_UNAUTHENTICATED_PULL Allow unauthenticed pull of container images One of true/false, yes/no, 1/0. -h, --help Print help
2.39. hammer location
Manipulate locations
Usage: hammer location [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-compute-resource Associate a compute resource add-config-template Associate a configuration template add-domain Associate a domain add-environment Associate a Puppet environment add-hostgroup Associate a hostgroup add-medium Associate a medium add-organization Associate an organization add-smart-proxy Associate a smart proxy add-subnet Associate a subnet add-user Associate an user create Create a location delete Delete a location delete-parameter Delete parameter for a location info Show a location list List all locations remove-compute-resource Disassociate a compute resource remove-config-template Disassociate a configuration template remove-domain Disassociate a domain remove-environment Disassociate a Puppet environment remove-hostgroup Disassociate a hostgroup remove-medium Disassociate a medium remove-organization Disassociate an organization remove-smart-proxy Disassociate a smart proxy remove-subnet Disassociate a subnet remove-user Disassociate an user set-parameter Create or update parameter for a location update Update a location Options: -h, --help Print help
2.39.1. hammer location add-compute-resource
Associate a compute resource
Usage: hammer location add-compute-resource [OPTIONS] Options: --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.2. hammer location add-config-template
Associate a configuration template
Usage: hammer location add-config-template [OPTIONS] Options: --config-template CONFIG_TEMPLATE_NAME Name to search by --config-template-id CONFIG_TEMPLATE_ID --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.3. hammer location add-domain
Associate a domain
Usage: hammer location add-domain [OPTIONS] Options: --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.4. hammer location add-environment
Associate a Puppet environment
Usage: hammer location add-environment [OPTIONS] Options: --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment instead) --environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment-id instead) --id ID --name NAME Location name --puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name --puppet-environment-id PUPPET_ENVIRONMENT_ID --title TITLE Location title -h, --help Print help
2.39.5. hammer location add-hostgroup
Associate a hostgroup
Usage: hammer location add-hostgroup [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.6. hammer location add-medium
Associate a medium
Usage: hammer location add-medium [OPTIONS] Options: --id ID --medium MEDIUM_NAME Medium name --medium-id MEDIUM_ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.7. hammer location add-organization
Associate an organization
Usage: hammer location add-organization [OPTIONS] Options: --id ID --name NAME Location name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Location title -h, --help Print help
2.39.8. hammer location add-smart-proxy
Associate a smart proxy
Usage: hammer location add-smart-proxy [OPTIONS] Options: --id ID --name NAME Location name --smart-proxy SMART_PROXY_NAME Name to search by --smart-proxy-id SMART_PROXY_ID --title TITLE Location title -h, --help Print help
2.39.9. hammer location add-subnet
Associate a subnet
Usage: hammer location add-subnet [OPTIONS] Options: --id ID --name NAME Location name --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID --title TITLE Location title -h, --help Print help
2.39.10. hammer location add-user
Associate an user
Usage: hammer location add-user [OPTIONS] Options: --id ID --name NAME Location name --title TITLE Location title --user USER_LOGIN User's login to search by --user-id USER_ID -h, --help Print help
2.39.11. hammer location create
Create a location
Usage: hammer location create [OPTIONS] Options: --compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource 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 --compute-resources COMPUTE_RESOURCE_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 --config-template-ids CONFIG_TEMPLATE_IDS Provisioning template 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 --config-templates CONFIG_TEMPLATE_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 --domain-ids DOMAIN_IDS Domain 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 --domains DOMAIN_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 --environment-ids ENVIRONMENT_IDS Environment IDs (--environment-ids is deprecated: Use --puppet-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 --puppet-environments instead) --hostgroup-ids HOSTGROUP_IDS Host group 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 --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 --ignore-types IGNORE_TYPES List of resources types that will be automatically associated 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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --media MEDIUM_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 --medium-ids MEDIUM_IDS Medium 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 --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --parent-id PARENT_ID Parent ID --partition-table-ids PARTITION_TABLE_IDS Partition template 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 --partition-tables PARTITION_TABLE_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 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template 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 --provisioning-templates PROVISIONING_TEMPLATE_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-ids PUPPET_ENVIRONMENT_IDS Environment 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-environments PUPPET_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 --realm-ids REALM_IDS Realm 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 --realms REALM_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 --smart-proxies SMART_PROXY_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 --smart-proxy-ids SMART_PROXY_IDS Capsule 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 --subnet-ids SUBNET_IDS Subnet 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 --subnets SUBNET_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 --user-ids USER_IDS User 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 --users USER_LOGINS 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
2.39.12. hammer location delete
Delete a location
Usage: hammer location delete [OPTIONS] Options: --id ID Location numeric id to search by --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Organization name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Organization title -h, --help Print help
2.39.13. hammer location delete-parameter
Delete parameter for a location
Usage: hammer location delete-parameter [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Parameter name -h, --help Print help
2.39.14. hammer location info
Show a location
Usage: hammer location info [OPTIONS] Options: --id ID Location numeric id to search by --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Organization name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values One of true/false, yes/no, 1/0. --title TITLE Organization title -h, --help Print help
2.39.15. hammer location list
List all locations
Usage: hammer location list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help
2.39.16. hammer location remove-compute-resource
Disassociate a compute resource
Usage: hammer location remove-compute-resource [OPTIONS] Options: --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.17. hammer location remove-config-template
Disassociate a configuration template
Usage: hammer location remove-config-template [OPTIONS] Options: --config-template CONFIG_TEMPLATE_NAME Name to search by --config-template-id CONFIG_TEMPLATE_ID --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.18. hammer location remove-domain
Disassociate a domain
Usage: hammer location remove-domain [OPTIONS] Options: --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.19. hammer location remove-environment
Disassociate a Puppet environment
Usage: hammer location remove-environment [OPTIONS] Options: --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment instead) --environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment-id instead) --id ID --name NAME Location name --puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name --puppet-environment-id PUPPET_ENVIRONMENT_ID --title TITLE Location title -h, --help Print help
2.39.20. hammer location remove-hostgroup
Disassociate a hostgroup
Usage: hammer location remove-hostgroup [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --id ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.21. hammer location remove-medium
Disassociate a medium
Usage: hammer location remove-medium [OPTIONS] Options: --id ID --medium MEDIUM_NAME Medium name --medium-id MEDIUM_ID --name NAME Location name --title TITLE Location title -h, --help Print help
2.39.22. hammer location remove-organization
Disassociate an organization
Usage: hammer location remove-organization [OPTIONS] Options: --id ID --name NAME Location name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Location title -h, --help Print help
2.39.23. hammer location remove-smart-proxy
Disassociate a smart proxy
Usage: hammer location remove-smart-proxy [OPTIONS] Options: --id ID --name NAME Location name --smart-proxy SMART_PROXY_NAME Name to search by --smart-proxy-id SMART_PROXY_ID --title TITLE Location title -h, --help Print help
2.39.24. hammer location remove-subnet
Disassociate a subnet
Usage: hammer location remove-subnet [OPTIONS] Options: --id ID --name NAME Location name --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID --title TITLE Location title -h, --help Print help
2.39.25. hammer location remove-user
Disassociate an user
Usage: hammer location remove-user [OPTIONS] Options: --id ID --name NAME Location name --title TITLE Location title --user USER_LOGIN User's login to search by --user-id USER_ID -h, --help Print help
2.39.26. hammer location set-parameter
Create or update parameter for a location
Usage: hammer location set-parameter [OPTIONS] Options: --hidden-value HIDDEN_VALUE Should the value be hidden One of true/false, yes/no, 1/0. --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --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 help
2.39.27. hammer location update
Update a location
Usage: hammer location update [OPTIONS] Options: --compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource 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 --compute-resources COMPUTE_RESOURCE_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 --config-template-ids CONFIG_TEMPLATE_IDS Provisioning template 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 --config-templates CONFIG_TEMPLATE_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 --domain-ids DOMAIN_IDS Domain 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 --domains DOMAIN_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 --environment-ids ENVIRONMENT_IDS Environment IDs (--environment-ids is deprecated: Use --puppet-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 --puppet-environments instead) --hostgroup-ids HOSTGROUP_IDS Host group 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 --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 --id ID Location numeric id to search by --ignore-types IGNORE_TYPES List of resources types that will be automatically associated 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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --media MEDIUM_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 --medium-ids MEDIUM_IDS Medium 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 Location name --new-name NEW_NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --parent-id PARENT_ID Parent ID --partition-table-ids PARTITION_TABLE_IDS Partition template 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 --partition-tables PARTITION_TABLE_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 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template 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 --provisioning-templates PROVISIONING_TEMPLATE_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-ids PUPPET_ENVIRONMENT_IDS Environment 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-environments PUPPET_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 --realm-ids REALM_IDS Realm 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 --realms REALM_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 --smart-proxies SMART_PROXY_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 --smart-proxy-ids SMART_PROXY_IDS Capsule 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 --subnet-ids SUBNET_IDS Subnet 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 --subnets SUBNET_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 --title TITLE Location title --user-ids USER_IDS User 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 --users USER_LOGINS 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
2.40. hammer medium
Manipulate installation media
Usage: hammer medium [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-operatingsystem Associate an operating system create Create a medium delete Delete a medium info Show a medium list List all installation media remove-operatingsystem Disassociate an operating system update Update a medium Options: -h, --help Print help
2.40.1. hammer medium add-operatingsystem
Associate an operating system
Usage: hammer medium add-operatingsystem [OPTIONS] Options: --id ID --name NAME Medium name --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID -h, --help Print help
2.40.2. hammer medium create
Create a medium
Usage: hammer medium create [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 of media --operatingsystem-ids OPERATINGSYSTEM_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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 --os-family OS_FAMILY Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris, Suse, VRP, Windows, Xenserver --path PATH The path to the medium, can be a URL or a valid NFS server (exclusive of The architecture). For example mirror.centos.org/centos/$version/os/$arch Where $arch will be substituted for the host's actual OS architecture And $version, $major and $minor will be substituted for the version of the Operating system. Solaris and Debian media may also use $release. -h, --help Print help
2.40.3. hammer medium delete
Delete a medium
Usage: hammer medium delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Medium name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.40.4. hammer medium info
Show a medium
Usage: hammer medium info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Medium name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.40.5. hammer medium list
List all installation media
Usage: hammer medium list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: family string location string location_id integer name string organization string organization_id integer path string
2.40.6. hammer medium remove-operatingsystem
Disassociate an operating system
Usage: hammer medium remove-operatingsystem [OPTIONS] Options: --id ID --name NAME Medium name --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID -h, --help Print help
2.40.7. hammer medium update
Update a medium
Usage: hammer medium update [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Medium name --new-name NEW_NAME Name of media --operatingsystem-ids OPERATINGSYSTEM_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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 --os-family OS_FAMILY Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris, Suse, VRP, Windows, Xenserver --path PATH The path to the medium, can be a URL or a valid NFS server (exclusive of The architecture). For example mirror.centos.org/centos/$version/os/$arch Where $arch will be substituted for the host's actual OS architecture And $version, $major and $minor will be substituted for the version of the Operating system. Solaris and Debian media may also use $release. -h, --help Print help
2.41. hammer model
Manipulate hardware models
Usage: hammer model [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a hardware model delete Delete a hardware model info Show a hardware model list List all hardware models update Update a hardware model Options: -h, --help Print help
2.41.1. hammer model create
Create a hardware model
Usage: hammer model create [OPTIONS] Options: --hardware-model HARDWARE_MODEL --info INFO --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --vendor-class VENDOR_CLASS -h, --help Print help
2.41.2. hammer model delete
Delete a hardware model
Usage: hammer model delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Model name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.41.3. hammer model info
Show a hardware model
Usage: hammer model info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Model name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.41.4. hammer model list
List all hardware models
Usage: hammer model list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: hardware_model string info text name string vendor_class string
2.41.5. hammer model update
Update a hardware model
Usage: hammer model update [OPTIONS] Options: --hardware-model HARDWARE_MODEL --id ID --info INFO --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Model name --new-name NEW_NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --vendor-class VENDOR_CLASS -h, --help Print help
2.42. hammer module-stream
View Module Streams
Usage: hammer module-stream [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show a module stream list List module streams Options: -h, --help Print help
2.42.1. hammer module-stream info
Show a module stream
Usage: hammer module-stream info [OPTIONS] Options: --id ID A module stream identifier --name NAME Module stream 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 --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
2.42.2. hammer module-stream list
List module streams
Usage: hammer module-stream list [OPTIONS] Options: --content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by --content-view-filter-id CONTENT_VIEW_FILTER_ID Filter 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-id ENVIRONMENT_ID --full-result FULL_RESULT Whether or not to show all results One of true/false, yes/no, 1/0. --host-ids HOST_IDS List of host id to list available module streams for 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 --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 --name-stream-only NAME_STREAM_ONLY Return name and stream information only) 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 --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 ID --search SEARCH Search string -h, --help Print help
2.43. hammer organization
Manipulate organizations
Usage: hammer organization [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-compute-resource Associate a compute resource add-config-template Associate a configuration template add-domain Associate a domain add-environment Associate a Puppet environment add-hostgroup Associate a hostgroup add-location Associate a location add-medium Associate a medium add-smart-proxy Associate a smart proxy add-subnet Associate a subnet add-user Associate an user create Create organization delete Delete an organization delete-parameter Delete parameter for an organization info Show organization list List all organizations remove-compute-resource Disassociate a compute resource remove-config-template Disassociate a configuration template remove-domain Disassociate a domain remove-environment Disassociate a Puppet environment remove-hostgroup Disassociate a hostgroup remove-location Disassociate a location remove-medium Disassociate a medium remove-smart-proxy Disassociate a smart proxy remove-subnet Disassociate a subnet remove-user Disassociate an user set-parameter Create or update parameter for an organization update Update organization Options: -h, --help Print help
2.43.1. hammer organization add-compute-resource
Associate a compute resource
Usage: hammer organization add-compute-resource [OPTIONS] Options: --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.2. hammer organization add-config-template
Associate a configuration template
Usage: hammer organization add-config-template [OPTIONS] Options: --config-template CONFIG_TEMPLATE_NAME Name to search by --config-template-id CONFIG_TEMPLATE_ID --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.3. hammer organization add-domain
Associate a domain
Usage: hammer organization add-domain [OPTIONS] Options: --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.4. hammer organization add-environment
Associate a Puppet environment
Usage: hammer organization add-environment [OPTIONS] Options: --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment instead) --environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment-id instead) --id ID Organization ID --name NAME Organization name --puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name --puppet-environment-id PUPPET_ENVIRONMENT_ID --title TITLE Organization title -h, --help Print help
2.43.5. hammer organization add-hostgroup
Associate a hostgroup
Usage: hammer organization add-hostgroup [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.6. hammer organization add-location
Associate a location
Usage: hammer organization add-location [OPTIONS] Options: --id ID Organization ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.7. hammer organization add-medium
Associate a medium
Usage: hammer organization add-medium [OPTIONS] Options: --id ID Organization ID --medium MEDIUM_NAME Medium name --medium-id MEDIUM_ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.8. hammer organization add-smart-proxy
Associate a smart proxy
Usage: hammer organization add-smart-proxy [OPTIONS] Options: --id ID Organization ID --name NAME Organization name --smart-proxy SMART_PROXY_NAME Name to search by --smart-proxy-id SMART_PROXY_ID --title TITLE Organization title -h, --help Print help
2.43.9. hammer organization add-subnet
Associate a subnet
Usage: hammer organization add-subnet [OPTIONS] Options: --id ID Organization ID --name NAME Organization name --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID --title TITLE Organization title -h, --help Print help
2.43.10. hammer organization add-user
Associate an user
Usage: hammer organization add-user [OPTIONS] Options: --id ID Organization ID --name NAME Organization name --title TITLE Organization title --user USER_LOGIN User's login to search by --user-id USER_ID -h, --help Print help
2.43.11. hammer organization create
Create organization
Usage: hammer organization create [OPTIONS] Options: --compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource 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 --compute-resources COMPUTE_RESOURCE_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 --config-template-ids CONFIG_TEMPLATE_IDS Provisioning template 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 --config-templates CONFIG_TEMPLATE_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 Description --domain-ids DOMAIN_IDS Domain 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 --domains DOMAIN_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 --environment-ids ENVIRONMENT_IDS Environment 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 --environments 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 --hostgroup-ids HOSTGROUP_IDS Host group 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 --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 --label LABEL Unique label --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --media MEDIUM_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 --medium-ids MEDIUM_IDS Medium 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 Name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template 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 --provisioning-templates PROVISIONING_TEMPLATE_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 --ptable-ids PTABLE_IDS Partition template 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 --ptables PTABLE_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 --realm-ids REALM_IDS Realm 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 --realms REALM_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 --smart-proxies SMART_PROXY_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 --smart-proxy-ids SMART_PROXY_IDS Capsule 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 --subnet-ids SUBNET_IDS Subnet 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 --subnets SUBNET_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 --user-ids USER_IDS User 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 --users USER_LOGINS 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
2.43.12. hammer organization delete
Delete an organization
Usage: hammer organization delete [OPTIONS] Options: --async Do not wait for the task --id ID --label LABEL Organization label to search by --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Organization name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --organization-title ORGANIZATION_TITLE Organization title --title TITLE Organization title -h, --help Print help
2.43.13. hammer organization delete-parameter
Delete parameter for an organization
Usage: hammer organization delete-parameter [OPTIONS] Options: --name NAME Parameter name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.43.14. hammer organization info
Show organization
Usage: hammer organization info [OPTIONS] Options: --id ID --label LABEL Organization label to search by --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Organization name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --organization-title ORGANIZATION_TITLE Organization title --title TITLE Organization title -h, --help Print help
2.43.15. hammer organization list
List all organizations
Usage: hammer organization list [OPTIONS] Options: --full-result FULL_RESULT Whether or not to show all results One of true/false, yes/no, 1/0. --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. 'id DESC' --organization ORGANIZATION_NAME Organization name --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 --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
2.43.16. hammer organization remove-compute-resource
Disassociate a compute resource
Usage: hammer organization remove-compute-resource [OPTIONS] Options: --compute-resource COMPUTE_RESOURCE_NAME Compute resource name --compute-resource-id COMPUTE_RESOURCE_ID --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.17. hammer organization remove-config-template
Disassociate a configuration template
Usage: hammer organization remove-config-template [OPTIONS] Options: --config-template CONFIG_TEMPLATE_NAME Name to search by --config-template-id CONFIG_TEMPLATE_ID --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.18. hammer organization remove-domain
Disassociate a domain
Usage: hammer organization remove-domain [OPTIONS] Options: --domain DOMAIN_NAME Domain name --domain-id DOMAIN_ID Numerical ID or domain name --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.19. hammer organization remove-environment
Disassociate a Puppet environment
Usage: hammer organization remove-environment [OPTIONS] Options: --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment instead) --environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment-id instead) --id ID Organization ID --name NAME Organization name --puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name --puppet-environment-id PUPPET_ENVIRONMENT_ID --title TITLE Organization title -h, --help Print help
2.43.20. hammer organization remove-hostgroup
Disassociate a hostgroup
Usage: hammer organization remove-hostgroup [OPTIONS] Options: --hostgroup HOSTGROUP_NAME Hostgroup name --hostgroup-id HOSTGROUP_ID --hostgroup-title HOSTGROUP_TITLE Hostgroup title --id ID Organization ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.21. hammer organization remove-location
Disassociate a location
Usage: hammer organization remove-location [OPTIONS] Options: --id ID Organization ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.22. hammer organization remove-medium
Disassociate a medium
Usage: hammer organization remove-medium [OPTIONS] Options: --id ID Organization ID --medium MEDIUM_NAME Medium name --medium-id MEDIUM_ID --name NAME Organization name --title TITLE Organization title -h, --help Print help
2.43.23. hammer organization remove-smart-proxy
Disassociate a smart proxy
Usage: hammer organization remove-smart-proxy [OPTIONS] Options: --id ID Organization ID --name NAME Organization name --smart-proxy SMART_PROXY_NAME Name to search by --smart-proxy-id SMART_PROXY_ID --title TITLE Organization title -h, --help Print help
2.43.24. hammer organization remove-subnet
Disassociate a subnet
Usage: hammer organization remove-subnet [OPTIONS] Options: --id ID Organization ID --name NAME Organization name --subnet SUBNET_NAME Subnet name --subnet-id SUBNET_ID --title TITLE Organization title -h, --help Print help
2.43.25. hammer organization remove-user
Disassociate an user
Usage: hammer organization remove-user [OPTIONS] Options: --id ID Organization ID --name NAME Organization name --title TITLE Organization title --user USER_LOGIN User's login to search by --user-id USER_ID -h, --help Print help
2.43.26. hammer organization set-parameter
Create or update parameter for an organization
Usage: hammer organization set-parameter [OPTIONS] Options: --hidden-value HIDDEN_VALUE Should the value be hidden One of true/false, yes/no, 1/0. --name NAME Parameter name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --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 help
2.43.27. hammer organization update
Update organization
Usage: hammer organization update [OPTIONS] Options: --compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource 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 --compute-resources COMPUTE_RESOURCE_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 --config-template-ids CONFIG_TEMPLATE_IDS Provisioning template 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 --config-templates CONFIG_TEMPLATE_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 --domain-ids DOMAIN_IDS Domain 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 --domains DOMAIN_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 --environment-ids ENVIRONMENT_IDS Environment IDs (--environment-ids is deprecated: Use --puppet-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 --puppet-environments instead) --hostgroup-ids HOSTGROUP_IDS Host group 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 --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 --id ID --ignore-types IGNORE_TYPES List of resources types that will be automatically associated Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --label LABEL Organization label to search by --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --media MEDIUM_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 --medium-ids MEDIUM_IDS Medium 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 Organization name --new-name NEW_NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --organization-title ORGANIZATION_TITLE Organization title --parent-id PARENT_ID Parent ID --partition-table-ids PARTITION_TABLE_IDS Partition template 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 --partition-tables PARTITION_TABLE_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 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template 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 --provisioning-templates PROVISIONING_TEMPLATE_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 --ptable-ids PTABLE_IDS Partition template 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 --ptables PTABLE_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-ids PUPPET_ENVIRONMENT_IDS Environment 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-environments PUPPET_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 --realm-ids REALM_IDS Realm 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 --realms REALM_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 --redhat-repository-url REDHAT_REPOSITORY_URL Red Hat CDN URL --smart-proxies SMART_PROXY_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 --smart-proxy-ids SMART_PROXY_IDS Capsule 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 --subnet-ids SUBNET_IDS Subnet 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 --subnets SUBNET_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 --title TITLE Organization title --user-ids USER_IDS User 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 --users USER_LOGINS 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
2.44. hammer os
Manipulate operating system
Usage: hammer os [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-architecture Associate an architecture add-config-template Associate a configuration template add-ptable Associate a partition table create Create an operating system delete Delete an operating system delete-default-template delete-parameter Delete parameter for an operating system info Show an operating system list List all operating systems remove-architecture Disassociate an architecture remove-config-template Disassociate a configuration template remove-ptable Disassociate a partition table set-default-template set-parameter Create or update parameter for an operating system update Update an operating system Options: -h, --help Print help
2.44.1. hammer os add-architecture
Associate an architecture
Usage: hammer os add-architecture [OPTIONS] Options: --architecture ARCHITECTURE_NAME Architecture name --architecture-id ARCHITECTURE_ID --id ID --title TITLE Operating system title -h, --help Print help
2.44.2. hammer os add-config-template
Associate a configuration template
Usage: hammer os add-config-template [OPTIONS] Options: --config-template CONFIG_TEMPLATE_NAME Name to search by --config-template-id CONFIG_TEMPLATE_ID --id ID --title TITLE Operating system title -h, --help Print help
2.44.3. hammer os add-ptable
Associate a partition table
Usage: hammer os add-ptable [OPTIONS] Options: --id ID --partition-table PARTITION_TABLE_NAME Partition table name --partition-table-id PARTITION_TABLE_ID --title TITLE Operating system title -h, --help Print help
2.44.4. hammer os create
Create an operating system
Usage: hammer os create [OPTIONS] Options: --architecture-ids ARCHITECTURE_IDS IDs of associated architectures Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --architectures ARCHITECTURE_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 --config-template-ids CONFIG_TEMPLATE_IDS IDs of associated provisioning templates 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-templates CONFIG_TEMPLATE_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 --family FAMILY --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --major MAJOR --media MEDIUM_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 --medium-ids MEDIUM_IDS IDs of associated media Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --minor MINOR --name NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --os-parameters-attributes OS_PARAMETERS_ATTRIBUTES Array of parameters Comma separated list of values defined by a schema. See Option details section below. JSON is acceptable and preferred way for complex parameters --partition-table-ids PARTITION_TABLE_IDS IDs of associated partition tables Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --partition-tables PARTITION_TABLE_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 --password-hash PASSWORD_HASH Root password hash function to use, one of MD5, SHA256, SHA512, Base64 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated provisioning templates Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --provisioning-templates PROVISIONING_TEMPLATE_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 --release-name RELEASE_NAME -h, --help Print help Option details: Following parameters accept format defined by its schema (bold are required): --os-parameters-attributes "name=string\,value=string, ... "
2.44.5. hammer os delete
Delete an operating system
Usage: hammer os delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --title TITLE Operating system title -h, --help Print help
2.44.6. hammer os delete-default-template
Usage: hammer os delete-default-template [OPTIONS] Options: --id OS ID Operatingsystem id --type TPL TYPE Type of the config template -h, --help Print help
2.44.7. hammer os delete-parameter
Delete parameter for an operating system
Usage: hammer os delete-parameter [OPTIONS] Options: --name NAME Parameter name --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID -h, --help Print help
2.44.8. hammer os info
Show an operating system
Usage: hammer os info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values One of true/false, yes/no, 1/0. --title TITLE Operating system title -h, --help Print help
2.44.9. hammer os list
List all operating systems
Usage: hammer os list [OPTIONS] Options: --architecture ARCHITECTURE_NAME Architecture name --architecture-id ARCHITECTURE_ID --config-template CONFIG_TEMPLATE_NAME Name to search by --config-template-id CONFIG_TEMPLATE_ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --medium MEDIUM_NAME Medium name --medium-id MEDIUM_ID --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --os-parameters-attributes OS_PARAMETERS_ATTRIBUTES Array of parameters Comma separated list of values defined by a schema. See Option details section below. JSON is acceptable and preferred way for complex parameters --page PAGE Paginate results --partition-table PARTITION_TABLE_NAME Partition table name --partition-table-id PARTITION_TABLE_ID --per-page PER_PAGE Number of entries per request --provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by --provisioning-template-id PROVISIONING_TEMPLATE_ID --search SEARCH Filter results -h, --help Print help Option details: Following parameters accept format defined by its schema (bold are required): --os-parameters-attributes "name=string\,value=string, ... " Search / Order fields: architecture string description string family string major string medium string minor string name string params text template string title string
2.44.10. hammer os remove-architecture
Disassociate an architecture
Usage: hammer os remove-architecture [OPTIONS] Options: --architecture ARCHITECTURE_NAME Architecture name --architecture-id ARCHITECTURE_ID --id ID --title TITLE Operating system title -h, --help Print help
2.44.11. hammer os remove-config-template
Disassociate a configuration template
Usage: hammer os remove-config-template [OPTIONS] Options: --config-template CONFIG_TEMPLATE_NAME Name to search by --config-template-id CONFIG_TEMPLATE_ID --id ID --title TITLE Operating system title -h, --help Print help
2.44.12. hammer os remove-ptable
Disassociate a partition table
Usage: hammer os remove-ptable [OPTIONS] Options: --id ID --partition-table PARTITION_TABLE_NAME Partition table name --partition-table-id PARTITION_TABLE_ID --title TITLE Operating system title -h, --help Print help
2.44.13. hammer os set-default-template
Usage: hammer os set-default-template [OPTIONS] Options: --config-template-id TPL ID Config template id to be set --id OS ID Operatingsystem id -h, --help Print help
2.44.14. hammer os set-parameter
Create or update parameter for an operating system
Usage: hammer os set-parameter [OPTIONS] Options: --hidden-value HIDDEN_VALUE Should the value be hidden One of true/false, yes/no, 1/0. --name NAME Parameter name --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --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 help
2.44.15. hammer os update
Update an operating system
Usage: hammer os update [OPTIONS] Options: --architecture-ids ARCHITECTURE_IDS IDs of associated architectures Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --architectures ARCHITECTURE_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 --config-template-ids CONFIG_TEMPLATE_IDS IDs of associated provisioning templates 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-templates CONFIG_TEMPLATE_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 --family FAMILY --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --major MAJOR --media MEDIUM_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 --medium-ids MEDIUM_IDS IDs of associated media Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --minor MINOR --name NAME --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --os-parameters-attributes OS_PARAMETERS_ATTRIBUTES Array of parameters Comma separated list of values defined by a schema. See Option details section below. JSON is acceptable and preferred way for complex parameters --partition-table-ids PARTITION_TABLE_IDS IDs of associated partition tables Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --partition-tables PARTITION_TABLE_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 --password-hash PASSWORD_HASH Root password hash function to use, one of MD5, SHA256, SHA512, Base64 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated provisioning templates Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --provisioning-templates PROVISIONING_TEMPLATE_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 --release-name RELEASE_NAME --title TITLE Operating system title -h, --help Print help Option details: Following parameters accept format defined by its schema (bold are required): --os-parameters-attributes "name=string\,value=string, ... "
2.45. hammer ostree-branch
Manipulate ostree branches
Usage: hammer ostree-branch [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show an ostree branch list List ostree_branches Options: -h, --help Print help
2.45.1. hammer ostree-branch info
Show an ostree branch
Usage: hammer ostree-branch info [OPTIONS] Options: --id ID An ostree branch identifier --name NAME Name to search by --repository REPOSITORY_NAME Repository name to search by --repository-id REPOSITORY_ID Repository ID -h, --help Print help
2.45.2. hammer ostree-branch list
List ostree_branches
Usage: hammer ostree-branch list [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 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-id ENVIRONMENT_ID --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 --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 --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 ID --search SEARCH Search string -h, --help Print help
2.46. hammer package
Manipulate packages
Usage: hammer package [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show a package list List packages Options: -h, --help Print help
2.46.1. hammer package info
Show a package
Usage: hammer package info [OPTIONS] Options: --id ID A package identifier --name NAME Name to search by --repository REPOSITORY_NAME Repository name to search by --repository-id REPOSITORY_ID Repository ID -h, --help Print help
2.46.2. hammer package list
List packages
Usage: hammer package list [OPTIONS] Options: --available-for AVAILABLE_FOR Return packages that can be added to the specified object. Only the value 'content_view_version' is 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 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 --environment ENVIRONMENT_NAME Lifecycle environment name to search by --environment-id ENVIRONMENT_ID --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 --ids IDS Package identifiers 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 --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 --packages-restrict-applicable PACKAGES_RESTRICT_APPLICABLE Return packages that are applicable to one or more hosts (defaults to true If host_id is specified) One of true/false, yes/no, 1/0. --packages-restrict-latest PACKAGES_RESTRICT_LATEST Return only the latest version of each package One of true/false, yes/no, 1/0. --packages-restrict-upgradable PACKAGES_RESTRICT_UPGRADABLE Return packages that are upgradable on one or more hosts One of true/false, yes/no, 1/0. --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 ID --search SEARCH Search string -h, --help Print help
2.47. hammer package-group
Manipulate package groups
Usage: hammer package-group [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show a package group list List package_groups Options: -h, --help Print help
2.47.1. hammer package-group info
Show a package group
Usage: hammer package-group info [OPTIONS] Options: --id ID A package group identifier --name NAME Name to search by --repository REPOSITORY_NAME Repository name to search by --repository-id REPOSITORY_ID Repository ID -h, --help Print help
2.47.2. hammer package-group list
List package_groups
Usage: hammer package-group list [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 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-id ENVIRONMENT_ID --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 --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 --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 ID --search SEARCH Search string -h, --help Print help
2.48. hammer partition-table
Manipulate partition tables
Usage: hammer partition-table [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-operatingsystem Associate an operating system create Create a partition table delete Delete a partition table dump View partition table content info Show a partition table list List all partition tables remove-operatingsystem Disassociate an operating system update Update a partition table Options: -h, --help Print help
2.48.1. hammer partition-table add-operatingsystem
Associate an operating system
Usage: hammer partition-table add-operatingsystem [OPTIONS] Options: --id ID --name NAME Partition table name --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID -h, --help Print help
2.48.2. hammer partition-table create
Create a partition table
Usage: hammer partition-table create [OPTIONS] Options: --audit-comment AUDIT_COMMENT --file LAYOUT Path to a file that contains the partition layout --host-ids HOST_IDS Array of host IDs to associate with the partition table 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-ids HOSTGROUP_IDS Array of host group IDs to associate with the partition table 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 --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 Location name --location-id LOCATION_ID --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 Location title --location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locked LOCKED Whether or not the template is locked for editing One of true/false, yes/no, 1/0. --name NAME --operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the partition table 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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 --os-family OS_FAMILY --snippet SNIPPET One of true/false, yes/no, 1/0. -h, --help Print help
2.48.3. hammer partition-table delete
Delete a partition table
Usage: hammer partition-table delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Partition table name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.48.4. hammer partition-table dump
View partition table content
Usage: hammer partition-table dump [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Partition table name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.48.5. hammer partition-table info
Show a partition table
Usage: hammer partition-table info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Partition table name --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.48.6. hammer partition-table list
List all partition tables
Usage: hammer partition-table list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: default Values: true, false family string layout text location string location_id integer locked Values: true, false name string organization string organization_id integer snippet Values: true, false template text vendor string
2.48.7. hammer partition-table remove-operatingsystem
Disassociate an operating system
Usage: hammer partition-table remove-operatingsystem [OPTIONS] Options: --id ID --name NAME Partition table name --operatingsystem OPERATINGSYSTEM_TITLE Operating system title --operatingsystem-id OPERATINGSYSTEM_ID -h, --help Print help
2.48.8. hammer partition-table update
Update a partition table
Usage: hammer partition-table update [OPTIONS] Options: --audit-comment AUDIT_COMMENT --file LAYOUT Path to a file that contains the partition layout --host-ids HOST_IDS Array of host IDs to associate with the partition table 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-ids HOSTGROUP_IDS Array of host group IDs to associate with the partition table 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 --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 --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for complex parameters --locked LOCKED Whether or not the template is locked for editing One of true/false, yes/no, 1/0. --name NAME Partition table name --new-name NEW_NAME --operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the partition table 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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 --os-family OS_FAMILY --snippet SNIPPET One of true/false, yes/no, 1/0. -h, --help Print help
2.49. hammer ping
Get the status of the server
Usage: hammer ping [OPTIONS] Options: -h, --help Print help
2.50. hammer policy
Manipulate policies
Usage: hammer policy [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a Policy delete Delete a Policy info Show a Policy list List Policies update Update a Policy Options: -h, --help Print help
2.50.1. hammer policy create
Create a Policy
Usage: hammer policy create [OPTIONS] Options: --cron-line CRON_LINE Policy schedule cron line (only if period == “custom”) --day-of-month DAY_OF_MONTH Policy schedule day of month (only if period == “monthly”) --deploy-by DEPLOY_BY How the policy should be deployed Possible value(s): 'puppet', 'ansible', 'manual' --description DESCRIPTION Policy description --host-ids HOST_IDS Apply policy to 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 --hostgroup-ids HOSTGROUP_IDS Apply policy to host 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 --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 --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 Name to search by --location-id LOCATION_ID --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 --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 Policy name --organization ORGANIZATION_NAME Name to search by --organization-id ORGANIZATION_ID Organization ID --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 --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 --period PERIOD Policy schedule period (weekly, monthly, custom) --scap-content SCAP_CONTENT_TITLE SCAP content title --scap-content-id SCAP_CONTENT_ID --scap-content-profile-id SCAP_CONTENT_PROFILE_ID Policy SCAP content profile ID --tailoring-file TAILORING_FILE_NAME Tailoring file name --tailoring-file-id TAILORING_FILE_ID --tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file profile ID --weekday WEEKDAY Policy schedule weekday (only if period == “weekly”) -h, --help Print help
2.50.2. hammer policy delete
Delete a Policy
Usage: hammer policy delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.50.3. hammer policy info
Show a Policy
Usage: hammer policy info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.50.4. hammer policy list
List Policies
Usage: hammer policy list [OPTIONS] Options: --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --order ORDER Sort field and order, eg. ‘id DESC’ --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --page PAGE Paginate results --per-page PER_PAGE Number of entries per request --search SEARCH Filter results -h, --help Print help Search / Order fields: content string location string location_id integer name string organization string organization_id integer profile string tailoring_file string tailoring_file_profile string
2.50.5. hammer policy update
Update a Policy
Usage: hammer policy update [OPTIONS] Options: --cron-line CRON_LINE Policy schedule cron line (only if period == “custom”) --day-of-month DAY_OF_MONTH Policy schedule day of month (only if period == “monthly”) --deploy-by DEPLOY_BY How the policy should be deployed Possible value(s): 'puppet', 'ansible', 'manual' --description DESCRIPTION Policy description --host-ids HOST_IDS Apply policy to 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 --hostgroup-ids HOSTGROUP_IDS Apply policy to host 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 --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 --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 --id ID --location LOCATION_NAME Name to search by --location-id LOCATION_ID --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 --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 Policy name --new-name NEW_NAME Policy name --organization ORGANIZATION_NAME Name to search by --organization-id ORGANIZATION_ID Organization ID --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 --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 --period PERIOD Policy schedule period (weekly, monthly, custom) --scap-content SCAP_CONTENT_TITLE SCAP content title --scap-content-id SCAP_CONTENT_ID --scap-content-profile-id SCAP_CONTENT_PROFILE_ID Policy SCAP content profile ID --tailoring-file TAILORING_FILE_NAME Tailoring file name --tailoring-file-id TAILORING_FILE_ID --tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file profile ID --weekday WEEKDAY Policy schedule weekday (only if period == “weekly”) -h, --help Print help
2.51. hammer product
Manipulate products
Usage: hammer product [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a product delete Destroy a product info Show a product list List products remove-sync-plan Delete assignment sync plan and product set-sync-plan Assign sync plan to product synchronize Sync all repositories for a product update Updates a product Options: -h, --help Print help
2.51.1. hammer product create
Create a product
Usage: hammer product create [OPTIONS] Options: --description DESCRIPTION Product description --gpg-key GPG_KEY_NAME Name to search by --gpg-key-id GPG_KEY_ID Gpg key numeric identifier --label LABEL --name NAME Product name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert --ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert --ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key --sync-plan SYNC_PLAN_NAME Sync plan name to search by --sync-plan-id SYNC_PLAN_ID Sync plan numeric identifier -h, --help Print help
2.51.2. hammer product delete
Destroy a product
Usage: hammer product delete [OPTIONS] Options: --id ID Product numeric identifier --name NAME Product name to search by --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by -h, --help Print help
2.51.3. hammer product info
Show a product
Usage: hammer product info [OPTIONS] Options: --id ID Product numeric identifier --name NAME Product 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 -h, --help Print help
2.51.4. hammer product list
List products
Usage: hammer product list [OPTIONS] Options: --available-for AVAILABLE_FOR Interpret specified object to return only Products that can be associated With specified object. Only 'sync_plan' is supported. --custom CUSTOM Return custom products only One of true/false, yes/no, 1/0. --enabled ENABLED Return enabled products only One of true/false, yes/no, 1/0. --full-result FULL_RESULT Whether or not to show all results One of true/false, yes/no, 1/0. --include-available-content INCLUDE_AVAILABLE_CONTENT Whether to include available content attribute in results One of true/false, yes/no, 1/0. --name NAME Filter products 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 --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 --redhat-only REDHAT_ONLY Return Red Hat (non-custom) products only One of true/false, yes/no, 1/0. --search SEARCH Search string --subscription SUBSCRIPTION_NAME Subscription name to search by --subscription-id SUBSCRIPTION_ID Subscription identifier --sync-plan SYNC_PLAN_NAME Sync plan name to search by --sync-plan-id SYNC_PLAN_ID Sync plan numeric identifier -h, --help Print help
2.51.5. hammer product remove-sync-plan
Delete assignment sync plan and product
Usage: hammer product remove-sync-plan [OPTIONS] Options: --description DESCRIPTION Product description --gpg-key GPG_KEY_NAME Name to search by --gpg-key-id GPG_KEY_ID Gpg key numeric identifier --id ID Product numeric identifier --name NAME Product name to search by --new-name NEW_NAME Product name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert --ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert --ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key -h, --help Print help
2.51.6. hammer product set-sync-plan
Assign sync plan to product
Usage: hammer product set-sync-plan [OPTIONS] Options: --gpg-key GPG_KEY_NAME Name to search by --gpg-key-id GPG_KEY_ID Gpg key numeric identifier --id ID Product numeric identifier --name NAME Product name to search by --new-name NEW_NAME Product name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert --ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert --ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key --sync-plan SYNC_PLAN_NAME Sync plan name to search by --sync-plan-id SYNC_PLAN_ID Sync plan numeric identifier -h, --help Print help
2.51.7. hammer product synchronize
Sync all repositories for a product
Usage: hammer product synchronize [OPTIONS] Options: --async Do not wait for the task --id ID Product ID --name NAME Product 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 -h, --help Print help
2.51.8. hammer product update
Updates a product
Usage: hammer product update [OPTIONS] Options: --description DESCRIPTION Product description --gpg-key GPG_KEY_NAME Name to search by --gpg-key-id GPG_KEY_ID Gpg key numeric identifier --id ID Product numeric identifier --name NAME Product name to search by --new-name NEW_NAME Product name --organization ORGANIZATION_NAME Organization name to search by --organization-id ORGANIZATION_ID Organization ID --organization-label ORGANIZATION_LABEL Organization label to search by --ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert --ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert --ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key --sync-plan SYNC_PLAN_NAME Sync plan name to search by --sync-plan-id SYNC_PLAN_ID Sync plan numeric identifier -h, --help Print help
2.52. hammer proxy
Manipulate smart proxies
Usage: hammer proxy [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: content Manage the capsule content create Create a capsule delete Delete a capsule import-classes Import puppet classes from puppet Capsule info Show a capsule list List all capsules refresh-features Refresh capsule features update Update a capsule Options: -h, --help Print help
2.52.1. hammer proxy content
Manage the capsule content
Usage: hammer proxy 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 help
2.52.1.1. hammer proxy content add-lifecycle-environment
Add lifecycle environments to the capsule
Usage: hammer proxy 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 help
2.52.1.2. hammer proxy content available-lifecycle-environments
List the lifecycle environments not attached to the capsule
Usage: hammer proxy content available-lifecycle-environments [OPTIONS] Options: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.52.1.3. hammer proxy content cancel-synchronization
Cancel running capsule synchronization
Usage: hammer proxy content cancel-synchronization [OPTIONS] Options: --id ID Id of the capsule --name NAME Name to search by -h, --help Print help
2.52.1.4. hammer proxy content info
Get current capsule synchronization status
Usage: hammer proxy content info [OPTIONS] Options: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.52.1.5. hammer proxy content lifecycle-environments
List the lifecycle environments attached to the capsule
Usage: hammer proxy content lifecycle-environments [OPTIONS] Options: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.52.1.6. hammer proxy content remove-lifecycle-environment
Remove lifecycle environments from the capsule
Usage: hammer proxy 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 help
2.52.1.7. hammer proxy content synchronization-status
Get current capsule synchronization status
Usage: hammer proxy content synchronization-status [OPTIONS] Options: --id ID Id of the capsule --name NAME 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 -h, --help Print help
2.52.1.8. hammer proxy content synchronize
Synchronize the content to the capsule
Usage: hammer proxy 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 help
2.52.2. hammer proxy create
Create a capsule
Usage: hammer proxy create [OPTIONS] Options: --download-policy DOWNLOAD_POLICY Download Policy of the capsule, must be one of immediate, on_demand, Background, inherit --location LOCATION_NAME Location name --location-id LOCATION_ID --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 Location title --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 Organization name --organization-id ORGANIZATION_ID Organization ID --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 Organization title --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 help
2.52.3. hammer proxy delete
Delete a capsule
Usage: hammer proxy delete [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help
2.52.4. hammer proxy import-classes
Import puppet classes from puppet Capsule
Usage: hammer proxy import-classes [OPTIONS] Options: --dryrun Do not run the import --environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment 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 Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title --puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name --puppet-environment-id PUPPET_ENVIRONMENT_ID -h, --help Print help
2.52.5. hammer proxy info
Show a capsule
Usage: hammer proxy info [OPTIONS] Options: --id ID --location LOCATION_NAME Location name --location-id LOCATION_ID --location-title LOCATION_TITLE Location title --name NAME Name to search by --organization ORGANIZATION_NAME Organization name --organization-id ORGANIZATION_ID Organization ID --organization-title ORGANIZATION_TITLE Organization title -h, --help Print help