Search

Hammer CLI Guide

download PDF
Red Hat Satellite 6.15

Develop custom scripts by using Hammer, the Satellite command-line tool

Red Hat Satellite Documentation Team

Abstract

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

Providing feedback on Red Hat documentation

We appreciate your feedback on our documentation. Let us know how we can improve it.

Use the Create Issue form in Red Hat Jira to provide your feedback. The Jira issue is created in the Red Hat Satellite Jira project, where you can track its progress.

Prerequisites

Procedure

  1. Click the following link: Create Issue. If Jira displays a login error, log in and proceed after you are redirected to the form.
  2. Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form.
  3. Click Create.

Chapter 1. Introduction to Hammer

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

Hammer compared to Satellite web UI

Compared to navigating the web UI, using Hammer can result in much faster interaction with the Satellite Server, as common shell features such as environment variables and aliases are at your disposal. You can also incorporate Hammer commands into reusable scripts for automating tasks of various complexity. Output from Hammer commands can be redirected to other tools, which allows for integration with your existing environment. You can issue Hammer commands directly on the base operating system running Red Hat Satellite.

Access to Satellite Server’s base operating system is required to issue Hammer commands, which can limit the number of potential users compared to the web UI. Although the parity between Hammer and the web UI is almost complete, the web UI has development priority and can be ahead especially for newly introduced features.

Hammer compared to Satellite API

For many tasks, both Hammer and Satellite API are equally applicable. Hammer can be used as a human friendly interface to Satellite API, for example to test responses to API calls before applying them in a script (use the -d option to inspect API calls issued by Hammer, for example hammer -d organization list). Changes in the API are automatically reflected in Hammer, while scripts using the API directly have to be updated manually.

In the background, each Hammer command first establishes a binding to the API, then sends a request. This can have performance implications when executing a large number of Hammer commands in sequence. In contrast, a script communicating directly with the API establishes the binding only once. See the API Guide for more information.

1.1. Getting help

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

$ hammer --help

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

$ hammer organization --help

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

$ hammer | less

1.2. Authentication

A Satellite user must prove their identity to Red Hat Satellite when entering hammer commands. Hammer commands can be run manually or automatically. In either case, hammer requires Satellite credentials for authentication. There are three methods of hammer authentication:

  • Hammer authentication session
  • Storing credentials in the hammer configuration file
  • Providing credentials with each hammer command

The hammer configuration file method is recommended when running commands automatically. For example, running Satellite maintenance commands from a cron job. When running commands manually, Red Hat recommends using the hammer authentication session and providing credentials with each command.

1.2.1. Hammer authentication session

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

See the instructions on how to use the sessions:

  • To enable sessions, add :use_sessions: true to the ~/.hammer/cli.modules.d/foreman.yml file:

    :foreman:
     :use_sessions: true

    Note that if you enable sessions, credentials stored in the configuration file will be ignored.

  • To start a session, enter the following command:

    # hammer auth login

    You are prompted for your Satellite credentials, and logged in. You will not be prompted for the credentials again until your session expires.

  • The default length of a session is 60 minutes. You can change the time to suit your preference. For example, to change it to 30 minutes, enter the following command:

    # hammer settings set --name idle_timeout --value 30
    Setting [idle_timeout] updated to [30]
  • To see the current status of the session, enter the following command:

    # hammer auth status
  • To end the session, enter the following command:

    # hammer auth logout

1.2.2. Hammer configuration file

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

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

:foreman:
 :username: 'username'
 :password: 'password'
Important

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

1.2.3. Command line

If you do not have your Satellite credentials saved in the ~/.hammer/cli.modules.d/foreman.yml configuration file, hammer prompts you for them each time you enter a command. You can specify your credentials when executing a command as follows:

$ hammer -u username -p password subcommands
Note

Examples in this guide assume that you have saved credentials in the configuration file, or are using a hammer authentication session.

1.3. Using standalone hammer

You can install hammer on a host running Red Hat Enterprise Linux 8 that has no Satellite 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 Hosts in Managing hosts.
  • Ensure that you synchronize the following repositories on Satellite Server or Capsule Server. For more information, see Synchronizing Repositories in Managing content.

    • rhel-8-for-x86_64-baseos-rpms
    • rhel-8-for-x86_64-appstream-rpms
    • satellite-utils-6.15-for-rhel-8-x86_64-rpms

Procedure

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

  1. Enable the required repositories:

    # subscription-manager repos --enable=rhel-8-for-x86_64-baseos-rpms \
    --enable=rhel-8-for-x86_64-appstream-rpms \
    --enable=satellite-utils-6.15-for-rhel-8-x86_64-rpms
  2. Enable the Satellite Utils module:

    # dnf module enable satellite-utils:el8
  3. Install hammer:

    # {package-install} rubygem-hammer_cli_katello
  4. Edit the :host: entry in the /etc/hammer/cli.modules.d/foreman.yml file to include the Satellite IP address or FQDN.

    :host: 'https://satellite.example.com'

1.4. Setting a default organization and location

Many hammer commands are organization specific. You can set a default organization and location for hammer commands so that you do not have to specify them every time with the --organization and --location options.

Specifying a default organization is useful when you mostly manage a single organization, as it makes your commands shorter. However, when you switch to a different organization, you must use hammer with the --organization option to specify it.

Procedure

To set a default organization and location, complete the following steps:

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

    # hammer defaults add --param-name organization \
    --param-value "Your_Organization"

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

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

    # hammer defaults add --param-name location \
    --param-value "Your_Location"

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

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

    # hammer defaults list

1.5. Configuring Hammer

The default location for global hammer configuration is:

  • /etc/hammer/cli_config.yml for general hammer settings
  • /etc/hammer/cli.modules.d/ for CLI module configuration files

You can set user specific directives for hammer (in ~/.hammer/cli_config.yml) as well as for CLI modules (in respective .yml files under ~/.hammer/cli.modules.d/).

To see the order in which configuration files are loaded, as well as versions of loaded modules, use:

$ hammer -d --version
Note

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

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

:log_level: 'warning'
:log_size: 5 #in MB

Similarly, you can configure user interface settings. For example, set the number of entries displayed per request in the Hammer output by changing the following line:

:per_page: 30

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

1.6. Configuring Hammer logging

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

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

Note

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

# satellite-maintain service restart
  • To set debug level for all components, use the following command:

    # hammer admin logging --all --level-debug
    # satellite-maintain service restart
  • To set production level logging, use the following command:

    # hammer admin logging --all --level-production
    # satellite-maintain service restart
  • To list the currently recognized components, that you can set logging for:

    # hammer admin logging --list
  • To list all available logging options:

    # hammer admin logging --help
    
    Usage:
        hammer admin logging [OPTIONS]

1.7. Invoking the Hammer shell

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

$ hammer shell

In the shell, you can enter sub-commands directly without typing "hammer", which can be useful for testing commands before using them in a script. To exit the shell, type exit or press Ctrl + D.

1.8. Generating formatted output

You can modify the default formatting of the output of hammer commands to simplify the processing of this output by other command line tools and applications. For example, to list organizations in a CSV format with a custom separator (in this case a semicolon), use the following command:

$ hammer --csv --csv-separator ";" organization list

Output in CSV format is useful for example when you need to parse IDs and use them in a for loop.

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

$ hammer --output output_format organization list

Replace output_format with one of:

  • table — generates output in the form of a human readable table (default).
  • base — generates output in the form of key-value pairs.
  • yaml — generates output in the YAML format.
  • csv — generates output in the Comma Separated Values format. To define a custom separator, use the --csv and --csv-separator options instead.
  • json — generates output in the JavaScript Object Notation format.
  • silent — suppresses the output.

1.9. Hiding header output from Hammer commands

When you use any hammer command, you have the option of hiding headers from the output. If you want to pipe or use the output in custom scripts, hiding the output is useful.

  • To hide the header output, add the --no-headers option to any hammer command.

1.10. Using JSON for complex parameters

JSON is the preferred way to describe complex parameters.

An example of JSON formatted content appears below:

# hammer compute-profile values create --compute-profile-id 22 --compute-resource-id 1 --compute-attributes=
'{
"cpus": 2,
"corespersocket": 2,
"memory_mb": 4096,
"firmware": "efi",
"resource_pool": "Resources",
"cluster": "Example_Cluster",
"guest_id": "rhel8",
"path": "/Datacenters/EXAMPLE/vm/",
"hardware_version": "Default",
"memoryHotAddEnabled": 0,
"cpuHotAddEnabled": 0,
"add_cdrom": 0,
"boot_order": [
               “disk",
               "network"
              ],
"scsi_controllers":[
      {
       "type":  "ParaVirtualSCSIController",
       "key":1000
       },
      {
        "type":  "ParaVirtualSCSIController",
        "key":1001
       }it
                   ]
}'

1.11. Troubleshooting with Hammer

You can use the hammer ping command to check the status of core Satellite services. Together with the satellite-maintain service status command, this can help you to diagnose and troubleshoot Satellite issues. If all services are running as expected, the output looks as follows:

$ hammer ping
candlepin:
    Status:          ok
    Server Response: Duration: 22ms
candlepin_auth:
    Status:          ok
    Server Response: Duration: 17ms
pulp:
    Status:          ok
    Server Response: Duration: 41ms
pulp_auth:
    Status:          ok
    Server Response: Duration: 23ms
foreman_tasks:
    Status:          ok
    Server Response: Duration: 33ms

Chapter 2. Hammer cheat sheet

Hammer is a command-line tool provided with Red Hat Satellite 6. You can use Hammer to configure and manage a Red Hat Satellite Server by using either CLI commands or shell script automation. The following cheat sheet provides a condensed overview of essential Hammer commands.

2.1. General information

SubcommandDescription and tasks

--help

Display hammer commands and options, append after a subcommand to get more information

org

The setting is organization-specific, append --organization org_name, or set default organization with:

hammer defaults add \
--param-name organization_id \
--param-value org_ID

loc

The setting is location-specific, append --location loc_name, or set default location with:

hammer defaults add \
--param-name location_id \
--param-value loc_ID

Note: This cheat sheet assumes saved credentials in ~/.hammer/cli_config.yml. For more information, see Section 1.2, “Authentication”.

2.2. Organizations, locations, and repositories

SubcommandDescription and tasks

organization

Create an organization:

hammer organization create \
--name org_name

List organizations:

hammer organization list

location

See the options for organization

subscription
org

Upload a subscription manifest:

hammer subscription upload \
--file path

repository-set
org

Enable a repository:

hammer repository-set enable \
--product prod_name \
--basearch base_arch \
--releasever rel_v \
--name repo_name

repository
org

Synchronize a repository:

hammer repository synchronize \
--product prod_name \
--name repo_name

Create a custom repository:

hammer repository create \
--product prod_name \
--content-type cont_type \
--publish-via-http true \
--url repo_url \
--name repo_name

Upload content to a custom repository:

hammer repository upload-content \
--product prod_name \
--id repo_id \
--path path_to_dir

2.3. Content life cycles

SubcommandDescription and tasks

lifecycle-environment
org

Create a life cycle environment:

hammer lifecycle-environment create \
--name env_name
--description env_desc
--prior prior_env_name

List life cycle environments:

hammer lifecycle-environment list

content-view
org

Create a content view:

hammer content-view create \
--name cv_n \
--repository-ids repo_ID1,... \
--description cv_description

Add repositories to a content view:

hammer content-view add-repository \
--name cv_n \
--repository-id repo_ID

Add Puppet modules to a content view:

hammer content-view puppet-module add \
--content-view cv_n \
--name module_name

Publishing a content view:

hammer content-view publish \
--id cv_ID

Promoting a content view:

hammer content-view version promote \
--content-view cv_n \
--to-lifecycle-environment env_name

Incremental update of a content view:

hammer content-view version incremental-update \
--content-view-version-id cv_ID \
--packages pkg_n1,... \
--lifecycle-environment-ids env_ID1,...

2.4. Provisioning environments

SubcommandDescription and tasks

domain

Create a domain:

hammer domain create \
--name domain_name

subnet
org
loc

Add a subnet:

hammer subnet create \
--name subnet_name \
--organization-ids org_ID1,... \
--location-ids loc_ID1,... \
--domain-ids dom_ID1,... \
--boot-mode boot_mode \
--network network_address \
--mask netmask --ipam ipam

compute-resource
org
loc

Create a compute resource:

hammer compute-resource create \
--name cr_name \
--organization-ids org_ID1,... \
--location-ids loc_ID1,... \
--provider provider_name

medium

Add an installation medium:

hammer medium create \
--name med_name \
--path path_to_medium

partition-table

Add a partition table:

hammer partition-table create \
--name tab_name \
--path path_to_file \
--os-family os_family

template

Add a provisioning template:

hammer template create \
--name tmp_name \
--file path_to_template

os

Add an operating system:

hammer os create \
--name os_name \
--version version_num

2.5. Activation keys

SubcommandDescription and tasks

activation-key
org

Create an activation key:

hammer activation-key create \
--name ak_name \
--content-view cv_n \
--lifecycle-environment lc_name

Add a subscription to the activation key:

hammer activation-key add-subscription \
--id ak_ID \
--subscription-id sub_ID

2.6. Users and permissions

SubcommandDescription and tasks

user
org

Create a user:

hammer user create \
--login user_name \
--mail user_mail \
--auth-source-id 1 \
--organization-ids org_ID1,org_ID2,...

Add a role to a user:

hammer user add-role \
--id user_id \
--role role_name

user-group

Create a user group:

hammer user-group create \
--name ug_name

Add a role to a user group:

hammer user-group add-role \
--id ug_id \
--role role_name

role

Create a role:

hammer role create \
--name role_name

filter

Create a filter and add it to a role:

hammer filter create \
--role role_name \
--permission-ids perm_ID1,perm_ID2,...

2.7. Errata

SubcommandDescription and tasks

erratum

List errata:

hammer erratum list

Find erratum by CVE:

hammer erratum list --cve CVE

Inspect erratum:

hammer erratum info --id err_ID

host

List errata applicable to a host:

hammer host errata list \
--host host_name

Apply errata to a host:

hammer host errata apply \
--host host_name \
--errata-ids err_ID1,err_ID2,...

2.8. Hosts

SubcommandDescription and tasks

hostgroup
org
loc

Create a host group:

hammer hostgroup create \
--name hg_name \
--puppet-environment env_name \
--architecture arch_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,... \
--location-ids loc_ID1,...

Add an activation key to a host group:

hammer hostgroup set-parameter \
--hostgroup "hg_name" \
--name "kt_activation_keys" \
--value key_name

host
org
loc

Create a host (inheriting parameters from a host group):

hammer host create \
--name host_name \
--hostgroup hg_name \
--interface="primary=true, \
mac=mac_addr, ip=ip_addr, \
provision=true" \
--organization-id org_ID \
--location-id loc_ID \
--ask-root-password yes

Remove the host from host group:

hammer host update --name host_name --hostgroup NIL

job-template

Add a job template for remote execution:

hammer job-template create \
--file path \
--name template_name \
--provider-type SSH \
--job-category category_name

job-invocation

Invoke a remote job:

hammer job-invocation create \
--job-template template_name \
--inputs key1=value,... \
--search-query query

Monitor the remote job:

hammer job-invocation output \
--id job_id --host host_name

2.9. Tasks

SubcommandDescription and tasks

task

List all tasks:

hammer task list
Monitor progress of a running task:
hammer task progress \
--id task_ID

Chapter 3. Hammer reference

You can review the usage of Hammer statements. These usage statements are current to the versions of Hammer and its components released for Satellite 6.15.

3.1. hammer

Usage

# hammer [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • --[no-]use-defaults – Enable/disable stored defaults. Enabled by default
  • --autocomplete VALUE – Get list of possible endings
  • --csv – Output as CSV (same as --output=csv)
  • --csv-separator VALUE – Character to separate the values
  • --fetch-ca-cert VALUE – Fetch CA certificate from server and exit
  • --interactive BOOLEAN – Explicitly turn interactive mode on/off
  • --no-headers – Hide headers from output
  • --output ENUM – Set output format Possible value(s): base, table, silent, csv, yaml, json
  • --output-file VALUE – Path to custom output file
  • --show-ids – Show ids of associated resources
  • --ssl-ca-file VALUE – Configure the file containing the CA certificates
  • --ssl-ca-path VALUE – Configure the directory containing the CA certificates
  • --ssl-client-cert VALUE – Configure the client`s public certificate
  • --ssl-client-key VALUE – Configure the client`s private key
  • --ssl-with-basic-auth – Use standard authentication in addition to client certificate authentication
  • --verify-ssl BOOLEAN – Configure SSL verification of remote system
  • --version – Show version
  • -c, --config VALUE – Path to custom config file
  • -d, --debug – Show debugging output
  • -h, --help – Print help
  • -p, --password VALUE – Password to access the remote system
  • -q, --quiet – Completely silent
  • -r, --reload-cache – Force reload of Apipie cache
  • -s, --server VALUE – Remote system address
  • -u, --username VALUE – Username to access the remote system
  • -v, --[no-]verbose – Be verbose (or not). True by default

3.2. activation-key

Manipulate activation keys

Usage

# hammer activation-key [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.2.1. activation-key add-host-collection

Associate a resource

Usage

# hammer activation-key add-host-collection [OPTIONS]

Options

  • --host-collection VALUE – Host collection name to search by
  • --host-collection-id NUMBER – Id of the host collection
  • --id VALUE – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization ID
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help

3.2.2. activation-key add-subscription

Add subscription

Usage

# hammer activation-key add-subscription [OPTIONS]

Options

  • --id NUMBER – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --quantity NUMBER – Quantity of this subscription to add
  • --subscription VALUE – Subscription name to search by
  • --subscription-id NUMBER – Subscription identifier
  • --subscriptions SCHEMA – Array of subscriptions to add
  • -h, --help – Print help

Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value):

  • --subscriptions – "id=<string>,quantity=<numeric>, …​ "

3.2.3. activation-key content-override

Override product content defaults

Usage

# hammer activation-key content-override [OPTIONS]

Options

  • --content-label VALUE – Label of the content
  • --id NUMBER – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --override-name VALUE – 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

3.2.4. activation-key copy

Copy an activation key

Usage

# hammer activation-key copy [OPTIONS]

Options

  • --id NUMBER – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --new-name VALUE – Name of new activation key
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization identifier
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help

3.2.5. activation-key create

Create an activation key

Usage

# hammer activation-key create [OPTIONS]

Options

  • --auto-attach BOOLEAN – Auto attach subscriptions upon registration
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view id
  • --description VALUE – Description
  • --environment VALUE – Lifecycle environment name to search by (--environment is deprecated: Use
  • --lifecycle-environment instead)
  • --environment-id NUMBER – (--environment-id is deprecated: Use --lifecycle-environment-id instead)
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Environment id
  • --max-hosts NUMBER – Maximum number of registered content hosts
  • --name VALUE – Name
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization identifier
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --purpose-addons LIST – Sets the system add-ons
  • --purpose-role VALUE – Sets the system purpose usage
  • --purpose-usage VALUE – Sets the system purpose usage
  • --release-version VALUE – Content release version
  • --service-level VALUE – Service level
  • --unlimited-hosts – Set hosts max to unlimited
  • -h, --help – Print help

3.2.6. activation-key delete

Destroy an activation key

Usage

# hammer activation-key <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help

3.2.7. activation-key host-collections

List associated host collections

Usage

# hammer activation-key host-collections [OPTIONS]

Options

  • --available-for VALUE – Interpret specified object to return only Host Collections that can be associated with specified object. The value host is supported.
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --host-id NUMBER – Filter products by host id
  • --id VALUE – ID of activation key
  • --name VALUE – Name of activation key
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization identifier
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --sort-by VALUE – Field to sort the results on
  • --sort-order VALUE – How to order the sorted results (e.g. ASC for ascending)
  • -h, --help – Print help
Table 3.1. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

3.2.8. activation-key info

Show an activation key

Usage

# hammer activation-key <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization identifier
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --show-hosts BOOLEAN – Show hosts associated to an activation key
  • -h, --help – Print help
Table 3.2. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

Id

x

x

x

Description

x

x

 

Host limit

x

x

 

Auto attach

x

x

 

Release version

x

x

 

Lifecycle environment

x

x

 

Content view

x

x

 

Associated hosts/id

x

x

 

Associated hosts/name

x

x

 

Host collections/id

x

x

 

Host collections/name

x

x

 

Content overrides/content label

x

x

 

Content overrides/name

x

x

 

Content overrides/value

x

x

 

System purpose/service level

x

x

 

System purpose/purpose usage

x

x

 

System purpose/purpose role

x

x

 

System purpose/purpose addons

x

x

 

3.2.9. activation-key list

List activation keys

Usage

# hammer activation-key <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --environment VALUE – Lifecycle environment name to search by (--environment is deprecated: Use
  • --lifecycle-environment instead)
  • --environment-id NUMBER – (--environment-id is deprecated: Use --lifecycle-environment-id instead)
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Environment identifier
  • --name VALUE – Activation key name to filter by
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization identifier
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --search VALUE – Search string
  • -h, --help – Print help
Table 3.3. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Host limit

x

x

 

Lifecycle environment

x

x

 

Content view

x

x

 

Search / Order fields

  • addon – string
  • content_view – string
  • content_view_id – integer
  • description – text
  • environment – string
  • name – string
  • organization_id – integer
  • role – string
  • subscription_id – string
  • subscription_name – string
  • usage – string

3.2.10. activation-key product-content

List associated products

Usage

# hammer activation-key product-content [OPTIONS]

Options

  • --content-access-mode-all BOOLEAN Get all content available, not just that provided by subscriptions
  • --content-access-mode-env BOOLEAN Limit content to just that available in the activation key`s content view version
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --id VALUE – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --search VALUE – Search string
  • -h, --help – Print help
Table 3.4. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Type

x

x

 

Url

x

x

 

Gpg key

x

x

 

Label

x

x

 

Default enabled?

x

x

 

Override

x

x

 

3.2.11. activation-key remove-host-collection

Disassociate a resource

Usage

# hammer activation-key remove-host-collection [OPTIONS]

Options

  • --host-collection VALUE – Host collection name to search by
  • --host-collection-id NUMBER – Id of the host collection
  • --id VALUE – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization ID
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help

3.2.12. activation-key remove-subscription

Remove subscription

Usage

# hammer activation-key remove-subscription [OPTIONS]

Options

  • --id NUMBER – ID of the activation key
  • --name VALUE – Activation key name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --subscription-id VALUE – ID of subscription
  • -h, --help – Print help

3.2.13. activation-key subscriptions

List associated subscriptions

Usage

# hammer activation-key subscriptions [OPTIONS]

Options

  • --activation-key VALUE – Activation key name to search by
  • --activation-key-id VALUE – Activation key ID
  • --available-for VALUE – Object to show subscriptions available for, either host or activation_key
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --host VALUE – Host name
  • --host-id VALUE – Id of a host
  • --id VALUE – ID of the activation key
  • --match-host BOOLEAN – Ignore subscriptions that are unavailable to the specified host
  • --match-installed BOOLEAN – Return subscriptions that match installed products of the specified host
  • --name VALUE – Activation key name to search by
  • --no-overlap BOOLEAN – Return subscriptions which do not overlap with a currently-attached subscription
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization ID
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --search VALUE – Search string
  • -h, --help – Print help
Table 3.5. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Name

x

x

Attached

x

x

Quantity

x

x

Start date

x

x

End date

x

x

Support

x

x

Contract

x

x

Account

x

x

3.2.14. activation-key update

Update an activation key

Usage

# hammer activation-key update [OPTIONS]

Options

  • --auto-attach BOOLEAN – Auto attach subscriptions upon registration
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view id
  • --description VALUE – Description
  • --environment VALUE – Lifecycle environment name to search by (--environment is deprecated: Use
  • --lifecycle-environment instead)
  • --environment-id NUMBER – (--environment-id is deprecated: Use --lifecycle-environment-id instead)
  • --id NUMBER – ID of the activation key
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Environment id
  • --max-hosts NUMBER – Maximum number of registered content hosts
  • --name VALUE – Name
  • --new-name VALUE – Name
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Organization identifier
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --purpose-addons LIST – Sets the system add-ons
  • --purpose-role VALUE – Sets the system purpose usage
  • --purpose-usage VALUE – Sets the system purpose usage
  • --release-version VALUE – Content release version
  • --service-level VALUE – Service level
  • --unlimited-hosts – Set hosts max to unlimited
  • -h, --help – Print help

3.3. admin

Administrative server-side tasks

Usage

# hammer admin [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.3.1. admin logging

Logging verbosity level setup

Usage

# hammer admin logging [OPTIONS]

Options

  • --no-backup – Skip configuration backups creation.
  • --prefix VALUE – Operate on prefixed environment (e.g. chroot).
  • -a, --all – Apply to all components.
  • -c, --components LIST – Components to apply, use --list to get them.
  • -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.

3.4. alternate-content-source

Manipulate alternate content sources

Usage

# hammer alternate-content-source [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.4.1. alternate-content-source bulk

Modify alternate content sources in bulk

Usage

# hammer alternate-content-source bulk [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.4.1.1. alternate-content-source bulk destroy

Destroy alternate content sources

Usage

# hammer alternate-content-source bulk destroy [OPTIONS]

Options

  • --ids LIST – List of alternate content source IDs
  • -h, --help – Print help
3.4.1.2. alternate-content-source bulk refresh

Refresh alternate content sources

Usage

# hammer alternate-content-source bulk refresh [OPTIONS]

Options

  • --ids LIST – List of alternate content source IDs
  • -h, --help – Print help
3.4.1.3. alternate-content-source bulk refresh-all

Refresh all alternate content sources

Usage

# hammer alternate-content-source bulk refresh-all [OPTIONS]

Options

  • -h, --help – Print help

3.4.2. alternate-content-source create

Create an alternate content source to download content from during repository syncing. Note: alternate content sources are global and affect ALL sync actions on their capsules regardless of organization.

Usage

# hammer alternate-content-source create [OPTIONS]

Options

  • --alternate-content-source-type ENUM The Alternate Content Source type Possible value(s): custom, simplified, rhui
  • --base-url VALUE – Base URL for finding alternate content
  • --content-type ENUM – The content type for the Alternate Content Source Possible value(s): file, yum
  • --description VALUE – Description for the alternate content source
  • --name VALUE – Name of the alternate content source
  • --product-ids LIST – IDs of products to copy repository information from into a Simplified Alternate Content Source. Products must include at least one repository of the chosen content type.
  • --smart-proxies LIST
  • --smart-proxy-ids LIST – Ids of capsules to associate
  • --smart-proxy-names LIST – Names of capsules to associate
  • --ssl-ca-cert-id NUMBER – Identifier of the content credential containing the SSL CA Cert
  • --ssl-client-cert-id NUMBER – Identifier of the content credential containing the SSL Client Cert
  • --ssl-client-key-id NUMBER – Identifier of the content credential containing the SSL Client Key
  • --subpaths LIST – Path suffixes for finding alternate content
  • --upstream-password VALUE – Basic authentication password
  • --upstream-username VALUE – Basic authentication username
  • --use-http-proxies BOOLEAN – If the capsules` assigned HTTP Proxies should be used
  • --verify-ssl BOOLEAN – If SSL should be verified for the upstream URL
  • -h, --help – Print help

3.4.3. alternate-content-source delete

Destroy an alternate content source.

Usage

# hammer alternate-content-source <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – Alternate content source ID
  • --name VALUE – Name to search by
  • -h, --help – Print help

3.4.4. alternate-content-source info

Show an alternate content source.

Usage

# hammer alternate-content-source <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Alternate content source ID
  • --name VALUE – Name to search by
  • -h, --help – Print help
Table 3.6. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Label

x

x

 

Description

x

x

 

Base url

x

x

 

Content type

x

x

 

Alternate content source type

x

x

 

Upstream username

x

x

 

Verify ssl

x

x

 

Ssl ca cert/id

x

x

 

Ssl ca cert/name

x

x

 

Ssl client cert/id

x

x

 

Ssl client cert/name

x

x

 

Ssl client key/id

x

x

 

Ssl client key/name

x

x

 

Subpaths/

x

x

 

Products/id

x

x

 

Products/organization id

x

x

 

Products/name

x

x

 

Products/label

x

x

 

Smart proxies/id

x

x

 

Smart proxies/name

x

x

 

Smart proxies/url

x

x

 

Smart proxies/download policy

x

x

 

3.4.5. alternate-content-source list

List alternate content sources.

Usage

# hammer alternate-content-source <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --name VALUE – Name of the alternate content source
  • --order VALUE – Sort field and order, eg. id DESC
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --search VALUE – Search string
  • -h, --help – Print help
Table 3.7. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Type

x

x

 

Search / Order fields

  • alternate_content_source_type – string
  • base_url – string
  • content_type – string
  • description – text
  • label – string
  • name – string
  • product_id – integer
  • product_name – string
  • smart_proxy_id – integer
  • smart_proxy_name – string
  • subpath – string
  • upstream_username – string

3.4.6. alternate-content-source refresh

Refresh an alternate content source. Refreshing, like repository syncing, is required before using an alternate content source.

Usage

# hammer alternate-content-source refresh [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Alternate content source ID
  • --name VALUE – Name to search by
  • -h, --help – Print help

3.4.7. alternate-content-source update

Update an alternate content source.

Usage

# hammer alternate-content-source update [OPTIONS]

Options

  • --base-url VALUE – Base URL for finding alternate content
  • --description VALUE – Description for the alternate content source
  • --id NUMBER – Alternate content source ID
  • --name VALUE – Name of the alternate content source
  • --new-name VALUE – Name of the alternate content source
  • --product-ids LIST – IDs of products to copy repository information from into a Simplified Alternate Content Source. Products must include at least one repository of the chosen content type.
  • --products LIST
  • --smart-proxies LIST
  • --smart-proxy-ids LIST – Ids of capsules to associate
  • --smart-proxy-names LIST – Names of capsules to associate
  • --ssl-ca-cert-id NUMBER – Identifier of the content credential containing the SSL CA Cert
  • --ssl-client-cert-id NUMBER – Identifier of the content credential containing the SSL Client Cert
  • --ssl-client-key-id NUMBER – Identifier of the content credential containing the SSL Client Key
  • --subpaths LIST – Path suffixes for finding alternate content
  • --upstream-password VALUE – Basic authentication password
  • --upstream-username VALUE – Basic authentication username
  • --use-http-proxies BOOLEAN – If the capsules` assigned HTTP Proxies should be used
  • --verify-ssl BOOLEAN – If SSL should be verified for the upstream URL
  • -h, --help – Print help

3.5. ansible

Manage foreman ansible

Usage

# hammer ansible [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.5.1. ansible inventory

Ansible Inventory

Usage

# hammer ansible inventory [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.5.1.1. ansible inventory hostgroups

Show Ansible inventory for hostgroups

Usage

# hammer ansible inventory hostgroups [OPTIONS]

Options

  • --as-json – Full response as json
  • --hostgroup-ids LIST – IDs of hostgroups included in inventory
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.5.1.2. ansible inventory hosts

Show Ansible inventory for hosts

Usage

# hammer ansible inventory hosts [OPTIONS]

Options

  • --as-json – Full response as json
  • --host-ids LIST – IDs of hosts included in inventory
  • --hosts LIST
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.5.1.3. ansible inventory schedule

Schedule generating of Ansible Inventory report

Usage

# hammer ansible inventory schedule [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --report-format ENUM – Report format, defaults to json Possible value(s): csv, json, yaml, html
  • -h, --help – Print help

3.5.2. ansible roles

Manage ansible roles

Usage

# hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.5.2.1. ansible roles delete

Deletes Ansible role

Usage

# hammer ansible roles <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.5.2.2. ansible roles fetch

Fetch Ansible roles available to be synced

Usage

# hammer ansible roles fetch [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --proxy-id VALUE – Capsule to fetch from
  • -h, --help – Print help
3.5.2.3. ansible roles import

DEPRECATED: Import Ansible roles

Usage

# hammer ansible roles import [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --proxy-id VALUE – Capsule to import from
  • --role-names LIST – Ansible role names to be imported
  • -h, --help – Print help
3.5.2.4. ansible roles info

Show role

Usage

# hammer ansible roles <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.8. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Imported at

x

x

 
3.5.2.5. ansible roles list

List Ansible roles

Usage

# hammer ansible roles <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.9. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Imported at

x

x

 

Search / Order fields

  • host – string
  • host_id – integer
  • hostgroup – string
  • hostgroup_id – integer
  • id – integer
  • name – string
  • updated_at – datetime
3.5.2.6. ansible roles obsolete

DEPRECATED: Obsolete Ansible roles

Usage

# hammer ansible roles obsolete [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --proxy-id VALUE – Capsule to import from
  • -h, --help – Print help
3.5.2.7. ansible roles play-hostgroups

Runs all Ansible roles on hostgroups

Usage

# hammer ansible roles play-hostgroups [OPTIONS]

Options

  • --hostgroup-ids LIST – IDs of hostgroups to play roles on
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.5.2.8. ansible roles play-hosts

Runs all Ansible roles on hosts

Usage

# hammer ansible roles play-hosts [OPTIONS]

Options

  • --host-ids LIST – IDs of hosts to play roles on
  • --hosts LIST
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.5.2.9. ansible roles sync

Sync Ansible roles

Usage

# hammer ansible roles sync [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --proxy-id VALUE – Capsule to sync from
  • --role-names LIST – Ansible role names to be synced
  • -h, --help – Print help

3.5.3. ansible variables

Manage ansible variables

Usage

# hammer ansible variables [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.5.3.1. ansible variables add-matcher

Create an override value for a specific ansible variable

Usage

# hammer ansible variables add-matcher [OPTIONS]

Options

  • --ansible-variable VALUE – Name to search by
  • --ansible-variable-id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --match VALUE – Override match
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --value VALUE – Override value, required if omit is false
  • -h, --help – Print help
3.5.3.2. ansible variables create

Create Ansible variable

Usage

# hammer ansible variables create [OPTIONS]

Options

  • --ansible-role VALUE – Name to search by
  • --ansible-role-id NUMBER – Role ID
  • --avoid-duplicates BOOLEAN – Remove duplicate values (only array type)
  • --default-value VALUE – Default value of variable
  • --description VALUE – Description of variable
  • --hidden-value BOOLEAN – When enabled the parameter is hidden in the UI
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --merge-default BOOLEAN – Include default value when merging all matching values
  • --merge-overrides BOOLEAN – Merge all matching values (only array/hash type)
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --override BOOLEAN – Whether to override variable or not
  • --override-value-order VALUE The order in which values are resolved
  • --validator-rule VALUE – Used to enforce certain values for the parameter values
  • --validator-type ENUM – Types of validation values Possible value(s): regexp, list
  • --variable VALUE – Name of variable
  • --variable-type ENUM – Types of variable values Possible value(s): string, boolean, integer, real, array, hash, yaml, json
  • -h, --help – Print help
3.5.3.3. ansible variables delete

Deletes Ansible variable

Usage

# hammer ansible variables <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.5.3.4. ansible variables import

DEPRECATED: Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles

Usage

# hammer ansible variables import [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --proxy-id VALUE – Capsule to import from
  • -h, --help – Print help
3.5.3.5. ansible variables info

Show variable

Usage

# hammer ansible variables <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.10. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Variable

x

x

Default value

x

x

Type

x

x

Role

x

x

Role id

x

x

Description

x

x

Hidden value?

x

x

Validator/type

x

x

Validator/rule

x

x

Override values/override

x

x

Override values/merge overrides

x

x

Override values/merge default value

x

x

Override values/avoid duplicates

x

x

Override values/order

x

x

Override values/values/id

x

x

Override values/values/match

x

x

Override values/values/value

x

x

Created at

x

x

Updated at

x

x

3.5.3.6. ansible variables list

List Ansible variables

Usage

# hammer ansible variables <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.11. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Variable

x

x

Default value

x

x

Type

x

x

Role

x

x

Role id

x

x

Search / Order fields

  • ansible_role – string
  • avoid_duplicates – Values: true, false
  • imported – Values: true, false
  • key – string
  • merge_default – Values: true, false
  • merge_overrides – Values: true, false
  • name – string
  • override – Values: true, false
  • parameter – string
3.5.3.7. ansible variables obsolete

DEPRECATED: Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles

Usage

# hammer ansible variables obsolete [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --proxy-id VALUE – Capsule to import from
  • -h, --help – Print help
3.5.3.8. ansible variables remove-matcher

Destroy an override value

Usage

# hammer ansible variables remove-matcher [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.5.3.9. ansible variables update

Updates Ansible variable

Usage

# hammer ansible variables update [OPTIONS]

Options

  • --ansible-role VALUE – Name to search by
  • --ansible-role-id NUMBER – Role ID
  • --avoid-duplicates BOOLEAN – Remove duplicate values (only array type)
  • --default-value VALUE – Default value of variable
  • --description VALUE – Description of variable
  • --hidden-value BOOLEAN – When enabled the parameter is hidden in the UI
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --merge-default BOOLEAN – Include default value when merging all matching values
  • --merge-overrides BOOLEAN – Merge all matching values (only array/hash type)
  • --name VALUE – Name to search by
  • --new-name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --override BOOLEAN – Whether to override variable or not
  • --override-value-order LIST – The order in which values are resolved
  • --validator-rule VALUE – Used to enforce certain values for the parameter values
  • --validator-type ENUM – Types of validation values Possible value(s): regexp, list
  • --variable VALUE – Name of variable
  • --variable-type ENUM – Types of variable values Possible value(s): string, boolean, integer, real, array, hash, yaml, json
  • -h, --help – Print help

3.6. architecture

Manipulate architectures

Usage

# hammer architecture [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.6.1. architecture add-operatingsystem

Associate an operating system

Usage

# hammer architecture add-operatingsystem [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Architecture name
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER
  • -h, --help – Print help

3.6.2. architecture create

Create an architecture

Usage

# hammer architecture create [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --operatingsystem-ids LIST – Operating system IDs
  • --operatingsystems LIST
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.6.3. architecture delete

Delete an architecture

Usage

# hammer architecture <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Architecture name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.6.4. architecture info

Show an architecture

Usage

# hammer architecture <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Architecture name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.12. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Operating systems/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

3.6.5. architecture list

List all architectures

Usage

# hammer architecture <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – ID of operating system
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.13. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • id – integer
  • name – string

3.6.6. architecture remove-operatingsystem

Disassociate an operating system

Usage

# hammer architecture remove-operatingsystem [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Architecture name
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER
  • -h, --help – Print help

3.6.7. architecture update

Update an architecture

Usage

# hammer architecture update [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --new-name VALUE
  • --operatingsystem-ids LIST – Operating system IDs
  • --operatingsystems LIST
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.7. arf-report

Manipulate compliance reports

Usage

# hammer arf-report [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.7.1. arf-report delete

Delete an ARF Report

Usage

# hammer arf-report <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • -h, --help – Print help

3.7.2. arf-report download

Download bzipped ARF report

Usage

# hammer arf-report download [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --path VALUE – Path to directory where downloaded file will be saved
  • -h, --help – Print help

3.7.3. arf-report download-html

Download ARF report in HTML

Usage

# hammer arf-report download-html [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --path VALUE – Path to directory where downloaded file will be saved
  • -h, --help – Print help

3.7.4. arf-report info

Show an ARF report

Usage

# hammer arf-report <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • -h, --help – Print help
Table 3.14. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Reported at

x

x

 

Host name

x

x

x

Openscap proxy name

x

x

 

Policy name

x

x

 

Passed

x

x

 

Failed

x

x

 

Othered

x

x

 

Host id

x

x

 

Openscap proxy id

x

x

 

Policy id

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

3.7.5. arf-report list

List ARF reports

Usage

# hammer arf-report <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.15. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Reported at

x

x

 

Host name

x

x

x

Openscap proxy name

x

x

 

Policy name

x

x

 

Passed

x

x

 

Failed

x

x

 

Othered

x

x

 

Search / Order fields

  • compliance_policy – string
  • compliance_status – Values: compliant, incompliant, inconclusive
  • comply_with – string
  • eventful – Values: true, false
  • host – string
  • host_collection – string
  • host_id – integer
  • host_owner_id – integer
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_title – string
  • id – integer
  • inconclusive_with – string
  • last_for – Values: host, policy
  • last_report – datetime
  • lifecycle_environment
  • location – string
  • location_id – integer
  • log – text
  • not_comply_with – string
  • openscap_proxy – string
  • organization – string
  • organization_id – integer
  • origin – string
  • policy – string
  • reported – datetime
  • resource – text
  • xccdf_rule_failed – string
  • xccdf_rule_name – text
  • xccdf_rule_othered – string
  • xccdf_rule_passed – string

3.8. audit

Search audit trails.

Usage

# hammer audit [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.8.1. audit info

Show an audit

Usage

# hammer audit <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.16. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

At

x

x

 

Ip

x

x

 

User

x

x

 

Action

x

x

 

Audit type

x

x

 

Audit record

x

x

 

Request uuid

x

x

 

Audited changes/attribute

x

x

 

Audited changes/value

x

x

 

Audited changes/old

x

x

 

Audited changes/new

x

x

 

3.8.2. audit list

List all audits

Usage

# hammer audit <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.17. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

At

x

x

 

Ip

x

x

 

User

x

x

 

Action

x

x

 

Audit type

x

x

 

Audit record

x

x

 

Request uuid

x

  

Search / Order fields

  • location – string
  • location_id – integer
  • organization – string
  • organization_id – integer

3.9. auth

Foreman connection login/logout

Usage

# hammer auth [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.9.1. auth login

Set credentials

Usage

# hammer auth login [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.9.1.1. auth login basic

provide username and password

Usage

# hammer auth login basic [OPTIONS]

Options

  • -h, --help – Print help
  • -p, --password VALUE – Password to access the remote system
  • -u, --username VALUE – Username to access the remote system
3.9.1.2. auth login basic-external

Authenticate against external source (IPA/PAM) with credentials

Usage

# hammer auth login basic-external [OPTIONS]

Options

  • -h, --help – Print help
  • -p, --password VALUE – Password to access the remote system
  • -u, --username VALUE – Username to access the remote system
3.9.1.3. auth login negotiate

negotiate the login credentials from the auth ticket (Kerberos)

Usage

# hammer auth login negotiate [OPTIONS]

Options

  • -h, --help – Print help
3.9.1.4. auth login oauth

supports for both with/without 2fa

Usage

# hammer auth login oauth [OPTIONS]

Options

  • -a, --oidc-authorization-endpoint VALUE Openidc provider URL which issues authentication code (two factor only)
  • -c, --oidc-client-id VALUE – Client id used in the Openidc provider
  • -f, --two-factor – Authenticate with two factor
  • -h, --help – Print help
  • -p, --password VALUE – Password to access the remote system
  • -r, --oidc-redirect-uri VALUE – Redirect URI for the authentication code grant flow
  • -t, --oidc-token-endpoint VALUE – Openidc provider URL which issues access token
  • -u, --username VALUE – Username to access the remote system

3.9.2. auth logout

Wipe your credentials

Usage

# hammer auth logout [OPTIONS]

Options

  • -h, --help – Print help

3.9.3. auth status

Information about current connections

Usage

# hammer auth status [OPTIONS]

Options

  • -h, --help – Print help

3.10. auth-source

Manipulate auth sources

Usage

# hammer auth-source [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.10.1. auth-source external

Manage external auth sources

Usage

# hammer auth-source external [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.10.1.1. auth-source external info

Show an external authentication source

Usage

# hammer auth-source external <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.18. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Locations/

x

x

 

Organizations/

x

x

 
3.10.1.2. auth-source external list

List external authentication sources

Usage

# hammer auth-source external <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Scope by locations
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Scope by organizations
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.19. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
3.10.1.3. auth-source external update

Update organization and location for Auth Source

Usage

# hammer auth-source external update [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE
  • --new-name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • -h, --help – Print help

3.10.2. auth-source ldap

Manage LDAP auth sources

Usage

# hammer auth-source ldap [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.10.2.1. auth-source ldap create

Create an LDAP authentication source

Usage

# hammer auth-source ldap create [OPTIONS]

Options

  • --account VALUE
  • --account-password VALUE – Required if onthefly_register is true
  • --attr-firstname VALUE – Required if onthefly_register is true
  • --attr-lastname VALUE – Required if onthefly_register is true
  • --attr-login VALUE – Required if onthefly_register is true
  • --attr-mail VALUE – Required if onthefly_register is true
  • --attr-photo VALUE
  • --base-dn VALUE
  • --groups-base VALUE – Groups base DN
  • --host VALUE – The hostname of the LDAP server
  • --ldap-filter VALUE – LDAP filter
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE
  • --onthefly-register BOOLEAN
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --port NUMBER – Defaults to 389
  • --server-type ENUM – Type of the LDAP server Possible value(s): free_ipa, active_directory, posix
  • --tls BOOLEAN
  • --use-netgroups BOOLEAN – Use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa
  • --usergroup-sync BOOLEAN – Sync external user groups on login
  • -h, --help – Print help
3.10.2.2. auth-source ldap delete

Delete an LDAP authentication source

Usage

# hammer auth-source ldap <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.10.2.3. auth-source ldap info

Show an LDAP authentication source

Usage

# hammer auth-source ldap <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.20. Predefined field sets
FIELDSALLDEFAULT

Server/id

x

x

Server/name

x

x

Server/server

x

x

Server/ldaps

x

x

Server/port

x

x

Server/server type

x

x

Account/account username

x

x

Account/base dn

x

x

Account/groups base dn

x

x

Account/use netgroups

x

x

Account/ldap filter

x

x

Account/automatically create accounts?

x

x

Account/usergroup sync

x

x

Attribute mappings/login name attribute

x

x

Attribute mappings/first name attribute

x

x

Attribute mappings/last name attribute

x

x

Attribute mappings/email address attribute

x

x

Attribute mappings/photo attribute

x

x

Locations/

x

x

Organizations/

x

x

3.10.2.4. auth-source ldap list

List all LDAP authentication sources

Usage

# hammer auth-source ldap <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Scope by locations
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Scope by organizations
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.21. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Server

x

x

 

Port

x

x

 

Ldaps?

x

x

 

Search / Order fields

  • id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
3.10.2.5. auth-source ldap update

Update an LDAP authentication source

Usage

# hammer auth-source ldap update [OPTIONS]

Options

  • --account VALUE
  • --account-password VALUE – Required if onthefly_register is true
  • --attr-firstname VALUE – Required if onthefly_register is true
  • --attr-lastname VALUE – Required if onthefly_register is true
  • --attr-login VALUE – Required if onthefly_register is true
  • --attr-mail VALUE – Required if onthefly_register is true
  • --attr-photo VALUE
  • --base-dn VALUE
  • --groups-base VALUE – Groups base DN
  • --host VALUE – The hostname of the LDAP server
  • --id VALUE
  • --ldap-filter VALUE – LDAP filter
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE
  • --new-name VALUE
  • --onthefly-register BOOLEAN
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --port NUMBER – Defaults to 389
  • --server-type ENUM – Type of the LDAP server Possible value(s): free_ipa, active_directory, posix
  • --tls BOOLEAN
  • --use-netgroups BOOLEAN – Use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa
  • --usergroup-sync BOOLEAN – Sync external user groups on login
  • -h, --help – Print help

3.10.3. auth-source list

List all auth sources

Usage

# hammer auth-source <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Scope by locations
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Scope by organizations
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.22. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Type of auth source

x

x

 

Search / Order fields

  • id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer

3.11. bookmark

Manage bookmarks

Usage

# hammer bookmark [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.11.1. bookmark create

Create a bookmark

Usage

# hammer bookmark create [OPTIONS]

Options

  • --controller VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --public BOOLEAN
  • --query VALUE
  • -h, --help – Print help

3.11.2. bookmark delete

Delete a bookmark

Usage

# hammer bookmark <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.11.3. bookmark info

Show a bookmark

Usage

# hammer bookmark <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.23. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Controller

x

x

 

Search query

x

x

 

Public

x

x

 

Owner id

x

x

 

Owner type

x

x

 

3.11.4. bookmark list

List all bookmarks

Usage

# hammer bookmark <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.24. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Controller

x

x

 

Search query

x

x

 

Public

x

x

 

Owner id

x

x

 

Owner type

x

x

 

Search / Order fields

  • controller – string
  • id – integer
  • name – string

3.11.5. bookmark update

Update a bookmark

Usage

# hammer bookmark update [OPTIONS]

Options

  • --controller VALUE
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --new-name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --public BOOLEAN
  • --query VALUE
  • -h, --help – Print help

3.12. bootdisk

Download boot disks

Usage

# hammer bootdisk [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.12.1. bootdisk generic

Download generic image

Usage

# hammer bootdisk generic [OPTIONS]

Options

  • --file VALUE – File or device to write image to
  • --force – Force writing to existing destination (device etc.)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --sudo – Use sudo to write to device
  • -h, --help – Print help

3.12.2. bootdisk host

Download host image

Usage

# hammer bootdisk host [OPTIONS]

Options

  • --file VALUE – File or device to write image to
  • --force – Force writing to existing destination (device etc.)
  • --full BOOLEAN – True for full, false for basic reusable image
  • --host VALUE – Host name
  • --host-id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --sudo – Use sudo to write to device
  • -h, --help – Print help

3.12.3. bootdisk subnet

Download subnet generic image

Usage

# hammer bootdisk subnet [OPTIONS]

Options

  • --file VALUE – File or device to write image to
  • --force – Force writing to existing destination (device etc.)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --subnet VALUE – Subnet name
  • --subnet-id VALUE
  • --sudo – Use sudo to write to device
  • -h, --help – Print help

3.13. capsule

Manipulate capsule

Usage

# hammer capsule [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.13.1. capsule content

Manage the capsule content

Usage

# hammer capsule content [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.13.1.1. capsule content add-lifecycle-environment

Add lifecycle environments to the capsule

Usage

# hammer capsule content add-lifecycle-environment [OPTIONS]

Options

  • --environment VALUE – Lifecycle environment name to search by (--environment is deprecated: Use
  • --lifecycle-environment instead)
  • --environment-id NUMBER – (--environment-id is deprecated: Use --lifecycle-environment-id instead)
  • --id NUMBER – Id of the capsule
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Id of the lifecycle environment
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name
  • --organization-id VALUE – Organization ID
  • -h, --help – Print help
3.13.1.2. capsule content available-lifecycle-environments

List the lifecycle environments not attached to the capsule

Usage

# hammer capsule content available-lifecycle-environments [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Id of the capsule
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Id of the organization to limit environments on
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help
Table 3.25. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Organization

x

x

 
3.13.1.3. capsule content cancel-synchronization

Cancel running capsule synchronization

Usage

# hammer capsule content cancel-synchronization [OPTIONS]

Options

  • --id NUMBER – Id of the capsule
  • --name VALUE – Name to search by
  • -h, --help – Print help
3.13.1.4. capsule content info

Get current capsule synchronization status

Usage

# hammer capsule content info [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Id of the capsule
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Id of the organization to get the status for
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help
Table 3.26. Predefined field sets
FIELDSALLDEFAULT

Lifecycle environments/name

x

x

Lifecycle environments/organization

x

x

Lifecycle environments/content views/name

x

x

Lifecycle environments/content views/composite

x

x

Lifecycle environments/content views/last published

x

x

Lifecycle environments/content views/repositories/repository id

x

x

Lifecycle environments/content views/repositories/repository name

x

x

Lifecycle environments/content views/repositories/content counts/warning

x

x

Lifecycle environments/content views/repositories/content counts/packages

x

x

Lifecycle environments/content views/repositories/content counts/srpms

x

x

Lifecycle environments/content views/repositories/content counts/module streams

x

x

Lifecycle environments/content views/repositories/content counts/package groups

x

x

Lifecycle environments/content views/repositories/content counts/errata

x

x

Lifecycle environments/content views/repositories/content counts/debian packages

x

x

Lifecycle environments/content views/repositories/content counts/container tags

x

x

Lifecycle environments/content views/repositories/content counts/container ma…​

x

x

Lifecycle environments/content views/repositories/content counts/container ma…​

x

x

Lifecycle environments/content views/repositories/content counts/files

x

x

Lifecycle environments/content views/repositories/content counts/ansible coll…​

x

x

Lifecycle environments/content views/repositories/content counts/ostree refs

x

x

Lifecycle environments/content views/repositories/content counts/python packages

x

x

3.13.1.5. capsule content lifecycle-environments

List the lifecycle environments attached to the capsule

Usage

# hammer capsule content lifecycle-environments [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Id of the capsule
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Id of the organization to limit environments on
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help
Table 3.27. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Organization

x

x

 
3.13.1.6. capsule content reclaim-space

Reclaim space from all On Demand repositories on a capsule

Usage

# hammer capsule content reclaim-space [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Id of the capsule
  • --name VALUE – Name to search by
  • -h, --help – Print help
3.13.1.7. capsule content remove-lifecycle-environment

Remove lifecycle environments from the capsule

Usage

# hammer capsule content remove-lifecycle-environment [OPTIONS]

Options

  • --environment VALUE – Lifecycle environment name to search by (--environment is deprecated: Use
  • --lifecycle-environment instead)
  • --environment-id NUMBER – (--environment-id is deprecated: Use --lifecycle-environment-id instead)
  • --id NUMBER – Id of the capsule
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Id of the lifecycle environment
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name
  • --organization-id VALUE – Organization ID
  • -h, --help – Print help
3.13.1.8. capsule content synchronization-status

Get current capsule synchronization status

Usage

# hammer capsule content synchronization-status [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Id of the capsule
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Id of the organization to get the status for
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help
Table 3.28. Predefined field sets
FIELDSALLDEFAULT

Last sync

x

x

Status

x

x

Currently running sync tasks/task id

x

x

Currently running sync tasks/progress

x

x

Last failure/task id

x

x

Last failure/messages

x

x

3.13.1.9. capsule content synchronize

Synchronize the content to the capsule

Usage

# hammer capsule content synchronize [OPTIONS]

Options

  • --async – Do not wait for the task
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Id of the content view to limit the synchronization on
  • --environment VALUE – Lifecycle environment name to search by (--environment is deprecated: Use
  • --lifecycle-environment instead)
  • --environment-id NUMBER – (--environment-id is deprecated: Use --lifecycle-environment-id instead)
  • --id NUMBER – Id of the capsule
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Id of the environment to limit the synchronization on
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name
  • --organization-id VALUE – Organization ID
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Id of the repository to limit the synchronization on
  • --skip-metadata-check BOOLEAN – Skip metadata check on each repository on the capsule
  • -h, --help – Print help
3.13.1.10. capsule content update-counts

Update content counts for the capsule

Usage

# hammer capsule content update-counts [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Id of the capsule
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name
  • --organization-id VALUE – Organization ID
  • -h, --help – Print help

3.13.2. capsule create

Create a capsule

Usage

# hammer capsule create [OPTIONS]

Options

  • --download-policy VALUE – Download Policy of the capsule, must be one of on_demand, immediate, inherit, streamed
  • --http-proxy VALUE – Name to search by
  • --http-proxy-id NUMBER – Id of the HTTP Proxy to use with alternate content sources
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --url VALUE
  • -h, --help – Print help

3.13.3. capsule delete

Delete a capsule

Usage

# hammer capsule <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.13.4. capsule import-subnets

Import subnets from Capsule

Usage

# hammer capsule import-subnets [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.13.5. capsule info

Show a capsule

Usage

# hammer capsule <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --include-status BOOLEAN – Flag to indicate whether to include status or not
  • --include-version BOOLEAN – Flag to indicate whether to include version or not
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.29. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Status

x

x

 

Url

x

x

 

Features

x

x

 

Version

x

x

 

Host count

x

x

 

Features/name

x

x

 

Features/version

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

3.13.6. capsule list

List all capsules

Usage

# hammer capsule <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --include-status BOOLEAN – Flag to indicate whether to include status or not
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Scope by locations
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Scope by organizations
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.30. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Status

x

x

 

Url

x

x

 

Features

x

x

 

Search / Order fields

  • feature – string
  • id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
  • url – string

3.13.7. capsule refresh-features

Refresh capsule features

Usage

# hammer capsule refresh-features [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.13.8. capsule update

Update a capsule

Usage

# hammer capsule update [OPTIONS]

Options

  • --download-policy VALUE – Download Policy of the capsule, must be one of on_demand, immediate, inherit, streamed
  • --http-proxy VALUE – Name to search by
  • --http-proxy-id NUMBER – Id of the HTTP Proxy to use with alternate content sources
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE
  • --new-name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --url VALUE
  • -h, --help – Print help

3.14. compute-profile

Manipulate compute profiles

Usage

# hammer compute-profile [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.14.1. compute-profile create

Create a compute profile

Usage

# hammer compute-profile create [OPTIONS]

Options

  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.14.2. compute-profile delete

Delete a compute profile

Usage

# hammer compute-profile <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute profile name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.14.3. compute-profile info

Show a compute profile

Usage

# hammer compute-profile <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute profile name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.31. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

Compute attributes/id

x

x

 

Compute attributes/name

x

x

 

Compute attributes/compute resource

x

x

 

Compute attributes/vm attributes

x

x

 

3.14.4. compute-profile list

List of compute profiles

Usage

# hammer compute-profile <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.32. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • id – integer
  • name – string

3.14.5. compute-profile update

Update a compute profile

Usage

# hammer compute-profile update [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --new-name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.14.6. compute-profile values

Create update and delete Compute profile values

Usage

# hammer compute-profile values [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.14.6.1. compute-profile values add-interface

Add interface for Compute Profile

Usage

# hammer compute-profile values add-interface [OPTIONS]

Options

  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --interface KEY_VALUE_LIST – Interface parameters, should be comma separated list of values
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

Provider specific options

Bold attributes are required.

EC2:

  • --interface:

Libvirt:

  • --interface:

    • compute_type – Possible values: bridge, network
    • compute_bridge – Name of interface according to type
    • compute_model – Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
    • compute_network – Libvirt instance network, e.g. default

OpenStack:

  • --interface:

Red Hat Virtualization:

  • --interface:

    • compute_name – Compute name, e.g. eth0
    • compute_network – Select one of available networks for a cluster, must be an ID or a name
    • compute_interface – Interface type
    • compute_vnic_profile – Vnic Profile

Rackspace:

  • --interface:

VMware:

  • --interface:

    • compute_type – Type of the network adapter, for example one of: VirtualVmxnet3, VirtualE1000, See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/
    • compute_network – Network ID or Network Name from VMware

AzureRM:

  • --interface:

    • compute_network – Select one of available Azure Subnets, must be an ID
    • compute_public_ip – Public IP (None, Static, Dynamic)
    • compute_private_ip – Static Private IP (expressed as true or false)

GCE:

  • --interface:
3.14.6.2. compute-profile values add-volume

Add volume for Compute Profile

Usage

# hammer compute-profile values add-volume [OPTIONS]

Options

  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --volume KEY_VALUE_LIST – Volume parameters, should be comma separated list of values
  • -h, --help – Print help

Provider specific options

Bold attributes are required.

EC2:

  • --volume:

Libvirt:

  • --volume:

    • pool_name – One of available storage pools
    • capacity – String value, e.g. 10G
    • allocation – Initial allocation, e.g. 0G
    • format_type – Possible values: raw, qcow2

OpenStack:

  • --volume:

Red Hat Virtualization:

  • --volume:

    • size_gb – Volume size in GB, integer value
    • storage_domain – ID or name of storage domain
    • bootable – Boolean, set 1 for bootable, only one volume can be bootable
    • preallocate – Boolean, set 1 to preallocate
    • wipe_after_delete – Boolean, set 1 to wipe disk after delete
    • interface – Disk interface name, must be ide, virtio or virtio_scsi

Rackspace:

  • --volume:

VMware:

  • --volume:

    • name
    • storage_pod – Storage Pod ID from VMware
    • datastore – Datastore ID from VMware
    • mode – persistent/independent_persistent/independent_nonpersistent
    • size_gb – Integer number, volume size in GB
    • thin – true/false
    • eager_zero – true/false
    • controller_key – Associated SCSI controller key

AzureRM:

  • --volume:

    • disk_size_gb – Volume Size in GB (integer value)
    • data_disk_caching – Data Disk Caching (None, ReadOnly, ReadWrite)

GCE:

  • --volume:

    • size_gb – Volume size in GB, integer value
3.14.6.3. compute-profile values create

Create compute profile set of values

Usage

# hammer compute-profile values create [OPTIONS]

Options

  • --compute-attributes KEY_VALUE_LIST Compute resource attributes
  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --interface KEY_VALUE_LIST – Interface parameters, should be comma separated list of values Can be specified multiple times.
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --volume KEY_VALUE_LIST – Volume parameters, should be comma separated list of values Can be specified multiple times.
  • -h, --help – Print help

Provider specific options

Bold attributes are required.

EC2:

  • --volume:
  • --interface:
  • --compute-attributes:

    • availability_zone
    • flavor_id
    • groups
    • security_group_ids
    • managed_ip

Libvirt:

  • --volume:

    • pool_name – One of available storage pools
    • capacity – String value, e.g. 10G
    • allocation – Initial allocation, e.g. 0G
    • format_type – Possible values: raw, qcow2
  • --interface:

    • compute_type – Possible values: bridge, network
    • compute_bridge – Name of interface according to type
    • compute_model – Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
    • compute_network – Libvirt instance network, e.g. default
  • --compute-attributes:

    • cpus – Number of CPUs
    • memory – String, amount of memory, value in bytes
    • cpu_mode – Possible values: default, host-model, host-passthrough
    • boot_order – Device names to specify the boot order

OpenStack:

  • --volume:
  • --interface:
  • --compute-attributes:

    • availability_zone
    • boot_from_volume
    • flavor_ref
    • image_ref
    • tenant_id
    • security_groups
    • network

Red Hat Virtualization:

  • --volume:

    • size_gb – Volume size in GB, integer value
    • storage_domain – ID or name of storage domain
    • bootable – Boolean, set 1 for bootable, only one volume can be bootable
    • preallocate – Boolean, set 1 to preallocate
    • wipe_after_delete – Boolean, set 1 to wipe disk after delete
    • interface – Disk interface name, must be ide, virtio or virtio_scsi
  • --interface:

    • compute_name – Compute name, e.g. eth0
    • compute_network – Select one of available networks for a cluster, must be an ID or a name
    • compute_interface – Interface type
    • compute_vnic_profile – Vnic Profile
  • --compute-attributes:

    • cluster – ID or name of cluster to use
    • template – Hardware profile to use
    • cores – Integer value, number of cores
    • sockets – Integer value, number of sockets
    • memory – Amount of memory, integer value in bytes
    • ha – Boolean, set 1 to high availability
    • display_type – Possible values: VNC, SPICE
    • keyboard_layout – Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.

Rackspace:

  • --volume:
  • --interface:
  • --compute-attributes:

    • flavor_id

VMware:

  • --volume:

    • name
    • storage_pod – Storage Pod ID from VMware
    • datastore – Datastore ID from VMware
    • mode – persistent/independent_persistent/independent_nonpersistent
    • size_gb – Integer number, volume size in GB
    • thin – true/false
    • eager_zero – true/false
    • controller_key – Associated SCSI controller key
  • --interface:

    • compute_type – Type of the network adapter, for example one of: VirtualVmxnet3, VirtualE1000, See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/
    • compute_network – Network ID or Network Name from VMware
  • --compute-attributes:

    • cluster – Cluster ID from VMware
    • corespersocket – Number of cores per socket (applicable to hardware versions < 10 only)
    • cpus – CPU count
    • memory_mb – Integer number, amount of memory in MB
    • path – Path to folder
    • resource_pool – Resource Pool ID from VMware
    • firmware – automatic/bios/efi
    • guest_id – Guest OS ID form VMware
    • hardware_version – Hardware version ID from VMware
    • memoryHotAddEnabled – Must be a 1 or 0, lets you add memory resources while the machine is on
    • cpuHotAddEnabled – Must be a 1 or 0, lets you add CPU resources while the machine is on
    • add_cdrom – Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
    • annotation – Annotation Notes
    • scsi_controllers – List with SCSI controllers definitions

      • type – ID of the controller from VMware
      • key – Key of the controller (e.g. 1000)
    • boot_order – Device names to specify the boot order

AzureRM:

  • --volume:

    • disk_size_gb – Volume Size in GB (integer value)
    • data_disk_caching – Data Disk Caching (None, ReadOnly, ReadWrite)
  • --interface:

    • compute_network – Select one of available Azure Subnets, must be an ID
    • compute_public_ip – Public IP (None, Static, Dynamic)
    • compute_private_ip – Static Private IP (expressed as true or false)
  • --compute-attributes:

    • resource_group – Existing Azure Resource Group of user
    • vm_size – VM Size, eg. Standard_A0 etc.
    • username – The Admin username
    • password – The Admin password
    • platform – OS type eg. Linux
    • ssh_key_data – SSH key for passwordless authentication
    • os_disk_caching – OS disk caching
    • premium_os_disk – Premium OS Disk, Boolean as 0 or 1
    • script_command – Custom Script Command
    • script_uris – Comma seperated file URIs

GCE:

  • --volume:

    • size_gb – Volume size in GB, integer value
  • --interface:
  • --compute-attributes:

    • machine_type
    • network
    • associate_external_ip
3.14.6.4. compute-profile values remove-interface

Remove compute profile interface

Usage

# hammer compute-profile values remove-interface [OPTIONS]

Options

  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --interface-id NUMBER – Interface id
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.14.6.5. compute-profile values remove-volume

Remove compute profile volume

Usage

# hammer compute-profile values remove-volume [OPTIONS]

Options

  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --volume-id NUMBER – Volume id
  • -h, --help – Print help
3.14.6.6. compute-profile values update

Update compute profile values

Usage

# hammer compute-profile values update [OPTIONS]

Options

  • --compute-attributes KEY_VALUE_LIST Compute resource attributes, should be comma separated list of values
  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --interface KEY_VALUE_LIST – Interface parameters, should be comma separated list of values Can be specified multiple times.
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --volume KEY_VALUE_LIST – Volume parameters, should be comma separated list of values Can be specified multiple times.
  • -h, --help – Print help

Provider specific options

Bold attributes are required.

EC2:

  • --volume:
  • --interface:
  • --compute-attributes:

    • availability_zone
    • flavor_id
    • groups
    • security_group_ids
    • managed_ip

Libvirt:

  • --volume:

    • pool_name – One of available storage pools
    • capacity – String value, e.g. 10G
    • allocation – Initial allocation, e.g. 0G
    • format_type – Possible values: raw, qcow2
  • --interface:

    • compute_type – Possible values: bridge, network
    • compute_bridge – Name of interface according to type
    • compute_model – Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
    • compute_network – Libvirt instance network, e.g. default
  • --compute-attributes:

    • cpus – Number of CPUs
    • memory – String, amount of memory, value in bytes
    • cpu_mode – Possible values: default, host-model, host-passthrough
    • boot_order – Device names to specify the boot order

OpenStack:

  • --volume:
  • --interface:
  • --compute-attributes:

    • availability_zone
    • boot_from_volume
    • flavor_ref
    • image_ref
    • tenant_id
    • security_groups
    • network

Red Hat Virtualization:

  • --volume:

    • size_gb – Volume size in GB, integer value
    • storage_domain – ID or name of storage domain
    • bootable – Boolean, set 1 for bootable, only one volume can be bootable
    • preallocate – Boolean, set 1 to preallocate
    • wipe_after_delete – Boolean, set 1 to wipe disk after delete
    • interface – Disk interface name, must be ide, virtio or virtio_scsi
  • --interface:

    • compute_name – Compute name, e.g. eth0
    • compute_network – Select one of available networks for a cluster, must be an ID or a name
    • compute_interface – Interface type
    • compute_vnic_profile – Vnic Profile
  • --compute-attributes:

    • cluster – ID or name of cluster to use
    • template – Hardware profile to use
    • cores – Integer value, number of cores
    • sockets – Integer value, number of sockets
    • memory – Amount of memory, integer value in bytes
    • ha – Boolean, set 1 to high availability
    • display_type – Possible values: VNC, SPICE
    • keyboard_layout – Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.

Rackspace:

  • --volume:
  • --interface:
  • --compute-attributes:

    • flavor_id

VMware:

  • --volume:

    • name
    • storage_pod – Storage Pod ID from VMware
    • datastore – Datastore ID from VMware
    • mode – persistent/independent_persistent/independent_nonpersistent
    • size_gb – Integer number, volume size in GB
    • thin – true/false
    • eager_zero – true/false
    • controller_key – Associated SCSI controller key
  • --interface:

    • compute_type – Type of the network adapter, for example one of: VirtualVmxnet3, VirtualE1000, See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/
    • compute_network – Network ID or Network Name from VMware
  • --compute-attributes:

    • cluster – Cluster ID from VMware
    • corespersocket – Number of cores per socket (applicable to hardware versions < 10 only)
    • cpus – CPU count
    • memory_mb – Integer number, amount of memory in MB
    • path – Path to folder
    • resource_pool – Resource Pool ID from VMware
    • firmware – automatic/bios/efi
    • guest_id – Guest OS ID form VMware
    • hardware_version – Hardware version ID from VMware
    • memoryHotAddEnabled – Must be a 1 or 0, lets you add memory resources while the machine is on
    • cpuHotAddEnabled – Must be a 1 or 0, lets you add CPU resources while the machine is on
    • add_cdrom – Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
    • annotation – Annotation Notes
    • scsi_controllers – List with SCSI controllers definitions

      • type – ID of the controller from VMware
      • key – Key of the controller (e.g. 1000)
    • boot_order – Device names to specify the boot order

AzureRM:

  • --volume:

    • disk_size_gb – Volume Size in GB (integer value)
    • data_disk_caching – Data Disk Caching (None, ReadOnly, ReadWrite)
  • --interface:

    • compute_network – Select one of available Azure Subnets, must be an ID
    • compute_public_ip – Public IP (None, Static, Dynamic)
    • compute_private_ip – Static Private IP (expressed as true or false)
  • --compute-attributes:

    • resource_group – Existing Azure Resource Group of user
    • vm_size – VM Size, eg. Standard_A0 etc.
    • username – The Admin username
    • password – The Admin password
    • platform – OS type eg. Linux
    • ssh_key_data – SSH key for passwordless authentication
    • os_disk_caching – OS disk caching
    • premium_os_disk – Premium OS Disk, Boolean as 0 or 1
    • script_command – Custom Script Command
    • script_uris – Comma seperated file URIs

GCE:

  • --volume:

    • size_gb – Volume size in GB, integer value
  • --interface:
  • --compute-attributes:

    • machine_type
    • network
    • associate_external_ip
3.14.6.7. compute-profile values update-interface

Update compute profile interface

Usage

# hammer compute-profile values update-interface [OPTIONS]

Options

  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --interface KEY_VALUE_LIST – Interface parameters, should be comma separated list of values
  • --interface-id NUMBER – Interface id
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

Provider specific options

Bold attributes are required.

EC2:

  • --interface:

Libvirt:

  • --interface:

    • compute_type – Possible values: bridge, network
    • compute_bridge – Name of interface according to type
    • compute_model – Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
    • compute_network – Libvirt instance network, e.g. default

OpenStack:

  • --interface:

Red Hat Virtualization:

  • --interface:

    • compute_name – Compute name, e.g. eth0
    • compute_network – Select one of available networks for a cluster, must be an ID or a name
    • compute_interface – Interface type
    • compute_vnic_profile – Vnic Profile

Rackspace:

  • --interface:

VMware:

  • --interface:

    • compute_type – Type of the network adapter, for example one of: VirtualVmxnet3, VirtualE1000, See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/
    • compute_network – Network ID or Network Name from VMware

AzureRM:

  • --interface:

    • compute_network – Select one of available Azure Subnets, must be an ID
    • compute_public_ip – Public IP (None, Static, Dynamic)
    • compute_private_ip – Static Private IP (expressed as true or false)

GCE:

  • --interface:
3.14.6.8. compute-profile values update-volume

Update compute profile volume

Usage

# hammer compute-profile values update-volume [OPTIONS]

Options

  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id VALUE
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --volume KEY_VALUE_LIST – Volume parameters, should be comma separated list of values
  • --volume-id NUMBER – Volume id
  • -h, --help – Print help

Provider specific options

Bold attributes are required.

EC2:

  • --volume:

Libvirt:

  • --volume:

    • pool_name – One of available storage pools
    • capacity – String value, e.g. 10G
    • allocation – Initial allocation, e.g. 0G
    • format_type – Possible values: raw, qcow2

OpenStack:

  • --volume:

Red Hat Virtualization:

  • --volume:

    • size_gb – Volume size in GB, integer value
    • storage_domain – ID or name of storage domain
    • bootable – Boolean, set 1 for bootable, only one volume can be bootable
    • preallocate – Boolean, set 1 to preallocate
    • wipe_after_delete – Boolean, set 1 to wipe disk after delete
    • interface – Disk interface name, must be ide, virtio or virtio_scsi

Rackspace:

  • --volume:

VMware:

  • --volume:

    • name
    • storage_pod – Storage Pod ID from VMware
    • datastore – Datastore ID from VMware
    • mode – persistent/independent_persistent/independent_nonpersistent
    • size_gb – Integer number, volume size in GB
    • thin – true/false
    • eager_zero – true/false
    • controller_key – Associated SCSI controller key

AzureRM:

  • --volume:

    • disk_size_gb – Volume Size in GB (integer value)
    • data_disk_caching – Data Disk Caching (None, ReadOnly, ReadWrite)

GCE:

  • --volume:

    • size_gb – Volume size in GB, integer value

3.15. compute-resource

Manipulate compute resources

Usage

# hammer compute-resource [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

3.15.1. compute-resource associate-vms

Associate VMs to Hosts

Usage

# hammer compute-resource associate-vms [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --vm-id VALUE – Associate a specific VM
  • -h, --help – Print help

3.15.2. compute-resource clusters

List available clusters for a compute resource

Usage

# hammer compute-resource clusters [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.33. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Datacenter

x

x

 

Hosts

x

x

 

Cluster path

x

x

 

3.15.3. compute-resource create

Create a compute resource

Usage

# hammer compute-resource create [OPTIONS]

Options

  • --app-ident VALUE – Client ID for AzureRm
  • --caching-enabled BOOLEAN – Enable caching, for VMware only
  • --cloud VALUE – Cloud
  • --datacenter VALUE – For RHEV, VMware Datacenter
  • --description VALUE
  • --display-type ENUM – For Libvirt and RHEV only Possible value(s): VNC, SPICE
  • --domain VALUE – For RHEL OpenStack Platform (v3) only
  • --email VALUE – Deprecated, email is automatically loaded from the JSON file. For GCE only
  • --key-path VALUE – Certificate path, for GCE only
  • --keyboard-layout ENUM – For RHEV only Possible value(s): ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --ovirt-quota VALUE – For RHEV only, ID or Name of quota to use
  • --password VALUE – Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2
  • --project VALUE – Deprecated, project is automatically loaded from the JSON file. For GCE only
  • --project-domain-id VALUE – For RHEL OpenStack Platform (v3) only
  • --project-domain-name VALUE – For RHEL OpenStack Platform (v3) only
  • --provider VALUE – Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, AzureRm, GCE
  • --public-key VALUE – For RHEV only
  • --public-key-path FILE – Path to a file that contains oVirt public key (For oVirt only)
  • --region VALUE – For AzureRm eg. eastus and for EC2 only. Use us-gov-west-1 for EC2 GovCloud region
  • --secret-key VALUE – Client Secret for AzureRm
  • --server VALUE – For VMware
  • --set-console-password BOOLEAN For Libvirt and VMware only
  • --sub-id VALUE – Subscription ID for AzureRm
  • --tenant VALUE – For RHEL OpenStack Platform and AzureRm only
  • --url VALUE – URL for Libvirt, RHEV and RHEL OpenStack Platform
  • --user VALUE – Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for EC2.
  • --zone VALUE – Zone, for GCE only
  • -h, --help – Print help

3.15.4. compute-resource delete

Delete a compute resource

Usage

# hammer compute-resource <delete|destroy> [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help

3.15.5. compute-resource flavors

List available flavors for a compute resource

Usage

# hammer compute-resource flavors [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.34. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

3.15.6. compute-resource folders

List available folders for a compute resource

Usage

# hammer compute-resource folders [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.35. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Parent

x

x

 

Datacenter

x

x

 

Path

x

x

 

Type

x

x

 

3.15.7. compute-resource image

View and manage compute resource’s images

Usage

# hammer compute-resource image [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
3.15.7.1. compute-resource image available

Show images available for addition

Usage

# hammer compute-resource image available [OPTIONS]

Options

  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.36. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

Uuid

x

x

 
3.15.7.2. compute-resource image create

Create an image

Usage

# hammer compute-resource image create [OPTIONS]

Options

  • --architecture VALUE – Architecture name
  • --architecture-id VALUE – ID of architecture
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – ID of operating system
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --password VALUE
  • --user-data BOOLEAN – Whether or not the image supports user data
  • --username VALUE
  • --uuid VALUE – Template ID in the compute resource
  • -h, --help – Print help
3.15.7.3. compute-resource image delete

Delete an image

Usage

# hammer compute-resource image <delete|destroy> [OPTIONS]

Options

  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
3.15.7.4. compute-resource image info

Show an image

Usage

# hammer compute-resource image <info|show> [OPTIONS]

Options

  • --architecture VALUE – Architecture name
  • --architecture-id VALUE – ID of architecture
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE – ID of compute resource
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Name to search by
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – ID of operating system
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.37. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Operating system

x

x

 

Username

x

x

 

Uuid

x

x

 

User data

x

x

 

Architecture

x

x

 

Iam role

x

x

 

Created at

x

x

 

Updated at

x

x

 
3.15.7.5. compute-resource image list

List all images for a compute resource

Usage

# hammer compute-resource image <list|index> [OPTIONS]

Options

  • --architecture VALUE – Architecture name
  • --architecture-id VALUE – ID of architecture
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE – ID of compute resource
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – ID of operating system
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.38. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Operating system

x

x

 

Username

x

x

 

Uuid

x

x

 

User data

x

x

 

Search / Order fields

  • architecture – integer
  • compute_resource – string
  • id – integer
  • name – string
  • operatingsystem – integer
  • user_data – Values: true, false
  • username – string
3.15.7.6. compute-resource image update

Update an image

Usage

# hammer compute-resource image update [OPTIONS]

Options

  • --architecture VALUE – Architecture name
  • --architecture-id VALUE – ID of architecture
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id VALUE
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE
  • --new-name VALUE
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – ID of operating system
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --password VALUE
  • --user-data BOOLEAN – Whether or not the image supports user data
  • --username VALUE
  • --uuid VALUE – Template ID in the compute resource
  • -h, --help – Print help

3.15.8. compute-resource images

List available images for a compute resource

Usage

# hammer compute-resource images [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.39. Predefined field sets
FIELDSALLDEFAULTTHIN

Uuid

x

x

 

Name

x

x

x

Path

x

x

 

3.15.9. compute-resource info

Show a compute resource

Usage

# hammer compute-resource <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.40. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Provider

x

x

 

Description

x

x

 

User

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

3.15.10. compute-resource list

List all compute resources

Usage

# hammer compute-resource <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Scope by locations
  • --location-title VALUE – Set the current location context for the request
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Scope by organizations
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 3.41. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Provider

x

x

 

Search / Order fields

  • id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
  • type – string

3.15.11. compute-resource networks

List available networks for a compute resource

Usage

# hammer compute-resource networks [OPTIONS]

Options

  • --cluster-id VALUE – Cluster ID (Deprecated: Use --cluster-name instead)
  • --cluster-name VALUE – Cluster name or path to search by
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Compute resource name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 3.42. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Datacenter

x

x

 

Virtual switch

x