Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Hammer CLI Guide

Red Hat Satellite 6.5

Using Hammer, the Satellite's CLI tool

Red Hat Satellite Documentation Team

Abstract

This document describes how to use the Hammer CLI tool to configure and manage Red Hat Satellite.

Chapter 1. Introduction to Hammer
Copy link

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
Copy link

View the full list of hammer options and subcommands by executing: 

$ hammer --help
Copy to Clipboard Toggle word wrap

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

$ hammer organization --help
Copy to Clipboard Toggle word wrap

You can search the help output using grep, or redirect it to a text viewer, for example: 

$ hammer | less
Copy to Clipboard Toggle word wrap

1.2. Authentication
Copy link

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
Copy link

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
    Copy to Clipboard Toggle word wrap

    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
    Copy to Clipboard Toggle word wrap

    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]
    Copy to Clipboard Toggle word wrap

  • To see the current status of the session, enter the following command: 

    # hammer auth status
    Copy to Clipboard Toggle word wrap

  • To end the session, enter the following command: 

    # hammer auth logout
    Copy to Clipboard Toggle word wrap

1.2.2. Hammer Configuration File
Copy link

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

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

:foreman:
 :username: 'username'
 :password: 'password'
Copy to Clipboard Toggle word wrap
Important

Use only spaces for indentation in hammer configuration files. Do not use tabs for indentation in hammer configuration files.

1.2.3. Command Line
Copy link

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
Copy to Clipboard Toggle word wrap
Note

Examples in this guide assume having saved credentials in the configuration file, or using a hammer authentication session.

1.3. Using Standalone Hammer
Copy link

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.5-rpms

Procedure

On a host, complete the following steps to install hammer:

  1. Enable the Red Hat Enterprise Linux, Red Hat Software Collections and Red Hat Satellite Tools repositories: 

    # subscription-manager repos --enable=rhel-7-server-rpms \
--enable=rhel-server-rhscl-7-rpms \
--enable=rhel-7-server-satellite-tools-6.5-rpms
    Copy to Clipboard Toggle word wrap

  2. Install hammer: 

    # yum install tfm-rubygem-hammer_cli_katello
    Copy to Clipboard Toggle word wrap

  3. Edit the :host: entry in the /etc/hammer/cli.modules.d/foreman.yml file to include the Satellite IP address or FQDN. 

    :host: 'https://satellite.example.com'
    Copy to Clipboard Toggle word wrap

1.4. Setting a Default Organization and Location
Copy link

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:

  1. To set a default organization, enter the following command: 

    # hammer defaults add --param-name organization \
--param-value "Your_Organization"
    Copy to Clipboard Toggle word wrap

    You can find the name of your organization with the hammer organization list command.

  2. Optional: To set a default location, enter the following command: 

    # hammer defaults add --param-name location \
--param-value 'Your_Location"
    Copy to Clipboard Toggle word wrap

    You can find the name of your location with the hammer location list command.

  3. To verify the currently specified default settings, enter the following command: 

    # hammer defaults list
    Copy to Clipboard Toggle word wrap

1.5. Configuring Hammer
Copy link

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
Copy to Clipboard Toggle word wrap
Note

Loading configuration for many CLI modules can slow down the execution of hammer commands. In such a case, consider disabling CLI modules that are not regularly used.

Apart from saving credentials as described in Section 1.2, “Authentication”, you can set several other options in the ~/.hammer/ configuration directory. For example, you can change the default log level and set log rotation with the following directives in ~/.hammer/cli_config.yml. Note that these directives affect only the current user and are not applied globally. 

:log_level: 'warning'
:log_size: 5 #in MB
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

This setting is an equivalent of the --per-page Hammer option.

1.6. Configuring Hammer Logging
Copy link

You can set hammer to log debugging information for various Satellite components.

You can set debug or normal configuration options for all Satellite components.

Note

After changing hammer’s logging behavior, you must restart Satellite services. 

# satellite-maintain service restart
Copy to Clipboard Toggle word wrap

  • To set debug level for all components, use the following command: 

    # hammer admin logging --all --level-debug
# satellite-maintain service restart
    Copy to Clipboard Toggle word wrap

  • To set production level logging, use the following command: 

    # hammer admin logging --all --level-production
# satellite-maintain service restart
    Copy to Clipboard Toggle word wrap

  • To list the currently recognized components, that you can set logging for: 

    # hammer admin logging --list
    Copy to Clipboard Toggle word wrap

  • To list all available logging options: 

    # hammer admin logging --help

Usage:
    hammer admin logging [OPTIONS]
    Copy to Clipboard Toggle word wrap

1.7. Invoking the Hammer Shell
Copy link

You can issue hammer commands through the interactive shell. To invoke the shell, issue the following command: 

$ hammer shell
Copy to Clipboard Toggle word wrap

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
Copy link

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
Copy to Clipboard Toggle word wrap

Output in CSV format is useful for example when you need to parse IDs and use them in a for loop (see ] or xref:exam-CLI_Guide-Assigning_a_Synchronization_Plan_to_Multiple_Products[).

Several other formatting options are available with the --output option: 

$ hammer --output output_format organization list
Copy to Clipboard Toggle word wrap

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
Copy link

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
Copy link

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
Copy to Clipboard Toggle word wrap

You can use hammer to create, edit, and manage organizations, locations, and repositories. For web UI equivalents of the following procedures see Managing Organizations and Importing Red Hat Content in the Content Management Guide.

2.1. Organizations
Copy link

Organization in Red Hat Satellite is an isolated collection of systems, content, and other functionality within a Satellite deployment. This section shows how to create and modify organizations using hammer.

2.1.1. Creating an Organization
Copy link

Use the following command to create an organization: 

$ hammer organization create \
--name "org_name" \
--label "org_label" \
--description "org_description"
Copy to Clipboard Toggle word wrap

Where:

  • org_name is the name of the organization. This parameter is required.
  • org_label is the organization label used in command-line applications such as subscription-manager. Labels cannot contain white space and you cannot change them later. If not specified, label is generated automatically from the organization name (white space is replaced with underscores).
  • org_description is a short description of the organization. This parameter is not required, but it can help you to manage a large number of organizations.

You can fully configure an organization while creating it (issue hammer organization create --help to see the options). Also, you can modify an existing organization using the hammer organization update command.

Example 2.1. Creating and Updating ACME Organization

The following example shows how to create an organization named ACME: 

$ ORG="ACME"
$ hammer organization create \
--name $ORG \
--description "Example_organization"
Copy to Clipboard Toggle word wrap

This command assigns a compute resource to the organization: 

$ hammer organization update \
--name $ORG \
--compute-resource-ids 1
Copy to Clipboard Toggle word wrap

Many tasks you can perform in the Satellite Server are specific to an organization. Hammer commands provide three ways to identify an organization: by using the organization, organization-label, or organization-id option. To find the organization ID, use the following command: 

$ hammer organization list
Copy to Clipboard Toggle word wrap

If your organization name is long, consider storing it in a shell variable. You can use this variable in Hammer commands. For example: 

$ ORG = "Red Hat Enterprise Linux Developer Team"
$ hammer product list --organization $ORG
Copy to Clipboard Toggle word wrap

This approach is used in examples in this guide.

If you mostly manage a single organization, you can set it as default. For information on how to do that, see Section 1.4, “Setting a Default Organization and Location”.

2.1.3. Uploading a Manifest
Copy link

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

$ hammer subscription upload \
--organization-label org_label \
--file path_to_manifest
Copy to Clipboard Toggle word wrap

Example 2.2. Uploading a Manifest to ACME Organization

The following example shows how to upload a Subscription Manifest file to the ACME organization (assuming the organization name is stored in a shell variable): 

$ hammer subscription upload --organization $ORG --file /tmp/manifest.zip
Copy to Clipboard Toggle word wrap

To view the subscriptions imported with the manifest, issue: 

$ hammer subscription list --organization $ORG
Copy to Clipboard Toggle word wrap

2.2. Locations
Copy link

Location in Red Hat Satellite is collection of default settings that represent a physical place. This section shows how to create locations using hammer.

2.2.1. Creating a Location
Copy link

Use the following command to create a location: 

$ hammer location create --name location_name
Copy to Clipboard Toggle word wrap

Example 2.3. Creating Multiple Locations Using a Script

The following Bash script creates three locations (london, munich, boston), and assigns them to the ACME organization. 

ORG="ACME"
LOCATIONS="london munich boston"

for LOC in ${LOCATIONS}
do
  hammer location create --name "${LOC}"
  hammer location add-organization --name "${LOC}" --organization "${ORG}"
done
Copy to Clipboard Toggle word wrap

Run hammer location --help to view all possible location related operations.

2.3. Repositories
Copy link

Repository provides storage for a collection of content. This section shows how to enable and synchronize repositories using hammer.

2.3.1. Enabling a Repository
Copy link

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

$ hammer repository-set enable \
--organization-label org_label \
--product "product_name" \
--basearch "base_architecture" \
--releasever "release_version" \
--name "repository_name"
Copy to Clipboard Toggle word wrap

Example 2.4. Enabling a Red Hat Enterprise Linux Repository

The following command enables the Red Hat Enterprise Linux 7 Server repository for the organization: 

$ hammer repository-set enable \
--organization $ORG \
--product "Red Hat Enterprise Linux Server" \
--basearch "x86_64" \
--releasever "7Server" \
--name "Red Hat Enterprise Linux 7 Server (RPMs)"
Copy to Clipboard Toggle word wrap

Run hammer repository-set --help to view all possible repository related operations. Also see hammer repository --help.

2.3.2. Synchronizing a Repository
Copy link

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

$ hammer repository synchronize \
--product "product_name" \
--name "repo_name" \
--organization-label org_label \
--async
Copy to Clipboard Toggle word wrap

Note that if you have created Content Views, multiple repositories with the same name can exist within a single organization. In such a case, use the --id option to identify the repository you want to synchronize (issue hammer repository list to find repository IDs).

Example 2.5. Synchronizing a Red Hat Enterprise Linux Repository

The following command performs a single synchronization of the Red Hat Enterprise Linux 7 Server repository in the organization: 

$ hammer repository synchronize \
--product "Red Hat Enterprise Linux Server" \
--name "Red Hat Enterprise Linux 7 Server (RPMs)" \
--organization $ORG \
--async
Copy to Clipboard Toggle word wrap

The task ID is displayed after executing the above command: 

Repository is being synchronized in task 640bb71f-0ce5-40a3-a675-425a4acacceb
Copy to Clipboard Toggle word wrap

To view the progress of the task, issue: 

$ hammer task progress --id 640bb71f-0ce5-40a3-a675-425a4acacceb
Copy to Clipboard Toggle word wrap

After finishing the first synchronization, the repository is added to the list of repositories mirrored on Satellite Server. Execute the following command to see the list: 

$ hammer repository list --organization $ORG
Copy to Clipboard Toggle word wrap

You can also synchronize all repositories within a product as follows: 

$ hammer product synchronize \
--organization-label org_label \
--name "product_name" \
--async
Copy to Clipboard Toggle word wrap

With the --async option, the repository synchronization runs in the background, which for example allows you to enable and synchronize several repositories in parallel.

Example 2.6. Synchronizing All Repositories in ACME Organization

The following Bash script synchronizes all repositories within the ACME organization. 

ORG="ACME"

for i in $(hammer --csv repository list --organization $ORG | grep -vi '^ID' | awk -F, {'print $1'})
do
  hammer repository synchronize --id ${i} --organization $ORG --async
done
Copy to Clipboard Toggle word wrap

2.3.3. Creating a Synchronization Plan
Copy link

Product in Red Hat Satellite is a collection of repositories that acts as the smallest unit of the synchronization process. You can create a synchronization plan to automatically update repositories of a selected product in a given time interval.

To define a synchronization plan, issue the following command: 

$ hammer sync-plan create \
--name "sync_plan_name" \
--enabled=true \
--interval repetition_interval \
--organization-label org_label \
--sync-date "initial_sync"
Copy to Clipboard Toggle word wrap

Replace repetition_interval with hourly, daily, or weekly. Replace initial_sync with the date and time of the initial synchronization in the form of "YYYY-MM-DD HH:MM:SS".

Example 2.7. Creating a Synchronization Plan

The following command creates a daily synchronization schedule for the ACME organization, that runs at 3 a.m., starting from 15 January 2016: 

$ hammer sync-plan create \
--name "daily sync at 3 a.m." \
--enabled=true \
--interval daily \
--organization $ORG \
--sync-date "2016-01-15 03:00:00"
Copy to Clipboard Toggle word wrap

To associate the synchronization plan with a product, issue the following command: 

$ hammer product set-sync-plan \
--organization-label org_label \
--name "product_name" \
--sync-plan "sync_plan_name"
Copy to Clipboard Toggle word wrap

Example 2.8. Assigning a Synchronization Plan to Multiple Products

The following Bash script selects the products in the ACME organization that have been synchronized at least once and contain at least one repository and assigns them a synchronization plan named "daily sync at 3 a.m.". 

ORG="ACME"
SYNC_PLAN="daily sync at 3 a.m."

for i in $(hammer --csv product list --organization $ORG --per-page 999 | grep -vi '^ID' | grep -vi not_synced | awk -F, {'{ if ($5!=0) print $1}'})
do
  hammer product set-sync-plan --sync-plan $SYNC_PLAN --organization $ORG --id $i
done
Copy to Clipboard Toggle word wrap

After executing the script, issue the following command to see which products have been assigned the synchronization plan: 

$ hammer product list --organization $ORG --sync-plan "daily sync at 3 a.m."
Copy to Clipboard Toggle word wrap

To view synchronization plans available for a selected organization, issue the following command: 

$ hammer sync-plan list --organization-label org_label
Copy to Clipboard Toggle word wrap

For more details on working with products and synchronization plans see the output of hammer sync-plan --help and hammer product --help.

2.3.4. Creating a Custom Repository
Copy link

After enabling a Red Hat repository, the corresponding product is created automatically. To enable a repository with custom packages, you first need to manually create a product for this repository.

Use the following command to create a custom product: 

$ hammer product create --name "product_name" --organization-label org_label
Copy to Clipboard Toggle word wrap

The following command creates a new repository under the custom product: 

$ hammer repository create \
--name "repo_name" \
--organization-label org_label \
--product "product_name" \
--content-type cont_type --publish-via-http true \
--url "repo_url"
Copy to Clipboard Toggle word wrap

Replace the example values with your own details, in particular:

  • cont_type specifies the type of content in the repository, choose one of yum, puppet, or docker.
  • repo_url specifies the URL on which the repository will be available, valid only if ` --publish-via-http` is enabled.

To upload packages to a custom repository, issue the following command: 

$ hammer repository upload-content \
 --organization-label org_label \
 --id "repo_id" \
--path path_to_dir
Copy to Clipboard Toggle word wrap

Replace path_to_dir with the path to the directory with content (RPM packages, Puppet modules, or Docker images) to be added to the custom repository.

Chapter 3. Managing Content Life Cycle
Copy link

This section shows how to use hammer to create Content Views and to promote them through life cycle environments.

3.1. Creating a Life Cycle Environment
Copy link

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

$ hammer lifecycle-environment create \
--name env_name \
--description "env_description" \
--organization-label org_label \
--prior prior_env_name
Copy to Clipboard Toggle word wrap

Example 3.1. Creating a Life Cycle Environment

This example shows how to create a new environment based on Library for the ACME organization (assuming the organization name is stored in a shell variable): 

$ hammer lifecycle-environment create \
--name Development \
--description "Initial testing" \
--organization $ORG \
--prior Library
Copy to Clipboard Toggle word wrap

You can create another life cycle environment based on Development using the --prior option.

To view existing life cycle environments, issue the following command: 

$ hammer lifecycle-environment list --organization-label org_label
Copy to Clipboard Toggle word wrap

The output of the above command can look as follows: 

---|-------------|------------
ID | NAME        | PRIOR
---|-------------|------------
2  | Library     |
5  | Development | Library
6  | Testing     | Development
---|-------------|------------
Copy to Clipboard Toggle word wrap

For more information on commands related to life cycle environments, see the output of hammer lifecycle-environment --help.

3.2. Creating a Content View
Copy link

Content Views are subsets of content from the Library created by intelligent filtering. You can publish and promote Content Views into life cycle environments that make content available for different uses (typically Dev, QA, and Production). To create a Content View, issue the following command: 

$ hammer content-view create \
--name cv_name \
--repository-ids repo_ID1,repo_ID2,repo_ID3 \
--description "cv_description" \
--organization-label org_label
Copy to Clipboard Toggle word wrap

The --repository-ids option adds the selected repositories to the Content View, use the hammer repository list command to find the IDs. It is also possible to omit this option to create an empty Content View that you can modify later using the update or add-repository subcommands.

Example 3.2. Creating a Content View

The following example creates a Content View under the ACME organization and assigns it three repositories: 

$ hammer content-view create \
--name cv-rhel7-server \
--repository-ids 1,2,3 \
--description "Initial CV for RHEL 7" \
--organization $ORG
Copy to Clipboard Toggle word wrap

Example 3.3. Creating a Composite Content View

A Composite Content View is comprised of one or more Content Views. This example shows how to create a Composite Content View from two existing Content Views: 

$ hammer content-view create \
--name ccv-rhel7-server-scl \
--description "CCV for RHEL7 and Software Collections" \
--organization $ORG \
--composite --component-ids 2,6 \
--auto-publish yes
Copy to Clipboard Toggle word wrap

Find the IDs for the --component-ids option by executing hammer content-view list. When the --auto-publish option is set to yes, the Composite Content View is automatically republished when a Content View it includes is republished.

There are three content types you can add to the Content View: RPM packages, Puppet modules, and Docker images.

3.2.1. Adding Repositories to a Content View
Copy link

Use the following command to add repositories to an existing Content View: 

$ hammer content-view update \
--repository-ids repo_ID1,repo_ID2... \
--name cv_name \
--organization-label org_label
Copy to Clipboard Toggle word wrap

The above command is useful for populating an empty Content View with repositories. Note that it will overwrite any existing repositories, therefore to increase the number of repositories in a Content View, use: 

$ hammer content-view add-repository \
--organization-label org_label \
--name cv_name \
--repository-id repo_ID
Copy to Clipboard Toggle word wrap

Similarly, you can use the remove-repository subcommand to remove a repository from the Content View. Use hammer content-view info to inspect repositories in a Content View.

Example 3.4. Filtering Packages for a Content View – Excluding a Package

Filters allow you to select a subset of packages from a repository (either by including or excluding) to create customized Content Views. This example shows how to create a filter to exclude the emacs package from the cv-rhel7-server Content View.

First create a filter for the Content View in the organization: 

$ hammer content-view filter create \
--type rpm \
--name exclude-emacs \
--description "Excluding emacs package" \
--inclusion false \
--organization $ORG \
--repository-ids 1,2,3 \
--content-view cv-rhel7-server
Copy to Clipboard Toggle word wrap

Find the repository IDs by executing hammer repository list. Create a rule to exclude packages with name starting with "emacs" and add it to the filter as follows: 

$ hammer content-view filter rule create \
--name "emacs*" \
--organization $ORG \
--content-view cv-rhel7-server \
--content-view-filter exclude-emacs
Copy to Clipboard Toggle word wrap

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

$ hammer content-view filter rule list \
--content-view cv-rhel7-server \
--content-view-filter exclude-emacs \
--organization $ORG
Copy to Clipboard Toggle word wrap

Example 3.5. Filtering Packages for a Content View – Limiting Errata by Date

This example shows how to create a filter to exclude errata released before a specific date from the cv-rhel7-server Content View. For more information on errata management see Chapter 8, Managing Errata. Create a filter for the Content View as follows: 

$ hammer content-view filter create \
--type erratum \
--name limit-errata-by-date \
--description "Excluding errata by date" \
--inclusion false \
--organization $ORG \
--repository-ids 1,2,3 \
--content-view cv-rhel7-server
Copy to Clipboard Toggle word wrap

Create a rule to exclude errata with a name starting with "emacs" and add it to the filter as follows: 

$ hammer content-view filter rule create \
--end-date YYYY-MM-DD \
--organization $ORG \
--content-view cv-rhel7-server \
--content-view-filter limit-errata-by-date \
--types enhancement,bugfix,security
Copy to Clipboard Toggle word wrap

3.2.2. Adding Puppet Modules to a Content View
Copy link

To add a Puppet module to a Content View, first upload this module to a Puppet repository within a custom product. Use the commands from Section 2.3.4, “Creating a Custom Repository” to create a product with a repository, and to upload a Puppet module to the repository.

To add a Puppet module to a Content View, issue the following command: 

$ hammer content-view puppet-module add \
--content-view cv_name \
--name module_name
Copy to Clipboard Toggle word wrap

Example 3.6. Adding a Puppet Module to a Content View

This example shows how to add a Puppet module from an external source to the cv-rhel7-server Content View.

  1. Download the concat module (that constructs files from multiple text fragments) from Puppet Forge: 

    $ wget -O /tmp/puppetlabs-concat-1.2.5.tar.gz https://forgeapi.puppetlabs.com
/v3/files/puppetlabs-concat-1.2.3.tar.gz
    Copy to Clipboard Toggle word wrap

  2. Create a Puppet repository under the ACME-puppet product and upload the module to this repository (the example assumes repository ID is 6): 

    $ hammer product create \
--name "ACME-puppet" \
--organization $ORG
    Copy to Clipboard Toggle word wrap 
    $ hammer repository create \
--organization $ORG \
--product ACME-puppet \
--name "ACME Puppet Repository" \
--content-type puppet \
--url "https://forge.puppetlabs.com/"
    Copy to Clipboard Toggle word wrap 
    $ hammer repository upload-content \
--organization $ORG \
--product ACME-puppet \
--id 6 \
--path /tmp/puppetlabs-concat-1.2.5.tar.gz
    Copy to Clipboard Toggle word wrap

  3. Add the module to the Content View using the id, name, or author parameters. To find the exact values, enter: 

    $ hammer puppet-module list --organization $ORG
---|--------|------------|--------
ID | NAME   | AUTHOR     | VERSION
---|--------|------------|--------
1  | concat | puppetlabs | 1.2.3
---|--------|------------|--------
    Copy to Clipboard Toggle word wrap

    To add the module to the Content View, issue: 

    $ hammer content-view puppet-module add \
--name concat \
--content-view cv-rhel7-server \
--organization $ORG
    Copy to Clipboard Toggle word wrap

    To verify if the module has been added successfully, issue the following command: 

    $ hammer content-view puppet-module list \
--content-view cv-rhel7-server \
--organization $ORG
    Copy to Clipboard Toggle word wrap

3.2.3. Adding Docker Images to a Content View
Copy link

You can upload Docker images directly to the dedicated repository as follows: 

$ hammer repository upload-content --path image_archive --id repo_id
Copy to Clipboard Toggle word wrap

Replace image_archive with a path to the archive containing the Docker image. Use repo_id to identify the repository of docker content type. Then you can add this repository to the Content View.

3.3. Publishing a Content View
Copy link

By publishing a Content View you make it visible and usable by hosts. Use the following command to publish a selected Content View: 

$ hammer content-view publish \
--id cv_ID \
--organization-label org_label \
--async
Copy to Clipboard Toggle word wrap

Find the cv_ID of the Content View to be published in the output of the hammer content-view list command. Published Content Views become available in the Library environment. To verify the Content View status, issue the following command: 

$ hammer content-view info --id cv_ID
Copy to Clipboard Toggle word wrap

3.4. Promoting a Content View
Copy link

Promoting is the act of moving a Content View from one life cycle environment to another. To do so, issue the following command. 

$ hammer content-view version promote \
--content-view cv_name \
--organization-label org_label \
--to-lifecycle-environment env_name
Copy to Clipboard Toggle word wrap

Here, env_name stands for the name of target life cycle environment.

Example 3.7. Promoting a Content View Through the Life Cycle Environment Path

The following Bash script promotes the selected Content View from Library through all life cycle environments in the ACME organization: 

ORG="ACME"
CV_ID=1

for i in $(hammer --csv lifecycle-environment list --organization $ORG | grep -vi '^ID' | awk -F, {'print $1'} | sort -n)
do
   hammer content-view version promote --organization $ORG --to-lifecycle-environment-id $i --id $CV_ID
done
Copy to Clipboard Toggle word wrap

To verify if the Content View has been promoted correctly, issue the following command: 

$ hammer content-view version info --id 1
Copy to Clipboard Toggle word wrap

Incremental updates enable modifying a published Content View without the need to promote a new Content View version through the life cycle environment. As a result of the incremental update, a new minor Content View version is created. Incremental updates are useful for fast emergency updates, you can use them to add errata, packages, or Puppet modules.

To create an incremental update adding new packages to a Content View, issue: 

$ hammer content-view version incremental-update \
--content-view-version-id cv_ID \
--packages pkg_name1,pkg_name2 \
--lifecycle-environment-ids env_ID1, env_ID2,... \
--organization-id org_ID
Copy to Clipboard Toggle word wrap

Find the Content View version ID in the output of hammer Content View version list. Instead of supplying packages with the --packages option, you can add Puppet modules with --puppet-modules, or errata with --errata-ids (see Example 3.8, “Adding Errata to a Content View using an Incremental Update”). For more information on working with incremental updates issue hammer content-view version incremental-update --help.

Example 3.8. Adding Errata to a Content View using an Incremental Update

This example shows how to apply an erratum to a host (named auth01.example.com) by creating an incremental update of its Content View: 

$ hammer content-view version incremental-update \
--content-view-version-id 4 \
--errata-ids 8c3801f6-12a7-4a62-83f4-addbb1f34ce6 \
--lifecycle-environments Infrastructure \
--organization $ORG
Copy to Clipboard Toggle word wrap

To find the required information for the above command, perform the following steps:

  1. Find the Organization ID and name by executing: 

    $ hammer organization list
    Copy to Clipboard Toggle word wrap

  2. Find the Content View your host is registered to as well as its life cycle environment by executing: 

    $ hammer host info --name auth01.example.com
    Copy to Clipboard Toggle word wrap

  3. Then find the current version of the Content View (assuming Content View name RHEL7_Infra): 

    $ hammer content-view info --name "RHEL7_Infra" --organization $ORG
    Copy to Clipboard Toggle word wrap

  4. Find the IDs of errata you want to apply in the list of applicable errata in Library: 

    $ hammer erratum list --content-view-version-id 4 --organization $ORG
$ hammer host errata list --host auth01.example.com
    Copy to Clipboard Toggle word wrap

Chapter 4. Managing Activation Keys
Copy link

Activation keys define the subscription properties of a host. Using an activation key improves the speed of host registration. For web UI equivalents of the following procedures see Managing Activation Keys in the Content Management Guide.

There are three possible use cases for activation keys:

Note

Activation keys are only used when hosts are registered. If changes are made to an activation key, it is only applicable to hosts that are registered with the amended activation key in the future. The changes are not made to existing hosts.

To create an activation key, issue the following command: 

$ hammer activation-key create --name ak_name \
--organization-label org_label \
--content-view cv_name \
--lifecycle-environment lc_name
Copy to Clipboard Toggle word wrap

Note that the Content View has to be published. To see the full list of operations related to activation keys, use the hammer activation-key --help command.

To add a subscription to the activation key, issue the following command: 

$ hammer activation-key add-subscription \
--id ak_ID \
--subscription-id sub_ID
Copy to Clipboard Toggle word wrap

To find the activation key ID, use hammer activation-key list; to find the subscription ID, use hammer subscription list.

Example 4.1. Creating an Empty Activation Key

This example shows how to create an activation key that directs the associated hosts to automatically attach a best fitting subscription: 

$ hammer activation-key create \
--name "automatically attach key" \
--organization $ORG \
--content-view cv-rhel7-server \
--lifecycle-environment Testing
Copy to Clipboard Toggle word wrap

As a result, hosts registered in the cv-rhel7-server Content View are associated with this activation key.

Example 4.2. Creating an Activation Key with Custom Subscription Pool

This example shows how to create an activation key that will direct the associated hosts to automatically attach a best fitting subscription from the list specified in the activation key.

First create an empty activation key: 

$ hammer activation-key create \
--name "custom pool key" \
--organization $ORG \
--content-view cv-rhel7-server \
--lifecycle-environment Testing
Copy to Clipboard Toggle word wrap

Add a subscription to the activation key: 

$ hammer activation-key add-subscription \
--name "custom pool key" \
--subscription-id 1
Copy to Clipboard Toggle word wrap

Keep repeating this step to add all required subscriptions to the activation key.

Example 4.3. Creating an Activation Key with Mandatory Subscription List

This example shows how to create an activation key that will direct the associated hosts to attach all subscriptions specified in the activation key.

First, create an activation key and add all required subscriptions to it. Follow the steps from Example 4.2, “Creating an Activation Key with Custom Subscription Pool”.

Then disable the auto-attach property of the activation key: 

$ hammer activation-key update \
--organization $ORG \
--name "mandatory subs key" \
--auto-attach false
Copy to Clipboard Toggle word wrap
Important

You can assign several activation keys to a Content View. In case of conflicting settings, the values from the last specified key take precedence. You can specify the order of precedence by setting a host group parameter as follows: 

$ hammer hostgroup set-parameter \
--name kt_activation_keys \
--value name_of_first_key, name_of_second_key,... \
--hostgroup hostgroup_name
Copy to Clipboard Toggle word wrap

Chapter 5. Configuring Provisioning Environment
Copy link

This section shows how to configure various stages of your provisioning environment using hammer. For web UI equivalents of the following procedures see Configuring Provisioning Resources in the Provisioning Guide.

5.1. Domains
Copy link

Domains in Red Hat Satellite represent DNS zones. Satellite has the ability to assign domain names with Red Hat Satellite Capsule Server DNS. This provides users with a means to group and name hosts within a particular domain and associate them with parameters and Puppet variables.

To create a new domain, issue the following command: 

$ hammer domain create --name domain_name
Copy to Clipboard Toggle word wrap

You can associate the newly created domain to organizations and locations using the hammer organization add-domain or hammer location add-domain commands. To view the status of a domain, issue the following command: 

$ hammer domain info --name domain_name
Copy to Clipboard Toggle word wrap

5.2. Subnets
Copy link

Subnets in Red Hat Satellite define networks specified for groups of systems. Subnets use standard IP-address settings to define the network and use the Red Hat Satellite Capsule Server’s DHCP features to assign IP addresses to systems within the subnet. The following command contains the minimal set of options required for subnet creation: 

$ hammer subnet create \
--name subnet_name \
--organization-ids org_ID1,org_ID2... \
--location-ids loc_ID1,loc_ID2... \
--domain-ids dom_ID1,dom_ID2... \
--boot-mode boot_mode \
--network network_address \
--mask netmask \
--ipam ipam
Copy to Clipboard Toggle word wrap

Here, boot_mode is one of Static or DHCP, ipam is one of DHCP, Internal DB, or None. If using DHCP, you can set the IP range with the --from and --to options. For the full list of configurable options, see the output of the hammer subnet create --help command.

5.3. Architectures
Copy link

Architecture in Satellite represents a logical grouping of hosts and operating systems. To view the architectures, issue the following command: 

$ hammer architecture list
Copy to Clipboard Toggle word wrap

Architectures are created by Satellite automatically when hosts are registered in Puppet, therefore it is rarely needed to create them manually (even though hammer provides this option).

5.4. Compute Resources
Copy link

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

$ hammer compute-resource create \
--name cr_name \
--organization-ids org_ID1,org_ID2... \
--location-ids loc_ID1,loc_ID2... \
--provider provider
Copy to Clipboard Toggle word wrap

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

5.5. Installation Media
Copy link

Installation media (ISO images) provide content for kickstart trees and new host installations in Red Hat Satellite. To list the media, issue the following command: 

$ hammer medium list
Copy to Clipboard Toggle word wrap

To add a new medium, issue the following command: 

$ hammer medium create --name medium_name --path path_to_medium
Copy to Clipboard Toggle word wrap

You can make the medium available to organizations and locations directly when adding it (see the output of the hammer medium create --help command), or later by using the hammer organization add-medium or hammer location add-medium commands.

5.6. Partition Tables
Copy link

Partition tables define the partitions and file system layout for new installations when provisioning systems. Red Hat Satellite provides default partition tables associated with operating system families, to view them, issue the following command: 

$ hammer partition-table list
Copy to Clipboard Toggle word wrap

To create a new partition table, issue the following command: 

$ hammer partition-table create \
--name table_name \
--file path_to_layout_file \
--os-family os_family
Copy to Clipboard Toggle word wrap

See the output of the hammer partition-table --help command for other subcommands.

5.7. Provisioning Templates
Copy link

Provisioning templates provide the systematic means to run unattended installations. To view the provisioning templates provided by Satellite, enter the following command: 

$ hammer template list
Copy to Clipboard Toggle word wrap

To add a new template, enter the following command: 

$ hammer template create --name template_name --file path_to_template_file
Copy to Clipboard Toggle word wrap

See the output of the hammer template --help command for other subcommands.

5.7.1. Importing Templates
Copy link

You can use the hammer import-templates command to import templates from a repository of your choice. You can use different protocols to point to your repository, for example /tmp/dir, git://example.com, https://example.com, and ssh://example.com.

For better indexing and management of your templates, use --prefix to set a category for your templates. To select certain templates from a large repository, use --filter to define the title of the templates that you want to import. For example --filter '.*Ansible Default$' imports various Ansible Default templates.

To import a template from a repository, enter the following command: 

$ hammer import-templates \
    --prefix '[Custom Index] ' \
    --filter '.*Template Name$' \
    --repo https://github.com/examplerepo/exampledirectory \
    --branch my_branch \
    --organization 'Default Organization'
Copy to Clipboard Toggle word wrap

5.7.2. Exporting templates
Copy link

You can use the hammer export-templates command to export templates to a Git repository.

  1. Clone a local copy of your Git repository: 

    $ git clone https://github.com/theforeman/community-templates /custom/templates
    Copy to Clipboard Toggle word wrap

  2. Change the owner of your local directory to the foreman user, and change the SELinux context with the following commands: 

    # chown -R foreman:foreman /custom/templates
# chcon -R -t httpd_sys_rw_content_t /custom/templates
    Copy to Clipboard Toggle word wrap

  3. To export the templates to your local repository, enter the following command: 

    hammer export-templates --organization 'Default Organization' --repo /custom/templates
    Copy to Clipboard Toggle word wrap

5.8. Operating Systems
Copy link

Operating systems define combinations of installation methods and media and are grouped within families. As a default, Red Hat Satellite uses a Red Hat family. Families allow Satellite to change certain behaviors when provisioning hosts. To list operating systems, issue the following command: 

$ hammer os list
Copy to Clipboard Toggle word wrap

To create a new operating system, issue the following command: 

$ hammer os create --name os_name --major version_number
Copy to Clipboard Toggle word wrap

Then you can add architectures, partition tables, installation media, and configuration templates to the operating system. See the output of the hammer os --help command for details.

Example 5.1. Updating Multiple Operating Systems

The following Bash script assigns each operating system a partition table (Kickstart default), configuration template (Kickstart default PXELinux), and provisioning template (Satellite Kickstart Default). 

PARTID=$(hammer --csv partition-table list | grep "Kickstart default" | cut -d, -f1)
PXEID=$(hammer --csv template list --per-page=1000 | grep "Kickstart default PXELinux" | cut -d, -f1)
SATID=$(hammer --csv template list --per-page=1000 | grep "provision" | grep "Satellite Kickstart Default" | cut -d, -f1)

for i in $(hammer --csv os list | grep -vi '^ID' | awk -F, {'print $1'})
do
   hammer partition-table add-operatingsystem --id="${PARTID}" --operatingsystem-id="${i}"
   hammer template add-operatingsystem --id="${PXEID}" --operatingsystem-id="${i}"
   hammer os set-default-template --id="${i}" --config-template-id="${PXEID}"
   hammer os add-config-template --id="${i}" --config-template-id="${SATID}"
   hammer os set-default-template --id="${i}" --config-template-id="${SATID}"
done
Copy to Clipboard Toggle word wrap

You can add grep commands to the for statement to further specify the affected operating systems. To verify if the assignment was performed correctly, use the hammer os info command.

5.9. Parameters
Copy link

Parameters define the behavior of Red Hat Satellite during provisioning. There are several types of parameters, see Parameters in the Puppet Guide for details. Use the following example to set a global parameter: 

$ hammer global-parameter set --name param_name --value param_value
Copy to Clipboard Toggle word wrap

Example 5.2. Setting a Global Parameter to Disable the Firewall

Run the following command to set the firewall global option to disabled: 

$ hammer global-parameter set --name firewall --value --disabled
Copy to Clipboard Toggle word wrap

To verify the setting, issue the following command: 

$ hammer global-parameter list
---------|-------------
NAME     | VALUE
---------|-------------
firewall | --disabled
---------|-------------
Copy to Clipboard Toggle word wrap

Similarly, you can use hammer to set other parameter types:

  • To set domain parameters, use: 
$ hammer domain set-parameter \
--name param_name \
--value param_value \
--domain domain_name
Copy to Clipboard Toggle word wrap
  • To set host group parameters, use: 
$ hammer hostgroup set-parameter \
--name param_name \
--value param_value \
--hostgroup hg_name
Copy to Clipboard Toggle word wrap
  • To set host parameters, use: 
$ hammer host set-parameter \
--name param_name \
--value param_value \
--host h_name
Copy to Clipboard Toggle word wrap
  • To update smart class parameters, use: 
$ hammer sc-param \
--name param_name \
--default-value param_value
Copy to Clipboard Toggle word wrap

Chapter 6. Managing Hosts
Copy link

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

6.1. Creating a Host Group
Copy link

A host group is a collection of hosts or host groups. It is recommended to create host groups to hold shared host parameters. Members of the host group inherit these parameters, therefore you do not have to set them individually during host creation. Note that you can nest host groups in a hierarchical manner.

The following command demonstrates a basic set of options for creating a host group: 

$ hammer hostgroup create \
--name "hostgroup_name" \
--environment "environment_name" \
--architecture "architecture_name" \
--domain domain_name \
--subnet subnet_name \
--puppet-proxy proxy_name \
--puppet-ca-proxy ca-proxy_name \
--operatingsystem "os_name" \
--partition-table "table_name" \
--medium "medium_name" \
--organization-ids org_ID1,org_ID2... \
--location-ids loc_ID1,loc_ID2...
Copy to Clipboard Toggle word wrap

See hammer hostgroup create --help for the full list of configurable options. There are two settings that cannot be configured during host group creation:

  • An activation key has to be added afterwards using: 
$ hammer hostgroup set-parameter \
--hostgroup "hostgroup_name" \
--name "kt_activation_keys" \
--value key_name
Copy to Clipboard Toggle word wrap

Run hammer activation-key list to find the activation key name (see Chapter 4, Managing Activation Keys for details on activation keys).

  • The root password has to be specified when adding a host to the host group.

Example 6.1. Creating Host Groups for Multiple Content Views

The following Bash script creates a host group for each life cycle environment. 

MAJOR="7"
OS=$(hammer --output csv os list | awk -F "," "/RedHat ${MAJOR}/ {print \$2;exit}")
ARCH="x86_64"
ORG="ACME"
LOCATIONS="london,munich"
PTABLE_NAME="ptable-acme-os-rhel-server"
DOMAIN="example.com"

hammer lifecycle-environment list --organization "${ORG}" | awk -F "|" '/[[:digit:]]/ {print $2}' | sed s'/ //' | while read LC_ENV
do
  if [[ ${LC_ENV} == "Library" ]]; then
    continue
  fi

  LC_ENV_LOWER=$(echo ${LC_ENV} | tr '[[:upper:]' '[[:lower:]]')
  ParentID=$(hammer --output csv hostgroup list --per-page 999 | awk -F"," "(\$3 ~ /^${LC_ENV_LOWER}$/) {print \$1}")

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

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

  hammer hostgroup set-parameter \
    --hostgroup-id "${HgID}" \
    --name "kt_activation_keys" \
    --value "act-${LC_ENV_LOWER}-os-rhel-${MAJOR}server-${ARCH}"
done
Copy to Clipboard Toggle word wrap

6.2. Creating a Host
Copy link

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

$ hammer host create \
--name "host_name" \
--hostgroup "hostgroup_name" \
--interface="primary=true, \
            provision=true, \
            mac=mac_address, \
            ip=ip_address" \
--organization-id org_ID \
--location-id loc_ID \
--ask-root-password yes
Copy to Clipboard Toggle word wrap

After executing the above command you will be prompted to specify the root password. It is required to specify the host’s IP and MAC address, other properties of the primary network interface can be inherited from the host group or set using the subnet, and domain parameters. You can set additional interfaces using the --interface option, which accepts a list of key-value pairs. For the list of available interface settings, see Table 6.1, “Available Keys for the --interface Option”.

If you decide to create a host without host group membership, specify additional options described in ]. There is a wide range of available host parameters, for details see the output of hammer host create --help. The value of certain parameters depends on the type of compute resource the host is provisioned on, see xref:tabl-CLI_Guide-Host_Options_Specific_to_Provider[ for reference.

Expand
Table 6.1. Available Keys for the --interface Option
KeysDescription

type

Defines the interface type, one of Nic::Managed, Nic::BMC, Nic::Bond.

name, identifier

Identification of the interface.

mac, ip, domain (or domain_id), subnet (or subnet_id)

Network settings, domain and subnet identification can be inherited from the host group.

primary, provision, managed, virtual

Accept true or false. Managed hosts needs to have one primary and provisioning interface.

Specific to virtual interfaces

 

tag

VLAN tag, this attribute has precedence over the subnet VLAN ID.

attached_to

Identifier of the interface to which the virtual interface belongs, for example eth1.

Specific to bonded interfaces

 

mode

Bonding mode, one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

Specific to BMC interfaces

 

provider

BMC provider, set to IPMI.

username, password

BMC access credentials.

Specific to hosts provisioned on Libvirt

 

compute_type

Interface type, one of bridge, network.

compute_network or compute_bridge

Specifies interface name, pick one depending on the interface type.

compute_model

One of virtio, rtl8139, ne2k_pci, pcnet, e1000.

Specific to hosts provisioned on RHEV

 

compute_name

Interface name, for example eth0.

compute_network

Select one of the available networks for a cluster, use UUID from RHEV.

Specific to hosts provisioned on VMware

 

compute_type

Type of the network adapter, depends on your version of vSphere.

compute_network

Network ID form VMware.

Expand
Table 6.2. Host Options Specific to Provider
ProviderKeys

Keys for the --compute-attributes option

 

EC2

flavor_id, image_id, availability_zone, security_group_ids, managed_ip

GCE

machine_type, image_id, network, external_ip

Libvirt

cpus, memory, start

OpenStack

flavor_ref, image_ref, tenant_id, security_groups, network

RHEV

cluster, template, cores, memory, start

VMware

cpus, corespersocket, memory_mb, cluster, path, guest_id, scsi_controller_type, hardware_version, start

Keys for the --volume option

 

Libvirt

poll_name, capacity, format_type

RHEV

size_gb, storage_domain, bootable

VMware

datastore, name, size_gb, thin, eager_zero

Example 6.2. Creating a Host with a Bonded Interface Pair

The following example shows how to create a host with a bonded interface pair. For more information on interface bonding see Configure Network Bonding in the Red Hat Enterprise Linux Networking Guide. 

$ hammer host create --name bondtest \
--hostgroup-id 1 \
--ip=192.168.100.123 \
--mac=52:54:00:14:92:2a \
--subnet-id=1 \
--managed true \
   --interface="identifier=eth1, \
               mac=52:54:00:62:43:06, \
               managed=true, \
               type=Nic::Managed, \
               domain_id=1, \
               subnet_id=1" \
   --interface="identifier=eth2, \
               mac=52:54:00:d3:87:8f, \
               managed=true, \
               type=Nic::Managed, \
               domain_id=1, \
               subnet_id=1" \
   --interface="identifier=bond0, \
               ip=172.25.18.123, \
               type=Nic::Bond, \
               mode=active-backup, \
               attached_devices=[eth1,eth2], \
               managed=true, \
               domain_id=1, \
               subnet_id=1" \
--organization-id 1 \
--location-id 1 \
--ask-root-password yes
Copy to Clipboard Toggle word wrap

6.3. Creating a Host Collection
Copy link

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

$ hammer host-collection create \
--organization-label org_label \
--name hc_name
Copy to Clipboard Toggle word wrap

To add hosts to a host collection, issue the following command: 

$ hammer host-collection add-host \
--id hc_ID \
--host-ids ch_ID1,ch_ID2...
Copy to Clipboard Toggle word wrap

Run the following command to associate a host collection with an activation key (see Chapter 4, Managing Activation Keys for details on activation keys): 

$ hammer activation-key add-host-collection \
--id ak_ID \
--host-collection hc_name
Copy to Clipboard Toggle word wrap

Hosts grouped in the host collection now inherit the configuration from the activation key.

6.4. Running Remote Jobs on Hosts
Copy link

The remote execution feature enables defining arbitrary commands on the Satellite Server and executing them on remote hosts. Commands are defined in job templates that are similar to provisioning templates. Several job templates are included by default, you can use them or define a custom template for example to manipulate software packages or start a Puppet process on remote hosts. To use this feature in Hammer, install the remote execution CLI module by executing the following command as root: 

# yum install tfm-rubygem-hammer_cli_foreman_remote_execution
Copy to Clipboard Toggle word wrap

To list job templates available, issue: 

$ hammer job-template list
Copy to Clipboard Toggle word wrap

To create a job template using a template-definition file, use a command as follows: 

$ hammer job-template create \
--file "template" \
--name "template_name" \
--provider-type SSH \
--job-category "category_name"
Copy to Clipboard Toggle word wrap

Replace template with the path to the file containing the template definition. Specify a custom category_name or select one of the existing categories (Commands, Katello, Packages, Power, Puppet, or Services). See the output of hammer job-template create --help for information on other available parameters.

To invoke a job with custom parameters, issue: 

$ hammer job-invocation create \
--job-template "template_name" \
--inputs key1="value",key2="value",... \
--search-query "query"
Copy to Clipboard Toggle word wrap

Specify the template name you want to use for the remote job. Specify inputs as a comma separated list of key-value pairs. Run hammer job-template info to see what parameters are required by your template. Replace query with the filter expression defining which hosts will be affected (for example "name ~ rex01").

Example 6.3. Starting the httpd Service on Selected Hosts

This example shows how to execute a remote job based on the default Service Action - SSH Default template, that will start the httpd service on hosts that have a name that contains "target". 

$ hammer job-invocation create \
--job-template "Service Action - SSH Default" \
--inputs service="httpd",action="start" \
--search-query "name ~ target"
Copy to Clipboard Toggle word wrap

To find the ID of a job output, issue: 

$ hammer job-invocation list
Copy to Clipboard Toggle word wrap

To monitor a job output, issue: 

$ hammer job-invocation output \
--id job_ID \
--host host_name
Copy to Clipboard Toggle word wrap

To cancel a job output, issue: 

$ hammer job-invocation cancel \
--id job_ID
Copy to Clipboard Toggle word wrap

For more information on executing remote commands with hammer, issue hammer job-template --help or hammer job-invocation --help.

Chapter 7. Managing Users and Permissions
Copy link

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

7.1. Creating Users
Copy link

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

$ hammer user create \
--login user_name \
--password user_password \
--mail user_mail \
--auth-source-id 1 \
--organization-ids org_ID1,org_ID2...
Copy to Clipboard Toggle word wrap

The --auth-source-id 1 setting means that the user is authenticated internally, you can specify an external authentication source as an alternative. Add the --admin option to grant administrator privileges to the user. Specifying organization IDs is not required, you can modify the user details later using the update subcommand.

For more information on user related subcommands see the output of hammer user --help.

7.2. Creating User Groups
Copy link

You can manage permissions of several users at once by organizing them into user groups. User groups themselves can be further grouped to create a hierarchy of permissions. Use the following command to create a new user group: 

$ hammer user-group create --name usergroup_name
Copy to Clipboard Toggle word wrap

To add a user to a user group, issue the following command: 

$ hammer user-group add-user --user user_name --id usergroup_id
Copy to Clipboard Toggle word wrap

Find the user group ID by executing hammer user-group list. Similarly, you can add user groups using the add-user-group subcommand. For more information on operations related to user groups see the output of hammer user-group --help.

7.3. Creating Roles
Copy link

Roles in Red Hat Satellite define a set of permissions and access levels. Satellite provides a number of predefined roles, to view them, enter the following command: 

$ hammer role list
Copy to Clipboard Toggle word wrap

To view permissions associated with a role, issue the following command: 

$ hammer role filters --id role_id
Copy to Clipboard Toggle word wrap

Here, role_id is the ID of the role from the output of hammer role list.

To create a custom role, issue the following command: 

$ hammer role create --name role_name
Copy to Clipboard Toggle word wrap

Add a permission filter to the role with the following command: 

$ hammer filter create \
--role role_name \
--permission-ids perm_ID1,perm_ID2...
Copy to Clipboard Toggle word wrap

Find the permissions to be added to the role by using hammer filter available-permissions. For details on roles and permissions see the output of hammer role --help and hammer filter --help.

Example 7.1. Granular Permission Filtering

Red Hat Satellite provides the ability to limit the configured user permissions to selected instances of a resource type. Use the --search option to limit permission filters, for example: 

$ hammer filter create \
--permission-ids 91 \
--search "name ~ ccv*" \
--role qa-user
Copy to Clipboard Toggle word wrap

The above command adds to the qa-user role a permission to view, create, edit, and destroy Content Views that only applies to Content Views with name starting with ccv. See Granular Permission Filtering in Administering Red Hat Satellite for more information.

7.4. Assigning Roles to Users
Copy link

To assign a role to a user, issue the following command: 

$ hammer user add-role --id user_id --role role_name
Copy to Clipboard Toggle word wrap

Similarly, you can assign a role to a user group: 

$ hammer user-group add-role --id usergroup_id --role role_name
Copy to Clipboard Toggle word wrap

7.5. Adding SSH Keys to a User
Copy link

The following steps show how to add public SSH keys to an existing user using the hammer. To create SSH keys or for more information, see Generating Key Pairs in the Red Hat Enterprise Linux 7 System Administrator’s Guide.

For web UI equivalents of the following procedures see Adding SSH keys to a User in Administering Red Hat Satellite.

Prerequisite

You need either the path to the public SSH key file, or the content of the public SSH key copied to the clipboard.

If you have the public SSH key file: 

$ hammer user ssh-keys add --user-id user_id --name key_name --key-file ~/.ssh/id_rsa.pub
Copy to Clipboard Toggle word wrap

If you have the content of the public SSH key: 

$ hammer user ssh-keys add --user-id user_id --name key_name --key ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNtYAAABBBHHS2KmNyIYa27Qaa7EHp+2l99ucGStx4P77e03ZvE3yVRJEFikpoP3MJtYYfIe8k 1/46MTIZo9CPTX4CYUHeN8= host@user
Copy to Clipboard Toggle word wrap

7.6. Deleting SSH Keys from a User
Copy link

To delete an SSH key from a user: 

$ hammer user ssh-keys delete --id key_id --user-id user_id
Copy to Clipboard Toggle word wrap

7.7. Viewing SSH Keys of a User
Copy link

To view an SSH key attached to a user: 

$ hammer user ssh-keys info --id key_id --user-id user_id
Copy to Clipboard Toggle word wrap

To list SSH keys attached to a user: 

$ hammer user ssh-keys list --user-id user_id
Copy to Clipboard Toggle word wrap

Chapter 8. Managing Errata
Copy link

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

8.1. Inspecting Available Errata
Copy link

To view errata that are available for all organizations, issue the following command: 

$ hammer erratum list
Copy to Clipboard Toggle word wrap

Example 8.1. Filtering Errata

The hammer erratum list command provides numerous options for filtering and ordering the output list. For example, to find an erratum that contains a specific security fix, issue: 

$ hammer erratum list --cve CVE-2014-0453
Copy to Clipboard Toggle word wrap

The following command displays applicable errata for the selected product that contain the specified bugs ordered so that the security errata are displayed on top: 

$ hammer erratum list \
--product-id 7 \
--search "bug = 1213000 or bug = 1207972" \
--errata-restrict-applicable 1 \
--order "type desc"
Copy to Clipboard Toggle word wrap

For more information on syntax used in the --search option, see Inspecting Available Errata in the Content Management Guide. For more information on filtering options implemented in hammer, see the output of hammer erratum list --help.

To view details of a specific erratum, issue the following command: 

$ hammer erratum info --id erratum_ID
Copy to Clipboard Toggle word wrap

Replace erratum_ID with a unique identifier of the erratum found in the output of the hammer erratum list command. You can identify errata also by name and repository name, see the output of hammer erratum info --help for details.

8.2. Applying Errata to a Host
Copy link

To list errata available for a host, issue the following command: 

$ hammer host errata list --host hostname
Copy to Clipboard Toggle word wrap

To apply selected errata to the host, issue the following command: 

$ hammer host errata apply \
--host hostname \
--errata-ids erratum_ID1,erratum_ID2...
Copy to Clipboard Toggle word wrap

Example 8.2. Applying All Available Errata to a Host

The following Bash script applies all errata available to a host (auth01.example.com): 

HOST="auth01.example.com"
for i in $(hammer --csv host errata list --host $HOST | grep -vi '^ID' | awk -F, {'print $2'})
do
  hammer host errata apply --host $HOST --errata-ids $i
done
Copy to Clipboard Toggle word wrap

Example 8.3. Applying a Security Advisory

This example shows how to apply a security fix to hosts using hammer:

  1. Find the erratum that contains a fix for a selected issue (CVE-2015-3238): 

    $ hammer erratum list --cve CVE-2015-3238
-------|----------------|----------|------------------------------
ID     | ERRATA ID      | TYPE     | TITLE
-------|----------------|----------|------------------------------
f30e66 | RHSA-2015:1640 | security | Moderate: pam security update
-------|----------------|----------|------------------------------
    Copy to Clipboard Toggle word wrap

  2. Verify if the security erratum (RHSA-2015:1640) is applicable for your host (auth01.example.com): 

    $ hammer host errata list \
--host auth01.example.com \
--search "RHSA-2015:1640"
    Copy to Clipboard Toggle word wrap

  3. Apply the erratum to the host: 

    $ hammer host errata apply \
--host auth01.example.com \
--errata-ids "RHSA-2015:1640"
    Copy to Clipboard Toggle word wrap

You can use the following Bash script to apply a security erratum (for example RHSA-2015:1640) to all hosts where it is applicable: 

ORG="ACME"
RHSA="RHSA-2015:1640"

for i in $(hammer --csv host list --organization $ORG | grep -vi '^ID' | awk -F, {'print $2'})
do
  hammer host errata apply --host $i --errata-ids $RHSA
done
Copy to Clipboard Toggle word wrap

To see if errata were applied successfully, find the corresponding task in the output of the following command: 

$ hammer task list
Copy to Clipboard Toggle word wrap

To review the state of a selected task, issue the following command: 

$ hammer task progress --id task_ID
Copy to Clipboard Toggle word wrap

8.3. Applying Errata to a Host Collection
Copy link

To apply selected errata to a Host Collection, enter a command as follows: 

$ hammer host-collection erratum install \
--errata "erratum_ID1,erratum_ID2,..." \
--name "my-collection" --organization $ORG
Copy to Clipboard Toggle word wrap

This command is available in Red Hat Satellite 6.2.8 or later.

Chapter 9. Managing Docker Containers
Copy link

A Docker container is a sandbox for isolating applications. The container image stores the configuration for the container. This section shows how to use hammer to provision Docker containers. For web UI equivalents of the following procedures see Managing Containers in Managing Hosts.

In Red Hat Satellite, you can deploy containers only on a compute resource of the Docker provider type. See Preparing Container Hosts in Managing Hosts for instructions on how to prepare a container host. To register this host as a compute resource, issue the following command: 

$ hammer compute-resource create
--name cr_name \
--organization-ids org_ID1,org_ID2... \
--location-ids loc_ID1,loc_ID2... \
--url cr_url \
--provider docker
Copy to Clipboard Toggle word wrap

Use the following syntax to provision a container on the compute resource: 

$ hammer docker container create \
--name container_name \
--compute-resource-id cr_ID \
--repository-name repo_name \
--tag tag \
--command command
Copy to Clipboard Toggle word wrap

Find the compute resource ID in the output of hammer compute-resource list. Replace repo_name with the name of the synchronized repository that contains your docker images. This can be a custom repository pointing to Docker Hub or your internal registry (see ]), or the official Red Hat image repository. If you provision from a Content View, replace repo_name with the name of the Content View. See xref:sect-CLI_Guide-Adding_Docker_Images_to_a_Content_View[ for details on adding images to a Content View.

By starting a container you start the process specified with the --command option during the container creation. To start a container, issue the following command: 

$ hammer docker container start --id container_ID
Copy to Clipboard Toggle word wrap

For the full list of container related options, see the output of the hammer docker container --help command.

Chapter 10. Reference
Copy link

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.5.

10.1. hammer
Copy link

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-resource              Manipulate compute resources
 config-group                  Manipulate config groups
 config-report                 Browse and read reports
 content-view                  Manipulate content views
 csv                           Import to or export from a running foreman server
 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-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
Copy to Clipboard Toggle word wrap

10.2. hammer activation-key
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.1. hammer activation-key add-host-collection
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.2. hammer activation-key add-subscription
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.3. hammer activation-key content-override
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.4. hammer activation-key copy
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.5. hammer activation-key create
Copy link

Create an activation key 

Usage:
    hammer activation-key create [OPTIONS]

Options:
 --content-view CONTENT_VIEW_NAME                    Content view name to search by
 --content-view-id CONTENT_VIEW_ID                   Content view numeric identifier
 --description DESCRIPTION                           Description
 --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME  Environment name
 --lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
 --max-hosts MAX_HOSTS                               Maximum number of registered content hosts
 --name NAME                                         Name
 --organization ORGANIZATION_NAME                    Organization name to search by
 --organization-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
Copy to Clipboard Toggle word wrap

10.2.6. hammer activation-key delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.7. hammer activation-key host-collections
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.8. hammer activation-key info
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.9. hammer activation-key list
Copy link

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
 --full-result FULL_RESULT                           Whether or not to show all results
                                                     One of true/false, yes/no, 1/0.
 --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME  Environment name
 --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
Copy to Clipboard Toggle word wrap

10.2.10. hammer activation-key product-content
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

10.2.12. hammer activation-key remove-subscription
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.13. hammer activation-key subscriptions
Copy link

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
Copy to Clipboard Toggle word wrap

10.2.14. hammer activation-key update
Copy link

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
 --id ID                                             ID of the activation key
 --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME  Environment name
 --lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
 --max-hosts MAX_HOSTS                               Maximum number of registered content hosts
 --name NAME                                         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
Copy to Clipboard Toggle word wrap

10.3. hammer admin
Copy link

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
Copy to Clipboard Toggle word wrap

10.3.1. hammer admin logging
Copy link

Logging verbosity level setup 

Usage:
    hammer admin logging [OPTIONS]

Options:
 --no-backup                   Skip configuration backups creation.
 --prefix PATH                 Operate on prefixed environment (e.g. chroot).
 -a, --all                     Apply to all components.
 -c, --components COMPONENTS   Components to apply, use --list to get them.
                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -d, --level-debug             Increase verbosity level to debug.
 -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.
Copy to Clipboard Toggle word wrap

10.4. hammer ansible
Copy link

Manage foreman ansible 

Usage:
    hammer ansible [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 roles                         Manage ansible roles

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.4.1. hammer ansible roles
Copy link

Manage ansible roles 

Usage:
    hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:

 delete                        Deletes Ansible role
 import                        Import Ansible roles
 info                          Show role
 list                          List Ansible roles
 obsolete                      Obsolete Ansible roles

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.4.1.1. hammer ansible roles delete
Copy link

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
Copy to Clipboard Toggle word wrap
10.4.1.2. hammer ansible roles import
Copy link

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
 -h, --help                              Print help
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.4.1.3. hammer ansible roles info
Copy link

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
Copy to Clipboard Toggle word wrap
10.4.1.4. hammer ansible roles list
Copy link

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
Copy to Clipboard Toggle word wrap
10.4.1.5. hammer ansible roles obsolete
Copy link

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.5. hammer architecture
Copy link

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
Copy to Clipboard Toggle word wrap

10.5.1. hammer architecture add-operatingsystem
Copy link

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
Copy to Clipboard Toggle word wrap

10.5.2. hammer architecture create
Copy link

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
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --organization ORGANIZATION_NAME          Organization name
 --organization-id ORGANIZATION_ID         Organization ID
 --organization-title ORGANIZATION_TITLE   Organization title
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.5.3. hammer architecture delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.5.4. hammer architecture info
Copy link

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
Copy to Clipboard Toggle word wrap

10.5.5. hammer architecture list
Copy link

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
Copy to Clipboard Toggle word wrap

10.5.6. hammer architecture remove-operatingsystem
Copy link

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
Copy to Clipboard Toggle word wrap

10.5.7. hammer architecture update
Copy link

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
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --organization ORGANIZATION_NAME          Organization name
 --organization-id ORGANIZATION_ID         Organization ID
 --organization-title ORGANIZATION_TITLE   Organization title
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.6. hammer arf-report
Copy link

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
Copy to Clipboard Toggle word wrap

10.6.1. hammer arf-report delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.6.2. hammer arf-report download
Copy link

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
Copy to Clipboard Toggle word wrap

10.6.3. hammer arf-report download-html
Copy link

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
Copy to Clipboard Toggle word wrap

10.6.4. hammer arf-report info
Copy link

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
Copy to Clipboard Toggle word wrap

10.6.5. hammer arf-report list
Copy link

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
Copy to Clipboard Toggle word wrap

10.7. hammer audit
Copy link

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
Copy to Clipboard Toggle word wrap

10.7.1. hammer audit info
Copy link

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
Copy to Clipboard Toggle word wrap

10.7.2. hammer audit list
Copy link

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
Copy to Clipboard Toggle word wrap

10.8. hammer auth
Copy link

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
Copy to Clipboard Toggle word wrap

10.8.1. hammer auth login
Copy link

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
Copy to Clipboard Toggle word wrap

10.8.2. hammer auth logout
Copy link

Wipe your credentials 

Usage:
    hammer auth logout [OPTIONS]

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.8.3. hammer auth status
Copy link

Information about current connections 

Usage:
    hammer auth status [OPTIONS]

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.9. hammer auth-source
Copy link

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
Copy to Clipboard Toggle word wrap

10.9.1. hammer auth-source ldap
Copy link

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
Copy to Clipboard Toggle word wrap
10.9.1.1. hammer auth-source ldap create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap
10.9.1.2. hammer auth-source ldap delete
Copy link

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
Copy to Clipboard Toggle word wrap
10.9.1.3. hammer auth-source ldap info
Copy link

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
Copy to Clipboard Toggle word wrap
10.9.1.4. hammer auth-source ldap list
Copy link

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
Copy to Clipboard Toggle word wrap
10.9.1.5. hammer auth-source ldap update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.9.2. hammer auth-source list
Copy link

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
Copy to Clipboard Toggle word wrap

10.10. hammer bootdisk
Copy link

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
Copy to Clipboard Toggle word wrap

10.10.1. hammer bootdisk generic
Copy link

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
Copy to Clipboard Toggle word wrap

10.10.2. hammer bootdisk host
Copy link

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
Copy to Clipboard Toggle word wrap

10.10.3. hammer bootdisk subnet
Copy link

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
Copy to Clipboard Toggle word wrap

10.11. hammer capsule
Copy link

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
Copy to Clipboard Toggle word wrap

10.11.1. hammer capsule content
Copy link

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
Copy to Clipboard Toggle word wrap

Add lifecycle environments to the capsule 

Usage:
    hammer capsule content add-lifecycle-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                         Id of the capsule
 --name NAME                     Name to search by
 --organization NAME             Organization name
 --organization-id ID            Organization ID
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap
10.11.1.4. hammer capsule content info
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

Remove lifecycle environments from the capsule 

Usage:
    hammer capsule content remove-lifecycle-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                         Id of the capsule
 --name NAME                     Name to search by
 --organization NAME             Organization name
 --organization-id ID            Organization ID
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap
10.11.1.8. hammer capsule content synchronize
Copy link

Synchronize the content to the capsule 

Usage:
    hammer capsule content synchronize [OPTIONS]

Options:
 --async                                   Do not wait for the task
 --environment ENVIRONMENT_NAME            Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                                   Id of the capsule
 --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
Copy to Clipboard Toggle word wrap

10.11.2. hammer capsule create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --url URL
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.11.3. hammer capsule delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.11.4. hammer capsule import-classes
Copy link

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-id ENVIRONMENT_ID
 --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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.11.5. hammer capsule info
Copy link

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
Copy to Clipboard Toggle word wrap

10.11.6. hammer capsule list
Copy link

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
Copy to Clipboard Toggle word wrap

10.11.7. hammer capsule refresh-features
Copy link

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
Copy to Clipboard Toggle word wrap

10.11.8. hammer capsule update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --url URL
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.12. hammer compute-resource
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.1. hammer compute-resource clusters
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.2. hammer compute-resource create
Copy link

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 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
 --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
 --locations LOCATION_NAMES                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --provider PROVIDER                         Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE,
                                             Docker
 --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 Docker, 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
Copy to Clipboard Toggle word wrap

10.12.3. hammer compute-resource delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.4. hammer compute-resource flavors
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.5. hammer compute-resource folders
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.6. hammer compute-resource image
Copy link

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
Copy to Clipboard Toggle word wrap
10.12.6.1. hammer compute-resource image available
Copy link

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
Copy to Clipboard Toggle word wrap
10.12.6.2. hammer compute-resource image create
Copy link

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
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap
10.12.6.3. hammer compute-resource image delete
Copy link

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
Copy to Clipboard Toggle word wrap
10.12.6.4. hammer compute-resource image info
Copy link

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
Copy to Clipboard Toggle word wrap
10.12.6.5. hammer compute-resource image list
Copy link

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
Copy to Clipboard Toggle word wrap
10.12.6.6. hammer compute-resource image update
Copy link

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
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.12.7. hammer compute-resource images
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.8. hammer compute-resource info
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.9. hammer compute-resource list
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.10. hammer compute-resource networks
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.11. hammer compute-resource resource-pools
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.12. hammer compute-resource security-groups
Copy link

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
Copy to Clipboard Toggle word wrap

10.12.13. hammer compute-resource storage-domains
Copy link

List storage domains for a compute resource 

Usage:
    hammer compute-resource storage-domains [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
 --storage-domain STORAGE_DOMAIN
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.12.14. hammer compute-resource storage-pods
Copy link

List storage pods for a compute resource 

Usage:
    hammer compute-resource storage-pods [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
 --storage-pod STORAGE_POD
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.12.15. hammer compute-resource update
Copy link

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 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
 --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
 --locations LOCATION_NAMES                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --provider PROVIDER                         Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE,
                                             Docker
 --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 Docker, 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
Copy to Clipboard Toggle word wrap

10.12.16. hammer compute-resource zones
Copy link

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
Copy to Clipboard Toggle word wrap

10.13. hammer config-group
Copy link

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
Copy to Clipboard Toggle word wrap

10.13.1. hammer config-group create
Copy link

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
 --puppet-classes PUPPET_CLASS_NAMES     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.13.2. hammer config-group delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.13.3. hammer config-group info
Copy link

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
Copy to Clipboard Toggle word wrap

10.13.4. hammer config-group list
Copy link

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
Copy to Clipboard Toggle word wrap

10.13.5. hammer config-group update
Copy link

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
 --puppet-classes PUPPET_CLASS_NAMES     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.14. hammer config-report
Copy link

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
Copy to Clipboard Toggle word wrap

10.14.1. hammer config-report delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.14.2. hammer config-report info
Copy link

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
Copy to Clipboard Toggle word wrap

10.14.3. hammer config-report list
Copy link

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
Copy to Clipboard Toggle word wrap

10.15. hammer content-view
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.1. hammer content-view add-repository
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.2. hammer content-view add-version
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.3. hammer content-view component
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.3.1. hammer content-view component add
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.3.2. hammer content-view component list
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.3.3. hammer content-view component remove
Copy link

Remove components from the content view 

Usage:
    hammer content-view component remove [OPTIONS]

Options:
 --component-content-view-ids COMPONENT_CONTENT_VIEW_IDs Array of component content view identfiers to remove. Comma separated list of values
 --component-content-views COMPONENT_CONTENT_VIEW_NAMES  Array of component content view names to remove. Comma separated list of values
 --component-ids COMPONENT_IDS                           Array of content view component IDs to remove. Identifier of the component
                                                         Association
                                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --composite-content-view COMPOSITE_CONTENT_VIEW_NAME    Name of the composite content view
 --composite-content-view-id COMPOSITE_CONTENT_VIEW_ID   Composite content view identifier
 --organization ORGANIZATION_NAME                        Organization name to search by
 --organization-id ORGANIZATION_ID                       Organization ID to search by
 --organization-label ORGANIZATION_LABEL                 Organization label to search by
 -h, --help                                              Print help
Copy to Clipboard Toggle word wrap
10.15.3.4. hammer content-view component update
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.4. hammer content-view copy
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.5. hammer content-view create
Copy link

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
 --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
 --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
 --repository-ids REPOSITORY_IDS         List of repository ids
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.15.6. hammer content-view delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.7. hammer content-view filter
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap
10.15.7.2. hammer content-view filter create
Copy link

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
 --repository-ids REPOSITORY_IDS         List of repository ids
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --type TYPE                             Type of filter (e.g. rpm, package_group, erratum, docker)
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.15.7.3. hammer content-view filter delete
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.7.4. hammer content-view filter info
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.7.5. hammer content-view filter list
Copy link

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap
10.15.7.7. hammer content-view filter rule
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.7.8. hammer content-view filter rule create
Copy link

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
 --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
 --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
 --uuid UUID                                     Package group: uuid
 --version VERSION                               Package: version
 -h, --help                                      Print help
Copy to Clipboard Toggle word wrap
10.15.7.9. hammer content-view filter rule delete
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.7.10. hammer content-view filter rule info
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.7.11. hammer content-view filter rule list
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.7.12. hammer content-view filter rule update
Copy link

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
 --version VERSION                               Package: version
 -h, --help                                      Print help
Copy to Clipboard Toggle word wrap
10.15.7.13. hammer content-view filter update
Copy link

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
 --repository-ids REPOSITORY_IDS         List of repository ids
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.15.8. hammer content-view info
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.9. hammer content-view list
Copy link

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.
 --full-result FULL_RESULT                           Whether or not to show all results
                                                     One of true/false, yes/no, 1/0.
 --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME  Environment name
 --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
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap

10.15.10. hammer content-view publish
Copy link

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. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.15.11. hammer content-view puppet-module
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.11.1. hammer content-view puppet-module add
Copy link

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
Copy to Clipboard Toggle word wrap
10.15.11.2. hammer content-view puppet-module list
Copy link

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                             The uuid of the puppet module to associate
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

10.15.12. hammer content-view purge
Copy link

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.
Copy to Clipboard Toggle word wrap

10.15.13. hammer content-view remove
Copy link

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
 --content-view-versions CONTENT_VIEW_VERSION_VERSIONS Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environment-ids ENVIRONMENT_IDS                     Environment ids to remove
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environments ENVIRONMENT_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
Copy to Clipboard Toggle word wrap

Remove a content view from an environment 

Usage:
    hammer content-view remove-from-environment [OPTIONS]

Options:
 --async                                             Do not wait for the task
 --id ID                                             Content view numeric identifier
 --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME  Environment name
 --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
Copy to Clipboard Toggle word wrap

10.15.15. hammer content-view remove-repository
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.16. hammer content-view remove-version
Copy link

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
Copy to Clipboard Toggle word wrap

10.15.17. hammer content-view update
Copy link

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
 --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
 --repositories REPOSITORY_NAMES         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --repository-ids REPOSITORY_IDS         List of repository ids
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.15.18. hammer content-view version
Copy link

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
 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
Copy to Clipboard Toggle word wrap
10.15.18.1. hammer content-view version delete
Copy link

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          Environment name
 --environment-id ENVIRONMENT_ID
 --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
Copy to Clipboard Toggle word wrap
10.15.18.2. hammer content-view version export
Copy link

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
Copy to Clipboard Toggle word wrap

Export a content view 

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          Environment name
 --environment-id ENVIRONMENT_ID
 --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
 --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
Copy to Clipboard Toggle word wrap
10.15.18.4. hammer content-view version import
Copy link

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
Copy to Clipboard Toggle word wrap

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 or uuids to copy into the new versions
                                                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --debs DEB_NAMES                                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --description DESCRIPTION                           The description for the new generated Content View Versions
 --errata-ids ERRATA_IDS                             Errata ids or uuids to copy into the new versions
                                                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --host-ids HOST_IDS                                 IDs of hosts to update
                                                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --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 or uuids to copy into the new versions
                                                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --packages PACKAGE_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --propagate-all-composites PROPAGATE_ALL_COMPOSITES If true, will publish a new composite version using any specified
                                                     Content_view_version_id that has been promoted to a lifecycle environment
                                                     One of true/false, yes/no, 1/0.
 --puppet-module-ids PUPPET_MODULE_IDS               Puppet Module ids or uuids to copy into the new versions
                                                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --puppet-modules PUPPET_MODULE_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --resolve-dependencies RESOLVE_DEPENDENCIES         If true, when adding the specified errata or packages, any needed
                                                     Dependencies will be copied as well
                                                     One of true/false, yes/no, 1/0.
 --update-all-hosts UPDATE                           Update all editable and applicable hosts within the specified Content View and \
                                                                    Lifecycle Environments
                                                     One of true/false, yes/no, 1/0.
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap
10.15.18.6. hammer content-view version info
Copy link

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          Environment name
 --environment-id ENVIRONMENT_ID
 --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
Copy to Clipboard Toggle word wrap
10.15.18.7. hammer content-view version list
Copy link

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              Environment name
 --environment-id ENVIRONMENT_ID
 --full-result FULL_RESULT                   Whether or not to show all results
                                             One of true/false, yes/no, 1/0.
 --order ORDER                               Sort field and order, eg. '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
Copy to Clipboard Toggle word wrap
10.15.18.8. hammer content-view version promote
Copy link

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
                                                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --force                                             Force content view promotion and bypass lifecycle environment restriction
 --from-lifecycle-environment FROM_ENVIRONMENT_ID    Environment name from where to promote its version from (if version is unknown)
 --from-lifecycle-environment-id FROM_ENVIRONMENT_ID Id of the environment from where to promote its version from (if version is unknown)
 --id ID                                             Content view version identifier
 --organization ORGANIZATION_NAME                    Organization name to search by
 --organization-id ORGANIZATION_ID                   Organization ID
 --organization-label ORGANIZATION_LABEL             Organization label to search by
 --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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

10.16. hammer csv
Copy link

import to or export from a running foreman server 

Usage:
    hammer csv [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 activation-keys               Import or export activation keys
 architectures                 Import or export architectures
 compute-profiles              Import or export compute profiles
 compute-resources             Import or export compute resources
 containers                    Import or export containers
 content-hosts                 Import or export content hosts
 content-view-filters          Import or export content-view-filters
 content-views                 Import or export content-views
 domains                       Import or export domains
 export                        Export into directory
 host-collections              Import or export host collections
 host-groups                   Import or export host-groups
 hosts                         Import or export hosts
 import                        Import by directory
 installation-media            Import or export media
 job-templates                 Import or export job templates
 lifecycle-environments        Import or export lifecycle environments
 locations                     Import or export locations
 operating-systems             Import or export operating systems
 organizations                 Import or export organizations
 partition-tables              Import or export partition tables
 products                      Import or export products
 provisioning-templates        Import or export provisioning templates
 puppet-environments           Import or export puppet environments
 puppet-facts                  Import or export puppet facts
 puppet-reports                Import or export puppet reports
 reports                       Import or export reports
 roles                         Import or export roles
 settings                      Import or export settings
 smart-proxies                 Import or export smart proxies
 splice                        Import Satellite-5 splice data
 subnets                       Import or export subnets
 subscriptions                 Import or export subscriptions
 sync-plans                    Import or export repository sync plans
 users                         Import or export users

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.16.1. hammer csv activation-keys
Copy link

import or export activation keys 

Usage:
    hammer csv activation-keys [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --itemized-subscriptions      Export one subscription per row, only process update subscriptions on import
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.2. hammer csv architectures
Copy link

import or export architectures 

Usage:
    hammer csv architectures [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.3. hammer csv compute-profiles
Copy link

import or export compute profiles 

Usage:
    hammer csv compute-profiles [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.4. hammer csv compute-resources
Copy link

import or export compute resources 

Usage:
    hammer csv compute-resources [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.5. hammer csv containers
Copy link

import or export containers 

Usage:
    hammer csv containers [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

10.16.6. hammer csv content-hosts
Copy link

import or export content hosts 

Usage:
    hammer csv content-hosts [OPTIONS]

Options:
 --clear-subscriptions         When processing --itemized-subscriptions, clear existing subscriptions first
 --columns COLUMN_NAMES        Comma separated list of column names to export
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --itemized-subscriptions      Export one subscription per row, only process update subscriptions on import
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.

Columns:
 Name - Name of resource
 Search - Search for matching names during import (overrides 'Name' column)
 Organization - Organization name
 Environment - Lifecycle environment name
 Content View - Content view name
 Host Collections - Comma separated list of host collection names
 Virtual - Is a virtual host, Yes or No
 Guest of Host - Hypervisor host name for virtual hosts
 OS - Operating system
 Arch - Architecture
 Sockets - Number of sockets
 RAM - Quantity of RAM in bytes
 Cores - Number of cores
 SLA - Service Level Agreement value
 Products - Comma separated list of products, each of the format "<sku>|<name>"
 Subscriptions - Comma separated list of subscriptions, each of the format "<quantity>|<sku>|<name>|<contract>|<account>"
 Subscription Name - Subscription name (only applicable for --itemized-subscriptions)
 Subscription Type - Subscription type (only applicable for --itemized-subscriptions)
 Subscription Quantity - Subscription quantity (only applicable for --itemized-subscriptions)
 Subscription SKU - Subscription SKU (only applicable for --itemized-subscriptions)
 Subscription Contract - Subscription contract number (only applicable for --itemized-subscriptions)
 Subscription Account - Subscription account number (only applicable for --itemized-subscriptions)
 Subscription Start - Subscription start date (only applicable for --itemized-subscriptions)
 Subscription End - Subscription end date (only applicable for --itemized-subscriptions)
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.7. hammer csv content-view-filters
Copy link

import or export content-view-filters 

Usage:
    hammer csv content-view-filters [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.8. hammer csv content-views
Copy link

import or export content-views 

Usage:
    hammer csv content-views [OPTIONS]

Options:
 --[no-]promote                Publish and promote content view on import (default false)
 --[no-]publish                Publish content view on import (default false)
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.9. hammer csv domains
Copy link

import or export domains 

Usage:
    hammer csv domains [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

10.16.10. hammer csv export
Copy link

export into directory 

Usage:
    hammer csv export [OPTIONS]

Options:
 --dir DIRECTORY               Directory to export to
 --organization ORGANIZATION   Only process organization matching this name
 --settings FILE               Csv file for settings
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.11. hammer csv host-collections
Copy link

import or export host collections 

Usage:
    hammer csv host-collections [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.12. hammer csv host-groups
Copy link

import or export host-groups 

Usage:
    hammer csv host-groups [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.13. hammer csv hosts
Copy link

import or export hosts 

Usage:
    hammer csv hosts [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

10.16.14. hammer csv import
Copy link

import by directory 

Usage:
    hammer csv import [OPTIONS]

Options:
 --dir DIRECTORY               Directory to import from
 --organization ORGANIZATION   Only process organization matching this name
 --settings FILE               Csv file for settings
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.15. hammer csv installation-media
Copy link

import or export media 

Usage:
    hammer csv installation-media [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.16. hammer csv job-templates
Copy link

import or export job templates 

Usage:
    hammer csv job-templates [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.17. hammer csv lifecycle-environments
Copy link

import or export lifecycle environments 

Usage:
    hammer csv lifecycle-environments [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.18. hammer csv locations
Copy link

import or export locations 

Usage:
    hammer csv locations [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.19. hammer csv operating-systems
Copy link

import or export operating systems 

Usage:
    hammer csv operating-systems [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.20. hammer csv organizations
Copy link

import or export organizations 

Usage:
    hammer csv organizations [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.21. hammer csv partition-tables
Copy link

import or export partition tables 

Usage:
    hammer csv partition-tables [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.22. hammer csv products
Copy link

import or export products 

Usage:
    hammer csv products [OPTIONS]

Options:
 --[no-]sync                   Sync product repositories (default true)
                               Default: true
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.23. hammer csv provisioning-templates
Copy link

import or export provisioning templates 

Usage:
    hammer csv provisioning-templates [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --include-locked              Include locked templates (will fail if re-imported)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.24. hammer csv puppet-environments
Copy link

import or export puppet environments 

Usage:
    hammer csv puppet-environments [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.25. hammer csv puppet-facts
Copy link

import or export puppet facts 

Usage:
    hammer csv puppet-facts [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.26. hammer csv puppet-reports
Copy link

import or export puppet reports 

Usage:
    hammer csv puppet-reports [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.27. hammer csv reports
Copy link

import or export reports 

Usage:
    hammer csv reports [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.28. hammer csv roles
Copy link

import or export roles 

Usage:
    hammer csv roles [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

10.16.29. hammer csv settings
Copy link

import or export settings 

Usage:
    hammer csv settings [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.30. hammer csv smart-proxies
Copy link

import or export smart proxies 

Usage:
    hammer csv smart-proxies [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.31. hammer csv splice
Copy link

import Satellite-5 splice data 

Usage:
    hammer csv splice [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --dir DIR                     Directory of Splice exported CSV files (default pwd)
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --mapping-dir DIR             Directory of Splice product mapping files (default /usr/share/rhsm/product/RHEL-6)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.32. hammer csv subnets
Copy link

import or export subnets 

Usage:
    hammer csv subnets [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

10.16.33. hammer csv subscriptions
Copy link

import or export subscriptions 

Usage:
    hammer csv subscriptions [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.34. hammer csv sync-plans
Copy link

import or export repository sync plans 

Usage:
    hammer csv sync-plans [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

This command is unsupported and is provided as tech preview.

10.16.35. hammer csv users
Copy link

import or export users 

Usage:
    hammer csv users [OPTIONS]

Options:
 --continue-on-error           Continue processing even if individual resource error
 --export                      Export current data instead of importing
 --file FILE_NAME              CSV file (default to /dev/stdout with --export, otherwise required)
 --organization ORGANIZATION   Only process organization matching this name
 --search SEARCH               Only export search results
 -h, --help                    Print help
 -v, --verbose                 Be verbose

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

10.17. hammer defaults
Copy link

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
Copy to Clipboard Toggle word wrap

10.17.1. hammer defaults add
Copy link

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
Copy to Clipboard Toggle word wrap

10.17.2. hammer defaults delete
Copy link

Delete a default param 

Usage:
    hammer defaults delete [OPTIONS]

Options:
 --param-name OPTION_NAME      The name of the default option
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.17.3. hammer defaults list
Copy link

List all the default parameters 

Usage:
    hammer defaults list [OPTIONS]

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.17.4. hammer defaults providers
Copy link

List all the providers 

Usage:
    hammer defaults providers [OPTIONS]

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.18. hammer discovery
Copy link

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
Copy to Clipboard Toggle word wrap

10.18.1. hammer discovery auto-provision
Copy link

Auto provision a host 

Usage:
    hammer discovery auto-provision [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
Copy to Clipboard Toggle word wrap

10.18.2. hammer discovery delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.18.3. hammer discovery facts
Copy link

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
Copy to Clipboard Toggle word wrap

10.18.4. hammer discovery info
Copy link

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
Copy to Clipboard Toggle word wrap

10.18.5. hammer discovery list
Copy link

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
Copy to Clipboard Toggle word wrap

10.18.6. hammer discovery provision
Copy link

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.
 --environment ENVIRONMENT_NAME                          Environment name
 --environment-id ENVIRONMENT_ID
 --host-parameters-attributes HOST_PARAMETERS_ATTRIBUTES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup HOSTGROUP_NAME                              Hostgroup name
 --hostgroup-id HOSTGROUP_ID
 --hostgroup-title HOSTGROUP_TITLE                       Hostgroup title
 --id ID
 --image IMAGE_NAME                                      Name to search by
 --image-id IMAGE_ID
 --interface INTERFACE                                   Interface parameters
                                                         Comma-separated list of key=value
                                                         Can be specified multiple times.
 --ip IP                                                 Not required if using a subnet with DHCP Capsule
 --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
 --partition-table PARTITION_TABLE_NAME                  Partition table name
 --partition-table-id PARTITION_TABLE_ID
 --progress-report-id PROGRESS_REPORT_ID                 UUID to track orchestration tasks status, GET
                                                         /api/orchestration/:UUID/tasks
 --provision-method METHOD                               Possible value(s): 'build', 'image'
 --puppet-ca-proxy-id PUPPET_CA_PROXY_ID
 --puppet-proxy-id PUPPET_PROXY_ID
 --puppetclass-ids PUPPETCLASS_IDS                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --pxe-loader PXE_LOADER                                 DHCP filename option (Grub2 or PXELinux by default)
                                                         Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', '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
Copy to Clipboard Toggle word wrap

10.18.7. hammer discovery reboot
Copy link

Reboot a host 

Usage:
    hammer discovery reboot [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
Copy to Clipboard Toggle word wrap

10.18.8. hammer discovery refresh-facts
Copy link

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
Copy to Clipboard Toggle word wrap

10.19. hammer discovery-rule
Copy link

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
Copy to Clipboard Toggle word wrap

10.19.1. hammer discovery-rule create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.19.2. hammer discovery-rule delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.19.3. hammer discovery-rule info
Copy link

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
Copy to Clipboard Toggle word wrap

10.19.4. hammer discovery-rule list
Copy link

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
Copy to Clipboard Toggle word wrap

10.19.5. hammer discovery-rule update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.20. hammer docker
Copy link

Manipulate docker content 

Usage:
    hammer docker [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 container                     Manage docker containers
 manifest                      Manage docker manifests
 registry                      Manage docker registries
 tag                           Manage docker tags

Options:
 -h, --help                    Print help

Unfortunately the server does not support such operation.
Copy to Clipboard Toggle word wrap

10.20.1. hammer docker container
Copy link

Manage docker containers 

Usage:
    hammer docker container [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a container
 delete                        Delete a container
 info                          Show a container
 list                          List all containers
 logs                          Show container logs
 start                         Power a container on
 status                        Run power operation on a container
 stop                          Power a container off

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.20.1.1. hammer docker container create
Copy link

Create a container 

Usage:
    hammer docker container create [OPTIONS]

Options:
 --attach-stderr ATTACH_STDERR                 One of true/false, yes/no, 1/0.
 --attach-stdin ATTACH_STDIN                   One of true/false, yes/no, 1/0.
 --attach-stdout ATTACH_STDOUT                 One of true/false, yes/no, 1/0.
 --capsule CAPSULE_NAME                        Name to search by
 --capsule-id CAPSULE_ID                       Id of the capsule
 --command COMMAND
 --compute-resource COMPUTE_RESOURCE_NAME      Compute resource name
 --compute-resource-id COMPUTE_RESOURCE_ID
 --cpu-set CPU_SET
 --cpu-shares CPU_SHARES
 --entrypoint ENTRYPOINT
 --environment-variables ENVIRONMENT_VARIABLES Optional array of environment variables hashes. e.g.
                                               'environment_variables': [{'name' => 'example',
                                               'value' => '123'}]
                                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --locations LOCATION_NAMES                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --memory MEMORY
 --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
 --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
 --organizations ORGANIZATION_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --registry REGISTRY_NAME                      Name to search by
 --registry-id REGISTRY_ID
 --repository-name REPOSITORY_NAME             Name of the repository to use to create the container. e.g. centos
 --tag TAG                                     Tag to use to create the container. e.g. latest
 --tty TTY                                     One of true/false, yes/no, 1/0.
 -h, --help                                    Print help
Copy to Clipboard Toggle word wrap
10.20.1.2. hammer docker container delete
Copy link

Delete a container 

Usage:
    hammer docker container 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
Copy to Clipboard Toggle word wrap
10.20.1.3. hammer docker container info
Copy link

Show a container 

Usage:
    hammer docker container info [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
Copy to Clipboard Toggle word wrap
10.20.1.4. hammer docker container list
Copy link

List all containers 

Usage:
    hammer docker container list [OPTIONS]

Options:
 --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
 --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
Copy to Clipboard Toggle word wrap
10.20.1.5. hammer docker container logs
Copy link

Show container logs 

Usage:
    hammer docker container logs [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
 --stderr STDERR                           One of true/false, yes/no, 1/0.
 --stdout STDOUT                           One of true/false, yes/no, 1/0.
 --tail TAIL                               Number of lines to tail. Default: 100
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap
10.20.1.6. hammer docker container start
Copy link

Power a container on 

Usage:
    hammer docker container start [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
Copy to Clipboard Toggle word wrap
10.20.1.7. hammer docker container status
Copy link

Run power operation on a container 

Usage:
    hammer docker container status [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
Copy to Clipboard Toggle word wrap
10.20.1.8. hammer docker container stop
Copy link

Power a container off 

Usage:
    hammer docker container stop [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
Copy to Clipboard Toggle word wrap

10.20.2. hammer docker manifest
Copy link

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
Copy to Clipboard Toggle word wrap
10.20.2.1. hammer docker manifest info
Copy link

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
Copy to Clipboard Toggle word wrap
10.20.2.2. hammer docker manifest list
Copy link

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                      Environment name
 --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
 --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
Copy to Clipboard Toggle word wrap

10.20.3. hammer docker registry
Copy link

Manage docker registries 

Usage:
    hammer docker registry [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a docker registry
 delete                        Delete a docker registry
 info                          Show a docker registry
 list                          List all docker registries
 update                        Update a docker registry

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.20.3.1. hammer docker registry create
Copy link

Create a docker registry 

Usage:
    hammer docker registry create [OPTIONS]

Options:
 --description DESCRIPTION
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --password PASSWORD
 --url URL
 --username USERNAME
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap
10.20.3.2. hammer docker registry delete
Copy link

Delete a docker registry 

Usage:
    hammer docker registry 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
Copy to Clipboard Toggle word wrap
10.20.3.3. hammer docker registry info
Copy link

Show a docker registry 

Usage:
    hammer docker registry 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
Copy to Clipboard Toggle word wrap
10.20.3.4. hammer docker registry list
Copy link

List all docker registries 

Usage:
    hammer docker registry 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
Copy to Clipboard Toggle word wrap
10.20.3.5. hammer docker registry update
Copy link

Update a docker registry 

Usage:
    hammer docker registry update [OPTIONS]

Options:
 --description DESCRIPTION
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --password PASSWORD
 --url URL
 --username USERNAME
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.20.4. hammer docker tag
Copy link

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
Copy to Clipboard Toggle word wrap
10.20.4.1. hammer docker tag info
Copy link

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
Copy to Clipboard Toggle word wrap
10.20.4.2. hammer docker tag list
Copy link

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                      Environment name
 --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
 --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
Copy to Clipboard Toggle word wrap

10.21. hammer domain
Copy link

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
Copy to Clipboard Toggle word wrap

10.21.1. hammer domain create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.21.2. hammer domain delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.21.3. hammer domain delete-parameter
Copy link

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
Copy to Clipboard Toggle word wrap

10.21.4. hammer domain info
Copy link

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
Copy to Clipboard Toggle word wrap

10.21.5. hammer domain list
Copy link

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
Copy to Clipboard Toggle word wrap

10.21.6. hammer domain set-parameter
Copy link

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
 --value VALUE                 Parameter value
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.21.7. hammer domain update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.22. hammer environment
Copy link

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
Copy to Clipboard Toggle word wrap

10.22.1. hammer environment create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.22.2. hammer environment delete
Copy link

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                             Environment name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.22.3. hammer environment info
Copy link

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                             Environment name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.22.4. hammer environment list
Copy link

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
Copy to Clipboard Toggle word wrap

10.22.5. hammer environment sc-params
Copy link

List all smart class parameters 

Usage:
    hammer environment sc-params [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME          Environment name
 --environment-id ENVIRONMENT_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
Copy to Clipboard Toggle word wrap

10.22.6. hammer environment update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                               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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.23. hammer erratum
Copy link

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
Copy to Clipboard Toggle word wrap

10.23.1. hammer erratum info
Copy link

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
Copy to Clipboard Toggle word wrap

10.23.2. hammer erratum list
Copy link

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                            Environment name
 --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
Copy to Clipboard Toggle word wrap

10.24. hammer export-templates
Copy link

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
 --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
 --locations LOCATION_NAMES                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.25. hammer fact
Copy link

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
Copy to Clipboard Toggle word wrap

10.25.1. hammer fact list
Copy link

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
Copy to Clipboard Toggle word wrap

10.26. hammer file
Copy link

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
Copy to Clipboard Toggle word wrap

10.26.1. hammer file info
Copy link

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
Copy to Clipboard Toggle word wrap

10.26.2. hammer file list
Copy link

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                      Environment name
 --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
 --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
Copy to Clipboard Toggle word wrap

10.27. hammer filter
Copy link

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
Copy to Clipboard Toggle word wrap

10.27.1. hammer filter available-permissions
Copy link

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
Copy to Clipboard Toggle word wrap

10.27.2. hammer filter available-resources
Copy link

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
Copy to Clipboard Toggle word wrap

10.27.3. hammer filter create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --permissions PERMISSION_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --role ROLE_NAME                          User role name
 --role-id ROLE_ID
 --search SEARCH
 -h, --help                                Print help

Overriding organizations and locations:

Filters inherit organizations and locations from its role by default. This behavior can be changed by setting --override=true.
Therefore options --organization[s|-ids] and --location[s|-ids] are applicable only when the override flag is set.
Copy to Clipboard Toggle word wrap

10.27.4. hammer filter delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.27.5. hammer filter info
Copy link

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
Copy to Clipboard Toggle word wrap

10.27.6. hammer filter list
Copy link

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
Copy to Clipboard Toggle word wrap

10.27.7. hammer filter update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --permissions PERMISSION_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --role ROLE_NAME                          User role name
 --role-id ROLE_ID
 --search SEARCH
 -h, --help                                Print help

Overriding organizations and locations:

Filters inherit organizations and locations from its role by default. This behavior can be changed by setting --override=true.
Therefore options --organization[s|-ids] and --location[s|-ids] are applicable only when the override flag is set.
Copy to Clipboard Toggle word wrap

10.28. hammer foreign-input-set
Copy link

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
Copy to Clipboard Toggle word wrap

10.28.1. hammer foreign-input-set create
Copy link

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
Copy to Clipboard Toggle word wrap

10.28.2. hammer foreign-input-set delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.28.3. hammer foreign-input-set info
Copy link

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
Copy to Clipboard Toggle word wrap

10.28.4. hammer foreign-input-set list
Copy link

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
Copy to Clipboard Toggle word wrap

10.28.5. hammer foreign-input-set update
Copy link

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
Copy to Clipboard Toggle word wrap

10.29. hammer full-help
Copy link

Print help for all hammer commands 

Usage:
    hammer full-help [OPTIONS]

Options:
 --md                          Format output in markdown
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.30. hammer global-parameter
Copy link

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
Copy to Clipboard Toggle word wrap

10.30.1. hammer global-parameter delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.30.2. hammer global-parameter list
Copy link

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
Copy to Clipboard Toggle word wrap

10.30.3. hammer global-parameter set
Copy link

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
 --value VALUE                 Parameter value
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.31. hammer gpg
Copy link

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
Copy to Clipboard Toggle word wrap

10.31.1. hammer gpg create
Copy link

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
Copy to Clipboard Toggle word wrap

10.31.2. hammer gpg delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.31.3. hammer gpg info
Copy link

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
Copy to Clipboard Toggle word wrap

10.31.4. hammer gpg list
Copy link

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
Copy to Clipboard Toggle word wrap

10.31.5. hammer gpg update
Copy link

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
Copy to Clipboard Toggle word wrap

10.32. hammer host
Copy link

Manipulate hosts 

Usage:
    hammer host [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 ansible-roles                 List all Ansible roles for 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 update parameter for a host
 smart-variables               List all smart variables
 start                         Power a host on
 status                        Get configuration status of host
 stop                          Power a host off
 subscription                  Manage subscription information on your hosts
 update                        Update a host

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.32.1. hammer host ansible-roles
Copy link

List all Ansible roles for a host 

Usage:
    hammer host ansible-roles [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
Copy to Clipboard Toggle word wrap

10.32.2. hammer host boot
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.3. hammer host config-reports
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.4. hammer host create
Copy link

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
 --ansible-roles ANSIBLE_ROLE_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --compute-profile COMPUTE_PROFILE_NAME                        Name to search by
 --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
 --config-groups CONFIG_GROUP_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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-id ENVIRONMENT_ID
 --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
 --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. Values containing comma should be quoted or escaped with backslash
 --interface INTERFACE                                         Interface parameters
                                                               Comma-separated list of key=value
                                                               Can be specified multiple times.
 --ip IP                                                       Not required if using a subnet with DHCP Capsule
 --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                                           Host parameters
                                                               Comma-separated list of key=value
 --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
 --puppet-classes PUPPET_CLASS_NAMES                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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 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
                                                               Can be specified multiple times.
 -h, --help                                                    Print help

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:
    --compute-attributes:
      flavor_id
      image_id
      availability_zone
      security_group_ids
      managed_ip

  GCE:
    --compute-attributes:
      machine_type
      image_id
      network
      external_ip

  Libvirt:
    --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

    --interface:
      compute_type                      Possible values: bridge, network
      compute_network / compute_bridge  Name of interface according to type
      compute_model                     Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000

    --volume:
      pool_name           One of available storage pools
      capacity            String value, eg. 10G
      format_type         Possible values: raw, qcow2

  OpenStack:
    --compute-attributes:
      flavor_ref
      image_ref
      tenant_id
      security_groups
      network

  oVirt:
    --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
      start               Boolean (expressed as 0 or 1), whether to start the machine or not

    --interface:
      compute_name        Eg. eth0
      compute_network     Select one of available networks for a cluster, must be an ID

    --volume:
      size_gb             Volume size in GB, integer value
      storage_domain      ID of storage domain
      bootable            Boolean, only one volume can be bootable

  Rackspace:
    --compute-attributes:
      flavor_id
      image_id

  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
      start                 Must be a 1 or 0, whether to start the machine or not
      annotation            Annotation Notes

    --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

    --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
Copy to Clipboard Toggle word wrap

10.32.5. hammer host delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.6. hammer host delete-parameter
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.7. hammer host disassociate
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.8. hammer host enc-dump
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.9. hammer host errata
Copy link

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.
Copy to Clipboard Toggle word wrap
10.32.9.1. hammer host errata apply
Copy link

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
 --host HOST_NAME              Host name
 --host-id HOST_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.32.9.2. hammer host errata info
Copy link

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
Copy to Clipboard Toggle word wrap
10.32.9.3. hammer host errata list
Copy link

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    Environment name
 --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
Copy to Clipboard Toggle word wrap
10.32.9.4. hammer host errata recalculate
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.10. hammer host facts
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.11. hammer host info
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.12. hammer host interface
Copy link

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
Copy to Clipboard Toggle word wrap
10.32.12.1. hammer host interface create
Copy link

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
 --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
 --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
Copy to Clipboard Toggle word wrap
10.32.12.2. hammer host interface delete
Copy link

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
Copy to Clipboard Toggle word wrap
10.32.12.3. hammer host interface info
Copy link

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
Copy to Clipboard Toggle word wrap
10.32.12.4. hammer host interface list
Copy link

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
Copy to Clipboard Toggle word wrap
10.32.12.5. hammer host interface update
Copy link

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
 --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
 --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
Copy to Clipboard Toggle word wrap

10.32.13. hammer host list
Copy link

List all hosts 

Usage:
    hammer host list [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME          Environment name
 --environment-id ENVIRONMENT_ID
 --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
 --thin THIN                             Only list ID and name of hosts
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.32.14. hammer host package
Copy link

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.
Copy to Clipboard Toggle word wrap
10.32.14.1. hammer host package install
Copy link

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
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.32.14.2. hammer host package list
Copy link

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
Copy to Clipboard Toggle word wrap
10.32.14.3. hammer host package remove
Copy link

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
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.32.14.4. hammer host package upgrade
Copy link

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
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.32.14.5. hammer host package upgrade-all
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.15. hammer host package-group
Copy link

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.
Copy to Clipboard Toggle word wrap
10.32.15.1. hammer host package-group install
Copy link

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
 --host HOST_NAME              Host name
 --host-id HOST_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.32.15.2. hammer host package-group remove
Copy link

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
 --host HOST_NAME              Host name
 --host-id HOST_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.32.16. hammer host puppet-classes
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.17. hammer host puppetrun
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.18. hammer host reboot
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.19. hammer host rebuild-config
Copy link

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
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.32.20. hammer host reports
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.21. hammer host reset
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.22. hammer host sc-params
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.23. hammer host set-parameter
Copy link

Create or update 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
 --value VALUE                 Parameter value
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.32.24. hammer host smart-variables
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.25. hammer host start
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.26. hammer host status
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.27. hammer host stop
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.28. hammer host subscription
Copy link

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.
Copy to Clipboard Toggle word wrap
10.32.28.1. hammer host subscription attach
Copy link

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
Copy to Clipboard Toggle word wrap
10.32.28.2. hammer host subscription auto-attach
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap
10.32.28.5. hammer host subscription register
Copy link

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
 --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
 --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
Copy to Clipboard Toggle word wrap
10.32.28.6. hammer host subscription remove
Copy link
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
Copy to Clipboard Toggle word wrap
10.32.28.7. hammer host subscription unregister
Copy link

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
Copy to Clipboard Toggle word wrap

10.32.29. hammer host update
Copy link

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
 --ansible-roles ANSIBLE_ROLE_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --compute-profile COMPUTE_PROFILE_NAME                        Name to search by
 --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
 --config-groups CONFIG_GROUP_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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-id ENVIRONMENT_ID
 --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
 --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. Values containing comma should be quoted or escaped with backslash
 --interface INTERFACE                                         Interface parameters
                                                               Comma-separated list of key=value
                                                               Can be specified multiple times.
 --ip IP                                                       Not required if using a subnet with DHCP Capsule
 --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-name NEW_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.
 --owner OWNER_LOGIN                                           Login of the owner
 --owner-id OWNER_ID                                           ID of the owner
 --owner-type OWNER_TYPE                                       Host's owner type
                                                               Possible value(s): 'User', 'Usergroup'
 --parameters PARAMS                                           Host parameters
                                                               Comma-separated list of key=value
 --partition-table PARTITION_TABLE_NAME                        Partition table name
 --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
 --puppet-classes PUPPET_CLASS_NAMES                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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 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
                                                               Can be specified multiple times.
 -h, --help                                                    Print help

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:
    --compute-attributes:
      flavor_id
      image_id
      availability_zone
      security_group_ids
      managed_ip

  GCE:
    --compute-attributes:
      machine_type
      image_id
      network
      external_ip

  Libvirt:
    --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

    --interface:
      compute_type                      Possible values: bridge, network
      compute_network / compute_bridge  Name of interface according to type
      compute_model                     Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000

    --volume:
      pool_name           One of available storage pools
      capacity            String value, eg. 10G
      format_type         Possible values: raw, qcow2

  OpenStack:
    --compute-attributes:
      flavor_ref
      image_ref
      tenant_id
      security_groups
      network

  oVirt:
    --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
      start               Boolean (expressed as 0 or 1), whether to start the machine or not

    --interface:
      compute_name        Eg. eth0
      compute_network     Select one of available networks for a cluster, must be an ID

    --volume:
      size_gb             Volume size in GB, integer value
      storage_domain      ID of storage domain
      bootable            Boolean, only one volume can be bootable

  Rackspace:
    --compute-attributes:
      flavor_id
      image_id

  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
      start                 Must be a 1 or 0, whether to start the machine or not
      annotation            Annotation Notes

    --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

    --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
Copy to Clipboard Toggle word wrap

10.33. hammer host-collection
Copy link

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
Copy to Clipboard Toggle word wrap

10.33.1. hammer host-collection add-host
Copy link

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
 --hosts HOST_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.33.2. hammer host-collection copy
Copy link

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
Copy to Clipboard Toggle word wrap

10.33.3. hammer host-collection create
Copy link

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
 --hosts HOST_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.33.4. hammer host-collection delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.33.5. hammer host-collection erratum
Copy link

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.
Copy to Clipboard Toggle word wrap
10.33.5.1. hammer host-collection erratum install
Copy link

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
 --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
Copy to Clipboard Toggle word wrap

10.33.6. hammer host-collection hosts
Copy link

List all hosts 

Usage:
    hammer host-collection hosts [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME          Environment name
 --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
Copy to Clipboard Toggle word wrap

10.33.7. hammer host-collection info
Copy link

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
Copy to Clipboard Toggle word wrap

10.33.8. hammer host-collection list
Copy link

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
Copy to Clipboard Toggle word wrap

10.33.9. hammer host-collection package
Copy link

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.
Copy to Clipboard Toggle word wrap
10.33.9.1. hammer host-collection package install
Copy link

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.33.9.2. hammer host-collection package remove
Copy link

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.33.9.3. hammer host-collection package update
Copy link

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.33.10. hammer host-collection package-group
Copy link

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.
Copy to Clipboard Toggle word wrap

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.33.11. hammer host-collection remove-host
Copy link

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
 --hosts HOST_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.33.12. hammer host-collection update
Copy link

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
 --hosts HOST_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.34. hammer hostgroup
Copy link

Manipulate hostgroups 

Usage:
    hammer hostgroup [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 ansible-roles                 List all Ansible roles for 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
 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
Copy to Clipboard Toggle word wrap

10.34.1. hammer hostgroup ansible-roles
Copy link

List all Ansible roles for a hostgroup 

Usage:
    hammer hostgroup ansible-roles [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
Copy to Clipboard Toggle word wrap

10.34.2. hammer hostgroup create
Copy link

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
 --ansible-roles ANSIBLE_ROLE_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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                    Name to search by
 --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
 --config-groups CONFIG_GROUP_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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-id ENVIRONMENT_ID
 --group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of parameters
                                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --locations LOCATION_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --puppet-classes PUPPET_CLASS_NAMES                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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 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
 -h, --help                                                Print help
Copy to Clipboard Toggle word wrap

10.34.3. hammer hostgroup delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.34.4. hammer hostgroup delete-parameter
Copy link

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
Copy to Clipboard Toggle word wrap

10.34.5. hammer hostgroup info
Copy link

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
Copy to Clipboard Toggle word wrap

10.34.6. hammer hostgroup list
Copy link

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
Copy to Clipboard Toggle word wrap

10.34.7. hammer hostgroup puppet-classes
Copy link

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
Copy to Clipboard Toggle word wrap

10.34.8. hammer hostgroup sc-params
Copy link

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
Copy to Clipboard Toggle word wrap

10.34.9. hammer hostgroup set-parameter
Copy link

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
 --value VALUE                     Parameter value
 -h, --help                        Print help
Copy to Clipboard Toggle word wrap

10.34.10. hammer hostgroup smart-variables
Copy link

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
Copy to Clipboard Toggle word wrap

10.34.11. hammer hostgroup update
Copy link

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
 --ansible-roles ANSIBLE_ROLE_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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                    Name to search by
 --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
 --config-groups CONFIG_GROUP_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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-id ENVIRONMENT_ID
 --group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of parameters
                                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --locations LOCATION_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --puppet-classes PUPPET_CLASS_NAMES                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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 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
 --title TITLE                                             Hostgroup title
 -h, --help                                                Print help
Copy to Clipboard Toggle word wrap

10.35. hammer import-templates
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.36. hammer job-invocation
Copy link

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
Copy to Clipboard Toggle word wrap

10.36.1. hammer job-invocation cancel
Copy link

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
Copy to Clipboard Toggle word wrap

10.36.2. hammer job-invocation create
Copy link

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
 --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
Copy to Clipboard Toggle word wrap

10.36.3. hammer job-invocation info
Copy link

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
Copy to Clipboard Toggle word wrap

10.36.4. hammer job-invocation list
Copy link

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
Copy to Clipboard Toggle word wrap

10.36.5. hammer job-invocation output
Copy link

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
Copy to Clipboard Toggle word wrap

10.36.6. hammer job-invocation rerun
Copy link

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
Copy to Clipboard Toggle word wrap

10.37. hammer job-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.37.1. hammer job-template create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.37.2. hammer job-template delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.37.3. hammer job-template dump
Copy link

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
Copy to Clipboard Toggle word wrap

10.37.4. hammer job-template export
Copy link

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
Copy to Clipboard Toggle word wrap

10.37.5. hammer job-template import
Copy link

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
Copy to Clipboard Toggle word wrap

10.37.6. hammer job-template info
Copy link

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
Copy to Clipboard Toggle word wrap

10.37.7. hammer job-template list
Copy link

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
Copy to Clipboard Toggle word wrap

10.37.8. hammer job-template update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.38. hammer lifecycle-environment
Copy link

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
Copy to Clipboard Toggle word wrap

10.38.1. hammer lifecycle-environment create
Copy link

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
Copy to Clipboard Toggle word wrap

10.38.2. hammer lifecycle-environment delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.38.3. hammer lifecycle-environment info
Copy link

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
Copy to Clipboard Toggle word wrap

10.38.4. hammer lifecycle-environment list
Copy link

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
Copy to Clipboard Toggle word wrap

10.38.5. hammer lifecycle-environment paths
Copy link

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
Copy to Clipboard Toggle word wrap

10.38.6. hammer lifecycle-environment update
Copy link

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
Copy to Clipboard Toggle word wrap

10.39. hammer location
Copy link

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 an environment
 add-hostgroup                 Associate a hostgroup
 add-medium                    Associate a medium
 add-organization              Associate an organization
 add-smart-proxy               Associate a smart proxy
 add-subnet                    Associate a subnet
 add-user                      Associate an user
 create                        Create a location
 delete                        Delete a location
 delete-parameter              Delete parameter for a location
 info                          Show a location
 list                          List all locations
 remove-compute-resource       Disassociate a compute resource
 remove-config-template        Disassociate a configuration template
 remove-domain                 Disassociate a domain
 remove-environment            Disassociate an environment
 remove-hostgroup              Disassociate a hostgroup
 remove-medium                 Disassociate a medium
 remove-organization           Disassociate an organization
 remove-smart-proxy            Disassociate a smart proxy
 remove-subnet                 Disassociate a subnet
 remove-user                   Disassociate an user
 set-parameter                 Create or update parameter for a location
 update                        Update a location

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.39.1. hammer location add-compute-resource
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.2. hammer location add-config-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.3. hammer location add-domain
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.4. hammer location add-environment
Copy link

Associate an environment 

Usage:
    hammer location add-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID
 --name NAME                     Location name
 --title TITLE                   Location title
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

10.39.5. hammer location add-hostgroup
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.6. hammer location add-medium
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.7. hammer location add-organization
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.8. hammer location add-smart-proxy
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.9. hammer location add-subnet
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.10. hammer location add-user
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.11. hammer location create
Copy link

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
 --compute-resources COMPUTE_RESOURCE_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-template-ids CONFIG_TEMPLATE_IDS             Provisioning template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-templates CONFIG_TEMPLATE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --description DESCRIPTION
 --domain-ids DOMAIN_IDS                               Domain IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --domains DOMAIN_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environment-ids ENVIRONMENT_IDS                     Environment IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environments ENVIRONMENT_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-ids HOSTGROUP_IDS                         Host group IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-titles HOSTGROUP_TITLES                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES                          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --medium-ids MEDIUM_IDS                               Medium IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --partition-tables PARTITION_TABLE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-templates PROVISIONING_TEMPLATE_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realm-ids REALM_IDS                                 Realm IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realms REALM_NAMES                                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --smart-proxies SMART_PROXY_NAMES                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --smart-proxy-ids SMART_PROXY_IDS                     Capsule IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnet-ids SUBNET_IDS                               Subnet IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnets SUBNET_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-ids USER_IDS                                   User IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --users USER_LOGINS                                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.39.12. hammer location delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.13. hammer location delete-parameter
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.14. hammer location info
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.15. hammer location list
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.16. hammer location remove-compute-resource
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.17. hammer location remove-config-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.18. hammer location remove-domain
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.19. hammer location remove-environment
Copy link

Disassociate an environment 

Usage:
    hammer location remove-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID
 --name NAME                     Location name
 --title TITLE                   Location title
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

10.39.20. hammer location remove-hostgroup
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.21. hammer location remove-medium
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.22. hammer location remove-organization
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.23. hammer location remove-smart-proxy
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.24. hammer location remove-subnet
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.25. hammer location remove-user
Copy link

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
Copy to Clipboard Toggle word wrap

10.39.26. hammer location set-parameter
Copy link

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
 --value VALUE                   Parameter value
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

10.39.27. hammer location update
Copy link

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
 --compute-resources COMPUTE_RESOURCE_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-template-ids CONFIG_TEMPLATE_IDS             Provisioning template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-templates CONFIG_TEMPLATE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --description DESCRIPTION
 --domain-ids DOMAIN_IDS                               Domain IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --domains DOMAIN_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environment-ids ENVIRONMENT_IDS                     Environment IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environments ENVIRONMENT_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-ids HOSTGROUP_IDS                         Host group IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-titles HOSTGROUP_TITLES                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES                          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --medium-ids MEDIUM_IDS                               Medium IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --partition-tables PARTITION_TABLE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-templates PROVISIONING_TEMPLATE_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realm-ids REALM_IDS                                 Realm IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realms REALM_NAMES                                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --smart-proxies SMART_PROXY_NAMES                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --smart-proxy-ids SMART_PROXY_IDS                     Capsule IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnet-ids SUBNET_IDS                               Subnet IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnets SUBNET_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --users USER_LOGINS                                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.40. hammer medium
Copy link

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
Copy to Clipboard Toggle word wrap

10.40.1. hammer medium add-operatingsystem
Copy link

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
Copy to Clipboard Toggle word wrap

10.40.2. hammer medium create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                               Name of media
 --operatingsystem-ids OPERATINGSYSTEM_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --os-family OS_FAMILY                     Operating system family, available values: AIX, Altlinux, Archlinux,
                                           Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,
                                           Suse, Windows, Xenserver
 --path PATH                               The path to the medium, can be a URL or a valid NFS server (exclusive of
                                           The architecture).

                                           For example mirror.centos.org/centos/$version/os/$arch
                                           Where $arch will be substituted for the host's actual OS architecture
                                           And $version, $major and $minor will be substituted for the version of the
                                           Operating system.

                                           Solaris and Debian media may also use $release.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.40.3. hammer medium delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.40.4. hammer medium info
Copy link

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
Copy to Clipboard Toggle word wrap

10.40.5. hammer medium list
Copy link

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
Copy to Clipboard Toggle word wrap

10.40.6. hammer medium remove-operatingsystem
Copy link

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
Copy to Clipboard Toggle word wrap

10.40.7. hammer medium update
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --os-family OS_FAMILY                     Operating system family, available values: AIX, Altlinux, Archlinux,
                                           Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,
                                           Suse, Windows, Xenserver
 --path PATH                               The path to the medium, can be a URL or a valid NFS server (exclusive of
                                           The architecture).

                                           For example mirror.centos.org/centos/$version/os/$arch
                                           Where $arch will be substituted for the host's actual OS architecture
                                           And $version, $major and $minor will be substituted for the version of the
                                           Operating system.

                                           Solaris and Debian media may also use $release.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.41. hammer model
Copy link

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
Copy to Clipboard Toggle word wrap

10.41.1. hammer model create
Copy link

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
Copy to Clipboard Toggle word wrap

10.41.2. hammer model delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.41.3. hammer model info
Copy link

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
Copy to Clipboard Toggle word wrap

10.41.4. hammer model list
Copy link

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
Copy to Clipboard Toggle word wrap

10.41.5. hammer model update
Copy link

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
Copy to Clipboard Toggle word wrap

10.42. hammer module-stream
Copy link

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
Copy to Clipboard Toggle word wrap

10.42.1. hammer module-stream info
Copy link

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
Copy to Clipboard Toggle word wrap

10.42.2. hammer module-stream list
Copy link

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                      Environment name
 --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
 --hosts HOST_NAMES                                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --ids IDS                                           Ids to filter content by
                                                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.43. hammer organization
Copy link

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 an environment
 add-hostgroup                 Associate a hostgroup
 add-location                  Associate a location
 add-medium                    Associate a medium
 add-smart-proxy               Associate a smart proxy
 add-subnet                    Associate a subnet
 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 an environment
 remove-hostgroup              Disassociate a hostgroup
 remove-location               Disassociate a location
 remove-medium                 Disassociate a medium
 remove-smart-proxy            Disassociate a smart proxy
 remove-subnet                 Disassociate a subnet
 remove-user                   Disassociate an user
 set-parameter                 Create or update parameter for an organization
 update                        Update organization

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.43.1. hammer organization add-compute-resource
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.2. hammer organization add-config-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.3. hammer organization add-domain
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.4. hammer organization add-environment
Copy link

Associate an environment 

Usage:
    hammer organization add-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                         Organization ID
 --name NAME                     Organization name
 --title TITLE                   Organization title
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

10.43.5. hammer organization add-hostgroup
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.6. hammer organization add-location
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.7. hammer organization add-medium
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.8. hammer organization add-smart-proxy
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.9. hammer organization add-subnet
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.10. hammer organization add-user
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.11. hammer organization create
Copy link

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
 --compute-resources COMPUTE_RESOURCE_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-template-ids CONFIG_TEMPLATE_IDS             Provisioning template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-templates CONFIG_TEMPLATE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --description DESCRIPTION                             Description
 --domain-ids DOMAIN_IDS                               Domain IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --domains DOMAIN_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environment-ids ENVIRONMENT_IDS                     Environment IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environments ENVIRONMENT_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-ids HOSTGROUP_IDS                         Host group IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-titles HOSTGROUP_TITLES                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES                          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --medium-ids MEDIUM_IDS                               Medium IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --provisioning-templates PROVISIONING_TEMPLATE_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --ptable-ids PTABLE_IDS                               Partition template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --ptables PTABLE_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realm-ids REALM_IDS                                 Realm IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realms REALM_NAMES                                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --smart-proxies SMART_PROXY_NAMES                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --smart-proxy-ids SMART_PROXY_IDS                     Capsule IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnet-ids SUBNET_IDS                               Subnet IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnets SUBNET_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-ids USER_IDS                                   User IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --users USER_LOGINS                                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.43.12. hammer organization delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.13. hammer organization delete-parameter
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.14. hammer organization info
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.15. hammer organization list
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

10.43.18. hammer organization remove-domain
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.19. hammer organization remove-environment
Copy link

Disassociate an environment 

Usage:
    hammer organization remove-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                         Organization ID
 --name NAME                     Organization name
 --title TITLE                   Organization title
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

10.43.20. hammer organization remove-hostgroup
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.21. hammer organization remove-location
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.22. hammer organization remove-medium
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.23. hammer organization remove-smart-proxy
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.24. hammer organization remove-subnet
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.25. hammer organization remove-user
Copy link

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
Copy to Clipboard Toggle word wrap

10.43.26. hammer organization set-parameter
Copy link

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
 --value VALUE                           Parameter value
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.43.27. hammer organization update
Copy link

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
 --compute-resources COMPUTE_RESOURCE_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-template-ids CONFIG_TEMPLATE_IDS             Provisioning template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --config-templates CONFIG_TEMPLATE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --description DESCRIPTION
 --domain-ids DOMAIN_IDS                               Domain IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --domains DOMAIN_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environment-ids ENVIRONMENT_IDS                     Environment IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --environments ENVIRONMENT_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-ids HOSTGROUP_IDS                         Host group IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-titles HOSTGROUP_TITLES                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES                          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --medium-ids MEDIUM_IDS                               Medium IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --partition-tables PARTITION_TABLE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-templates PROVISIONING_TEMPLATE_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --ptable-ids PTABLE_IDS                               Partition template IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --ptables PTABLE_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realm-ids REALM_IDS                                 Realm IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realms REALM_NAMES                                  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --smart-proxy-ids SMART_PROXY_IDS                     Capsule IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnet-ids SUBNET_IDS                               Subnet IDs
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --subnets SUBNET_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --users USER_LOGINS                                   Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.44. hammer os
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.1. hammer os add-architecture
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.2. hammer os add-config-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.3. hammer os add-ptable
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.4. hammer os create
Copy link

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
 --architectures ARCHITECTURE_NAMES                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --config-templates CONFIG_TEMPLATE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --medium-ids MEDIUM_IDS                               IDs of associated media
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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. Values containing comma should be quoted or escaped with backslash
 --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
 --partition-tables PARTITION_TABLE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --password-hash PASSWORD_HASH                         Root password hash function to use, one of MD5, SHA256, SHA512, Base64
 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated provisioning templates
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-templates PROVISIONING_TEMPLATE_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --release-name RELEASE_NAME
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.44.5. hammer os delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.6. hammer os delete-default-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.7. hammer os delete-parameter
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.8. hammer os info
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.9. hammer os list
Copy link

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. Values containing comma should be quoted or escaped with backslash
 --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
Copy to Clipboard Toggle word wrap

10.44.10. hammer os remove-architecture
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.11. hammer os remove-config-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.12. hammer os remove-ptable
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.13. hammer os set-default-template
Copy link

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
Copy to Clipboard Toggle word wrap

10.44.14. hammer os set-parameter
Copy link

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
 --value VALUE                           Parameter value
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.44.15. hammer os update
Copy link

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
 --architectures ARCHITECTURE_NAMES                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --config-templates CONFIG_TEMPLATE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --medium-ids MEDIUM_IDS                               IDs of associated media
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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. Values containing comma should be quoted or escaped with backslash
 --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
 --partition-tables PARTITION_TABLE_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --password-hash PASSWORD_HASH                         Root password hash function to use, one of MD5, SHA256, SHA512, Base64
 --provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated provisioning templates
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --provisioning-templates PROVISIONING_TEMPLATE_NAMES  Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --release-name RELEASE_NAME
 --title TITLE                                         Operating system title
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.45. hammer ostree-branch
Copy link

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
Copy to Clipboard Toggle word wrap

10.45.1. hammer ostree-branch info
Copy link

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
Copy to Clipboard Toggle word wrap

10.45.2. hammer ostree-branch list
Copy link

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                      Environment name
 --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
 --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
Copy to Clipboard Toggle word wrap

10.46. hammer package
Copy link

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
Copy to Clipboard Toggle word wrap

10.46.1. hammer package info
Copy link

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
Copy to Clipboard Toggle word wrap

10.46.2. hammer package list
Copy link

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                              Environment name
 --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
 --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
Copy to Clipboard Toggle word wrap

10.47. hammer package-group
Copy link

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
Copy to Clipboard Toggle word wrap

10.47.1. hammer package-group info
Copy link

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
Copy to Clipboard Toggle word wrap

10.47.2. hammer package-group list
Copy link

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                      Environment name
 --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
 --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
Copy to Clipboard Toggle word wrap

10.48. hammer partition-table
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

10.48.2. hammer partition-table create
Copy link

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
 --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
 --hostgroup-titles HOSTGROUP_TITLES       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hosts HOST_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --os-family OS_FAMILY
 --snippet SNIPPET                         One of true/false, yes/no, 1/0.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.48.3. hammer partition-table delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.48.4. hammer partition-table dump
Copy link

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
Copy to Clipboard Toggle word wrap

10.48.5. hammer partition-table info
Copy link

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
Copy to Clipboard Toggle word wrap

10.48.6. hammer partition-table list
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

10.48.8. hammer partition-table update
Copy link

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
 --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
 --hostgroup-titles HOSTGROUP_TITLES       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES              Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hosts HOST_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --os-family OS_FAMILY
 --snippet SNIPPET                         One of true/false, yes/no, 1/0.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.49. hammer ping
Copy link

Get the status of the server 

Usage:
    hammer ping [OPTIONS]

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.50. hammer policy
Copy link

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
Copy to Clipboard Toggle word wrap

10.50.1. hammer policy create
Copy link

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”)
 --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
 --hostgroup-ids HOSTGROUP_IDS                         Apply policy to host groups
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES                          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hosts HOST_NAMES                                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --locations LOCATION_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --organizations ORGANIZATION_NAMES                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --period PERIOD                                       Policy schedule period (weekly, monthly, custom)
 --scap-content SCAP_CONTENT_TITLE                     SCAP content title
 --scap-content-id SCAP_CONTENT_ID
 --scap-content-profile-id SCAP_CONTENT_PROFILE_ID     Policy SCAP content profile ID
 --tailoring-file TAILORING_FILE_NAME                  Tailoring file name
 --tailoring-file-id TAILORING_FILE_ID
 --tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file profile ID
 --weekday WEEKDAY                                     Policy schedule weekday (only if period == “weekly”)
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.50.2. hammer policy delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.50.3. hammer policy info
Copy link

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
Copy to Clipboard Toggle word wrap

10.50.4. hammer policy list
Copy link

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
Copy to Clipboard Toggle word wrap

10.50.5. hammer policy update
Copy link

Update a Policy 

Usage:
    hammer policy update [OPTIONS]

Options:
 --cron-line CRON_LINE                                 Policy schedule cron line (only if period == “custom”)
 --day-of-month DAY_OF_MONTH                           Policy schedule day of month (only if period == “monthly”)
 --description DESCRIPTION                             Policy description
 --host-ids HOST_IDS                                   Apply policy to hosts
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroup-ids HOSTGROUP_IDS                         Apply policy to host groups
                                                       Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hostgroups HOSTGROUP_NAMES                          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --hosts HOST_NAMES                                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --locations LOCATION_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --organizations ORGANIZATION_NAMES                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --period PERIOD                                       Policy schedule period (weekly, monthly, custom)
 --scap-content SCAP_CONTENT_TITLE                     SCAP content title
 --scap-content-id SCAP_CONTENT_ID
 --scap-content-profile-id SCAP_CONTENT_PROFILE_ID     Policy SCAP content profile ID
 --tailoring-file TAILORING_FILE_NAME                  Tailoring file name
 --tailoring-file-id TAILORING_FILE_ID
 --tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file profile ID
 --weekday WEEKDAY                                     Policy schedule weekday (only if period == “weekly”)
 -h, --help                                            Print help
Copy to Clipboard Toggle word wrap

10.51. hammer product
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.1. hammer product create
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.2. hammer product delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.3. hammer product info
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.4. hammer product list
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.5. hammer product remove-sync-plan
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.6. hammer product set-sync-plan
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.7. hammer product synchronize
Copy link

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
Copy to Clipboard Toggle word wrap

10.51.8. hammer product update
Copy link

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
Copy to Clipboard Toggle word wrap

10.52. hammer proxy
Copy link

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
Copy to Clipboard Toggle word wrap

10.52.1. hammer proxy content
Copy link

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
Copy to Clipboard Toggle word wrap

Add lifecycle environments to the capsule 

Usage:
    hammer proxy content add-lifecycle-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                         Id of the capsule
 --name NAME                     Name to search by
 --organization NAME             Organization name
 --organization-id ID            Organization ID
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap
10.52.1.4. hammer proxy content info
Copy link

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

Remove lifecycle environments from the capsule 

Usage:
    hammer proxy content remove-lifecycle-environment [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME  Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                         Id of the capsule
 --name NAME                     Name to search by
 --organization NAME             Organization name
 --organization-id ID            Organization ID
 -h, --help                      Print help
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap
10.52.1.8. hammer proxy content synchronize
Copy link

Synchronize the content to the capsule 

Usage:
    hammer proxy content synchronize [OPTIONS]

Options:
 --async                                   Do not wait for the task
 --environment ENVIRONMENT_NAME            Environment name
 --environment-id ENVIRONMENT_ID
 --id ID                                   Id of the capsule
 --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
Copy to Clipboard Toggle word wrap

10.52.2. hammer proxy create
Copy link

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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --url URL
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.52.3. hammer proxy delete
Copy link

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
Copy to Clipboard Toggle word wrap

10.52.4. hammer proxy import-classes
Copy link

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-id ENVIRONMENT_ID
 --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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.52.5. hammer proxy info
Copy link

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
Copy to Clipboard Toggle word wrap

10.52.6. hammer proxy list
Copy link

List all capsules 

Usage:
    hammer proxy 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
Copy to Clipboard Toggle word wrap

10.52.7. hammer proxy refresh-features
Copy link

Refresh capsule features 

Usage:
    hammer proxy 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
Copy to Clipboard Toggle word wrap

10.52.8. hammer proxy update
Copy link

Update a capsule 

Usage:
    hammer proxy 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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --url URL
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.53. hammer puppet-class
Copy link

Search puppet modules 

Usage:
    hammer puppet-class [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 info                          Show a Puppet class
 list                          List all Puppet classes
 sc-params                     List all smart class parameters
 smart-variables               List all smart variables

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.53.1. hammer puppet-class info
Copy link

Show a Puppet class 

Usage:
    hammer puppet-class info [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME          Environment name
 --environment-id ENVIRONMENT_ID
 --host HOST_NAME                        Host name
 --host-id HOST_ID
 --hostgroup HOSTGROUP_NAME              Hostgroup name
 --hostgroup-id HOSTGROUP_ID
 --hostgroup-title HOSTGROUP_TITLE       Hostgroup title
 --id ID                                 ID of Puppet class
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Puppet class name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.53.2. hammer puppet-class list
Copy link

List all Puppet classes 

Usage:
    hammer puppet-class list [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME          Environment name
 --environment-id ENVIRONMENT_ID
 --host HOST_NAME                        Host name
 --host-id HOST_ID
 --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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.53.3. hammer puppet-class sc-params
Copy link

List all smart class parameters 

Usage:
    hammer puppet-class sc-params [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
 --show-hidden SHOW_HIDDEN               Display hidden values
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.53.4. hammer puppet-class smart-variables
Copy link

List all smart variables 

Usage:
    hammer puppet-class smart-variables [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
 --show-hidden SHOW_HIDDEN               Display hidden values
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.54. hammer puppet-module
Copy link

View Puppet Module details 

Usage:
    hammer puppet-module [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 info                          Show a puppet module
 list                          List puppet_modules

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.54.1. hammer puppet-module info
Copy link

Show a puppet module 

Usage:
    hammer puppet-module info [OPTIONS]

Options:
 --id ID                                 A puppet module 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
 --repository REPOSITORY_NAME            Repository name to search by
 --repository-id REPOSITORY_ID           Repository ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.54.2. hammer puppet-module list
Copy link

List puppet_modules 

Usage:
    hammer puppet-module 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                      Environment name
 --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
 --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
Copy to Clipboard Toggle word wrap

10.55. hammer realm
Copy link

Manipulate realms 

Usage:
    hammer realm [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a realm
 delete                        Delete a realm
 info                          Show a realm
 list                          List of realms
 update                        Update a realm

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.55.1. hammer realm create
Copy link

Create a realm 

Usage:
    hammer realm 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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                               The realm name, e.g. EXAMPLE.COM
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realm-proxy-id REALM_PROXY_ID           Capsule ID to use within this realm
 --realm-type REALM_TYPE                   Realm type, e.g. Red Hat Identity Management or Active Directory
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.55.2. hammer realm delete
Copy link

Delete a realm 

Usage:
    hammer realm 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
Copy to Clipboard Toggle word wrap

10.55.3. hammer realm info
Copy link

Show a realm 

Usage:
    hammer realm info [OPTIONS]

Options:
 --id ID                                 Numerical ID or realm name
 --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
Copy to Clipboard Toggle word wrap

10.55.4. hammer realm list
Copy link

List of realms 

Usage:
    hammer realm 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
Copy to Clipboard Toggle word wrap

10.55.5. hammer realm update
Copy link

Update a realm 

Usage:
    hammer realm 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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                               Name to search by
 --new-name NEW_NAME                       The realm name, e.g. EXAMPLE.COM
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --realm-proxy-id REALM_PROXY_ID           Capsule ID to use within this realm
 --realm-type REALM_TYPE                   Realm type, e.g. Red Hat Identity Management or Active Directory
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.56. hammer recurring-logic
Copy link

Recurring logic related actions 

Usage:
    hammer recurring-logic [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 cancel                        Cancel recurring logic
 info                          Show recurring logic details
 list                          List recurring logics

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.56.1. hammer recurring-logic cancel
Copy link

Cancel recurring logic 

Usage:
    hammer recurring-logic cancel [OPTIONS]

Options:
 --id ID                                 ID of the recurring logic
 --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
Copy to Clipboard Toggle word wrap

10.56.2. hammer recurring-logic info
Copy link

Show recurring logic details 

Usage:
    hammer recurring-logic info [OPTIONS]

Options:
 --id ID                                 ID of the recurring logic
 --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
Copy to Clipboard Toggle word wrap

10.56.3. hammer recurring-logic list
Copy link

List recurring logics 

Usage:
    hammer recurring-logic 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
Copy to Clipboard Toggle word wrap

10.57. hammer remote-execution-feature
Copy link

Manage remote execution features 

Usage:
    hammer remote-execution-feature [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 info                          Show remote execution feature
 list                          List remote execution features
 update                        Update a job template

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.57.1. hammer remote-execution-feature info
Copy link

Show remote execution feature 

Usage:
    hammer remote-execution-feature 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
Copy to Clipboard Toggle word wrap

10.57.2. hammer remote-execution-feature list
Copy link

List remote execution features 

Usage:
    hammer remote-execution-feature list [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
Copy to Clipboard Toggle word wrap

10.57.3. hammer remote-execution-feature update
Copy link

Update a job template 

Usage:
    hammer remote-execution-feature update [OPTIONS]

Options:
 --id ID
 --job-template JOB_TEMPLATE_NAME        Name to search by
 --job-template-id JOB_TEMPLATE_ID
 --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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.58. hammer report
Copy link

Browse and read reports 

Usage:
    hammer 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
Copy to Clipboard Toggle word wrap

10.58.1. hammer report delete
Copy link

Delete a report 

Usage:
    hammer 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
Copy to Clipboard Toggle word wrap

10.58.2. hammer report info
Copy link

Show a report 

Usage:
    hammer 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
Copy to Clipboard Toggle word wrap

10.58.3. hammer report list
Copy link

List all reports 

Usage:
    hammer 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
Copy to Clipboard Toggle word wrap

10.59. hammer report-template
Copy link

Manipulate report templates 

Usage:
    hammer report-template [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 clone                         Clone a template
 create                        Create a report template
 delete                        Delete a report template
 dump                          View report content
 generate                      Generate report
 info                          Show a report template
 list                          List all report templates
 update                        Update a report template

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.59.1. hammer report-template clone
Copy link

Clone a template 

Usage:
    hammer report-template clone [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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.59.2. hammer report-template create
Copy link

Create a report template 

Usage:
    hammer report-template create [OPTIONS]

Options:
 --audit-comment AUDIT_COMMENT
 --default DEFAULT                         Whether or not the template is added automatically to new organizations and
                                           Locations
                                           One of true/false, yes/no, 1/0.
 --file LAYOUT                             Path to a file that contains the report template content
 --interactive, -i                         Open empty template in an $EDITOR. Upload the result
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --locked LOCKED                           Whether or not the template is locked for editing
                                           One of true/false, yes/no, 1/0.
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --snippet SNIPPET                         One of true/false, yes/no, 1/0.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.59.3. hammer report-template delete
Copy link

Delete a report template 

Usage:
    hammer report-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
Copy to Clipboard Toggle word wrap

10.59.4. hammer report-template dump
Copy link

View report content 

Usage:
    hammer report-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
Copy to Clipboard Toggle word wrap

10.59.5. hammer report-template generate
Copy link

Generate report 

Usage:
    hammer report-template generate [OPTIONS]

Options:
 --id ID
 --inputs INPUTS                         Specify inputs
                                         Comma-separated list of key=value
 --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
 --path PATH                             Path to directory where downloaded content will be saved
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.59.6. hammer report-template info
Copy link

Show a report template 

Usage:
    hammer report-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
Copy to Clipboard Toggle word wrap

10.59.7. hammer report-template list
Copy link

List all report templates 

Usage:
    hammer report-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
Copy to Clipboard Toggle word wrap

10.59.8. hammer report-template update
Copy link

Update a report template 

Usage:
    hammer report-template update [OPTIONS]

Options:
 --audit-comment AUDIT_COMMENT
 --default DEFAULT                         Whether or not the template is added automatically to new organizations and
                                           Locations
                                           One of true/false, yes/no, 1/0.
 --file REPORT                             Path to a file that contains the report template content
 --id ID
 --interactive, -i                         Dump existing template and open it in an $EDITOR. Update with the result
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --snippet SNIPPET                         One of true/false, yes/no, 1/0.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.60. hammer repository
Copy link

Manipulate repositories 

Usage:
    hammer repository [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a custom repository
 delete                        Destroy a custom repository
 export                        Export content from a repository to the configured directory
 info                          Show a repository
 list                          List of enabled repositories
 remove-content                Remove content from a repository
 synchronize                   Sync a repository
 update                        Update a repository
 upload-content                Upload content into the repository

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.60.1. hammer repository create
Copy link

Create a custom repository 

Usage:
    hammer repository create [OPTIONS]

Options:
 --checksum-type CHECKSUM_TYPE                             Checksum of the repository, currently 'sha1' & 'sha256'
                                                           Are supported
 --content-type CONTENT_TYPE                               Type of repo (either 'yum', 'deb', 'puppet',
                                                           'docker', or 'ostree')
                                                           Possible value(s): 'docker', 'file', 'ostree', 'puppet', 'yum'
 --deb-architectures DEB_ARCHITECTURES                     Comma separated list of architectures to be synched from deb-archive
 --deb-components DEB_COMPONENTS                           Comma separated list of repo components to be synched from deb-archive
 --deb-releases DEB_RELEASES                               Comma separated list of releases to be synched from deb-archive
 --docker-tags-whitelist DOCKER_TAGS_WHITELIST             Comma separated list of tags to sync for Container Image repository
                                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --docker-upstream-name DOCKER_UPSTREAM_NAME               Name of the upstream docker repository
 --download-policy DOWNLOAD_POLICY                         Download policy for yum repos (either 'immediate',
                                                           'on_demand', or 'background')
                                                           Possible value(s): 'immediate', 'on_demand', 'background'
 --gpg-key GPG_KEY_NAME                                    Name to search by
 --gpg-key-id GPG_KEY_ID                                   Gpg key numeric identifier
 --ignorable-content IGNORABLE_CONTENT                     List of content units to ignore while syncing a yum repository. Must be
                                                           Subset of rpm,drpm,srpm,distribution,erratum
                                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --ignore-global-proxy IGNORE_GLOBAL_PROXY                 If true, will ignore the globally configured Capsule when syncing
                                                           One of true/false, yes/no, 1/0.
 --label LABEL
 --mirror-on-sync MIRROR_ON_SYNC                           True if this repository when synced has to be mirrored from the source and
                                                           Stale rpms removed
                                                           One of true/false, yes/no, 1/0.
 --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
 --ostree-upstream-sync-depth OSTREE_UPSTREAM_SYNC_DEPTH   If a custom sync policy is chosen for ostree repositories then a
                                                           'depth' value must be provided
 --ostree-upstream-sync-policy OSTREE_UPSTREAM_SYNC_POLICY Policies for syncing upstream ostree repositories
                                                           Possible value(s): 'latest', 'all', 'custom'
 --product PRODUCT_NAME                                    Product name to search by
 --product-id PRODUCT_ID                                   Product numeric identifier
 --publish-via-http ENABLE                                 Publish Via HTTP
                                                           One of true/false, yes/no, 1/0.
 --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
 --upstream-password UPSTREAM_PASSWORD                     Password of the upstream repository user used for authentication
 --upstream-username UPSTREAM_USERNAME                     Username of the upstream repository user used for authentication
 --url URL                                                 Repository source url
 --verify-ssl-on-sync VERIFY_SSL_ON_SYNC                   If true, Katello will verify the upstream url's SSL certifcates are
                                                           Signed by a trusted CA
                                                           One of true/false, yes/no, 1/0.
 -h, --help                                                Print help
Copy to Clipboard Toggle word wrap

10.60.2. hammer repository delete
Copy link

Destroy a custom repository 

Usage:
    hammer repository delete [OPTIONS]

Options:
 --id ID
 --name NAME                             Repository 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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.60.3. hammer repository export
Copy link

Export content from a repository to the configured directory 

Usage:
    hammer repository export [OPTIONS]

Options:
 --async                                 Do not wait for the task
 --export-to-iso EXPORT_TO_ISO           Export to ISO format
                                         One of true/false, yes/no, 1/0.
 --id ID                                 Repository identifier
 --iso-mb-size ISO_MB_SIZE               Maximum size of each ISO in MB
 --name NAME                             Repository 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
 --since SINCE                           Optional date of last export (ex: 2010-01-01T12:00:00Z)
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.60.4. hammer repository info
Copy link

Show a repository 

Usage:
    hammer repository info [OPTIONS]

Options:
 --id ID                                 Repository ID
 --name NAME                             Repository 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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.60.5. hammer repository list
Copy link

List of enabled repositories 

Usage:
    hammer repository list [OPTIONS]

Options:
 --available-for AVAILABLE_FOR                       Interpret specified object to return only Repositories that can be
                                                     Associated with specified object.  Only 'content_view' &
                                                     'content_view_version' are supported.
 --content-type CONTENT_TYPE                         Limit to only repositories of this type
                                                     Possible value(s): 'docker', 'file', 'ostree', 'puppet', 'yum'
 --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
 --deb DEB_NAME                                      Name to search by
 --deb-id DEB_ID                                     A deb identifier
 --description DESCRIPTION                           Description of the repository
 --environment ENVIRONMENT_NAME                      Environment name
 --environment-id ENVIRONMENT_ID
 --erratum-id ERRATUM_ID                             Id of an erratum to find repositories that contain the erratum
 --file-id FILE_ID                                   Id of a file to find repositories that contain the file
 --full-result FULL_RESULT                           Whether or not to show all results
                                                     One of true/false, yes/no, 1/0.
 --label LABEL                                       Label of the repository
 --library LIBRARY                                   Show repositories in Library and the default content view
                                                     One of true/false, yes/no, 1/0.
 --name NAME                                         Name of the repository
 --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
 --ostree-branch OSTREE_BRANCH_NAME                  Name to search by
 --ostree-branch-id OSTREE_BRANCH_ID                 An ostree branch identifier
 --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
 --rpm-id RPM_ID                                     Id of a rpm package to find repositories that contain the rpm
 --search SEARCH                                     Search string
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap

10.60.6. hammer repository remove-content
Copy link

Remove content from a repository 

Usage:
    hammer repository remove-content [OPTIONS]

Options:
 --id ID                                 Repository ID
 --ids IDS                               Array of content ids to remove
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                             Repository 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
 --sync-capsule SYNC_CAPSULE             Whether or not to sync an external capsule after upload. Default: true
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.60.7. hammer repository synchronize
Copy link

Sync a repository 

Usage:
    hammer repository synchronize [OPTIONS]

Options:
 --async                                   Do not wait for the task
 --id ID                                   Repository ID
 --incremental INCREMENTAL                 Perform an incremental import
                                           One of true/false, yes/no, 1/0.
 --name NAME                               Repository 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
 --skip-metadata-check SKIP_METADATA_CHECK Force sync even if no upstream changes are detected. Only used with yum
                                           Repositories.
                                           One of true/false, yes/no, 1/0.
 --source-url SOURCE_URL                   Temporarily override feed URL for sync
 --validate-contents VALIDATE_CONTENTS     Force a sync and validate the checksums of all content. Only used with yum
                                           Repositories.
                                           One of true/false, yes/no, 1/0.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.60.8. hammer repository update
Copy link

Update a repository 

Usage:
    hammer repository update [OPTIONS]

Options:
 --checksum-type CHECKSUM_TYPE                             Checksum of the repository, currently 'sha1' & 'sha256'
                                                           Are supported
 --deb-architectures DEB_ARCHITECTURES                     Comma separated list of architectures to be synched from deb-archive
 --deb-components DEB_COMPONENTS                           Comma separated list of repo components to be synched from deb-archive
 --deb-releases DEB_RELEASES                               Comma separated list of releases to be synched from deb-archive
 --docker-digest DIGEST                                    Container Image manifest digest
 --docker-tag TAG                                          Container Image tag
 --docker-tags-whitelist DOCKER_TAGS_WHITELIST             Comma separated list of tags to sync for Container Image repository
                                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --docker-upstream-name DOCKER_UPSTREAM_NAME               Name of the upstream docker repository
 --download-policy DOWNLOAD_POLICY                         Download policy for yum repos (either 'immediate',
                                                           'on_demand', or 'background')
                                                           Possible value(s): 'immediate', 'on_demand', 'background'
 --gpg-key GPG_KEY_NAME                                    Name to search by
 --gpg-key-id GPG_KEY_ID                                   Gpg key numeric identifier
 --id ID                                                   Repository ID
 --ignorable-content IGNORABLE_CONTENT                     List of content units to ignore while syncing a yum repository. Must be
                                                           Subset of rpm,drpm,srpm,distribution,erratum
                                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --ignore-global-proxy IGNORE_GLOBAL_PROXY                 If true, will ignore the globally configured Capsule when syncing
                                                           One of true/false, yes/no, 1/0.
 --mirror-on-sync MIRROR_ON_SYNC                           True if this repository when synced has to be mirrored from the source and
                                                           Stale rpms removed
                                                           One of true/false, yes/no, 1/0.
 --name NAME                                               Repository name to search by
 --new-name NEW_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
 --ostree-upstream-sync-depth OSTREE_UPSTREAM_SYNC_DEPTH   If a custom sync policy is chosen for ostree repositories then a
                                                           'depth' value must be provided
 --ostree-upstream-sync-policy OSTREE_UPSTREAM_SYNC_POLICY Policies for syncing upstream ostree repositories
                                                           Possible value(s): 'latest', 'all', 'custom'
 --product PRODUCT_NAME                                    Product name to search by
 --product-id PRODUCT_ID                                   Product numeric identifier
 --publish-via-http ENABLE                                 Publish Via HTTP
                                                           One of true/false, yes/no, 1/0.
 --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
 --upstream-password UPSTREAM_PASSWORD                     Password of the upstream repository user used for authentication
 --upstream-username UPSTREAM_USERNAME                     Username of the upstream repository user used for authentication
 --url URL                                                 Repository source url
 --verify-ssl-on-sync VERIFY_SSL_ON_SYNC                   If true, Katello will verify the upstream url's SSL certifcates are
                                                           Signed by a trusted CA
                                                           One of true/false, yes/no, 1/0.
 -h, --help                                                Print help
Copy to Clipboard Toggle word wrap

10.60.9. hammer repository upload-content
Copy link

Upload content into the repository 

Usage:
    hammer repository upload-content [OPTIONS]

Options:
 --id ID                                 Repository ID
 --name NAME                             Repository 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
 --path PATH                             Upload file, directory of files, or glob of files as content for a repository.
                                         Globs must be escaped by single or double quotes
 --product PRODUCT_NAME                  Product name to search by
 --product-id PRODUCT_ID                 Product numeric identifier
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.61. hammer repository-set
Copy link

Manipulate repository sets on the server 

Usage:
    hammer repository-set [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 available-repositories        Get list of available repositories for the repository set
 disable                       Disable a repository from the set
 enable                        Enable a repository from the set
 info                          Get info about a repository set
 list                          List repository sets.

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

Get list of available repositories for the repository set 

Usage:
    hammer repository-set available-repositories [OPTIONS]

Options:
 --id ID                                 ID of the repository set
 --name NAME                             Repository set name to search by
 --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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.61.2. hammer repository-set disable
Copy link

Disable a repository from the set 

Usage:
    hammer repository-set disable [OPTIONS]

Options:
 --basearch BASEARCH                     Basearch to disable
 --id ID                                 ID of the repository set to disable
 --name NAME                             Repository set 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
 --releasever RELEASEVER                 Releasever to disable
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.61.3. hammer repository-set enable
Copy link

Enable a repository from the set 

Usage:
    hammer repository-set enable [OPTIONS]

Options:
 --basearch BASEARCH                     Basearch to enable
 --id ID                                 ID of the repository set to enable
 --name NAME                             Repository set 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
 --releasever RELEASEVER                 Releasever to enable
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.61.4. hammer repository-set info
Copy link

Get info about a repository set 

Usage:
    hammer repository-set info [OPTIONS]

Options:
 --id ID                                 ID of the repository set
 --name NAME                             Repository set 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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.61.5. hammer repository-set list
Copy link

List repository sets. 

Usage:
    hammer repository-set list [OPTIONS]

Options:
 --enabled ENABLED                                   If true, only return repository sets that have been enabled. Defaults to
                                                     False
                                                     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.
 --name NAME                                         Repository set name to search on
 --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
 --search SEARCH                                     Search string
 --with-active-subscription WITH_ACTIVE_SUBSCRIPTION If true, only return repository sets that are associated with an active
                                                     Subscriptions
                                                     One of true/false, yes/no, 1/0.
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap

10.62. hammer role
Copy link

Manage user roles 

Usage:
    hammer role [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 clone                         Clone a role
 create                        Create a role
 delete                        Delete a role
 filters                       List all filters
 info                          Show a role
 list                          List all roles
 update                        Update a role

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.62.1. hammer role clone
Copy link

Clone a role 

Usage:
    hammer role clone [OPTIONS]

Options:
 --description DESCRIPTION                 Role description
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                               User role 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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.62.2. hammer role create
Copy link

Create a role 

Usage:
    hammer role create [OPTIONS]

Options:
 --description DESCRIPTION                 Role description
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.62.3. hammer role delete
Copy link

Delete a role 

Usage:
    hammer role delete [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             User role name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.62.4. hammer role filters
Copy link

List all filters 

Usage:
    hammer role filters [OPTIONS]

Options:
 --id ID                                 User role id
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             User role 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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.62.5. hammer role info
Copy link

Show a role 

Usage:
    hammer role info [OPTIONS]

Options:
 --description DESCRIPTION
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             User role name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.62.6. hammer role list
Copy link

List all roles 

Usage:
    hammer role 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
Copy to Clipboard Toggle word wrap

10.62.7. hammer role update
Copy link

Update a role 

Usage:
    hammer role update [OPTIONS]

Options:
 --description DESCRIPTION                 Role description
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                               User role 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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.63. hammer sc-param
Copy link

Manipulate smart class parameters 

Usage:
    hammer sc-param [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 add-matcher                   Create an override value for a specific smart variable
 info                          Show a smart class parameter
 list                          List all smart class parameters
 remove-matcher                Delete an override value for a specific smart variable
 update                        Update a smart class parameter

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.63.1. hammer sc-param add-matcher
Copy link

Create an override value for a specific smart variable 

Usage:
    hammer sc-param add-matcher [OPTIONS]

Options:
 --location LOCATION_NAME                            Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE                     Location title
 --match MATCH                                       Override match
 --omit OMIT                                         Satellite will not send this parameter in classification output, replaces
                                                     Use_puppet_default
                                                     One of true/false, yes/no, 1/0.
 --organization ORGANIZATION_NAME                    Organization name
 --organization-id ORGANIZATION_ID                   Organization ID
 --organization-title ORGANIZATION_TITLE             Organization title
 --puppet-class PUPPET_CLASS_NAME                    Puppet class name
 --puppet-class-id PUPPET_CLASS_ID                   ID of Puppet class
 --smart-class-parameter SMART_CLASS_PARAMETER_NAME  Smart class parameter name
 --smart-class-parameter-id SMART_CLASS_PARAMETER_ID
 --use-puppet-default USE_PUPPET_DEFAULT             Deprecated, please use omit
                                                     One of true/false, yes/no, 1/0.
 --value VALUE                                       Override value, required if omit is false
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap

10.63.2. hammer sc-param info
Copy link

Show a smart class parameter 

Usage:
    hammer sc-param info [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Smart class parameter name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --puppet-class PUPPET_CLASS_NAME        Puppet class name
 --puppet-class-id PUPPET_CLASS_ID       ID of Puppet class
 --show-hidden SHOW_HIDDEN               Display hidden values
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.63.3. hammer sc-param list
Copy link

List all smart class parameters 

Usage:
    hammer sc-param list [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME          Environment name
 --environment-id ENVIRONMENT_ID
 --host HOST_NAME                        Host name
 --host-id HOST_ID
 --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-class PUPPET_CLASS_NAME        Puppet class name
 --puppet-class-id PUPPET_CLASS_ID       ID of Puppet class
 --search SEARCH                         Filter results
 --show-hidden SHOW_HIDDEN               Display hidden values
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.63.4. hammer sc-param remove-matcher
Copy link

Delete an override value for a specific smart variable 

Usage:
    hammer sc-param remove-matcher [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
 --puppet-class PUPPET_CLASS_NAME                    Puppet class name
 --puppet-class-id PUPPET_CLASS_ID                   ID of Puppet class
 --smart-class-parameter SMART_CLASS_PARAMETER_NAME  Smart class parameter name
 --smart-class-parameter-id SMART_CLASS_PARAMETER_ID
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap

10.63.5. hammer sc-param update
Copy link

Update a smart class parameter 

Usage:
    hammer sc-param update [OPTIONS]

Options:
 --avoid-duplicates AVOID_DUPLICATES         Remove duplicate values (only array type)
                                             One of true/false, yes/no, 1/0.
 --default-value VALUE                       Value to use when there is no match
 --description DESCRIPTION                   Description of smart class
 --hidden-value HIDDEN_VALUE                 When enabled the parameter is hidden in the UI
                                             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                                 Smart class parameter name
 --omit OMIT                                 Satellite will not send this parameter in classification output. Puppet
                                             Will use the value defined in the Puppet manifest for this parameter
                                             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                         Override this parameter
                                             One of true/false, yes/no, 1/0.
 --override-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
                                             Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --parameter-type PARAMETER_TYPE             Type of the parameter
                                             Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
 --path PATH                                 The order in which values are resolved
 --puppet-class PUPPET_CLASS_NAME            Puppet class name
 --puppet-class-id PUPPET_CLASS_ID           ID of Puppet class
 --required REQUIRED                         This parameter is required
                                             One of true/false, yes/no, 1/0.
 --use-puppet-default USE_PUPPET_DEFAULT     Deprecated, please use omit
                                             One of true/false, yes/no, 1/0.
 --validator-rule VALIDATOR_RULE             Used to enforce certain values for the parameter values
 --validator-type VALIDATOR_TYPE             Type of the validator
                                             Possible value(s): 'regexp', 'list', ''
 -h, --help                                  Print help
Copy to Clipboard Toggle word wrap

10.64. hammer scap-content
Copy link

Manipulate SCAP contents 

Usage:
    hammer scap-content [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create SCAP content
 delete                        Deletes an SCAP content
 download                      Download an SCAP content as XML
 info                          Show an SCAP content
 list                          List SCAP contents
 update                        Update an SCAP content

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.64.1. hammer scap-content create
Copy link

Create SCAP content 

Usage:
    hammer scap-content create [OPTIONS]

Options:
 --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
 --locations LOCATION_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --organizations ORGANIZATION_NAMES    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --original-filename ORIGINAL_FILENAME Original file name of the XML file
 --scap-file SCAP_FILE                 SCAP content file
 --title TITLE                         SCAP content name
 -h, --help                            Print help
Copy to Clipboard Toggle word wrap

10.64.2. hammer scap-content delete
Copy link

Deletes an SCAP content 

Usage:
    hammer scap-content 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
 --title TITLE                     SCAP content title
 -h, --help                        Print help
Copy to Clipboard Toggle word wrap

10.64.3. hammer scap-content download
Copy link

Download an SCAP content as XML 

Usage:
    hammer scap-content 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
 --title TITLE                     SCAP content title
 -h, --help                        Print help
Copy to Clipboard Toggle word wrap

10.64.4. hammer scap-content info
Copy link

Show an SCAP content 

Usage:
    hammer scap-content 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
 --title TITLE                     SCAP content title
 -h, --help                        Print help
Copy to Clipboard Toggle word wrap

10.64.5. hammer scap-content list
Copy link

List SCAP contents 

Usage:
    hammer scap-content 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
Copy to Clipboard Toggle word wrap

10.64.6. hammer scap-content update
Copy link

Update an SCAP content 

Usage:
    hammer scap-content update [OPTIONS]

Options:
 --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
 --locations LOCATION_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --new-title NEW_TITLE                 SCAP content 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
 --organizations ORGANIZATION_NAMES    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --original-filename ORIGINAL_FILENAME Original file name of the XML file
 --scap-file SCAP_FILE                 SCAP content file
 --title TITLE                         SCAP content title
 -h, --help                            Print help
Copy to Clipboard Toggle word wrap

10.65. hammer settings
Copy link

Change server settings 

Usage:
    hammer settings [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 list                          List all settings
 set                           Update a setting

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.65.1. hammer settings list
Copy link

List all settings 

Usage:
    hammer settings 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
Copy to Clipboard Toggle word wrap

10.65.2. hammer settings set
Copy link

Update a setting 

Usage:
    hammer settings set [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Setting name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --value VALUE
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.66. hammer shell
Copy link

Interactive shell 

Usage:
    hammer shell [OPTIONS]

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.67. hammer smart-variable
Copy link

Manipulate smart variables 

Usage:
    hammer smart-variable [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 add-matcher                   Create an override value for a specific smart variable
 create                        Create a smart variable
 delete                        Delete a smart variable
 info                          Show a smart variable
 list                          List all smart variables
 remove-matcher                Delete an override value for a specific smart variable
 update                        Update a smart variable

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.67.1. hammer smart-variable add-matcher
Copy link

Create an override value for a specific smart variable 

Usage:
    hammer smart-variable add-matcher [OPTIONS]

Options:
 --location LOCATION_NAME                 Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE          Location title
 --match MATCH                            Override match
 --omit OMIT                              Satellite will not send this parameter in classification output, replaces
                                          Use_puppet_default
                                          One of true/false, yes/no, 1/0.
 --organization ORGANIZATION_NAME         Organization name
 --organization-id ORGANIZATION_ID        Organization ID
 --organization-title ORGANIZATION_TITLE  Organization title
 --smart-variable SMART_VARIABLE_VARIABLE Smart variable name
 --smart-variable-id SMART_VARIABLE_ID
 --use-puppet-default USE_PUPPET_DEFAULT  Deprecated, please use omit
                                          One of true/false, yes/no, 1/0.
 --value VALUE                            Override value, required if omit is false
 -h, --help                               Print help
Copy to Clipboard Toggle word wrap

10.67.2. hammer smart-variable create
Copy link

Create a smart variable 

Usage:
    hammer smart-variable create [OPTIONS]

Options:
 --avoid-duplicates AVOID_DUPLICATES         Remove duplicate values (only array type)
                                             One of true/false, yes/no, 1/0.
 --default-value VALUE                       Value to use when there is no match
 --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-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
                                             Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --puppet-class PUPPET_CLASS_NAME            Puppet class name
 --puppet-class-id PUPPET_CLASS_ID           ID of Puppet class
 --validator-rule VALIDATOR_RULE             Used to enforce certain values for the parameter values
 --validator-type VALIDATOR_TYPE             Type of the validator
                                             Possible value(s): 'regexp', 'list', ''
 --variable VARIABLE                         Name of variable
 --variable-type VARIABLE_TYPE               Type of the variable
                                             Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
 -h, --help                                  Print help
Copy to Clipboard Toggle word wrap

10.67.3. hammer smart-variable delete
Copy link

Delete a smart variable 

Usage:
    hammer smart-variable delete [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Smart variable name (Deprecated: Use --variable instead)
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --variable VARIABLE                     Smart variable name
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.67.4. hammer smart-variable info
Copy link

Show a smart variable 

Usage:
    hammer smart-variable info [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Smart variable name (Deprecated: Use --variable instead)
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --show-hidden SHOW_HIDDEN               Display hidden values
                                         One of true/false, yes/no, 1/0.
 --variable VARIABLE                     Smart variable name
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.67.5. hammer smart-variable list
Copy link

List all smart variables 

Usage:
    hammer smart-variable list [OPTIONS]

Options:
 --host HOST_NAME                        Host name
 --host-id HOST_ID
 --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-class PUPPET_CLASS_NAME        Puppet class name
 --puppet-class-id PUPPET_CLASS_ID       ID of Puppet class
 --search SEARCH                         Filter results
 --show-hidden SHOW_HIDDEN               Display hidden values
                                         One of true/false, yes/no, 1/0.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.67.6. hammer smart-variable remove-matcher
Copy link

Delete an override value for a specific smart variable 

Usage:
    hammer smart-variable remove-matcher [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
 --smart-variable SMART_VARIABLE_VARIABLE Smart variable name
 --smart-variable-id SMART_VARIABLE_ID
 -h, --help                               Print help
Copy to Clipboard Toggle word wrap

10.67.7. hammer smart-variable update
Copy link

Update a smart variable 

Usage:
    hammer smart-variable update [OPTIONS]

Options:
 --avoid-duplicates AVOID_DUPLICATES         Remove duplicate values (only array type)
                                             One of true/false, yes/no, 1/0.
 --default-value VALUE                       Value to use when there is no match
 --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.
 --new-variable NEW_VARIABLE                 Name of variable
 --organization ORGANIZATION_NAME            Organization name
 --organization-id ORGANIZATION_ID           Organization ID
 --organization-title ORGANIZATION_TITLE     Organization title
 --override-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
                                             Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --puppet-class PUPPET_CLASS_NAME            Puppet class name
 --puppet-class-id PUPPET_CLASS_ID           ID of Puppet class
 --validator-rule VALIDATOR_RULE             Used to enforce certain values for the parameter values
 --validator-type VALIDATOR_TYPE             Type of the validator
                                             Possible value(s): 'regexp', 'list', ''
 --variable VARIABLE                         Smart variable name
 --variable-type VARIABLE_TYPE               Type of the variable
                                             Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
 -h, --help                                  Print help
Copy to Clipboard Toggle word wrap

10.68. hammer subnet
Copy link

Manipulate subnets 

Usage:
    hammer subnet [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a subnet
 delete                        Delete a subnet
 delete-parameter              Delete parameter for a subnet
 info                          Show a subnet
 list                          List of subnets
 set-parameter                 Create or update parameter for a subnet
 update                        Update a subnet

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.68.1. hammer subnet create
Copy link

Create a subnet 

Usage:
    hammer subnet create [OPTIONS]

Options:
 --boot-mode BOOT_MODE                     Default boot mode for interfaces assigned to this subnet, valid values are
                                           “Static”, “DHCP”
 --description DESCRIPTION                 Subnet description
 --dhcp DHCP_NAME                          DHCP Proxy to use within this subnet
 --dhcp-id DHCP_ID                         DHCP Capsule ID to use within this subnet
 --discovery-id DISCOVERY_ID               ID of Discovery Capsule to use within this subnet for managing connection
                                           To discovered hosts
 --dns DNS_NAME                            DNS Proxy to use within this subnet
 --dns-id DNS_ID                           DNS Capsule ID to use within this subnet
 --dns-primary DNS_PRIMARY                 Primary DNS for this subnet
 --dns-secondary DNS_SECONDARY             Secondary DNS for this subnet
 --domain-ids DOMAIN_IDS                   Domains in which this subnet is part
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --domains DOMAIN_NAMES                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --from FROM                               Starting IP Address for IP auto suggestion
 --gateway GATEWAY                         Subnet gateway
 --httpboot-id HTTPBOOT_ID                 HTTPBoot Capsule ID to use within this subnet
 --ipam IPAM                               IP Address auto suggestion mode for this subnet, valid values are “DHCP”,
                                           “Internal DB”, “None”
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --mask MASK                               Netmask for this subnet
 --mtu MTU                                 MTU for this subnet
 --name NAME                               Subnet name
 --network NETWORK                         Subnet network
 --network-type NETWORK_TYPE               Type or protocol, IPv4 or IPv6, defaults to IPv4
                                           Possible value(s): 'IPv4', 'IPv6'
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --template-id TEMPLATE_ID                 Template HTTP(S) Capsule ID to use within this subnet
 --tftp TFTP_NAME                          TFTP Proxy to use within this subnet
 --tftp-id TFTP_ID                         TFTP Capsule ID to use within this subnet
 --to TO                                   Ending IP Address for IP auto suggestion
 --vlanid VLANID                           VLAN ID for this subnet
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.68.2. hammer subnet delete
Copy link

Delete a subnet 

Usage:
    hammer subnet delete [OPTIONS]

Options:
 --id ID                                 Subnet numeric identifier
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             Subnet name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.68.3. hammer subnet delete-parameter
Copy link

Delete parameter for a subnet 

Usage:
    hammer subnet delete-parameter [OPTIONS]

Options:
 --name NAME                   Parameter name
 --subnet SUBNET_NAME          Subnet name
 --subnet-id SUBNET_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.68.4. hammer subnet info
Copy link

Show a subnet 

Usage:
    hammer subnet info [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                        Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE                 Location title
 --name NAME                                     Subnet 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
Copy to Clipboard Toggle word wrap

10.68.5. hammer subnet list
Copy link

List of subnets 

Usage:
    hammer subnet list [OPTIONS]

Options:
 --domain DOMAIN_NAME                    Domain name
 --domain-id DOMAIN_ID                   Numerical ID or domain name
 --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
Copy to Clipboard Toggle word wrap

10.68.6. hammer subnet set-parameter
Copy link

Create or update parameter for a subnet 

Usage:
    hammer subnet 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
 --subnet SUBNET_NAME          Subnet name
 --subnet-id SUBNET_ID
 --value VALUE                 Parameter value
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.68.7. hammer subnet update
Copy link

Update a subnet 

Usage:
    hammer subnet update [OPTIONS]

Options:
 --boot-mode BOOT_MODE                     Default boot mode for interfaces assigned to this subnet, valid values are
                                           “Static”, “DHCP”
 --description DESCRIPTION                 Subnet description
 --dhcp DHCP_NAME                          DHCP Proxy to use within this subnet
 --dhcp-id DHCP_ID                         DHCP Capsule ID to use within this subnet
 --discovery-id DISCOVERY_ID               ID of Discovery Capsule to use within this subnet for managing connection
                                           To discovered hosts
 --dns DNS_NAME                            DNS Proxy to use within this subnet
 --dns-id DNS_ID                           DNS Capsule ID to use within this subnet
 --dns-primary DNS_PRIMARY                 Primary DNS for this subnet
 --dns-secondary DNS_SECONDARY             Secondary DNS for this subnet
 --domain-ids DOMAIN_IDS                   Domains in which this subnet is part
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --domains DOMAIN_NAMES                    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --from FROM                               Starting IP Address for IP auto suggestion
 --gateway GATEWAY                         Subnet gateway
 --httpboot-id HTTPBOOT_ID                 HTTPBoot Capsule ID to use within this subnet
 --id ID                                   Subnet numeric identifier
 --ipam IPAM                               IP Address auto suggestion mode for this subnet, valid values are “DHCP”,
                                           “Internal DB”, “None”
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --mask MASK                               Netmask for this subnet
 --mtu MTU                                 MTU for this subnet
 --name NAME                               Subnet name
 --network NETWORK                         Subnet network
 --network-type NETWORK_TYPE               Type or protocol, IPv4 or IPv6, defaults to IPv4
                                           Possible value(s): 'IPv4', 'IPv6'
 --new-name NEW_NAME                       Subnet 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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --template-id TEMPLATE_ID                 Template HTTP(S) Capsule ID to use within this subnet
 --tftp TFTP_NAME                          TFTP Proxy to use within this subnet
 --tftp-id TFTP_ID                         TFTP Capsule ID to use within this subnet
 --to TO                                   Ending IP Address for IP auto suggestion
 --vlanid VLANID                           VLAN ID for this subnet
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.69. hammer subscription
Copy link

Manipulate subscriptions 

Usage:
    hammer subscription [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 delete-manifest               Delete manifest from Red Hat provider
 list                          List organization subscriptions
 manifest-history              Obtain manifest history for subscriptions
 refresh-manifest              Refresh previously imported manifest for Red Hat provider
 upload                        Upload a subscription manifest

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.69.1. hammer subscription delete-manifest
Copy link

Delete manifest from Red Hat provider 

Usage:
    hammer subscription delete-manifest [OPTIONS]

Options:
 --async                                 Do not wait for the task
 --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
Copy to Clipboard Toggle word wrap

10.69.2. hammer subscription list
Copy link

List organization subscriptions 

Usage:
    hammer subscription 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           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
 --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.
 --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
Copy to Clipboard Toggle word wrap

10.69.3. hammer subscription manifest-history
Copy link

obtain manifest history for subscriptions 

Usage:
    hammer subscription manifest-history [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
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.69.4. hammer subscription refresh-manifest
Copy link

Refresh previously imported manifest for Red Hat provider 

Usage:
    hammer subscription refresh-manifest [OPTIONS]

Options:
 --async                                 Do not wait for the task
 --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
Copy to Clipboard Toggle word wrap

10.69.5. hammer subscription upload
Copy link

Upload a subscription manifest 

Usage:
    hammer subscription upload [OPTIONS]

Options:
 --async                                 Do not wait for the task
 --file MANIFEST                         Subscription manifest file
 --organization ORGANIZATION_NAME        Organization name to search by
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-label ORGANIZATION_LABEL Organization label to search by
 --repository-url REPOSITORY_URL         Repository url
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.70. hammer sync-plan
Copy link

Manipulate sync plans 

Usage:
    hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a sync plan
 delete                        Destroy a sync plan
 info                          Show a sync plan
 list                          List sync plans
 update                        Update a sync plan

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.70.1. hammer sync-plan create
Copy link

Create a sync plan 

Usage:
    hammer sync-plan create [OPTIONS]

Options:
 --cron-expression CRON EXPRESSION       Set this when interval is custom cron
 --description DESCRIPTION               Sync plan description
 --enabled ENABLED                       Enables or disables synchronization
                                         One of true/false, yes/no, 1/0.
 --interval INTERVAL                     How often synchronization should run
 --name NAME                             Sync plan name
 --organization ORGANIZATION_NAME        Organization name to search by
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-label ORGANIZATION_LABEL Organization label to search by
 --sync-date SYNC_DATE                   Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered
                                         Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.70.2. hammer sync-plan delete
Copy link

Destroy a sync plan 

Usage:
    hammer sync-plan delete [OPTIONS]

Options:
 --id ID                                 Sync plan numeric identifier
 --name NAME                             Sync plan name to search by
 --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
Copy to Clipboard Toggle word wrap

10.70.3. hammer sync-plan info
Copy link

Show a sync plan 

Usage:
    hammer sync-plan info [OPTIONS]

Options:
 --id ID                                 Sync plan numeric identifier
 --name NAME                             Sync plan 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
Copy to Clipboard Toggle word wrap

10.70.4. hammer sync-plan list
Copy link

List sync plans 

Usage:
    hammer sync-plan list [OPTIONS]

Options:
 --full-result FULL_RESULT               Whether or not to show all results
                                         One of true/false, yes/no, 1/0.
 --interval INTERVAL                     Filter by interval
                                         Possible value(s): 'hourly', 'daily', 'weekly', 'custom cron'
 --name NAME                             Filter 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
 --search SEARCH                         Search string
 --sync-date SYNC_DATE                   Filter by sync date
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.70.5. hammer sync-plan update
Copy link

Update a sync plan 

Usage:
    hammer sync-plan update [OPTIONS]

Options:
 --cron-expression CRON_EXPRESSION       Add custom cron logic for sync plan
 --description DESCRIPTION               Sync plan description
 --enabled ENABLED                       Enables or disables synchronization
                                         One of true/false, yes/no, 1/0.
 --id ID                                 Sync plan numeric identifier
 --interval INTERVAL                     How often synchronization should run
 --name NAME                             Sync plan name to search by
 --new-name NEW_NAME                     Sync plan name
 --organization ORGANIZATION_NAME        Organization name to search by
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-label ORGANIZATION_LABEL Organization label to search by
 --sync-date SYNC_DATE                   Start date and time of the synchronization
                                         Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.71. hammer tailoring-file
Copy link

Manipulate Tailoring files 

Usage:
    hammer tailoring-file [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a Tailoring file
 delete                        Deletes a Tailoring file
 download                      Download a Tailoring file as XML
 info                          Show a Tailoring file
 list                          List Tailoring files
 update                        Update a Tailoring file

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.71.1. hammer tailoring-file create
Copy link

Create a Tailoring file 

Usage:
    hammer tailoring-file create [OPTIONS]

Options:
 --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
 --locations LOCATION_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                           Tailoring file 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
 --organizations ORGANIZATION_NAMES    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --original-filename ORIGINAL_FILENAME Original file name of the XML file
 --scap-file SCAP_FILE                 Tailoring file content
 -h, --help                            Print help
Copy to Clipboard Toggle word wrap

10.71.2. hammer tailoring-file delete
Copy link

Deletes a Tailoring file 

Usage:
    hammer tailoring-file 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
Copy to Clipboard Toggle word wrap

10.71.3. hammer tailoring-file download
Copy link

Download a Tailoring file as XML 

Usage:
    hammer tailoring-file download [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME          Name to search by
 --location-id LOCATION_ID
 --name NAME                       Tailoring file name
 --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
Copy to Clipboard Toggle word wrap

10.71.4. hammer tailoring-file info
Copy link

Show a Tailoring file 

Usage:
    hammer tailoring-file info [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME          Name to search by
 --location-id LOCATION_ID
 --name NAME                       Tailoring file name
 --organization ORGANIZATION_NAME  Name to search by
 --organization-id ORGANIZATION_ID Organization ID
 -h, --help                        Print help
Copy to Clipboard Toggle word wrap

10.71.5. hammer tailoring-file list
Copy link

List Tailoring files 

Usage:
    hammer tailoring-file 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
Copy to Clipboard Toggle word wrap

10.71.6. hammer tailoring-file update
Copy link

Update a Tailoring file 

Usage:
    hammer tailoring-file update [OPTIONS]

Options:
 --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
 --locations LOCATION_NAMES            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                           Tailoring file name
 --new-name NEW_NAME                   Tailoring file 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
 --organizations ORGANIZATION_NAMES    Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --original-filename ORIGINAL_FILENAME Original file name of the XML file
 --scap-file SCAP_FILE                 Tailoring file content
 -h, --help                            Print help
Copy to Clipboard Toggle word wrap

10.72. hammer task
Copy link

Tasks related actions. 

Usage:
    hammer task [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 info                          Show task details
 list                          List tasks
 progress                      Show the progress of the task
 resume                        Resume all tasks paused in error state

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.72.1. hammer task info
Copy link

Show task details 

Usage:
    hammer task info [OPTIONS]

Options:
 --id ID                           UUID of the task
 --location-id LOCATION_ID         Scope by locations
 --organization-id ORGANIZATION_ID Scope by organizations
 -h, --help                        Print help
Copy to Clipboard Toggle word wrap

10.72.2. hammer task list
Copy link

List tasks 

Usage:
    hammer task list [OPTIONS]

Options:
 --by BY                           Field to sort the results on
 --location-id LOCATION_ID         Scope by locations
 --order ORDER                     Sort field and order, e.g. 'name DESC'
 --organization-id ORGANIZATION_ID Scope by organizations
 --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
Copy to Clipboard Toggle word wrap

10.72.3. hammer task progress
Copy link

Show the progress of the task 

Usage:
    hammer task progress [OPTIONS]

Options:
 --id ID                                 UUID of the task
 --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
Copy to Clipboard Toggle word wrap

10.72.4. hammer task resume
Copy link

Resume all tasks paused in error state 

Usage:
    hammer task resume [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
 --search SEARCH                         Resume tasks matching search string
 --task-ids TASK_IDS                     Resume specific tasks by ID
                                         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --tasks TASK_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.73. hammer template
Copy link

Manipulate config templates 

Usage:
    hammer template [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 add-operatingsystem           Associate an operating system
 build-pxe-default             Update the default PXE menu on all configured TFTP servers
 clone                         Clone a provision template
 combination                   Manage template combinations
 create                        Create a provisioning template
 delete                        Delete a provisioning template
 dump                          View provisioning template content
 info                          Show provisioning template details
 kinds                         List available provisioning template kinds
 list                          List provisioning templates
 remove-operatingsystem        Disassociate an operating system
 update                        Update a provisioning template

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.73.1. hammer template add-operatingsystem
Copy link

Associate an operating system 

Usage:
    hammer template add-operatingsystem [OPTIONS]

Options:
 --id ID
 --name NAME                             Name to search by
 --operatingsystem OPERATINGSYSTEM_TITLE Operating system title
 --operatingsystem-id OPERATINGSYSTEM_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.73.2. hammer template build-pxe-default
Copy link

Update the default PXE menu on all configured TFTP servers 

Usage:
    hammer template build-pxe-default [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
Copy to Clipboard Toggle word wrap

10.73.3. hammer template clone
Copy link

Clone a provision template 

Usage:
    hammer template clone [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                     Template name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.73.4. hammer template combination
Copy link

Manage template combinations 

Usage:
    hammer template combination [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Add a template combination
 delete                        Delete a template combination
 info                          Show template combination
 list                          List template combination
 update                        Update template combination

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.73.4.1. hammer template combination create
Copy link

Add a template combination 

Usage:
    hammer template combination create [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME                      Environment name
 --environment-id ENVIRONMENT_ID
 --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
 --organization ORGANIZATION_NAME                    Organization name
 --organization-id ORGANIZATION_ID                   Organization ID
 --organization-title ORGANIZATION_TITLE             Organization title
 --provisioning-template PROVISIONING_TEMPLATE_NAME  Name to search by
 --provisioning-template-id PROVISIONING_TEMPLATE_ID
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap
10.73.4.2. hammer template combination delete
Copy link

Delete a template combination 

Usage:
    hammer template combination 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
Copy to Clipboard Toggle word wrap
10.73.4.3. hammer template combination info
Copy link

Show template combination 

Usage:
    hammer template combination info [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME                      Environment name
 --environment-id ENVIRONMENT_ID
 --hostgroup HOSTGROUP_NAME                          Hostgroup name
 --hostgroup-id HOSTGROUP_ID
 --hostgroup-title HOSTGROUP_TITLE                   Hostgroup title
 --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
 --provisioning-template PROVISIONING_TEMPLATE_NAME  Name to search by
 --provisioning-template-id PROVISIONING_TEMPLATE_ID
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap
10.73.4.4. hammer template combination list
Copy link

List template combination 

Usage:
    hammer template combination list [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
 --provisioning-template PROVISIONING_TEMPLATE_NAME  Name to search by
 --provisioning-template-id PROVISIONING_TEMPLATE_ID
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap
10.73.4.5. hammer template combination update
Copy link

Update template combination 

Usage:
    hammer template combination update [OPTIONS]

Options:
 --environment ENVIRONMENT_NAME                      Environment name
 --environment-id ENVIRONMENT_ID
 --hostgroup HOSTGROUP_NAME                          Hostgroup name
 --hostgroup-id HOSTGROUP_ID
 --hostgroup-title HOSTGROUP_TITLE                   Hostgroup title
 --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
 --provisioning-template PROVISIONING_TEMPLATE_NAME  Name to search by
 --provisioning-template-id PROVISIONING_TEMPLATE_ID
 -h, --help                                          Print help
Copy to Clipboard Toggle word wrap

10.73.5. hammer template create
Copy link

Create a provisioning template 

Usage:
    hammer template create [OPTIONS]

Options:
 --audit-comment AUDIT_COMMENT
 --file TEMPLATE                           Path to a file that contains the template
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --locked LOCKED                           Whether or not the template is locked for editing
                                           One of true/false, yes/no, 1/0.
 --name NAME                               Template name
 --operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the template
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --type TYPE                               Template type. Eg. snippet, script, provision
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.73.6. hammer template delete
Copy link

Delete a provisioning template 

Usage:
    hammer 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
Copy to Clipboard Toggle word wrap

10.73.7. hammer template dump
Copy link

View provisioning template content 

Usage:
    hammer 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
Copy to Clipboard Toggle word wrap

10.73.8. hammer template info
Copy link

Show provisioning template details 

Usage:
    hammer 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
Copy to Clipboard Toggle word wrap

10.73.9. hammer template kinds
Copy link

List available provisioning template kinds 

Usage:
    hammer template kinds [OPTIONS]

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.73.10. hammer template list
Copy link

List provisioning templates 

Usage:
    hammer template 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
Copy to Clipboard Toggle word wrap

10.73.11. hammer template remove-operatingsystem
Copy link

Disassociate an operating system 

Usage:
    hammer template remove-operatingsystem [OPTIONS]

Options:
 --id ID
 --name NAME                             Name to search by
 --operatingsystem OPERATINGSYSTEM_TITLE Operating system title
 --operatingsystem-id OPERATINGSYSTEM_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.73.12. hammer template update
Copy link

Update a provisioning template 

Usage:
    hammer template update [OPTIONS]

Options:
 --audit-comment AUDIT_COMMENT
 --file TEMPLATE                           Path to a file that contains the template
 --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
 --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
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the template
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --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
 --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
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --type TYPE                               Template type. Eg. snippet, script, provision
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.74. hammer template-input
Copy link

Manage template inputs 

Usage:
    hammer template-input [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a template input
 delete                        Delete a template input
 info                          Show template input details
 list                          List template inputs

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.74.1. hammer template-input create
Copy link

Create a template input 

Usage:
    hammer template-input create [OPTIONS]

Options:
 --advanced ADVANCED                           Input is advanced
                                               One of true/false, yes/no, 1/0.
 --description DESCRIPTION                     Input description
 --fact-name FACT_NAME                         Fact name, used when input type is fact
 --input-type INPUT_TYPE                       Input type
                                               Possible value(s): 'user', 'fact', 'variable', 'puppet_parameter'
 --location LOCATION_NAME                      Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE               Location title
 --name NAME                                   Input name
 --options OPTIONS                             Selectable values for user inputs
                                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --organization ORGANIZATION_NAME              Organization name
 --organization-id ORGANIZATION_ID             Organization ID
 --organization-title ORGANIZATION_TITLE       Organization title
 --puppet-class-name PUPPET_CLASS_NAME         Puppet class name, used when input type is puppet_parameter
 --puppet-parameter-name PUPPET_PARAMETER_NAME Puppet parameter name, used when input type is puppet_parameter
 --required REQUIRED                           Input is required
                                               One of true/false, yes/no, 1/0.
 --template-id TEMPLATE_ID
 --variable-name VARIABLE_NAME                 Variable name, used when input type is variable
 -h, --help                                    Print help
Copy to Clipboard Toggle word wrap

10.74.2. hammer template-input delete
Copy link

Delete a template input 

Usage:
    hammer template-input 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
Copy to Clipboard Toggle word wrap

10.74.3. hammer template-input info
Copy link

Show template input details 

Usage:
    hammer template-input 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
Copy to Clipboard Toggle word wrap

10.74.4. hammer template-input list
Copy link

List template inputs 

Usage:
    hammer template-input 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
Copy to Clipboard Toggle word wrap

10.75. hammer user
Copy link

Manipulate users 

Usage:
    hammer user [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 access-token                  Managing personal access tokens
 add-role                      Assign a user role
 create                        Create a user
 delete                        Delete a user
 info                          Show a user
 list                          List all users
 remove-role                   Remove a user role
 ssh-keys                      Managing User SSH Keys.
 update                        Update a user

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.75.1. hammer user access-token
Copy link

Managing personal access tokens 

Usage:
    hammer user access-token [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a Personal Access Token for a user
 info                          Show a Personal Access Token for a user
 list                          List all Personal Access Tokens for a user
 revoke                        Revoke a Personal Access Token for a user

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.75.1.1. hammer user access-token create
Copy link

Create a Personal Access Token for a user 

Usage:
    hammer user access-token create [OPTIONS]

Options:
 --expires-at EXPIRES_AT                 Expiry Date
 --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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.75.1.2. hammer user access-token info
Copy link

Show a Personal Access Token for a user 

Usage:
    hammer user access-token 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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.75.1.3. hammer user access-token list
Copy link

List all Personal Access Tokens for a user 

Usage:
    hammer user access-token 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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.75.1.4. hammer user access-token revoke
Copy link

Revoke a Personal Access Token for a user 

Usage:
    hammer user access-token revoke [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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.75.2. hammer user add-role
Copy link

Assign a user role 

Usage:
    hammer user add-role [OPTIONS]

Options:
 --id ID
 --login LOGIN                 User's login to search by
 --role ROLE_NAME              User role name
 --role-id ROLE_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.75.3. hammer user create
Copy link

Create a user 

Usage:
    hammer user create [OPTIONS]

Options:
 --admin ADMIN                                     Is an admin account
                                                   One of true/false, yes/no, 1/0.
 --ask-password ASK_PW                             One of true/false, yes/no, 1/0.
 --auth-source AUTH_SOURCE_NAME                    Name to search by
 --auth-source-id AUTH_SOURCE_ID
 --default-location DEFAULT_LOCATION_NAME          Default location name
 --default-location-id DEFAULT_LOCATION_ID
 --default-organization DEFAULT_ORGANIZATION_NAME  Default organization name
 --default-organization-id DEFAULT_ORGANIZATION_ID
 --description DESCRIPTION
 --firstname FIRSTNAME
 --lastname LASTNAME
 --locale LOCALE                                   User's preferred locale
                                                   Possible value(s): 'ca', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'nl_NL', 'pl', 'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW'
 --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
 --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
 --locations LOCATION_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --login LOGIN
 --mail MAIL
 --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
 --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
 --organizations ORGANIZATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --password PASSWORD                               Required unless user is in an external authentication source
 --role-ids ROLE_IDS                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --roles ROLE_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --timezone TIMEZONE                               User's timezone
                                                   Possible value(s): 'International Date Line West', 'American Samoa', 'Midway Island', 'Hawaii', 'Alaska', 'Pacific Time (US &amp; Canada)', 'Tijuana', 'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US &amp; Canada)', 'Central America', 'Central Time (US &amp; Canada)', 'Guadalajara', 'Mexico City', 'Monterrey', 'Saskatchewan', 'Bogota', 'Eastern Time (US &amp; Canada)', 'Indiana (East)', 'Lima', 'Quito', 'Atlantic Time (Canada)', 'Caracas', 'Georgetown', 'La Paz', 'Puerto Rico', 'Santiago', 'Newfoundland', 'Brasilia', 'Buenos Aires', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London', 'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern', 'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid', 'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna', 'Warsaw', 'West Central Africa', 'Zagreb', 'Zurich', 'Athens', 'Bucharest', 'Cairo', 'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria', 'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait', 'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Volgograd', 'Yerevan', 'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai', 'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu', 'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi', 'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei', 'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk', 'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart', 'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji', 'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku&#39;alofa', 'Samoa', 'Tokelau Is.'
 -h, --help                                        Print help
Copy to Clipboard Toggle word wrap

10.75.4. hammer user delete
Copy link

Delete a user 

Usage:
    hammer user delete [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --login LOGIN                           User's login to search by
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.75.5. hammer user info
Copy link

Show a user 

Usage:
    hammer user info [OPTIONS]

Options:
 --id ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --login LOGIN                           User's login to search by
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.75.6. hammer user list
Copy link

List all users 

Usage:
    hammer user list [OPTIONS]

Options:
 --auth-source-ldap AUTH_SOURCE_LDAP_NAME  Name to search by
 --auth-source-ldap-id AUTH_SOURCE_LDAP_ID
 --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
 --role ROLE_NAME                          User role name
 --role-id ROLE_ID
 --search SEARCH                           Filter results
 --user-group USER_GROUP_NAME              Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.75.7. hammer user remove-role
Copy link

Remove a user role 

Usage:
    hammer user remove-role [OPTIONS]

Options:
 --id ID
 --login LOGIN                 User's login to search by
 --role ROLE_NAME              User role name
 --role-id ROLE_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.75.8. hammer user ssh-keys
Copy link

Managing User SSH Keys. 

Usage:
    hammer user ssh-keys [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 add                           Add an SSH key for a user
 delete                        Delete an SSH key for a user
 info                          Show an SSH key from a user
 list                          List all SSH keys for a user

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.75.8.1. hammer user ssh-keys add
Copy link

Add an SSH key for a user 

Usage:
    hammer user ssh-keys add [OPTIONS]

Options:
 --key KEY                               Public SSH key
 --key-file KEY_FILE                     Path to a SSH public key
 --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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.75.8.2. hammer user ssh-keys delete
Copy link

Delete an SSH key for a user 

Usage:
    hammer user ssh-keys 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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.75.8.3. hammer user ssh-keys info
Copy link

Show an SSH key from a user 

Usage:
    hammer user ssh-keys 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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.75.8.4. hammer user ssh-keys list
Copy link

List all SSH keys for a user 

Usage:
    hammer user ssh-keys 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
 --user USER_LOGIN                       User's login to search by
 --user-id USER_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.75.9. hammer user update
Copy link

Update a user 

Usage:
    hammer user update [OPTIONS]

Options:
 --admin ADMIN                                     Is an admin account
                                                   One of true/false, yes/no, 1/0.
 --ask-password ASK_PW                             One of true/false, yes/no, 1/0.
 --auth-source AUTH_SOURCE_NAME                    Name to search by
 --auth-source-id AUTH_SOURCE_ID
 --current-password CURRENT_PASSWORD               Required when user want to change own password
 --default-location DEFAULT_LOCATION_NAME          Default location name
 --default-location-id DEFAULT_LOCATION_ID
 --default-organization DEFAULT_ORGANIZATION_NAME  Default organization name
 --default-organization-id DEFAULT_ORGANIZATION_ID
 --description DESCRIPTION
 --firstname FIRSTNAME
 --id ID
 --lastname LASTNAME
 --locale LOCALE                                   User's preferred locale
                                                   Possible value(s): 'ca', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'nl_NL', 'pl', 'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW'
 --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
 --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
 --locations LOCATION_NAMES                        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --login LOGIN                                     User's login to search by
 --mail MAIL
 --new-login NEW_LOGIN
 --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
 --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
 --organizations ORGANIZATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --password PASSWORD                               Required unless user is in an external authentication source
 --role-ids ROLE_IDS                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --roles ROLE_NAMES                                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --timezone TIMEZONE                               User's timezone
                                                   Possible value(s): 'International Date Line West', 'American Samoa', 'Midway Island', 'Hawaii', 'Alaska', 'Pacific Time (US &amp; Canada)', 'Tijuana', 'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US &amp; Canada)', 'Central America', 'Central Time (US &amp; Canada)', 'Guadalajara', 'Mexico City', 'Monterrey', 'Saskatchewan', 'Bogota', 'Eastern Time (US &amp; Canada)', 'Indiana (East)', 'Lima', 'Quito', 'Atlantic Time (Canada)', 'Caracas', 'Georgetown', 'La Paz', 'Puerto Rico', 'Santiago', 'Newfoundland', 'Brasilia', 'Buenos Aires', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London', 'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern', 'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid', 'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna', 'Warsaw', 'West Central Africa', 'Zagreb', 'Zurich', 'Athens', 'Bucharest', 'Cairo', 'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria', 'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait', 'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Volgograd', 'Yerevan', 'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai', 'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu', 'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi', 'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei', 'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk', 'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart', 'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji', 'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku&#39;alofa', 'Samoa', 'Tokelau Is.'
 -h, --help                                        Print help
Copy to Clipboard Toggle word wrap

10.76. hammer user-group
Copy link

Manage user groups 

Usage:
    hammer user-group [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 add-role                      Assign a user role
 add-user                      Associate an user
 add-user-group                Associate an user group
 create                        Create a user group
 delete                        Delete a user group
 external                      View and manage user group's external user groups
 info                          Show a user group
 list                          List all user groups
 remove-role                   Remove a user role
 remove-user                   Disassociate an user
 remove-user-group             Disassociate an user group
 update                        Update a user group

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.76.1. hammer user-group add-role
Copy link

Assign a user role 

Usage:
    hammer user-group add-role [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --role ROLE_NAME              User role name
 --role-id ROLE_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.76.2. hammer user-group add-user
Copy link

Associate an user 

Usage:
    hammer user-group add-user [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user USER_LOGIN             User's login to search by
 --user-id USER_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.76.3. hammer user-group add-user-group
Copy link

Associate an user group 

Usage:
    hammer user-group add-user-group [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user-group USER_GROUP_NAME  Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.76.4. hammer user-group create
Copy link

Create a user group 

Usage:
    hammer user-group create [OPTIONS]

Options:
 --admin ADMIN                           Is an admin user group
                                         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
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --role-ids ROLE_IDS                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --roles ROLE_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-group-ids USER_GROUP_IDS         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-groups USER_GROUP_NAMES          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-ids USER_IDS                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --users USER_LOGINS                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.76.5. hammer user-group delete
Copy link

Delete a user group 

Usage:
    hammer user-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
Copy to Clipboard Toggle word wrap

10.76.6. hammer user-group external
Copy link

View and manage user group’s external user groups 

Usage:
    hammer user-group external [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create an external user group linked to a user group
 delete                        Delete an external user group
 info                          Show an external user group for user group
 list                          List all external user groups for user group
 refresh                       Refresh external user group
 update                        Update external user group

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap
10.76.6.1. hammer user-group external create
Copy link

Create an external user group linked to a user group 

Usage:
    hammer user-group external create [OPTIONS]

Options:
 --auth-source AUTH_SOURCE_NAME          Name to search by
 --auth-source-id AUTH_SOURCE_ID
 --location LOCATION_NAME                Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE         Location title
 --name NAME                             External user group name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.76.6.2. hammer user-group external delete
Copy link

Delete an external user group 

Usage:
    hammer user-group external delete [OPTIONS]

Options:
 --id ID                                 ID or name external user group
 --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
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.76.6.3. hammer user-group external info
Copy link

Show an external user group for user group 

Usage:
    hammer user-group external info [OPTIONS]

Options:
 --id ID                                 ID or name of external user group
 --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
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.76.6.4. hammer user-group external list
Copy link

List all external user groups for user group 

Usage:
    hammer user-group external list [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
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.76.6.5. hammer user-group external refresh
Copy link

Refresh external user group 

Usage:
    hammer user-group external refresh [OPTIONS]

Options:
 --id ID                                 ID or name of external user group
 --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
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap
10.76.6.6. hammer user-group external update
Copy link

Update external user group 

Usage:
    hammer user-group external update [OPTIONS]

Options:
 --auth-source AUTH_SOURCE_NAME          Name to search by
 --auth-source-id AUTH_SOURCE_ID
 --id ID                                 ID or name of external user group
 --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                     External user group name
 --organization ORGANIZATION_NAME        Organization name
 --organization-id ORGANIZATION_ID       Organization ID
 --organization-title ORGANIZATION_TITLE Organization title
 --user-group USER_GROUP_NAME            Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.76.7. hammer user-group info
Copy link

Show a user group 

Usage:
    hammer user-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
Copy to Clipboard Toggle word wrap

10.76.8. hammer user-group list
Copy link

List all user groups 

Usage:
    hammer user-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
Copy to Clipboard Toggle word wrap

10.76.9. hammer user-group remove-role
Copy link

Remove a user role 

Usage:
    hammer user-group remove-role [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --role ROLE_NAME              User role name
 --role-id ROLE_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.76.10. hammer user-group remove-user
Copy link

Disassociate an user 

Usage:
    hammer user-group remove-user [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user USER_LOGIN             User's login to search by
 --user-id USER_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.76.11. hammer user-group remove-user-group
Copy link

Disassociate an user group 

Usage:
    hammer user-group remove-user-group [OPTIONS]

Options:
 --id ID
 --name NAME                   Name to search by
 --user-group USER_GROUP_NAME  Name to search by
 --user-group-id USER_GROUP_ID
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.76.12. hammer user-group update
Copy link

Update a user group 

Usage:
    hammer user-group update [OPTIONS]

Options:
 --admin ADMIN                           Is an admin user group
                                         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                             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
 --role-ids ROLE_IDS                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --roles ROLE_NAMES                      Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-group-ids USER_GROUP_IDS         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-groups USER_GROUP_NAMES          Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --user-ids USER_IDS                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --users USER_LOGINS                     Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.77. hammer virt-who-config
Copy link

Manage Virt Who configurations 

Usage:
    hammer virt-who-config [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a virt-who configuration
 delete                        Delete a virt-who configuration
 deploy                        Download and execute script for the specified virt-who configuration
 fetch                         Renders a deploy script for the specified virt-who configuration
 info                          Show a virt-who configuration
 list                          List of virt-who configurations
 update                        Update a virt-who configuration

Options:
 -h, --help                    Print help
Copy to Clipboard Toggle word wrap

10.77.1. hammer virt-who-config create
Copy link

Create a virt-who configuration 

Usage:
    hammer virt-who-config create [OPTIONS]

Options:
 --blacklist BLACKLIST                     Hypervisor blacklist, applicable only when filtering mode is set to 2.
                                           Wildcards and regular expressions are supported, multiple records must be
                                           Separated by comma.
 --debug DEBUG                             Enable debugging output
                                           One of true/false, yes/no, 1/0.
 --filtering-mode MODE                     Hypervisor filtering mode
                                           Possible value(s): 'none', 'whitelist', 'blacklist'
 --hypervisor-id HYPERVISOR_ID             Specifies how the hypervisor will be identified.
                                           Possible value(s): 'hostname', 'uuid', 'hwuuid'
 --hypervisor-password HYPERVISOR_PASSWORD Hypervisor password, required for all hypervisor types except for libvirt
 --hypervisor-server HYPERVISOR_SERVER     Fully qualified host name or IP address of the hypervisor
 --hypervisor-type HYPERVISOR_TYPE         Hypervisor type
                                           Possible value(s): 'esx', 'rhevm', 'hyperv', 'xen', 'libvirt'
 --hypervisor-username HYPERVISOR_USERNAME Account name by which virt-who is to connect to the hypervisor.
 --interval INTERVAL                       Configuration interval in minutes
                                           Possible value(s): '60', '120', '240', '480', '720'
 --location LOCATION_NAME                  Location name
 --location-id LOCATION_ID
 --location-title LOCATION_TITLE           Location title
 --name NAME                               Configuration name
 --no-proxy NO_PROXY                       Ignore Proxy. A comma-separated list of hostnames or domains or ip
                                           Addresses to ignore Capsule settings for. Optionally this may be set to *
                                           To bypass proxy settings for all hostnames domains or ip addresses.
 --organization ORGANIZATION_NAME          Organization name
 --organization-id ORGANIZATION_ID         Organization ID
 --organization-title ORGANIZATION_TITLE   Organization title
 --proxy PROXY                             HTTP Proxy that should be used for communication between the server on
                                           Which virt-who is running and the hypervisors and virtualization managers.
 --satellite-url SATELLITE_URL             Satellite server FQDN
 --whitelist WHITELIST                     Hypervisor whitelist, applicable only when filtering mode is set to 1.
                                           Wildcards and regular expressions are supported, multiple records must be
                                           Separated by comma.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

10.77.2. hammer virt-who-config delete
Copy link

Delete a virt-who configuration 

Usage:
    hammer virt-who-config delete [OPTIONS]

Options:
 --id ID                                 Configuration numeric identifier
 --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
Copy to Clipboard Toggle word wrap

10.77.3. hammer virt-who-config deploy
Copy link

Download and execute script for the specified virt-who configuration 

Usage:
    hammer virt-who-config deploy [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
Copy to Clipboard Toggle word wrap

10.77.4. hammer virt-who-config fetch
Copy link

Renders a deploy script for the specified virt-who configuration 

Usage:
    hammer virt-who-config fetch [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
 --output, -o FILE                       File where the script will be written.
 -h, --help                              Print help
Copy to Clipboard Toggle word wrap

10.77.5. hammer virt-who-config info
Copy link

Show a virt-who configuration 

Usage:
    hammer virt-who-config 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
Copy to Clipboard Toggle word wrap

10.77.6. hammer virt-who-config list
Copy link

List of virt-who configurations 

Usage:
    hammer virt-who-config 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
Copy to Clipboard Toggle word wrap

10.77.7. hammer virt-who-config update
Copy link

Update a virt-who configuration 

Usage:
    hammer virt-who-config update [OPTIONS]

Options:
 --blacklist BLACKLIST                     Hypervisor blacklist, applicable only when filtering mode is set to 2.
                                           Wildcards and regular expressions are supported, multiple records must be
                                           Separated by comma.
 --debug DEBUG                             Enable debugging output
                                           One of true/false, yes/no, 1/0.
 --filtering-mode MODE                     Hypervisor filtering mode
                                           Possible value(s): 'none', 'whitelist', 'blacklist'
 --hypervisor-id HYPERVISOR_ID             Specifies how the hypervisor will be identified.
                                           Possible value(s): 'hostname', 'uuid', 'hwuuid'
 --hypervisor-password HYPERVISOR_PASSWORD Hypervisor password, required for all hypervisor types except for libvirt
 --hypervisor-server HYPERVISOR_SERVER     Fully qualified host name or IP address of the hypervisor
 --hypervisor-type HYPERVISOR_TYPE         Hypervisor type
                                           Possible value(s): 'esx', 'rhevm', 'hyperv', 'xen', 'libvirt'
 --hypervisor-username HYPERVISOR_USERNAME Account name by which virt-who is to connect to the hypervisor.
 --id ID                                   Configuration numeric identifier
 --interval INTERVAL                       Configuration interval in minutes
                                           Possible value(s): '60', '120', '240', '480', '720'
 --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                       Configuration name
 --no-proxy NO_PROXY                       Ignore Proxy. A comma-separated list of hostnames or domains or ip
                                           Addresses to ignore Capsule settings for. Optionally this may be set to *
                                           To bypass proxy settings for all hostnames domains or ip addresses.
 --organization ORGANIZATION_NAME          Organization name
 --organization-id ORGANIZATION_ID         Organization ID
 --organization-title ORGANIZATION_TITLE   Organization title
 --proxy PROXY                             HTTP Proxy that should be used for communication between the server on
                                           Which virt-who is running and the hypervisors and virtualization managers.
 --satellite-url SATELLITE_URL             Satellite server FQDN
 --whitelist WHITELIST                     Hypervisor whitelist, applicable only when filtering mode is set to 1.
                                           Wildcards and regular expressions are supported, multiple records must be
                                           Separated by comma.
 -h, --help                                Print help
Copy to Clipboard Toggle word wrap

Legal Notice
Copy link

Copyright © 2019 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat