Search
SupportConsoleDevelopersStart a trialContact

Using the Hammer CLI tool

download PDF
Red Hat Satellite 6.16

Administer Satellite or 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 Satellite Server either through CLI commands or automation in shell scripts. Hammer also provides an interactive shell.

1.1. Hammer compared to Satellite web UI

Compared to navigating the Satellite 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 base operating system on Satellite Server is required to issue Hammer commands, which can limit the number of potential users compared to the Satellite web UI. Although the parity between Hammer and the Satellite web UI is almost complete, the Satellite web UI has development priority and can be ahead especially for newly introduced features.

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

For more information, see the Using the Satellite REST API.

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

Chapter 2. Installing standalone Hammer

You can install Hammer on a host running RHEL that has no Satellite Server installed, and use it to connect from the host to a remote Satellite.

Prerequisites

  • Ensure that you register the host to Satellite Server or Capsule Server.

  • If you are installing on Red Hat Enterprise Linux 9, ensure that the following repositories are enabled and synchronized on Satellite Server:

    • rhel-9-for-x86_64-baseos-rpms
    • rhel-9-for-x86_64-appstream-rpms
    • satellite-utils-6.16-for-rhel-9-x86_64-rpms

  • If you are installing on Red Hat Enterprise Linux 8, ensure that the following repositories are enabled and synchronized on Satellite Server:

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

Procedure

  1. Enable the required repositories on the host.

  2. If you are installing on Red Hat Enterprise Linux 8, enable the following module: 

    # dnf module enable satellite-utils:el8

  3. Install Hammer CLI: 

    # dnf install satellite-cli

  4. Set the :host: entry in the /etc/hammer/cli.modules.d/foreman.yml file to the Satellite URL: 

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

Additional resources

Chapter 3. Hammer 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.

3.1. Authenticating Hammer using a configuration file

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

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

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

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

Important

If you change your credentials on Satellite Server, you must update the configuration file manually. The installer does not overwrite the configuration file.

3.2. Authenticating Hammer using CLI options

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.

3.3. Authenticating Hammer using sessions

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

Chapter 4. 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 Chapter 3, Hammer 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.

4.1. Setting a default organization and location context

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

  1. Set a default organization: 

    # 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: Set a default location: 

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

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

Verification

  1. Review the currently specified default settings: 

    # hammer defaults list

4.2. Increasing the logging level for Hammer

You can find the log in ~/.hammer/log/hammer.log.

Procedure

  • In /etc/hammer/cli_config.yml, set the :log_level: option to debug: 
:log_level: 'debug'

Chapter 5. Using interactive Hammer shell

You can issue hammer commands through an interactive shell. To start the shell, run 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.

Chapter 6. Formatting Hammer 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.

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

Chapter 8. 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
       }
                   ]
}'

Chapter 9. Troubleshooting Satellite by using 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
database:
    Status:          ok
    Server Response: Duration: 0ms
cache:
    servers:
     1) Status:          ok
        Server Response: Duration: 1ms
candlepin:
    Status:          ok
    Server Response: Duration: 17ms
candlepin_auth:
    Status:          ok
    Server Response: Duration: 14ms
candlepin_events:
    Status:          ok
    message:         4 Processed, 0 Failed
    Server Response: Duration: 0ms
katello_events:
    Status:          ok
    message:         5 Processed, 0 Failed
    Server Response: Duration: 0ms
pulp3:
    Status:          ok
    Server Response: Duration: 5083ms
pulp3_content:
    Status:          ok
    Server Response: Duration: 5051ms
foreman_tasks:
    Status:          ok
    Server Response: Duration: 2ms

Chapter 10. Hammer cheat sheet

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

10.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 Chapter 3, Hammer authentication.

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

10.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,...

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

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

10.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,...

10.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,...

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

Start 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

10.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 11. Hammer reference

You can review the usage of Hammer statements.

This reference is up to date with the versions of Hammer components released for Satellite 6.16.

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

11.2. activation-key

Manipulate activation keys

Usage

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

Options

  • -h, --help – Print help

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

11.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>, …​ "

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

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

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

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

11.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 11.1. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

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

 

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

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

 

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

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

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

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

11.3. admin

Administrative server-side tasks

Usage

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

Options

  • -h, --help – Print help

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

11.4. alternate-content-source

Manipulate alternate content sources

Usage

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

Options

  • -h, --help – Print help

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

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

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

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

 

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

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

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

11.5. ansible

Manage foreman ansible

Usage

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

Options

  • -h, --help – Print help

11.5.1. ansible inventory

Ansible Inventory

Usage

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

Options

  • -h, --help – Print help
11.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
11.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
11.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

11.5.2. ansible roles

Manage ansible roles

Usage

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

Options

  • -h, --help – Print help
11.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
11.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
11.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
11.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 11.8. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Imported at

x

x

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

11.5.3. ansible variables

Manage ansible variables

Usage

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

Options

  • -h, --help – Print help
11.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
11.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
11.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
11.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
11.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 11.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

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

11.6. architecture

Manipulate architectures

Usage

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

Options

  • -h, --help – Print help

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

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

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

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

 

11.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 11.13. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • id – integer
  • name – string

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

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

11.7. arf-report

Manipulate compliance reports

Usage

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

Options

  • -h, --help – Print help

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

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

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

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

 

11.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 11.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 – string
  • location – string
  • location_id – integer
  • log – text
  • not_comply_with – string
  • openscap_proxy – string
  • organization – string
  • organization_id – integer
  • origin – string
  • policy – string
  • reported – datetime
  • resource – text
  • xccdf_rule_failed – string
  • xccdf_rule_name – text
  • xccdf_rule_othered – string
  • xccdf_rule_passed – string

11.8. audit

Search audit trails.

Usage

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

Options

  • -h, --help – Print help

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

 

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

11.9. auth

Foreman connection login/logout

Usage

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

Options

  • -h, --help – Print help

11.9.1. auth login

Set credentials

Usage

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

Options

  • -h, --help – Print help
11.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
11.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
11.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
11.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

11.9.2. auth logout

Wipe your credentials

Usage

# hammer auth logout [OPTIONS]

Options

  • -h, --help – Print help

11.9.3. auth status

Information about current connections

Usage

# hammer auth status [OPTIONS]

Options

  • -h, --help – Print help

11.10. auth-source

Manipulate auth sources

Usage

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

Options

  • -h, --help – Print help

11.10.1. auth-source external

Manage external auth sources

Usage

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

Options

  • -h, --help – Print help
11.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 11.18. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Locations/

x

x

 

Organizations/

x

x

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

11.10.2. auth-source ldap

Manage LDAP auth sources

Usage

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

Options

  • -h, --help – Print help
11.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
11.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
11.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 11.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

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

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

11.11. bookmark

Manage bookmarks

Usage

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

Options

  • -h, --help – Print help

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

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

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

 

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

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

11.12. bootdisk

Download boot disks

Usage

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

Options

  • -h, --help – Print help

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

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

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

11.13. capsule

Manipulate capsule

Usage

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

Options

  • -h, --help – Print help

11.13.1. capsule content

Manage the capsule content

Usage

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

Options

  • -h, --help – Print help
11.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
11.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 11.25. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Organization

x

x

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

11.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 11.27. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Organization

x

x

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

11.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
11.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
11.13.1.11. capsule content verify-checksum

Check for missing or corrupted artifacts, and attempt to redownload them.

Usage

# hammer capsule content verify-checksum [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 verifying checksum 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 verifying checksum 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 verifying checksum on
  • -h, --help – Print help

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

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

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

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

 

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

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

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

11.14. compute-profile

Manipulate compute profiles

Usage

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

Options

  • -h, --help – Print help

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

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

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

 

11.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 11.32. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • id – integer
  • name – string

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

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

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:
11.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

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 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
11.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
    • 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.

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 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 type from VMware
      • key – Key of the controller (e.g. 1000)

    • nvme_controllers – List with NVME controllers definitions

      • type – ID of the controller type from VMware
      • key – Key of the controller (e.g. 2000)
    • 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 –
11.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
11.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
11.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
    • 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.

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 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 type from VMware
      • key – Key of the controller (e.g. 1000)

    • nvme_controllers – List with NVME controllers definitions

      • type – ID of the controller type from VMware
      • key – Key of the controller (e.g. 2000)
    • 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 –
11.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

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:
11.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

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

11.15. compute-resource

Manipulate compute resources

Usage

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

Options

  • -h, --help – Print help

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

11.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 11.33. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Datacenter

x

x

 

Hosts

x

x

 

Cluster path

x

x

 

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

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

11.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 11.34. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

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

 

11.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
11.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 11.36. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

Uuid

x

x

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

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

11.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 11.39. Predefined field sets
FIELDSALLDEFAULTTHIN

Uuid

x

x

 

Name

x

x

x

Path

x

x

 

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

 

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

11.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 11.42. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Datacenter

x

x

 

Virtual switch

x

x

 

Vlan id

x

x

 

11.15.12. compute-resource resource-pools

List resource pools for a compute resource cluster

Usage

# hammer compute-resource resource-pools [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 11.43. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Cluster

x

x

 

Datacenter

x

x

 

11.15.13. compute-resource security-groups

List available security groups for a compute resource

Usage

# hammer compute-resource security-groups [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 11.44. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

11.15.14. compute-resource storage-domains

List storage domains for a compute resource

Usage

# hammer compute-resource storage-domains [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
  • --storage-domain VALUE
  • -h, --help – Print help
Table 11.45. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

11.15.15. compute-resource storage-pods

List storage pods for a compute resource

Usage

# hammer compute-resource storage-pods [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
  • --storage-pod VALUE
  • -h, --help – Print help
Table 11.46. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Datacenter

x

x

 

11.15.16. compute-resource update

Update a compute resource

Usage

# hammer compute-resource update [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
  • --id VALUE
  • --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 – Compute resource name
  • --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
  • --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

11.15.17. compute-resource virtual-machine

View and manage compute resource’s virtual machines

Usage

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

Options

  • -h, --help – Print help
11.15.17.1. compute-resource virtual-machine delete

Delete a Virtual Machine

Usage

# hammer compute-resource virtual-machine <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
  • --vm-id VALUE
  • -h, --help – Print help
11.15.17.2. compute-resource virtual-machine info

Show a virtual machine

Usage

# hammer compute-resource virtual-machine <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
  • --vm-id VALUE
  • -h, --help – Print help
Table 11.47. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

11.15.17.3. compute-resource virtual-machine power

Power a Virtual Machine

Usage

# hammer compute-resource virtual-machine power [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
  • -h, --help – Print help

11.15.18. compute-resource virtual-machines

List available virtual machines for a compute resource

Usage

# hammer compute-resource virtual-machines [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 11.48. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Path

x

x

 

State

x

x

 

11.15.19. compute-resource vnic-profiles

List available vnic profiles for a compute resource, for RHEV only

Usage

# hammer compute-resource vnic-profiles [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 11.49. Predefined field sets
FIELDSALLDEFAULTTHIN

Vnic profile id

x

x

x

Name

x

x

x

Network id

x

x

 

11.15.20. compute-resource zones

List available zone for a compute resource

Usage

# hammer compute-resource zones [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 11.50. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

11.16. config-report

Browse and read reports

Usage

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

Options

  • -h, --help – Print help

11.16.1. config-report delete

Delete a report

Usage

# hammer config-report <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
  • --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

11.16.2. config-report info

Show a report

Usage

# hammer config-report <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 11.51. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Host

x

x

 

Reported at

x

x

 

Origin

x

x

 

Report status/applied

x

x

 

Report status/restarted

x

x

 

Report status/failed

x

x

 

Report status/restart failures

x

x

 

Report status/skipped

x

x

 

Report status/pending

x

x

 

Report metrics/config retrieval

x

x

 

Report metrics/exec

x

x

 

Report metrics/file

x

x

 

Report metrics/package

x

x

 

Report metrics/service

x

x

 

Report metrics/user

x

x

 

Report metrics/yumrepo

x

x

 

Report metrics/filebucket

x

x

 

Report metrics/cron

x

x

 

Report metrics/total

x

x

 

Logs/resource

x

x

 

Logs/message

x

x

 

11.16.3. config-report list

List all reports

Usage

# hammer config-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 11.52. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Host

x

x

 

Last report

x

x

 

Origin

x

x

 

Applied

x

x

 

Restarted

x

x

 

Failed

x

x

 

Restart failures

x

x

 

Skipped

x

x

 

Pending

x

x

 

Search / Order fields

  • applied – integer
  • eventful – Values: true, false
  • failed – integer
  • failed_restarts – integer
  • host – string
  • host_id – integer
  • host_owner_id – integer
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_title – string
  • id – integer
  • last_report – datetime
  • location – string
  • log – text
  • organization – string
  • origin – string
  • pending – integer
  • reported – datetime
  • resource – text
  • restarted – integer
  • skipped – integer

11.17. content-credentials

Manipulate content credentials on the server

Usage

# hammer content-credentials [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.17.1. content-credentials create

Create a Content Credential

Usage

# hammer content-credentials create [OPTIONS]

Options

  • --content-type VALUE – Type of content: “cert”, “gpg_key”
  • --name VALUE – Name of the Content Credential
  • --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
  • --path FILE – Key file
  • -h, --help – Print help

11.17.2. content-credentials delete

Destroy a Content Credential

Usage

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

Options

  • --id NUMBER – Content Credential ID
  • --name VALUE – 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

11.17.3. content-credentials info

Show a Content Credential

Usage

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

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Content Credential numeric identifier
  • --name VALUE – 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
Table 11.53. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Organization

x

x

 

Repositories/id

x

x

 

Repositories/name

x

x

 

Repositories/content type

x

x

 

Repositories/product

x

x

 

Content

x

x

 

11.17.4. content-credentials list

List Content Credentials

Usage

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

Options

  • --content-type VALUE – Type of content
  • --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 Content Credential
  • --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 11.54. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Content type

x

x

 

11.17.5. content-credentials update

Update a Content Credential

Usage

# hammer content-credentials update [OPTIONS]

Options

  • --content-type VALUE – Type of content: “cert”, “gpg_key”
  • --id NUMBER – Content Credential ID
  • --name VALUE – Name of the Content Credential
  • --new-name VALUE – Name of the Content Credential
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --path FILE – Key file
  • -h, --help – Print help

11.18. content-export

Prepare content for export to a disconnected Katello

Usage

# hammer content-export [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.18.1. content-export complete

Prepare content for a full export to a disconnected Katello

Usage

# hammer content-export complete [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.18.1.1. content-export complete library

Performs a full export of the organization’s library environment

Usage

# hammer content-export complete library [OPTIONS]

Options

  • --async – Do not wait for the task
  • --chunk-size-gb NUMBER – Split the exported content into archives no greater than the specified size in gigabytes.
  • --destination-server VALUE – Destination Server name
  • --fail-on-missing-content – Fails if any of the repositories belonging to this organization are unexportable.
  • --format ENUM – Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker, deb repositories. Possible value(s): syncable, importable
  • --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
11.18.1.2. content-export complete repository

Performs a full export of a repository

Usage

# hammer content-export complete repository [OPTIONS]

Options

  • --async – Do not wait for the task
  • --chunk-size-gb NUMBER – Split the exported content into archives no greater than the specified size in gigabytes.
  • --format ENUM – Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker, deb repositories. Possible value(s): syncable, importable
  • --id NUMBER – Repository identifier
  • --name VALUE – Filter repositories by name.
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • -h, --help – Print help
11.18.1.3. content-export complete version

Performs a full export a content view version

Usage

# hammer content-export complete version [OPTIONS]

Options

  • --async – Do not wait for the task
  • --chunk-size-gb NUMBER – Split the exported content into archives no greater than the specified size in gigabytes.
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --destination-server VALUE – Destination Server name
  • --fail-on-missing-content – Fails if any of the repositories belonging to this version are unexportable.
  • --format ENUM – Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker, deb repositories. Possible value(s): syncable, importable
  • --id NUMBER – Content view version identifier
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER ID of the environment
  • --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
  • --version VALUE – Filter versions by version number.
  • -h, --help – Print help

11.18.2. content-export generate-listing

Generates listing file on each directory of a syncable export. This command only needs to be used if the export was performed asynchronously or if the listing files were lost. Assumes the syncable export directory is accessible on disk

Usage

# hammer content-export generate-listing [OPTIONS]

Options

  • --id VALUE – Generate listing files based on specified export history
  • --task-id VALUE – Generate listing files for a syncable export task
  • -h, --help – Print help

11.18.3. content-export generate-metadata

Writes export metadata to disk for use by the importing Katello. This command only needs to be used if the export was performed asynchronously or if the metadata was lost

Usage

# hammer content-export generate-metadata [OPTIONS]

Options

  • --id VALUE – Generate metadata based on specified export history
  • --task-id VALUE – Generate metadata based on output of the specified export task
  • -h, --help – Print help

11.18.4. content-export incremental

Prepare content for an incremental export to a disconnected Katello

Usage

# hammer content-export incremental [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.18.4.1. content-export incremental library

Performs an incremental export of the organization’s library environment

Usage

# hammer content-export incremental library [OPTIONS]

Options

  • --async – Do not wait for the task
  • --chunk-size-gb NUMBER – Split the exported content into archives no greater than the specified size in gigabytes.
  • --destination-server VALUE – Destination Server name
  • --fail-on-missing-content – Fails if any of the repositories belonging to this organization are unexportable.
  • --format ENUM – Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker, deb repositories. Possible value(s): syncable, importable
  • --from-history-id NUMBER – Export history identifier used for incremental export. If not provided the most recent export history will be used.
  • --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
11.18.4.2. content-export incremental repository

Performs an incremental export of a repository

Usage

# hammer content-export incremental repository [OPTIONS]

Options

  • --async – Do not wait for the task
  • --chunk-size-gb NUMBER – Split the exported content into archives no greater than the specified size in gigabytes.
  • --format ENUM – Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker, deb repositories. Possible value(s): syncable, importable
  • --from-history-id NUMBER – Export history identifier used for incremental export. If not provided the most recent export history will be used.
  • --id NUMBER – Repository identifier
  • --name VALUE – Filter repositories by name.
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • -h, --help – Print help
11.18.4.3. content-export incremental version

Performs an incremental export of a content view version

Usage

# hammer content-export incremental version [OPTIONS]

Options

  • --async – Do not wait for the task
  • --chunk-size-gb NUMBER – Split the exported content into archives no greater than the specified size in gigabytes.
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --destination-server VALUE – Destination Server name
  • --fail-on-missing-content – Fails if any of the repositories belonging to this version are unexportable.
  • --format ENUM – Export formats.Choose syncable if the exported content needs to be in a yum format. This option is only available for yum, file repositories. Choose importable if the importing server uses the same version and exported content needs to be one of yum, file, ansible_collection, docker, deb repositories. Possible value(s): syncable, importable
  • --from-history-id NUMBER – Export history identifier used for incremental export. If not provided the most recent export history will be used.
  • --id NUMBER – Content view version identifier
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER ID of the environment
  • --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
  • --version VALUE – Filter versions by version number.
  • -h, --help – Print help

11.18.5. content-export list

View content view export histories

Usage

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

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER Content view version identifier
  • --destination-server VALUE – Destination Server name
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --id NUMBER – Content view version export history identifier
  • --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
  • --type ENUM – Export Types Possible value(s): complete, incremental
  • -h, --help – Print help
Table 11.55. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Destination server

x

x

 

Path

x

x

 

Type

x

x

 

Content view version

x

x

 

Content view version id

x

x

 

Created at

x

x

 

Updated at

x

x

 

Search / Order fields

  • content_view_id – integer
  • content_view_version_id – integer
  • id – integer
  • type – string

11.19. content-import

Import content from an upstream archive.

Usage

# hammer content-import [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.19.1. content-import library

Imports a content archive to an organization’s library lifecycle environment

Usage

# hammer content-import library [OPTIONS]

Options

  • --async – Do not wait for the task
  • --metadata-file VALUE – Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory.
  • --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
  • --path VALUE – Directory containing the exported Content View Version
  • -h, --help – Print help

11.19.2. content-import list

View content view import histories

Usage

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

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER Content view version identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --id NUMBER – Content view version import history identifier
  • --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
  • --type ENUM – Import Types Possible value(s): complete, incremental
  • -h, --help – Print help
Table 11.56. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Path

x

x

 

Type

x

x

 

Content view version

x

x

 

Content view version id

x

x

 

Created at

x

x

 

Updated at

x

x

 

Search / Order fields

  • content_view_id – integer
  • content_view_version_id – integer
  • id – integer
  • type – string

11.19.3. content-import repository

Imports a repository

Usage

# hammer content-import repository [OPTIONS]

Options

  • --async – Do not wait for the task
  • --metadata-file VALUE – Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory.
  • --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
  • --path VALUE – Directory containing the exported Content View Version
  • -h, --help – Print help

11.19.4. content-import version

Imports a content archive to a content view version

Usage

# hammer content-import version [OPTIONS]

Options

  • --async – Do not wait for the task
  • --metadata-file VALUE – Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory.
  • --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
  • --path VALUE – Directory containing the exported Content View Version
  • -h, --help – Print help

11.20. content-units

Manipulate content units

Usage

# hammer content-units [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.20.1. content-units info

Show a content unit

Usage

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

Options

  • --content-type VALUE – Possible values:
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER Content view version identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A content unit identifier
  • --name VALUE – 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.57. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Version

x

x

 

Filename

x

x

 

11.20.2. content-units list

List content_units

Usage

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

Options

  • --content-type VALUE – Possible values:
  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content view filter identifier
  • --content-view-filter-rule VALUE – Name to search by
  • --content-view-filter-rule-id NUMBER Content view filter rule identifier
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content view version identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --ids LIST – Ids to filter content by
  • --include-filter-ids BOOLEAN – Includes associated content view filter ids in response
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.58. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Version

x

x

 

Filename

x

x

 

11.21. content-view

Manipulate content views

Usage

# hammer content-view [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.21.1. content-view add-repository

Associate a resource

Usage

# hammer content-view add-repository [OPTIONS]

Options

  • --id VALUE – Content view numeric identifier
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository ID
  • -h, --help – Print help

11.21.2. content-view add-version

Add a content view version to a composite view

Usage

# hammer content-view add-version [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view id to search by
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER Content view version identifier
  • --id VALUE – Content view numeric identifier
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help

11.21.3. content-view component

View and manage components

Usage

# hammer content-view component [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.21.3.1. content-view component add

Add components to the content view

Usage

# hammer content-view component add [OPTIONS]

Options

  • --component-content-view VALUE – Content View name of the component who`s latest version is desired
  • --component-content-view-id VALUE – Content View identifier of the component who`s latest version is desired
  • --component-content-view-version VALUE – Content View Version number of the component. Either use this or
  • --component-content-view-version-id option
  • --component-content-view-version-id VALUE Content View Version identifier of the component
  • --composite-content-view VALUE – Name of the composite content view
  • --composite-content-view-id NUMBER – Composite content view identifier
  • --latest – Select the latest version of the components content view is desired
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
11.21.3.2. content-view component list

List components attached to this content view

Usage

# hammer content-view component <list|index> [OPTIONS]

Options

  • --composite-content-view VALUE – Name of the composite content view
  • --composite-content-view-id NUMBER Composite content view identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
Table 11.59. Predefined field sets
FIELDSALLDEFAULTTHIN

Content view id

x

x

 

Name

x

x

 

Version

x

x

 

Component id

x

x

x

Current version

x

x

 

Version id

x

x

 
11.21.3.3. content-view component remove

Remove components from the content view

Usage

# hammer content-view component remove [OPTIONS]

Options

  • --component-content-view-ids VALUE Array of component content view identfiers to remove. Comma separated list of values
  • --component-content-views VALUE – Array of component content view names to remove. Comma separated list of values
  • --component-ids LIST – Array of content view component IDs to remove. Identifier of the component association
  • --composite-content-view VALUE – Name of the composite content view
  • --composite-content-view-id NUMBER Composite content view identifier
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
11.21.3.4. content-view component update

Update a component associated with the content view

Usage

# hammer content-view component update [OPTIONS]

Options

  • --component-content-view VALUE – Content View name of the component who`s latest version is desired
  • --component-content-view-id VALUE – Content View identifier of the component who`s latest version is desired
  • --component-content-view-version VALUE – Content View Version number of the component. Either use this or
  • --component-content-view-version-id option
  • --component-content-view-version-id VALUE Content View Version identifier of the component
  • --composite-content-view VALUE – Name of the composite content view
  • --composite-content-view-id NUMBER – Composite content view identifier
  • --id NUMBER – Content view component ID. Identifier of the component association
  • --latest – Select the latest version of the components content view is desired
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help

11.21.4. content-view copy

Copy a content view

Usage

# hammer content-view copy [OPTIONS]

Options

  • --id NUMBER – Content view numeric identifier
  • --name VALUE – Content view name to search by
  • --new-name VALUE – New content view name
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help

11.21.5. content-view create

Create a content view

Usage

# hammer content-view create [OPTIONS]

Options

  • --auto-publish BOOLEAN – Enable/Disable auto publish of composite view
  • --component-ids LIST – List of component content view version ids for composite views
  • --composite – Create a composite content view
  • --description VALUE – Description for the content view
  • --import-only – Designate this Content View for importing from upstream servers only.
  • --label VALUE – Content view label
  • --name VALUE – Name of the content view
  • --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
  • --repository-ids LIST – List of repository ids
  • --solve-dependencies BOOLEAN Solve RPM dependencies by default on Content View publish, defaults to false
  • -h, --help – Print help

11.21.6. content-view delete

Delete a content view

Usage

# hammer content-view delete [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Content view numeric identifier
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help

11.21.7. content-view filter

View and manage filters

Usage

# hammer content-view filter [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.21.7.1. content-view filter add-repository

Associate a resource

Usage

# hammer content-view filter add-repository [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --id VALUE – Filter identifier
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository ID
  • -h, --help – Print help
11.21.7.2. content-view filter create

create a filter for a content view

Usage

# hammer content-view filter create [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --description VALUE – Description of the filter
  • --inclusion BOOLEAN – Specifies if content should be included or excluded, default: inclusion=false
  • --name VALUE – Name of the filter
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --original-module-streams BOOLEAN Add all module streams without errata to the included/excluded list. (module stream filter only)
  • --original-packages BOOLEAN – Add all packages without errata to the included/excluded list. (package filter only)
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repositories LIST
  • --repository-ids LIST – List of repository ids
  • --type VALUE – Type of filter (e.g. deb, rpm, package_group, erratum, erratum_id, erratum_date, docker, modulemd)
  • -h, --help – Print help
11.21.7.3. content-view filter delete

delete a filter

Usage

# hammer content-view filter <delete|destroy> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --id NUMBER – Filter identifier
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
11.21.7.4. content-view filter info

show filter info

Usage

# hammer content-view filter <info|show> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Filter identifier
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
Table 11.60. Predefined field sets
FIELDSALLDEFAULTTHIN

Filter id

x

x

x

Name

x

x

x

Type

x

x

 

Inclusion

x

x

 

Description

x

x

 

Repositories/id

x

x

 

Repositories/name

x

x

 

Repositories/label

x

x

 

Rules/id

x

x

 

Rules/name

x

x

 

Rules/version

x

x

 

Rules/minimum version

x

x

 

Rules/maximum version

x

x

 

Rules/errata id

x

x

 

Rules/start date

x

x

 

Rules/end date

x

x

 

Rules/types

x

x

 

Rules/created

x

x

 

Rules/updated

x

x

 
11.21.7.5. content-view filter list

list filters

Usage

# hammer content-view filter <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --name VALUE – Filter content view filters by name
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --search VALUE – Search string
  • --types LIST – Types of filters
  • -h, --help – Print help
Table 11.61. Predefined field sets
FIELDSALLDEFAULTTHIN

Filter id

x

x

x

Name

x

x

x

Description

x

x

 

Type

x

x

 

Inclusion

x

x

 

Search / Order fields

  • content_type – Values: rpm, deb, package_group, erratum, docker, modulemd
  • inclusion_type – Values: include, exclude
  • name – string
11.21.7.6. content-view filter remove-repository

Disassociate a resource

Usage

# hammer content-view filter remove-repository [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --id VALUE – Filter identifier
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository ID
  • -h, --help – Print help
11.21.7.7. content-view filter rule

View and manage filter rules

Usage

# hammer content-view filter rule [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.21.7.7.1. content-view filter rule create

Create a filter rule. The parameters included should be based upon the filter type.

Usage

# hammer content-view filter rule create [OPTIONS]

Options

  • --architecture VALUE – Package: architecture
  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER Filter identifier
  • --content-view-id NUMBER
  • --date-type VALUE – Erratum: search using the Issued On or Updated On column of the errata. Values are issued/updated
  • --end-date VALUE – Erratum: end date (YYYY-MM-DD)
  • --errata-id VALUE – Erratum: id
  • --errata-ids LIST – Erratum: IDs or a select all object
  • --max-version VALUE – Package: maximum version
  • --min-version VALUE – Package: minimum version
  • --module-stream-ids LIST – Module stream ids
  • --name LIST – Deb, package, package group, or docker tag names
  • --names VALUE – Package and package group names
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --start-date VALUE – Erratum: start date (YYYY-MM-DD)
  • --types LIST – Erratum: types (enhancement, bugfix, security)
  • --uuid VALUE – Package group: uuid
  • --version VALUE – Package: version
  • -h, --help – Print help
11.21.7.7.2. content-view filter rule delete

Delete a filter rule

Usage

# hammer content-view filter rule <delete|destroy> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER Filter identifier
  • --content-view-id NUMBER
  • --id NUMBER – Rule identifier
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
11.21.7.7.3. content-view filter rule info

Show filter rule info

Usage

# hammer content-view filter rule <info|show> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER Filter identifier
  • --content-view-id NUMBER
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Rule identifier
  • --name VALUE – Name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
Table 11.62. Predefined field sets
FIELDSALLDEFAULTTHIN

Rule id

x

x

x

Filter id

x

x

 

Name

x

x

x

Version

x

x

 

Minimum version

x

x

 

Maximum version

x

x

 

Architecture

x

x

 

Errata id

x

x

 

Start date

x

x

 

End date

x

x

 

Date type

x

x

 

Types

x

x

 

Created

x

x

 

Updated

x

x

 
11.21.7.7.4. content-view filter rule list

List filter rules

Usage

# hammer content-view filter rule <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER Filter identifier
  • --content-view-id NUMBER
  • --errata-id VALUE – Errata_id of the content view filter rule
  • --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 content view filter rule
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --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 11.63. Predefined field sets
FIELDSALLDEFAULTTHIN

Rule id

x

x

x

Filter id

x

x

 

Name

x

x

x

Version

x

x

 

Minimum version

x

x

 

Maximum version

x

x

 

Architecture

x

x

 

Errata id

x

x

 

Start date

x

x

 

End date

x

x

 
11.21.7.7.5. content-view filter rule update

Update a filter rule. The parameters included should be based upon the filter type.

Usage

# hammer content-view filter rule update [OPTIONS]

Options

  • --architecture VALUE – Package: architecture
  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER Filter identifier
  • --content-view-id NUMBER
  • --end-date VALUE – Erratum: end date (YYYY-MM-DD)
  • --errata-id VALUE – Erratum: id
  • --id NUMBER – Rule identifier
  • --max-version VALUE – Package: maximum version
  • --min-version VALUE – Package: minimum version
  • --name VALUE – Package, package group, or docker tag: name
  • --new-name VALUE – Package, package group, or docker tag: name
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --start-date VALUE – Erratum: start date (YYYY-MM-DD)
  • --types LIST – Erratum: types (enhancement, bugfix, security)
  • --version VALUE – Package: version
  • -h, --help – Print help
11.21.7.8. content-view filter update

update a filter

Usage

# hammer content-view filter update [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view identifier
  • --description VALUE – Description of the filter
  • --id NUMBER – Filter identifier
  • --inclusion BOOLEAN – Specifies if content should be included or excluded, default: inclusion=false
  • --name VALUE – New name for the filter
  • --new-name VALUE – New name for the filter
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --original-module-streams BOOLEAN Add all module streams without errata to the included/excluded list. (module stream filter only)
  • --original-packages BOOLEAN – Add all packages without errata to the included/excluded list. (package filter only)
  • --repositories LIST
  • --repository-ids LIST – List of repository ids
  • -h, --help – Print help

11.21.8. content-view info

Show a content view

Usage

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

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Content view numeric identifier
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help
Table 11.64. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Label

x

x

 

Composite

x

x

 

Description

x

x

 

Content host count

x

x

 

Solve dependencies

x

x

 

Organization

x

x

 

Yum repositories/id

x

x

 

Yum repositories/name

x

x

 

Yum repositories/label

x

x

 

File repositories/id

x

x

 

File repositories/name

x

x

 

File repositories/label

x

x

 

Container image repositories/id

x

x

 

Container image repositories/name

x

x

 

Container image repositories/label

x

x

 

Ostree repositories/id

x

x

 

Ostree repositories/name

x

x

 

Ostree repositories/label

x

x

 

Ansible repositories/id

x

x

 

Ansible repositories/name

x

x

 

Ansible repositories/label

x

x

 

File repositories/id

x

x

 

File repositories/name

x

x

 

File repositories/label

x

x

 

Debian repositories/id

x

x

 

Debian repositories/name

x

x

 

Debian repositories/label

x

x

 

Python repositories/id

x

x

 

Python repositories/name

x

x

 

Python repositories/label

x

x

 

Lifecycle environments/id

x

x

 

Lifecycle environments/name

x

x

 

Versions/id

x

x

 

Versions/version

x

x

 

Versions/published

x

x

 

Components/id

x

x

 

Components/name

x

x

 

Components/latest version

x

x

 

Components/not yet published

x

x

 

Components/always update to the latest

x

x

 

Activation keys/

x

x

 

11.21.9. content-view list

List content views

Usage

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

Options

  • --composite BOOLEAN – Filter only composite content views
  • --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
  • --include-generated BOOLEAN – Include content views generated by imports/exports. Defaults to false
  • --label VALUE – Label of the content view
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Environment identifier
  • --name VALUE – Name of the content view
  • --noncomposite BOOLEAN – Filter out composite content views
  • --nondefault BOOLEAN – Filter out default content views
  • --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
  • --without LIST – Do not include this array of content views
  • -h, --help – Print help
Table 11.65. Predefined field sets
FIELDSALLDEFAULTTHIN

Content view id

x

x

x

Name

x

x

x

Label

x

x

 

Composite

x

x

 

Last published

x

x

 

Repository ids

x

x

 

Search / Order fields

  • composite – boolean
  • content_views – string
  • default – boolean
  • generated_for – integer
  • label – string
  • name – string
  • organization_id – integer

11.21.10. content-view publish

Publish a content view

Usage

# hammer content-view publish [OPTIONS]

Options

  • --async – Do not wait for the task
  • --description VALUE – Description for the new published content view version
  • --id NUMBER – Content view identifier
  • --is-force-promote BOOLEAN – Force content view promotion and bypass lifecycle environment restriction
  • --lifecycle-environment-ids LIST Identifiers for Lifecycle Environment
  • --lifecycle-environments LIST – Names for Lifecycle Environment
  • --major NUMBER – Override the major version number
  • --minor NUMBER – Override the minor version number
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --publish-only-if-needed BOOLEAN Check audited changes and proceed only if content or filters have changed since last publish
  • --repos-units SCHEMA – Specify the list of units in each repo
  • -h, --help – Print help

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

  • --repos-units – "label=<string>,rpm_filenames=<array>, …​ "

11.21.11. content-view purge

Delete old versions of a content view

Usage

# hammer content-view purge [OPTIONS]

Options

  • --async – Do not wait for the task
  • --count NUMBER – Count of unused versions to keep Default: 3
  • --id VALUE – Content View numeric identifier
  • --name VALUE – Content View name
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help

11.21.12. content-view remove

Remove versions and/or environments from a content view and reassign systems and keys

Usage

# hammer content-view remove [OPTIONS]

Options

  • --async – Do not wait for the task
  • --content-view-version-ids LIST Content view version identifiers to be deleted
  • --content-view-versions LIST
  • --destroy-content-view BOOLEAN – Delete the content view with all the versions and environments
  • --environment-ids LIST – (--environment-ids is deprecated: Use --lifecycle-environment-ids instead)
  • --environments LIST – (--environments is deprecated: Use --lifecycle-environments instead)
  • --id NUMBER – Content view numeric identifier
  • --key-content-view-id NUMBER – Content view to reassign orphaned activation keys to
  • --key-environment-id NUMBER – Environment to reassign orphaned activation keys to
  • --lifecycle-environment-ids LIST Environment numeric identifiers to be removed
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --system-content-view-id NUMBER Content view to reassign orphaned systems to
  • --system-environment-id NUMBER – Environment to reassign orphaned systems to
  • -h, --help – Print help

11.21.13. content-view remove-from-environment

Remove a content view from an environment

Usage

# hammer content-view remove-from-environment [OPTIONS]

Options

  • --async – Do not wait for the task
  • --environment 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 – Content view numeric identifier
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Environment numeric identifier
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help

11.21.14. content-view remove-repository

Disassociate a resource

Usage

# hammer content-view remove-repository [OPTIONS]

Options

  • --id VALUE – Content view numeric identifier
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository ID
  • -h, --help – Print help

11.21.15. content-view remove-version

Remove a content view version from a composite view

Usage

# hammer content-view remove-version [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER Content view version identifier
  • --id VALUE – Content view numeric identifier
  • --name VALUE – Content view name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • -h, --help – Print help

11.21.16. content-view update

Update a content view

Usage

# hammer content-view update [OPTIONS]

Options

  • --auto-publish BOOLEAN – Enable/Disable auto publish of composite view
  • --component-ids LIST – List of component content view version ids for composite views
  • --description VALUE – Description for the content view
  • --id NUMBER – Content view identifier
  • --import-only BOOLEAN – Designate this Content View for importing from upstream servers only. Defaults to false
  • --name VALUE – New name for the content view
  • --new-name VALUE – New name for the content view
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --repository-ids LIST – List of repository ids
  • --solve-dependencies BOOLEAN Solve RPM dependencies by default on Content View publish, defaults to false
  • -h, --help – Print help

11.21.17. content-view version

View and manage content view versions

Usage

# hammer content-view version [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.21.17.1. content-view version delete

Remove content view version

Usage

# hammer content-view version delete [OPTIONS]

Options

  • --async – Do not wait for the task
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric 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)
  • --id NUMBER – Content view version identifier
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER ID of the environment
  • --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
  • --version VALUE – Content view version number
  • -h, --help – Print help
11.21.17.2. content-view version incremental-update

Perform an Incremental Update on one or more Content View Versions

Usage

# hammer content-view version incremental-update [OPTIONS]

Options

  • --async – Do not wait for the task
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content View Version Ids to perform an incremental update on. May contain composites as well as one or more components to update.
  • --deb-ids LIST – Deb Package ids to copy into the new versions
  • --debs LIST
  • --description VALUE – The description for the new generated Content View Versions
  • --errata-ids LIST – Errata ids to copy into the new versions
  • --host-ids LIST – IDs of hosts to update
  • --lifecycle-environment-ids LIST – List of lifecycle environment IDs to update the content view version in
  • --lifecycle-environments LIST – List of lifecycle environment names to update the content view version in
  • --organization VALUE – Organization name for resolving lifecycle environment names
  • --organization-id VALUE – Organization id for resolving lifecycle environment names
  • --package-ids LIST – Package ids to copy into the new versions
  • --packages LIST
  • --propagate-all-composites BOOLEAN If true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment
  • --resolve-dependencies BOOLEAN – If true, when adding the specified errata or packages, any needed dependencies will be copied as well. Defaults to true
  • --update-all-hosts BOOLEAN – Update all editable and applicable hosts within the specified Content View and Lifecycle Environments
  • -h, --help – Print help
11.21.17.3. content-view version info

Show content view version

Usage

# hammer content-view version <info|show> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric 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)
  • --id NUMBER – Content view version identifier
  • --include-applied-filters BOOLEAN Whether or not to return filters applied to the content view version
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER ID of the environment
  • --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
  • --version VALUE – Content view version number
  • -h, --help – Print help
Table 11.66. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

 

Version

x

x

x

Description

x

x

 

Content view id

x

x

 

Content view name

x

x

 

Content view label

x

x

 

Lifecycle environments/id

x

x

 

Lifecycle environments/name

x

x

 

Lifecycle environments/label

x

x

 

Repositories/id

x

x

 

Repositories/name

x

x

 

Repositories/label

x

x

 

Has applied filters

x

x

 

Applied filters/id

x

x

 

Applied filters/name

x

x

 

Applied filters/type

x

x

 

Applied filters/inclusion

x

x

 

Applied filters/original packages

x

x

 

Applied filters/original module streams

x

x

 

Applied filters/rules/id

x

x

 

Applied filters/rules/name

x

x

 

Applied filters/rules/uuid

x

x

 

Applied filters/rules/module stream id

x

x

 

Applied filters/rules/types/

x

x

 

Applied filters/rules/architecture

x

x

 

Applied filters/rules/content view filter id

x

x

 

Applied filters/rules/errata id

x

x

 

Applied filters/rules/date type

x

x

 

Applied filters/rules/start date

x

x

 

Applied filters/rules/end date

x

x

 

Dependency solving

x

x

 
11.21.17.4. content-view version list

List content view versions

Usage

# hammer content-view version <list|index> [OPTIONS]

Options

  • --composite-version-id NUMBER – Filter versions that are components in the specified composite version
  • --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)
  • --file-id NUMBER – Filter content view versions that contain the file
  • --full-result BOOLEAN – Whether or not to show all results
  • --include-applied-filters BOOLEAN Whether or not to return filters applied to the content view version
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Filter versions by environment
  • --nondefault BOOLEAN – Filter out default content views
  • --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
  • --triggered-by-id NUMBER – Filter composite versions whose publish was triggered by the specified component version
  • --version VALUE – Filter versions by version number
  • -h, --help – Print help
Table 11.67. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

 

Version

x

x

x

Description

x

x

 

Lifecycle environments

x

x

 

Search / Order fields

  • content_view_id – integer
  • repository – string
  • version – string
11.21.17.5. content-view version promote

Promote a content view version

Usage

# hammer content-view version promote [OPTIONS]

Options

  • --async – Do not wait for the task
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --description VALUE – The description for the content view version promotion
  • --force – Force content view promotion and bypass lifecycle environment restriction
  • --from-lifecycle-environment VALUE – Environment name from where to promote its version from (if version is unknown)
  • --from-lifecycle-environment-id VALUE Id of the environment from where to promote its version from (if version is unknown)
  • --id NUMBER – Content view version identifier
  • --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
  • --to-lifecycle-environment VALUE – Name of the target environment
  • --to-lifecycle-environment-id VALUE – Id of the target environment
  • --version VALUE – Content view version number
  • -h, --help – Print help
11.21.17.6. content-view version republish-repositories

Forces a republish of the version’s repositories' metadata

Usage

# hammer content-view version republish-repositories [OPTIONS]

Options

  • --async – Do not wait for the task
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --force BOOLEAN – Force metadata regeneration to proceed. Dangerous operation when version has repositories with the Complete Mirroring mirroring policy
  • --id NUMBER – Content view version identifier
  • --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
  • --version VALUE – Content view version number
  • -h, --help – Print help
11.21.17.7. content-view version update

Update a content view version

Usage

# hammer content-view version update [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --description VALUE – The description for the content view version
  • --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 – Content view version identifier
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER ID of the environment
  • --new-version VALUE
  • --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
  • --version VALUE – Content view version number
  • -h, --help – Print help
11.21.17.8. content-view version verify-checksum

Verify checksum of repository contents in the content view version

Usage

# hammer content-view version verify-checksum [OPTIONS]

Options

  • --async – Do not wait for the task
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --id NUMBER – Content view version identifier
  • --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
  • --version VALUE – Content view version number
  • -h, --help – Print help

11.22. deb-package

Manipulate deb packages

Usage

# hammer deb-package [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.22.1. deb-package info

Show a deb package

Usage

# hammer deb-package <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A deb package identifier
  • --name VALUE – 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
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.68. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Pulp id

x

x

 

Uuid

x

x

 

Name

x

x

x

Version

x

x

 

Checksum

x

x

 

Architecture

x

x

 

Nav

x

x

 

Nva

x

x

 

Filename

x

x

 

Available host count

x

x

 

Applicable host count

x

x

 

Description

x

x

 

11.22.2. deb-package list

List deb packages

Usage

# hammer deb-package <list|index> [OPTIONS]

Options

  • --available-for VALUE – Return deb packages that can be added to the specified object. Only the value content_view_version is supported.
  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content View Filter identifier. Use to filter by ID
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content View Version 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
  • --host VALUE – Host name
  • --host-id NUMBER – Host id to list applicable deb packages for
  • --ids LIST – Deb package identifiers to filter content by
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --packages-restrict-applicable BOOLEAN Return deb packages that are applicable to one or more hosts (defaults to true if host_id is specified)
  • --packages-restrict-latest BOOLEAN – Return only the latest version of each package
  • --packages-restrict-upgradable BOOLEAN Return deb packages that are upgradable on one or more hosts
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.69. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Filename

x

x

11.23. defaults

Defaults management

Usage

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

Options

  • -h, --help – Print help

11.23.1. defaults add

Add a default parameter to config

Usage

# hammer defaults add [OPTIONS]

Options

  • --param-name VALUE – The name of the default option (e.g. organization_id)
  • --param-value VALUE – The value for the default option
  • --provider VALUE – The name of the provider providing the value. For list available providers see hammer defaults providers
  • -h, --help – Print help

11.23.2. defaults delete

Delete a default param

Usage

# hammer defaults delete [OPTIONS]

Options

  • --param-name VALUE – The name of the default option
  • -h, --help – Print help

11.23.3. defaults list

List all the default parameters

Usage

# hammer defaults list [OPTIONS]

Options

  • -h, --help – Print help

11.23.4. defaults providers

List all the providers

Usage

# hammer defaults providers [OPTIONS]

Options

  • -h, --help – Print help

11.24. discovery

Manipulate discovered hosts.

Usage

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

Options

  • -h, --help – Print help

11.24.1. discovery auto-provision

Auto provision a host

Usage

# hammer discovery auto-provision [OPTIONS]

Options

  • --all – Auto provision all discovered hosts
  • --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

11.24.2. discovery delete

Delete a discovered host

Usage

# hammer discovery <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

11.24.3. discovery facts

List all fact values

Usage

# hammer discovery facts [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
  • --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 11.70. Predefined field sets
FIELDSALLDEFAULT

Fact

x

x

Value

x

x

Search / Order fields

  • fact – string
  • fact_short_name – string
  • facts – string
  • host – string
  • host.hostgroup – string
  • host_id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
  • origin – string
  • reported_at – datetime
  • short_name – string
  • type – string
  • value – string

11.24.4. discovery info

Show a discovered host

Usage

# hammer discovery <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 11.71. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Mac

x

x

 

Cpus

x

x

 

Memory

x

x

 

Disk count

x

x

 

Disks size

x

x

 

Subnet

x

x

 

Last report

x

x

 

Ip

x

x

 

Model

x

x

 

Organization

x

x

 

Location

x

x

 

11.24.5. discovery list

List all discovered hosts

Usage

# hammer discovery <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 results
  • --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 VALUE – Paginate results
  • --per-page VALUE – Number of entries per request
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 11.72. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Mac

x

x

 

Cpus

x

x

 

Memory

x

x

 

Disk count

x

x

 

Disks size

x

x

 

Subnet

x

x

 

Last report

x

x

 

11.24.6. discovery provision

Provision a discovered host

Usage

# hammer discovery provision [OPTIONS]

Options

  • --architecture VALUE – Architecture name
  • --architecture-id NUMBER – Required if host is managed and value is not inherited from host group
  • --ask-root-password BOOLEAN
  • --build BOOLEAN
  • --capabilities VALUE
  • --domain VALUE – Domain name
  • --domain-id NUMBER – Required if host is managed and value is not inherited from host group
  • --enabled BOOLEAN
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER
  • --hostgroup-title VALUE – Hostgroup title
  • --id VALUE
  • --image VALUE – Name to search by
  • --image-id NUMBER
  • --interface KEY_VALUE_LIST – Interface parameters Can be specified multiple times.
  • --ip VALUE – Not required if using a subnet with DHCP Capsule
  • --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
  • --mac VALUE – Not required if it`s a virtual machine
  • --managed BOOLEAN
  • --medium VALUE – Medium name
  • --medium-id VALUE – Required if not imaged based provisioning and host is managed and value is not inherited from host group
  • --model VALUE – Model name
  • --model-id NUMBER
  • --name VALUE
  • --new-name VALUE
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – Required if host is managed and value is not inherited from host group
  • --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
  • --overwrite BOOLEAN
  • --owner-id NUMBER
  • --owner-type ENUM – Host`s owner type Possible value(s): User, Usergroup
  • --parameters KEY_VALUE_LIST – Host parameters
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER
  • --progress-report-id VALUE – UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks
  • --provision-method ENUM – Possible value(s): build, image
  • --pxe-loader ENUM – DHCP filename option (Grub2 or PXELinux by default) Possible value(s): None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI
  • --root-password VALUE
  • --sp-subnet-id NUMBER
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER – Required if host is managed and value is not inherited from host group
  • -h, --help – Print help

11.24.7. discovery reboot

Reboot a host

Usage

# hammer discovery reboot [OPTIONS]

Options

  • --all – Reboot all discovered hosts
  • --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

11.24.8. discovery refresh-facts

Refresh the facts of a host

Usage

# hammer discovery refresh-facts [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

11.25. discovery-rule

Manipulate discovered rules.

Usage

# hammer discovery-rule [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.25.1. discovery-rule create

Create a discovery rule

Usage

# hammer discovery-rule create [OPTIONS]

Options

  • --enabled BOOLEAN – Flag is used for temporary shutdown of rules
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER – The hostgroup that is used to auto provision a host
  • --hostgroup-title VALUE – Hostgroup title
  • --hostname VALUE – Defines a pattern to assign human-readable hostnames to the matching hosts
  • --hosts-limit VALUE – Enables to limit maximum amount of provisioned hosts per rule
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – Location ID for provisioned hosts
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE – Represents rule name shown to the users
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – Organization ID for provisioned hosts
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --priority NUMBER – Puts the rules in order, low numbers go first. Must be greater then zero
  • --search VALUE – Query to match discovered hosts for the particular rule
  • -h, --help – Print help

11.25.2. discovery-rule delete

Delete a rule

Usage

# hammer discovery-rule <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

11.25.3. discovery-rule info

Show a discovery rule

Usage

# hammer discovery-rule <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 11.73. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Priority

x

x

 

Search

x

x

 

Host group

x

x

 

Hosts limit

x

x

 

Enabled

x

x

 

Hostname template

x

x

 

Hosts/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

11.25.4. discovery-rule list

List all discovery rules

Usage

# hammer discovery-rule <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 results
  • --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 VALUE – Paginate results
  • --per-page VALUE – Number of entries per request
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 11.74. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Priority

x

x

 

Search

x

x

 

Host group

x

x

 

Hosts limit

x

x

 

Enabled

x

x

 

11.25.5. discovery-rule update

Update a rule

Usage

# hammer discovery-rule update [OPTIONS]

Options

  • --enabled BOOLEAN – Flag is used for temporary shutdown of rules
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER – The hostgroup that is used to auto provision a host
  • --hostgroup-title VALUE – Hostgroup title
  • --hostname VALUE – Defines a pattern to assign human-readable hostnames to the matching hosts
  • --hosts-limit VALUE – Enables to limit maximum amount of provisioned hosts per rule
  • --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 – Location ID for provisioned hosts
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --name VALUE – Represents rule name shown to the users
  • --new-name VALUE – Represents rule name shown to the users
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – Organization ID for provisioned hosts
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --priority NUMBER – Puts the rules in order, low numbers go first. Must be greater then zero
  • --search VALUE – Query to match discovered hosts for the particular rule
  • -h, --help – Print help

11.26. docker

Manipulate docker content

Usage

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

Options

  • -h, --help – Print help

11.26.1. docker manifest

Manage docker manifests

Usage

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

Options

  • -h, --help – Print help
11.26.1.1. docker manifest info

Show a docker manifest

Usage

# hammer docker manifest <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A docker manifest identifier
  • --name VALUE – 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
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.75. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Schema version

x

x

 

Digest

x

x

 

Downloaded

x

x

 

Tags/name

x

x

 
11.26.1.2. docker manifest list

List docker_manifests

Usage

# hammer docker manifest <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content view filter identifier
  • --content-view-filter-rule VALUE – Name to search by
  • --content-view-filter-rule-id NUMBER Content view filter rule identifier
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content view version 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
  • --ids LIST – Ids to filter content by
  • --include-filter-ids BOOLEAN – Includes associated content view filter ids in response
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.76. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Schema version

x

x

 

Digest

x

x

 

Downloaded

x

x

 

Tags

x

x

 

11.26.2. docker tag

Manage docker tags

Usage

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

Options

  • -h, --help – Print help
11.26.2.1. docker tag info

Show a docker tag

Usage

# hammer docker tag <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A docker tag identifier
  • --name VALUE – 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
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.77. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Tag

x

x

x

Repository id

x

x

 

Docker manifest id

x

x

 

Docker manifest name

x

x

 
11.26.2.2. docker tag list

List docker_tags

Usage

# hammer docker tag <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content view filter identifier
  • --content-view-filter-rule VALUE – Name to search by
  • --content-view-filter-rule-id NUMBER Content view filter rule identifier
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content view version 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
  • --ids LIST – Ids to filter content by
  • --include-filter-ids BOOLEAN – Includes associated content view filter ids in response
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.78. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Tag

x

x

x

Repository id

x

x

 

11.27. domain

Manipulate domains

Usage

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

Options

  • -h, --help – Print help

11.27.1. domain create

Create a domain

Usage

# hammer domain create [OPTIONS]

Options

  • --description VALUE – Full name describing the domain
  • --dns VALUE – Name of DNS proxy to use within this domain
  • --dns-id NUMBER – DNS Capsule ID to use within this domain
  • --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 – The full DNS domain name
  • --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

11.27.2. domain delete

Delete a domain

Usage

# hammer domain <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 – Domain 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

11.27.3. domain delete-parameter

Delete parameter for a domain

Usage

# hammer domain delete-parameter [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id NUMBER – Numerical ID or domain name
  • --name VALUE – Parameter name
  • -h, --help – Print help

11.27.4. domain info

Show a domain

Usage

# hammer domain <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – Numerical ID or domain name
  • --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 – Domain 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
  • --show-hidden-parameters BOOLEAN Display hidden parameter values
  • -h, --help – Print help
Table 11.79. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Dns id

x

x

 

Subnets/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Parameters/

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.27.5. domain list

List of domains

Usage

# hammer domain <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
  • --subnet VALUE – Subnet name
  • --subnet-id VALUE – ID of subnet
  • -h, --help – Print help
Table 11.80. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

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

11.27.6. domain set-parameter

Create or update parameter for a domain

Usage

# hammer domain set-parameter [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id NUMBER – Numerical ID or domain name
  • --hidden-value BOOLEAN – Should the value be hidden
  • --name VALUE – Parameter name
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.27.7. domain update

Update a domain

Usage

# hammer domain update [OPTIONS]

Options

  • --description VALUE – Full name describing the domain
  • --dns VALUE – Name of DNS proxy to use within this domain
  • --dns-id NUMBER – DNS Capsule ID to use within this domain
  • --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 – The full DNS domain name
  • --new-name VALUE – The full DNS domain name
  • --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

11.28. erratum

Manipulate errata

Usage

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

Options

  • -h, --help – Print help

11.28.1. erratum info

Show an erratum

Usage

# hammer erratum info [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – An erratum identifier
  • --name VALUE – 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
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.81. Predefined field sets
FIELDSALLDEFAULT

Title

x

x

Version

x

x

Description

x

x

Status

x

x

Id

x

x

Errata id

x

x

Reboot suggested

x

x

Updated

x

x

Issued

x

x

Release

x

x

Solution

x

x

Packages

x

x

Module streams/name

x

x

Module streams/stream

x

x

Module streams/packages

x

x

11.28.2. erratum list

List errata

Usage

# hammer erratum <list|index> [OPTIONS]

Options

  • --available-for VALUE – Return errata that can be added to the specified object. The values content_view_version and `content_view_filter are supported.
  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content View Filter identifier. Use to filter by ID
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content View Version identifier
  • --cve VALUE – CVE 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)
  • --errata-restrict-applicable BOOLEAN Return errata that are applicable to one or more hosts (defaults to true if host_id is specified)
  • --errata-restrict-installable BOOLEAN Return errata that are upgradable on one or more hosts
  • --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 NUMBER – Host id to list applicable errata for
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.82. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Errata id

x

x

Type

x

x

Title

x

x

Issued

x

x

Updated

x

x

Search / Order fields

  • bug – string
  • cve – string
  • db_id – integer
  • errata_id – string
  • errata_type – string
  • id – string
  • issued – date
  • modular – Values: true, false
  • package – string
  • package_name – string
  • reboot_suggested – boolean
  • repository – string
  • severity – string
  • synopsis – string
  • title – string
  • type – string
  • updated – date

11.29. export-templates

Export templates to a git repo or a directory on the server

Usage

# hammer export-templates [OPTIONS]

Options

  • --branch VALUE – Branch in Git repo.
  • --commit-msg VALUE – Custom commit message for templates export
  • --dirname VALUE – The directory within Git repo containing the templates
  • --filter VALUE – Export templates with names matching this regex (case-insensitive; snippets are not filtered).
  • --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
  • --metadata-export-mode ENUM – Specify how to handle metadata Possible value(s): refresh, keep, remove
  • --negate BOOLEAN – Negate the prefix (for purging).
  • --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
  • --repo VALUE – Override the default repo from settings.
  • --verbose BOOLEAN – Be verbose
  • -h, --help – Print help

11.30. fact

Search facts

Usage

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

Options

  • -h, --help – Print help

11.30.1. fact list

List all fact values

Usage

# hammer fact <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 11.83. Predefined field sets
FIELDSALLDEFAULT

Host

x

x

Fact

x

x

Value

x

x

Search / Order fields

  • fact – string
  • fact_short_name – string
  • facts – string
  • host – string
  • host.hostgroup – string
  • host_id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
  • origin – string
  • reported_at – datetime
  • short_name – string
  • type – string
  • value – string

11.31. file

Manipulate files

Usage

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

Options

  • -h, --help – Print help

11.31.1. file info

Show a file

Usage

# hammer file <info|show> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER Content view version identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A file identifier
  • --name VALUE – File 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.84. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

 

Name

x

x

x

Path

x

x

 

Uuid

x

x

 

Checksum

x

x

 

11.31.2. file list

List files

Usage

# hammer file <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content view filter identifier
  • --content-view-filter-rule VALUE – Name to search by
  • --content-view-filter-rule-id NUMBER Content view filter rule identifier
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content view version identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --ids LIST – Ids to filter content by
  • --include-filter-ids BOOLEAN – Includes associated content view filter ids in response
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.85. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

 

Name

x

x

x

Path

x

x

 

11.32. filter

Manage permission filters

Usage

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

Options

  • -h, --help – Print help

11.32.1. filter available-permissions

List all permissions

Usage

# hammer filter available-permissions [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 11.86. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Resource

x

x

 

Search / Order fields

  • id – integer
  • name – string
  • resource_type – string

11.32.2. filter available-resources

List available resource types

Usage

# hammer filter available-resources [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
  • --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 11.87. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

11.32.3. filter create

Create a filter

Usage

# hammer filter 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-ids LIST
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --override BOOLEAN
  • --permission-ids LIST
  • --permissions LIST
  • --role VALUE – User role name
  • --role-id VALUE
  • --search VALUE
  • -h, --help – Print help

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

11.32.4. filter delete

Delete a filter

Usage

# hammer filter <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
  • --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

11.32.5. filter info

Show a filter

Usage

# hammer filter <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 11.88. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Resource type

x

x

 

Search

x

x

 

Unlimited?

x

x

 

Override?

x

x

 

Role

x

x

 

Permissions

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.32.6. filter list

List all filters

Usage

# hammer filter <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 11.89. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Resource type

x

x

 

Search

x

x

 

Unlimited?

x

x

 

Override?

x

x

 

Role

x

x

 

Permissions

x

x

 

Search / Order fields

  • id – integer
  • limited – Values: true, false
  • location – string
  • location_id – integer
  • organization – string
  • organization_id – integer
  • override – Values: true, false
  • permission – string
  • resource – string
  • role – string
  • role_id – integer
  • search – text
  • unlimited – Values: true, false

11.32.7. filter update

Update a filter

Usage

# hammer filter 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
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --override BOOLEAN
  • --permission-ids LIST
  • --permissions LIST
  • --role VALUE – User role name
  • --role-id VALUE
  • --search VALUE
  • -h, --help – Print help

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

11.33. foreign-input-set

Manage foreign input sets

Usage

# hammer foreign-input-set [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.33.1. foreign-input-set create

Create a foreign input set

Usage

# hammer foreign-input-set create [OPTIONS]

Options

  • --description VALUE – Input set description
  • --exclude VALUE – A comma separated list of input names to be included from the foreign template.
  • --include VALUE – A comma separated list of input names to be included from the foreign template.
  • --include-all BOOLEAN – Include all inputs from the foreign template
  • --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
  • --target-template-id VALUE – Target template ID
  • --template-id VALUE
  • -h, --help – Print help

11.33.2. foreign-input-set delete

Delete a foreign input set

Usage

# hammer foreign-input-set <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
  • --template-id VALUE
  • -h, --help – Print help

11.33.3. foreign-input-set info

Show foreign input set details

Usage

# hammer foreign-input-set <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
  • --template-id VALUE
  • -h, --help – Print help
Table 11.90. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Target template id

x

x

 

Target template name

x

x

 

Include all

x

x

 

Include

x

x

 

Exclude

x

x

 

11.33.4. foreign-input-set list

List foreign input sets

Usage

# hammer foreign-input-set <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
  • --template-id VALUE
  • -h, --help – Print help
Table 11.91. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Target template id

x

x

Target template name

x

x

11.33.5. foreign-input-set update

Update a foreign input set

Usage

# hammer foreign-input-set update [OPTIONS]

Options

  • --description VALUE – Input set description
  • --exclude VALUE – A comma separated list of input names to be included from the foreign template.
  • --id VALUE
  • --include VALUE – A comma separated list of input names to be included from the foreign template.
  • --include-all BOOLEAN – Include all inputs from the foreign template
  • --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
  • --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
  • --target-template-id VALUE – Target template ID
  • --template-id VALUE
  • -h, --help – Print help

11.34. full-help

Print help for all hammer commands

Usage

# hammer full-help [OPTIONS]

Options

  • --md – Format output in markdown
  • -h, --help – Print help

11.35. global-parameter

Manipulate global parameters

Usage

# hammer global-parameter [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.35.1. global-parameter delete

Delete a global parameter

Usage

# hammer global-parameter <delete|destroy> [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 – Common parameter 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

11.35.2. global-parameter list

List all global parameters

Usage

# hammer global-parameter <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
  • --show-hidden BOOLEAN – Display hidden values
  • -h, --help – Print help
Table 11.92. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

Value

x

x

 

Type

x

x

 

Search / Order fields

  • domain_name – string
  • host_group_name – string
  • host_name – string
  • id – integer
  • key_type – string
  • location_name – string
  • name – string
  • organization_name – string
  • os_name – string
  • parameter_type – string
  • subnet_name – text
  • type – string
  • value – text

11.35.3. global-parameter set

Set a global parameter

Usage

# hammer global-parameter set [OPTIONS]

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --name VALUE – Parameter name
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.36. host

Manipulate hosts

Usage

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

Options

  • -h, --help – Print help

11.36.1. host ansible-roles

Manage Ansible roles on a host

Usage

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

Options

  • -h, --help – Print help
11.36.1.1. host ansible-roles add

Associate an Ansible role

Usage

# hammer host ansible-roles add [OPTIONS]

Options

  • --ansible-role VALUE – Name to search by
  • --ansible-role-id NUMBER
  • --force – Associate the Ansible role even if it already is associated indirectly
  • --id VALUE
  • --name VALUE – Host name
  • -h, --help – Print help
11.36.1.2. host ansible-roles assign

Assigns Ansible roles to a host

Usage

# hammer host ansible-roles assign [OPTIONS]

Options

  • --ansible-role-ids LIST – Ansible roles to assign to a host
  • --ansible-roles LIST
  • --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 – Host 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
11.36.1.3. host ansible-roles list

List all Ansible roles for a host

Usage

# hammer host ansible-roles <list|index> [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 – Host 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 11.93. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Imported at

x

x

 

Inherited

x

x

 

Directly assigned

x

x

 
11.36.1.4. host ansible-roles play

Runs all Ansible roles on a host

Usage

# hammer host ansible-roles play [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 – Host 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
11.36.1.5. host ansible-roles remove

Disassociate an Ansible role

Usage

# hammer host ansible-roles remove [OPTIONS]

Options

  • --ansible-role VALUE – Name to search by
  • --ansible-role-id NUMBER
  • --id VALUE
  • --name VALUE – Host name
  • -h, --help – Print help

11.36.2. host boot

Boot host from specified device

Usage

# hammer host boot [OPTIONS]

Options

  • --device VALUE – Boot device, valid devices are disk, cdrom, pxe, bios
  • --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 – Host 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

11.36.3. host config-reports

List all reports

Usage

# hammer host config-reports [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – Host 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
  • --name VALUE – Host name
  • --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 11.94. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Host

x

x

 

Last report

x

x

 

Origin

x

x

 

Applied

x

x

 

Restarted

x

x

 

Failed

x

x

 

Restart failures

x

x

 

Skipped

x

x

 

Pending

x

x

 

Search / Order fields

  • applied – integer
  • eventful – Values: true, false
  • failed – integer
  • failed_restarts – integer
  • host – string
  • host_id – integer
  • host_owner_id – integer
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_title – string
  • id – integer
  • last_report – datetime
  • location – string
  • log – text
  • organization – string
  • origin – string
  • pending – integer
  • reported – datetime
  • resource – text
  • restarted – integer
  • skipped – integer

11.36.4. host create

Create a host

Usage

# hammer host create [OPTIONS]

Options

  • --ansible-role-ids LIST – IDs of associated ansible roles
  • --ansible-roles LIST
  • --architecture VALUE – Architecture name
  • --architecture-id NUMBER – Required if host is managed and value is not inherited from host group
  • --ask-root-password BOOLEAN
  • --autoheal BOOLEAN – Sets whether the Host will autoheal subscriptions upon checkin
  • --build BOOLEAN
  • --comment VALUE – Additional information about this host
  • --compute-attributes KEY_VALUE_LIST – Compute resource attributes
  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id NUMBER
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id NUMBER – Nil means host is bare metal
  • --content-source VALUE – Content Source name
  • --content-source-id NUMBER – Id of the capsule from which the host consumes content.
  • --content-view VALUE – Name to search by
  • --content-view-environment-ids LIST – Array of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.
  • --content-view-environments LIST – Comma-separated list of Candlepin environment names to be associated with the host, in the format of lifecycle_environment_label/content_view_label. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.
  • --content-view-id NUMBER – Id of the single content view to be associated with the host.
  • --domain VALUE – Domain name
  • --domain-id NUMBER – Required if host is managed and value is not inherited from host group
  • --enabled BOOLEAN – Include this host within Satellite reporting
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER
  • --hostgroup-title VALUE – Hostgroup title
  • --hypervisor-guest-uuids LIST – List of hypervisor guest uuids
  • --image VALUE – Name to search by
  • --image-id NUMBER
  • --installed-products-attributes SCHEMA List of products installed on the host
  • --interface KEY_VALUE_LIST – Interface parameters Can be specified multiple times.
  • --ip VALUE – Not required if using a subnet with DHCP Capsule
  • --kickstart-repository VALUE – Kickstart repository name
  • --kickstart-repository-id NUMBER – Repository Id associated with the kickstart repo used for provisioning
  • --lifecycle-environment VALUE – Name to search by
  • --lifecycle-environment-id NUMBER – Id of the single lifecycle environment to be associated with the host.
  • --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
  • --mac VALUE – Required for managed host that is bare metal, not required if it`s a virtual machine
  • --managed BOOLEAN – True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not
  • --medium VALUE – Medium name
  • --medium-id VALUE – Required if not imaged based provisioning and host is managed and value is not inherited from host group
  • --model VALUE – Model name
  • --model-id NUMBER
  • --name VALUE
  • --openscap-proxy-id NUMBER – ID of OpenSCAP Capsule
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – Required if host is managed and value is not inherited from host group
  • --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
  • --overwrite BOOLEAN – Default: "true"
  • --owner VALUE – Login of the owner
  • --owner-id VALUE – ID of the owner
  • --owner-type ENUM – Host`s owner type Possible value(s): User, Usergroup
  • --parameters KEY_VALUE_LIST – Replaces with new host parameters
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER – Required if host is managed and custom partition has not been defined
  • --product VALUE – Name to search by
  • --product-id NUMBER – Product id as listed from a host`s installed products, this is not the same product id as the products api returns
  • --progress-report-id VALUE – UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks
  • --provision-method ENUM – The method used to provision the host. Possible value(s): build, image, bootdisk
  • --puppet-ca-proxy-id NUMBER – Puppet CA Capsule ID
  • --puppet-proxy-id NUMBER – Puppet Capsule ID
  • --purpose-addons LIST – Sets the system add-ons
  • --purpose-role VALUE – Sets the system purpose usage
  • --purpose-usage VALUE – Sets the system purpose usage
  • --pxe-loader ENUM – DHCP filename option (Grub2/PXELinux by default) Possible value(s): None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI
  • --realm VALUE – Name to search by
  • --realm-id NUMBER
  • --release-version VALUE – Release version for this Host to use (7Server, 7.1, etc)
  • --root-password VALUE – Required if host is managed and value is not inherited from host group or default password in settings
  • --service-level VALUE – Service level to be used for autoheal
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER – Required if host is managed and value is not inherited from host group
  • --typed-parameters SCHEMA – Replaces with new host parameters (with type support)
  • --volume KEY_VALUE_LIST – Volume parameters Can be specified multiple times.
  • -h, --help – Print help

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

  • --typed-parameters "name=<string>,value=<string>,parameter_type=[string|boolean|integer|real|array|hash|yaml|json],hidden_value=[true|false|1|0], …​ "
  • --installed-products-attributes "product_id=<string>,product_name=<string>,arch=<string>,version=<string>, …​ "

Available keys for --interface: mac ip type Possible values: interface, bmc, bond, bridge name subnet_id domain_id identifier managed true/false primary true/false, each managed hosts needs to have one primary interface. provision true/false virtual true/false

For virtual=true: tag VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. attached_to Identifier of the interface to which this interface belongs, e.g. eth1.

For type=bond: mode Possible values: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2] bond_options

For type=bmc: provider always IPMI username password

Provider specific options

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
    • boot_order – Device names to specify the boot order
    • start – Boolean (expressed as 0 or 1), whether to start the machine or not

OpenStack:

  • --volume:
  • --interface:

  • --compute-attributes:

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

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.
    • start – Boolean, set 1 to start the vm

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 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 type from VMware
      • key – Key of the controller (e.g. 1000)

    • nvme_controllers – List with NVME controllers definitions

      • type – ID of the controller type from VMware
      • key – Key of the controller (e.g. 2000)
    • boot_order – Device names to specify the boot order
    • start – Must be a 1 or 0, whether to start the machine or not

AzureRM:

  • --volume:

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

  • --interface:

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

  • --compute-attributes:

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

GCE:

  • --volume:

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

  • --compute-attributes:

    • machine_type –
    • network –
    • associate_external_ip –

11.36.5. host deb-package

Manage deb packages on your hosts

Usage

# hammer host deb-package [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.36.5.1. host deb-package list

List deb packages installed on the host

Usage

# hammer host deb-package <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
  • --host VALUE – Host name
  • --host-id NUMBER – ID of the host
  • --include-latest-upgradable BOOLEAN Also include the latest upgradable package version for each host package
  • --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
  • --status VALUE – Return only packages of a particular status (upgradable or up-to-date)
  • -h, --help – Print help
Table 11.95. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Version

x

x

 

Arch

x

x

 

Search / Order fields

  • architecture – string
  • id – integer
  • name – string
  • version – string

11.36.6. host delete

Delete a host

Usage

# hammer host <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 – Host 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

11.36.7. host delete-parameter

Delete parameter for a host

Usage

# hammer host delete-parameter [OPTIONS]

Options

  • --host VALUE – Host name
  • --host-id NUMBER
  • --name VALUE – Parameter name
  • -h, --help – Print help

11.36.8. host disassociate

Disassociate a host

Usage

# hammer host disassociate [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 – Host 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

11.36.9. host enc-dump

Dump host’s ENC YAML

Usage

# hammer host enc-dump [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 – Host 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

11.36.10. host errata

Manage errata on your hosts

Usage

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

Options

  • -h, --help – Print help
11.36.10.1. host errata apply

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_errata_install.

Usage

# hammer host errata apply [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_errata_install`.

Unfortunately the server does not support such operation.

11.36.10.2. host errata info

Retrieve a single errata for a host

Usage

# hammer host errata info [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --host VALUE – Host name
  • --host-id NUMBER – Host ID
  • --id VALUE – Errata id of the erratum (RHSA-2012:108)
  • --name VALUE – Name to search by
  • -h, --help – Print help
Table 11.96. Predefined field sets
FIELDSALLDEFAULT

Title

x

x

Version

x

x

Description

x

x

Status

x

x

Id

x

x

Errata id

x

x

Reboot suggested

x

x

Updated

x

x

Issued

x

x

Release

x

x

Solution

x

x

Packages

x

x

Module streams/name

x

x

Module streams/stream

x

x

Module streams/packages

x

x

11.36.10.3. host errata list

List errata available for the content host

Usage

# hammer host errata list [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Calculate Applicable Errata based on a particular Content View
  • --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
  • --host VALUE – Host name
  • --host-id NUMBER – UUID of the content host
  • --include-applicable BOOLEAN – Return errata that are applicable to this host. Defaults to false)
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Calculate Applicable Errata based on a particular Environment
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --search VALUE – Search string
  • --severity VALUE – Return only errata of a particular severity (None, Low, Moderate, Important, Critical)
  • --type VALUE – Return only errata of a particular type (security, bugfix, enhancement)
  • -h, --help – Print help
Table 11.97. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Erratum id

x

x

Type

x

x

Title

x

x

Installable

x

x

11.36.10.4. host errata recalculate

Force regenerate applicability.

Usage

# hammer host errata recalculate [OPTIONS]

Options

  • --host VALUE – Host name
  • --host-id NUMBER – Host ID
  • -h, --help – Print help

11.36.11. host facts

List all fact values

Usage

# hammer host facts [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 – Host name
  • --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 11.98. Predefined field sets
FIELDSALLDEFAULT

Fact

x

x

Value

x

x

Search / Order fields

  • fact – string
  • fact_short_name – string
  • facts – string
  • host – string
  • host.hostgroup – string
  • host_id – integer
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
  • origin – string
  • reported_at – datetime
  • short_name – string
  • type – string
  • value – string

11.36.12. host info

Show a host

Usage

# hammer host <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 – Host 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
  • --show-hidden-parameters BOOLEAN Display hidden parameter values
  • -h, --help – Print help
Table 11.99. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Uuid

x

x

 

Name

x

x

x

Organization

x

x

 

Location

x

x

 

Host group

x

x

 

Compute resource

x

x

 

Compute profile

x

x

 

Cert name

x

x

 

Token

x

x

 

Managed

x

x

 

Installed at

x

x

 

Last report

x

x

 

Uptime (seconds)

x

x

 

Status/global status

x

x

 

Status/build status

x

x

 

Network/ipv4 address

x

x

 

Network/ipv6 address

x

x

 

Network/mac

x

x

 

Network/subnet ipv4

x

x

 

Network/subnet ipv6

x

x

 

Network/domain

x

x

 

Network/service provider/sp name

x

x

 

Network/service provider/sp ip

x

x

 

Network/service provider/sp mac

x

x

 

Network/service provider/sp subnet

x

x

 

Network interfaces/id

x

x

 

Network interfaces/identifier

x

x

 

Network interfaces/type

x

x

 

Network interfaces/mac address

x

x

 

Network interfaces/ipv4 address

x

x

 

Network interfaces/ipv6 address

x

x

 

Network interfaces/fqdn

x

x

 

Operating system/architecture

x

x

 

Operating system/operating system

x

x

 

Operating system/build

x

x

 

Operating system/medium

x

x

 

Operating system/partition table

x

x

 

Operating system/pxe loader

x

x

 

Operating system/custom partition table

x

x

 

Operating system/image

x

x

 

Operating system/image file

x

x

 

Operating system/use image

x

x

 

Parameters/

x

x

 

All parameters/

x

x

 

Additional info/owner

x

x

 

Additional info/owner id

x

x

 

Additional info/owner type

x

x

 

Additional info/enabled

x

x

 

Additional info/model

x

x

 

Additional info/comment

x

x

 

Openscap proxy

x

x

 

Content information/content view environments/content view/id

x

x

 

Content information/content view environments/content view/name

x

x

 

Content information/content view environments/content view/composite

x

x

 

Content information/content view environments/lifecycle environment/id

x

x

 

Content information/content view environments/lifecycle environment/name

x

x

 

Content information/content source/id

x

x

 

Content information/content source/name

x

x

 

Content information/kickstart repository/id

x

x

 

Content information/kickstart repository/name

x

x

 

Content information/applicable packages

x

x

 

Content information/upgradable packages

x

x

 

Content information/applicable errata/enhancement

x

x

 

Content information/applicable errata/bug fix

x

x

 

Content information/applicable errata/security

x

x

 

Subscription information/uuid

x

x

 

Subscription information/last checkin

x

x

 

Subscription information/release version

x

x

 

Subscription information/autoheal

x

x

 

Subscription information/registered to

x

x

 

Subscription information/registered at

x

x

 

Subscription information/registered by activation keys/

x

x

 

Subscription information/system purpose/service level

x

x

 

Subscription information/system purpose/purpose usage

x

x

 

Subscription information/system purpose/purpose role

x

x

 

Subscription information/system purpose/purpose addons

x

x

 

Trace status

x

x

 

Host collections/id

x

x

 

Host collections/name

x

x

 

11.36.13. host interface

View and manage host’s network interfaces

Usage

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

Options

  • -h, --help – Print help
11.36.13.1. host interface create

Create an interface on a host

Usage

# hammer host interface create [OPTIONS]

Options

  • --attached-devices LIST – Identifiers of attached interfaces, e.g. [`eth1, eth2]`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.
  • --attached-to VALUE – Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.
  • --bond-options VALUE – Space separated options, e.g. miimon=100. Only for bond interfaces.
  • --compute-attributes KEY_VALUE_LIST Compute resource specific attributes
  • --domain VALUE – Domain name
  • --domain-id NUMBER – Satellite domain ID of interface. Required for primary interfaces on managed hosts.
  • --execution BOOLEAN – Should this interface be used for remote execution?
  • --host VALUE – Host name
  • --host-id VALUE – ID or name of host
  • --identifier VALUE – Device identifier, e.g. eth0 or eth1.1
  • --ip VALUE – IPv4 address of interface
  • --ip6 VALUE – IPv6 address of interface
  • --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
  • --mac VALUE – MAC address of interface. Required for managed interfaces on bare metal.
  • --managed BOOLEAN – Should this interface be managed via DHCP and DNS capsule and should it be configured during provisioning?
  • --mode ENUM – Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Possible value(s): balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb
  • --mtu NUMBER – MTU, this attribute has precedence over the subnet MTU.
  • --name VALUE – Interface`s DNS 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
  • --password VALUE – Only for BMC interfaces.
  • --primary – Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface
  • --provider ENUM – Interface provider, e.g. IPMI. Only for BMC interfaces. Possible value(s): IPMI, Redfish, SSH
  • --provision – Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER – Satellite subnet ID of IPv4 interface
  • --subnet6-id NUMBER – Satellite subnet ID of IPv6 interface
  • --tag VALUE – VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.
  • --type ENUM – Interface type, e.g. bmc. Default is interface Possible value(s): interface, bmc, bond, bridge
  • --username VALUE – Only for BMC interfaces.
  • --virtual BOOLEAN – Alias or VLAN device
  • -h, --help – Print help
11.36.13.2. host interface delete

Delete a host’s interface

Usage

# hammer host interface <delete|destroy> [OPTIONS]

Options

  • --host VALUE – Host name
  • --host-id VALUE – ID or name of host
  • --id VALUE – ID of interface
  • --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
11.36.13.3. host interface info

Show an interface for host

Usage

# hammer host interface <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --host VALUE – Host name
  • --host-id VALUE – ID or name of host
  • --id VALUE – ID or name of interface
  • --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 11.100. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Identifier

x

x

 

Type

x

x

 

Mac address

x

x

 

Ip address

x

x

 

Dns name

x

x

 

Subnet

x

x

 

Domain

x

x

 

Managed

x

x

 

Primary

x

x

 

Provision

x

x

 

Virtual

x

x

 

Tag

x

x

 

Attached to

x

x

 

Bmc/username

x

x

 

Bmc/provider

x

x

 

Bond/mode

x

x

 

Bond/attached devices

x

x

 

Bond/bond options

x

x

 

Execution

x

x

 
11.36.13.4. host interface list

List all interfaces for host

Usage

# hammer host interface <list|index> [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id VALUE – ID or name of domain
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --host VALUE – Host name
  • --host-id VALUE – ID or name of host
  • --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
  • --page NUMBER – Page number, starting at 1
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --subnet VALUE – Subnet name
  • --subnet-id VALUE – ID or name of subnet
  • -h, --help – Print help
Table 11.101. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Identifier

x

x

 

Type

x

x

 

Mac address

x

x

 

Ip address

x

x

 

Dns name

x

x

 
11.36.13.5. host interface update

Update a host’s interface

Usage

# hammer host interface update [OPTIONS]

Options

  • --attached-devices LIST – Identifiers of attached interfaces, e.g. [`eth1, eth2]`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.
  • --attached-to VALUE – Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.
  • --bond-options VALUE – Space separated options, e.g. miimon=100. Only for bond interfaces.
  • --compute-attributes KEY_VALUE_LIST Compute resource specific attributes
  • --domain VALUE – Domain name
  • --domain-id NUMBER – Satellite domain ID of interface. Required for primary interfaces on managed hosts.
  • --execution BOOLEAN – Should this interface be used for remote execution?
  • --host VALUE – Host name
  • --host-id VALUE – ID or name of host
  • --id VALUE – ID of interface
  • --identifier VALUE – Device identifier, e.g. eth0 or eth1.1
  • --ip VALUE – IPv4 address of interface
  • --ip6 VALUE – IPv6 address of interface
  • --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
  • --mac VALUE – MAC address of interface. Required for managed interfaces on bare metal.
  • --managed BOOLEAN – Should this interface be managed via DHCP and DNS capsule and should it be configured during provisioning?
  • --mode ENUM – Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Possible value(s): balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb
  • --mtu NUMBER – MTU, this attribute has precedence over the subnet MTU.
  • --name VALUE – Interface`s DNS 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
  • --password VALUE – Only for BMC interfaces.
  • --primary – Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface
  • --provider ENUM – Interface provider, e.g. IPMI. Only for BMC interfaces. Possible value(s): IPMI, Redfish, SSH
  • --provision – Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER – Satellite subnet ID of IPv4 interface
  • --subnet6-id NUMBER – Satellite subnet ID of IPv6 interface
  • --tag VALUE – VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.
  • --type ENUM – Interface type, e.g. bmc. Default is interface Possible value(s): interface, bmc, bond, bridge
  • --username VALUE – Only for BMC interfaces.
  • --virtual BOOLEAN – Alias or VLAN device
  • -h, --help – Print help

11.36.14. host list

List all hosts

Usage

# hammer host <list|index> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id VALUE – ID of host group
  • --hostgroup-title VALUE – Hostgroup title
  • --location VALUE – Set the current location context for the request
  • --location-id VALUE – ID of location
  • --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 VALUE – ID of organization
  • --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
  • --thin BOOLEAN – Only list ID and name of hosts
  • -h, --help – Print help
Table 11.102. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Operating system

x

x

 

Host group

x

x

 

Ip

x

x

 

Mac

x

x

 

Global status

x

x

 

Organization

x

  

Location

x

  

Additional information

x

  

Content view

x

x

 

Lifecycle environment

x

x

 

Security

x

  

Bugfix

x

  

Enhancement

x

  

Trace status

x

x

 

Search / Order fields

  • activation_key – string
  • activation_key_id – string
  • addon – string
  • applicable_debs – string
  • applicable_errata – string
  • applicable_errata_issued – date
  • applicable_rpms – string
  • architecture – string
  • autoheal – boolean
  • boot_time
  • build – Values: true, false
  • build_status – Values: built, pending, token_expired, build_failed
  • comment – text
  • compute_resource – string
  • compute_resource_id – integer
  • configuration_status.applied – integer
  • configuration_status.enabled – Values: true, false
  • configuration_status.failed – integer
  • configuration_status.failed_restarts – integer
  • configuration_status.interesting – Values: true, false
  • configuration_status.pending – integer
  • configuration_status.restarted – integer
  • configuration_status.skipped – integer
  • content_source – string
  • content_views – string
  • convert2rhel_through_foreman integer
  • created_at – datetime
  • domain – string
  • domain_id – integer
  • errata_status – Values: security_needed, errata_needed, updated, unknown
  • execution_status – Values: ok, error
  • facts – string
  • global_status – Values: ok, warning, error
  • has_ip – string
  • has_ip6 string
  • has_mac – string
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_id – integer
  • hostgroup_name – string
  • hostgroup_title – string
  • hypervisor – boolean
  • hypervisor_host – string
  • id – integer
  • image – string
  • infrastructure_facet.foreman – Values: true, false
  • infrastructure_facet.smart_proxy_id
  • insights_client_report_status – Values: reporting, no_report
  • insights_inventory_sync_status – Values: disconnect, sync
  • insights_recommendations_count – integer
  • installable_errata – string
  • installed_at – datetime
  • ip – string
  • ip6 string
  • job_invocation.id – string
  • job_invocation.result – Values: cancelled, failed, pending, success
  • last_checkin – datetime
  • last_report – datetime
  • lifecycle_environments – string
  • location – string
  • location_id – integer
  • mac – string
  • managed – Values: true, false
  • model – string
  • name – string
  • organization – string
  • organization_id – integer
  • origin – string
  • os – string
  • os_description – string
  • os_id – integer
  • os_major – string
  • os_minor – string
  • os_title – string
  • owner – string
  • owner_id – integer
  • owner_type – string
  • params – string
  • params_name – string
  • parent_hostgroup – string
  • puppet_ca – string
  • puppet_proxy_id – integer
  • puppetmaster – string
  • pxe_loader – Values: PXELinux_BIOS, PXELinux_UEFI, Grub_UEFI, Grub2_BIOS, Grub2_ELF, Grub2_UEFI, Grub2_UEFI_SecureBoot, Grub2_UEFI_HTTP, Grub2_UEFI_HTTPS, Grub2_UEFI_HTTPS_SecureBoot, iPXE_Embedded, iPXE_UEFI_HTTP, iPXE_Chain_BIOS, iPXE_Chain_UEFI
  • realm – string
  • realm_id – integer
  • registered_at – datetime
  • registered_through – string
  • release_version – string
  • reported.bios_release_date
  • reported.bios_vendor
  • reported.bios_version
  • reported.boot_time
  • reported.cores
  • reported.disks_total
  • reported.kernel_version
  • reported.ram
  • reported.sockets
  • reported.virtual – Values: true, false
  • repository – string
  • repository_content_label – string
  • rhel_lifecycle_status – Values: full_support, maintenance_support, approaching_end_of_maintenance, extended_support, approaching_end_of_support, support_ended
  • role – text
  • service_level – string
  • smart_proxy – string
  • status.applied – integer
  • status.enabled – Values: true, false
  • status.failed – integer
  • status.failed_restarts – integer
  • status.interesting – Values: true, false
  • status.pending – integer
  • status.restarted – integer
  • status.skipped – integer
  • subnet – string
  • subnet.name – text
  • subnet6 string
  • subnet6.name text
  • subscription_id – string
  • subscription_name – string
  • subscription_uuid – string
  • trace_status – Values: reboot_needed, process_restart_needed, updated
  • upgradable_debs – string
  • upgradable_rpms – string
  • usage – text
  • user.firstname – string
  • user.lastname – string
  • user.login – string
  • user.mail – string
  • usergroup – string
  • usergroup.name – string
  • uuid – string

11.36.15. host package

Manage packages on your hosts

Usage

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

Options

  • -h, --help – Print help
11.36.15.1. host package install

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_package_install.

Usage

# hammer host package install [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_package_install`.

Unfortunately the server does not support such operation.

11.36.15.2. host package list

List packages installed on the host

Usage

# hammer host package <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
  • --host VALUE – Host name
  • --host-id NUMBER – ID of the host
  • --include-latest-upgradable BOOLEAN Also include the latest upgradable package version for each host package
  • --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
  • --status VALUE – Return only packages of a particular status (upgradable or up-to-date)
  • -h, --help – Print help
Table 11.103. Predefined field sets
FIELDSALLDEFAULT

Nvra

x

x

Search / Order fields

  • arch – string
  • epoch – string
  • id – integer
  • name – string
  • nvra – string
  • nvrea – string
  • release – string
  • vendor – string
  • version – string
11.36.15.3. host package remove

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_package_remove.

Usage

# hammer host package remove [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_package_remove`.

Unfortunately the server does not support such operation.

11.36.15.4. host package upgrade

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_package_update.

Usage

# hammer host package upgrade [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_package_update`.

Unfortunately the server does not support such operation.

11.36.15.5. host package upgrade-all

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_package_update.

Usage

# hammer host package upgrade-all [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_package_update`.

Unfortunately the server does not support such operation.

11.36.16. host package-group

Manage package-groups on your hosts. These commands are no longer available

Use the remote execution equivalent

Usage

# hammer host package-group [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.36.16.1. host package-group install

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_group_install.

Usage

# hammer host package-group install [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_group_install`.

Unfortunately the server does not support such operation.

11.36.16.2. host package-group remove

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_group_remove.

Usage

# hammer host package-group remove [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_group_remove`.

Unfortunately the server does not support such operation.

11.36.17. host policies-enc

View policies ENC for host

Usage

# hammer host policies-enc [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – The identifier of the host
  • --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 – Host 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 11.104. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Profile id

x

x

Content path

x

x

Content download path

x

x

Tailoring path

x

x

Tailoring download path

x

x

Day of month

x

x

Hour

x

x

Minute

x

x

Month

x

x

Week

x

x

11.36.18. host reboot

Reboot a host

Usage

# hammer host reboot [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 – Host 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

11.36.19. host rebuild-config

Rebuild orchestration related configurations for host

Usage

# hammer host rebuild-config [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 – Host name
  • --only LIST – Limit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status
  • --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

11.36.20. host reports

List all reports

Usage

# hammer host reports [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – Host 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
  • --name VALUE – Host name
  • --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 11.105. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Host

x

x

 

Last report

x

x

 

Origin

x

x

 

Applied

x

x

 

Restarted

x

x

 

Failed

x

x

 

Restart failures

x

x

 

Skipped

x

x

 

Pending

x

x

 

Search / Order fields

  • applied – integer
  • eventful – Values: true, false
  • failed – integer
  • failed_restarts – integer
  • host – string
  • host_id – integer
  • host_owner_id – integer
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_title – string
  • id – integer
  • last_report – datetime
  • location – string
  • log – text
  • organization – string
  • origin – string
  • pending – integer
  • reported – datetime
  • resource – text
  • restarted – integer
  • skipped – integer

11.36.21. host reset

Reset a host

Usage

# hammer host reset [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 – Host 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

11.36.22. host set-parameter

Create or append a parameter for a host

Usage

# hammer host set-parameter [OPTIONS]

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --host VALUE – Host name
  • --host-id NUMBER
  • --name VALUE – Parameter name
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.36.23. host start

Power a host on

Usage

# hammer host start [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 – Host 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

11.36.24. host status

Get status of host

Usage

# hammer host status [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 – Host 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
  • --type ENUM – Status type, can be one of

Global

Configuration

Build Possible value(s): HostStatus::Global, configuration, build * -h, --help – Print help

11.36.25. host stop

Power a host off

Usage

# hammer host stop [OPTIONS]

Options

  • --force – Force turning off a 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
  • --name VALUE – Host 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

11.36.26. host subscription

Manage subscription information on your hosts

Usage

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

Options

  • -h, --help – Print help
11.36.26.1. host subscription attach

Add a subscription to a host

Usage

# hammer host subscription attach [OPTIONS]

Options

  • --host VALUE – Host name
  • --host-id NUMBER – Id of the host
  • --quantity VALUE – Quantity of this subscriptions to add. Defaults to 1
  • --subscription-id VALUE – ID of subscription
  • -h, --help – Print help
11.36.26.2. host subscription auto-attach

Trigger an auto-attach of subscriptions

Usage

# hammer host subscription auto-attach [OPTIONS]

Options

  • --host VALUE – Host name
  • --host-id NUMBER – Id of the host
  • -h, --help – Print help
11.36.26.3. host subscription content-override

Override product content defaults

Usage

# hammer host subscription content-override [OPTIONS]

Options

  • --content-label VALUE – Label of the content
  • --enabled BOOLEAN – Set true to override to enabled; Set false to override to disabled.`
  • --full-result BOOLEAN – Whether or not to show all results
  • --host VALUE – Host name
  • --host-id VALUE – Id of the content host
  • --limit-to-env BOOLEAN – Limit actions to content in the host`s environment.
  • --order VALUE – Sort field and order, eg. id DESC
  • --override-name VALUE – Override parameter key or name. To enable or disable a repo select enabled. Default value: enabled Default: "enabled"
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --remove – Remove a content override
  • --search VALUE – Search string
  • --sort-by VALUE – Field to sort the results on
  • --sort-order VALUE – How to order the sorted results (e.g. ASC for ascending)
  • --value VALUE – Override value. Note for repo enablement you can use a boolean value
  • -h, --help – Print help
11.36.26.4. host subscription enabled-repositories

Show repositories enabled on the host that are known to Katello

Usage

# hammer host subscription enabled-repositories [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --host VALUE – Host name
  • --host-id VALUE – Id of host
  • -h, --help – Print help
Table 11.106. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Label

x

x

 

Content type

x

x

 

Checksum

x

x

 

Content view id

x

x

 

Content view name

x

x

 

Content view version

x

x

 

Environment name

x

x

 

Product name

x

x

 
11.36.26.5. host subscription product-content

List associated products

Usage

# hammer host subscription 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 host`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
  • --host VALUE – Host name
  • --host-id VALUE – Id of the host
  • --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 11.107. 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

 
11.36.26.6. host subscription register

Register a host with subscription and information

Usage

# hammer host subscription register [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content View ID
  • --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)
  • --hypervisor-guest-uuids LIST – UUIDs of the virtual guests from the host`s hypervisor
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER Lifecycle Environment ID
  • --name VALUE – Name of the host
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --release-version VALUE – Release version of the content host
  • --service-level VALUE – A service level for auto-healing process, e.g. SELF-SUPPORT
  • --uuid VALUE – UUID to use for registered host, random uuid is generated if not provided
  • -h, --help – Print help
11.36.26.7. host subscription remove

Remove subscriptions from a host

Usage

# hammer host subscription remove [OPTIONS]

Options

  • --host VALUE – Host name
  • --host-id NUMBER – Id of the host
  • --quantity VALUE – Remove the first instance of a subscription with matching id and quantity
  • --subscription-id VALUE – ID of subscription
  • -h, --help – Print help
11.36.26.8. host subscription unregister

Unregister the host as a subscription consumer

Usage

# hammer host subscription unregister [OPTIONS]

Options

  • --host VALUE – Host name
  • --host-id NUMBER – Id of the host
  • -h, --help – Print help

11.36.27. host traces

List traces on your hosts

Usage

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

Options

  • -h, --help – Print help
11.36.27.1. host traces list

List services that need restarting on the host

Usage

# hammer host traces list [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --host VALUE – Host name
  • --host-id NUMBER – ID of the host
  • -h, --help – Print help
Table 11.108. Predefined field sets
FIELDSALLDEFAULT

Trace id

x

x

Application

x

x

Helper

x

x

Type

x

x

11.36.27.2. host traces resolve

Resolve traces

Usage

# hammer host traces resolve [OPTIONS]

Options

  • --async – Do not wait for the task
  • --host VALUE – Host name
  • --host-id NUMBER – ID of the host
  • --trace-ids LIST – Array of Trace IDs
  • -h, --help – Print help

11.36.28. host update

Update a host

Usage

# hammer host update [OPTIONS]

Options

  • --ansible-role-ids LIST – IDs of associated ansible roles
  • --ansible-roles LIST
  • --architecture VALUE – Architecture name
  • --architecture-id NUMBER – Required if host is managed and value is not inherited from host group
  • --ask-root-password BOOLEAN
  • --autoheal BOOLEAN – Sets whether the Host will autoheal subscriptions upon checkin
  • --build BOOLEAN
  • --comment VALUE – Additional information about this host
  • --compute-attributes KEY_VALUE_LIST – Compute resource attributes
  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id NUMBER
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id NUMBER – Nil means host is bare metal
  • --content-source VALUE – Content Source name
  • --content-source-id NUMBER – Id of the capsule from which the host consumes content.
  • --content-view VALUE – Name to search by
  • --content-view-environment-ids LIST – Array of content view environment ids to be associated with the host. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.
  • --content-view-environments LIST – Comma-separated list of Candlepin environment names to be associated with the host, in the format of lifecycle_environment_label/content_view_label. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.
  • --content-view-id NUMBER – Id of the single content view to be associated with the host.
  • --domain VALUE – Domain name
  • --domain-id NUMBER – Required if host is managed and value is not inherited from host group
  • --enabled BOOLEAN – Include this host within Satellite reporting
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER
  • --hostgroup-title VALUE – Hostgroup title
  • --hypervisor-guest-uuids LIST – List of hypervisor guest uuids
  • --id VALUE
  • --image VALUE – Name to search by
  • --image-id NUMBER
  • --installed-products-attributes SCHEMA List of products installed on the host
  • --interface KEY_VALUE_LIST – Interface parameters Can be specified multiple times.
  • --ip VALUE – Not required if using a subnet with DHCP Capsule
  • --kickstart-repository VALUE – Kickstart repository name
  • --kickstart-repository-id NUMBER – Repository Id associated with the kickstart repo used for provisioning
  • --lifecycle-environment VALUE – Name to search by
  • --lifecycle-environment-id NUMBER – Id of the single lifecycle environment to be associated with the host.
  • --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
  • --mac VALUE – Required for managed host that is bare metal, not required if it`s a virtual machine
  • --managed BOOLEAN – True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not
  • --medium VALUE – Medium name
  • --medium-id VALUE – Required if not imaged based provisioning and host is managed and value is not inherited from host group
  • --model VALUE – Model name
  • --model-id NUMBER
  • --name VALUE
  • --new-location VALUE – Use to update associated location
  • --new-location-id NUMBER – Use to update associated location
  • --new-location-title VALUE – Use to update associated location
  • --new-name VALUE
  • --new-organization VALUE – Use to update associated organization
  • --new-organization-id NUMBER – Use to update associated organization
  • --new-organization-title VALUE – Use to update associated organization
  • --openscap-proxy-id NUMBER – ID of OpenSCAP Capsule
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – Required if host is managed and value is not inherited from host group
  • --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
  • --overwrite BOOLEAN
  • --owner VALUE – Login of the owner
  • --owner-id VALUE – ID of the owner
  • --owner-type ENUM – Host`s owner type Possible value(s): User, Usergroup
  • --parameters KEY_VALUE_LIST – Replaces with new host parameters
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER – Required if host is managed and custom partition has not been defined
  • --product VALUE – Name to search by
  • --product-id NUMBER – Product id as listed from a host`s installed products, this is not the same product id as the products api returns
  • --progress-report-id VALUE – UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks
  • --provision-method ENUM – The method used to provision the host. Possible value(s): build, image, bootdisk
  • --puppet-ca-proxy-id NUMBER – Puppet CA Capsule ID
  • --puppet-proxy-id NUMBER – Puppet Capsule ID
  • --purpose-addons LIST – Sets the system add-ons
  • --purpose-role VALUE – Sets the system purpose usage
  • --purpose-usage VALUE – Sets the system purpose usage
  • --pxe-loader ENUM – DHCP filename option (Grub2/PXELinux by default) Possible value(s): None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI
  • --realm VALUE – Name to search by
  • --realm-id NUMBER
  • --release-version VALUE – Release version for this Host to use (7Server, 7.1, etc)
  • --root-password VALUE – Required if host is managed and value is not inherited from host group or default password in settings
  • --service-level VALUE – Service level to be used for autoheal
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER – Required if host is managed and value is not inherited from host group
  • --typed-parameters SCHEMA – Replaces with new host parameters (with type support)
  • --volume KEY_VALUE_LIST – Volume parameters Can be specified multiple times.
  • -h, --help – Print help

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

  • --typed-parameters "name=<string>,value=<string>,parameter_type=[string|boolean|integer|real|array|hash|yaml|json],hidden_value=[true|false|1|0], …​ "
  • --installed-products-attributes "product_id=<string>,product_name=<string>,arch=<string>,version=<string>, …​ "

Available keys for --interface: mac ip type Possible values: interface, bmc, bond, bridge name subnet_id domain_id identifier managed true/false primary true/false, each managed hosts needs to have one primary interface. provision true/false virtual true/false

For virtual=true: tag VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. attached_to Identifier of the interface to which this interface belongs, e.g. eth1.

For type=bond: mode Possible values: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2] bond_options

For type=bmc: provider always IPMI username password

Provider specific options

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
    • boot_order – Device names to specify the boot order
    • start – Boolean (expressed as 0 or 1), whether to start the machine or not

OpenStack:

  • --volume:
  • --interface:

  • --compute-attributes:

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

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.
    • start – Boolean, set 1 to start the vm

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 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 type from VMware
      • key – Key of the controller (e.g. 1000)

    • nvme_controllers – List with NVME controllers definitions

      • type – ID of the controller type from VMware
      • key – Key of the controller (e.g. 2000)
    • boot_order – Device names to specify the boot order
    • start – Must be a 1 or 0, whether to start the machine or not

AzureRM:

  • --volume:

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

  • --interface:

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

  • --compute-attributes:

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

GCE:

  • --volume:

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

  • --compute-attributes:

    • machine_type –
    • network –
    • associate_external_ip –

11.37. host-collection

Manipulate host collections

Usage

# hammer host-collection [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.37.1. host-collection add-host

Add host to the host collection

Usage

# hammer host-collection add-host [OPTIONS]

Options

  • --host-ids LIST – Array of host ids
  • --hosts LIST
  • --id NUMBER – Id of the host collection
  • --name VALUE – Host collection 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

11.37.2. host-collection copy

Copy a host collection

Usage

# hammer host-collection copy [OPTIONS]

Options

  • --id NUMBER – ID of the host collection
  • --name VALUE – New host collection name
  • --new-name VALUE – New host collection name
  • --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

11.37.3. host-collection create

Create a host collection

Usage

# hammer host-collection create [OPTIONS]

Options

  • --description VALUE
  • --host-ids LIST – List of host ids to replace the hosts in host collection
  • --hosts LIST
  • --max-hosts NUMBER – Maximum number of hosts in the host collection
  • --name VALUE – Host Collection 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
  • --unlimited-hosts – Set hosts max to unlimited
  • -h, --help – Print help

11.37.4. host-collection delete

Destroy a host collection

Usage

# hammer host-collection <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – Id of the host collection
  • --name VALUE – Host collection 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

11.37.5. host-collection erratum

Manage errata on your host collections. These commands are no longer available. Use the remote execution equivalent

Usage

# hammer host-collection erratum [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.37.5.1. host-collection erratum install

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_errata_install. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Usage

# hammer host-collection erratum install [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_errata_install`. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Unfortunately the server does not support such operation.

11.37.6. host-collection hosts

List all hosts

Usage

# hammer host-collection hosts [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id VALUE – ID of host group
  • --hostgroup-title VALUE – Hostgroup title
  • --id VALUE – Host Collection ID
  • --include ENUM – Array of extra information types to include Possible value(s): parameters, all_parameters
  • --location VALUE – Set the current location context for the request
  • --location-id VALUE – ID of location
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Host Collection Name
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – ID of organization
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --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
  • --thin BOOLEAN – Only list ID and name of hosts
  • -h, --help – Print help
Table 11.109. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Security

x

  

Bugfix

x

  

Enhancement

x

  

Search / Order fields

  • activation_key – string
  • activation_key_id – string
  • addon – string
  • applicable_debs – string
  • applicable_errata – string
  • applicable_errata_issued – date
  • applicable_rpms – string
  • architecture – string
  • autoheal – boolean
  • boot_time
  • build – Values: true, false
  • build_status – Values: built, pending, token_expired, build_failed
  • comment – text
  • compute_resource – string
  • compute_resource_id – integer
  • configuration_status.applied – integer
  • configuration_status.enabled – Values: true, false
  • configuration_status.failed – integer
  • configuration_status.failed_restarts – integer
  • configuration_status.interesting – Values: true, false
  • configuration_status.pending – integer
  • configuration_status.restarted – integer
  • configuration_status.skipped – integer
  • content_source – string
  • content_views – string
  • convert2rhel_through_foreman integer
  • created_at – datetime
  • domain – string
  • domain_id – integer
  • errata_status – Values: security_needed, errata_needed, updated, unknown
  • execution_status – Values: ok, error
  • facts – string
  • global_status – Values: ok, warning, error
  • has_ip – string
  • has_ip6 string
  • has_mac – string
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_id – integer
  • hostgroup_name – string
  • hostgroup_title – string
  • hypervisor – boolean
  • hypervisor_host – string
  • id – integer
  • image – string
  • infrastructure_facet.foreman – Values: true, false
  • infrastructure_facet.smart_proxy_id
  • insights_client_report_status – Values: reporting, no_report
  • insights_inventory_sync_status – Values: disconnect, sync
  • insights_recommendations_count – integer
  • installable_errata – string
  • installed_at – datetime
  • ip – string
  • ip6 string
  • job_invocation.id – string
  • job_invocation.result – Values: cancelled, failed, pending, success
  • last_checkin – datetime
  • last_report – datetime
  • lifecycle_environments – string
  • location – string
  • location_id – integer
  • mac – string
  • managed – Values: true, false
  • model – string
  • name – string
  • organization – string
  • organization_id – integer
  • origin – string
  • os – string
  • os_description – string
  • os_id – integer
  • os_major – string
  • os_minor – string
  • os_title – string
  • owner – string
  • owner_id – integer
  • owner_type – string
  • params – string
  • params_name – string
  • parent_hostgroup – string
  • puppet_ca – string
  • puppet_proxy_id – integer
  • puppetmaster – string
  • pxe_loader – Values: PXELinux_BIOS, PXELinux_UEFI, Grub_UEFI, Grub2_BIOS, Grub2_ELF, Grub2_UEFI, Grub2_UEFI_SecureBoot, Grub2_UEFI_HTTP, Grub2_UEFI_HTTPS, Grub2_UEFI_HTTPS_SecureBoot, iPXE_Embedded, iPXE_UEFI_HTTP, iPXE_Chain_BIOS, iPXE_Chain_UEFI
  • realm – string
  • realm_id – integer
  • registered_at – datetime
  • registered_through – string
  • release_version – string
  • reported.bios_release_date
  • reported.bios_vendor
  • reported.bios_version
  • reported.boot_time
  • reported.cores
  • reported.disks_total
  • reported.kernel_version
  • reported.ram
  • reported.sockets
  • reported.virtual – Values: true, false
  • repository – string
  • repository_content_label – string
  • rhel_lifecycle_status – Values: full_support, maintenance_support, approaching_end_of_maintenance, extended_support, approaching_end_of_support, support_ended
  • role – text
  • service_level – string
  • smart_proxy – string
  • status.applied – integer
  • status.enabled – Values: true, false
  • status.failed – integer
  • status.failed_restarts – integer
  • status.interesting – Values: true, false
  • status.pending – integer
  • status.restarted – integer
  • status.skipped – integer
  • subnet – string
  • subnet.name – text
  • subnet6 string
  • subnet6.name text
  • subscription_id – string
  • subscription_name – string
  • subscription_uuid – string
  • trace_status – Values: reboot_needed, process_restart_needed, updated
  • upgradable_debs – string
  • upgradable_rpms – string
  • usage – text
  • user.firstname – string
  • user.lastname – string
  • user.login – string
  • user.mail – string
  • usergroup – string
  • usergroup.name – string
  • uuid – string

11.37.7. host-collection info

Show a host collection

Usage

# hammer host-collection <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Id of the host collection
  • --name VALUE – Host collection 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
  • -h, --help – Print help
Table 11.110. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Limit

x

x

 

Description

x

x

 

Total hosts

x

x

 

11.37.8. host-collection list

List host collections

Usage

# hammer host-collection <list|index> [OPTIONS]

Options

  • --activation-key VALUE – Activation key name to search by
  • --activation-key-id VALUE – Activation key identifier
  • --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 VALUE – Host name
  • --host-id NUMBER – Filter products by host id
  • --name VALUE – Host collection 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 11.111. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Limit

x

x

 

Description

x

x

 

Search / Order fields

  • host – string
  • name – string
  • organization_id – integer

11.37.9. host-collection package

Manage packages on your host collections. These commands are no longer available. Use the remote execution equivalent

Usage

# hammer host-collection package [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.37.9.1. host-collection package install

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_package_install. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Usage

# hammer host-collection package install [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_package_install`. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Unfortunately the server does not support such operation.

11.37.9.2. host-collection package remove

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_package_remove. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Usage

# hammer host-collection package remove [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_package_remove`. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Unfortunately the server does not support such operation.

11.37.9.3. host-collection package update

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_package_update. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Usage

# hammer host-collection package update [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_package_update`. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Unfortunately the server does not support such operation.

11.37.10. host-collection package-group

Manage package-groups on your host collections. These commands are no longer available. Use the remote execution equivalent

Usage

# hammer host-collection package-group [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.37.10.1. host-collection package-group install

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_group_install. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Usage

# hammer host-collection package-group install [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_group_install`. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Unfortunately the server does not support such operation.

11.37.10.2. host-collection package-group remove

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_group_remove. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Usage

# hammer host-collection package-group remove [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_group_remove`. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Unfortunately the server does not support such operation.

11.37.10.3. host-collection package-group update

Not supported. Use the remote execution equivalent hammer job-invocation create --feature katello_group_update. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Usage

# hammer host-collection package-group update [OPTIONS]

Options

  • -h, --help – Unsupported Operation - Use the remote execution equivalent hammer job-invocation create `--feature katello_group_update`. Specify the host collection with the --search-query parameter, e.g. --search-query "host_collection = MyCollection" or --search-query "host_collection_id=6"

Unfortunately the server does not support such operation.

11.37.11. host-collection remove-host

Remove hosts from the host collection

Usage

# hammer host-collection remove-host [OPTIONS]

Options

  • --host-ids LIST – Array of host ids
  • --hosts LIST
  • --id NUMBER – Id of the host collection
  • --name VALUE – Host collection 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

11.37.12. host-collection update

Update a host collection

Usage

# hammer host-collection update [OPTIONS]

Options

  • --description VALUE
  • --host-ids LIST – List of host ids to replace the hosts in host collection
  • --hosts LIST
  • --id NUMBER – Id of the host collection
  • --max-hosts NUMBER – Maximum number of hosts in the host collection
  • --name VALUE – Host Collection name
  • --new-name VALUE – Host Collection name
  • --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
  • --unlimited-hosts – Set hosts max to unlimited
  • -h, --help – Print help

11.38. host-registration

Host Registration

Usage

# hammer host-registration [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.38.1. host-registration generate-command

Generate global registration command

Usage

# hammer host-registration generate-command [OPTIONS]

Options

  • --activation-key VALUE – Activation key for subscription-manager client, required for CentOS and Red Hat Enterprise Linux. For multiple keys use activation_keys param instead.
  • --activation-keys LIST – Activation keys for subscription-manager client, required for CentOS and Red Hat Enterprise Linux. Required only if host group has no activation keys or if you do not provide a host group.
  • --force BOOLEAN – Clear any previous registration and run subscription-manager with –force.
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER – ID of the Host group to register the host in
  • --hostgroup-title VALUE – Hostgroup title
  • --ignore-subman-errors BOOLEAN – Ignore subscription-manager errors for subscription-manager register command
  • --insecure BOOLEAN – Enable insecure argument for the initial curl
  • --jwt-expiration NUMBER – Expiration of the authorization token (in hours), 0 means unlimited.
  • --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 the Operating System to register the host in. Operating system must have a host_init_config template assigned
  • --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
  • --packages VALUE – Packages to install on the host when registered. Can be set by host_packages parameter, example: pkg1 pkg2
  • --remote-execution-interface VALUE – Identifier of the Host interface for Remote execution
  • --repo VALUE – DEPRECATED, use the repo_data param instead.
  • --repo-data SCHEMA – Array with repository URL and corresponding GPG key URL
  • --repo-gpg-key-url VALUE – DEPRECATED, use the repo_data param instead.
  • --setup-insights BOOLEAN – Set host_registration_insights parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems
  • --setup-remote-execution BOOLEAN – Set host_registration_remote_execution parameter for the host. If it is set to true, SSH keys will be installed on the host
  • --setup-remote-execution-pull BOOLEAN Set host_registration_remote_execution_pull parameter for the host. If it is set to true, pull provider client will be deployed on the host
  • --smart-proxy VALUE – Name to search by
  • --smart-proxy-id NUMBER – ID of the Capsule. This Capsule must have enabled both the Templates and Registration features
  • --update-packages BOOLEAN – Update all packages on the host
  • -h, --help – Print help

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

  • --repo-data – "repo=<string>,repo_gpg_key_url=<string>, …​ "

11.39. hostgroup

Manipulate hostgroups

Usage

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

Options

  • -h, --help – Print help

11.39.1. hostgroup ansible-roles

Manage Ansible roles on a hostgroup

Usage

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

Options

  • -h, --help – Print help
11.39.1.1. hostgroup ansible-roles add

Associate an Ansible role

Usage

# hammer hostgroup ansible-roles add [OPTIONS]

Options

  • --ansible-role VALUE – Name to search by
  • --ansible-role-id NUMBER
  • --force – Associate the Ansible role even if it already is associated indirectly
  • --id VALUE
  • --name VALUE – Hostgroup name
  • --title VALUE – Hostgroup title
  • -h, --help – Print help
11.39.1.2. hostgroup ansible-roles assign

Assigns Ansible roles to a hostgroup

Usage

# hammer hostgroup ansible-roles assign [OPTIONS]

Options

  • --ansible-role-ids LIST – Ansible roles to assign to a hostgroup
  • --ansible-roles LIST
  • --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 – Hostgroup 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
  • --title VALUE – Hostgroup title
  • -h, --help – Print help
11.39.1.3. hostgroup ansible-roles list

List all Ansible roles for a hostgroup

Usage

# hammer hostgroup ansible-roles <list|index> [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 – Hostgroup 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
  • --title VALUE – Hostgroup title
  • -h, --help – Print help
Table 11.112. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Imported at

x

x

 

Inherited

x

x

 

Directly assigned

x

x

 
11.39.1.4. hostgroup ansible-roles play

Runs all Ansible roles on a hostgroup

Usage

# hammer hostgroup ansible-roles play [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 – Hostgroup 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
  • --title VALUE – Hostgroup title
  • -h, --help – Print help
11.39.1.5. hostgroup ansible-roles remove

Disassociate an Ansible role

Usage

# hammer hostgroup ansible-roles remove [OPTIONS]

Options

  • --ansible-role VALUE – Name to search by
  • --ansible-role-id NUMBER
  • --id VALUE
  • --name VALUE – Hostgroup name
  • --title VALUE – Hostgroup title
  • -h, --help – Print help

11.39.2. hostgroup create

Create a host group

Usage

# hammer hostgroup create [OPTIONS]

Options

  • --ansible-role-ids LIST – IDs of associated ansible roles
  • --ansible-roles LIST
  • --architecture VALUE – Architecture name
  • --architecture-id NUMBER – Architecture ID
  • --ask-root-password BOOLEAN
  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id NUMBER – Compute profile ID
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id NUMBER – Compute resource ID
  • --content-source VALUE – Content Source name
  • --content-source-id NUMBER – Content source ID
  • --content-view VALUE – Name to search by
  • --content-view-id NUMBER – Content view ID
  • --description VALUE – Host group description
  • --domain VALUE – Domain name
  • --domain-id NUMBER – Domain ID
  • --group-parameters-attributes SCHEMA Array of parameters
  • --kickstart-repository VALUE – Kickstart repository name
  • --kickstart-repository-id NUMBER – Kickstart repository ID
  • --lifecycle-environment VALUE – Name to search by
  • --lifecycle-environment-id NUMBER – Lifecycle environment ID
  • --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
  • --medium VALUE – Medium name
  • --medium-id NUMBER – Media ID
  • --name VALUE – Name of the host group
  • --openscap-proxy-id NUMBER – ID of OpenSCAP Capsule
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – Operating system ID
  • --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
  • --parent VALUE – Name of parent hostgroup
  • --parent-id NUMBER – Parent ID of the host group
  • --parent-title VALUE – Title of parent hostgroup
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER – Partition table ID
  • --puppet-ca-proxy-id NUMBER – Puppet CA Capsule ID
  • --puppet-proxy-id NUMBER – Puppet Capsule ID
  • --pxe-loader ENUM – DHCP filename option (Grub2/PXELinux by default) Possible value(s): None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI
  • --query-organization VALUE – Organization name to search by
  • --query-organization-id VALUE – Organization ID to search by
  • --query-organization-label VALUE – Organization label to search by
  • --realm VALUE – Name to search by
  • --realm-id NUMBER – Realm ID
  • --root-password VALUE – Root password
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER – Subnet ID
  • --subnet6 VALUE – Subnet IPv6 name
  • --subnet6-id NUMBER – Subnet IPv6 ID
  • -h, --help – Print help

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

  • --group-parameters-attributes "name=<string>,value=<string>,parameter_type=[string|boolean|integer|real|array|hash|yaml|json],hidden_value=[true|false|1|0], …​ "

11.39.3. hostgroup delete

Delete a host group

Usage

# hammer hostgroup <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 – Hostgroup 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
  • --title VALUE – Hostgroup title
  • -h, --help – Print help

11.39.4. hostgroup delete-parameter

Delete parameter for a hostgroup

Usage

# hammer hostgroup delete-parameter [OPTIONS]

Options

  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER
  • --hostgroup-title VALUE – Hostgroup title
  • --name VALUE – Parameter name
  • -h, --help – Print help

11.39.5. hostgroup info

Show a host group

Usage

# hammer hostgroup <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 – Hostgroup 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
  • --show-hidden-parameters BOOLEAN Display hidden parameter values
  • --title VALUE – Hostgroup title
  • -h, --help – Print help
Table 11.113. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Title

x

x

x

Model

x

x

 

Description

x

x

 

Parent

x

x

 

Compute profile

x

x

 

Compute resource

x

x

 

Network/subnet ipv4

x

x

 

Network/subnet ipv6

x

x

 

Network/realm

x

x

 

Network/domain

x

x

 

Operating system/architecture

x

x

 

Operating system/operating system

x

x

 

Operating system/medium

x

x

 

Operating system/partition table

x

x

 

Operating system/pxe loader

x

x

 

Parameters/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Openscap proxy

x

x

 

Content view/id

x

x

 

Content view/name

x

x

 

Lifecycle environment/id

x

x

 

Lifecycle environment/name

x

x

 

Content source/id

x

x

 

Content source/name

x

x

 

Kickstart repository/id

x

x

 

Kickstart repository/name

x

x

 

11.39.6. hostgroup list

List all host groups

Usage

# hammer hostgroup <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 11.114. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Title

x

x

x

Operating system

x

x

 

Model

x

x

 

Search / Order fields

  • ansible_role – string
  • architecture – string
  • host – string
  • id – integer
  • label – string
  • location – string
  • location_id – integer
  • medium – string
  • name – string
  • organization – string
  • organization_id – integer
  • os – string
  • os_description – string
  • os_id – integer
  • os_major – string
  • os_minor – string
  • os_title – string
  • params – string
  • template – string
  • title – string

11.39.7. hostgroup rebuild-config

Rebuild orchestration config

Usage

# hammer hostgroup rebuild-config [OPTIONS]

Options

  • --children-hosts BOOLEAN – Operate on child hostgroup hosts
  • --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 – Hostgroup name
  • --only LIST – Limit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status
  • --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
  • --title VALUE – Hostgroup title
  • -h, --help – Print help

11.39.8. hostgroup set-parameter

Create or update parameter for a hostgroup

Usage

# hammer hostgroup set-parameter [OPTIONS]

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER
  • --hostgroup-title VALUE – Hostgroup title
  • --name VALUE – Parameter name
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.39.9. hostgroup update

Update a host group

Usage

# hammer hostgroup update [OPTIONS]

Options

  • --ansible-role-ids LIST – IDs of associated ansible roles
  • --ansible-roles LIST
  • --architecture VALUE – Architecture name
  • --architecture-id NUMBER – Architecture ID
  • --ask-root-password BOOLEAN
  • --compute-profile VALUE – Compute profile name
  • --compute-profile-id NUMBER – Compute profile ID
  • --compute-resource VALUE – Compute resource name
  • --compute-resource-id NUMBER – Compute resource ID
  • --content-source VALUE – Content Source name
  • --content-source-id NUMBER – Content source ID
  • --content-view VALUE – Name to search by
  • --content-view-id NUMBER – Content view ID
  • --description VALUE – Host group description
  • --domain VALUE – Domain name
  • --domain-id NUMBER – Domain ID
  • --group-parameters-attributes SCHEMA Array of parameters
  • --id VALUE
  • --kickstart-repository VALUE – Kickstart repository name
  • --kickstart-repository-id NUMBER – Kickstart repository ID
  • --lifecycle-environment VALUE – Name to search by
  • --lifecycle-environment-id NUMBER – Lifecycle environment ID
  • --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
  • --medium VALUE – Medium name
  • --medium-id NUMBER – Media ID
  • --name VALUE – Name of the host group
  • --new-name VALUE – Name of the host group
  • --openscap-proxy-id NUMBER – ID of OpenSCAP Capsule
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER – Operating system ID
  • --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
  • --parent VALUE – Name of parent hostgroup
  • --parent-id NUMBER – Parent ID of the host group
  • --parent-title VALUE – Title of parent hostgroup
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER – Partition table ID
  • --puppet-ca-proxy-id NUMBER – Puppet CA Capsule ID
  • --puppet-proxy-id NUMBER – Puppet Capsule ID
  • --pxe-loader ENUM – DHCP filename option (Grub2/PXELinux by default) Possible value(s): None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI
  • --query-organization VALUE – Organization name to search by
  • --query-organization-id VALUE – Organization ID to search by
  • --query-organization-label VALUE – Organization label to search by
  • --realm VALUE – Name to search by
  • --realm-id NUMBER – Realm ID
  • --root-password VALUE – Root password
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER – Subnet ID
  • --subnet6 VALUE – Subnet IPv6 name
  • --subnet6-id NUMBER – Subnet IPv6 ID
  • --title VALUE – Hostgroup title
  • -h, --help – Print help

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

  • --group-parameters-attributes "name=<string>,value=<string>,parameter_type=[string|boolean|integer|real|array|hash|yaml|json],hidden_value=[true|false|1|0], …​ "

11.40. http-proxy

Manipulate http proxies

Usage

# hammer http-proxy [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.40.1. http-proxy create

Create an HTTP Proxy

Usage

# hammer http-proxy 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-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 – The HTTP Proxy name
  • --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
  • --password VALUE – Password used to authenticate with the HTTP Proxy
  • --url VALUE – URL of the HTTP Proxy
  • --username VALUE – Username used to authenticate with the HTTP Proxy
  • -h, --help – Print help

11.40.2. http-proxy delete

Delete an HTTP Proxy

Usage

# hammer http-proxy <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

11.40.3. http-proxy info

Show an HTTP Proxy

Usage

# hammer http-proxy <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – Identifier of the HTTP Proxy
  • --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 11.115. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Username

x

x

 

Url

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

11.40.4. http-proxy list

List of HTTP Proxies

Usage

# hammer http-proxy <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 11.116. 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
  • url – string

11.40.5. http-proxy update

Update an HTTP Proxy

Usage

# hammer http-proxy 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 – The HTTP Proxy name
  • --new-name VALUE – The HTTP Proxy name
  • --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
  • --password VALUE – Password used to authenticate with the HTTP Proxy
  • --url VALUE – URL of the HTTP Proxy
  • --username VALUE – Username used to authenticate with the HTTP Proxy
  • -h, --help – Print help

11.41. import-templates

Import templates from a git repo or a directory on the server

Usage

# hammer import-templates [OPTIONS]

Options

  • --associate ENUM – Associate to OS`s, Locations & Organizations. Options are: always, new or never. Possible value(s): always, new, never
  • --branch VALUE – Branch in Git repo.
  • --dirname VALUE – The directory within Git repo containing the templates
  • --filter VALUE – Export templates with names matching this regex (case-insensitive; snippets are not filtered).
  • --force BOOLEAN – Update templates that are locked
  • --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
  • --lock ENUM – Lock imported templates Possible value(s): lock, keep_lock_new, keep, unlock, true, false, 0, 1
  • --negate BOOLEAN – Negate the prefix (for purging).
  • --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
  • --prefix VALUE – The string all imported templates should begin with.
  • --repo VALUE – Override the default repo from settings.
  • --verbose BOOLEAN – Show template diff in response
  • -h, --help – Print help

11.42. job-invocation

Manage job invocations

Usage

# hammer job-invocation [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.42.1. job-invocation cancel

Cancel the job

Usage

# hammer job-invocation cancel [OPTIONS]

Options

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

11.42.2. job-invocation create

Create a job invocation

Usage

# hammer job-invocation create [OPTIONS]

Options

  • --async – Do not wait for the task
  • --bookmark VALUE – Name to search by
  • --bookmark-id NUMBER
  • --concurrency-level NUMBER – Run at most N tasks at a time

  • --cron-line VALUE – Create a recurring execution Cron line format a b c d e, where:

    1. is minute (range: 0-59)
    2. is hour (range: 0-23)
    3. is day of month (range: 1-31)
    4. is month (range: 1-12)
    5. is day of week (range: 0-6)
  • --description-format VALUE – Override the description format from the template for this invocation only
  • --dynamic – Dynamic search queries are evaluated at run time
  • --effective-user VALUE – What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.
  • --effective-user-password VALUE – Set password for effective user (using sudo-like mechanisms)
  • --end-time DATETIME – Perform no more executions after this time, used with --cron-line
  • --execution-timeout-interval NUMBER Override the timeout interval from the template for this invocation only
  • --feature VALUE – Remote execution feature label that should be triggered, job template assigned to this feature will be used
  • --input-files KEY_VALUE_LIST – Read input values from files Comma-separated list of key=file, where file is a path to a text file to be read
  • --inputs KEY_VALUE_LIST – Specify inputs from command line
  • --job-template VALUE – Name to search by
  • --job-template-id VALUE – The job template to use, parameter is required unless feature was specified
  • --key-passphrase VALUE – Set SSH key passphrase
  • --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
  • --max-iteration NUMBER – Repeat a maximum of N times
  • --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 – Set SSH password
  • --purpose VALUE – Designation of a special purpose
  • --randomized-ordering BOOLEAN – Execute the jobs on hosts in randomized order
  • --search-query VALUE
  • --ssh-user VALUE – Set SSH user
  • --start-at DATETIME – Schedule the execution for a later time
  • --start-before DATETIME – Execution should be cancelled if it cannot be started before --start-at
  • --tags VALUE – A comma separated list of tags to use for Ansible run
  • --tags-flag ENUM – IncludeExclude tags for Ansible run Possible value(s): include, exclude
  • --time-to-pickup NUMBER – Override the global time to pickup interval for this invocation only
  • -h, --help – Print help

11.42.3. job-invocation info

Show job invocation

Usage

# hammer job-invocation <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location-id NUMBER – Set the current location context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --show-host-status – Show job status for the hosts
  • --show-inputs – Show the complete input of the job
  • -h, --help – Print help
Table 11.117. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Description

x

x

Status

x

x

Success

x

x

Failed

x

x

Pending

x

x

Missing

x

x

Total

x

x

Start

x

x

Randomized ordering

x

x

Inputs

x

x

Job category

x

x

Mode

x

x

Cron line

x

x

Recurring logic id

x

x

Time to pickup

x

x

Hosts

x

x

11.42.4. job-invocation list

List job invocations

Usage

# hammer job-invocation <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 11.118. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Description

x

x

Status

x

x

Success

x

x

Failed

x

x

Pending

x

x

Total

x

x

Start

x

x

Randomized ordering

x

x

Inputs

x

x

11.42.5. job-invocation output

View the output for a host

Usage

# hammer job-invocation output [OPTIONS]

Options

  • --async – Do not wait for job to complete, shows current output only
  • --host VALUE – Host name
  • --host-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

11.42.6. job-invocation rerun

Rerun the job

Usage

# hammer job-invocation rerun [OPTIONS]

Options

  • --failed-only BOOLEAN
  • --id VALUE
  • --location-id NUMBER – Set the current location context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --succeeded-only BOOLEAN
  • -h, --help – Print help

11.43. job-template

Manage job templates

Usage

# hammer job-template [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.43.1. job-template create

Create a job template

Usage

# hammer job-template create [OPTIONS]

Options

  • --ansible-callback-enabled BOOLEAN Enable the callback plugin for this template
  • --audit-comment VALUE
  • --current-user BOOLEAN – Whether the current user login should be used as the effective user
  • --description VALUE
  • --description-format VALUE – This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.
  • --file FILE – Path to a file that contains the template
  • --job-category VALUE – Job category
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --name VALUE – Template name
  • --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
  • --overridable BOOLEAN – Whether it should be allowed to override the effective user from the invocation form.
  • --provider-type ENUM – Provider type Possible value(s): SSH, script, Ansible
  • --snippet BOOLEAN
  • --value VALUE – What user should be used to run the script (using sudo-like mechanisms)
  • -h, --help – Print help

11.43.2. job-template delete

Delete a job template

Usage

# hammer job-template <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

11.43.3. job-template dump

View job template content

Usage

# hammer job-template dump [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 11.119. Predefined field sets

FIELDS

11.43.4. job-template export

Export a template including all metadata

Usage

# hammer job-template export [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 11.120. Predefined field sets

FIELDS

11.43.5. job-template import

Import a job template from ERB

Usage

# hammer job-template import [OPTIONS]

Options

  • --file FILE – Path to a file that contains the template - must include ERB metadata
  • --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
  • --overwrite BOOLEAN – Overwrite template if it already exists
  • -h, --help – Print help

11.43.6. job-template info

Show job template details

Usage

# hammer job-template <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 11.121. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Job category

x

x

 

Provider

x

x

 

Type

x

x

 

Ansible callback enabled

x

x

 

Description

x

x

 

Inputs

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

11.43.7. job-template list

List job templates

Usage

# hammer job-template <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 11.122. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Job category

x

x

 

Provider

x

x

 

Type

x

x

 

11.43.8. job-template update

Update a job template

Usage

# hammer job-template update [OPTIONS]

Options

  • --ansible-callback-enabled BOOLEAN Enable the callback plugin for this template
  • --audit-comment VALUE
  • --current-user BOOLEAN – Whether the current user login should be used as the effective user
  • --description VALUE
  • --description-format VALUE – This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.
  • --file FILE – Path to a file that contains the template
  • --id VALUE
  • --job-category VALUE – Job category
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --name VALUE – Template name
  • --new-name VALUE – Template name
  • --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
  • --overridable BOOLEAN – Whether it should be allowed to override the effective user from the invocation form.
  • --provider-type ENUM – Provider type Possible value(s): SSH, script, Ansible
  • --snippet BOOLEAN
  • --value VALUE – What user should be used to run the script (using sudo-like mechanisms)
  • -h, --help – Print help

11.44. lifecycle-environment

Manipulate lifecycle_environments on the server

Usage

# hammer lifecycle-environment [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.44.1. lifecycle-environment create

Create an environment

Usage

# hammer lifecycle-environment create [OPTIONS]

Options

  • --description VALUE – Description of the environment
  • --label VALUE – Label of the environment
  • --name VALUE – Name of the environment
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Name of organization
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --prior VALUE – Name of the prior environment
  • --prior-id NUMBER – ID of an environment that is prior to the new environment in the chain. It has to be either the ID of Library or the ID of an environment at the end of a chain.
  • --registry-name-pattern VALUE – Pattern for container image names
  • --registry-unauthenticated-pull BOOLEAN Allow unauthenticed pull of container images
  • -h, --help – Print help

11.44.2. lifecycle-environment delete

Destroy an environment

Usage

# hammer lifecycle-environment <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – ID of the environment
  • --name VALUE – Lifecycle environment 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
  • -h, --help – Print help

11.44.3. lifecycle-environment info

Show an environment

Usage

# hammer lifecycle-environment <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – ID of the environment
  • --name VALUE – Lifecycle environment name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – ID of the organization
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • -h, --help – Print help
Table 11.123. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Label

x

x

 

Description

x

x

 

Organization

x

x

 

Library

x

x

 

Prior lifecycle environment

x

x

 

Unauthenticated pull

x

x

 

Registry name pattern

x

x

 

11.44.4. lifecycle-environment list

List environments in an organization

Usage

# hammer lifecycle-environment <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
  • --label VALUE – Filter only environments containing this label
  • --library BOOLEAN – Set true if you want to see only library environments
  • --name VALUE – Filter only environments containing this name
  • --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 11.124. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Prior

x

x

 

Search / Order fields

  • id – integer
  • label – string
  • name – string
  • organization_id – integer

11.44.5. lifecycle-environment paths

List environment paths

Usage

# hammer lifecycle-environment paths [OPTIONS]

Options

  • --content-source-id NUMBER – Show whether each lifecycle environment is associated with the given Capsule id.
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --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
  • --permission-type VALUE – The associated permission type. One of (readable | promotable) Default: readable
  • -h, --help – Print help
Table 11.125. Predefined field sets
FIELDSALLDEFAULT

Lifecycle path

x

x

11.44.6. lifecycle-environment update

Update an environment

Usage

# hammer lifecycle-environment update [OPTIONS]

Options

  • --async BOOLEAN – Do not wait for the update action to finish. Default: true
  • --description VALUE – Description of the environment
  • --id NUMBER – ID of the environment
  • --name VALUE – Lifecycle environment name to search by
  • --new-name VALUE – New name to be given to the environment
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Name of the organization
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --registry-name-pattern VALUE – Pattern for container image names
  • --registry-unauthenticated-pull BOOLEAN Allow unauthenticed pull of container images
  • -h, --help – Print help

11.45. location

Manipulate locations

Usage

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

Options

  • -h, --help – Print help

11.45.1. location add-compute-resource

Associate a compute resource

Usage

# hammer location add-compute-resource [OPTIONS]

Options

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

11.45.2. location add-domain

Associate a domain

Usage

# hammer location add-domain [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id NUMBER – Numerical ID or domain name
  • --id VALUE
  • --name VALUE – Set the current location context for the request
  • --title VALUE – Set the current location context for the request
  • -h, --help – Print help

11.45.3. location add-hostgroup

Associate a hostgroup

Usage

# hammer location add-hostgroup [OPTIONS]

Options

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

11.45.4. location add-medium

Associate a medium

Usage

# hammer location add-medium [OPTIONS]

Options

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

11.45.5. location add-organization

Associate an organization

Usage

# hammer location add-organization [OPTIONS]

Options

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

11.45.6. location add-provisioning-template

Associate provisioning templates

Usage

# hammer location add-provisioning-template [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Set the current location context for the request
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be associated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Set the current location context for the request
  • -h, --help – Print help

11.45.7. location add-smart-proxy

Associate a smart proxy

Usage

# hammer location add-smart-proxy [OPTIONS]

Options

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

11.45.8. location add-subnet

Associate a subnet

Usage

# hammer location add-subnet [OPTIONS]

Options

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

11.45.9. location add-user

Associate an user

Usage

# hammer location add-user [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Set the current location context for the request
  • --title VALUE – Set the current location context for the request
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

11.45.10. location create

Create a location

Usage

# hammer location create [OPTIONS]

Options

  • --compute-resource-ids LIST – Compute resource IDs
  • --compute-resources LIST
  • --description VALUE
  • --domain-ids LIST – Domain IDs
  • --domains LIST
  • --environment-ids LIST – Environment IDs
  • --hostgroup-ids LIST – Host group IDs
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --ignore-types LIST – List of resources types that will be automatically associated
  • --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
  • --media LIST
  • --medium-ids LIST – Medium IDs
  • --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 – Associated organization IDs
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --parent-id NUMBER – Parent ID
  • --partition-table-ids LIST – Partition template IDs
  • --partition-tables LIST
  • --provisioning-template-ids LIST Provisioning template IDs
  • --provisioning-templates LIST
  • --realm-ids LIST – Realm IDs
  • --realms LIST
  • --smart-proxies LIST
  • --smart-proxy-ids LIST – Capsule IDs
  • --subnet-ids LIST – Subnet IDs
  • --subnets LIST
  • --user-ids LIST – User IDs
  • --users LIST
  • -h, --help – Print help

11.45.11. location delete

Delete a location

Usage

# hammer location <delete|destroy> [OPTIONS]

Options

  • --id VALUE – Location numeric id to search by
  • --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 – Set the current organization 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
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.45.12. location delete-parameter

Delete parameter for a location

Usage

# hammer location delete-parameter [OPTIONS]

Options

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

11.45.13. location info

Show a location

Usage

# hammer location <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – Location numeric id to search by
  • --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 – Set the current organization 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
  • --show-hidden-parameters BOOLEAN Display hidden parameter values
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 11.126. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Name

x

x

x

Description

x

x

 

Parent

x

x

 

Users/

x

x

 

Smart proxies/

x

x

 

Subnets/

x

x

 

Compute resources/

x

x

 

Installation media/

x

x

 

Templates/

x

x

 

Partition tables/

x

x

 

Domains/

x

x

 

Realms/

x

x

 

Hostgroups/

x

x

 

Parameters/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.45.14. location list

List all locations

Usage

# hammer location <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 11.127. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Name

x

x

x

Description

x

x

 

Search / Order fields

  • description – text
  • id – integer
  • location_id – integer
  • name – string
  • title – string

11.45.15. location remove-compute-resource

Disassociate a compute resource

Usage

# hammer location remove-compute-resource [OPTIONS]

Options

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

11.45.16. location remove-domain

Disassociate a domain

Usage

# hammer location remove-domain [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id NUMBER – Numerical ID or domain name
  • --id VALUE
  • --name VALUE – Set the current location context for the request
  • --title VALUE – Set the current location context for the request
  • -h, --help – Print help

11.45.17. location remove-hostgroup

Disassociate a hostgroup

Usage

# hammer location remove-hostgroup [OPTIONS]

Options

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

11.45.18. location remove-medium

Disassociate a medium

Usage

# hammer location remove-medium [OPTIONS]

Options

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

11.45.19. location remove-organization

Disassociate an organization

Usage

# hammer location remove-organization [OPTIONS]

Options

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

11.45.20. location remove-provisioning-template

Disassociate provisioning templates

Usage

# hammer location remove-provisioning-template [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Set the current location context for the request
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be disassociated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Set the current location context for the request
  • -h, --help – Print help

11.45.21. location remove-smart-proxy

Disassociate a smart proxy

Usage

# hammer location remove-smart-proxy [OPTIONS]

Options

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

11.45.22. location remove-subnet

Disassociate a subnet

Usage

# hammer location remove-subnet [OPTIONS]

Options

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

11.45.23. location remove-user

Disassociate an user

Usage

# hammer location remove-user [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Set the current location context for the request
  • --title VALUE – Set the current location context for the request
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

11.45.24. location set-parameter

Create or update parameter for a location

Usage

# hammer location set-parameter [OPTIONS]

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Parameter name
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.45.25. location update

Update a location

Usage

# hammer location update [OPTIONS]

Options

  • --compute-resource-ids LIST – Compute resource IDs
  • --compute-resources LIST
  • --description VALUE
  • --domain-ids LIST – Domain IDs
  • --domains LIST
  • --environment-ids LIST – Environment IDs
  • --hostgroup-ids LIST – Host group IDs
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --id VALUE – Location numeric id to search by
  • --ignore-types LIST – List of resources types that will be automatically associated
  • --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
  • --media LIST
  • --medium-ids LIST – Medium IDs
  • --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 – Associated organization IDs
  • --organization-title VALUE – Set the current organization context for the request
  • --organization-titles LIST
  • --organizations LIST
  • --parent-id NUMBER – Parent ID
  • --partition-table-ids LIST – Partition template IDs
  • --partition-tables LIST
  • --provisioning-template-ids LIST Provisioning template IDs
  • --provisioning-templates LIST
  • --realm-ids LIST – Realm IDs
  • --realms LIST
  • --smart-proxies LIST
  • --smart-proxy-ids LIST – Capsule IDs
  • --subnet-ids LIST – Subnet IDs
  • --subnets LIST
  • --title VALUE – Set the current location context for the request
  • --user-ids LIST – User IDs
  • --users LIST
  • -h, --help – Print help

11.46. mail-notification

Manage mail notifications

Usage

# hammer mail-notification [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.46.1. mail-notification info

Show an email notification

Usage

# hammer mail-notification <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – Numerical ID or email notification name
  • --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 11.128. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Subscription type

x

x

 

11.46.2. mail-notification list

List of email notifications

Usage

# hammer mail-notification <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 11.129. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • description – text
  • id – integer
  • name – string
  • user – string

11.47. medium

Manipulate installation media

Usage

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

Options

  • -h, --help – Print help

11.47.1. medium add-operatingsystem

Associate an operating system

Usage

# hammer medium add-operatingsystem [OPTIONS]

Options

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

11.47.2. medium create

Create a medium

Usage

# hammer medium 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-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 – Name of media
  • --operatingsystem-ids LIST
  • --operatingsystems LIST
  • --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
  • --os-family VALUE – Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver
  • --path VALUE – The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

For example mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host`s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

Solaris and Debian media may also use $release. * -h, --help – Print help

11.47.3. medium delete

Delete a medium

Usage

# hammer medium <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 – Medium 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

11.47.4. medium info

Show a medium

Usage

# hammer medium <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 – Medium 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 11.130. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Path

x

x

 

Os family

x

x

 

Operating systems/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.47.5. medium list

List all installation media

Usage

# hammer medium <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
  • --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 – 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 11.131. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Path

x

x

 

Search / Order fields

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

11.47.6. medium remove-operatingsystem

Disassociate an operating system

Usage

# hammer medium remove-operatingsystem [OPTIONS]

Options

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

11.47.7. medium update

Update a medium

Usage

# hammer medium 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 – Name of media
  • --new-name VALUE – Name of media
  • --operatingsystem-ids LIST
  • --operatingsystems LIST
  • --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
  • --os-family VALUE – Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver
  • --path VALUE – The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

For example mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host`s actual OS architecture and $version, $major and $minor will be substituted for the version of the operating system.

Solaris and Debian media may also use $release. * -h, --help – Print help

11.48. model

Manipulate hardware models

Usage

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

Options

  • -h, --help – Print help

11.48.1. model create

Create a hardware model

Usage

# hammer model create [OPTIONS]

Options

  • --hardware-model VALUE
  • --info 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
  • --vendor-class VALUE
  • -h, --help – Print help

11.48.2. model delete

Delete a hardware model

Usage

# hammer model <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 – Model 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

11.48.3. model info

Show a hardware model

Usage

# hammer model <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 – Model 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 11.132. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Vendor class

x

x

 

Hw model

x

x

 

Info

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.48.4. model list

List all hardware models

Usage

# hammer model <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 11.133. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Vendor class

x

x

 

Hw model

x

x

 

Search / Order fields

  • hardware_model – string
  • id – integer
  • info – text
  • name – string
  • vendor_class – string

11.48.5. model update

Update a hardware model

Usage

# hammer model update [OPTIONS]

Options

  • --hardware-model VALUE
  • --id VALUE
  • --info 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
  • --vendor-class VALUE
  • -h, --help – Print help

11.49. module-stream

View Module Streams

Usage

# hammer module-stream [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.49.1. module-stream info

Show a module stream

Usage

# hammer module-stream <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A module stream identifier
  • --name VALUE – Module stream 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.134. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

 

Module stream name

x

x

x

Stream

x

x

 

Uuid

x

x

 

Version

x

x

 

Architecture

x

x

 

Context

x

x

 

Repositories/id

x

x

 

Repositories/name

x

x

 

Repositories/label

x

x

 

Artifacts/id

x

x

 

Artifacts/name

x

x

 

Profiles/id

x

x

 

Profiles/name

x

x

 

Profiles/rpms/id

x

x

 

Profiles/rpms/name

x

x

 

11.49.2. module-stream list

List module streams

Usage

# hammer module-stream <list|index> [OPTIONS]

Options

  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content view filter identifier
  • --content-view-filter-rule VALUE – Name to search by
  • --content-view-filter-rule-id NUMBER Content view filter rule identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content view version identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --host-ids LIST – List of host id to list available module streams for
  • --hosts LIST
  • --ids LIST – Ids to filter content by
  • --include-filter-ids BOOLEAN – Includes associated content view filter ids in response
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --name-stream-only BOOLEAN – Return name and stream information only)
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.135. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

 

Module stream name

x

x

x

Stream

x

x

 

Uuid

x

x

 

Version

x

x

 

Architecture

x

x

 

Context

x

x

 

11.50. organization

Manipulate organizations

Usage

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

Options

  • -h, --help – Print help

11.50.1. organization add-compute-resource

Associate a compute resource

Usage

# hammer organization add-compute-resource [OPTIONS]

Options

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

11.50.2. organization add-domain

Associate a domain

Usage

# hammer organization add-domain [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id NUMBER – Numerical ID or domain name
  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.3. organization add-hostgroup

Associate a hostgroup

Usage

# hammer organization add-hostgroup [OPTIONS]

Options

  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER
  • --hostgroup-title VALUE – Hostgroup title
  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.4. organization add-location

Associate a location

Usage

# hammer organization add-location [OPTIONS]

Options

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

11.50.5. organization add-medium

Associate a medium

Usage

# hammer organization add-medium [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --medium VALUE – Medium name
  • --medium-id NUMBER
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.6. organization add-provisioning-template

Associate provisioning templates

Usage

# hammer organization add-provisioning-template [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be associated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.7. organization add-smart-proxy

Associate a smart proxy

Usage

# hammer organization add-smart-proxy [OPTIONS]

Options

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

11.50.8. organization add-subnet

Associate a subnet

Usage

# hammer organization add-subnet [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.9. organization add-user

Associate an user

Usage

# hammer organization add-user [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

11.50.10. organization configure-cdn

Update the CDN configuration

Usage

# hammer organization configure-cdn [OPTIONS]

Options

  • --custom-cdn-auth-enabled BOOLEAN – If product certificates should be used to authenticate to a custom CDN.
  • --id VALUE – ID of the Organization
  • --label VALUE – Organization label to search by
  • --name VALUE – Organization name to search by
  • --password VALUE – Password for authentication. Relevant only for upstream_server type.
  • --ssl-ca-credential-id NUMBER – Content Credential to use for SSL CA. Relevant only for upstream_server type.
  • --title VALUE – Organization title
  • --type VALUE – CDN configuration type. One of redhat_cdn, network_sync, export_sync, custom_cdn.
  • --upstream-content-view-label VALUE – Upstream Content View Label, default: Default_Organization_View. Relevant only for upstream_server type.
  • --upstream-lifecycle-environment-label VALUE Upstream Lifecycle Environment, default: Library. Relevant only for upstream_server type.
  • --upstream-organization-label VALUE – Upstream organization to sync CDN content from. Relevant only for upstream_server type.
  • --url VALUE – Upstream satellite server to sync CDN content from. Relevant only for upstream_server type.
  • --username VALUE – Username for authentication. Relevant only for upstream_server type.
  • -h, --help – Print help

11.50.11. organization create

Create organization

Usage

# hammer organization create [OPTIONS]

Options

  • --compute-resource-ids LIST – Compute resource IDs
  • --compute-resources LIST
  • --description VALUE
  • --domain-ids LIST – Domain IDs
  • --domains LIST
  • --environment-ids LIST – Environment IDs
  • --hostgroup-ids LIST – Host group IDs
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --ignore-types LIST – List of resources types that will be automatically associated
  • --label 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 – Associated location IDs
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --media LIST
  • --medium-ids LIST – Medium IDs
  • --name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Set the current organization context for the request
  • --partition-table-ids LIST – Partition template IDs
  • --partition-tables LIST
  • --provisioning-template-ids LIST Provisioning template IDs
  • --provisioning-templates LIST
  • --realm-ids LIST – Realm IDs
  • --realms LIST
  • --smart-proxies LIST
  • --smart-proxy-ids LIST – Capsule IDs
  • --subnet-ids LIST – Subnet IDs
  • --subnets LIST
  • --user-ids LIST – User IDs
  • --users LIST
  • -h, --help – Print help

11.50.12. organization delete

Delete an organization

Usage

# hammer organization <delete|destroy> [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id VALUE
  • --label VALUE – Organization label to search by
  • --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 – Set the current organization 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-label VALUE – Organization label to search by
  • --organization-title VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.13. organization delete-parameter

Delete parameter for an organization

Usage

# hammer organization delete-parameter [OPTIONS]

Options

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

11.50.14. organization info

Show organization

Usage

# hammer organization <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --label VALUE – Organization label to search by
  • --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 – Set the current organization 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-label VALUE – Organization label to search by
  • --organization-title VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help
Table 11.136. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Name

x

x

x

Description

x

x

 

Parent

x

x

 

Users/

x

x

 

Smart proxies/

x

x

 

Subnets/

x

x

 

Compute resources/

x

x

 

Installation media/

x

x

 

Templates/

x

x

 

Partition tables/

x

x

 

Domains/

x

x

 

Realms/

x

x

 

Hostgroups/

x

x

 

Parameters/

x

x

 

Locations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

Label

x

x

x

Description

x

x

 

Service levels

x

x

 

Cdn configuration/type

x

x

 

Cdn configuration/url

x

x

 

Cdn configuration/upstream organization

x

x

 

Cdn configuration/upstream lifecycle environment

x

x

 

Cdn configuration/upstream content view

x

x

 

Cdn configuration/username

x

x

 

Cdn configuration/ssl ca credential id

x

x

 

11.50.15. organization list

List all organizations

Usage

# hammer organization <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
  • --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 field and order, eg. id DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Set the current organization context for the request
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --search VALUE – Search string
  • --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 11.137. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Name

x

x

x

Description

x

x

 

Label

x

x

x

Search / Order fields

  • description – text
  • id – integer
  • label – string
  • name – string
  • organization_id – integer
  • title – string

11.50.16. organization remove-compute-resource

Disassociate a compute resource

Usage

# hammer organization remove-compute-resource [OPTIONS]

Options

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

11.50.17. organization remove-domain

Disassociate a domain

Usage

# hammer organization remove-domain [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id NUMBER – Numerical ID or domain name
  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.18. organization remove-hostgroup

Disassociate a hostgroup

Usage

# hammer organization remove-hostgroup [OPTIONS]

Options

  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id NUMBER
  • --hostgroup-title VALUE – Hostgroup title
  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.19. organization remove-location

Disassociate a location

Usage

# hammer organization remove-location [OPTIONS]

Options

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

11.50.20. organization remove-medium

Disassociate a medium

Usage

# hammer organization remove-medium [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --medium VALUE – Medium name
  • --medium-id NUMBER
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.21. organization remove-provisioning-template

Disassociate provisioning templates

Usage

# hammer organization remove-provisioning-template [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be disassociated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.22. organization remove-smart-proxy

Disassociate a smart proxy

Usage

# hammer organization remove-smart-proxy [OPTIONS]

Options

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

11.50.23. organization remove-subnet

Disassociate a subnet

Usage

# hammer organization remove-subnet [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER
  • --title VALUE – Set the current organization context for the request
  • -h, --help – Print help

11.50.24. organization remove-user

Disassociate an user

Usage

# hammer organization remove-user [OPTIONS]

Options

  • --id VALUE – Organization ID
  • --name VALUE – Set the current organization context for the request
  • --title VALUE – Set the current organization context for the request
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

11.50.25. organization set-parameter

Create or update parameter for an organization

Usage

# hammer organization set-parameter [OPTIONS]

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --name VALUE – Parameter name
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Organization ID
  • --organization-title VALUE – Set the current organization context for the request
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.50.26. organization update

Update organization

Usage

# hammer organization update [OPTIONS]

Options

  • --compute-resource-ids LIST – Compute resource IDs
  • --compute-resources LIST
  • --description VALUE
  • --domain-ids LIST – Domain IDs
  • --domains LIST
  • --environment-ids LIST – Environment IDs
  • --hostgroup-ids LIST – Host group IDs
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --id VALUE
  • --ignore-types LIST – List of resources types that will be automatically associated
  • --label VALUE – Organization label to search by
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – Associated location IDs
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --media LIST
  • --medium-ids LIST – Medium IDs
  • --name VALUE
  • --new-name VALUE
  • --new-title VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Set the current organization context for the request
  • --partition-table-ids LIST – Partition template IDs
  • --partition-tables LIST
  • --provisioning-template-ids LIST Provisioning template IDs
  • --provisioning-templates LIST
  • --realm-ids LIST – Realm IDs
  • --realms LIST
  • --redhat-repository-url VALUE – Red Hat CDN URL
  • --smart-proxies LIST
  • --smart-proxy-ids LIST – Capsule IDs
  • --subnet-ids LIST – Subnet IDs
  • --subnets LIST
  • --title VALUE – Set the current organization context for the request
  • --user-ids LIST – User IDs
  • --users LIST
  • -h, --help – Print help

11.51. os

Manipulate operating system

Usage

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

Options

  • -h, --help – Print help

11.51.1. os add-architecture

Associate an architecture

Usage

# hammer os add-architecture [OPTIONS]

Options

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

11.51.2. os add-provisioning-template

Associate provisioning templates

Usage

# hammer os add-provisioning-template [OPTIONS]

Options

  • --id VALUE
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be associated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Operating system title
  • -h, --help – Print help

11.51.3. os add-ptable

Associate a partition table

Usage

# hammer os add-ptable [OPTIONS]

Options

  • --id VALUE
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER
  • --title VALUE – Operating system title
  • -h, --help – Print help

11.51.4. os create

Create an operating system

Usage

# hammer os create [OPTIONS]

Options

  • --architecture-ids LIST – IDs of associated architectures
  • --architectures LIST
  • --description VALUE
  • --family 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
  • --major VALUE
  • --media LIST
  • --medium-ids LIST – IDs of associated media
  • --minor VALUE
  • --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
  • --os-parameters-attributes SCHEMA Array of parameters
  • --partition-table-ids LIST – IDs of associated partition tables
  • --partition-tables LIST
  • --password-hash ENUM – Root password hash function to use Possible value(s): SHA512, SHA256, Base64, Base64-Windows, MD5
  • --provisioning-template-ids LIST IDs of associated provisioning templates
  • --provisioning-templates LIST
  • --release-name VALUE
  • -h, --help – Print help

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

  • --os-parameters-attributes "name=<string>,value=<string>, …​ "

11.51.5. os delete

Delete an operating system

Usage

# hammer os <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
  • --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
  • --title VALUE – Operating system title
  • -h, --help – Print help

11.51.6. os delete-default-template

Usage

# hammer os delete-default-template [OPTIONS]

Options

  • --id VALUE – Operatingsystem id
  • --type VALUE – Type of the provisioning template
  • -h, --help – Print help

11.51.7. os delete-parameter

Delete parameter for an operating system

Usage

# hammer os delete-parameter [OPTIONS]

Options

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

11.51.8. os info

Show an operating system

Usage

# hammer os <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
  • --show-hidden-parameters BOOLEAN Display hidden parameter values
  • --title VALUE – Operating system title
  • -h, --help – Print help
Table 11.138. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Release name

x

x

 

Family

x

x

 

Name

x

x

 

Major version

x

x

 

Minor version

x

x

 

Partition tables/

x

x

 

Default templates/

x

x

 

Architectures/

x

x

 

Installation media/

x

x

 

Templates/

x

x

 

Parameters/

x

x

 

11.51.9. os list

List all operating systems

Usage

# hammer os <list|index> [OPTIONS]

Options

  • --architecture VALUE – Architecture name
  • --architecture-id VALUE – ID of architecture
  • --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
  • --medium VALUE – Medium name
  • --medium-id VALUE – ID of medium
  • --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
  • --os-parameters-attributes SCHEMA Array of parameters
  • --page NUMBER – Page number, starting at 1
  • --partition-table VALUE – Partition table name
  • --partition-table-id VALUE – ID of partition table
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id VALUE ID of template
  • --search VALUE – Filter results
  • -h, --help – Print help
Table 11.139. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Release name

x

x

 

Family

x

x

 

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

  • --os-parameters-attributes "name=<string>,value=<string>, …​ "

Search / Order fields

  • architecture – string
  • description – string
  • family – string
  • id – integer
  • major – string
  • medium – string
  • minor – string
  • name – string
  • params – string
  • template – string
  • title – string

11.51.10. os remove-architecture

Disassociate an architecture

Usage

# hammer os remove-architecture [OPTIONS]

Options

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

11.51.11. os remove-provisioning-template

Disassociate provisioning templates

Usage

# hammer os remove-provisioning-template [OPTIONS]

Options

  • --id VALUE
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be disassociated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Operating system title
  • -h, --help – Print help

11.51.12. os remove-ptable

Disassociate a partition table

Usage

# hammer os remove-ptable [OPTIONS]

Options

  • --id VALUE
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER
  • --title VALUE – Operating system title
  • -h, --help – Print help

11.51.13. os set-default-template

Usage

# hammer os set-default-template [OPTIONS]

Options

  • --id VALUE – Operatingsystem id
  • --provisioning-template-id VALUE Provisioning template id to be set
  • -h, --help – Print help

11.51.14. os set-parameter

Create or update parameter for an operating system

Usage

# hammer os set-parameter [OPTIONS]

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --name VALUE – Parameter name
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.51.15. os update

Update an operating system

Usage

# hammer os update [OPTIONS]

Options

  • --architecture-ids LIST – IDs of associated architectures
  • --architectures LIST
  • --description VALUE
  • --family 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
  • --major VALUE
  • --media LIST
  • --medium-ids LIST – IDs of associated media
  • --minor VALUE
  • --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
  • --os-parameters-attributes SCHEMA Array of parameters
  • --partition-table-ids LIST – IDs of associated partition tables
  • --partition-tables LIST
  • --password-hash ENUM – Root password hash function to use Possible value(s): SHA512, SHA256, Base64, Base64-Windows, MD5
  • --provisioning-template-ids LIST IDs of associated provisioning templates
  • --provisioning-templates LIST
  • --release-name VALUE
  • --title VALUE – Operating system title
  • -h, --help – Print help

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

  • --os-parameters-attributes "name=<string>,value=<string>, …​ "

11.52. package

Manipulate packages

Usage

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

Options

  • -h, --help – Print help

11.52.1. package info

Show a package

Usage

# hammer package <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A package identifier
  • --name VALUE – 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
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.140. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Pulp id

x

x

 

Uuid

x

x

 

Name

x

x

x

Version

x

x

 

Architecture

x

x

 

Epoch

x

x

 

Release

x

x

 

Author

x

x

 

Filename

x

x

 

Source rpm

x

x

 

Nvrea

x

x

 

Build host

x

x

 

Available host count

x

x

 

Applicable host count

x

x

 

Children

x

x

 

Vendor

x

x

 

License

x

x

 

Relative path

x

x

 

Description

x

x

 

Summary

x

x

 

Url

x

x

 

Build time

x

x

 

Group

x

x

 

Requires

x

x

 

Provides

x

x

 

Files

x

x

 

Size

x

x

 

Modular

x

x

 

11.52.2. package list

List packages

Usage

# hammer package <list|index> [OPTIONS]

Options

  • --available-for VALUE – Return packages that can be added to the specified object. Only the value content_view_version is supported.
  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content View Filter identifier. Use to filter by ID
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content View Version 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
  • --host VALUE – Host name
  • --host-id NUMBER – Host id to list applicable packages for
  • --ids LIST – Package identifiers to filter content by
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --packages-restrict-applicable BOOLEAN Return packages that are applicable to one or more hosts (defaults to true if host_id is specified)
  • --packages-restrict-latest BOOLEAN – Return only the latest version of each package
  • --packages-restrict-upgradable BOOLEAN Return packages that are upgradable on one or more hosts
  • --page NUMBER – Page number, starting at 1
  • --per-page NUMBER – Number of results per page to return
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.141. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Filename

x

x

Source rpm

x

x

11.53. package-group

Manipulate package groups

Usage

# hammer package-group [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.53.1. package-group info

Show a package group

Usage

# hammer package-group <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – A package group identifier
  • --name VALUE – 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
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.142. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Package group name

x

x

x

Repository name

x

x

 

Uuid

x

x

 

Description

x

x

 

Default packages

x

x

 

Mandatory packages

x

x

 

Conditional packages

x

x

 

Optional packages

x

x

 

11.53.2. package-group list

List package_groups

Usage

# hammer package-group <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-filter VALUE – Name to search by
  • --content-view-filter-id NUMBER – Content view filter identifier
  • --content-view-filter-rule VALUE – Name to search by
  • --content-view-filter-rule-id NUMBER Content view filter rule identifier
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER – Content view version identifier
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --ids LIST – Ids to filter content by
  • --include-filter-ids BOOLEAN – Includes associated content view filter ids in response
  • --lifecycle-environment-id NUMBER – Environment identifier
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.143. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Package group name

x

x

x

Repository name

x

x

 

Uuid

x

x

 

11.54. partition-table

Manipulate partition tables

Usage

# hammer partition-table [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.54.1. partition-table add-operatingsystem

Associate an operating system

Usage

# hammer partition-table add-operatingsystem [OPTIONS]

Options

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

11.54.2. partition-table create

Create a partition table

Usage

# hammer partition-table create [OPTIONS]

Options

  • --audit-comment VALUE
  • --description VALUE
  • --file FILE – Path to a file that contains the partition layout
  • --host-ids LIST – Array of host IDs to associate with the partition table
  • --hostgroup-ids LIST – Array of host group IDs to associate with the partition table
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --hosts LIST
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --name VALUE
  • --operatingsystem-ids LIST – Array of operating system IDs to associate with the partition table
  • --operatingsystems LIST
  • --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
  • --os-family VALUE
  • --snippet BOOLEAN
  • -h, --help – Print help

11.54.3. partition-table delete

Delete a partition table

Usage

# hammer partition-table <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 – Partition table 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

11.54.4. partition-table dump

View partition table content

Usage

# hammer partition-table dump [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 – Partition table 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 11.144. Predefined field sets

FIELDS

11.54.5. partition-table export

Export a partition template to ERB

Usage

# hammer partition-table export [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 – Partition table 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
  • --path VALUE – Path to directory where downloaded content will be saved
  • -h, --help – Print help

11.54.6. partition-table import

Import a partition table

Usage

# hammer partition-table import [OPTIONS]

Options

  • --associate ENUM – Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s): new, always, never
  • --default BOOLEAN – Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)
  • --file FILE – Path to a file that contains the template content including metadata
  • --force BOOLEAN – Use if you want update locked templates
  • --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
  • --lock BOOLEAN – Lock imported templates (false by default)
  • --name VALUE – Template name
  • --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

11.54.7. partition-table info

Show a partition table

Usage

# hammer partition-table <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 – Partition table 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 11.145. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Os family

x

x

 

Description

x

x

 

Locked

x

x

 

Operating systems/

x

x

 

Created at

x

x

 

Updated at

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

11.54.8. partition-table list

List all partition tables

Usage

# hammer partition-table <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
  • --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 – 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 11.146. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Os family

x

x

 

Search / Order fields

  • default – Values: true, false
  • family – string
  • id – integer
  • layout – text
  • location – string
  • location_id – integer
  • locked – Values: true, false
  • name – string
  • organization – string
  • organization_id – integer
  • snippet – Values: true, false
  • template – text
  • vendor – string

11.54.9. partition-table remove-operatingsystem

Disassociate an operating system

Usage

# hammer partition-table remove-operatingsystem [OPTIONS]

Options

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

11.54.10. partition-table update

Update a partition table

Usage

# hammer partition-table update [OPTIONS]

Options

  • --audit-comment VALUE
  • --description VALUE
  • --file FILE – Path to a file that contains the partition layout
  • --host-ids LIST – Array of host IDs to associate with the partition table
  • --hostgroup-ids LIST – Array of host group IDs to associate with the partition table
  • --hostgroup-titles LIST
  • --hostgroups LIST
  • --hosts LIST
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --name VALUE
  • --new-name VALUE
  • --operatingsystem-ids LIST – Array of operating system IDs to associate with the partition table
  • --operatingsystems LIST
  • --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
  • --os-family VALUE
  • --snippet BOOLEAN
  • -h, --help – Print help

11.55. ping

Get the status of the server and/or it’s subcomponents

Usage

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

Options

  • -h, --help – Print help

11.55.1. ping foreman

Shows status of Satellite system and it’s subcomponents

Usage

# hammer ping foreman [OPTIONS]

Options

  • -h, --help – Print help

11.55.2. ping katello

Shows status of Katello system and it’s subcomponents

Usage

# hammer ping katello [OPTIONS]

Options

  • -h, --help – Print help

11.56. policy

Manipulate policies

Usage

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

Options

  • -h, --help – Print help

11.56.1. policy create

Create a Policy

Usage

# hammer policy create [OPTIONS]

Options

  • --cron-line VALUE – Policy schedule cron line (only if period == “custom”)
  • --day-of-month NUMBER – Policy schedule day of month (only if period == “monthly”)
  • --deploy-by ENUM – How the policy should be deployed Possible value(s): puppet, ansible, manual
  • --description VALUE – Policy description
  • --host-ids LIST – Apply policy to hosts
  • --hostgroup-ids LIST – Apply policy to host groups
  • --hostgroups LIST
  • --hosts LIST
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --locations LIST
  • --name VALUE – Policy name
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organizations LIST
  • --period VALUE – Policy schedule period (weekly, monthly, custom)
  • --scap-content VALUE – SCAP content title
  • --scap-content-id NUMBER – Policy SCAP content ID
  • --scap-content-profile VALUE – Name to search by
  • --scap-content-profile-id NUMBER – Policy SCAP content profile ID
  • --tailoring-file VALUE – Tailoring file name
  • --tailoring-file-id NUMBER – Tailoring file ID
  • --tailoring-file-profile-id NUMBER Tailoring file profile ID
  • --weekday VALUE – Policy schedule weekday (only if period == “weekly”)
  • -h, --help – Print help

11.56.2. policy delete

Delete a Policy

Usage

# hammer policy <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

11.56.3. policy hosts

List all hosts

Usage

# hammer policy hosts [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id VALUE – ID of host group
  • --hostgroup-title VALUE – Hostgroup title
  • --id VALUE – Policy Id
  • --include ENUM – Array of extra information types to include Possible value(s): parameters, all_parameters
  • --location VALUE – Set the current location context for the request
  • --location-id VALUE – ID of location
  • --location-title VALUE – Set the current location context for the request
  • --name VALUE – Policy name
  • --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 VALUE – ID of organization
  • --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
  • --thin BOOLEAN – Only list ID and name of hosts
  • -h, --help – Print help
Table 11.147. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Operating system

x

x

 

Host group

x

x

 

Ip

x

x

 

Mac

x

x

 

Global status

x

x

 

Organization

x

  

Location

x

  

Additional information

x

  

Content view

x

x

 

Lifecycle environment

x

x

 

Security

x

  

Bugfix

x

  

Enhancement

x

  

Trace status

x

x

 

Search / Order fields

  • activation_key – string
  • activation_key_id – string
  • addon – string
  • applicable_debs – string
  • applicable_errata – string
  • applicable_errata_issued – date
  • applicable_rpms – string
  • architecture – string
  • autoheal – boolean
  • boot_time
  • build – Values: true, false
  • build_status – Values: built, pending, token_expired, build_failed
  • comment – text
  • compute_resource – string
  • compute_resource_id – integer
  • configuration_status.applied – integer
  • configuration_status.enabled – Values: true, false
  • configuration_status.failed – integer
  • configuration_status.failed_restarts – integer
  • configuration_status.interesting – Values: true, false
  • configuration_status.pending – integer
  • configuration_status.restarted – integer
  • configuration_status.skipped – integer
  • content_source – string
  • content_views – string
  • convert2rhel_through_foreman integer
  • created_at – datetime
  • domain – string
  • domain_id – integer
  • errata_status – Values: security_needed, errata_needed, updated, unknown
  • execution_status – Values: ok, error
  • facts – string
  • global_status – Values: ok, warning, error
  • has_ip – string
  • has_ip6 string
  • has_mac – string
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_id – integer
  • hostgroup_name – string
  • hostgroup_title – string
  • hypervisor – boolean
  • hypervisor_host – string
  • id – integer
  • image – string
  • infrastructure_facet.foreman – Values: true, false
  • infrastructure_facet.smart_proxy_id
  • insights_client_report_status – Values: reporting, no_report
  • insights_inventory_sync_status – Values: disconnect, sync
  • insights_recommendations_count – integer
  • installable_errata – string
  • installed_at – datetime
  • ip – string
  • ip6 string
  • job_invocation.id – string
  • job_invocation.result – Values: cancelled, failed, pending, success
  • last_checkin – datetime
  • last_report – datetime
  • lifecycle_environments – string
  • location – string
  • location_id – integer
  • mac – string
  • managed – Values: true, false
  • model – string
  • name – string
  • organization – string
  • organization_id – integer
  • origin – string
  • os – string
  • os_description – string
  • os_id – integer
  • os_major – string
  • os_minor – string
  • os_title – string
  • owner – string
  • owner_id – integer
  • owner_type – string
  • params – string
  • params_name – string
  • parent_hostgroup – string
  • puppet_ca – string
  • puppet_proxy_id – integer
  • puppetmaster – string
  • pxe_loader – Values: PXELinux_BIOS, PXELinux_UEFI, Grub_UEFI, Grub2_BIOS, Grub2_ELF, Grub2_UEFI, Grub2_UEFI_SecureBoot, Grub2_UEFI_HTTP, Grub2_UEFI_HTTPS, Grub2_UEFI_HTTPS_SecureBoot, iPXE_Embedded, iPXE_UEFI_HTTP, iPXE_Chain_BIOS, iPXE_Chain_UEFI
  • realm – string
  • realm_id – integer
  • registered_at – datetime
  • registered_through – string
  • release_version – string
  • reported.bios_release_date
  • reported.bios_vendor
  • reported.bios_version
  • reported.boot_time
  • reported.cores
  • reported.disks_total
  • reported.kernel_version
  • reported.ram
  • reported.sockets
  • reported.virtual – Values: true, false
  • repository – string
  • repository_content_label – string
  • rhel_lifecycle_status – Values: full_support, maintenance_support, approaching_end_of_maintenance, extended_support, approaching_end_of_support, support_ended
  • role – text
  • service_level – string
  • smart_proxy – string
  • status.applied – integer
  • status.enabled – Values: true, false
  • status.failed – integer
  • status.failed_restarts – integer
  • status.interesting – Values: true, false
  • status.pending – integer
  • status.restarted – integer
  • status.skipped – integer
  • subnet – string
  • subnet.name – text
  • subnet6 string
  • subnet6.name text
  • subscription_id – string
  • subscription_name – string
  • subscription_uuid – string
  • trace_status – Values: reboot_needed, process_restart_needed, updated
  • upgradable_debs – string
  • upgradable_rpms – string
  • usage – text
  • user.firstname – string
  • user.lastname – string
  • user.login – string
  • user.mail – string
  • usergroup – string
  • usergroup.name – string
  • uuid – string

11.56.4. policy info

Show a Policy

Usage

# hammer policy <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 11.148. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Created at

x

x

 

Period

x

x

 

Weekday

x

x

 

Day of month

x

x

 

Cron line

x

x

 

Scap content id

x

x

 

Scap content profile id

x

x

 

Tailoring file id

x

x

 

Tailoring file profile id

x

x

 

Deployment option

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Hostgroups/

x

x

 

11.56.5. policy list

List Policies

Usage

# hammer policy <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 11.149. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Created at

x

x

 

Search / Order fields

  • content – string
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer
  • profile – string
  • tailoring_file – string
  • tailoring_file_profile – string

11.56.6. policy update

Update a Policy

Usage

# hammer policy update [OPTIONS]

Options

  • --cron-line VALUE – Policy schedule cron line (only if period == “custom”)
  • --day-of-month NUMBER – Policy schedule day of month (only if period == “monthly”)
  • --deploy-by ENUM – How the policy should be deployed Possible value(s): puppet, ansible, manual
  • --description VALUE – Policy description
  • --host-ids LIST – Apply policy to hosts
  • --hostgroup-ids LIST – Apply policy to host groups
  • --hostgroups LIST
  • --hosts LIST
  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --locations LIST
  • --name VALUE – Policy name
  • --new-name VALUE – Policy name
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organizations LIST
  • --period VALUE – Policy schedule period (weekly, monthly, custom)
  • --scap-content VALUE – SCAP content title
  • --scap-content-id NUMBER – Policy SCAP content ID
  • --scap-content-profile VALUE – Name to search by
  • --scap-content-profile-id NUMBER – Policy SCAP content profile ID
  • --tailoring-file VALUE – Tailoring file name
  • --tailoring-file-id NUMBER – Tailoring file ID
  • --tailoring-file-profile-id NUMBER Tailoring file profile ID
  • --weekday VALUE – Policy schedule weekday (only if period == “weekly”)
  • -h, --help – Print help

11.57. prebuild-bash-completion

Prepare map of options and subcommands for Bash completion

Usage

# hammer prebuild-bash-completion [OPTIONS]

Options

  • -h, --help – Print help

11.58. preupgrade-report

Manage Leapp Preupgrade reports

Usage

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

Options

  • -h, --help – Print help

11.58.1. preupgrade-report info

Show Preupgrade report

Usage

# hammer preupgrade-report <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 11.150. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Reported at

x

x

Job invocation id

x

x

Host id

x

x

Entries/id

x

x

Entries/host name

x

x

Entries/title

x

x

Entries/actor

x

x

Entries/audience

x

x

Entries/severity

x

x

Entries/tags

x

x

Entries/summary

x

x

11.58.2. preupgrade-report job-invocation

List Preupgrade reports for Job invocation

Usage

# hammer preupgrade-report job-invocation [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 11.151. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Reported at

x

x

Job invocation id

x

x

Host id

x

x

11.58.3. preupgrade-report list

List Preupgrade reports

Usage

# hammer preupgrade-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 11.152. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Reported at

x

x

Job invocation id

x

x

Host id

x

x

11.59. product

Manipulate products

Usage

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

Options

  • -h, --help – Print help

11.59.1. product create

Create a product

Usage

# hammer product create [OPTIONS]

Options

  • --description VALUE – Product description
  • --gpg-key-id NUMBER – Identifier of the GPG key
  • --label VALUE
  • --name VALUE – Product name
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – ID of the organization
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --ssl-ca-cert-id NUMBER – Idenifier of the SSL CA Cert
  • --ssl-client-cert-id NUMBER – Identifier of the SSL Client Cert
  • --ssl-client-key-id NUMBER – Identifier of the SSL Client Key
  • --sync-plan VALUE – Sync plan name to search by
  • --sync-plan-id NUMBER – Plan numeric identifier
  • -h, --help – Print help

11.59.2. product delete

Destroy a product

Usage

# hammer product <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – Product numeric identifier
  • --name VALUE – Product 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

11.59.3. product info

Show a product

Usage

# hammer product <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Product numeric identifier
  • --name VALUE – Product 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
Table 11.153. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Label

x

x

 

Description

x

x

 

Sync state (all)

x

x

 

Sync state (last)

x

x

 

Sync plan id

x

x

 

Gpg/gpg key id

x

x

 

Gpg/gpg key

x

x

 

Organization

x

x

 

Readonly

x

x

 

Deletable

x

x

 

Content/repo name

x

x

 

Content/url

x

x

 

Content/content type

x

x

 

11.59.4. product list

List products

Usage

# hammer product <list|index> [OPTIONS]

Options

  • --available-for VALUE – Interpret specified object to return only Products that can be associated with specified object. Only sync_plan is supported.
  • --custom BOOLEAN – Return custom products only
  • --enabled BOOLEAN – Return enabled products only
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --full-result BOOLEAN – Whether or not to show all results
  • --include-available-content BOOLEAN Whether to include available content attribute in results
  • --name VALUE – Filter products by name
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – Filter products by organization
  • --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
  • --redhat-only BOOLEAN – Return Red Hat (non-custom) products only
  • --search VALUE – Search string
  • --subscription VALUE – Subscription name to search by
  • --subscription-id NUMBER – Filter products by subscription
  • --sync-plan VALUE – Sync plan name to search by
  • --sync-plan-id NUMBER – Filter products by sync plan id
  • -h, --help – Print help
Table 11.154. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Organization

x

x

 

Repositories

x

x

 

Sync state

x

x

 

Search / Order fields

  • description – text
  • label – string
  • name – string
  • organization_id – integer
  • redhat – Values: true, false

11.59.5. product remove-sync-plan

Delete assignment sync plan and product

Usage

# hammer product remove-sync-plan [OPTIONS]

Options

  • --description VALUE – Product description
  • --gpg-key-id NUMBER – Identifier of the GPG key
  • --id NUMBER – Product numeric identifier
  • --name VALUE – Product name
  • --new-name VALUE – Product name
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --ssl-ca-cert-id NUMBER – Idenifier of the SSL CA Cert
  • --ssl-client-cert-id NUMBER – Identifier of the SSL Client Cert
  • --ssl-client-key-id NUMBER – Identifier of the SSL Client Key
  • -h, --help – Print help

11.59.6. product set-sync-plan

Assign sync plan to product

Usage

# hammer product set-sync-plan [OPTIONS]

Options

  • --id NUMBER – Product numeric identifier
  • --name VALUE – Product name to search by
  • --new-name VALUE – Product name
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --ssl-ca-cert-id NUMBER – Idenifier of the SSL CA Cert
  • --ssl-client-cert-id NUMBER – Identifier of the SSL Client Cert
  • --ssl-client-key-id NUMBER – Identifier of the SSL Client Key
  • --sync-plan VALUE – Sync plan name to search by
  • --sync-plan-id NUMBER – Plan numeric identifier
  • -h, --help – Print help

11.59.7. product synchronize

Sync all repositories for a product

Usage

# hammer product synchronize [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Product ID
  • --name VALUE – Product 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

11.59.8. product update

Updates a product

Usage

# hammer product update [OPTIONS]

Options

  • --description VALUE – Product description
  • --gpg-key-id NUMBER – Identifier of the GPG key
  • --id NUMBER – Product numeric identifier
  • --name VALUE – Product name
  • --new-name VALUE – Product name
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --ssl-ca-cert-id NUMBER – Idenifier of the SSL CA Cert
  • --ssl-client-cert-id NUMBER – Identifier of the SSL Client Cert
  • --ssl-client-key-id NUMBER – Identifier of the SSL Client Key
  • --sync-plan VALUE – Sync plan name to search by
  • --sync-plan-id NUMBER – Plan numeric identifier
  • -h, --help – Print help

11.59.9. product update-proxy

Updates an HTTP Proxy for a product

Usage

# hammer product update-proxy [OPTIONS]

Options

  • --async – Do not wait for the task
  • --http-proxy VALUE – Name to search by
  • --http-proxy-id NUMBER – HTTP Proxy identifier to associated
  • --http-proxy-policy ENUM – Policy for HTTP Proxy for content sync Possible value(s): global_default_http_proxy, none, use_selected_http_proxy
  • --ids LIST – List of product ids
  • -h, --help – Print help

11.59.10. product verify-checksum

Verify checksum for one or more products

Usage

# hammer product verify-checksum [OPTIONS]

Options

  • --async – Do not wait for the task
  • --ids LIST – List of product ids
  • -h, --help – Print help

11.60. proxy

Manipulate smart proxies

Usage

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

Options

  • -h, --help – Print help

11.60.1. proxy content

Manage the capsule content

Usage

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

Options

  • -h, --help – Print help
11.60.1.1. proxy content add-lifecycle-environment

Add lifecycle environments to the capsule

Usage

# hammer proxy 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
11.60.1.2. proxy content available-lifecycle-environments

List the lifecycle environments not attached to the capsule

Usage

# hammer proxy 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 11.155. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Organization

x

x

 
11.60.1.3. proxy content cancel-synchronization

Cancel running capsule synchronization

Usage

# hammer proxy content cancel-synchronization [OPTIONS]

Options

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

Get current capsule synchronization status

Usage

# hammer proxy 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 11.156. 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

11.60.1.5. proxy content lifecycle-environments

List the lifecycle environments attached to the capsule

Usage

# hammer proxy 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 11.157. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Organization

x

x

 
11.60.1.6. proxy content reclaim-space

Reclaim space from all On Demand repositories on a capsule

Usage

# hammer proxy 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
11.60.1.7. proxy content remove-lifecycle-environment

Remove lifecycle environments from the capsule

Usage

# hammer proxy 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
11.60.1.8. proxy content synchronization-status

Get current capsule synchronization status

Usage

# hammer proxy 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 11.158. 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

11.60.1.9. proxy content synchronize

Synchronize the content to the capsule

Usage

# hammer proxy 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
11.60.1.10. proxy content update-counts

Update content counts for the capsule

Usage

# hammer proxy 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
11.60.1.11. proxy content verify-checksum

Check for missing or corrupted artifacts, and attempt to redownload them.

Usage

# hammer proxy content verify-checksum [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 verifying checksum 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 verifying checksum 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 verifying checksum on
  • -h, --help – Print help

11.60.2. proxy create

Create a capsule

Usage

# hammer proxy 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

11.60.3. proxy delete

Delete a capsule

Usage

# hammer proxy <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

11.60.4. proxy import-subnets

Import subnets from Capsule

Usage

# hammer proxy 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

11.60.5. proxy info

Show a capsule

Usage

# hammer proxy <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 11.159. 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

 

11.60.6. proxy list

List all capsules

Usage

# hammer proxy <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 11.160. 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

Search / Order fields

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

11.60.7. proxy refresh-features

Refresh capsule features

Usage

# hammer proxy 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

11.60.8. proxy update

Update a capsule

Usage

# hammer proxy 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

11.61. realm

Manipulate realms

Usage

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

Options

  • -h, --help – Print help

11.61.1. realm create

Create a realm

Usage

# hammer realm 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-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 – The realm name, e.g. EXAMPLE.COM
  • --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
  • --realm-proxy-id NUMBER – Capsule ID to use within this realm
  • --realm-type VALUE – Realm type, e.g. Red Hat Identity Management or Active Directory
  • -h, --help – Print help

11.61.2. realm delete

Delete a realm

Usage

# hammer realm <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

11.61.3. realm info

Show a realm

Usage

# hammer realm <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – Numerical ID or realm name
  • --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 11.161. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Realm proxy id

x

x

 

Realm type

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.61.4. realm list

List of realms

Usage

# hammer realm <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 11.162. 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
  • type – string

11.61.5. realm update

Update a realm

Usage

# hammer realm 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 – The realm name, e.g. EXAMPLE.COM
  • --new-name VALUE – The realm name, e.g. EXAMPLE.COM
  • --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
  • --realm-proxy-id NUMBER – Capsule ID to use within this realm
  • --realm-type VALUE – Realm type, e.g. Red Hat Identity Management or Active Directory
  • -h, --help – Print help

11.62. recurring-logic

Recurring logic related actions

Usage

# hammer recurring-logic [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.62.1. recurring-logic cancel

Cancel recurring logic

Usage

# hammer recurring-logic cancel [OPTIONS]

Options

  • --id VALUE – ID of the recurring logic
  • --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

11.62.2. recurring-logic delete

Delete all recuring logics filtered by the arguments

Usage

# hammer recurring-logic delete [OPTIONS]

Options

  • --cancelled – Only delete cancelled recurring logics
  • --finished – Only delete finished recurring logics
  • -h, --help – Print help

11.62.3. recurring-logic info

Show recurring logic details

Usage

# hammer recurring-logic <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – ID of the recurring logic
  • --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 11.163. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Cron line

x

x

Action

x

x

Last occurrence

x

x

Next occurrence

x

x

Task count

x

x

Action

x

x

Last occurrence

x

x

Next occurrence

x

x

Iteration

x

x

Iteration limit

x

x

Iteration limit

x

x

Repeat until

x

x

State

x

x

Purpose

x

x

11.62.4. recurring-logic list

List recurring logics

Usage

# hammer recurring-logic <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 11.164. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Cron line

x

x

Task count

x

x

Action

x

x

Last occurrence

x

x

Next occurrence

x

x

Iteration

x

x

Iteration limit

x

x

End time

x

x

State

x

x

Purpose

x

x

11.63. remote-execution-feature

Manage remote execution features

Usage

# hammer remote-execution-feature [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.63.1. remote-execution-feature info

Show remote execution feature

Usage

# hammer remote-execution-feature <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 11.165. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Label

x

x

 

Name

x

x

x

Description

x

x

 

Job template name

x

x

 

Job template id

x

x

 

11.63.2. remote-execution-feature list

List remote execution features

Usage

# hammer remote-execution-feature <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
  • --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 11.166. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Job template name

x

x

 

11.63.3. remote-execution-feature update

Update a job template

Usage

# hammer remote-execution-feature update [OPTIONS]

Options

  • --id VALUE
  • --job-template VALUE – Name to search by
  • --job-template-id VALUE – Job template ID to be used for the feature
  • --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
  • --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

11.64. report

Browse and read reports

Usage

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

Options

  • -h, --help – Print help

11.64.1. report delete

Delete a report

Usage

# hammer report <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
  • --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

11.64.2. report info

Show a report

Usage

# hammer report <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 11.167. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Host

x

x

 

Reported at

x

x

 

Origin

x

x

 

Report status/applied

x

x

 

Report status/restarted

x

x

 

Report status/failed

x

x

 

Report status/restart failures

x

x

 

Report status/skipped

x

x

 

Report status/pending

x

x

 

Report metrics/config retrieval

x

x

 

Report metrics/exec

x

x

 

Report metrics/file

x

x

 

Report metrics/package

x

x

 

Report metrics/service

x

x

 

Report metrics/user

x

x

 

Report metrics/yumrepo

x

x

 

Report metrics/filebucket

x

x

 

Report metrics/cron

x

x

 

Report metrics/total

x

x

 

Logs/resource

x

x

 

Logs/message

x

x

 

11.64.3. report list

List all reports

Usage

# hammer 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 11.168. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Host

x

x

 

Last report

x

x

 

Origin

x

x

 

Applied

x

x

 

Restarted

x

x

 

Failed

x

x

 

Restart failures

x

x

 

Skipped

x

x

 

Pending

x

x

 

Search / Order fields

  • applied – integer
  • eventful – Values: true, false
  • failed – integer
  • failed_restarts – integer
  • host – string
  • host_id – integer
  • host_owner_id – integer
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_title – string
  • id – integer
  • last_report – datetime
  • location – string
  • log – text
  • organization – string
  • origin – string
  • pending – integer
  • reported – datetime
  • resource – text
  • restarted – integer
  • skipped – integer

Search / Order fields

  • applied – integer
  • eventful – Values: true, false
  • failed – integer
  • failed_restarts – integer
  • host – string
  • host_id – integer
  • host_owner_id – integer
  • hostgroup – string
  • hostgroup_fullname – string
  • hostgroup_title – string
  • id – integer
  • last_report – datetime
  • location – string
  • log – text
  • organization – string
  • origin – string
  • pending – integer
  • reported – datetime
  • resource – text
  • restarted – integer
  • skipped – integer

11.65. report-template

Manipulate report templates

Usage

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

Options

  • -h, --help – Print help

11.65.1. report-template clone

Clone a template

Usage

# hammer report-template clone [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 – Template name
  • --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

11.65.2. report-template create

Create a report template

Usage

# hammer report-template create [OPTIONS]

Options

  • --audit-comment VALUE
  • --default BOOLEAN – Whether or not the template is added automatically to new organizations and locations
  • --description VALUE
  • --file FILE – Path to a file that contains the report template content
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --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
  • --snippet BOOLEAN
  • -h, --help – Print help
  • -i, --interactive – Open empty template in an $EDITOR. Upload the result

11.65.3. report-template delete

Delete a report template

Usage

# hammer report-template <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

11.65.4. report-template dump

View report content

Usage

# hammer report-template dump [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 11.169. Predefined field sets

FIELDS

11.65.5. report-template export

Export a report template to ERB

Usage

# hammer report-template export [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
  • --path VALUE – Path to directory where downloaded content will be saved
  • -h, --help – Print help

11.65.6. report-template generate

Generate report

Usage

# hammer report-template generate [OPTIONS]

Options

  • --gzip BOOLEAN – Compress the report uzing gzip
  • --id VALUE
  • --inputs KEY_VALUE_LIST – Specify inputs
  • --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
  • --path VALUE – Path to directory where downloaded content will be saved
  • --report-format ENUM – Report format, defaults to csv Possible value(s): csv, json, yaml, html
  • -h, --help – Print help

11.65.7. report-template import

Import a report template

Usage

# hammer report-template import [OPTIONS]

Options

  • --associate ENUM – Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s): new, always, never
  • --default BOOLEAN – Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)
  • --file FILE – Path to a file that contains the report template content including metadata
  • --force BOOLEAN – Use if you want update locked templates
  • --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
  • --lock BOOLEAN – Lock imported templates (false by default)
  • --name VALUE – Template name
  • --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

11.65.8. report-template info

Show a report template

Usage

# hammer report-template <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 11.170. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Locked

x

x

 

Default

x

x

 

Created at

x

x

 

Updated at

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Template inputs/id

x

x

 

Template inputs/name

x

x

 

Template inputs/description

x

x

 

Template inputs/required

x

x

 

Template inputs/options

x

x

 

11.65.9. report-template list

List all report templates

Usage

# hammer report-template <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 11.171. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • default – Values: true, false
  • id – integer
  • location – string
  • location_id – integer
  • locked – Values: true, false
  • name – string
  • organization – string
  • organization_id – integer
  • snippet – Values: true, false
  • template – text

11.65.10. report-template report-data

Downloads a generated report

Usage

# hammer report-template report-data [OPTIONS]

Options

  • --id VALUE
  • --job-id VALUE – ID assigned to generating job by the schedule command
  • --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
  • --path VALUE – Path to directory where downloaded content will be saved
  • -h, --help – Print help

11.65.11. report-template schedule

Schedule generating of a report

Usage

# hammer report-template schedule [OPTIONS]

Options

  • --generate-at VALUE – UTC time to generate report at
  • --gzip BOOLEAN – Compress the report using gzip
  • --id VALUE
  • --inputs KEY_VALUE_LIST – Specify inputs
  • --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
  • --mail-to VALUE – If set, scheduled report will be delivered via e-mail. Use , to separate multiple email addresses.
  • --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
  • --path VALUE – Path to directory where downloaded content will be saved. Only usable if wait is specified
  • --report-format ENUM – Report format, defaults to csv Possible value(s): csv, json, yaml, html
  • --wait – Turns a command to be active, wait for the result and download it right away
  • -h, --help – Print help

11.65.12. report-template update

Update a report template

Usage

# hammer report-template update [OPTIONS]

Options

  • --audit-comment VALUE
  • --default BOOLEAN – Whether or not the template is added automatically to new organizations and locations
  • --description VALUE
  • --file FILE – Path to a file that contains the report template content
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --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
  • --snippet BOOLEAN
  • -h, --help – Print help
  • -i, --interactive – Dump existing template and open it in an $EDITOR. Update with the result

11.66. repository

Manipulate repositories

Usage

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

Options

  • -h, --help – Print help

11.66.1. repository create

Create a custom repository

Usage

# hammer repository create [OPTIONS]

Options

  • --ansible-collection-auth-token VALUE – The token key to use for authentication.
  • --ansible-collection-auth-url VALUE – The URL to receive a session token from, e.g. used with Automation Hub.
  • --ansible-collection-requirements VALUE – Contents of requirement yaml file to sync from URL
  • --ansible-collection-requirements-file VALUE Location of the ansible collections requirements.yml file.
  • --arch VALUE – Architecture of content in the repository
  • --checksum-type VALUE – Checksum used for published repository contents. Supported types: sha256, sha384, sha512
  • --content-type VALUE – Type of repository to create. View available types with "hammer repository types"
  • --deb-architectures VALUE – Whitespace-separated list of architectures to be synced from deb-archive
  • --deb-components VALUE – Whitespace-separated list of repo components to be synced from deb-archive
  • --deb-releases VALUE – Whitespace-separated list of releases to be synced from deb-archive
  • --description VALUE – Description of the repository
  • --docker-upstream-name VALUE – Name of the upstream docker repository
  • --download-concurrency NUMBER – Used to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10
  • --download-policy ENUM – Download policy for yum, deb, and docker repos (either immediate or on_demand) Possible value(s): immediate, on_demand
  • --exclude-refs LIST – A comma-separated list of tags to exclude during a sync. The wildcards *, ? are recognized. exclude_refs is evaluated after include_refs.
  • --exclude-tags LIST – Comma-separated list of tags to exclude when syncing a container image repository. Default: any tag ending in “-source”
  • --excludes LIST – Python packages to exclude from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0.
  • --gpg-key-id NUMBER – Id of the gpg key that will be assigned to the new repository
  • --http-proxy VALUE – Name to search by
  • --http-proxy-id NUMBER – ID of a HTTP Proxy
  • --http-proxy-policy ENUM – Policies for HTTP Proxy for content sync Possible value(s): global_default_http_proxy, none, use_selected_http_proxy
  • --ignorable-content LIST – List of content units to ignore while syncing a yum repository. Must be subset of srpm,treeinfo
  • --include-refs LIST – A comma-separated list of refs to include during a sync. The wildcards *, ? are recognized.
  • --include-tags LIST – Comma-separated list of tags to sync for a container image repository
  • --includes LIST – Python packages to include from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. Leave empty to include every package.
  • --label VALUE
  • --metadata-expire NUMBER – Time to expire yum metadata in seconds. Only relevant for custom yum repositories.
  • --mirroring-policy ENUM – Policy to set for mirroring content. Must be one of additive. Possible value(s): additive, mirror_complete, mirror_content_only
  • --name VALUE – Name of the repository
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER
  • --organization-label VALUE – Organization label to search by
  • --organization-title VALUE – Organization title
  • --os-versions LIST – Identifies whether the repository should be unavailable on a client with a non-matching OS version. Pass [] to make repo available for clients regardless of OS version. Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9
  • --package-types LIST – Package types to sync for Python content, separated by comma. Leave empty to get every package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, bdist_rpm, bdist_wheel, bdist_wininst, sdist.
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product the repository belongs to
  • --publish-via-http BOOLEAN – Publish Via HTTP
  • --retain-package-versions-count NUMBER – The maximum number of versions of each package to keep.
  • --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
  • --upstream-authentication-token VALUE – Upstream authentication token string for yum repositories.
  • --upstream-password VALUE – Password of the upstream repository user used for authentication
  • --upstream-username VALUE – Username of the upstream repository user used for authentication
  • --url VALUE – Repository source url
  • --verify-ssl-on-sync BOOLEAN – If true, Katello will verify the upstream url`s SSL certifcates are signed by a trusted CA
  • -h, --help – Print help

11.66.2. repository delete

Destroy a custom repository

Usage

# hammer repository <delete|destroy> [OPTIONS]

Options

  • --delete-empty-repo-filters BOOLEAN – Delete content view filters that have this repository as the last associated repository. Defaults to true. If false, such filters will now apply to all repositories in the content view.
  • --id NUMBER
  • --name VALUE – Repository name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --remove-from-content-view-versions BOOLEAN Force delete the repository by removing it from all content view versions
  • -h, --help – Print help

11.66.3. repository info

Show a repository

Usage

# hammer repository <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Repository ID
  • --name VALUE – Repository 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • -h, --help – Print help
Table 11.172. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Label

x

x

 

Description

x

x

 

Organization

x

x

 

Red hat repository

x

x

 

Content type

x

x

 

Content label

x

x

 

Checksum type

x

x

 

Mirroring policy

x

x

 

Url

x

x

 

Publish via http

x

x

 

Published at

x

x

 

Relative path

x

x

 

Download policy

x

x

 

Metadata expiration

x

x

 

Upstream repository name

x

x

 

Container image tags filter

x

x

 

Container repository name

x

x

 

Ignorable content units

x

x

 

Publish settings/restrict to architecture

x

x

 

Publish settings/restrict to os version

x

x

 

Http proxy/id

x

x

 

Http proxy/name

x

x

 

Http proxy/http proxy policy

x

x

 

Product/id

x

x

 

Product/name

x

x

 

Gpg key/id

x

x

 

Gpg key/name

x

x

 

Sync/status

x

x

 

Sync/last sync date

x

x

 

Created

x

x

 

Updated

x

x

 

Content counts/packages

x

x

 

Content counts/srpms

x

x

 

Content counts/module streams

x

x

 

Content counts/package groups

x

x

 

Content counts/errata

x

x

 

Content counts/debian packages

x

x

 

Content counts/container tags

x

x

 

Content counts/container manifests

x

x

 

Content counts/container manifest lists

x

x

 

Content counts/files

x

x

 

Content counts/ansible collections

x

x

 

Content counts/ostree refs

x

x

 

Content counts/python packages

x

x

 

11.66.4. repository list

List of enabled repositories

Usage

# hammer repository <list|index> [OPTIONS]

Options

  • --ansible-collection VALUE – Name to search by
  • --ansible-collection-id VALUE – Id of an ansible collection to find repositories that contain the ansible collection
  • --archived BOOLEAN – Show archived repositories
  • --available-for VALUE – Interpret specified object to return only Repositories that can be associated with specified object. Only content_view & content_view_version are supported.
  • --content-type VALUE – Limit the repository type to return. View available types with "hammer repository types"
  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – ID of a content view to show repositories in
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER ID of a content view version to show repositories in
  • --deb VALUE – Name to search by
  • --deb-id VALUE – Id of a deb package to find repositories that contain the deb
  • --description VALUE – Description of the repository
  • --download-policy ENUM – Limit to only repositories with this download policy Possible value(s): immediate, on_demand
  • --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)
  • --erratum-id VALUE – Id of an erratum to find repositories that contain the erratum
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --file-id VALUE – Id of a file to find repositories that contain the file
  • --full-result BOOLEAN – Whether or not to show all results
  • --label VALUE – Label of the repository
  • --library BOOLEAN – Show repositories in Library and the default content view
  • --lifecycle-environment VALUE – Lifecycle environment name to search by
  • --lifecycle-environment-id NUMBER ID of an environment to show repositories in
  • --name VALUE – Name of the repository
  • --order VALUE – Sort field and order, eg. id DESC
  • --organization VALUE – Organization name to search by
  • --organization-id NUMBER – ID of an organization to show repositories in
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – ID of a product to show repositories of
  • --rpm-id VALUE – Id of a rpm package to find repositories that contain the rpm
  • --search VALUE – Search string
  • --username VALUE – Only show the repositories readable by this user with this username
  • --with-content VALUE – Limit the repository type to return. View available types with "hammer repository types"
  • -h, --help – Print help
Table 11.173. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Product

x

x

 

Content type

x

x

 

Content label

x

x

 

Url

x

x

 

Search / Order fields

  • container_repository_name – string
  • content_label – string
  • content_type – string
  • content_view_id – integer
  • description – text
  • distribution_arch – string
  • distribution_bootable – boolean
  • distribution_family – string
  • distribution_variant – string
  • distribution_version – string
  • download_policy – string
  • label – string
  • name – string
  • product – string
  • product_id – integer
  • product_name – string
  • redhat – Values: true, false

11.66.5. repository reclaim-space

Reclaim space from an On Demand repository

Usage

# hammer repository reclaim-space [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Repository ID
  • --name VALUE – Repository name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • -h, --help – Print help

11.66.6. repository remove-content

Remove content from a repository

Usage

# hammer repository remove-content [OPTIONS]

Options

  • --content-type VALUE – The type of content unit to remove (srpm, docker_manifest, etc.). View removable types with "hammer repository types"
  • --id NUMBER – Repository ID
  • --ids LIST – Array of content ids to remove
  • --name VALUE – Repository name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --sync-capsule BOOLEAN – Whether or not to sync an external capsule after upload. Default: true
  • -h, --help – Print help

11.66.7. repository republish

Forces a republish of the specified repository.

Usage

# hammer repository republish [OPTIONS]

Options

  • --async – Do not wait for the task
  • --force BOOLEAN – Force metadata regeneration to proceed. Dangerous when repositories use the Complete Mirroring mirroring policy
  • --id NUMBER – Repository identifier
  • --name VALUE – Repository name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • -h, --help – Print help

11.66.8. repository synchronize

Sync a repository

Usage

# hammer repository synchronize [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Repository ID
  • --incremental BOOLEAN – Perform an incremental import
  • --name VALUE – Repository 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --skip-metadata-check BOOLEAN Force sync even if no upstream changes are detected. Only used with yum or deb repositories.
  • --validate-contents BOOLEAN – Force a sync and validate the checksums of all content. Only used with yum repositories.
  • -h, --help – Print help

11.66.9. repository types

Show the available repository types

Usage

# hammer repository types [OPTIONS]

Options

  • --creatable BOOLEAN – When set to True repository types that are creatable will be returned
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • -h, --help – Print help
Table 11.174. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

Content types/type

x

x

 

Content types/generic?

x

x

 

Content types/removable?

x

x

 

Content types/uploadable?

x

x

 

Content types/indexed?

x

x

 

11.66.10. repository update

Update a repository

Usage

# hammer repository update [OPTIONS]

Options

  • --ansible-collection-auth-token VALUE – The token key to use for authentication.
  • --ansible-collection-auth-url VALUE – The URL to receive a session token from, e.g. used with Automation Hub.
  • --ansible-collection-requirements VALUE – Contents of requirement yaml file to sync from URL
  • --ansible-collection-requirements-file VALUE Location of the ansible collections requirements.yml file.
  • --arch VALUE – Architecture of content in the repository
  • --checksum-type VALUE – Checksum used for published repository contents. Supported types: sha256, sha384, sha512
  • --deb-architectures VALUE – Whitespace-separated list of architectures to be synced from deb-archive
  • --deb-components VALUE – Whitespace-separated list of repo components to be synced from deb-archive
  • --deb-releases VALUE – Whitespace-separated list of releases to be synced from deb-archive
  • --description VALUE – Description of the repository
  • --docker-digest VALUE – Container Image manifest digest
  • --docker-tag VALUE – Container Image tag
  • --docker-upstream-name VALUE – Name of the upstream docker repository
  • --download-concurrency NUMBER – Used to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10
  • --download-policy ENUM – Download policy for yum, deb, and docker repos (either immediate or on_demand) Possible value(s): immediate, on_demand
  • --exclude-refs LIST – A comma-separated list of tags to exclude during a sync. The wildcards *, ? are recognized. exclude_refs is evaluated after include_refs.
  • --exclude-tags LIST – Comma-separated list of tags to exclude when syncing a container image repository. Default: any tag ending in “-source”
  • --excludes LIST – Python packages to exclude from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0.
  • --gpg-key-id NUMBER – Id of the gpg key that will be assigned to the new repository
  • --http-proxy VALUE – Name to search by
  • --http-proxy-id NUMBER – ID of a HTTP Proxy
  • --http-proxy-policy ENUM – Policies for HTTP Proxy for content sync Possible value(s): global_default_http_proxy, none, use_selected_http_proxy
  • --id NUMBER – Repository ID
  • --ignorable-content LIST – List of content units to ignore while syncing a yum repository. Must be subset of srpm,treeinfo
  • --include-refs LIST – A comma-separated list of refs to include during a sync. The wildcards *, ? are recognized.
  • --include-tags LIST – Comma-separated list of tags to sync for a container image repository
  • --includes LIST – Python packages to include from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. Leave empty to include every package.
  • --metadata-expire NUMBER – Time to expire yum metadata in seconds. Only relevant for custom yum repositories.
  • --mirroring-policy ENUM – Policy to set for mirroring content. Must be one of additive. Possible value(s): additive, mirror_complete, mirror_content_only
  • --name VALUE
  • --new-name VALUE
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --os-versions LIST – Identifies whether the repository should be unavailable on a client with a non-matching OS version. Pass [] to make repo available for clients regardless of OS version. Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9
  • --package-types LIST – Package types to sync for Python content, separated by comma. Leave empty to get every package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, bdist_rpm, bdist_wheel, bdist_wininst, sdist.
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --publish-via-http BOOLEAN – Publish Via HTTP
  • --retain-package-versions-count NUMBER – The maximum number of versions of each package to keep.
  • --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
  • --upstream-authentication-token VALUE – Upstream authentication token string for yum repositories.
  • --upstream-password VALUE – Password of the upstream repository user used for authentication
  • --upstream-username VALUE – Username of the upstream repository user used for authentication
  • --url VALUE – Repository source url
  • --verify-ssl-on-sync BOOLEAN – If true, Katello will verify the upstream url`s SSL certifcates are signed by a trusted CA
  • -h, --help – Print help

11.66.11. repository upload-content

This endpoint is primarily designed for UI interactions and uploading content into the repository. For API-based uploads, please use the 'content_uploads' endpoint instead.

Usage

# hammer repository upload-content [OPTIONS]

Options

  • --async – Do not wait for the task.
  • --content-type VALUE – The type of content unit to upload (srpm, file, etc.). View uploadable types with "hammer repository types"
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Repository ID
  • --name VALUE – Repository 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
  • --ostree-repository-name VALUE Name of OSTree repository in archive.
  • --path FILE – Upload file, directory of files, or glob of files as content for a repository. Globs must be escaped by single or double quotes
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • -h, --help – Print help
Table 11.175. Predefined field sets

FIELDS

11.66.12. repository verify-checksum

Verify checksum of repository contents

Usage

# hammer repository verify-checksum [OPTIONS]

Options

  • --async – Do not wait for the task
  • --id NUMBER – Repository ID
  • --name VALUE – Repository name to search by
  • --organization VALUE – Organization name to search by
  • --organization-id VALUE – Organization ID to search by
  • --organization-label VALUE – Organization label to search by
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • -h, --help – Print help

11.67. repository-set

Manipulate repository sets on the server

Usage

# hammer repository-set [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.67.1. repository-set available-repositories

Get list of available repositories for the repository set

Usage

# hammer repository-set available-repositories [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – ID of the repository set
  • --name VALUE – Repository set 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – ID of a product to list repository sets from
  • -h, --help – Print help
Table 11.176. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

Arch

x

x

 

Release

x

x

 

Registry name

x

x

 

Enabled

x

x

 

11.67.2. repository-set disable

Disable a repository from the set

Usage

# hammer repository-set disable [OPTIONS]

Options

  • --basearch VALUE – Basearch to disable
  • --id NUMBER – ID of the repository set to disable
  • --name VALUE – Repository set 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – ID of the product containing the repository set
  • --releasever VALUE – Releasever to disable
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – ID of the repository within the set to disable
  • -h, --help – Print help

11.67.3. repository-set enable

Enable a repository from the set

Usage

# hammer repository-set enable [OPTIONS]

Options

  • --basearch VALUE – Basearch to enable
  • --id NUMBER – ID of the repository set to enable
  • --name VALUE – Repository set 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – ID of the product containing the repository set
  • --releasever VALUE – Releasever to enable
  • -h, --help – Print help

11.67.4. repository-set info

Get info about a repository set

Usage

# hammer repository-set <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – ID of the repository set
  • --name VALUE – Repository set 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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – ID of a product to list repository sets from
  • -h, --help – Print help
Table 11.177. 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

 

Enabled repositories/id

x

x

 

Enabled repositories/name

x

x

 

11.67.5. repository-set list

List repository sets.

Usage

# hammer repository-set <list|index> [OPTIONS]

Options

  • --activation-key VALUE – Activation key name to search by
  • --activation-key-id NUMBER – Activation key identifier
  • --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 host`s or activation key`s content view version and lifecycle environment.
  • --enabled BOOLEAN – If true, only return repository sets that have been enabled. Defaults to false
  • --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 NUMBER – Id of the host
  • --name VALUE – Repository set name to search on
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – ID of a product to list repository sets from
  • --repository-type ENUM – Limit content to Red Hat / custom Possible value(s): redhat, custom
  • --search VALUE – Search string
  • --status ENUM – Limit content to enabled / disabled / overridden Possible value(s): enabled, disabled, overridden
  • --with-active-subscription BOOLEAN If true, only return repository sets that are associated with an active subscriptions
  • --with-custom BOOLEAN – If true, return custom repository sets along with redhat repos. Will be ignored if repository_type is supplied.
  • -h, --help – Print help
Table 11.178. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Type

x

x

 

Name

x

x

x

Search / Order fields

  • content_label – string
  • content_type – string
  • enabled_by_default – Values: true, false
  • label – string
  • name – string
  • path – string
  • product – string
  • product_id – integer
  • product_name – string
  • redhat – Values: true, false

11.68. role

Manage user roles

Usage

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

Options

  • -h, --help – Print help

11.68.1. role clone

Clone a role

Usage

# hammer role clone [OPTIONS]

Options

  • --description VALUE – Role description
  • --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

11.68.2. role create

Create a role

Usage

# hammer role create [OPTIONS]

Options

  • --description VALUE – Role description
  • --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
  • -h, --help – Print help

11.68.3. role delete

Delete a role

Usage

# hammer role <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 – User role 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

11.68.4. role filters

List all filters

Usage

# hammer role filters [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – User role 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
  • --name VALUE – User role name
  • --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
  • -h, --help – Print help
Table 11.179. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Resource type

x

x

 

Search

x

x

 

Unlimited?

x

x

 

Override?

x

x

 

Role

x

x

 

Permissions

x

x

 

11.68.5. role info

Show a role

Usage

# hammer role <info|show> [OPTIONS]

Options

  • --description VALUE
  • --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 – User role 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 11.180. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Builtin

x

x

 

Description

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

11.68.6. role list

List all roles

Usage

# hammer role <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 11.181. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Builtin

x

x

 

Search / Order fields

  • builtin – Values: true, false
  • description – text
  • id – integer
  • locked – Values: true, false
  • name – string
  • permission – string

11.68.7. role update

Update a role

Usage

# hammer role update [OPTIONS]

Options

  • --description VALUE – Role description
  • --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

11.69. scap-content

Manipulate SCAP contents

Usage

# hammer scap-content [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.69.1. scap-content bulk-upload

Upload scap contents in bulk

Usage

# hammer scap-content bulk-upload [OPTIONS]

Options

  • --directory VALUE – Directory to upload when using “directory” upload type
  • --files LIST – File paths to upload when using “files” upload type
  • --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
  • --type ENUM – Type of the upload Possible value(s): files, directory, default
  • -h, --help – Print help

11.69.2. scap-content create

Create SCAP content

Usage

# hammer scap-content create [OPTIONS]

Options

  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --locations LIST
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organizations LIST
  • --original-filename VALUE – Original file name of the XML file
  • --scap-file FILE – SCAP content file
  • --title VALUE – SCAP content name
  • -h, --help – Print help

11.69.3. scap-content delete

Deletes an SCAP content

Usage

# hammer scap-content <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
  • --title VALUE – SCAP content title
  • -h, --help – Print help

11.69.4. scap-content download

Download an SCAP content as XML

Usage

# hammer scap-content 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
  • --title VALUE – SCAP content title
  • -h, --help – Print help

11.69.5. scap-content info

Show an SCAP content

Usage

# hammer scap-content <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
  • --title VALUE – SCAP content title
  • -h, --help – Print help
Table 11.182. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Digest

x

x

 

Created at

x

x

 

Original filename

x

x

 

Scap content profiles/id

x

x

 

Scap content profiles/profile id

x

x

 

Scap content profiles/title

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

11.69.6. scap-content list

List SCAP contents

Usage

# hammer scap-content <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 11.183. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Digest

x

x

 

Search / Order fields

  • created_at – datetime
  • filename – string
  • location – string
  • location_id – integer
  • organization – string
  • organization_id – integer
  • title – string

11.69.7. scap-content update

Update an SCAP content

Usage

# hammer scap-content update [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --locations LIST
  • --new-title VALUE – SCAP content name
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organizations LIST
  • --original-filename VALUE – Original file name of the XML file
  • --scap-file FILE – SCAP content file
  • --title VALUE – SCAP content name
  • -h, --help – Print help

11.70. scap-content-profile

Manipulate Scap Content Profiles

Usage

# hammer scap-content-profile [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.70.1. scap-content-profile list

List SCAP content profiles

Usage

# hammer scap-content-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 11.184. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

 

Profile id

x

x

 

Scap content id

x

x

 

Scap content title

x

x

 

Tailoring file id

x

x

 

Tailoring file name

x

x

x

Search / Order fields

  • profile_id – string
  • title – string

11.71. settings

Change server settings

Usage

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

Options

  • -h, --help – Print help

11.71.1. settings info

Show a setting

Usage

# hammer settings <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 – Setting 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 11.185. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Category

x

x

 

Settings type

x

x

 

Value

x

x

 

11.71.2. settings list

List all settings

Usage

# hammer settings <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 11.186. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Full name

x

x

 

Value

x

x

 

Description

x

x

 

Search / Order fields

  • description
  • id – integer
  • name – string

11.71.3. settings set

Update a setting

Usage

# hammer settings set [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 – Setting 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
  • --value VALUE
  • -h, --help – Print help

11.72. shell

Interactive shell

Usage

# hammer shell [OPTIONS]

Options

  • -h, --help – Print help

11.73. srpm

Manipulate source RPMs

Usage

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

Options

  • -h, --help – Print help

11.73.1. srpm info

Show SRPM details

Usage

# hammer srpm <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – SRPM details identifier
  • --name VALUE – 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
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • -h, --help – Print help
Table 11.187. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Version

x

x

 

Architecture

x

x

 

Epoch

x

x

 

Release

x

x

 

Filename

x

x

 

Description

x

x

 

11.73.2. srpm list

List srpms

Usage

# hammer srpm <list|index> [OPTIONS]

Options

  • --content-view VALUE – Content view name to search by
  • --content-view-id NUMBER – Content view numeric identifier
  • --content-view-version VALUE – Content view version number
  • --content-view-version-id NUMBER Content View Version 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
  • --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
  • --product VALUE – Product name to search by
  • --product-id NUMBER – Product numeric identifier
  • --repository VALUE – Repository name to search by
  • --repository-id NUMBER – Repository identifier
  • --search VALUE – Search string
  • -h, --help – Print help
Table 11.188. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Filename

x

x

 

11.74. status

Get the complete status of the server and/or it’s subcomponents

Usage

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

Options

  • -h, --help – Print help

11.74.1. status foreman

Shows status and version information of Satellite system and it’s subcomponents

Usage

# hammer status foreman [OPTIONS]

Options

  • -h, --help – Print help

11.74.2. status katello

Shows version information

Usage

# hammer status katello [OPTIONS]

Options

  • -h, --help – Print help

11.75. subnet

Manipulate subnets

Usage

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

Options

  • -h, --help – Print help

11.75.1. subnet create

Create a subnet

Usage

# hammer subnet create [OPTIONS]

Options

  • --bmc VALUE – BMC Proxy to use within this subnet
  • --bmc-id NUMBER – BMC Capsule ID to use within this subnet
  • --boot-mode ENUM – Default boot mode for interfaces assigned to this subnet. Possible value(s): Static, DHCP
  • --description VALUE – Subnet description
  • --dhcp VALUE – DHCP Proxy to use within this subnet
  • --dhcp-id NUMBER – DHCP Capsule ID to use within this subnet
  • --discovery-id NUMBER – ID of Discovery Capsule to use within this subnet for managing connection to discovered hosts
  • --dns VALUE – DNS Proxy to use within this subnet
  • --dns-id NUMBER – DNS Capsule ID to use within this subnet
  • --dns-primary VALUE – Primary DNS for this subnet
  • --dns-secondary VALUE – Secondary DNS for this subnet
  • --domain-ids LIST – Domains in which this subnet is part
  • --domains LIST
  • --externalipam-group VALUE – External IPAM group - only relevant when IPAM is set to external
  • --externalipam-id NUMBER – External IPAM Capsule ID to use within this subnet
  • --from VALUE – Starting IP Address for IP auto suggestion
  • --gateway VALUE – Subnet gateway
  • --httpboot-id NUMBER – HTTPBoot Capsule ID to use within this subnet
  • --ipam ENUM – IP Address auto suggestion mode for this subnet. Possible value(s): DHCP, Internal DB, Random DB, EUI-64, External IPAM, None
  • --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
  • --mask VALUE – Netmask for this subnet
  • --mtu NUMBER – MTU for this subnet
  • --name VALUE – Subnet name
  • --network VALUE – Subnet network
  • --network-type ENUM – Type or protocol, IPv4 or IPv6, defaults to IPv4 Possible value(s): IPv4, IPv6
  • --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
  • --prefix VALUE – Network prefix in CIDR notation (e.g. 64) for this subnet
  • --remote-execution-proxy-ids LIST List of Capsule IDs to be used for remote execution
  • --template-id NUMBER – Template HTTP(S) Capsule ID to use within this subnet
  • --tftp VALUE – TFTP Proxy to use within this subnet
  • --tftp-id NUMBER – TFTP Capsule ID to use within this subnet
  • --to VALUE – Ending IP Address for IP auto suggestion
  • --vlanid VALUE – VLAN ID for this subnet
  • -h, --help – Print help

11.75.2. subnet delete

Delete a subnet

Usage

# hammer subnet <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – Subnet numeric identifier
  • --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 – Subnet 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

11.75.3. subnet delete-parameter

Delete parameter for a subnet

Usage

# hammer subnet delete-parameter [OPTIONS]

Options

  • --name VALUE – Parameter name
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER
  • -h, --help – Print help

11.75.4. subnet info

Show a subnet

Usage

# hammer subnet <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 – Subnet 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
  • --show-hidden-parameters BOOLEAN Display hidden parameter values
  • -h, --help – Print help
Table 11.189. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Protocol

x

x

 

Priority

x

x

 

Network addr

x

x

 

Network prefix

x

x

 

Network mask

x

x

 

Gateway addr

x

x

 

Primary dns

x

x

 

Secondary dns

x

x

 

Smart proxies/dns

x

x

 

Smart proxies/tftp

x

x

 

Smart proxies/dhcp

x

x

 

Remote execution proxies/id

x

x

 

Remote execution proxies/name

x

x

 

Ipam

x

x

 

Start of ip range

x

x

 

End of ip range

x

x

 

Vlan id

x

x

 

Mtu

x

x

 

Boot mode

x

x

 

Domains/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Parameters/

x

x

 

11.75.5. subnet list

List of subnets

Usage

# hammer subnet <list|index> [OPTIONS]

Options

  • --domain VALUE – Domain name
  • --domain-id VALUE – ID of domain
  • --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 11.190. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Network addr

x

x

 

Network prefix

x

x

 

Network mask

x

x

 

Vlan id

x

x

 

Boot mode

x

x

 

Gateway address

x

x

 

Search / Order fields

  • boot_mode – string
  • dns_primary – string
  • dns_secondary – string
  • domain – string
  • gateway – string
  • id – integer
  • ipam – string
  • location – string
  • location_id – integer
  • mask – string
  • mtu – integer
  • name – text
  • network – string
  • nic_delay – integer
  • organization – string
  • organization_id – integer
  • params – string
  • type – string
  • vlanid – integer

11.75.6. subnet set-parameter

Create or update parameter for a subnet

Usage

# hammer subnet set-parameter [OPTIONS]

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --name VALUE – Parameter name
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --subnet VALUE – Subnet name
  • --subnet-id NUMBER
  • --value VALUE – Parameter value
  • -h, --help – Print help

11.75.7. subnet update

Update a subnet

Usage

# hammer subnet update [OPTIONS]

Options

  • --bmc VALUE – BMC Proxy to use within this subnet
  • --bmc-id NUMBER – BMC Capsule ID to use within this subnet
  • --boot-mode ENUM – Default boot mode for interfaces assigned to this subnet. Possible value(s): Static, DHCP
  • --description VALUE – Subnet description
  • --dhcp VALUE – DHCP Proxy to use within this subnet
  • --dhcp-id NUMBER – DHCP Capsule ID to use within this subnet
  • --discovery-id NUMBER – ID of Discovery Capsule to use within this subnet for managing connection to discovered hosts
  • --dns VALUE – DNS Proxy to use within this subnet
  • --dns-id NUMBER – DNS Capsule ID to use within this subnet
  • --dns-primary VALUE – Primary DNS for this subnet
  • --dns-secondary VALUE – Secondary DNS for this subnet
  • --domain-ids LIST – Domains in which this subnet is part
  • --domains LIST
  • --externalipam-group VALUE – External IPAM group - only relevant when IPAM is set to external
  • --externalipam-id NUMBER – External IPAM Capsule ID to use within this subnet
  • --from VALUE – Starting IP Address for IP auto suggestion
  • --gateway VALUE – Subnet gateway
  • --httpboot-id NUMBER – HTTPBoot Capsule ID to use within this subnet
  • --id NUMBER – Subnet numeric identifier
  • --ipam ENUM – IP Address auto suggestion mode for this subnet. Possible value(s): DHCP, Internal DB, Random DB, EUI-64, External IPAM, None
  • --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
  • --mask VALUE – Netmask for this subnet
  • --mtu NUMBER – MTU for this subnet
  • --name VALUE – Subnet name
  • --network VALUE – Subnet network
  • --network-type ENUM – Type or protocol, IPv4 or IPv6, defaults to IPv4 Possible value(s): IPv4, IPv6
  • --new-name VALUE – Subnet name
  • --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
  • --prefix VALUE – Network prefix in CIDR notation (e.g. 64) for this subnet
  • --remote-execution-proxy-ids LIST List of Capsule IDs to be used for remote execution
  • --template-id NUMBER – Template HTTP(S) Capsule ID to use within this subnet
  • --tftp VALUE – TFTP Proxy to use within this subnet
  • --tftp-id NUMBER – TFTP Capsule ID to use within this subnet
  • --to VALUE – Ending IP Address for IP auto suggestion
  • --vlanid VALUE – VLAN ID for this subnet
  • -h, --help – Print help

11.76. subscription

Manipulate subscriptions

Usage

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

Options

  • -h, --help – Print help

11.76.1. subscription delete-manifest

Delete manifest from Red Hat provider

Usage

# hammer subscription delete-manifest [OPTIONS]

Options

  • --async – Do not wait for the task
  • --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

11.76.2. subscription list

List organization subscriptions

Usage

# hammer subscription <list|index> [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
  • --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 – Name of the subscription
  • --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 11.191. Predefined field sets
FIELDSALLDEFAULT

Id

x

x

Uuid

x

x

Name

x

x

Type

x

x

Contract

x

x

Account

x

x

Support

x

x

Start date

x

x

End date

x

x

Quantity

x

x

Consumed

x

x

11.76.3. subscription manifest-history

obtain manifest history for subscriptions

Usage

# hammer subscription manifest-history [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --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
Table 11.192. Predefined field sets
FIELDSALLDEFAULT

Status

x

x

Status message

x

x

Time

x

x

11.76.4. subscription refresh-manifest

Refresh previously imported manifest for Red Hat provider

Usage

# hammer subscription refresh-manifest [OPTIONS]

Options

  • --async – Do not wait for the task
  • --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

11.76.5. subscription upload

Upload a subscription manifest

Usage

# hammer subscription upload [OPTIONS]

Options

  • --async – Do not wait for the task
  • --file FILE – Subscription manifest file
  • --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

11.77. sync-plan

Manipulate sync plans

Usage

# hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.77.1. sync-plan create

Create a sync plan

Usage

# hammer sync-plan create [OPTIONS]

Options

  • --cron-expression VALUE – Set this when interval is custom cron
  • --description VALUE – Sync plan description
  • --enabled BOOLEAN – Enables or disables synchronization
  • --interval VALUE – How often synchronization should run
  • --name VALUE – Sync plan name
  • --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
  • --sync-date DATETIME – Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered
  • -h, --help – Print help

11.77.2. sync-plan delete

Destroy a sync plan

Usage

# hammer sync-plan <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – Sync plan numeric identifier
  • --name VALUE – Sync plan 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

11.77.3. sync-plan info

Show a sync plan

Usage

# hammer sync-plan <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id NUMBER – Sync plan numeric identifier
  • --name VALUE – Sync plan 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
Table 11.193. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Start date

x

x

 

Interval

x

x

 

Enabled

x

x

 

Cron expression

x

x

 

Recurring logic id

x

x

 

Description

x

x

 

Created at

x

x

 

Updated at

x

x

 

Next sync

x

x

 

Products/id

x

x

 

Products/name

x

x

 

11.77.4. sync-plan list

List sync plans

Usage

# hammer sync-plan <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
  • --interval ENUM – Filter by interval Possible value(s): hourly, daily, weekly, custom cron
  • --name VALUE – Filter by name
  • --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
  • --sync-date VALUE – Filter by sync date
  • -h, --help – Print help
Table 11.194. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Start date

x

x

 

Interval

x

x

 

Enabled

x

x

 

Cron expression

x

x

 

Recurring logic id

x

x

 

Search / Order fields

  • enabled – Values: true, false
  • interval – string
  • name – string
  • organization_id – integer

11.77.5. sync-plan update

Update a sync plan

Usage

# hammer sync-plan update [OPTIONS]

Options

  • --cron-expression VALUE – Add custom cron logic for sync plan
  • --description VALUE – Sync plan description
  • --enabled BOOLEAN – Enables or disables synchronization
  • --id NUMBER – Sync plan numeric identifier
  • --interval VALUE – How often synchronization should run
  • --name VALUE – Sync plan name
  • --new-name VALUE – Sync plan name
  • --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
  • --sync-date DATETIME – Start date and time of the synchronization
  • -h, --help – Print help

11.78. tailoring-file

Manipulate Tailoring files

Usage

# hammer tailoring-file [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.78.1. tailoring-file create

Create a Tailoring file

Usage

# hammer tailoring-file create [OPTIONS]

Options

  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --locations LIST
  • --name VALUE – Tailoring file name
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organizations LIST
  • --original-filename VALUE – Original file name of the XML file
  • --scap-file FILE – Tailoring file content
  • -h, --help – Print help

11.78.2. tailoring-file delete

Deletes a Tailoring file

Usage

# hammer tailoring-file <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

11.78.3. tailoring-file download

Download a Tailoring file as XML

Usage

# hammer tailoring-file download [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --name VALUE – Tailoring file name
  • --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

11.78.4. tailoring-file info

Show a Tailoring file

Usage

# hammer tailoring-file <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
  • --name VALUE – Tailoring file name
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • -h, --help – Print help
Table 11.195. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Created at

x

x

 

Original filename

x

x

 

Tailoring file profiles/id

x

x

 

Tailoring file profiles/profile id

x

x

 

Tailoring file profiles/title

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

11.78.5. tailoring-file list

List Tailoring files

Usage

# hammer tailoring-file <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 11.196. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • created_at – datetime
  • filename – string
  • location – string
  • location_id – integer
  • name – string
  • organization – string
  • organization_id – integer

11.78.6. tailoring-file update

Update a Tailoring file

Usage

# hammer tailoring-file update [OPTIONS]

Options

  • --id VALUE
  • --location VALUE – Name to search by
  • --location-id NUMBER – Set the current location context for the request
  • --location-ids LIST – REPLACE locations with given ids
  • --locations LIST
  • --name VALUE – Tailoring file name
  • --new-name VALUE – Tailoring file name
  • --organization VALUE – Name to search by
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-ids LIST – REPLACE organizations with given ids.
  • --organizations LIST
  • --original-filename VALUE – Original file name of the XML file
  • --scap-file FILE – Tailoring file content
  • -h, --help – Print help

11.79. task

Tasks related actions.

Usage

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

Options

  • -h, --help – Print help

11.79.1. task info

Show task details

Usage

# hammer task <info|show> [OPTIONS]

Options

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

Id

x

x

Action

x

x

State

x

x

Result

x

x

Started at

x

x

Ended at

x

x

Duration

x

x

Owner

x

x

Task errors

x

x

11.79.2. task list

List tasks

Usage

# hammer task <list|index> [OPTIONS]

Options

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

Id

x

x

Action

x

x

State

x

x

Result

x

x

Started at

x

x

Ended at

x

x

Duration

x

x

Owner

x

x

Task errors

x

x

11.79.3. task progress

Show the progress of the task

Usage

# hammer task progress [OPTIONS]

Options

  • --id VALUE – UUID of the task
  • --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

11.79.4. task resume

Resume all tasks paused in error state

Usage

# hammer task resume [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
  • --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
  • --search VALUE – Resume tasks matching search string
  • --task-ids LIST – Resume specific tasks by ID
  • --tasks LIST
  • -h, --help – Print help
Table 11.199. Predefined field sets
FIELDSALLDEFAULT

Total tasks found paused in error state

x

x

Total tasks resumed

x

x

Resumed tasks/task identifier

x

x

Resumed tasks/task action

x

x

Resumed tasks/task errors

x

x

Total tasks failed to resume

x

x

Failed tasks/task identifier

x

x

Failed tasks/task action

x

x

Failed tasks/task errors

x

x

Total tasks skipped

x

x

Skipped tasks/task identifier

x

x

Skipped tasks/task action

x

x

Skipped tasks/task errors

x

x

11.80. template

Manipulate provisioning templates

Usage

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

Options

  • -h, --help – Print help

11.80.1. template add-operatingsystem

Associate an operating system

Usage

# hammer template add-operatingsystem [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER
  • -h, --help – Print help

11.80.2. template build-pxe-default

Update the default PXE menu on all configured TFTP servers

Usage

# hammer template build-pxe-default [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
  • -h, --help – Print help

11.80.3. template clone

Clone a provision template

Usage

# hammer template clone [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 – Template name
  • --new-name VALUE – Template 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

11.80.4. template combination

Manage template combinations

Usage

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

Options

  • -h, --help – Print help
11.80.4.1. template combination create

Add a template combination

Usage

# hammer template combination create [OPTIONS]

Options

  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id VALUE – ID of host group
  • --hostgroup-title VALUE – Hostgroup title
  • --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
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id VALUE ID of config template
  • -h, --help – Print help
11.80.4.2. template combination delete

Delete a template combination

Usage

# hammer template combination <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
  • --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
11.80.4.3. template combination info

Show template combination

Usage

# hammer template combination <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id VALUE – ID of host group
  • --hostgroup-title VALUE – Hostgroup title
  • --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
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id VALUE ID of config template
  • -h, --help – Print help
Table 11.200. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Provisioning template id

x

x

 

Provisioning template name

x

x

 

Hostgroup id

x

x

 

Hostgroup name

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 
11.80.4.4. template combination list

List template combination

Usage

# hammer template combination <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
  • --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
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id VALUE ID of config template
  • -h, --help – Print help
Table 11.201. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Provisioning template

x

x

 

Hostgroup

x

x

 
11.80.4.5. template combination update

Update template combination

Usage

# hammer template combination update [OPTIONS]

Options

  • --hostgroup VALUE – Hostgroup name
  • --hostgroup-id VALUE – ID of host group
  • --hostgroup-title VALUE – Hostgroup title
  • --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
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id VALUE ID of config template
  • -h, --help – Print help

11.80.5. template create

Create a provisioning template

Usage

# hammer template create [OPTIONS]

Options

  • --audit-comment VALUE
  • --description VALUE
  • --file FILE – Path to a file that contains the template
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --name VALUE – Template name
  • --operatingsystem-ids LIST – Array of operating system IDs to associate with the template
  • --operatingsystems LIST
  • --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
  • --type VALUE – Template type. Eg. snippet, script, provision
  • -h, --help – Print help

11.80.6. template delete

Delete a provisioning template

Usage

# hammer template <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

11.80.7. template dump

View provisioning template content

Usage

# hammer template dump [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 11.202. Predefined field sets

FIELDS

11.80.8. template export

Export a provisioning template to ERB

Usage

# hammer template export [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
  • --path VALUE – Path to directory where downloaded content will be saved
  • -h, --help – Print help

11.80.9. template import

Import a provisioning template

Usage

# hammer template import [OPTIONS]

Options

  • --associate ENUM – Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s): new, always, never
  • --default BOOLEAN – Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)
  • --file FILE – Path to a file that contains the template content including metadata
  • --force BOOLEAN – Use if you want update locked templates
  • --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
  • --lock BOOLEAN – Lock imported templates (false by default)
  • --name VALUE – Template name
  • --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

11.80.10. template info

Show provisioning template details

Usage

# hammer template <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 11.203. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Type

x

x

 

Description

x

x

 

Locked

x

x

 

Operating systems/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Template combinations/hostgroup name

x

x

 

Template combinations/environment name

x

x

 

11.80.11. template kinds

List available provisioning template kinds

Usage

# hammer template kinds [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • -h, --help – Print help
Table 11.204. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

11.80.12. template list

List provisioning templates

Usage

# hammer template <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
  • --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 – 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 11.205. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Type

x

x

 

Search / Order fields

  • default_template – Values: true, false
  • hostgroup – string
  • id – integer
  • kind – string
  • location – string
  • location_id – integer
  • locked – Values: true, false
  • name – string
  • operatingsystem – string
  • organization – string
  • organization_id – integer
  • snippet – Values: true, false
  • supported – Values: true, false
  • template – text
  • vendor – string

11.80.13. template remove-operatingsystem

Disassociate an operating system

Usage

# hammer template remove-operatingsystem [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER
  • -h, --help – Print help

11.80.14. template update

Update a provisioning template

Usage

# hammer template update [OPTIONS]

Options

  • --audit-comment VALUE
  • --description VALUE
  • --file FILE – Path to a file that contains the template
  • --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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --name VALUE – Template name
  • --new-name VALUE – Template name
  • --operatingsystem-ids LIST – Array of operating system IDs to associate with the template
  • --operatingsystems LIST
  • --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
  • --type VALUE – Template type. Eg. snippet, script, provision
  • -h, --help – Print help

11.81. template-input

Manage template inputs

Usage

# hammer template-input [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.81.1. template-input create

Create a template input

Usage

# hammer template-input create [OPTIONS]

Options

  • --advanced BOOLEAN – Input is advanced
  • --default VALUE – Default value for user input
  • --description VALUE – Input description
  • --fact-name VALUE – Fact name, used when input type is Fact value
  • --hidden-value BOOLEAN – The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords
  • --input-type ENUM – Input type Possible value(s): user, fact, variable
  • --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 – Input name
  • --options LIST – Selectable values for user inputs
  • --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
  • --required BOOLEAN – Input is required
  • --resource-type ENUM – For values of type search, this is the resource the value searches in Possible value(s): AnsibleRole, AnsibleVariable, Architecture, Audit, AuthSource, Bookmark, ComputeProfile, ComputeResource, ConfigReport, DiscoveryRule, Domain, ExternalUsergroup, FactValue, Filter, ForemanOpenscap::ArfReport, ForemanOpenscap::Policy, ForemanOpenscap::ScapContent, ForemanOpenscap::TailoringFile, ForemanTasks::RecurringLogic, ForemanTasks::Task, ForemanVirtWhoConfigure::Config, Host, Hostgroup, HttpProxy, Image, InsightsHit, JobInvocation, JobTemplate, Katello::ActivationKey, Katello::AlternateContentSource, Katello::ContentCredential, Katello::ContentView, Katello::HostCollection, Katello::KTEnvironment, Katello::Product, Katello::Subscription, Katello::SyncPlan, KeyPair, Location, LookupValue, MailNotification, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Realm, RemoteExecutionFeature, ReportTemplate, Role, Setting, SmartProxy, SshKey, Subnet, Template, TemplateInvocation, User, Usergroup, Webhook, WebhookTemplate
  • --template-id VALUE
  • --value-type ENUM – Value type, defaults to plain Possible value(s): plain, search, date, resource
  • --variable-name VALUE – Variable name, used when input type is Variable
  • -h, --help – Print help

11.81.2. template-input delete

Delete a template input

Usage

# hammer template-input <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
  • --template-id VALUE
  • -h, --help – Print help

11.81.3. template-input info

Show template input details

Usage

# hammer template-input <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
  • --template-id VALUE
  • -h, --help – Print help
Table 11.206. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Input type

x

x

 

Fact name

x

x

 

Variable name

x

x

 

Puppet parameter name

x

x

 

Options

x

x

 

Default value

x

x

 

11.81.4. template-input list

List template inputs

Usage

# hammer template-input <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
  • --template-id VALUE
  • -h, --help – Print help
Table 11.207. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Input type

x

x

 

Search / Order fields

  • id – integer
  • input_type – string
  • name – string

11.81.5. template-input update

Update a template input

Usage

# hammer template-input update [OPTIONS]

Options

  • --advanced BOOLEAN – Input is advanced
  • --default VALUE – Default value for user input
  • --description VALUE – Input description
  • --fact-name VALUE – Fact name, used when input type is Fact value
  • --hidden-value BOOLEAN – The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords
  • --id VALUE
  • --input-type ENUM – Input type Possible value(s): user, fact, variable
  • --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 – Input name
  • --new-name VALUE – Input name
  • --options LIST – Selectable values for user inputs
  • --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
  • --required BOOLEAN – Input is required
  • --resource-type ENUM – For values of type search, this is the resource the value searches in Possible value(s): AnsibleRole, AnsibleVariable, Architecture, Audit, AuthSource, Bookmark, ComputeProfile, ComputeResource, ConfigReport, DiscoveryRule, Domain, ExternalUsergroup, FactValue, Filter, ForemanOpenscap::ArfReport, ForemanOpenscap::Policy, ForemanOpenscap::ScapContent, ForemanOpenscap::TailoringFile, ForemanTasks::RecurringLogic, ForemanTasks::Task, ForemanVirtWhoConfigure::Config, Host, Hostgroup, HttpProxy, Image, InsightsHit, JobInvocation, JobTemplate, Katello::ActivationKey, Katello::AlternateContentSource, Katello::ContentCredential, Katello::ContentView, Katello::HostCollection, Katello::KTEnvironment, Katello::Product, Katello::Subscription, Katello::SyncPlan, KeyPair, Location, LookupValue, MailNotification, Medium, Model, Operatingsystem, Organization, Parameter, PersonalAccessToken, ProvisioningTemplate, Ptable, Realm, RemoteExecutionFeature, ReportTemplate, Role, Setting, SmartProxy, SshKey, Subnet, Template, TemplateInvocation, User, Usergroup, Webhook, WebhookTemplate
  • --template-id VALUE
  • --value-type ENUM – Value type, defaults to plain Possible value(s): plain, search, date, resource
  • --variable-name VALUE – Variable name, used when input type is Variable
  • -h, --help – Print help

11.82. user

Manipulate users

Usage

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

Options

  • -h, --help – Print help

11.82.1. user access-token

Managing personal access tokens

Usage

# hammer user access-token [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.82.1.1. user access-token create

Create a Personal Access Token for a user

Usage

# hammer user access-token create [OPTIONS]

Options

  • --expires-at VALUE – Expiry Date
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
11.82.1.2. user access-token info

Show a Personal Access Token for a user

Usage

# hammer user access-token <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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
Table 11.208. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Active

x

x

 

Expires at

x

x

 

Created at

x

x

 

Last used at

x

x

 
11.82.1.3. user access-token list

List all Personal Access Tokens for a user

Usage

# hammer user access-token <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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
Table 11.209. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Active

x

x

 

Expires at

x

x

 

Search / Order fields

  • id – integer
  • name – string
  • user_id – integer
11.82.1.4. user access-token revoke

Revoke a Personal Access Token for a user

Usage

# hammer user access-token revoke [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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help

11.82.2. user add-role

Assign a user role

Usage

# hammer user add-role [OPTIONS]

Options

  • --id VALUE
  • --login VALUE – User`s login to search by
  • --role VALUE – User role name
  • --role-id NUMBER
  • -h, --help – Print help

11.82.3. user create

Create a user

Usage

# hammer user create [OPTIONS]

Options

  • --admin BOOLEAN – Is an admin account
  • --ask-password BOOLEAN
  • --auth-source VALUE – Name to search by
  • --auth-source-id NUMBER
  • --default-location VALUE – Default location name
  • --default-location-id NUMBER
  • --default-organization VALUE – Default organization name
  • --default-organization-id NUMBER
  • --description VALUE
  • --disabled BOOLEAN
  • --firstname VALUE
  • --lastname VALUE
  • --locale ENUM – User`s preferred locale Possible value(s): ca, cs_CZ, de, en, en_GB, es, fr, it, ja, ka, ko, pl, pt_BR, ru, zh_CN, zh_TW
  • --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
  • --login VALUE
  • --mail VALUE
  • --mail-enabled BOOLEAN – Enable user`s email
  • --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
  • --password VALUE – Required unless user is in an external authentication source
  • --role-ids LIST
  • --roles LIST
  • --timezone ENUM – User`s timezone Possible value(s): International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Chihuahua, Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US & Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku`alofa, Samoa, Tokelau Is.
  • -h, --help – Print help

11.82.4. user delete

Delete a user

Usage

# hammer user <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
  • --login VALUE – User`s login 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

11.82.5. user info

Show a user

Usage

# hammer user <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
  • --login VALUE – User`s login 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 11.210. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Login

x

x

x

Name

x

x

 

Email

x

x

 

Admin

x

x

 

Disabled

x

x

 

Last login

x

x

 

Authorized by

x

x

 

Email enabled

x

x

 

Effective admin

x

x

 

Locale

x

x

 

Timezone

x

x

 

Description

x

x

 

Default organization

x

x

 

Default location

x

x

 

Roles/

x

x

 

User groups/usergroup

x

x

 

User groups/id

x

x

 

User groups/roles/

x

x

 

Inherited user groups/usergroup

x

x

 

Inherited user groups/id

x

x

 

Inherited user groups/roles/

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.82.6. user list

List all users

Usage

# hammer user <list|index> [OPTIONS]

Options

  • --auth-source-ldap VALUE – Name to search by
  • --auth-source-ldap-id VALUE – ID of LDAP authentication source
  • --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
  • --role VALUE – User role name
  • --role-id VALUE – ID of role
  • --search VALUE – Filter results
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID of user group
  • -h, --help – Print help
Table 11.211. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Login

x

x

x

Name

x

x

 

Email

x

x

 

Admin

x

x

 

Disabled

x

x

 

Last login

x

x

 

Authorized by

x

x

 

Search / Order fields

  • admin – Values: true, false
  • auth_source – string
  • auth_source_type – string
  • description – text
  • disabled – Values: true, false
  • firstname – string
  • id – integer
  • last_login_on – datetime
  • lastname – string
  • location – string
  • location_id – integer
  • login – string
  • mail – string
  • organization – string
  • organization_id – integer
  • role – string
  • role_id – integer
  • usergroup – string

11.82.7. user mail-notification

Managing personal mail notifications

Usage

# hammer user mail-notification [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.82.7.1. user mail-notification add

Add an email notification for a user

Usage

# hammer user mail-notification add [OPTIONS]

Options

  • --interval VALUE – Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification
  • --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
  • --mail-notification VALUE – Name to search by
  • --mail-notification-id NUMBER
  • --mail-query VALUE – Relevant only for audit summary notification
  • --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
  • --subscription VALUE – Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state
  • --user VALUE – User`s login to search by
  • --user-id VALUE
  • -h, --help – Print help
11.82.7.2. user mail-notification list

List all email notifications for a user

Usage

# hammer user mail-notification <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
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE
  • -h, --help – Print help
Table 11.212. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

 

Name

x

x

x

Description

x

x

 

Interval

x

x

 

Mail query

x

x

 
11.82.7.3. user mail-notification remove

Remove an email notification for a user

Usage

# hammer user mail-notification remove [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
  • --mail-notification VALUE – Name to search by
  • --mail-notification-id NUMBER
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE
  • -h, --help – Print help
11.82.7.4. user mail-notification update

Update an email notification for a user

Usage

# hammer user mail-notification update [OPTIONS]

Options

  • --interval VALUE – Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification
  • --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
  • --mail-notification VALUE – Name to search by
  • --mail-notification-id NUMBER
  • --mail-query VALUE – Relevant only for audit summary notification
  • --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
  • --subscription VALUE – Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state
  • --user VALUE – User`s login to search by
  • --user-id VALUE
  • -h, --help – Print help

11.82.8. user remove-role

Remove a user role

Usage

# hammer user remove-role [OPTIONS]

Options

  • --id VALUE
  • --login VALUE – User`s login to search by
  • --role VALUE – User role name
  • --role-id NUMBER
  • -h, --help – Print help

11.82.9. user ssh-keys

Managing User SSH Keys.

Usage

# hammer user ssh-keys [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.82.9.1. user ssh-keys add

Add an SSH key for a user

Usage

# hammer user ssh-keys add [OPTIONS]

Options

  • --key VALUE – Public SSH key
  • --key-file FILE – Path to a SSH public key
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
11.82.9.2. user ssh-keys delete

Delete an SSH key for a user

Usage

# hammer user ssh-keys <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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
11.82.9.3. user ssh-keys info

Show an SSH key from a user

Usage

# hammer user ssh-keys <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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
Table 11.213. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Fingerprint

x

x

 

Length

x

x

 

Created at

x

x

 

Public key

x

x

 
11.82.9.4. user ssh-keys list

List all SSH keys for a user

Usage

# hammer user ssh-keys <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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
Table 11.214. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Fingerprint

x

x

 

Length

x

x

 

Created at

x

x

 

Search / Order fields

  • id – integer
  • name – string
  • user_id – integer

11.82.10. user table-preference

Managing table preferences

Usage

# hammer user table-preference [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.82.10.1. user table-preference create

Creates a table preference for a given table

Usage

# hammer user table-preference create [OPTIONS]

Options

  • --columns LIST – List of user selected columns
  • --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 of the table
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
11.82.10.2. user table-preference delete

Delete a table preference for a given table

Usage

# hammer user table-preference <delete|destroy> [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 – Name of the table
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
11.82.10.3. user table-preference info

Table preference details of a given table

Usage

# hammer user table-preference <info|show> [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
  • --name VALUE – Name of the table
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
Table 11.215. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

 

Columns

x

x

 

Created at

x

x

 

Updated at

x

x

 
11.82.10.4. user table-preference list

List of table preferences for a user

Usage

# hammer user table-preference <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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help
Table 11.216. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

 

Columns

x

x

 
11.82.10.5. user table-preference update

Updates a table preference for a given table

Usage

# hammer user table-preference update [OPTIONS]

Options

  • --columns LIST – List of user selected columns
  • --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 of the table
  • --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
  • --user VALUE – User`s login to search by
  • --user-id VALUE – ID of the user
  • -h, --help – Print help

11.82.11. user update

Update a user

Usage

# hammer user update [OPTIONS]

Options

  • --admin BOOLEAN – Is an admin account
  • --ask-password BOOLEAN
  • --auth-source VALUE – Name to search by
  • --auth-source-id NUMBER
  • --current-password VALUE – Required when user want to change own password
  • --default-location VALUE – Default location name
  • --default-location-id NUMBER
  • --default-organization VALUE – Default organization name
  • --default-organization-id NUMBER
  • --description VALUE
  • --disabled BOOLEAN
  • --firstname VALUE
  • --id VALUE
  • --lastname VALUE
  • --locale ENUM – User`s preferred locale Possible value(s): ca, cs_CZ, de, en, en_GB, es, fr, it, ja, ka, ko, pl, pt_BR, ru, zh_CN, zh_TW
  • --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
  • --login VALUE
  • --mail VALUE
  • --mail-enabled BOOLEAN – Enable user`s email
  • --new-login 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
  • --password VALUE – Required unless user is in an external authentication source
  • --role-ids LIST
  • --roles LIST
  • --timezone ENUM – User`s timezone Possible value(s): International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Chihuahua, Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US & Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Almaty, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku`alofa, Samoa, Tokelau Is.
  • -h, --help – Print help

11.83. user-group

Manage user groups

Usage

# hammer user-group [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.83.1. user-group add-role

Assign a user role

Usage

# hammer user-group add-role [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --role VALUE – User role name
  • --role-id NUMBER
  • -h, --help – Print help

11.83.2. user-group add-user

Associate an user

Usage

# hammer user-group add-user [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

11.83.3. user-group add-user-group

Associate an user group

Usage

# hammer user-group add-user-group [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user-group VALUE – Name to search by
  • --user-group-id NUMBER
  • -h, --help – Print help

11.83.4. user-group create

Create a user group

Usage

# hammer user-group create [OPTIONS]

Options

  • --admin BOOLEAN – Is an admin user group, can be modified by admins only
  • --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
  • --role-ids LIST
  • --roles LIST
  • --user-group-ids LIST
  • --user-groups LIST
  • --user-ids LIST
  • --users LIST
  • -h, --help – Print help

11.83.5. user-group delete

Delete a user group

Usage

# hammer user-group <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

11.83.6. user-group external

View and manage user group’s external user groups

Usage

# hammer user-group external [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help
11.83.6.1. user-group external create

Create an external user group linked to a user group

Usage

# hammer user-group external create [OPTIONS]

Options

  • --auth-source VALUE – Name to search by
  • --auth-source-id NUMBER – ID of linked authentication source
  • --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 – External user group 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
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help
11.83.6.2. user-group external delete

Delete an external user group

Usage

# hammer user-group external <delete|destroy> [OPTIONS]

Options

  • --id VALUE – ID or name external user group
  • --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
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help
11.83.6.3. user-group external info

Show an external user group for user group

Usage

# hammer user-group external <info|show> [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – ID or name of external user group
  • --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
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help
Table 11.217. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Auth source

x

x

 
11.83.6.4. user-group external list

List all external user groups for user group

Usage

# hammer user-group 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 – 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
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help
Table 11.218. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Auth source

x

x

 
11.83.6.5. user-group external refresh

Refresh external user group

Usage

# hammer user-group external refresh [OPTIONS]

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE – ID or name of external user group
  • --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
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help
Table 11.219. Predefined field sets
FIELDSALLDEFAULTTHIN

Name

x

x

x

Auth source

x

x

 
11.83.6.6. user-group external update

Update external user group

Usage

# hammer user-group external update [OPTIONS]

Options

  • --auth-source VALUE – Name to search by
  • --auth-source-id NUMBER – ID of linked authentication source
  • --id VALUE – ID or name of external user group
  • --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 – External user group name
  • --new-name VALUE – External user group 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
  • --user-group VALUE – Name to search by
  • --user-group-id VALUE – ID or name of user group
  • -h, --help – Print help

11.83.7. user-group info

Show a user group

Usage

# hammer user-group <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 11.220. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Admin

x

x

 

Users/

x

x

 

User groups/usergroup

x

x

 

User groups/id

x

x

 

User groups/roles/

x

x

 

Inherited user groups/usergroup

x

x

 

Inherited user groups/id

x

x

 

Inherited user groups/roles/

x

x

 

External user groups/

x

x

 

Roles/

x

x

 

Created at

x

x

 

Updated at

x

x

 

11.83.8. user-group list

List all user groups

Usage

# hammer user-group <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 11.221. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Admin

x

x

 

Search / Order fields

  • id – integer
  • name – string
  • role – string
  • role_id – integer

11.83.9. user-group remove-role

Remove a user role

Usage

# hammer user-group remove-role [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --role VALUE – User role name
  • --role-id NUMBER
  • -h, --help – Print help

11.83.10. user-group remove-user

Disassociate an user

Usage

# hammer user-group remove-user [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user VALUE – User`s login to search by
  • --user-id NUMBER
  • -h, --help – Print help

11.83.11. user-group remove-user-group

Disassociate an user group

Usage

# hammer user-group remove-user-group [OPTIONS]

Options

  • --id VALUE
  • --name VALUE – Name to search by
  • --user-group VALUE – Name to search by
  • --user-group-id NUMBER
  • -h, --help – Print help

11.83.12. user-group update

Update a user group

Usage

# hammer user-group update [OPTIONS]

Options

  • --admin BOOLEAN – Is an admin user group, can be modified by admins only
  • --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
  • --role-ids LIST
  • --roles LIST
  • --user-group-ids LIST
  • --user-groups LIST
  • --user-ids LIST
  • --users LIST
  • -h, --help – Print help

11.84. virt-who-config

Manage Virt Who configurations

Usage

# hammer virt-who-config [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.84.1. virt-who-config create

Create a virt-who configuration

Usage

# hammer virt-who-config create [OPTIONS]

Options

  • --ahv-internal-debug BOOLEAN Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled
  • --blacklist VALUE – Hypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma.
  • --debug BOOLEAN – Enable debugging output
  • --exclude-host-parents VALUE Applicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will NOT be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.
  • --filter-host-parents VALUE – Applicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.
  • --filtering-mode ENUM – Hypervisor filtering mode Possible value(s): none, whitelist, blacklist
  • --http-proxy VALUE – Name to search by
  • --http-proxy-id NUMBER – HTTP Proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.
  • --hypervisor-id ENUM – Specifies how the hypervisor will be identified. Possible value(s): hostname, uuid, hwuuid
  • --hypervisor-password VALUE – Hypervisor password, required for all hypervisor types except for libvirt/kubevirt.
  • --hypervisor-server VALUE – Fully qualified host name or IP address of the hypervisor
  • --hypervisor-type ENUM – Hypervisor type Possible value(s): esx, hyperv, libvirt, kubevirt, ahv
  • --hypervisor-username VALUE – Account name by which virt-who is to connect to the hypervisor.
  • --interval ENUM – Configuration interval in minutes Possible value(s): 60, 120, 240, 480, 720, 1440, 2880, 4320
  • --kubeconfig-path VALUE – Configuration file containing details about how to connect to the cluster and authentication details.
  • --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 – Configuration name
  • --no-proxy VALUE – Ignore Proxy. A comma-separated list of hostnames or domains or ip addresses to ignore Capsule settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.
  • --organization 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
  • --prism-flavor ENUM – Select the Prism flavor you are connecting to Possible value(s): central, element
  • --satellite-url VALUE – Satellite server FQDN
  • --whitelist VALUE – Hypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma.
  • -h, --help – Print help

11.84.2. virt-who-config delete

Delete a virt-who configuration

Usage

# hammer virt-who-config <delete|destroy> [OPTIONS]

Options

  • --id NUMBER – Configuration numeric identifier
  • --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

11.84.3. virt-who-config deploy

Download and execute script for the specified virt-who configuration

Usage

# hammer virt-who-config deploy [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

11.84.4. virt-who-config fetch

Renders a deploy script for the specified virt-who configuration

Usage

# hammer virt-who-config fetch [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
  • -o, --output VALUE – File where the script will be written

11.84.5. virt-who-config info

Show a virt-who configuration

Usage

# hammer virt-who-config <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 11.222. Predefined field sets
FIELDSALLDEFAULT

General information/id

x

x

General information/name

x

x

General information/hypervisor type

x

x

General information/hypervisor server

x

x

General information/hypervisor username

x

x

General information/configuration file

x

x

General information/ahv prism flavor

x

x

General information/enable ahv debug

x

x

General information/status

x

x

Schedule/interval

x

x

Schedule/last report at

x

x

Connection/satellite server

x

x

Connection/hypervisor id

x

x

Connection/filtering

x

x

Connection/excluded hosts

x

x

Connection/filtered hosts

x

x

Connection/filter host parents

x

x

Connection/exclude host parents

x

x

Connection/debug mode

x

x

Connection/ignore proxy

x

x

Http proxy/http proxy id

x

x

Http proxy/http proxy name

x

x

Http proxy/http proxy url

x

x

Locations/

x

x

Organizations/

x

x

11.84.6. virt-who-config list

List of virt-who configurations

Usage

# hammer virt-who-config <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 11.223. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Interval

x

x

 

Status

x

x

 

Last report at

x

x

 

11.84.7. virt-who-config update

Update a virt-who configuration

Usage

# hammer virt-who-config update [OPTIONS]

Options

  • --ahv-internal-debug BOOLEAN Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled
  • --blacklist VALUE – Hypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma.
  • --debug BOOLEAN – Enable debugging output
  • --exclude-host-parents VALUE Applicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will NOT be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.
  • --filter-host-parents VALUE – Applicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end.
  • --filtering-mode ENUM – Hypervisor filtering mode Possible value(s): none, whitelist, blacklist
  • --http-proxy VALUE – Name to search by
  • --http-proxy-id NUMBER – HTTP Proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.
  • --hypervisor-id ENUM – Specifies how the hypervisor will be identified. Possible value(s): hostname, uuid, hwuuid
  • --hypervisor-password VALUE – Hypervisor password, required for all hypervisor types except for libvirt/kubevirt.
  • --hypervisor-server VALUE – Fully qualified host name or IP address of the hypervisor
  • --hypervisor-type ENUM – Hypervisor type Possible value(s): esx, hyperv, libvirt, kubevirt, ahv
  • --hypervisor-username VALUE – Account name by which virt-who is to connect to the hypervisor.
  • --id NUMBER – Configuration numeric identifier
  • --interval ENUM – Configuration interval in minutes Possible value(s): 60, 120, 240, 480, 720, 1440, 2880, 4320
  • --kubeconfig-path VALUE – Configuration file containing details about how to connect to the cluster and authentication details.
  • --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 – Configuration name
  • --new-name VALUE – Configuration name
  • --no-proxy VALUE – Ignore Proxy. A comma-separated list of hostnames or domains or ip addresses to ignore Capsule settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.
  • --organization 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
  • --prism-flavor ENUM – Select the Prism flavor you are connecting to Possible value(s): central, element
  • --satellite-url VALUE – Satellite server FQDN
  • --whitelist VALUE – Hypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma.
  • -h, --help – Print help

11.85. webhook

Manage webhooks

Usage

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

Options

  • -h, --help – Print help

11.85.1. webhook create

Create a Webhook

Usage

# hammer webhook create [OPTIONS]

Options

  • --enabled BOOLEAN
  • --event ENUM – Possible value(s): actions.katello.capsule_content.sync_failed, actions.katello.capsule_content.sync_succeeded, actions.katello.content_view.promote_failed, actions.katello.content_view.promote_succeeded, actions.katello.content_view.publish_failed, actions.katello.content_view.publish_succeeded, actions.katello.repository.sync_failed, actions.katello.repository.sync_succeeded, actions.remote_execution.run_host_job_ansible_configure_cloud_connector_failed, actions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded, actions.remote_execution.run_host_job_ansible_enable_web_console_failed, actions.remote_execution.run_host_job_ansible_enable_web_console_succeeded, actions.remote_execution.run_host_job_ansible_run_capsule_upgrade_failed, actions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded, actions.remote_execution.run_host_job_ansible_run_host_failed, actions.remote_execution.run_host_job_ansible_run_host_succeeded, actions.remote_execution.run_host_job_ansible_run_openscap_remediation_failed, actions.remote_execution.run_host_job_ansible_run_openscap_remediation_succeeded, actions.remote_execution.run_host_job_ansible_run_playbook_failed, actions.remote_execution.run_host_job_ansible_run_playbook_succeeded, actions.remote_execution.run_host_job_failed, actions.remote_execution.run_host_job_foreman_openscap_run_scans_failed, actions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded, actions.remote_execution.run_host_job_katello_change_content_source_failed, actions.remote_execution.run_host_job_katello_change_content_source_succeeded, actions.remote_execution.run_host_job_katello_errata_install_by_search_failed, actions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded, actions.remote_execution.run_host_job_katello_errata_install_failed, actions.remote_execution.run_host_job_katello_errata_install_succeeded, actions.remote_execution.run_host_job_katello_group_install_failed, actions.remote_execution.run_host_job_katello_group_install_succeeded, actions.remote_execution.run_host_job_katello_group_remove_failed, actions.remote_execution.run_host_job_katello_group_remove_succeeded, actions.remote_execution.run_host_job_katello_group_update_failed, actions.remote_execution.run_host_job_katello_group_update_succeeded, actions.remote_execution.run_host_job_katello_host_tracer_resolve_failed, actions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded, actions.remote_execution.run_host_job_katello_module_stream_action_failed, actions.remote_execution.run_host_job_katello_module_stream_action_succeeded, actions.remote_execution.run_host_job_katello_package_install_by_search_failed, actions.remote_execution.run_host_job_katello_package_install_by_search_succeeded, actions.remote_execution.run_host_job_katello_package_install_failed, actions.remote_execution.run_host_job_katello_package_install_succeeded, actions.remote_execution.run_host_job_katello_package_remove_failed, actions.remote_execution.run_host_job_katello_package_remove_succeeded, actions.remote_execution.run_host_job_katello_package_update_failed, actions.remote_execution.run_host_job_katello_package_update_succeeded, actions.remote_execution.run_host_job_katello_packages_remove_by_search_failed, actions.remote_execution.run_host_job_katello_packages_remove_by_search_succeeded, actions.remote_execution.run_host_job_katello_packages_update_by_search_failed, actions.remote_execution.run_host_job_katello_packages_update_by_search_succeeded, actions.remote_execution.run_host_job_katello_service_restart_failed, actions.remote_execution.run_host_job_katello_service_restart_succeeded, actions.remote_execution.run_host_job_katello_upload_profile_failed, actions.remote_execution.run_host_job_katello_upload_profile_succeeded, actions.remote_execution.run_host_job_leapp_preupgrade_failed, actions.remote_execution.run_host_job_leapp_preupgrade_succeeded, actions.remote_execution.run_host_job_leapp_remediation_plan_failed, actions.remote_execution.run_host_job_leapp_remediation_plan_succeeded, actions.remote_execution.run_host_job_leapp_upgrade_failed, actions.remote_execution.run_host_job_leapp_upgrade_succeeded, actions.remote_execution.run_host_job_puppet_run_host_failed, actions.remote_execution.run_host_job_puppet_run_host_succeeded, actions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_failed, actions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded, actions.remote_execution.run_host_job_rh_cloud_remediate_hosts_failed, actions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded, actions.remote_execution.run_host_job_run_script_failed, actions.remote_execution.run_host_job_run_script_succeeded, actions.remote_execution.run_host_job_script_run_openscap_remediation_failed, actions.remote_execution.run_host_job_script_run_openscap_remediation_succeeded, actions.remote_execution.run_host_job_succeeded, actions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_failed, actions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_running, actions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_succeeded, actions.remote_execution.run_hosts_job_ansible_enable_web_console_failed, actions.remote_execution.run_hosts_job_ansible_enable_web_console_running, actions.remote_execution.run_hosts_job_ansible_enable_web_console_succeeded, actions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_failed, actions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_running, actions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_succeeded, actions.remote_execution.run_hosts_job_ansible_run_host_failed, actions.remote_execution.run_hosts_job_ansible_run_host_running, actions.remote_execution.run_hosts_job_ansible_run_host_succeeded, actions.remote_execution.run_hosts_job_ansible_run_openscap_remediation_failed, actions.remote_execution.run_hosts_job_ansible_run_openscap_remediation_running, actions.remote_execution.run_hosts_job_ansible_run_openscap_remediation_succeeded, actions.remote_execution.run_hosts_job_ansible_run_playbook_failed, actions.remote_execution.run_hosts_job_ansible_run_playbook_running, actions.remote_execution.run_hosts_job_ansible_run_playbook_succeeded, actions.remote_execution.run_hosts_job_failed, actions.remote_execution.run_hosts_job_foreman_openscap_run_scans_failed, actions.remote_execution.run_hosts_job_foreman_openscap_run_scans_running, actions.remote_execution.run_hosts_job_foreman_openscap_run_scans_succeeded, actions.remote_execution.run_hosts_job_katello_change_content_source_failed, actions.remote_execution.run_hosts_job_katello_change_content_source_running, actions.remote_execution.run_hosts_job_katello_change_content_source_succeeded, actions.remote_execution.run_hosts_job_katello_errata_install_by_search_failed, actions.remote_execution.run_hosts_job_katello_errata_install_by_search_running, actions.remote_execution.run_hosts_job_katello_errata_install_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_errata_install_failed, actions.remote_execution.run_hosts_job_katello_errata_install_running, actions.remote_execution.run_hosts_job_katello_errata_install_succeeded, actions.remote_execution.run_hosts_job_katello_group_install_failed, actions.remote_execution.run_hosts_job_katello_group_install_running, actions.remote_execution.run_hosts_job_katello_group_install_succeeded, actions.remote_execution.run_hosts_job_katello_group_remove_failed, actions.remote_execution.run_hosts_job_katello_group_remove_running, actions.remote_execution.run_hosts_job_katello_group_remove_succeeded, actions.remote_execution.run_hosts_job_katello_group_update_failed, actions.remote_execution.run_hosts_job_katello_group_update_running, actions.remote_execution.run_hosts_job_katello_group_update_succeeded, actions.remote_execution.run_hosts_job_katello_host_tracer_resolve_failed, actions.remote_execution.run_hosts_job_katello_host_tracer_resolve_running, actions.remote_execution.run_hosts_job_katello_host_tracer_resolve_succeeded, actions.remote_execution.run_hosts_job_katello_module_stream_action_failed, actions.remote_execution.run_hosts_job_katello_module_stream_action_running, actions.remote_execution.run_hosts_job_katello_module_stream_action_succeeded, actions.remote_execution.run_hosts_job_katello_package_install_by_search_failed, actions.remote_execution.run_hosts_job_katello_package_install_by_search_running, actions.remote_execution.run_hosts_job_katello_package_install_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_package_install_failed, actions.remote_execution.run_hosts_job_katello_package_install_running, actions.remote_execution.run_hosts_job_katello_package_install_succeeded, actions.remote_execution.run_hosts_job_katello_package_remove_failed, actions.remote_execution.run_hosts_job_katello_package_remove_running, actions.remote_execution.run_hosts_job_katello_package_remove_succeeded, actions.remote_execution.run_hosts_job_katello_package_update_failed, actions.remote_execution.run_hosts_job_katello_package_update_running, actions.remote_execution.run_hosts_job_katello_package_update_succeeded, actions.remote_execution.run_hosts_job_katello_packages_remove_by_search_failed, actions.remote_execution.run_hosts_job_katello_packages_remove_by_search_running, actions.remote_execution.run_hosts_job_katello_packages_remove_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_packages_update_by_search_failed, actions.remote_execution.run_hosts_job_katello_packages_update_by_search_running, actions.remote_execution.run_hosts_job_katello_packages_update_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_service_restart_failed, actions.remote_execution.run_hosts_job_katello_service_restart_running, actions.remote_execution.run_hosts_job_katello_service_restart_succeeded, actions.remote_execution.run_hosts_job_katello_upload_profile_failed, actions.remote_execution.run_hosts_job_katello_upload_profile_running, actions.remote_execution.run_hosts_job_katello_upload_profile_succeeded, actions.remote_execution.run_hosts_job_leapp_preupgrade_failed, actions.remote_execution.run_hosts_job_leapp_preupgrade_running, actions.remote_execution.run_hosts_job_leapp_preupgrade_succeeded, actions.remote_execution.run_hosts_job_leapp_remediation_plan_failed, actions.remote_execution.run_hosts_job_leapp_remediation_plan_running, actions.remote_execution.run_hosts_job_leapp_remediation_plan_succeeded, actions.remote_execution.run_hosts_job_leapp_upgrade_failed, actions.remote_execution.run_hosts_job_leapp_upgrade_running, actions.remote_execution.run_hosts_job_leapp_upgrade_succeeded, actions.remote_execution.run_hosts_job_puppet_run_host_failed, actions.remote_execution.run_hosts_job_puppet_run_host_running, actions.remote_execution.run_hosts_job_puppet_run_host_succeeded, actions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_failed, actions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_running, actions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_succeeded, actions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_failed, actions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_running, actions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_succeeded, actions.remote_execution.run_hosts_job_run_script_failed, actions.remote_execution.run_hosts_job_run_script_running, actions.remote_execution.run_hosts_job_run_script_succeeded, actions.remote_execution.run_hosts_job_running, actions.remote_execution.run_hosts_job_script_run_openscap_remediation_failed, actions.remote_execution.run_hosts_job_script_run_openscap_remediation_running, actions.remote_execution.run_hosts_job_script_run_openscap_remediation_succeeded, actions.remote_execution.run_hosts_job_succeeded, build_entered, build_exited, content_view_created, content_view_destroyed, content_view_updated, domain_created, domain_destroyed, domain_updated, host_created, host_destroyed, host_facts_updated, host_updated, hostgroup_created, hostgroup_destroyed, hostgroup_updated, model_created, model_destroyed, model_updated, status_changed, subnet_created, subnet_destroyed, subnet_updated, user_created, user_destroyed, user_updated
  • --http-content-type VALUE
  • --http-headers KEY_VALUE_LIST
  • --http-method ENUM – Possible value(s): POST, GET, PUT, DELETE, PATCH
  • --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
  • --password VALUE
  • --proxy-authorization BOOLEAN Authorize with Satellite client certificate and validate capsule CA from Settings
  • --ssl-ca-certs FILE – File containing X509 Certification Authorities concatenated in PEM format
  • --target-url VALUE
  • --user VALUE
  • --verify-ssl BOOLEAN
  • --webhook-template VALUE – Name to search by
  • --webhook-template-id VALUE
  • -h, --help – Print help

11.85.2. webhook delete

Delete a Webhook

Usage

# hammer webhook <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

11.85.3. webhook info

Show Webhook details

Usage

# hammer webhook <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 11.224. Predefined field sets
FIELDSADDITIONALALLDEFAULTTHIN

Id

 

x

x

x

Name

 

x

x

x

Target url

 

x

x

 

Enabled

 

x

x

 

Event

 

x

x

 

Http method

 

x

x

 

Http content type

 

x

x

 

Webhook template

 

x

x

 

User

 

x

x

 

Verify ssl

 

x

x

 

Proxy authorization

 

x

x

 

X509 certification authorities

x

x

  

Http headers/

 

x

x

 

Created at

 

x

x

 

Updated at

 

x

x

 

11.85.4. webhook list

List Webhooks

Usage

# hammer webhook <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 11.225. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Target url

x

x

 

Enabled

x

x

 

Search / Order fields

  • enabled – Values: true, false
  • name – string
  • target_url – string

11.85.5. webhook update

Update a Webhook

Usage

# hammer webhook update [OPTIONS]

Options

  • --enabled BOOLEAN
  • --event ENUM – Possible value(s): actions.katello.capsule_content.sync_failed, actions.katello.capsule_content.sync_succeeded, actions.katello.content_view.promote_failed, actions.katello.content_view.promote_succeeded, actions.katello.content_view.publish_failed, actions.katello.content_view.publish_succeeded, actions.katello.repository.sync_failed, actions.katello.repository.sync_succeeded, actions.remote_execution.run_host_job_ansible_configure_cloud_connector_failed, actions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded, actions.remote_execution.run_host_job_ansible_enable_web_console_failed, actions.remote_execution.run_host_job_ansible_enable_web_console_succeeded, actions.remote_execution.run_host_job_ansible_run_capsule_upgrade_failed, actions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded, actions.remote_execution.run_host_job_ansible_run_host_failed, actions.remote_execution.run_host_job_ansible_run_host_succeeded, actions.remote_execution.run_host_job_ansible_run_openscap_remediation_failed, actions.remote_execution.run_host_job_ansible_run_openscap_remediation_succeeded, actions.remote_execution.run_host_job_ansible_run_playbook_failed, actions.remote_execution.run_host_job_ansible_run_playbook_succeeded, actions.remote_execution.run_host_job_failed, actions.remote_execution.run_host_job_foreman_openscap_run_scans_failed, actions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded, actions.remote_execution.run_host_job_katello_change_content_source_failed, actions.remote_execution.run_host_job_katello_change_content_source_succeeded, actions.remote_execution.run_host_job_katello_errata_install_by_search_failed, actions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded, actions.remote_execution.run_host_job_katello_errata_install_failed, actions.remote_execution.run_host_job_katello_errata_install_succeeded, actions.remote_execution.run_host_job_katello_group_install_failed, actions.remote_execution.run_host_job_katello_group_install_succeeded, actions.remote_execution.run_host_job_katello_group_remove_failed, actions.remote_execution.run_host_job_katello_group_remove_succeeded, actions.remote_execution.run_host_job_katello_group_update_failed, actions.remote_execution.run_host_job_katello_group_update_succeeded, actions.remote_execution.run_host_job_katello_host_tracer_resolve_failed, actions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded, actions.remote_execution.run_host_job_katello_module_stream_action_failed, actions.remote_execution.run_host_job_katello_module_stream_action_succeeded, actions.remote_execution.run_host_job_katello_package_install_by_search_failed, actions.remote_execution.run_host_job_katello_package_install_by_search_succeeded, actions.remote_execution.run_host_job_katello_package_install_failed, actions.remote_execution.run_host_job_katello_package_install_succeeded, actions.remote_execution.run_host_job_katello_package_remove_failed, actions.remote_execution.run_host_job_katello_package_remove_succeeded, actions.remote_execution.run_host_job_katello_package_update_failed, actions.remote_execution.run_host_job_katello_package_update_succeeded, actions.remote_execution.run_host_job_katello_packages_remove_by_search_failed, actions.remote_execution.run_host_job_katello_packages_remove_by_search_succeeded, actions.remote_execution.run_host_job_katello_packages_update_by_search_failed, actions.remote_execution.run_host_job_katello_packages_update_by_search_succeeded, actions.remote_execution.run_host_job_katello_service_restart_failed, actions.remote_execution.run_host_job_katello_service_restart_succeeded, actions.remote_execution.run_host_job_katello_upload_profile_failed, actions.remote_execution.run_host_job_katello_upload_profile_succeeded, actions.remote_execution.run_host_job_leapp_preupgrade_failed, actions.remote_execution.run_host_job_leapp_preupgrade_succeeded, actions.remote_execution.run_host_job_leapp_remediation_plan_failed, actions.remote_execution.run_host_job_leapp_remediation_plan_succeeded, actions.remote_execution.run_host_job_leapp_upgrade_failed, actions.remote_execution.run_host_job_leapp_upgrade_succeeded, actions.remote_execution.run_host_job_puppet_run_host_failed, actions.remote_execution.run_host_job_puppet_run_host_succeeded, actions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_failed, actions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded, actions.remote_execution.run_host_job_rh_cloud_remediate_hosts_failed, actions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded, actions.remote_execution.run_host_job_run_script_failed, actions.remote_execution.run_host_job_run_script_succeeded, actions.remote_execution.run_host_job_script_run_openscap_remediation_failed, actions.remote_execution.run_host_job_script_run_openscap_remediation_succeeded, actions.remote_execution.run_host_job_succeeded, actions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_failed, actions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_running, actions.remote_execution.run_hosts_job_ansible_configure_cloud_connector_succeeded, actions.remote_execution.run_hosts_job_ansible_enable_web_console_failed, actions.remote_execution.run_hosts_job_ansible_enable_web_console_running, actions.remote_execution.run_hosts_job_ansible_enable_web_console_succeeded, actions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_failed, actions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_running, actions.remote_execution.run_hosts_job_ansible_run_capsule_upgrade_succeeded, actions.remote_execution.run_hosts_job_ansible_run_host_failed, actions.remote_execution.run_hosts_job_ansible_run_host_running, actions.remote_execution.run_hosts_job_ansible_run_host_succeeded, actions.remote_execution.run_hosts_job_ansible_run_openscap_remediation_failed, actions.remote_execution.run_hosts_job_ansible_run_openscap_remediation_running, actions.remote_execution.run_hosts_job_ansible_run_openscap_remediation_succeeded, actions.remote_execution.run_hosts_job_ansible_run_playbook_failed, actions.remote_execution.run_hosts_job_ansible_run_playbook_running, actions.remote_execution.run_hosts_job_ansible_run_playbook_succeeded, actions.remote_execution.run_hosts_job_failed, actions.remote_execution.run_hosts_job_foreman_openscap_run_scans_failed, actions.remote_execution.run_hosts_job_foreman_openscap_run_scans_running, actions.remote_execution.run_hosts_job_foreman_openscap_run_scans_succeeded, actions.remote_execution.run_hosts_job_katello_change_content_source_failed, actions.remote_execution.run_hosts_job_katello_change_content_source_running, actions.remote_execution.run_hosts_job_katello_change_content_source_succeeded, actions.remote_execution.run_hosts_job_katello_errata_install_by_search_failed, actions.remote_execution.run_hosts_job_katello_errata_install_by_search_running, actions.remote_execution.run_hosts_job_katello_errata_install_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_errata_install_failed, actions.remote_execution.run_hosts_job_katello_errata_install_running, actions.remote_execution.run_hosts_job_katello_errata_install_succeeded, actions.remote_execution.run_hosts_job_katello_group_install_failed, actions.remote_execution.run_hosts_job_katello_group_install_running, actions.remote_execution.run_hosts_job_katello_group_install_succeeded, actions.remote_execution.run_hosts_job_katello_group_remove_failed, actions.remote_execution.run_hosts_job_katello_group_remove_running, actions.remote_execution.run_hosts_job_katello_group_remove_succeeded, actions.remote_execution.run_hosts_job_katello_group_update_failed, actions.remote_execution.run_hosts_job_katello_group_update_running, actions.remote_execution.run_hosts_job_katello_group_update_succeeded, actions.remote_execution.run_hosts_job_katello_host_tracer_resolve_failed, actions.remote_execution.run_hosts_job_katello_host_tracer_resolve_running, actions.remote_execution.run_hosts_job_katello_host_tracer_resolve_succeeded, actions.remote_execution.run_hosts_job_katello_module_stream_action_failed, actions.remote_execution.run_hosts_job_katello_module_stream_action_running, actions.remote_execution.run_hosts_job_katello_module_stream_action_succeeded, actions.remote_execution.run_hosts_job_katello_package_install_by_search_failed, actions.remote_execution.run_hosts_job_katello_package_install_by_search_running, actions.remote_execution.run_hosts_job_katello_package_install_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_package_install_failed, actions.remote_execution.run_hosts_job_katello_package_install_running, actions.remote_execution.run_hosts_job_katello_package_install_succeeded, actions.remote_execution.run_hosts_job_katello_package_remove_failed, actions.remote_execution.run_hosts_job_katello_package_remove_running, actions.remote_execution.run_hosts_job_katello_package_remove_succeeded, actions.remote_execution.run_hosts_job_katello_package_update_failed, actions.remote_execution.run_hosts_job_katello_package_update_running, actions.remote_execution.run_hosts_job_katello_package_update_succeeded, actions.remote_execution.run_hosts_job_katello_packages_remove_by_search_failed, actions.remote_execution.run_hosts_job_katello_packages_remove_by_search_running, actions.remote_execution.run_hosts_job_katello_packages_remove_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_packages_update_by_search_failed, actions.remote_execution.run_hosts_job_katello_packages_update_by_search_running, actions.remote_execution.run_hosts_job_katello_packages_update_by_search_succeeded, actions.remote_execution.run_hosts_job_katello_service_restart_failed, actions.remote_execution.run_hosts_job_katello_service_restart_running, actions.remote_execution.run_hosts_job_katello_service_restart_succeeded, actions.remote_execution.run_hosts_job_katello_upload_profile_failed, actions.remote_execution.run_hosts_job_katello_upload_profile_running, actions.remote_execution.run_hosts_job_katello_upload_profile_succeeded, actions.remote_execution.run_hosts_job_leapp_preupgrade_failed, actions.remote_execution.run_hosts_job_leapp_preupgrade_running, actions.remote_execution.run_hosts_job_leapp_preupgrade_succeeded, actions.remote_execution.run_hosts_job_leapp_remediation_plan_failed, actions.remote_execution.run_hosts_job_leapp_remediation_plan_running, actions.remote_execution.run_hosts_job_leapp_remediation_plan_succeeded, actions.remote_execution.run_hosts_job_leapp_upgrade_failed, actions.remote_execution.run_hosts_job_leapp_upgrade_running, actions.remote_execution.run_hosts_job_leapp_upgrade_succeeded, actions.remote_execution.run_hosts_job_puppet_run_host_failed, actions.remote_execution.run_hosts_job_puppet_run_host_running, actions.remote_execution.run_hosts_job_puppet_run_host_succeeded, actions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_failed, actions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_running, actions.remote_execution.run_hosts_job_rh_cloud_connector_run_playbook_succeeded, actions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_failed, actions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_running, actions.remote_execution.run_hosts_job_rh_cloud_remediate_hosts_succeeded, actions.remote_execution.run_hosts_job_run_script_failed, actions.remote_execution.run_hosts_job_run_script_running, actions.remote_execution.run_hosts_job_run_script_succeeded, actions.remote_execution.run_hosts_job_running, actions.remote_execution.run_hosts_job_script_run_openscap_remediation_failed, actions.remote_execution.run_hosts_job_script_run_openscap_remediation_running, actions.remote_execution.run_hosts_job_script_run_openscap_remediation_succeeded, actions.remote_execution.run_hosts_job_succeeded, build_entered, build_exited, content_view_created, content_view_destroyed, content_view_updated, domain_created, domain_destroyed, domain_updated, host_created, host_destroyed, host_facts_updated, host_updated, hostgroup_created, hostgroup_destroyed, hostgroup_updated, model_created, model_destroyed, model_updated, status_changed, subnet_created, subnet_destroyed, subnet_updated, user_created, user_destroyed, user_updated
  • --http-content-type VALUE
  • --http-headers KEY_VALUE_LIST
  • --http-method ENUM – Possible value(s): POST, GET, PUT, DELETE, PATCH
  • --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
  • --password VALUE
  • --proxy-authorization BOOLEAN Authorize with Satellite client certificate and validate capsule CA from Settings
  • --ssl-ca-certs FILE – File containing X509 Certification Authorities concatenated in PEM format
  • --target-url VALUE
  • --user VALUE
  • --verify-ssl BOOLEAN
  • --webhook-template VALUE – Name to search by
  • --webhook-template-id VALUE
  • -h, --help – Print help

11.86. webhook-template

Manipulate webhook templates

Usage

# hammer webhook-template [OPTIONS] SUBCOMMAND [ARG] ...

Options

  • -h, --help – Print help

11.86.1. webhook-template clone

Clone a template

Usage

# hammer webhook-template clone [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 – Template name
  • --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

11.86.2. webhook-template create

Create a webhook template

Usage

# hammer webhook-template create [OPTIONS]

Options

  • --audit-comment VALUE
  • --default BOOLEAN – Whether or not the template is added automatically to new organizations and locations
  • --description 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
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --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
  • --snippet BOOLEAN
  • --template VALUE
  • -h, --help – Print help

11.86.3. webhook-template delete

Delete a webhook template

Usage

# hammer webhook-template <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

11.86.4. webhook-template dump

View webhook template content

Usage

# hammer webhook-template dump [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 11.226. Predefined field sets

FIELDS

11.86.5. webhook-template export

Export a webhook template to ERB

Usage

# hammer webhook-template export [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
  • --path VALUE – Path to directory where downloaded content will be saved
  • -h, --help – Print help

11.86.6. webhook-template import

Import a webhook template

Usage

# hammer webhook-template import [OPTIONS]

Options

  • --associate ENUM – Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s): new, always, never
  • --default BOOLEAN – Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)
  • --file FILE – Path to a file that contains the webhook template content including metadata
  • --force BOOLEAN – Use if you want update locked templates
  • --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
  • --lock BOOLEAN – Lock imported templates (false by default)
  • --name VALUE – Template name
  • --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

11.86.7. webhook-template info

Show webhook template details

Usage

# hammer webhook-template <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 11.227. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Description

x

x

 

Locked

x

x

 

Default

x

x

 

Created at

x

x

 

Updated at

x

x

 

Locations/

x

x

 

Organizations/

x

x

 

Template inputs/id

x

x

 

Template inputs/name

x

x

 

Template inputs/description

x

x

 

Template inputs/required

x

x

 

Template inputs/options

x

x

 

11.86.8. webhook-template list

List webhook templates

Usage

# hammer webhook-template <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 11.228. Predefined field sets
FIELDSALLDEFAULTTHIN

Id

x

x

x

Name

x

x

x

Search / Order fields

  • default – Values: true, false
  • location – string
  • location_id – integer
  • locked – Values: true, false
  • name – string
  • organization – string
  • organization_id – integer
  • snippet – Values: true, false
  • template – text

11.86.9. webhook-template update

Update a webhook template

Usage

# hammer webhook-template update [OPTIONS]

Options

  • --audit-comment VALUE
  • --default BOOLEAN – Whether or not the template is added automatically to new organizations and locations
  • --description 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-ids LIST – REPLACE locations with given ids
  • --location-title VALUE – Set the current location context for the request
  • --location-titles LIST
  • --locations LIST
  • --locked BOOLEAN – Whether or not the template is locked for editing
  • --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
  • --snippet BOOLEAN
  • --template VALUE
  • -h, --help – Print help

11.87. Option details

Hammer options accept the following option types and values:

BOOLEAN
One of true/false, yes/no, 1/0
DATETIME
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM
Possible values are described in the option’s description
FILE
Path to a file
KEY_VALUE_LIST
Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters
LIST
Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters
MULTIENUM
Any combination of possible values described in the option’s description
NUMBER
Numeric value. Integer
SCHEMA
Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters
VALUE
Value described in the option’s description. Mostly simple string

Legal Notice

Copyright © 2024 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.