Chapter 2. Reference
This chapter provides a list of Hammer usage statements. These usage statements are current to the versions of Hammer and its components released for Satellite 6.9.
2.1. hammer
Usage:
hammer [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
activation-key Manipulate activation keys
admin Administrative server-side tasks
ansible Manage foreman ansible
architecture Manipulate architectures
arf-report Manipulate compliance reports
audit Search audit trails.
auth Foreman connection login/logout
auth-source Manipulate auth sources
bookmark Manage bookmarks
bootdisk Download boot disks
capsule Manipulate capsule
compute-profile Manipulate compute profiles
compute-resource Manipulate compute resources
config-group Manipulate config groups
config-report Browse and read reports
content-credentials Manipulate content credentials on the server
content-view Manipulate content views
deb-package Manipulate deb packages
defaults Defaults management
discovery Manipulate discovered hosts.
discovery-rule Manipulate discovered rules.
docker Manipulate docker content
domain Manipulate domains
environment Manipulate environments
erratum Manipulate errata
export-templates Export templates to a git repo or a directory on the server
fact Search facts
file Manipulate files
filter Manage permission filters
foreign-input-set Manage foreign input sets
full-help Print help for all hammer commands
global-parameter Manipulate global parameters
gpg Manipulate GPG Key actions on the server
host Manipulate hosts
host-collection Manipulate host collections
hostgroup Manipulate hostgroups
http-proxy Manipulate http proxies
import-templates Import templates from a git repo or a directory on the server
job-invocation Manage job invocations
job-template Manage job templates
lifecycle-environment Manipulate lifecycle_environments on the server
location Manipulate locations
mail-notification Manage mail notifications
medium Manipulate installation media
model Manipulate hardware models
module-stream View Module Streams
organization Manipulate organizations
os Manipulate operating system
ostree-branch Manipulate ostree branches
package Manipulate packages
package-group Manipulate package groups
partition-table Manipulate partition tables
ping Get the status of the server and/or it's subcomponents
policy Manipulate policies
prebuild-bash-completion Prepare map of options and subcommands for Bash completion
product Manipulate products
proxy Manipulate smart proxies
puppet-class Search puppet modules
puppet-environment Manipulate Puppet environments
puppet-module View Puppet Module details
realm Manipulate realms
recurring-logic Recurring logic related actions
remote-execution-feature Manage remote execution features
report Browse and read reports
report-template Manipulate report templates
repository Manipulate repositories
repository-set Manipulate repository sets on the server
role Manage user roles
sc-param Manipulate smart class parameters
scap-content Manipulate SCAP contents
scap-content-profile Manipulate Scap Content Profiles
settings Change server settings
shell Interactive shell
srpm Manipulate source RPMs
status Get the complete status of the server and/or it's subcomponents
subnet Manipulate subnets
subscription Manipulate subscriptions
sync-plan Manipulate sync plans
tailoring-file Manipulate Tailoring files
task Tasks related actions.
template Manipulate provisioning templates
template-input Manage template inputs
user Manipulate users
user-group Manage user groups
virt-who-config Manage Virt Who configurations
Options:
--[no-]use-defaults Enable/disable stored defaults. Enabled by default
--autocomplete LINE Get list of possible endings
--csv Output as CSV (same as --output=csv)
--csv-separator SEPARATOR Character to separate the values
--fetch-ca-cert SERVER Fetch CA certificate from server and exit
--interactive INTERACTIVE Explicitly turn interactive mode on/off
One of true/false, yes/no, 1/0.
--no-headers Hide headers from output
--output ADAPTER Set output format
Possible value(s): 'base', 'table', 'silent', 'csv', 'yaml', 'json'
--output-file OUTPUT_FILE Path to custom output file
--show-ids Show ids of associated resources
--ssl-ca-file CA_FILE Configure the file containing the CA certificates
--ssl-ca-path CA_PATH Configure the directory containing the CA certificates
--ssl-client-cert CERT_FILE Configure the client's public certificate
--ssl-client-key KEY_FILE Configure the client's private key
--ssl-with-basic-auth Use standard authentication in addition to client certificate authentication
--verify-ssl VERIFY_SSL Configure SSL verification of remote system
One of true/false, yes/no, 1/0.
--version Show version
-c, --config CFG_FILE Path to custom config file
-d, --debug Show debugging output
-h, --help Print help
-p, --password PASSWORD Password to access the remote system
-q, --quiet Completely silent
-r, --reload-cache Force reload of Apipie cache
-s, --server SERVER Remote system address
-u, --username USERNAME Username to access the remote system
-v, --[no-]verbose Be verbose (or not). True by default2.2. hammer activation-key
Manipulate activation keys
Usage:
hammer activation-key [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-host-collection Associate a resource
add-subscription Add subscription
content-override Override product content defaults
copy Copy an activation key
create Create an activation key
delete, destroy Destroy an activation key
host-collections List associated host collections
info, show Show an activation key
list, index List activation keys
product-content List associated products
remove-host-collection Disassociate a resource
remove-subscription Remove subscription
subscriptions List associated subscriptions
update Update an activation key
Options:
-h, --help Print help2.2.1. hammer activation-key add-host-collection
Associate a resource
Usage:
hammer activation-key add-host-collection [OPTIONS]
Options:
--host-collection HOST_COLLECTION_NAME Host collection name to search by
--host-collection-id HOST_COLLECTION_ID Id of the host collection
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.2. hammer activation-key add-subscription
Add subscription
Usage:
hammer activation-key add-subscription [OPTIONS]
Options:
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--quantity QUANTITY Quantity of this subscription to add
--subscription SUBSCRIPTION_NAME Subscription name to search by
--subscription-id SUBSCRIPTION_ID Subscription identifier
--subscriptions SUBSCRIPTIONS Array of subscriptions to add
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--subscriptions "id=<string>\,quantity=<numeric>, ... "2.2.3. hammer activation-key content-override
Override product content defaults
Usage:
hammer activation-key content-override [OPTIONS]
Options:
--content-label CONTENT_LABEL Label of the content
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--override-name OVERRIDE_NAME Override parameter key or name.
To enable or disable a repo select 'enabled'.
Default value: enabled
Default: "enabled"
--remove Remove a content override
--value VALUE Override value. Note for repo enablement you can use a boolean value
-h, --help Print help2.2.4. hammer activation-key copy
Copy an activation key
Usage:
hammer activation-key copy [OPTIONS]
Options:
--id ID ID of the activation key
--name NAME Activation key name to search by
--new-name NEW_NAME Name of new activation key
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.5. hammer activation-key create
Create an activation key
Usage:
hammer activation-key create [OPTIONS]
Options:
--auto-attach AUTO_ATTACH Auto attach subscriptions upon registration
One of true/false, yes/no, 1/0.
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view id
--description DESCRIPTION Description
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--max-hosts MAX_HOSTS Maximum number of registered content hosts
--name NAME Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--purpose-addons PURPOSE_ADDONS Sets the system add-ons
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--purpose-role PURPOSE_ROLE Sets the system purpose usage
--purpose-usage PURPOSE_USAGE Sets the system purpose usage
--release-version RELEASE_VERSION Content release version
--service-level SERVICE_LEVEL Service level
--unlimited-hosts Set hosts max to unlimited
-h, --help Print help2.2.6. hammer activation-key delete
Destroy an activation key
Usage:
hammer activation-key <delete|destroy> [OPTIONS]
Options:
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.7. hammer activation-key host-collections
List associated host collections
Usage:
hammer activation-key host-collections [OPTIONS]
Options:
--available-for AVAILABLE_FOR Interpret specified object to return only Host Collections that can be
Associated with specified object. The value 'host' is supported.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host-id HOST_ID Filter products by host id
--id ID ID of activation key
--name NAME Name of activation key
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--sort-by SORT_BY Field to sort the results on
--sort-order SORT_ORDER How to order the sorted results (e.g. ASC for ascending)
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----2.2.8. hammer activation-key info
Show an activation key
Usage:
hammer activation-key <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------------------|-----|---------|-----
Name | x | x | x
ID | x | x | x
Description | x | x |
Host Limit | x | x |
Auto Attach | x | x |
Release Version | x | x |
Lifecycle Environment | x | x |
Content View | x | x |
Host Collections/ID | x | x |
Host Collections/Name | x | x |
System Purpose/Service Level | x | x |
System Purpose/Purpose Usage | x | x |
System Purpose/Purpose Role | x | x |
System Purpose/Purpose Addons | x | x |
------------------------------|-----|---------|-----2.2.9. hammer activation-key list
List activation keys
Usage:
hammer activation-key <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Activation key name to filter by
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Host Limit | x | x |
Lifecycle Environment | x | x |
Content View | x | x |
----------------------|-----|---------|-----
Search / Order fields:
addon string
content_view string
content_view_id integer
description text
environment string
name string
organization_id integer
role string
subscription_id string
subscription_name string
usage string2.2.10. hammer activation-key product-content
List associated products
Usage:
hammer activation-key product-content [OPTIONS]
Options:
--content-access-mode-all CONTENT_ACCESS_MODE_ALL Get all content available, not just that provided by subscriptions
One of true/false, yes/no, 1/0.
--content-access-mode-env CONTENT_ACCESS_MODE_ENV Limit content to just that available in the activation key's content
View version
One of true/false, yes/no, 1/0.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Type | x | x |
URL | x | x |
GPG Key | x | x |
Label | x | x |
Default Enabled? | x | x |
Override | x | x |
-----------------|-----|---------|-----2.2.11. hammer activation-key remove-host-collection
Disassociate a resource
Usage:
hammer activation-key remove-host-collection [OPTIONS]
Options:
--host-collection HOST_COLLECTION_NAME Host collection name to search by
--host-collection-id HOST_COLLECTION_ID Id of the host collection
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.2.12. hammer activation-key remove-subscription
Remove subscription
Usage:
hammer activation-key remove-subscription [OPTIONS]
Options:
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--subscription-id SUBSCRIPTION_ID ID of subscription
-h, --help Print help2.2.13. hammer activation-key subscriptions
List associated subscriptions
Usage:
hammer activation-key subscriptions [OPTIONS]
Options:
--activation-key ACTIVATION_KEY_NAME Activation key name to search by
--activation-key-id ACTIVATION_KEY_ID Activation key ID
--available-for AVAILABLE_FOR Object to show subscriptions available for, either 'host' or
'activation_key'
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID Id of a host
--id ACTIVATION_KEY_ID ID of the activation key
--match-host MATCH_HOST Ignore subscriptions that are unavailable to the specified host
One of true/false, yes/no, 1/0.
--match-installed MATCH_INSTALLED Return subscriptions that match installed products of the specified host
One of true/false, yes/no, 1/0.
--name ACTIVATION_KEY_NAME Activation key name to search by
--no-overlap NO_OVERLAP Return subscriptions which do not overlap with a currently-attached
Subscription
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-----------|-----|--------
FIELDS | ALL | DEFAULT
-----------|-----|--------
ID | x | x
Name | x | x
Attached | x | x
Quantity | x | x
Start Date | x | x
End Date | x | x
Support | x | x
Contract | x | x
Account | x | x
-----------|-----|--------2.2.14. hammer activation-key update
Update an activation key
Usage:
hammer activation-key update [OPTIONS]
Options:
--auto-attach AUTO_ATTACH Auto attach subscriptions upon registration
One of true/false, yes/no, 1/0.
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view id
--description DESCRIPTION Description
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID ID of the activation key
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--max-hosts MAX_HOSTS Maximum number of registered content hosts
--name NAME Activation key name to search by
--new-name NEW_NAME Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--purpose-addons PURPOSE_ADDONS Sets the system add-ons
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--purpose-role PURPOSE_ROLE Sets the system purpose usage
--purpose-usage PURPOSE_USAGE Sets the system purpose usage
--release-version RELEASE_VERSION Content release version
--service-level SERVICE_LEVEL Service level
--unlimited-hosts Set hosts max to unlimited
-h, --help Print help2.3. hammer admin
Administrative server-side tasks
Usage:
hammer admin [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
logging Logging verbosity level setup
Options:
-h, --help Print help2.3.1. hammer admin logging
Logging verbosity level setup
Usage:
hammer admin logging [OPTIONS]
Options:
--no-backup Skip configuration backups creation.
--prefix PATH Operate on prefixed environment (e.g. chroot).
-a, --all Apply to all components.
-c, --components COMPONENTS Components to apply, use --list to get them.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-d, --level-debug Increase verbosity level to debug.
-h, --help Print help
-l, --list List available components.
-n, --dry-run Do not apply specified changes.
-p, --level-production Decrease verbosity level to standard.2.4. hammer ansible
Manage foreman ansible
Usage:
hammer ansible [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
roles Manage ansible roles
variables Manage ansible variables
Options:
-h, --help Print help2.4.1. hammer ansible roles
Manage ansible roles
Usage:
hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Deletes Ansible role
fetch Fetch Ansible roles available to be imported
import Import Ansible roles
info, show Show role
list, index List Ansible roles
obsolete Obsolete Ansible roles
play-hostgroups Runs all Ansible roles on hostgroups
play-hosts Runs all Ansible roles on hosts
Options:
-h, --help Print help2.4.1.1. hammer ansible roles delete
Deletes Ansible role
Usage:
hammer ansible roles <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.1.2. hammer ansible roles fetch
Fetch Ansible roles available to be imported
Usage:
hammer ansible roles fetch [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to fetch from
-h, --help Print help2.4.1.3. hammer ansible roles import
Import Ansible roles
Usage:
hammer ansible roles import [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
--role-names ROLE_NAMES Ansible role names to import
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.4.1.4. hammer ansible roles info
Show role
Usage:
hammer ansible roles <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Imported at | x | x |
------------|-----|---------|-----2.4.1.5. hammer ansible roles list
List Ansible roles
Usage:
hammer ansible roles <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Imported at | x | x |
------------|-----|---------|-----
Search / Order fields:
host string
host_id integer
hostgroup string
hostgroup_id integer
id integer
name string
updated_at datetime2.4.1.6. hammer ansible roles obsolete
Obsolete Ansible roles
Usage:
hammer ansible roles obsolete [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
-h, --help Print help2.4.1.7. hammer ansible roles play-hostgroups
Runs all Ansible roles on hostgroups
Usage:
hammer ansible roles play-hostgroups [OPTIONS]
Options:
--hostgroup-ids HOSTGROUP_IDS IDs of hostgroups to play roles on
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.1.8. hammer ansible roles play-hosts
Runs all Ansible roles on hosts
Usage:
hammer ansible roles play-hosts [OPTIONS]
Options:
--host-ids HOST_IDS IDs of hosts to play roles on
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.2. hammer ansible variables
Manage ansible variables
Usage:
hammer ansible variables [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-matcher Create an override value for a specific ansible variable
create Create Ansible variable
delete, destroy Deletes Ansible variable
import Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles
info, show Show variable
list, index List Ansible variables
obsolete Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles
remove-matcher Destroy an override value
update Updates Ansible variable
Options:
-h, --help Print help2.4.2.1. hammer ansible variables add-matcher
Create an override value for a specific ansible variable
Usage:
hammer ansible variables add-matcher [OPTIONS]
Options:
--ansible-variable ANSIBLE_VARIABLE_NAME Name to search by
--ansible-variable-id ANSIBLE_VARIABLE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--match MATCH Override match
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--value VALUE Override value, required if omit is false
-h, --help Print help2.4.2.2. hammer ansible variables create
Create Ansible variable
Usage:
hammer ansible variables create [OPTIONS]
Options:
--ansible-role ANSIBLE_ROLE_NAME Name to search by
--ansible-role-id ANSIBLE_ROLE_ID Role ID
--avoid-duplicates AVOID_DUPLICATES Remove duplicate values (only array type)
One of true/false, yes/no, 1/0.
--default-value DEFAULT_VALUE Default value of variable
--description DESCRIPTION Description of variable
--hidden-value HIDDEN_VALUE When enabled the parameter is hidden in the UI
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--merge-default MERGE_DEFAULT Include default value when merging all matching values
One of true/false, yes/no, 1/0.
--merge-overrides MERGE_OVERRIDES Merge all matching values (only array/hash type)
One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--override OVERRIDE Whether to override variable or not
One of true/false, yes/no, 1/0.
--override-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
--validator-rule VALIDATOR_RULE Used to enforce certain values for the parameter values
--validator-type VALIDATOR_TYPE Types of validation values
Possible value(s): 'regexp', 'list'
--variable VARIABLE Name of variable
--variable-type VARIABLE_TYPE Types of variable values
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
-h, --help Print help2.4.2.3. hammer ansible variables delete
Deletes Ansible variable
Usage:
hammer ansible variables <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.2.4. hammer ansible variables import
Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles
Usage:
hammer ansible variables import [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
-h, --help Print help2.4.2.5. hammer ansible variables info
Show variable
Usage:
hammer ansible variables <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------------------|-----|--------
Id | x | x
Variable | x | x
Default Value | x | x
Type | x | x
Role | x | x
Role Id | x | x
Description | x | x
Hidden Value? | x | x
Validator/Type | x | x
Validator/Rule | x | x
Override values/Override | x | x
Override values/Merge overrides | x | x
Override values/Merge default value | x | x
Override values/Avoid duplicates | x | x
Override values/Order | x | x
Override values/Values/Id | x | x
Override values/Values/Match | x | x
Override values/Values/Value | x | x
Created at | x | x
Updated at | x | x
------------------------------------|-----|--------2.4.2.6. hammer ansible variables list
List Ansible variables
Usage:
hammer ansible variables <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Variable | x | x
Default Value | x | x
Type | x | x
Role | x | x
Role Id | x | x
--------------|-----|--------
Search / Order fields:
ansible_role string
avoid_duplicates Values: true, false
imported Values: true, false
key string
merge_default Values: true, false
merge_overrides Values: true, false
name string
override Values: true, false
parameter string2.4.2.7. hammer ansible variables obsolete
Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles
Usage:
hammer ansible variables obsolete [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--proxy-id PROXY_ID Capsule to import from
-h, --help Print help2.4.2.8. hammer ansible variables remove-matcher
Destroy an override value
Usage:
hammer ansible variables remove-matcher [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.4.2.9. hammer ansible variables update
Updates Ansible variable
Usage:
hammer ansible variables update [OPTIONS]
Options:
--ansible-role ANSIBLE_ROLE_NAME Name to search by
--ansible-role-id ANSIBLE_ROLE_ID Role ID
--avoid-duplicates AVOID_DUPLICATES Remove duplicate values (only array type)
One of true/false, yes/no, 1/0.
--default-value DEFAULT_VALUE Default value of variable
--description DESCRIPTION Description of variable
--hidden-value HIDDEN_VALUE When enabled the parameter is hidden in the UI
One of true/false, yes/no, 1/0.
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--merge-default MERGE_DEFAULT Include default value when merging all matching values
One of true/false, yes/no, 1/0.
--merge-overrides MERGE_OVERRIDES Merge all matching values (only array/hash type)
One of true/false, yes/no, 1/0.
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--override OVERRIDE Whether to override variable or not
One of true/false, yes/no, 1/0.
--override-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
--validator-rule VALIDATOR_RULE Used to enforce certain values for the parameter values
--validator-type VALIDATOR_TYPE Types of validation values
Possible value(s): 'regexp', 'list'
--variable VARIABLE Name of variable
--variable-type VARIABLE_TYPE Types of variable values
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
-h, --help Print help2.5. hammer architecture
Manipulate architectures
Usage:
hammer architecture [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-operatingsystem Associate an operating system
create Create an architecture
delete, destroy Delete an architecture
info, show Show an architecture
list, index List all architectures
remove-operatingsystem Disassociate an operating system
update Update an architecture
Options:
-h, --help Print help2.5.1. hammer architecture add-operatingsystem
Associate an operating system
Usage:
hammer architecture add-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Architecture name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.5.2. hammer architecture create
Create an architecture
Usage:
hammer architecture create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Operating system IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.5.3. hammer architecture delete
Delete an architecture
Usage:
hammer architecture <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Architecture name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.5.4. hammer architecture info
Show an architecture
Usage:
hammer architecture <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Architecture name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating systems/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
-------------------|-----|---------|-----2.5.5. hammer architecture list
List all architectures
Usage:
hammer architecture <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
name string2.5.6. hammer architecture remove-operatingsystem
Disassociate an operating system
Usage:
hammer architecture remove-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Architecture name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.5.7. hammer architecture update
Update an architecture
Usage:
hammer architecture update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Architecture name
--new-name NEW_NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Operating system IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.6. hammer arf-report
Manipulate compliance reports
Usage:
hammer arf-report [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete an ARF Report
download Download bzipped ARF report
download-html Download ARF report in HTML
info, show Show an ARF report
list, index List ARF reports
Options:
-h, --help Print help2.6.1. hammer arf-report delete
Delete an ARF Report
Usage:
hammer arf-report <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help2.6.2. hammer arf-report download
Download bzipped ARF report
Usage:
hammer arf-report download [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--path PATH Path to directory where downloaded file will be saved
-h, --help Print help2.6.3. hammer arf-report download-html
Download ARF report in HTML
Usage:
hammer arf-report download-html [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--path PATH Path to directory where downloaded file will be saved
-h, --help Print help2.6.4. hammer arf-report info
Show an ARF report
Usage:
hammer arf-report <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
Id | x | x | x
Reported at | x | x |
Host name | x | x | x
OpenSCAP proxy name | x | x |
Policy name | x | x |
Passed | x | x |
Failed | x | x |
Othered | x | x |
Host Id | x | x |
OpenSCAP proxy Id | x | x |
Policy Id | x | x |
Locations/ | x | x |
Organizations/ | x | x |
--------------------|-----|---------|-----2.6.5. hammer arf-report list
List ARF reports
Usage:
hammer arf-report <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
Id | x | x | x
Reported at | x | x |
Host name | x | x | x
OpenSCAP proxy name | x | x |
Policy name | x | x |
Passed | x | x |
Failed | x | x |
Othered | x | x |
--------------------|-----|---------|-----
Search / Order fields:
compliance_policy string
compliance_status Values: compliant, incompliant, inconclusive
comply_with string
environment string
eventful Values: true, false
host string
host_collection string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
inconclusive_with string
last_for Values: host, policy
last_report datetime
lifecycle_environment string
location string
location_id integer
log text
not_comply_with string
openscap_proxy string
organization string
organization_id integer
origin string
policy string
reported datetime
resource text
xccdf_rule_failed string
xccdf_rule_name text
xccdf_rule_othered string
xccdf_rule_passed string2.7. hammer audit
Search audit trails.
Usage:
hammer audit [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show an audit
list, index List all audits
Options:
-h, --help Print help2.7.1. hammer audit info
Show an audit
Usage:
hammer audit <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
Id | x | x | x
At | x | x |
IP | x | x |
User | x | x |
Action | x | x |
Audit type | x | x |
Audit record | x | x |
Request UUID | x | x |
Audited changes/Attribute | x | x |
Audited changes/Value | x | x |
Audited changes/Old | x | x |
Audited changes/New | x | x |
--------------------------|-----|---------|-----2.7.2. hammer audit list
List all audits
Usage:
hammer audit <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
At | x | x |
IP | x | x |
User | x | x |
Action | x | x |
Audit type | x | x |
Audit record | x | x |
Request UUID | x | |
-------------|-----|---------|-----
Search / Order fields:
action string
auditable_id integer
changes text
comment string
host string
hostgroup string
hostgroup_title string
id integer
interface_fqdn string
interface_ip string
interface_mac string
location string
location_id integer
organization string
organization_id integer
os string
os_title string
parameter string
partition_table string
provisioning_template string
puppetclass string
remote_address string
request_uuid string
setting string
time datetime
type Values: role, ptable, provisioning_template, user, filter, subnet, hostgroup, katello/repository, smart_proxy, katello/host/content_facet, katello/hostgroup/content_facet, katello/host/subscription_facet, remote_execution_feature, usergroup, katello/content_view, katello/kt_environment, architecture, bookmark, compute_profile, config_group, domain, environment, host_class, http_proxy, image, key_pair, medium, model, personal_access_token, report_template, puppetclass, realm, ssh_key, job_template, job_invocation, ansible_role, discovery_rule, katello/activation_key, katello/gpg_key, katello/host_collection, katello/product, katello/sync_plan, foreman_virt_who_configure/config, foreman_openscap/policy, foreman_openscap/scap_content, foreman_openscap/tailoring_file, lookup_value, hostgroup_class, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, setting, smart_class_parameter
user string
username string2.8. hammer auth
Foreman connection login/logout
Usage:
hammer auth [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
login Set credentials
logout Wipe your credentials
status Information about current connections
Options:
-h, --help Print help2.8.1. hammer auth login
Set credentials
Usage:
hammer auth login [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
basic Provide username and password
oauth Supports for both with/without 2fa
Options:
-h, --help Print help2.8.1.1. hammer auth login basic
provide username and password
Usage:
hammer auth login basic [OPTIONS]
Options:
-h, --help Print help
-p, --password PASSWORD Password to access the remote system
-u, --username USERNAME Username to access the remote system2.8.1.2. hammer auth login oauth
supports for both with/without 2fa
Usage:
hammer auth login oauth [OPTIONS]
Options:
-a, --oidc-authorization-endpoint OPENIDC_AUTHORIZATION_ENDPOINT Openidc provider URL which issues authentication code (two factor only)
-c, --oidc-client-id OPENIDC_CLIENT_ID Client id used in the Openidc provider
-f, --two-factor Authenticate with two factor
-h, --help Print help
-p, --password PASSWORD Password to access the remote system
-r, --oidc-redirect-uri OPENIDC_REDIRECT_URI Redirect URI for the authentication code grant flow
-t, --oidc-token-endpoint OPENIDC_TOKEN_ENDPOINT Openidc provider URL which issues access token
-u, --username USERNAME Username to access the remote system2.8.2. hammer auth logout
Wipe your credentials
Usage:
hammer auth logout [OPTIONS]
Options:
-h, --help Print help2.8.3. hammer auth status
Information about current connections
Usage:
hammer auth status [OPTIONS]
Options:
-h, --help Print help2.9. hammer auth-source
Manipulate auth sources
Usage:
hammer auth-source [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
external Manage external auth sources
ldap Manage LDAP auth sources
list, index List all auth sources
Options:
-h, --help Print help2.9.1. hammer auth-source external
Manage external auth sources
Usage:
hammer auth-source external [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show an external authentication source
list, index List external authentication sources
update Update organization and location for Auth Source
Options:
-h, --help Print help2.9.1.1. hammer auth-source external info
Show an external authentication source
Usage:
hammer auth-source external <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Locations/ | x | x |
Organizations/ | x | x |
---------------|-----|---------|-----2.9.1.2. hammer auth-source external list
List external authentication sources
Usage:
hammer auth-source external <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer2.9.1.3. hammer auth-source external update
Update organization and location for Auth Source
Usage:
hammer auth-source external update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.9.2. hammer auth-source ldap
Manage LDAP auth sources
Usage:
hammer auth-source ldap [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an LDAP authentication source
delete, destroy Delete an LDAP authentication source
info, show Show an LDAP authentication source
list, index List all LDAP authentication sources
update Update an LDAP authentication source
Options:
-h, --help Print help2.9.2.1. hammer auth-source ldap create
Create an LDAP authentication source
Usage:
hammer auth-source ldap create [OPTIONS]
Options:
--account ACCOUNT
--account-password ACCOUNT_PASSWORD Required if onthefly_register is true
--attr-firstname ATTR_FIRSTNAME Required if onthefly_register is true
--attr-lastname ATTR_LASTNAME Required if onthefly_register is true
--attr-login ATTR_LOGIN Required if onthefly_register is true
--attr-mail ATTR_MAIL Required if onthefly_register is true
--attr-photo ATTR_PHOTO
--base-dn BASE_DN
--groups-base GROUPS_BASE Groups base DN
--host HOST
--ldap-filter LDAP_FILTER LDAP filter
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--onthefly-register ONTHEFLY_REGISTER One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--port PORT Defaults to 389
--server-type SERVER_TYPE Type of the LDAP server
Possible value(s): 'free_ipa', 'active_directory', 'posix'
--tls TLS One of true/false, yes/no, 1/0.
--use-netgroups USE_NETGROUPS Use NIS netgroups instead of posix groups, applicable only when server_type
Is posix or free_ipa
One of true/false, yes/no, 1/0.
--usergroup-sync USERGROUP_SYNC Sync external user groups on login
One of true/false, yes/no, 1/0.
-h, --help Print help2.9.2.2. hammer auth-source ldap delete
Delete an LDAP authentication source
Usage:
hammer auth-source ldap <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.9.2.3. hammer auth-source ldap info
Show an LDAP authentication source
Usage:
hammer auth-source ldap <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
-------------------------------------------|-----|--------
Server/Id | x | x
Server/Name | x | x
Server/Server | x | x
Server/LDAPS | x | x
Server/Port | x | x
Server/Server Type | x | x
Account/Account Username | x | x
Account/Base DN | x | x
Account/Groups base DN | x | x
Account/Use Netgroups | x | x
Account/LDAP filter | x | x
Account/Automatically Create Accounts? | x | x
Account/Usergroup sync | x | x
Attribute mappings/Login Name Attribute | x | x
Attribute mappings/First Name Attribute | x | x
Attribute mappings/Last Name Attribute | x | x
Attribute mappings/Email Address Attribute | x | x
Attribute mappings/Photo Attribute | x | x
Locations/ | x | x
Organizations/ | x | x
-------------------------------------------|-----|--------2.9.2.4. hammer auth-source ldap list
List all LDAP authentication sources
Usage:
hammer auth-source ldap <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Server | x | x |
Port | x | x |
LDAPS? | x | x |
-------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer2.9.2.5. hammer auth-source ldap update
Update an LDAP authentication source
Usage:
hammer auth-source ldap update [OPTIONS]
Options:
--account ACCOUNT
--account-password ACCOUNT_PASSWORD Required if onthefly_register is true
--attr-firstname ATTR_FIRSTNAME Required if onthefly_register is true
--attr-lastname ATTR_LASTNAME Required if onthefly_register is true
--attr-login ATTR_LOGIN Required if onthefly_register is true
--attr-mail ATTR_MAIL Required if onthefly_register is true
--attr-photo ATTR_PHOTO
--base-dn BASE_DN
--groups-base GROUPS_BASE Groups base DN
--host HOST
--id ID
--ldap-filter LDAP_FILTER LDAP filter
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME
--onthefly-register ONTHEFLY_REGISTER One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--port PORT Defaults to 389
--server-type SERVER_TYPE Type of the LDAP server
Possible value(s): 'free_ipa', 'active_directory', 'posix'
--tls TLS One of true/false, yes/no, 1/0.
--use-netgroups USE_NETGROUPS Use NIS netgroups instead of posix groups, applicable only when server_type
Is posix or free_ipa
One of true/false, yes/no, 1/0.
--usergroup-sync USERGROUP_SYNC Sync external user groups on login
One of true/false, yes/no, 1/0.
-h, --help Print help2.9.3. hammer auth-source list
List all auth sources
Usage:
hammer auth-source <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Type of auth source | x | x |
--------------------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer2.10. hammer bookmark
Manage bookmarks
Usage:
hammer bookmark [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a bookmark
delete, destroy Delete a bookmark
info, show Show a bookmark
list, index List all bookmarks
update Update a bookmark
Options:
-h, --help Print help2.10.1. hammer bookmark create
Create a bookmark
Usage:
hammer bookmark create [OPTIONS]
Options:
--controller CONTROLLER
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--public PUBLIC One of true/false, yes/no, 1/0.
--query QUERY
-h, --help Print help2.10.2. hammer bookmark delete
Delete a bookmark
Usage:
hammer bookmark <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.10.3. hammer bookmark info
Show a bookmark
Usage:
hammer bookmark <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Controller | x | x |
Search Query | x | x |
Public | x | x |
Owner Id | x | x |
Owner Type | x | x |
-------------|-----|---------|-----2.10.4. hammer bookmark list
List all bookmarks
Usage:
hammer bookmark <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Controller | x | x |
Search Query | x | x |
Public | x | x |
Owner Id | x | x |
Owner Type | x | x |
-------------|-----|---------|-----
Search / Order fields:
controller string
name string2.10.5. hammer bookmark update
Update a bookmark
Usage:
hammer bookmark update [OPTIONS]
Options:
--controller CONTROLLER
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--public PUBLIC One of true/false, yes/no, 1/0.
--query QUERY
-h, --help Print help2.11. hammer bootdisk
Download boot disks
Usage:
hammer bootdisk [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
generic Download generic image
host Download host image
subnet Download subnet generic image
Options:
-h, --help Print help2.11.1. hammer bootdisk generic
Download generic image
Usage:
hammer bootdisk generic [OPTIONS]
Options:
--file PATH File or device to write image to
--force Force writing to existing destination (device etc.)
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--sudo Use sudo to write to device
-h, --help Print help2.11.2. hammer bootdisk host
Download host image
Usage:
hammer bootdisk host [OPTIONS]
Options:
--file PATH File or device to write image to
--force Force writing to existing destination (device etc.)
--full FULL True for full, false for basic reusable image
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--sudo Use sudo to write to device
-h, --help Print help2.11.3. hammer bootdisk subnet
Download subnet generic image
Usage:
hammer bootdisk subnet [OPTIONS]
Options:
--file PATH File or device to write image to
--force Force writing to existing destination (device etc.)
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--sudo Use sudo to write to device
-h, --help Print help2.12. hammer capsule
Manipulate capsule
Usage:
hammer capsule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
content Manage the capsule content
create Create a capsule
delete, destroy Delete a capsule
import-classes Import puppet classes from puppet Capsule
info, show Show a capsule
list, index List all capsules
refresh-features Refresh capsule features
update Update a capsule
Options:
-h, --help Print help2.12.1. hammer capsule content
Manage the capsule content
Usage:
hammer capsule content [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-lifecycle-environment Add lifecycle environments to the capsule
available-lifecycle-environments List the lifecycle environments not attached to the capsule
cancel-synchronization Cancel running capsule synchronization
info Get current capsule synchronization status
lifecycle-environments List the lifecycle environments attached to the capsule
remove-lifecycle-environment Remove lifecycle environments from the capsule
synchronization-status Get current capsule synchronization status
synchronize Synchronize the content to the capsule
Options:
-h, --help Print help2.12.1.1. hammer capsule content add-lifecycle-environment
Add lifecycle environments to the capsule
Usage:
hammer capsule content add-lifecycle-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
-h, --help Print help2.12.1.2. hammer capsule content available-lifecycle-environments
List the lifecycle environments not attached to the capsule
Usage:
hammer capsule content available-lifecycle-environments [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to limit environments on
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
-------------|-----|---------|-----2.12.1.3. hammer capsule content cancel-synchronization
Cancel running capsule synchronization
Usage:
hammer capsule content cancel-synchronization [OPTIONS]
Options:
--id ID Id of the capsule
--name NAME Name to search by
-h, --help Print help2.12.1.4. hammer capsule content info
Get current capsule synchronization status
Usage:
hammer capsule content info [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to get the status for
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------------------------------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
-------------------------------------------------------------------|-----|--------
Lifecycle Environments/Name | x | x
Lifecycle Environments/Organization | x | x
Lifecycle Environments/Content Views/Name | x | x
Lifecycle Environments/Content Views/Composite | x | x
Lifecycle Environments/Content Views/Last Published | x | x
Lifecycle Environments/Content Views/Content/Hosts | x | x
Lifecycle Environments/Content Views/Content/Products | x | x
Lifecycle Environments/Content Views/Content/Yum repos | x | x
Lifecycle Environments/Content Views/Content/Container Image repos | x | x
Lifecycle Environments/Content Views/Content/Packages | x | x
Lifecycle Environments/Content Views/Content/Package groups | x | x
Lifecycle Environments/Content Views/Content/Errata | x | x
Lifecycle Environments/Content Views/Content/Puppet modules | x | x
-------------------------------------------------------------------|-----|--------2.12.1.5. hammer capsule content lifecycle-environments
List the lifecycle environments attached to the capsule
Usage:
hammer capsule content lifecycle-environments [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to limit environments on
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
-------------|-----|---------|-----2.12.1.6. hammer capsule content remove-lifecycle-environment
Remove lifecycle environments from the capsule
Usage:
hammer capsule content remove-lifecycle-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
-h, --help Print help2.12.1.7. hammer capsule content synchronization-status
Get current capsule synchronization status
Usage:
hammer capsule content synchronization-status [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to get the status for
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
--------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
--------------------------------------|-----|--------
Last sync | x | x
Status | x | x
Currently running sync tasks/Task id | x | x
Currently running sync tasks/Progress | x | x
Last failure/Task id | x | x
Last failure/Messages | x | x
--------------------------------------|-----|--------2.12.1.8. hammer capsule content synchronize
Synchronize the content to the capsule
Usage:
hammer capsule content synchronize [OPTIONS]
Options:
--async Do not wait for the task
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
--skip-metadata-check SKIP_METADATA_CHECK Skip metadata check on each repository on the capsule
One of true/false, yes/no, 1/0.
-h, --help Print help2.12.2. hammer capsule create
Create a capsule
Usage:
hammer capsule create [OPTIONS]
Options:
--download-policy DOWNLOAD_POLICY Download Policy of the capsule, must be one of immediate, on_demand,
Background, inherit
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--url URL
-h, --help Print help2.12.3. hammer capsule delete
Delete a capsule
Usage:
hammer capsule <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.12.4. hammer capsule import-classes
Import puppet classes from puppet Capsule
Usage:
hammer capsule import-classes [OPTIONS]
Options:
--dryrun Do not run the import
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--except EXCEPT Optional comma-delimited string containing either 'new',
'updated', or 'obsolete' that is used to limit the imported
Puppet classes
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
-h, --help Print help2.12.5. hammer capsule info
Show a capsule
Usage:
hammer capsule <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
URL | x | x |
Features | x | x |
Features/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.12.6. hammer capsule list
List all capsules
Usage:
hammer capsule <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
Id | x | x | x
Name | x | x | x
URL | x | x |
Features | x | x |
---------|-----|---------|-----
Search / Order fields:
feature string
location string
location_id integer
name string
organization string
organization_id integer
url string2.12.7. hammer capsule refresh-features
Refresh capsule features
Usage:
hammer capsule refresh-features [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.12.8. hammer capsule update
Update a capsule
Usage:
hammer capsule update [OPTIONS]
Options:
--download-policy DOWNLOAD_POLICY Download Policy of the capsule, must be one of immediate, on_demand,
Background, inherit
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--url URL
-h, --help Print help2.13. hammer compute-profile
Manipulate compute profiles
Usage:
hammer compute-profile [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a compute profile
delete, destroy Delete a compute profile
info, show Show a compute profile
list, index List of compute profiles
update Update a compute profile
values Create update and delete Compute profile values
Options:
-h, --help Print help2.13.1. hammer compute-profile create
Create a compute profile
Usage:
hammer compute-profile create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.2. hammer compute-profile delete
Delete a compute profile
Usage:
hammer compute-profile <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute profile name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.3. hammer compute-profile info
Show a compute profile
Usage:
hammer compute-profile <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute profile name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
Compute attributes/Id | x | x |
Compute attributes/Name | x | x |
Compute attributes/Compute Resource | x | x |
Compute attributes/VM attributes | x | x |
------------------------------------|-----|---------|-----2.13.4. hammer compute-profile list
List of compute profiles
Usage:
hammer compute-profile <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
name string2.13.5. hammer compute-profile update
Update a compute profile
Usage:
hammer compute-profile update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute profile name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.6. hammer compute-profile values
Create update and delete Compute profile values
Usage:
hammer compute-profile values [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-interface Add interface for Compute Profile
add-volume Add volume for Compute Profile
create Create compute profile set of values
remove-interface Remove compute profile interface
remove-volume Remove compute profile volume
update Update compute profile values
update-interface Update compute profile interface
update-volume Update compute profile volume
Options:
-h, --help Print help2.13.6.1. hammer compute-profile values add-interface
Add interface for Compute Profile
Usage:
hammer compute-profile values add-interface [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface SET_VALUES Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--interface:
GCE:
--interface:
Libvirt:
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
OpenStack:
--interface:
oVirt:
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
Rackspace:
--interface:
VMware:
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
See documentation center for your version of vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network ID or Network Name from VMware
AzureRM:
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)2.13.6.2. hammer compute-profile values add-volume
Add volume for Compute Profile
Usage:
hammer compute-profile values add-volume [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
GCE:
--volume:
size_gb Volume size in GB, integer value
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
OpenStack:
--volume:
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
Rackspace:
--volume:
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)2.13.6.3. hammer compute-profile values create
Create compute profile set of values
Usage:
hammer compute-profile values create [OPTIONS]
Options:
--compute-attributes COMPUTE_ATTRS Compute resource attributes
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface INTERFACE Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
--interface:
--compute-attributes:
availability_zone
flavor_id
groups
security_group_ids
managed_ip
GCE:
--volume:
size_gb Volume size in GB, integer value
--interface:
--compute-attributes:
machine_type
network
associate_external_ip
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
--compute-attributes:
cpus Number of CPUs
memory String, amount of memory, value in bytes
cpu_mode Possible values: default, host-model, host-passthrough
OpenStack:
--volume:
--interface:
--compute-attributes:
availability_zone
boot_from_volume
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
--compute-attributes:
cluster ID or name of cluster to use
template Hardware profile to use
cores Integer value, number of cores
sockets Integer value, number of sockets
memory Amount of memory, integer value in bytes
ha Boolean, set 1 to high availability
display_type Possible values: VNC, SPICE
keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.
Rackspace:
--volume:
--interface:
--compute-attributes:
flavor_id
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
See documentation center for your version of vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network ID or Network Name from VMware
--compute-attributes:
cluster Cluster ID from VMware
corespersocket Number of cores per socket (applicable to hardware versions < 10 only)
cpus CPU count
memory_mb Integer number, amount of memory in MB
path Path to folder
resource_pool Resource Pool ID from VMware
firmware automatic/bios/efi
guest_id Guest OS ID form VMware
hardware_version Hardware version ID from VMware
memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on
cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on
add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
annotation Annotation Notes
scsi_controllers List with SCSI controllers definitions
type - ID of the controller from VMware
key - Key of the controller (e.g. 1000)
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)
--compute-attributes:
resource_group Existing Azure Resource Group of user
vm_size VM Size, eg. Standard_A0 etc.
username The Admin username
password The Admin password
platform OS type eg. Linux
ssh_key_data SSH key for passwordless authentication
os_disk_caching OS disk caching
premium_os_disk Premium OS Disk, Boolean as 0 or 1
script_command Custom Script Command
script_uris Comma seperated file URIs2.13.6.4. hammer compute-profile values remove-interface
Remove compute profile interface
Usage:
hammer compute-profile values remove-interface [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface-id INTERFACE ID Interface id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.13.6.5. hammer compute-profile values remove-volume
Remove compute profile volume
Usage:
hammer compute-profile values remove-volume [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume-id VOLUME_ID Volume id
-h, --help Print help2.13.6.6. hammer compute-profile values update
Update compute profile values
Usage:
hammer compute-profile values update [OPTIONS]
Options:
--compute-attributes COMPUTE_ATTRS Compute resource attributes, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface INTERFACE Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
--interface:
--compute-attributes:
availability_zone
flavor_id
groups
security_group_ids
managed_ip
GCE:
--volume:
size_gb Volume size in GB, integer value
--interface:
--compute-attributes:
machine_type
network
associate_external_ip
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
--compute-attributes:
cpus Number of CPUs
memory String, amount of memory, value in bytes
cpu_mode Possible values: default, host-model, host-passthrough
OpenStack:
--volume:
--interface:
--compute-attributes:
availability_zone
boot_from_volume
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
--compute-attributes:
cluster ID or name of cluster to use
template Hardware profile to use
cores Integer value, number of cores
sockets Integer value, number of sockets
memory Amount of memory, integer value in bytes
ha Boolean, set 1 to high availability
display_type Possible values: VNC, SPICE
keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.
Rackspace:
--volume:
--interface:
--compute-attributes:
flavor_id
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
See documentation center for your version of vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network ID or Network Name from VMware
--compute-attributes:
cluster Cluster ID from VMware
corespersocket Number of cores per socket (applicable to hardware versions < 10 only)
cpus CPU count
memory_mb Integer number, amount of memory in MB
path Path to folder
resource_pool Resource Pool ID from VMware
firmware automatic/bios/efi
guest_id Guest OS ID form VMware
hardware_version Hardware version ID from VMware
memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on
cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on
add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
annotation Annotation Notes
scsi_controllers List with SCSI controllers definitions
type - ID of the controller from VMware
key - Key of the controller (e.g. 1000)
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)
--compute-attributes:
resource_group Existing Azure Resource Group of user
vm_size VM Size, eg. Standard_A0 etc.
username The Admin username
password The Admin password
platform OS type eg. Linux
ssh_key_data SSH key for passwordless authentication
os_disk_caching OS disk caching
premium_os_disk Premium OS Disk, Boolean as 0 or 1
script_command Custom Script Command
script_uris Comma seperated file URIs2.13.6.7. hammer compute-profile values update-interface
Update compute profile interface
Usage:
hammer compute-profile values update-interface [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--interface SET_VALUES Interface parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--interface-id INTERFACE_ID Interface id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--interface:
GCE:
--interface:
Libvirt:
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
OpenStack:
--interface:
oVirt:
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
Rackspace:
--interface:
VMware:
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
See documentation center for your version of vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network ID or Network Name from VMware
AzureRM:
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)2.13.6.8. hammer compute-profile values update-volume
Update compute profile volume
Usage:
hammer compute-profile values update-volume [OPTIONS]
Options:
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--volume VOLUME Volume parameters, should be comma separated list of values
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--volume-id VOLUME_ID Volume id
-h, --help Print help
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
GCE:
--volume:
size_gb Volume size in GB, integer value
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
OpenStack:
--volume:
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
Rackspace:
--volume:
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)2.14. hammer compute-resource
Manipulate compute resources
Usage:
hammer compute-resource [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
clusters List available clusters for a compute resource
create Create a compute resource
delete, destroy Delete a compute resource
flavors List available flavors for a compute resource
folders List available folders for a compute resource
image View and manage compute resource's images
images List available images for a compute resource
info, show Show a compute resource
list, index List all compute resources
networks List available networks for a compute resource
resource-pools List resource pools for a compute resource cluster
security-groups List available security groups for a compute resource
storage-domains List storage domains for a compute resource
storage-pods List storage pods for a compute resource
update Update a compute resource
virtual-machine View and manage compute resource's virtual machines
virtual-machines List available virtual machines for a compute resource
zones List available zone for a compute resource
Options:
-h, --help Print help2.14.1. hammer compute-resource clusters
List available clusters for a compute resource
Usage:
hammer compute-resource clusters [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.2. hammer compute-resource create
Create a compute resource
Usage:
hammer compute-resource create [OPTIONS]
Options:
--app-ident APP_IDENT Client ID for AzureRm
--caching-enabled CACHING_ENABLED Enable caching, for VMware only
One of true/false, yes/no, 1/0.
--datacenter DATACENTER For RHEV, VMware Datacenter
--description DESCRIPTION
--display-type DISPLAY_TYPE For Libvirt and RHEV only
Possible value(s): 'VNC', 'SPICE'
--domain DOMAIN For RHEL OpenStack Platform (v3) only
--email EMAIL Email for GCE only
--key-path KEY_PATH Certificate path for GCE only
--keyboard-layout KEYBOARD_LAYOUT For RHEV only
Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ovirt-quota OVIRT_QUOTA For RHEV only, ID or Name of quota to use
--password PASSWORD Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2
--project PROJECT Project id for GCE only
--project-domain-id PROJECT_DOMAIN_ID For RHEL OpenStack Platform (v3) only
--project-domain-name PROJECT_DOMAIN_NAME For RHEL OpenStack Platform (v3) only
--provider PROVIDER Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm
--public-key PUBLIC_KEY For RHEV only
--public-key-path PUBLIC_KEY_PATH Path to a file that contains oVirt public key (For oVirt only)
--region REGION For AzureRm eg. 'eastus' and for EC2 only. Use
'us-gov-west-1' for EC2 GovCloud region
--secret-key SECRET_KEY Client Secret for AzureRm
--server SERVER For VMware
--set-console-password SET_CONSOLE_PASSWORD For Libvirt and VMware only
One of true/false, yes/no, 1/0.
--sub-id SUB_ID Subscription ID for AzureRm
--tenant TENANT For RHEL OpenStack Platform and AzureRm only
--url URL URL for Libvirt, RHEV and RHEL OpenStack Platform
--use-v4 USE_V4 For RHEV only
One of true/false, yes/no, 1/0.
--user USER Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for
EC2.
--zone ZONE For GCE only
-h, --help Print help2.14.3. hammer compute-resource delete
Delete a compute resource
Usage:
hammer compute-resource <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.14.4. hammer compute-resource flavors
List available flavors for a compute resource
Usage:
hammer compute-resource flavors [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.5. hammer compute-resource folders
List available folders for a compute resource
Usage:
hammer compute-resource folders [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.6. hammer compute-resource image
View and manage compute resource’s images
Usage:
hammer compute-resource image [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
available Show images available for addition
create Create an image
delete, destroy Delete an image
info, show Show an image
list, index List all images for a compute resource
update Update an image
Options:
-h, --help Print help2.14.6.1. hammer compute-resource image available
Show images available for addition
Usage:
hammer compute-resource image available [OPTIONS]
Options:
--compute-resource NAME Compute resource name
--compute-resource-id ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Name | x | x | x
UUID | x | x |
-------|-----|---------|-----2.14.6.2. hammer compute-resource image create
Create an image
Usage:
hammer compute-resource image create [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--password PASSWORD
--user-data USER_DATA Whether or not the image supports user data
One of true/false, yes/no, 1/0.
--username USERNAME
--uuid UUID Template ID in the compute resource
-h, --help Print help2.14.6.3. hammer compute-resource image delete
Delete an image
Usage:
hammer compute-resource image <delete|destroy> [OPTIONS]
Options:
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.14.6.4. hammer compute-resource image info
Show an image
Usage:
hammer compute-resource image <info|show> [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID ID of compute resource
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating System | x | x |
Username | x | x |
UUID | x | x |
User Data | x | x |
Architecture | x | x |
IAM role | x | x |
Created at | x | x |
Updated at | x | x |
-----------------|-----|---------|-----2.14.6.5. hammer compute-resource image list
List all images for a compute resource
Usage:
hammer compute-resource image <list|index> [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID ID of compute resource
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating System | x | x |
Username | x | x |
UUID | x | x |
User Data | x | x |
-----------------|-----|---------|-----
Search / Order fields:
architecture integer
compute_resource string
name string
operatingsystem integer
user_data Values: true, false
username string2.14.6.6. hammer compute-resource image update
Update an image
Usage:
hammer compute-resource image update [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--password PASSWORD
--user-data USER_DATA Whether or not the image supports user data
One of true/false, yes/no, 1/0.
--username USERNAME
--uuid UUID Template ID in the compute resource
-h, --help Print help2.14.7. hammer compute-resource images
List available images for a compute resource
Usage:
hammer compute-resource images [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Uuid | x | x |
Name | x | x | x
-------|-----|---------|-----2.14.8. hammer compute-resource info
Show a compute resource
Usage:
hammer compute-resource <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Provider | x | x |
Description | x | x |
User | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.14.9. hammer compute-resource list
List all compute resources
Usage:
hammer compute-resource <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Provider | x | x |
---------|-----|---------|-----
Search / Order fields:
id integer
location string
location_id integer
name string
organization string
organization_id integer
type string2.14.10. hammer compute-resource networks
List available networks for a compute resource
Usage:
hammer compute-resource networks [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.11. hammer compute-resource resource-pools
List resource pools for a compute resource cluster
Usage:
hammer compute-resource resource-pools [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.12. hammer compute-resource security-groups
List available security groups for a compute resource
Usage:
hammer compute-resource security-groups [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.13. hammer compute-resource storage-domains
List storage domains for a compute resource
Usage:
hammer compute-resource storage-domains [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--storage-domain STORAGE_DOMAIN
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.14. hammer compute-resource storage-pods
List storage pods for a compute resource
Usage:
hammer compute-resource storage-pods [OPTIONS]
Options:
--cluster-id CLUSTER_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--storage-pod STORAGE_POD
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.15. hammer compute-resource update
Update a compute resource
Usage:
hammer compute-resource update [OPTIONS]
Options:
--app-ident APP_IDENT Client ID for AzureRm
--caching-enabled CACHING_ENABLED Enable caching, for VMware only
One of true/false, yes/no, 1/0.
--datacenter DATACENTER For RHEV, VMware Datacenter
--description DESCRIPTION
--display-type DISPLAY_TYPE For Libvirt and RHEV only
Possible value(s): 'VNC', 'SPICE'
--domain DOMAIN For RHEL OpenStack Platform (v3) only
--email EMAIL Email for GCE only
--id ID
--key-path KEY_PATH Certificate path for GCE only
--keyboard-layout KEYBOARD_LAYOUT For RHEV only
Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Compute resource name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ovirt-quota OVIRT_QUOTA For RHEV only, ID or Name of quota to use
--password PASSWORD Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2
--project PROJECT Project id for GCE only
--project-domain-id PROJECT_DOMAIN_ID For RHEL OpenStack Platform (v3) only
--project-domain-name PROJECT_DOMAIN_NAME For RHEL OpenStack Platform (v3) only
--provider PROVIDER Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm
--public-key PUBLIC_KEY For RHEV only
--public-key-path PUBLIC_KEY_PATH Path to a file that contains oVirt public key (For oVirt only)
--region REGION For AzureRm eg. 'eastus' and for EC2 only. Use
'us-gov-west-1' for EC2 GovCloud region
--secret-key SECRET_KEY Client Secret for AzureRm
--server SERVER For VMware
--set-console-password SET_CONSOLE_PASSWORD For Libvirt and VMware only
One of true/false, yes/no, 1/0.
--sub-id SUB_ID Subscription ID for AzureRm
--tenant TENANT For RHEL OpenStack Platform and AzureRm only
--url URL URL for Libvirt, RHEV and RHEL OpenStack Platform
--use-v4 USE_V4 For RHEV only
One of true/false, yes/no, 1/0.
--user USER Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for
EC2.
--zone ZONE For GCE only
-h, --help Print help2.14.16. hammer compute-resource virtual-machine
View and manage compute resource’s virtual machines
Usage:
hammer compute-resource virtual-machine [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete a Virtual Machine
info, show Show a virtual machine
power Power a Virtual Machine
Options:
-h, --help Print help2.14.16.1. hammer compute-resource virtual-machine delete
Delete a Virtual Machine
Usage:
hammer compute-resource virtual-machine <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vm-id VM-ID Virtual machine id, for gce use virtual machine name
-h, --help Print help2.14.16.2. hammer compute-resource virtual-machine info
Show a virtual machine
Usage:
hammer compute-resource virtual-machine <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vm-id VM-ID Virtual machine id, for gce use virtual machine name
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.16.3. hammer compute-resource virtual-machine power
Power a Virtual Machine
Usage:
hammer compute-resource virtual-machine power [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vm-id VM-ID Virtual machine id, for gce use virtual machine name
-h, --help Print help2.14.17. hammer compute-resource virtual-machines
List available virtual machines for a compute resource
Usage:
hammer compute-resource virtual-machines [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.14.18. hammer compute-resource zones
List available zone for a compute resource
Usage:
hammer compute-resource zones [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Compute resource name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----2.15. hammer config-group
Manipulate config groups
Usage:
hammer config-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a config group
delete, destroy Delete a config group
info, show Show a config group
list, index List of config groups
update Update a config group
Options:
-h, --help Print help2.15.1. hammer config-group create
Create a config group
Usage:
hammer config-group create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.15.2. hammer config-group delete
Delete a config group
Usage:
hammer config-group <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.15.3. hammer config-group info
Show a config group
Usage:
hammer config-group <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Puppetclasses/ | x | x |
---------------|-----|---------|-----2.15.4. hammer config-group list
List of config groups
Usage:
hammer config-group <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
class string
name string2.15.5. hammer config-group update
Update a config group
Usage:
hammer config-group update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.16. hammer config-report
Browse and read reports
Usage:
hammer config-report [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete a report
info, show Show a report
list, index List all reports
Options:
-h, --help Print help2.16.1. hammer config-report delete
Delete a report
Usage:
hammer config-report <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.16.2. hammer config-report info
Show a report
Usage:
hammer config-report <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Reported at | x | x |
Report status/Applied | x | x |
Report status/Restarted | x | x |
Report status/Failed | x | x |
Report status/Restart Failures | x | x |
Report status/Skipped | x | x |
Report status/Pending | x | x |
Report metrics/config_retrieval | x | x |
Report metrics/exec | x | x |
Report metrics/file | x | x |
Report metrics/package | x | x |
Report metrics/service | x | x |
Report metrics/user | x | x |
Report metrics/yumrepo | x | x |
Report metrics/filebucket | x | x |
Report metrics/cron | x | x |
Report metrics/total | x | x |
Logs/Resource | x | x |
Logs/Message | x | x |
--------------------------------|-----|---------|-----2.16.3. hammer config-report list
List all reports
Usage:
hammer config-report <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Last report | x | x |
Applied | x | x |
Restarted | x | x |
Failed | x | x |
Restart Failures | x | x |
Skipped | x | x |
Pending | x | x |
-----------------|-----|---------|-----
Search / Order fields:
applied integer
environment string
eventful Values: true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer2.17. hammer content-credentials
Manipulate content credentials on the server
Usage:
hammer content-credentials [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a content credential
delete, destroy Destroy a content credential
info, show Show a content credential
list, index List content credentials
update Update a content credential
Options:
-h, --help Print help2.17.1. hammer content-credentials create
Create a content credential
Usage:
hammer content-credentials create [OPTIONS]
Options:
--content-type CONTENT_TYPE Type of content: "cert", "gpg_key"
--key GPG_KEY_FILE GPG Key file
--name NAME Identifier of the content credential
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.17.2. hammer content-credentials delete
Destroy a content credential
Usage:
hammer content-credentials <delete|destroy> [OPTIONS]
Options:
--id ID Content credential numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.17.3. hammer content-credentials info
Show a content credential
Usage:
hammer content-credentials <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content credential numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Content Type | x | x |
Repositories/Product | x | x |
Content | x | x |
--------------------------|-----|---------|-----2.17.4. hammer content-credentials list
List content credentials
Usage:
hammer content-credentials <list|index> [OPTIONS]
Options:
--content-type CONTENT_TYPE Type of content
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the Content Credential
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----2.17.5. hammer content-credentials update
Update a content credential
Usage:
hammer content-credentials update [OPTIONS]
Options:
--content-type CONTENT_TYPE Type of content
--id ID Content credential numeric identifier
--key GPG_KEY_FILE GPG Key file
--name NAME Name to search by
--new-name NEW_NAME Identifier of the content credential
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.18. hammer content-view
Manipulate content views
Usage:
hammer content-view [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-repository Associate a resource
add-version Add a content view version to a composite view
component View and manage components
copy Copy a content view
create Create a content view
delete Delete a content view
filter View and manage filters
info, show Show a content view
list, index List content views
publish Publish a content view
puppet-module View and manage puppet modules
purge Delete old versions of a content view
remove Remove versions and/or environments from a content view and reassign systems and keys
remove-from-environment Remove a content view from an environment
remove-repository Disassociate a resource
remove-version Remove a content view version from a composite view
update Update a content view
version View and manage content view versions
Options:
-h, --help Print help2.18.1. hammer content-view add-repository
Associate a resource
Usage:
hammer content-view add-repository [OPTIONS]
Options:
--id ID Content view numeric identifier
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository ID
-h, --help Print help2.18.2. hammer content-view add-version
Add a content view version to a composite view
Usage:
hammer content-view add-version [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier to search by
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--id ID Content view numeric identifier
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.3. hammer content-view component
View and manage components
Usage:
hammer content-view component [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add Add components to the content view
list, index List components attached to this content view
remove Remove components from the content view
update Update a component associated with the content view
Options:
-h, --help Print help2.18.3.1. hammer content-view component add
Add components to the content view
Usage:
hammer content-view component add [OPTIONS]
Options:
--component-content-view COMPONENT_CONTENT_VIEW_NAME Content View name of the component who's latest version is desired
--component-content-view-id COMPONENT_CONTENT_VIEW_ID Content View identifier of the component who's latest version is desired
--component-content-view-version COMPONENT_CONTENT_VIEW_VERSION_VERSION Content View Version number of the component. Either use this or --component-content-view-version-id option
--component-content-view-version-id COMPONENT_CONTENT_VIEW_VERSION_ID Content View Version identifier of the component
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME Name of the composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID Composite content view identifier
--latest Select the latest version of the components content view is desired
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.3.2. hammer content-view component list
List components attached to this content view
Usage:
hammer content-view component <list|index> [OPTIONS]
Options:
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME Name of the composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID Composite content view identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Id | x | x | x
Name | x | x |
Version | x | x |
Current Version | x | x |
Version Id | x | x |
----------------|-----|---------|-----2.18.3.3. hammer content-view component remove
Remove components from the content view
Usage:
hammer content-view component remove [OPTIONS]
Options:
--component-content-view-ids COMPONENT_CONTENT_VIEW_IDs Array of component content view identfiers to remove. Comma separated list of values
--component-content-views COMPONENT_CONTENT_VIEW_NAMES Array of component content view names to remove. Comma separated list of values
--component-ids COMPONENT_IDS Array of content view component IDs to remove. Identifier of the component
Association
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME Name of the composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID Composite content view identifier
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.3.4. hammer content-view component update
Update a component associated with the content view
Usage:
hammer content-view component update [OPTIONS]
Options:
--component-content-view COMPONENT_CONTENT_VIEW_NAME Content View name of the component who's latest version is desired
--component-content-view-id COMPONENT_CONTENT_VIEW_ID Content View identifier of the component who's latest version is desired
--component-content-view-version COMPONENT_CONTENT_VIEW_VERSION_VERSION Content View Version number of the component. Either use this or --component-content-view-version-id option
--component-content-view-version-id COMPONENT_CONTENT_VIEW_VERSION_ID Content View Version identifier of the component
--composite-content-view COMPOSITE_CONTENT_VIEW_NAME Name of the composite content view
--composite-content-view-id COMPOSITE_CONTENT_VIEW_ID Composite content view identifier
--id ID Content view component ID. Identifier of the component association
--latest Select the latest version of the components content view is desired
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.4. hammer content-view copy
Copy a content view
Usage:
hammer content-view copy [OPTIONS]
Options:
--id ID Content view numeric identifier
--name NAME Content view name to search by
--new-name NEW_NAME New content view name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.5. hammer content-view create
Create a content view
Usage:
hammer content-view create [OPTIONS]
Options:
--auto-publish AUTO_PUBLISH Enable/Disable auto publish of composite view
One of true/false, yes/no, 1/0.
--component-ids COMPONENT_IDS List of component content view version ids for composite views
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--composite Create a composite content view
--description DESCRIPTION Description for the content view
--label LABEL Content view label
--name NAME Name of the content view
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--solve-dependencies SOLVE_DEPENDENCIES Solve RPM dependencies by default on Content View publish, defaults to
False
One of true/false, yes/no, 1/0.
-h, --help Print help2.18.6. hammer content-view delete
Delete a content view
Usage:
hammer content-view delete [OPTIONS]
Options:
--async Do not wait for the task
--id ID Content view numeric identifier
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.7. hammer content-view filter
View and manage filters
Usage:
hammer content-view filter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-repository Associate a resource
create Create a filter for a content view
delete, destroy Delete a filter
info, show Show filter info
list, index List filters
remove-repository Disassociate a resource
rule View and manage filter rules
update Update a filter
Options:
-h, --help Print help2.18.7.1. hammer content-view filter add-repository
Associate a resource
Usage:
hammer content-view filter add-repository [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--id ID Filter identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository ID
-h, --help Print help2.18.7.2. hammer content-view filter create
create a filter for a content view
Usage:
hammer content-view filter create [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--description DESCRIPTION Description of the filter
--inclusion INCLUSION Specifies if content should be included or excluded, default:
Inclusion=false
One of true/false, yes/no, 1/0.
--name NAME Name of the filter
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--original-module-streams ORIGINAL_MODULE_STREAMS Add all module streams without errata to the included/excluded list.
(module stream filter only)
One of true/false, yes/no, 1/0.
--original-packages ORIGINAL_PACKAGES Add all packages without errata to the included/excluded list. (package
Filter only)
One of true/false, yes/no, 1/0.
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repositories REPOSITORY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--type TYPE Type of filter (e.g. rpm, package_group, erratum, docker, modulemd)
-h, --help Print help2.18.7.3. hammer content-view filter delete
delete a filter
Usage:
hammer content-view filter <delete|destroy> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--id ID Filter identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.7.4. hammer content-view filter info
show filter info
Usage:
hammer content-view filter <info|show> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Filter identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
Filter ID | x | x | x
Name | x | x | x
Type | x | x |
Inclusion | x | x |
Description | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Label | x | x |
Rules/ID | x | x |
Rules/Name | x | x |
Rules/Version | x | x |
Rules/Minimum Version | x | x |
Rules/Maximum Version | x | x |
Rules/Errata ID | x | x |
Rules/Start Date | x | x |
Rules/End Date | x | x |
Rules/Types | x | x |
Rules/Created | x | x |
Rules/Updated | x | x |
----------------------|-----|---------|-----2.18.7.5. hammer content-view filter list
list filters
Usage:
hammer content-view filter <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Filter content view filters by name
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--types TYPES Types of filters
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Filter ID | x | x | x
Name | x | x | x
Description | x | x |
Type | x | x |
Inclusion | x | x |
------------|-----|---------|-----
Search / Order fields:
content_type Values: rpm, package_group, erratum, docker, modulemd
inclusion_type Values: include, exclude
name string2.18.7.6. hammer content-view filter remove-repository
Disassociate a resource
Usage:
hammer content-view filter remove-repository [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--id ID Filter identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository ID
-h, --help Print help2.18.7.7. hammer content-view filter rule
View and manage filter rules
Usage:
hammer content-view filter rule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a filter rule. The parameters included should be based upon the filter type.
delete, destroy Delete a filter rule
info, show Show filter rule info
list, index List filter rules
update Update a filter rule. The parameters included should be based upon the filter type.
Options:
-h, --help Print help2.18.7.7.1. hammer content-view filter rule create
Create a filter rule. The parameters included should be based upon the filter type.
Usage:
hammer content-view filter rule create [OPTIONS]
Options:
--architecture ARCHITECTURE Package: architecture
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Filter identifier
--content-view-id CONTENT_VIEW_ID
--date-type DATE_TYPE Erratum: search using the 'Issued On' or 'Updated On'
Column of the errata. Values are 'issued'/'updated'
--end-date END_DATE Erratum: end date (YYYY-MM-DD)
--errata-id ERRATA_ID Erratum: id
--errata-ids ERRATA_IDS Erratum: IDs or a select all object
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--max-version MAX_VERSION Package: maximum version
--min-version MIN_VERSION Package: minimum version
--module-stream-ids MODULE_STREAM_IDS Module stream ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Package, package group, or docker tag names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--names NAMES Package and package group names
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--start-date START_DATE Erratum: start date (YYYY-MM-DD)
--types TYPES Erratum: types (enhancement, bugfix, security)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--uuid UUID Package group: uuid
--version VERSION Package: version
-h, --help Print help2.18.7.7.2. hammer content-view filter rule delete
Delete a filter rule
Usage:
hammer content-view filter rule <delete|destroy> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Filter identifier
--content-view-id CONTENT_VIEW_ID
--id ID Rule identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.7.7.3. hammer content-view filter rule info
Show filter rule info
Usage:
hammer content-view filter rule <info|show> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Filter identifier
--content-view-id CONTENT_VIEW_ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Rule identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Rule ID | x | x | x
Filter ID | x | x |
Name | x | x | x
Version | x | x |
Minimum Version | x | x |
Maximum Version | x | x |
Architecture | x | x |
Errata ID | x | x |
Start Date | x | x |
End Date | x | x |
Date Type | x | x |
Types | x | x |
Created | x | x |
Updated | x | x |
----------------|-----|---------|-----2.18.7.7.4. hammer content-view filter rule list
List filter rules
Usage:
hammer content-view filter rule <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Filter identifier
--content-view-id CONTENT_VIEW_ID
--errata-id ERRATA_ID Errata_id of the content view filter rule
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the content view filter rule
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Rule ID | x | x | x
Filter ID | x | x |
Name | x | x | x
Version | x | x |
Minimum Version | x | x |
Maximum Version | x | x |
Architecture | x | x |
Errata ID | x | x |
Start Date | x | x |
End Date | x | x |
----------------|-----|---------|-----2.18.7.7.5. hammer content-view filter rule update
Update a filter rule. The parameters included should be based upon the filter type.
Usage:
hammer content-view filter rule update [OPTIONS]
Options:
--architecture ARCHITECTURE Package: architecture
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Filter identifier
--content-view-id CONTENT_VIEW_ID
--end-date END_DATE Erratum: end date (YYYY-MM-DD)
--errata-id ERRATA_ID Erratum: id
--id ID Rule identifier
--max-version MAX_VERSION Package: maximum version
--min-version MIN_VERSION Package: minimum version
--name NAME Name to search by
--new-name NEW_NAME Package, package group, or docker tag: name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--start-date START_DATE Erratum: start date (YYYY-MM-DD)
--types TYPES Erratum: types (enhancement, bugfix, security)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--version VERSION Package: version
-h, --help Print help2.18.7.8. hammer content-view filter update
update a filter
Usage:
hammer content-view filter update [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--description DESCRIPTION Description of the filter
--id ID Filter identifier
--inclusion INCLUSION Specifies if content should be included or excluded, default:
Inclusion=false
One of true/false, yes/no, 1/0.
--name NAME Name to search by
--new-name NEW_NAME New name for the filter
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--original-module-streams ORIGINAL_MODULE_STREAMS Add all module streams without errata to the included/excluded list.
(module stream filter only)
One of true/false, yes/no, 1/0.
--original-packages ORIGINAL_PACKAGES Add all packages without errata to the included/excluded list. (package
Filter only)
One of true/false, yes/no, 1/0.
--repositories REPOSITORY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.18.8. hammer content-view info
Show a content view
Usage:
hammer content-view <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content view numeric identifier
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help
Predefined field sets:
-----------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Label | x | x |
Composite | x | x |
Description | x | x |
Content Host Count | x | x |
Force Puppet | x | x |
Solve Dependencies | x | x |
Organization | x | x |
Yum Repositories/ID | x | x |
Yum Repositories/Name | x | x |
Yum Repositories/Label | x | x |
Container Image Repositories/ID | x | x |
Container Image Repositories/Name | x | x |
Container Image Repositories/Label | x | x |
OSTree Repositories/ID | x | x |
OSTree Repositories/Name | x | x |
OSTree Repositories/Label | x | x |
Puppet Modules/ID | x | x |
Puppet Modules/UUID | x | x |
Puppet Modules/Name | x | x |
Puppet Modules/Author | x | x |
Lifecycle Environments/ID | x | x |
Lifecycle Environments/Name | x | x |
Versions/ID | x | x |
Versions/Version | x | x |
Versions/Published | x | x |
Components/ID | x | x |
Components/Name | x | x |
Activation Keys/ | x | x |
-----------------------------------|-----|---------|-----2.18.9. hammer content-view list
List content views
Usage:
hammer content-view <list|index> [OPTIONS]
Options:
--composite COMPOSITE Filter only composite content views
One of true/false, yes/no, 1/0.
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name of the content view
--noncomposite NONCOMPOSITE Filter out composite content views
One of true/false, yes/no, 1/0.
--nondefault NONDEFAULT Filter out default content views
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--without WITHOUT Do not include this array of content views
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Content View ID | x | x | x
Name | x | x | x
Label | x | x |
Composite | x | x |
Last Published | x | x |
Repository IDs | x | x |
----------------|-----|---------|-----
Search / Order fields:
composite boolean
label string
name string
organization_id integer2.18.10. hammer content-view publish
Publish a content view
Usage:
hammer content-view publish [OPTIONS]
Options:
--async Do not wait for the task
--description DESCRIPTION Description for the new published content view version
--id ID Content view identifier
--major MAJOR Override the major version number
--minor MINOR Override the minor version number
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--repos-units REPOS_UNITS Specify the list of units in each repo
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--repos-units "label=<string>\,rpm_filenames=<array>, ... "2.18.11. hammer content-view puppet-module
View and manage puppet modules
Usage:
hammer content-view puppet-module [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add Add a puppet module to the content view
list, index List content view puppet modules
remove Remove a puppet module from the content view
Options:
-h, --help Print help2.18.11.1. hammer content-view puppet-module add
Add a puppet module to the content view
Usage:
hammer content-view puppet-module add [OPTIONS]
Options:
--author AUTHOR Puppet module's author to search by
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--id ID The id of the puppet module to associate
--name NAME Puppet module name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--uuid UUID Puppet module's UUID to search by
-h, --help Print help2.18.11.2. hammer content-view puppet-module list
List content view puppet modules
Usage:
hammer content-view puppet-module <list|index> [OPTIONS]
Options:
--author AUTHOR Author of the puppet module
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the puppet module
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--uuid UUID Uuid of the puppet module
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
UUID | x | x | x
Name | x | x | x
Author | x | x | x
Version | x | x |
--------|-----|---------|-----
Search / Order fields:
author string
content_view_name string
name string
uuid string2.18.11.3. hammer content-view puppet-module remove
Remove a puppet module from the content view
Usage:
hammer content-view puppet-module remove [OPTIONS]
Options:
--author AUTHOR Puppet module's author to search by
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--id ID Puppet module ID
--name NAME Puppet module name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--uuid UUID Puppet module's UUID to search by
-h, --help Print help2.18.12. hammer content-view purge
Delete old versions of a content view
Usage:
hammer content-view purge [OPTIONS]
Options:
--async Do not wait for the task
--count COUNT Count of unused versions to keep
Default: 3
--id ID Content View numeric identifier
--name NAME Content View name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.13. hammer content-view remove
Remove versions and/or environments from a content view and reassign systems and keys
Usage:
hammer content-view remove [OPTIONS]
Options:
--async Do not wait for the task
--content-view-version-ids VERSION_IDS Version ids to remove
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--content-view-versions CONTENT_VIEW_VERSION_VERSIONS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environment-ids ENVIRONMENT_IDS (--environment-ids is deprecated: Use --lifecycle-environment-ids instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environments ENVIRONMENT_NAMES (--environments is deprecated: Use --lifecycle-environments instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content view numeric identifier
--key-content-view-id KEY_CONTENT_VIEW_ID Content view to reassign orphaned activation keys to
--key-environment-id KEY_ENVIRONMENT_ID Environment to reassign orphaned activation keys to
--lifecycle-environment-ids LIFECYCLE_ENVIRONMENT_IDS Environment ids to remove
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environments LIFECYCLE_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--system-content-view-id SYSTEM_CONTENT_VIEW_ID Content view to reassign orphaned systems to
--system-environment-id SYSTEM_ENVIRONMENT_ID Environment to reassign orphaned systems to
-h, --help Print help2.18.14. hammer content-view remove-from-environment
Remove a content view from an environment
Usage:
hammer content-view remove-from-environment [OPTIONS]
Options:
--async Do not wait for the task
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Content view numeric identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.15. hammer content-view remove-repository
Disassociate a resource
Usage:
hammer content-view remove-repository [OPTIONS]
Options:
--id ID Content view numeric identifier
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository ID
-h, --help Print help2.18.16. hammer content-view remove-version
Remove a content view version from a composite view
Usage:
hammer content-view remove-version [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--id ID Content view numeric identifier
--name NAME Content view name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help Print help2.18.17. hammer content-view update
Update a content view
Usage:
hammer content-view update [OPTIONS]
Options:
--auto-publish AUTO_PUBLISH Enable/Disable auto publish of composite view
One of true/false, yes/no, 1/0.
--component-ids COMPONENT_IDS List of component content view version ids for composite views
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION Description for the content view
--id ID Content view identifier
--name NAME Content view name to search by
--new-name NEW_NAME New name for the content view
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--repository-ids REPOSITORY_IDS List of repository ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--solve-dependencies SOLVE_DEPENDENCIES Solve RPM dependencies by default on Content View publish, defaults to
False
One of true/false, yes/no, 1/0.
-h, --help Print help2.18.18. hammer content-view version
View and manage content view versions
Usage:
hammer content-view version [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete Remove content view version
export Export a content view version
export-default Export the library default content view
export-legacy Export a content view (legacy method)
import Import a content view version
incremental-update Perform an Incremental Update on one or more Content View Versions
info, show Show content view version
list, index List content view versions
promote Promote a content view version
republish-repositories Forces a republish of the version's repositories' metadata
update Update a content view version
Options:
-h, --help Print help2.18.18.1. hammer content-view version delete
Remove content view version
Usage:
hammer content-view version delete [OPTIONS]
Options:
--async Do not wait for the task
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Content view version identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help2.18.18.2. hammer content-view version export
Export a content view version
Usage:
hammer content-view version export [OPTIONS]
Options:
--export-dir EXPORT_DIR Directory to put content view version export into.
--id ID Content View Version numeric identifier
-h, --help Print help2.18.18.3. hammer content-view version export-default
Export the library default content view
Usage:
hammer content-view version export-default [OPTIONS]
Options:
--export-dir EXPORT_DIR Directory to put content view version export into.
-h, --help Print help2.18.18.4. hammer content-view version export-legacy
Export a content view (legacy method)
Usage:
hammer content-view version export-legacy [OPTIONS]
Options:
--async Do not wait for the task
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--export-to-iso EXPORT_TO_ISO Export to ISO format.
One of true/false, yes/no, 1/0.
--id ID Content view version identifier
--iso-mb-size ISO_MB_SIZE Maximum size of each ISO in MB. Relevant only for Pulp 2 repositories
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--since SINCE Optional date of last export (ex: 2010-01-01T12:00:00Z). Relevant only for
Pulp 2 repositories
--version VERSION Content view version number
-h, --help Print help2.18.18.5. hammer content-view version import
Import a content view version
Usage:
hammer content-view version import [OPTIONS]
Options:
--async Do not wait for the task
--export-tar EXPORT_TAR Location of export tar on disk
--organization-id ORGANIZATION_ID Organization numeric identifier
-h, --help Print help2.18.18.6. hammer content-view version incremental-update
Perform an Incremental Update on one or more Content View Versions
Usage:
hammer content-view version incremental-update [OPTIONS]
Options:
--async Do not wait for the task
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content View Version Ids to perform an incremental update on. May contain
Composites as well as one or more components to update.
--deb-ids DEB_IDS Deb Package ids to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--debs DEB_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION The description for the new generated Content View Versions
--errata-ids ERRATA_IDS Errata ids to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host-ids HOST_IDS IDs of hosts to update
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment-ids ENVIRONMENT_IDS List of lifecycle environment IDs to update the content view version in
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environments ENVIRONMENTS List of lifecycle environment names to update the content view version in
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Organization name for resolving lifecycle environment names
--organization-id ORGANIZATION_ID Organization id for resolving lifecycle environment names
--package-ids PACKAGE_IDS Package ids to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--packages PACKAGE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--propagate-all-composites PROPAGATE_ALL_COMPOSITES If true, will publish a new composite version using any specified
Content_view_version_id that has been promoted to a lifecycle environment
One of true/false, yes/no, 1/0.
--puppet-module-ids PUPPET_MODULE_IDS Puppet Module ids to copy into the new versions
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-modules PUPPET_MODULE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--resolve-dependencies RESOLVE_DEPENDENCIES If true, when adding the specified errata or packages, any needed
Dependencies will be copied as well. Defaults to true
One of true/false, yes/no, 1/0.
--update-all-hosts UPDATE Update all editable and applicable hosts within the specified Content View and \
Lifecycle Environments
One of true/false, yes/no, 1/0.
-h, --help Print help2.18.18.7. hammer content-view version info
Show content view version
Usage:
hammer content-view version <info|show> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Content view version identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help
Predefined field sets:
-----------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------------|-----|---------|-----
ID | x | x | x
Name | x | x |
Version | x | x | x
Description | x | x |
Content View ID | x | x |
Content View Name | x | x |
Content View Label | x | x |
Lifecycle Environments/ID | x | x |
Lifecycle Environments/Name | x | x |
Lifecycle Environments/Label | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Label | x | x |
Puppet Modules/ID | x | x |
Puppet Modules/Name | x | x |
Puppet Modules/Author | x | x |
Puppet Modules/Version | x | x |
-----------------------------|-----|---------|-----2.18.18.8. hammer content-view version list
List content view versions
Usage:
hammer content-view version <list|index> [OPTIONS]
Options:
--composite-version-id COMPOSITE_VERSION_ID Filter versions that are components in the specified composite version
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--puppet-module PUPPET_MODULE_NAME Name to search by
--puppet-module-id PUPPET_MODULE_ID Filter versions by puppet module
--search SEARCH Search string
--triggered-by-id TRIGGERED_BY_ID Filter composite versions whose publish was triggered by the specified
Component version
--version VERSION Filter versions by version number
-h, --help Print help
Predefined field sets:
-----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------|-----|---------|-----
ID | x | x | x
Name | x | x |
Version | x | x | x
Description | x | x |
Lifecycle Environments | x | x |
-----------------------|-----|---------|-----
Search / Order fields:
content_view_id integer
repository string
version string2.18.18.9. hammer content-view version promote
Promote a content view version
Usage:
hammer content-view version promote [OPTIONS]
Options:
--async Do not wait for the task
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--description DESCRIPTION The description for the content view version promotion
--force Force content view promotion and bypass lifecycle environment restriction
--from-lifecycle-environment FROM_ENVIRONMENT_ID Environment name from where to promote its version from (if version is unknown)
--from-lifecycle-environment-id FROM_ENVIRONMENT_ID Id of the environment from where to promote its version from (if version is unknown)
--id ID Content view version identifier
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--to-lifecycle-environment TO_ENVIRONMENT Name of the target environment
--to-lifecycle-environment-id TO_ENVIRONMENT_ID Id of the target environment
--version VERSION Content view version number
-h, --help Print help2.18.18.10. hammer content-view version republish-repositories
Forces a republish of the version’s repositories' metadata
Usage:
hammer content-view version republish-repositories [OPTIONS]
Options:
--async Do not wait for the task
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--id ID Content view version identifier
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help2.18.18.11. hammer content-view version update
Update a content view version
Usage:
hammer content-view version update [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--description DESCRIPTION The description for the content view version
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Content view version identifier
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--new-version NEW_VERSION
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--version VERSION Content view version number
-h, --help Print help2.19. hammer deb-package
Manipulate deb packages
Usage:
hammer deb-package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a deb
list, index List debs
Options:
-h, --help Print help2.19.1. hammer deb-package info
Show a deb
Usage:
hammer deb-package <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A deb identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
ID | x | x | x
Pulp ID | x | x |
UUID | x | x |
Name | x | x | x
Version | x | x |
checksum | x | x |
Architecture | x | x |
Nav | x | x |
Nva | x | x |
Filename | x | x |
Available Host Count | x | x |
Applicable Host Count | x | x |
Description | x | x |
----------------------|-----|---------|-----2.19.2. hammer deb-package list
List debs
Usage:
hammer deb-package <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
---------|-----|--------
FIELDS | ALL | DEFAULT
---------|-----|--------
ID | x | x
Filename | x | x
---------|-----|--------2.20. hammer defaults
Defaults management
Usage:
hammer defaults [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add Add a default parameter to config
delete Delete a default param
list List all the default parameters
providers List all the providers
Options:
-h, --help Print help2.20.1. hammer defaults add
Add a default parameter to config
Usage:
hammer defaults add [OPTIONS]
Options:
--param-name OPTION_NAME The name of the default option (e.g. organization_id)
--param-value OPTION_VALUE The value for the default option
--provider OPTION_PROVIDER The name of the provider providing the value. For list available providers see `hammer defaults providers`
-h, --help Print help2.20.2. hammer defaults delete
Delete a default param
Usage:
hammer defaults delete [OPTIONS]
Options:
--param-name OPTION_NAME The name of the default option
-h, --help Print help2.20.3. hammer defaults list
List all the default parameters
Usage:
hammer defaults list [OPTIONS]
Options:
-h, --help Print help2.20.4. hammer defaults providers
List all the providers
Usage:
hammer defaults providers [OPTIONS]
Options:
-h, --help Print help2.21. hammer discovery
Manipulate discovered hosts.
Usage:
hammer discovery [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
auto-provision Auto provision a host
delete, destroy Delete a discovered host
facts List all fact values
info, show Show a discovered host
list, index List all discovered hosts
provision Provision a discovered host
reboot Reboot a host
refresh-facts Refresh the facts of a host
Options:
-h, --help Print help2.21.1. hammer discovery auto-provision
Auto provision a host
Usage:
hammer discovery auto-provision [OPTIONS]
Options:
--all Auto provision all discovered hosts
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.21.2. hammer discovery delete
Delete a discovered host
Usage:
hammer discovery <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.21.3. hammer discovery facts
List all fact values
Usage:
hammer discovery facts [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|--------
FIELDS | ALL | DEFAULT
-------|-----|--------
Fact | x | x
Value | x | x
-------|-----|--------
Search / Order fields:
fact string
fact_short_name string
facts string
host string
host.hostgroup string
host_id integer
location string
location_id integer
name string
organization string
organization_id integer
origin string
reported_at datetime
short_name string
type string
value string2.21.4. hammer discovery info
Show a discovered host
Usage:
hammer discovery <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
MAC | x | x |
CPUs | x | x |
Memory | x | x |
Disk count | x | x |
Disks size | x | x |
Subnet | x | x |
Last report | x | x |
IP | x | x |
Model | x | x |
Organization | x | x |
Location | x | x |
-------------|-----|---------|-----2.21.5. hammer discovery list
List all discovered hosts
Usage:
hammer discovery <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort results
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Paginate results
--per-page PER_PAGE Number of entries per request
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
MAC | x | x |
CPUs | x | x |
Memory | x | x |
Disk count | x | x |
Disks size | x | x |
Subnet | x | x |
Last report | x | x |
------------|-----|---------|-----2.21.6. hammer discovery provision
Provision a discovered host
Usage:
hammer discovery provision [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID Required if host is managed and value is not inherited from host group
--ask-root-password ASK_ROOT_PW One of true/false, yes/no, 1/0.
--build BUILD One of true/false, yes/no, 1/0.
--capabilities CAPABILITIES
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Required if host is managed and value is not inherited from host group
--enabled ENABLED One of true/false, yes/no, 1/0.
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID
--image IMAGE_NAME Name to search by
--image-id IMAGE_ID
--interface INTERFACE Interface parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--ip IP Not required if using a subnet with DHCP Capsule
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mac MAC Not required if it's a virtual machine
--managed MANAGED One of true/false, yes/no, 1/0.
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID Required if not imaged based provisioning and host is managed and value is
not inherited from host group
--model MODEL_NAME Model name
--model-id MODEL_ID
--name NAME Name to search by
--new-name NEW_NAME
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID Required if host is managed and value is not inherited from host group
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--overwrite OVERWRITE One of true/false, yes/no, 1/0.
--owner-id OWNER_ID
--owner-type OWNER_TYPE Host's owner type
Possible value(s): 'User', 'Usergroup'
--parameters PARAMS Host parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--progress-report-id PROGRESS_REPORT_ID UUID to track orchestration tasks status, GET
/api/orchestration/:UUID/tasks
--provision-method METHOD Possible value(s): 'build', 'image'
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--puppet-proxy-id PUPPET_PROXY_ID
--puppetclass-ids PUPPETCLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--pxe-loader PXE_LOADER DHCP filename option (Grub2 or PXELinux by default)
Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
--root-password ROOT_PW
--sp-subnet-id SP_SUBNET_ID
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Required if host is managed and value is not inherited from host group
-h, --help Print help2.21.7. hammer discovery reboot
Reboot a host
Usage:
hammer discovery reboot [OPTIONS]
Options:
--all Reboot all discovered hosts
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.21.8. hammer discovery refresh-facts
Refresh the facts of a host
Usage:
hammer discovery refresh-facts [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.22. hammer discovery-rule
Manipulate discovered rules.
Usage:
hammer discovery-rule [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a discovery rule
delete, destroy Delete a rule
info, show Show a discovery rule
list, index List all discovery rules
update Update a rule
Options:
-h, --help Print help2.22.1. hammer discovery-rule create
Create a discovery rule
Usage:
hammer discovery-rule create [OPTIONS]
Options:
--enabled ENABLED Flag is used for temporary shutdown of rules
One of true/false, yes/no, 1/0.
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID The hostgroup that is used to auto provision a host
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--hostname HOSTNAME Defines a pattern to assign human-readable hostnames to the matching hosts
--hosts-limit HOSTS_LIMIT
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Location ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--max-count MAX_COUNT Enables to limit maximum amount of provisioned hosts per rule
--name NAME Represents rule name shown to the users
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Organization ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--priority PRIORITY Puts the rules in order, low numbers go first. Must be greater then zero
--search SEARCH Query to match discovered hosts for the particular rule
-h, --help Print help2.22.2. hammer discovery-rule delete
Delete a rule
Usage:
hammer discovery-rule <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.22.3. hammer discovery-rule info
Show a discovery rule
Usage:
hammer discovery-rule <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Priority | x | x |
Search | x | x |
Host Group | x | x |
Hosts Limit | x | x |
Enabled | x | x |
Hostname template | x | x |
Hosts/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
------------------|-----|---------|-----2.22.4. hammer discovery-rule list
List all discovery rules
Usage:
hammer discovery-rule <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort results
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Paginate results
--per-page PER_PAGE Number of entries per request
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Priority | x | x |
Search | x | x |
Host Group | x | x |
Hosts Limit | x | x |
Enabled | x | x |
------------|-----|---------|-----2.22.5. hammer discovery-rule update
Update a rule
Usage:
hammer discovery-rule update [OPTIONS]
Options:
--enabled ENABLED Flag is used for temporary shutdown of rules
One of true/false, yes/no, 1/0.
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID The hostgroup that is used to auto provision a host
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--hostname HOSTNAME Defines a pattern to assign human-readable hostnames to the matching hosts
--hosts-limit HOSTS_LIMIT
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Location ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--max-count MAX_COUNT Enables to limit maximum amount of provisioned hosts per rule
--name NAME Name to search by
--new-name NEW_NAME Represents rule name shown to the users
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Organization ID for provisioned hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--priority PRIORITY Puts the rules in order, low numbers go first. Must be greater then zero
--search SEARCH Query to match discovered hosts for the particular rule
-h, --help Print help2.23. hammer docker
Manipulate docker content
Usage:
hammer docker [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
manifest Manage docker manifests
tag Manage docker tags
Options:
-h, --help Print help2.23.1. hammer docker manifest
Manage docker manifests
Usage:
hammer docker manifest [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a docker manifest
list, index List docker_manifests
Options:
-h, --help Print help2.23.1.1. hammer docker manifest info
Show a docker manifest
Usage:
hammer docker manifest <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A docker manifest identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Schema Version | x | x |
Digest | x | x |
Downloaded | x | x |
Tags/Name | x | x |
---------------|-----|---------|-----2.23.1.2. hammer docker manifest list
List docker_manifests
Usage:
hammer docker manifest <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Schema Version | x | x |
Digest | x | x |
Downloaded | x | x |
Tags | x | x |
---------------|-----|---------|-----2.23.2. hammer docker tag
Manage docker tags
Usage:
hammer docker tag [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a docker tag
list, index List docker_tags
Options:
-h, --help Print help2.23.2.1. hammer docker tag info
Show a docker tag
Usage:
hammer docker tag <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A docker tag identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
---------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------|-----|---------|-----
ID | x | x | x
Tag | x | x | x
Repository ID | x | x |
Docker Manifest ID | x | x |
Docker Manifest Name | x | x |
---------------------|-----|---------|-----2.23.2.2. hammer docker tag list
List docker_tags
Usage:
hammer docker tag <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
ID | x | x | x
Tag | x | x | x
Repository ID | x | x |
--------------|-----|---------|-----2.24. hammer domain
Manipulate domains
Usage:
hammer domain [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a domain
delete, destroy Delete a domain
delete-parameter Delete parameter for a domain
info, show Show a domain
list, index List of domains
set-parameter Create or update parameter for a domain
update Update a domain
Options:
-h, --help Print help2.24.1. hammer domain create
Create a domain
Usage:
hammer domain create [OPTIONS]
Options:
--description DESC Full name describing the domain
--dns DNS_NAME Name of DNS proxy to use within this domain
--dns-id DNS_ID ID of DNS proxy to use within this domain
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME The full DNS domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.24.2. hammer domain delete
Delete a domain
Usage:
hammer domain <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.24.3. hammer domain delete-parameter
Delete parameter for a domain
Usage:
hammer domain delete-parameter [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--name NAME Parameter name
-h, --help Print help2.24.4. hammer domain info
Show a domain
Usage:
hammer domain <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Numerical ID or domain name
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Description | x | x |
DNS Id | x | x |
Subnets/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Parameters/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.24.5. hammer domain list
List of domains
Usage:
hammer domain <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID ID of subnet
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
fullname string
location string
location_id integer
name string
organization string
organization_id integer
params string2.24.6. hammer domain set-parameter
Create or update parameter for a domain
Usage:
hammer domain set-parameter [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.24.7. hammer domain update
Update a domain
Usage:
hammer domain update [OPTIONS]
Options:
--description DESC Full name describing the domain
--dns DNS_NAME Name of DNS proxy to use within this domain
--dns-id DNS_ID ID of DNS proxy to use within this domain
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Domain name
--new-name NEW_NAME The full DNS domain name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.25. hammer environment
Manipulate environments
Usage:
hammer environment [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an environment
delete, destroy Delete an environment
info, show Show an environment
list, index List all environments
sc-params List all smart class parameters
update Update an environment
Options:
-h, --help Print help2.25.1. hammer environment create
Create an environment
Usage:
hammer environment create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.25.2. hammer environment delete
Delete an environment
Usage:
hammer environment <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Puppet environment name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.25.3. hammer environment info
Show an environment
Usage:
hammer environment <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Puppet environment name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Puppetclasses/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.25.4. hammer environment list
List all environments
Usage:
hammer environment <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
content_view string
lifecycle_environment string
location string
location_id integer
name string
organization string
organization_id integer2.25.5. hammer environment sc-params
List all smart class parameters
Usage:
hammer environment sc-params [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
Puppet class | x | x
Class Id | x | x
--------------|-----|--------
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string2.25.6. hammer environment update
Update an environment
Usage:
hammer environment update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Puppet environment name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.26. hammer erratum
Manipulate errata
Usage:
hammer erratum [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info Show an erratum
list, index List errata
Options:
-h, --help Print help2.26.1. hammer erratum info
Show an erratum
Usage:
hammer erratum info [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID An erratum identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------|-----|--------
Title | x | x
Version | x | x
Description | x | x
Status | x | x
ID | x | x
Errata ID | x | x
Reboot Suggested | x | x
Updated | x | x
Issued | x | x
Release | x | x
Solution | x | x
Packages | x | x
Module Streams/Name | x | x
Module Streams/Stream | x | x
Module Streams/Packages | x | x
------------------------|-----|--------2.26.2. hammer erratum list
List errata
Usage:
hammer erratum <list|index> [OPTIONS]
Options:
--available-for AVAILABLE_FOR Return errata that can be added to the specified object. The values
'content_view_version' and 'content_view_filter are supported.
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content View Filter identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content View Version identifier
--cve CVE CVE identifier
--errata-restrict-applicable ERRATA_RESTRICT_APPLICABLE Return errata that are applicable to one or more hosts (defaults to true if
Host_id is specified)
One of true/false, yes/no, 1/0.
--errata-restrict-installable ERRATA_RESTRICT_INSTALLABLE Return errata that are upgradable on one or more hosts
One of true/false, yes/no, 1/0.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID Host id to list applicable errata for
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
----------|-----|--------
FIELDS | ALL | DEFAULT
----------|-----|--------
ID | x | x
Errata ID | x | x
Type | x | x
Title | x | x
Issued | x | x
Updated | x | x
----------|-----|--------
Search / Order fields:
bug string
cve string
errata_id string
errata_type string
id string
issued date
modular Values: true, false
package string
package_name string
reboot_suggested boolean
repository string
severity string
title string
type string
updated date2.27. hammer export-templates
Export templates to a git repo or a directory on the server
Usage:
hammer export-templates [OPTIONS]
Options:
--branch BRANCH Branch in Git repo.
--commit-msg COMMIT_MSG Custom commit message for templates export
--dirname DIRNAME The directory within Git repo containing the templates
--filter FILTER Export templates with names matching this regex (case-insensitive; snippets
Are not filtered).
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--metadata-export-mode METADATA_EXPORT_MODE Specify how to handle metadata
Possible value(s): 'refresh', 'keep', 'remove'
--negate NEGATE Negate the prefix (for purging).
One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--repo REPO Override the default repo from settings.
--verbose BE_VERBOSE Be verbose
One of true/false, yes/no, 1/0.
-h, --help Print help2.28. hammer fact
Search facts
Usage:
hammer fact [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
list, index List all fact values
Options:
-h, --help Print help2.28.1. hammer fact list
List all fact values
Usage:
hammer fact <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|--------
FIELDS | ALL | DEFAULT
-------|-----|--------
Host | x | x
Fact | x | x
Value | x | x
-------|-----|--------
Search / Order fields:
fact string
fact_short_name string
facts string
host string
host.hostgroup string
host_id integer
location string
location_id integer
name string
organization string
organization_id integer
origin string
reported_at datetime
short_name string
type string
value string2.29. hammer file
Manipulate files
Usage:
hammer file [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a file
list, index List files
Options:
-h, --help Print help2.29.1. hammer file info
Show a file
Usage:
hammer file <info|show> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content View Version ID
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A file identifier
--name NAME File name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository ID
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
ID | x | x |
Name | x | x | x
Path | x | x |
UUID | x | x |
Checksum | x | x |
---------|-----|---------|-----2.29.2. hammer file list
List files
Usage:
hammer file <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x |
Name | x | x | x
Path | x | x |
-------|-----|---------|-----2.30. hammer filter
Manage permission filters
Usage:
hammer filter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
available-permissions List all permissions
available-resources List available resource types
create Create a filter
delete, destroy Delete a filter
info, show Show a filter
list, index List all filters
update Update a filter
Options:
-h, --help Print help2.30.1. hammer filter available-permissions
List all permissions
Usage:
hammer filter available-permissions [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Resource | x | x |
---------|-----|---------|-----
Search / Order fields:
name string
resource_type string2.30.2. hammer filter available-resources
List available resource types
Usage:
hammer filter available-resources [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Name | x | x | x
-------|-----|---------|-----2.30.3. hammer filter create
Create a filter
Usage:
hammer filter create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--override OVERRIDE One of true/false, yes/no, 1/0.
--permission-ids PERMISSION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--permissions PERMISSION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--role ROLE_NAME User role name
--role-id ROLE_ID
--search SEARCH
-h, --help Print help
Overriding organizations and locations:
Filters inherit organizations and locations from its role by default. This behavior can be changed by setting --override=true.
Therefore options --organization[s|-ids] and --location[s|-ids] are applicable only when the override flag is set.2.30.4. hammer filter delete
Delete a filter
Usage:
hammer filter <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.30.5. hammer filter info
Show a filter
Usage:
hammer filter <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Resource type | x | x |
Search | x | x |
Unlimited? | x | x |
Override? | x | x |
Role | x | x |
Permissions | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.30.6. hammer filter list
List all filters
Usage:
hammer filter <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
Id | x | x | x
Resource type | x | x |
Search | x | x |
Unlimited? | x | x |
Override? | x | x |
Role | x | x |
Permissions | x | x |
--------------|-----|---------|-----
Search / Order fields:
limited Values: true, false
location string
location_id integer
organization string
organization_id integer
override Values: true, false
permission string
resource string
role string
role_id integer
search text
unlimited Values: true, false2.30.7. hammer filter update
Update a filter
Usage:
hammer filter update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--override OVERRIDE One of true/false, yes/no, 1/0.
--permission-ids PERMISSION_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--permissions PERMISSION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--role ROLE_NAME User role name
--role-id ROLE_ID
--search SEARCH
-h, --help Print help
Overriding organizations and locations:
Filters inherit organizations and locations from its role by default. This behavior can be changed by setting --override=true.
Therefore options --organization[s|-ids] and --location[s|-ids] are applicable only when the override flag is set.2.31. hammer foreign-input-set
Manage foreign input sets
Usage:
hammer foreign-input-set [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a foreign input set
delete, destroy Delete a foreign input set
info, show Show foreign input set details
list, index List foreign input sets
update Update a foreign input set
Options:
-h, --help Print help2.31.1. hammer foreign-input-set create
Create a foreign input set
Usage:
hammer foreign-input-set create [OPTIONS]
Options:
--description DESCRIPTION Input set description
--exclude EXCLUDE A comma separated list of input names to be included from the foreign
Template.
--include INCLUDE A comma separated list of input names to be included from the foreign
Template.
--include-all INCLUDE_ALL Include all inputs from the foreign template
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--target-template-id TARGET_TEMPLATE_ID Target template ID
--template-id TEMPLATE_ID
-h, --help Print help2.31.2. hammer foreign-input-set delete
Delete a foreign input set
Usage:
hammer foreign-input-set <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--template-id TEMPLATE_ID
-h, --help Print help2.31.3. hammer foreign-input-set info
Show foreign input set details
Usage:
hammer foreign-input-set <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--template-id TEMPLATE_ID
-h, --help Print help
Predefined field sets:
---------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Target template ID | x | x |
Target template name | x | x |
Include all | x | x |
Include | x | x |
Exclude | x | x |
---------------------|-----|---------|-----2.31.4. hammer foreign-input-set list
List foreign input sets
Usage:
hammer foreign-input-set <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--template-id TEMPLATE_ID
-h, --help Print help
Predefined field sets:
---------------------|-----|--------
FIELDS | ALL | DEFAULT
---------------------|-----|--------
ID | x | x
Target template ID | x | x
Target template name | x | x
---------------------|-----|--------2.31.5. hammer foreign-input-set update
Update a foreign input set
Usage:
hammer foreign-input-set update [OPTIONS]
Options:
--description DESCRIPTION Input set description
--exclude EXCLUDE A comma separated list of input names to be included from the foreign
Template.
--id ID
--include INCLUDE A comma separated list of input names to be included from the foreign
Template.
--include-all INCLUDE_ALL Include all inputs from the foreign template
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--target-template-id TARGET_TEMPLATE_ID Target template ID
--template-id TEMPLATE_ID
-h, --help Print help2.32. hammer full-help
Print help for all hammer commands
Usage:
hammer full-help [OPTIONS]
Options:
--md Format output in markdown
-h, --help Print help2.33. hammer global-parameter
Manipulate global parameters
Usage:
hammer global-parameter [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete a global parameter
list, index List all global parameters
set Set a global parameter
Options:
-h, --help Print help2.33.1. hammer global-parameter delete
Delete a global parameter
Usage:
hammer global-parameter <delete|destroy> [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Common parameter name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.33.2. hammer global-parameter list
List all global parameters
Usage:
hammer global-parameter <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Name | x | x | x
Value | x | x |
Type | x | x |
-------|-----|---------|-----
Search / Order fields:
domain_name string
host_group_name string
host_name string
key_type string
location_name string
name string
organization_name string
os_name string
parameter_type string
subnet_name text
type string
value text2.33.3. hammer global-parameter set
Set a global parameter
Usage:
hammer global-parameter set [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.34. hammer gpg
Manipulate GPG Key actions on the server
Usage:
hammer gpg [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a gpg key
delete, destroy Destroy a gpg key
info, show Show a gpg key
list, index List gpg keys
update Update a repository
Options:
-h, --help Print help2.34.1. hammer gpg create
Create a gpg key
Usage:
hammer gpg create [OPTIONS]
Options:
--key GPG_KEY_FILE GPG Key file
--name NAME Identifier of the gpg key
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.34.2. hammer gpg delete
Destroy a gpg key
Usage:
hammer gpg <delete|destroy> [OPTIONS]
Options:
--id ID Gpg key numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.34.3. hammer gpg info
Show a gpg key
Usage:
hammer gpg <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Gpg key numeric identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
Repositories/ID | x | x |
Repositories/Name | x | x |
Repositories/Content Type | x | x |
Repositories/Product | x | x |
Content | x | x |
--------------------------|-----|---------|-----2.34.4. hammer gpg list
List gpg keys
Usage:
hammer gpg <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Name of the GPG key
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
name string
organization_id integer2.34.5. hammer gpg update
Update a repository
Usage:
hammer gpg update [OPTIONS]
Options:
--id ID Gpg key numeric identifier
--key GPG_KEY_FILE GPG Key file
--name NAME Name to search by
--new-name NEW_NAME Identifier of the gpg key
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.35. hammer host
Manipulate hosts
Usage:
hammer host [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
ansible-roles Manage Ansible roles on a host
boot Boot host from specified device
config-reports List all reports
create Create a host
deb-package Manage deb packages on your hosts
delete, destroy Delete a host
delete-parameter Delete parameter for a host
disassociate Disassociate a host
enc-dump Dump host's ENC YAML
errata Manage errata on your hosts
facts List all fact values
info, show Show a host
interface View and manage host's network interfaces
list, index List all hosts
package Manage packages on your hosts
package-group Manage package-groups on your hosts
policies-enc View policies ENC for host
puppet-classes List all Puppet classes
puppetrun Force a Puppet agent run on the host
reboot Reboot a host
rebuild-config Rebuild orchestration related configurations for host
reports List all reports
reset Reset a host
sc-params List all smart class parameters
set-parameter Create or append a parameter for a host
start Power a host on
status Get status of host
stop Power a host off
subscription Manage subscription information on your hosts
traces List traces on your hosts
update Update a host
Options:
-h, --help Print help2.35.1. hammer host ansible-roles
Manage Ansible roles on a host
Usage:
hammer host ansible-roles [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
assign Assigns Ansible roles to a host
list, index List all Ansible roles for a host
play Runs all Ansible roles on a host
Options:
-h, --help Print help2.35.1.1. hammer host ansible-roles assign
Assigns Ansible roles to a host
Usage:
hammer host ansible-roles assign [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS Ansible roles to assign to a host
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.1.2. hammer host ansible-roles list
List all Ansible roles for a host
Usage:
hammer host ansible-roles <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Imported at | x | x |
------------|-----|---------|-----2.35.1.3. hammer host ansible-roles play
Runs all Ansible roles on a host
Usage:
hammer host ansible-roles play [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.2. hammer host boot
Boot host from specified device
Usage:
hammer host boot [OPTIONS]
Options:
--device DEVICE Boot device, valid devices are disk, cdrom, pxe, bios
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.3. hammer host config-reports
List all reports
Usage:
hammer host config-reports [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Host id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Last report | x | x |
Applied | x | x |
Restarted | x | x |
Failed | x | x |
Restart Failures | x | x |
Skipped | x | x |
Pending | x | x |
-----------------|-----|---------|-----
Search / Order fields:
applied integer
environment string
eventful Values: true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer2.35.4. hammer host create
Create a host
Usage:
hammer host create [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS IDs of associated ansible roles
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID Required if host is managed and value is not inherited from host group
--ask-root-password ASK_ROOT_PW One of true/false, yes/no, 1/0.
--autoheal AUTOHEAL Sets whether the Host will autoheal subscriptions upon checkin
One of true/false, yes/no, 1/0.
--build BUILD One of true/false, yes/no, 1/0.
--comment COMMENT Additional information about this host
--compute-attributes COMPUTE_ATTRS Compute resource attributes
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID Nil means host is bare metal
--config-group-ids CONFIG_GROUP_IDS IDs of associated config groups
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--config-groups CONFIG_GROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--content-source CONTENT_SOURCE_NAME Content Source name
--content-source-id CONTENT_SOURCE_ID
--content-view CONTENT_VIEW_NAME Name to search by
--content-view-id CONTENT_VIEW_ID
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Required if host is managed and value is not inherited from host group
--enabled ENABLED Include this host within Satellite reporting
One of true/false, yes/no, 1/0.
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS List of hypervisor guest uuids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--image IMAGE_NAME Name to search by
--image-id IMAGE_ID
--installed-products-attributes INSTALLED_PRODUCTS_ATTRIBUTES List of products installed on the host
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--interface INTERFACE Interface parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--ip IP Not required if using a subnet with DHCP Capsule
--kickstart-repository REPOSITORY_NAME Kickstart repository name
--kickstart-repository-id KICKSTART_REPOSITORY_ID Repository Id associated with the kickstart repo used for provisioning
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mac MAC Required for managed host that is bare metal, not required if it's a
Virtual machine
--managed MANAGED True/False flag whether a host is managed or unmanaged. Note: this value
Also determines whether several parameters are required or not
One of true/false, yes/no, 1/0.
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID Required if not imaged based provisioning and host is managed and value is
Not inherited from host group
--model MODEL_NAME Model name
--model-id MODEL_ID
--name NAME
--openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID Required if host is managed and value is not inherited from host group
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--overwrite OVERWRITE One of true/false, yes/no, 1/0.
Default: "true"
--owner OWNER_LOGIN Login of the owner
--owner-id OWNER_ID ID of the owner
--owner-type OWNER_TYPE Host's owner type
Possible value(s): 'User', 'Usergroup'
--parameters PARAMS Replaces with new host parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--product PRODUCT_NAME Name to search by
--product-id PRODUCT_ID Product id as listed from a host's installed products, this is
Not the same product id as the products api returns
--progress-report-id PROGRESS_REPORT_ID UUID to track orchestration tasks status, GET
/api/orchestration/:UUID/tasks
--provision-method PROVISION_METHOD The method used to provision the host.
Possible value(s): 'build', 'image', 'bootdisk'
--puppet-ca-proxy PUPPET_CA_PROXY_NAME
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--puppet-proxy PUPPET_PROXY_NAME
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID
--purpose-addons PURPOSE_ADDONS Sets the system add-ons
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--purpose-role PURPOSE_ROLE Sets the system purpose usage
--purpose-usage PURPOSE_USAGE Sets the system purpose usage
--pxe-loader PXE_LOADER DHCP filename option (Grub2/PXELinux by default)
Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
--realm REALM_NAME Name to search by
--realm-id REALM_ID
--release-version RELEASE_VERSION Release version for this Host to use (7Server, 7.1, etc)
--root-password ROOT_PW Required if host is managed and value is not inherited from host group or default password in settings
--service-level SERVICE_LEVEL Service level to be used for autoheal
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Required if host is managed and value is not inherited from host group
--typed-parameters TYPED_PARAMS Replaces with new host parameters (with type support)
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--volume VOLUME Volume parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--typed-parameters "name=<string>\,value=<string>\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\,hidden_value=[true|false|1|0], ... "
--installed-products-attributes "product_id=<string>\,product_name=<string>\,arch=<string>\,version=<string>, ... "
Available keys for --interface:
mac
ip
type Possible values: interface, bmc, bond, bridge
name
subnet_id
domain_id
identifier
managed true/false
primary true/false, each managed hosts needs to have one primary interface.
provision true/false
virtual true/false
For virtual=true:
tag VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.
attached_to Identifier of the interface to which this interface belongs, e.g. eth1.
For type=bond:
mode Possible values: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb
attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2]
bond_options
For type=bmc:
provider always IPMI
username
password
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
--interface:
--compute-attributes:
availability_zone
flavor_id
groups
security_group_ids
managed_ip
GCE:
--volume:
size_gb Volume size in GB, integer value
--interface:
--compute-attributes:
machine_type
network
associate_external_ip
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
--compute-attributes:
cpus Number of CPUs
memory String, amount of memory, value in bytes
cpu_mode Possible values: default, host-model, host-passthrough
start Boolean (expressed as 0 or 1), whether to start the machine or not
OpenStack:
--volume:
--interface:
--compute-attributes:
availability_zone
boot_from_volume
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
--compute-attributes:
cluster ID or name of cluster to use
template Hardware profile to use
cores Integer value, number of cores
sockets Integer value, number of sockets
memory Amount of memory, integer value in bytes
ha Boolean, set 1 to high availability
display_type Possible values: VNC, SPICE
keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.
start Boolean, set 1 to start the vm
Rackspace:
--volume:
--interface:
--compute-attributes:
flavor_id
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
See documentation center for your version of vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network ID or Network Name from VMware
--compute-attributes:
cluster Cluster ID from VMware
corespersocket Number of cores per socket (applicable to hardware versions < 10 only)
cpus CPU count
memory_mb Integer number, amount of memory in MB
path Path to folder
resource_pool Resource Pool ID from VMware
firmware automatic/bios/efi
guest_id Guest OS ID form VMware
hardware_version Hardware version ID from VMware
memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on
cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on
add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
annotation Annotation Notes
scsi_controllers List with SCSI controllers definitions
type - ID of the controller from VMware
key - Key of the controller (e.g. 1000)
start Must be a 1 or 0, whether to start the machine or not
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)
--compute-attributes:
resource_group Existing Azure Resource Group of user
vm_size VM Size, eg. Standard_A0 etc.
username The Admin username
password The Admin password
platform OS type eg. Linux
ssh_key_data SSH key for passwordless authentication
os_disk_caching OS disk caching
premium_os_disk Premium OS Disk, Boolean as 0 or 1
script_command Custom Script Command
script_uris Comma seperated file URIs2.35.5. hammer host deb-package
Manage deb packages on your hosts
Usage:
hammer host deb-package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
list, index List deb packages installed on the host
Options:
-h, --help Print help2.35.5.1. hammer host deb-package list
List deb packages installed on the host
Usage:
hammer host deb-package <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--order ORDER Sort field and order, eg. 'id DESC'
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Version | x | x |
Arch | x | x |
--------|-----|---------|-----2.35.6. hammer host delete
Delete a host
Usage:
hammer host <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.7. hammer host delete-parameter
Delete parameter for a host
Usage:
hammer host delete-parameter [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID
--name NAME Parameter name
-h, --help Print help2.35.8. hammer host disassociate
Disassociate a host
Usage:
hammer host disassociate [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.9. hammer host enc-dump
Dump host’s ENC YAML
Usage:
hammer host enc-dump [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.10. hammer host errata
Manage errata on your hosts
Usage:
hammer host errata [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
apply Schedule errata for installation
info Retrieve a single errata for a host
list List errata available for the content host
recalculate Force regenerate applicability.
Options:
-h, --help Print help2.35.10.1. hammer host errata apply
Schedule errata for installation
Usage:
hammer host errata apply [OPTIONS]
Options:
--async Do not wait for the task
--errata-ids ERRATA_IDS List of Errata ids to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID Host ID
--ids IDS List of errata ids to perform an action on, (ex: RHSA-2019:1168)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--search SEARCH Search string for erratum to perform an action on
-h, --help Print help2.35.10.2. hammer host errata info
Retrieve a single errata for a host
Usage:
hammer host errata info [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID Host ID
--id ID Errata id of the erratum (RHSA-2012:108)
--name NAME Name to search by
-h, --help Print help
Predefined field sets:
------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------|-----|--------
Title | x | x
Version | x | x
Description | x | x
Status | x | x
ID | x | x
Errata ID | x | x
Reboot Suggested | x | x
Updated | x | x
Issued | x | x
Release | x | x
Solution | x | x
Packages | x | x
Module Streams/Name | x | x
Module Streams/Stream | x | x
Module Streams/Packages | x | x
------------------------|-----|--------2.35.10.3. hammer host errata list
List errata available for the content host
Usage:
hammer host errata list [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Calculate Applicable Errata based on a particular Content View
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID UUID of the content host
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
------------|-----|--------
FIELDS | ALL | DEFAULT
------------|-----|--------
ID | x | x
Erratum ID | x | x
Type | x | x
Title | x | x
Installable | x | x
------------|-----|--------2.35.10.4. hammer host errata recalculate
Force regenerate applicability.
Usage:
hammer host errata recalculate [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID Host ID
-h, --help Print help2.35.11. hammer host facts
List all fact values
Usage:
hammer host facts [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|--------
FIELDS | ALL | DEFAULT
-------|-----|--------
Fact | x | x
Value | x | x
-------|-----|--------
Search / Order fields:
fact string
fact_short_name string
facts string
host string
host.hostgroup string
host_id integer
location string
location_id integer
name string
organization string
organization_id integer
origin string
reported_at datetime
short_name string
type string
value string2.35.12. hammer host info
Show a host
Usage:
hammer host <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------------------------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------------------------------------|-----|---------|-----
Id | x | x | x
UUID | x | x |
Name | x | x | x
Organization | x | x |
Location | x | x |
Host Group | x | x |
Compute Resource | x | x |
Compute Profile | x | x |
Puppet Environment | x | x |
Puppet CA Proxy | x | x |
Puppet Master Proxy | x | x |
Cert name | x | x |
Managed | x | x |
Installed at | x | x |
Last report | x | x |
Uptime (seconds) | x | x |
Status/Global Status | x | x |
Status/Build Status | x | x |
Network/IPv4 address | x | x |
Network/IPv6 address | x | x |
Network/MAC | x | x |
Network/Subnet ipv4 | x | x |
Network/Subnet ipv6 | x | x |
Network/Domain | x | x |
Network/Service provider/SP Name | x | x |
Network/Service provider/SP IP | x | x |
Network/Service provider/SP MAC | x | x |
Network/Service provider/SP Subnet | x | x |
Network interfaces/Id | x | x |
Network interfaces/Identifier | x | x |
Network interfaces/Type | x | x |
Network interfaces/MAC address | x | x |
Network interfaces/IPv4 address | x | x |
Network interfaces/IPv6 address | x | x |
Network interfaces/FQDN | x | x |
Operating system/Architecture | x | x |
Operating system/Operating System | x | x |
Operating system/Build | x | x |
Operating system/Medium | x | x |
Operating system/Partition Table | x | x |
Operating system/PXE Loader | x | x |
Operating system/Custom partition table | x | x |
Operating system/Image | x | x |
Operating system/Image file | x | x |
Operating system/Use image | x | x |
Parameters/ | x | x |
All parameters/ | x | x |
Additional info/Owner | x | x |
Additional info/Owner Id | x | x |
Additional info/Owner Type | x | x |
Additional info/Enabled | x | x |
Additional info/Model | x | x |
Additional info/Comment | x | x |
OpenSCAP Proxy | x | x |
Content Information/Content View/ID | x | x |
Content Information/Content View/Name | x | x |
Content Information/Lifecycle Environment/ID | x | x |
Content Information/Lifecycle Environment/Name | x | x |
Content Information/Content Source/ID | x | x |
Content Information/Content Source/Name | x | x |
Content Information/Kickstart Repository/ID | x | x |
Content Information/Kickstart Repository/Name | x | x |
Content Information/Applicable Packages | x | x |
Content Information/Upgradable Packages | x | x |
Content Information/Applicable Errata/Enhancement | x | x |
Content Information/Applicable Errata/Bug Fix | x | x |
Content Information/Applicable Errata/Security | x | x |
Subscription Information/UUID | x | x |
Subscription Information/Last Checkin | x | x |
Subscription Information/Release Version | x | x |
Subscription Information/Autoheal | x | x |
Subscription Information/Registered To | x | x |
Subscription Information/Registered At | x | x |
Subscription Information/Registered by Activation Keys/ | x | x |
Subscription Information/System Purpose/Service Level | x | x |
Subscription Information/System Purpose/Purpose Usage | x | x |
Subscription Information/System Purpose/Purpose Role | x | x |
Subscription Information/System Purpose/Purpose Addons | x | x |
Trace Status | x | x |
Host Collections/Id | x | x |
Host Collections/Name | x | x |
--------------------------------------------------------|-----|---------|-----2.35.13. hammer host interface
View and manage host’s network interfaces
Usage:
hammer host interface [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an interface on a host
delete, destroy Delete a host's interface
info, show Show an interface for host
list, index List all interfaces for host
update Update a host's interface
Options:
-h, --help Print help2.35.13.1. hammer host interface create
Create an interface on a host
Usage:
hammer host interface create [OPTIONS]
Options:
--attached-devices ATTACHED_DEVICES Identifiers of attached interfaces, e.g. `['eth1',
'eth2']`. For bond interfaces those are the slaves. Only for bond
And bridges interfaces.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--attached-to ATTACHED_TO Identifier of the interface to which this interface belongs, e.g. eth1.
Only for virtual interfaces.
--bond-options BOND_OPTIONS Space separated options, e.g. miimon=100. Only for bond interfaces.
--compute-attributes COMPUTE_ATTRS Compute resource specific attributes
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Satellite domain ID of interface. Required for primary interfaces on
Managed hosts.
--execution EXECUTION Should this interface be used for remote execution?
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--identifier IDENTIFIER Device identifier, e.g. eth0 or eth1.1
--ip IP IPv4 address of interface
--ip6 IP6 IPv6 address of interface
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mac MAC MAC address of interface. Required for managed interfaces on bare metal.
--managed MANAGED Should this interface be managed via DHCP and DNS capsule and should it be
Configured during provisioning?
One of true/false, yes/no, 1/0.
--mode MODE Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.
Possible value(s): 'balance-rr', 'active-backup', 'balance-xor', 'broadcast', '802.3ad', 'balance-tlb', 'balance-alb'
--mtu MTU MTU, this attribute has precedence over the subnet MTU.
--name NAME Interface's DNS name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--password PASSWORD Only for BMC interfaces.
--primary Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface
--provider PROVIDER Interface provider, e.g. IPMI. Only for BMC interfaces.
Possible value(s): 'IPMI', 'SSH'
--provision Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Satellite subnet ID of IPv4 interface
--subnet6-id SUBNET6_ID Satellite subnet ID of IPv6 interface
--tag TAG VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for
Virtual interfaces.
--type TYPE Interface type, e.g. bmc. Default is interface
Possible value(s): 'interface', 'bmc', 'bond', 'bridge'
--username USERNAME Only for BMC interfaces.
--virtual VIRTUAL Alias or VLAN device
One of true/false, yes/no, 1/0.
-h, --help Print help2.35.13.2. hammer host interface delete
Delete a host’s interface
Usage:
hammer host interface <delete|destroy> [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--id ID ID of interface
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.13.3. hammer host interface info
Show an interface for host
Usage:
hammer host interface <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--id ID ID or name of interface
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
Id | x | x | x
Identifier | x | x |
Type | x | x |
MAC address | x | x |
IP address | x | x |
DNS name | x | x |
Subnet | x | x |
Domain | x | x |
Managed | x | x |
Primary | x | x |
Provision | x | x |
Virtual | x | x |
Tag | x | x |
Attached to | x | x |
BMC/Username | x | x |
BMC/Provider | x | x |
Bond/Mode | x | x |
Bond/Attached devices | x | x |
Bond/Bond options | x | x |
Execution | x | x |
----------------------|-----|---------|-----2.35.13.4. hammer host interface list
List all interfaces for host
Usage:
hammer host interface <list|index> [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID ID or name of domain
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID ID or name of subnet
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Identifier | x | x |
Type | x | x |
MAC address | x | x |
IP address | x | x |
DNS name | x | x |
------------|-----|---------|-----2.35.13.5. hammer host interface update
Update a host’s interface
Usage:
hammer host interface update [OPTIONS]
Options:
--attached-devices ATTACHED_DEVICES Identifiers of attached interfaces, e.g. `['eth1',
'eth2']`. For bond interfaces those are the slaves. Only for bond
And bridges interfaces.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--attached-to ATTACHED_TO Identifier of the interface to which this interface belongs, e.g. eth1.
Only for virtual interfaces.
--bond-options BOND_OPTIONS Space separated options, e.g. miimon=100. Only for bond interfaces.
--compute-attributes COMPUTE_ATTRS Compute resource specific attributes
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Satellite domain ID of interface. Required for primary interfaces on
Managed hosts.
--execution EXECUTION Should this interface be used for remote execution?
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID ID or name of host
--id ID ID of interface
--identifier IDENTIFIER Device identifier, e.g. eth0 or eth1.1
--ip IP IPv4 address of interface
--ip6 IP6 IPv6 address of interface
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mac MAC MAC address of interface. Required for managed interfaces on bare metal.
--managed MANAGED Should this interface be managed via DHCP and DNS capsule and should it be
Configured during provisioning?
One of true/false, yes/no, 1/0.
--mode MODE Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.
Possible value(s): 'balance-rr', 'active-backup', 'balance-xor', 'broadcast', '802.3ad', 'balance-tlb', 'balance-alb'
--mtu MTU MTU, this attribute has precedence over the subnet MTU.
--name NAME Interface's DNS name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--password PASSWORD Only for BMC interfaces.
--primary Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface
--provider PROVIDER Interface provider, e.g. IPMI. Only for BMC interfaces.
Possible value(s): 'IPMI', 'SSH'
--provision Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Satellite subnet ID of IPv4 interface
--subnet6-id SUBNET6_ID Satellite subnet ID of IPv6 interface
--tag TAG VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for
Virtual interfaces.
--type TYPE Interface type, e.g. bmc. Default is interface
Possible value(s): 'interface', 'bmc', 'bond', 'bridge'
--username USERNAME Only for BMC interfaces.
--virtual VIRTUAL Alias or VLAN device
One of true/false, yes/no, 1/0.
-h, --help Print help2.35.14. hammer host list
List all hosts
Usage:
hammer host <list|index> [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID ID of location
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID ID of organization
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
--thin THIN Only list ID and name of hosts
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
-----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating System | x | x |
Host Group | x | x |
IP | x | x |
MAC | x | x |
Global Status | x | x |
Organization | x | |
Location | x | |
Additional Information | x | |
Content View | x | x |
Lifecycle Environment | x | x |
Security | x | |
Bugfix | x | |
Enhancement | x | |
Trace Status | x | x |
-----------------------|-----|---------|-----
Search / Order fields:
activation_key string
activation_key_id string
addon string
addons_status Values: mismatched, matched, not_specified
ansible_role string
applicable_errata string
applicable_errata_issued date
applicable_rpms string
architecture string
autoheal boolean
boot_time
build Values: true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
created_at datetime
domain string
domain_id integer
environment string
errata_status Values: security_needed, errata_needed, updated, unknown
execution_status Values: ok, error
facts string
global_status Values: ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
id integer
image string
insights_recommendations_count integer
installable_errata string
installed_at datetime
ip string
job_invocation.id string
job_invocation.result Values: cancelled, failed, pending, success
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed Values: true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
params_name string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status Values: mismatched, matched, not_specified
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
role text
role_status Values: mismatched, matched, not_specified
service_level string
sla_status Values: mismatched, matched, not_specified
smart_proxy string
status.applied integer
status.enabled Values: true, false
status.failed integer
status.failed_restarts integer
status.interesting Values: true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status Values: valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor
subscription_uuid string
trace_status Values: reboot_needed, process_restart_needed, updated
upgradable_rpms string
usage text
usage_status Values: mismatched, matched, not_specified
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string2.35.15. hammer host package
Manage packages on your hosts
Usage:
hammer host package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
install Install packages remotely
list, index List packages installed on the host
remove Uninstall packages remotely
upgrade Update packages remotely
upgrade-all Update packages remotely
Options:
-h, --help Print help2.35.15.1. hammer host package install
Install packages remotely
Usage:
hammer host package install [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--packages PACKAGES List of package names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.35.15.2. hammer host package list
List packages installed on the host
Usage:
hammer host package <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--order ORDER Sort field and order, eg. 'id DESC'
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|--------
FIELDS | ALL | DEFAULT
-------|-----|--------
NVRA | x | x
-------|-----|--------
Search / Order fields:
arch string
epoch string
name string
nvra string
nvrea string
release string
version string2.35.15.3. hammer host package remove
Uninstall packages remotely
Usage:
hammer host package remove [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--packages PACKAGES List of package names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.35.15.4. hammer host package upgrade
Update packages remotely
Usage:
hammer host package upgrade [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--packages PACKAGES List of packages names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.35.15.5. hammer host package upgrade-all
Update packages remotely
Usage:
hammer host package upgrade-all [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
-h, --help Print help2.35.16. hammer host package-group
Manage package-groups on your hosts
Usage:
hammer host package-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
install Install packages remotely
remove Uninstall packages remotely
Options:
-h, --help Print help2.35.16.1. hammer host package-group install
Install packages remotely
Usage:
hammer host package-group install [OPTIONS]
Options:
--async Do not wait for the task
--groups GROUPS List of package group names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
-h, --help Print help2.35.16.2. hammer host package-group remove
Uninstall packages remotely
Usage:
hammer host package-group remove [OPTIONS]
Options:
--async Do not wait for the task
--groups GROUPS List of package group names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
-h, --help Print help2.35.17. hammer host policies-enc
View policies ENC for host
Usage:
hammer host policies-enc [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID The identifier of the host
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------|-----|--------
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
------------------------|-----|--------2.35.18. hammer host puppet-classes
List all Puppet classes
Usage:
hammer host puppet-classes [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID of host
--location-id LOCATION_ID Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization-id ORGANIZATION_ID Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
config_group string
environment string
host string
hostgroup string
key string
location string
name string
organization string2.35.19. hammer host puppetrun
Force a Puppet agent run on the host
Usage:
hammer host puppetrun [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.20. hammer host reboot
Reboot a host
Usage:
hammer host reboot [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.21. hammer host rebuild-config
Rebuild orchestration related configurations for host
Usage:
hammer host rebuild-config [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--only ONLY Limit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,
Content_Host_Status
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.22. hammer host reports
List all reports
Usage:
hammer host reports [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Host id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Last report | x | x |
Applied | x | x |
Restarted | x | x |
Failed | x | x |
Restart Failures | x | x |
Skipped | x | x |
Pending | x | x |
-----------------|-----|---------|-----
Search / Order fields:
applied integer
environment string
eventful Values: true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer2.35.23. hammer host reset
Reset a host
Usage:
hammer host reset [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.24. hammer host sc-params
List all smart class parameters
Usage:
hammer host sc-params [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
Puppet class | x | x
Class Id | x | x
--------------|-----|--------
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string2.35.25. hammer host set-parameter
Create or append a parameter for a host
Usage:
hammer host set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.35.26. hammer host start
Power a host on
Usage:
hammer host start [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.27. hammer host status
Get status of host
Usage:
hammer host status [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--type TYPE Status type, can be one of
Global
Configuration
Build
Possible value(s): 'HostStatus::Global', 'configuration', 'build'
-h, --help Print help2.35.28. hammer host stop
Power a host off
Usage:
hammer host stop [OPTIONS]
Options:
--force Force turning off a host
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Host name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.35.29. hammer host subscription
Manage subscription information on your hosts
Usage:
hammer host subscription [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
attach Add a subscription to a host
auto-attach Trigger an auto-attach of subscriptions
content-override Override product content defaults
product-content List associated products
register Register a host with subscription and information
remove
unregister Unregister the host as a subscription consumer
Options:
-h, --help Print help2.35.29.1. hammer host subscription attach
Add a subscription to a host
Usage:
hammer host subscription attach [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID Id of the host
--quantity Quantity Quantity of this subscriptions to add. Defaults to 1
--subscription-id SUBSCRIPTION_ID ID of subscription
-h, --help Print help2.35.29.2. hammer host subscription auto-attach
Trigger an auto-attach of subscriptions
Usage:
hammer host subscription auto-attach [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID Id of the host
-h, --help Print help2.35.29.3. hammer host subscription content-override
Override product content defaults
Usage:
hammer host subscription content-override [OPTIONS]
Options:
--content-label CONTENT_LABEL Label of the content
--host HOST_NAME Host name
--host-id HOST_ID Id of the content host
--override-name OVERRIDE_NAME Override parameter key or name.
To enable or disable a repo select 'enabled'.
Default value: enabled
Default: "enabled"
--remove Remove a content override
--value VALUE Override value. Note for repo enablement you can use a boolean value
-h, --help Print help2.35.29.4. hammer host subscription product-content
List associated products
Usage:
hammer host subscription product-content [OPTIONS]
Options:
--content-access-mode-all CONTENT_ACCESS_MODE_ALL Get all content available, not just that provided by subscriptions
One of true/false, yes/no, 1/0.
--content-access-mode-env CONTENT_ACCESS_MODE_ENV Limit content to just that available in the host's content view version
One of true/false, yes/no, 1/0.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID Id of the host
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Type | x | x |
URL | x | x |
GPG Key | x | x |
Label | x | x |
Default Enabled? | x | x |
Override | x | x |
-----------------|-----|---------|-----2.35.29.5. hammer host subscription register
Register a host with subscription and information
Usage:
hammer host subscription register [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content View ID
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS UUIDs of the virtual guests from the host's hypervisor
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID Lifecycle Environment ID
--name NAME Name of the host
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--release-version RELEASE_VERSION Release version of the content host
--service-level SERVICE_LEVEL A service level for auto-healing process, e.g. SELF-SUPPORT
--uuid UUID UUID to use for registered host, random uuid is generated if not provided
-h, --help Print help2.35.29.6. hammer host subscription remove
Usage:
hammer host subscription remove [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID Id of the host
--quantity Quantity Remove the first instance of a subscription with matching id and quantity
--subscription-id SUBSCRIPTION_ID ID of subscription
-h, --help Print help2.35.29.7. hammer host subscription unregister
Unregister the host as a subscription consumer
Usage:
hammer host subscription unregister [OPTIONS]
Options:
--host HOST_NAME Host name
--host-id HOST_ID Id of the host
-h, --help Print help2.35.30. hammer host traces
List traces on your hosts
Usage:
hammer host traces [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
list List services that need restarting on the host
resolve Resolve Traces
Options:
-h, --help Print help2.35.30.1. hammer host traces list
List services that need restarting on the host
Usage:
hammer host traces list [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
-h, --help Print help
Predefined field sets:
------------|-----|--------
FIELDS | ALL | DEFAULT
------------|-----|--------
Trace ID | x | x
Application | x | x
Helper | x | x
Type | x | x
------------|-----|--------2.35.30.2. hammer host traces resolve
Resolve Traces
Usage:
hammer host traces resolve [OPTIONS]
Options:
--async Do not wait for the task
--host HOST_NAME Host name
--host-id HOST_ID ID of the host
--trace-ids TRACE_IDS Array of Trace IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.35.31. hammer host update
Update a host
Usage:
hammer host update [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS IDs of associated ansible roles
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID Required if host is managed and value is not inherited from host group
--ask-root-password ASK_ROOT_PW One of true/false, yes/no, 1/0.
--autoheal AUTOHEAL Sets whether the Host will autoheal subscriptions upon checkin
One of true/false, yes/no, 1/0.
--build BUILD One of true/false, yes/no, 1/0.
--comment COMMENT Additional information about this host
--compute-attributes COMPUTE_ATTRS Compute resource attributes
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID Nil means host is bare metal
--config-group-ids CONFIG_GROUP_IDS IDs of associated config groups
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--config-groups CONFIG_GROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--content-source CONTENT_SOURCE_NAME Content Source name
--content-source-id CONTENT_SOURCE_ID
--content-view CONTENT_VIEW_NAME Name to search by
--content-view-id CONTENT_VIEW_ID
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Required if host is managed and value is not inherited from host group
--enabled ENABLED Include this host within Satellite reporting
One of true/false, yes/no, 1/0.
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS List of hypervisor guest uuids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--image IMAGE_NAME Name to search by
--image-id IMAGE_ID
--installed-products-attributes INSTALLED_PRODUCTS_ATTRIBUTES List of products installed on the host
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--interface INTERFACE Interface parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
--ip IP Not required if using a subnet with DHCP Capsule
--kickstart-repository REPOSITORY_NAME Kickstart repository name
--kickstart-repository-id KICKSTART_REPOSITORY_ID Repository Id associated with the kickstart repo used for provisioning
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mac MAC Required for managed host that is bare metal, not required if it's a
Virtual machine
--managed MANAGED True/False flag whether a host is managed or unmanaged. Note: this value
Also determines whether several parameters are required or not
One of true/false, yes/no, 1/0.
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID Required if not imaged based provisioning and host is managed and value is
Not inherited from host group
--model MODEL_NAME Model name
--model-id MODEL_ID
--name NAME Host name
--new-location NEW_LOCATION_NAME Use to update
--new-location-id NEW_LOCATION_ID Use to update
--new-location-title NEW_LOCATION_TITLE Use to update
--new-name NEW_NAME
--new-organization NEW_ORGANIZATION_NAME Use to update
--new-organization-id NEW_ORGANIZATION_ID Use to update
--new-organization-title NEW_ORGANIZATION_TITLE Use to update
--openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID Required if host is managed and value is not inherited from host group
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--overwrite OVERWRITE One of true/false, yes/no, 1/0.
--owner OWNER_LOGIN Login of the owner
--owner-id OWNER_ID ID of the owner
--owner-type OWNER_TYPE Host's owner type
Possible value(s): 'User', 'Usergroup'
--parameters PARAMS Replaces with new host parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--product PRODUCT_NAME Name to search by
--product-id PRODUCT_ID Product id as listed from a host's installed products, this is
Not the same product id as the products api returns
--progress-report-id PROGRESS_REPORT_ID UUID to track orchestration tasks status, GET
/api/orchestration/:UUID/tasks
--provision-method PROVISION_METHOD The method used to provision the host.
Possible value(s): 'build', 'image', 'bootdisk'
--puppet-ca-proxy PUPPET_CA_PROXY_NAME
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID
--puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--puppet-proxy PUPPET_PROXY_NAME
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID
--purpose-addons PURPOSE_ADDONS Sets the system add-ons
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--purpose-role PURPOSE_ROLE Sets the system purpose usage
--purpose-usage PURPOSE_USAGE Sets the system purpose usage
--pxe-loader PXE_LOADER DHCP filename option (Grub2/PXELinux by default)
Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
--realm REALM_NAME Name to search by
--realm-id REALM_ID
--release-version RELEASE_VERSION Release version for this Host to use (7Server, 7.1, etc)
--root-password ROOT_PW Required if host is managed and value is not inherited from host group or default password in settings
--service-level SERVICE_LEVEL Service level to be used for autoheal
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Required if host is managed and value is not inherited from host group
--typed-parameters TYPED_PARAMS Replaces with new host parameters (with type support)
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--volume VOLUME Volume parameters
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
Can be specified multiple times.
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--typed-parameters "name=<string>\,value=<string>\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\,hidden_value=[true|false|1|0], ... "
--installed-products-attributes "product_id=<string>\,product_name=<string>\,arch=<string>\,version=<string>, ... "
Available keys for --interface:
mac
ip
type Possible values: interface, bmc, bond, bridge
name
subnet_id
domain_id
identifier
managed true/false
primary true/false, each managed hosts needs to have one primary interface.
provision true/false
virtual true/false
For virtual=true:
tag VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.
attached_to Identifier of the interface to which this interface belongs, e.g. eth1.
For type=bond:
mode Possible values: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb
attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2]
bond_options
For type=bmc:
provider always IPMI
username
password
Provider specific options:
NOTE: Bold attributes are required.
EC2:
--volume:
--interface:
--compute-attributes:
availability_zone
flavor_id
groups
security_group_ids
managed_ip
GCE:
--volume:
size_gb Volume size in GB, integer value
--interface:
--compute-attributes:
machine_type
network
associate_external_ip
Libvirt:
--volume:
pool_name One of available storage pools
capacity String value, e.g. 10G
allocation
Initial allocation, e.g. 0G
format_type Possible values: raw, qcow2
--interface:
compute_type Possible values: bridge, network
compute_bridge Name of interface according to type
compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000
compute_network
Libvirt instance network, e.g. default
--compute-attributes:
cpus Number of CPUs
memory String, amount of memory, value in bytes
cpu_mode Possible values: default, host-model, host-passthrough
start Boolean (expressed as 0 or 1), whether to start the machine or not
OpenStack:
--volume:
--interface:
--compute-attributes:
availability_zone
boot_from_volume
flavor_ref
image_ref
tenant_id
security_groups
network
oVirt:
--volume:
size_gb Volume size in GB, integer value
storage_domain ID or name of storage domain
bootable Boolean, set 1 for bootable, only one volume can be bootable
preallocate Boolean, set 1 to preallocate
wipe_after_delete Boolean, set 1 to wipe disk after delete
interface Disk interface name, must be ide, virto or virto_scsi
--interface:
compute_name Compute name, e.g. eth0
compute_network Select one of available networks for a cluster, must be an ID or a name
compute_interface Interface type
--compute-attributes:
cluster ID or name of cluster to use
template Hardware profile to use
cores Integer value, number of cores
sockets Integer value, number of sockets
memory Amount of memory, integer value in bytes
ha Boolean, set 1 to high availability
display_type Possible values: VNC, SPICE
keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE.
start Boolean, set 1 to start the vm
Rackspace:
--volume:
--interface:
--compute-attributes:
flavor_id
VMware:
--volume:
name
storage_pod Storage Pod ID from VMware
datastore Datastore ID from VMware
mode persistent/independent_persistent/independent_nonpersistent
size_gb Integer number, volume size in GB
thin true/false
eager_zero true/false
controller_key Associated SCSI controller key
--interface:
compute_type Type of the network adapter, for example one of:
VirtualVmxnet3
VirtualE1000
See documentation center for your version of vSphere to find more details about available adapter types:
https://www.vmware.com/support/pubs/
compute_network Network ID or Network Name from VMware
--compute-attributes:
cluster Cluster ID from VMware
corespersocket Number of cores per socket (applicable to hardware versions < 10 only)
cpus CPU count
memory_mb Integer number, amount of memory in MB
path Path to folder
resource_pool Resource Pool ID from VMware
firmware automatic/bios/efi
guest_id Guest OS ID form VMware
hardware_version Hardware version ID from VMware
memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on
cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on
add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
annotation Annotation Notes
scsi_controllers List with SCSI controllers definitions
type - ID of the controller from VMware
key - Key of the controller (e.g. 1000)
start Must be a 1 or 0, whether to start the machine or not
AzureRM:
--volume:
disk_size_gb Volume Size in GB (integer value)
data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)
--interface:
compute_network Select one of available Azure Subnets, must be an ID
compute_public_ip Public IP (None, Static, Dynamic)
compute_private_ip Static Private IP (expressed as true or false)
--compute-attributes:
resource_group Existing Azure Resource Group of user
vm_size VM Size, eg. Standard_A0 etc.
username The Admin username
password The Admin password
platform OS type eg. Linux
ssh_key_data SSH key for passwordless authentication
os_disk_caching OS disk caching
premium_os_disk Premium OS Disk, Boolean as 0 or 1
script_command Custom Script Command
script_uris Comma seperated file URIs2.36. hammer host-collection
Manipulate host collections
Usage:
hammer host-collection [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-host Add host to the host collection
copy Copy a host collection
create Create a host collection
delete, destroy Destroy a host collection
erratum Manipulate errata for a host collection
hosts List all hosts
info, show Show a host collection
list, index List host collections
package Manipulate packages for a host collection
package-group Manipulate package-groups for a host collection
remove-host Remove hosts from the host collection
update Update a host collection
Options:
-h, --help Print help2.36.1. hammer host-collection add-host
Add host to the host collection
Usage:
hammer host-collection add-host [OPTIONS]
Options:
--host-ids HOST_IDS Array of host ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.36.2. hammer host-collection copy
Copy a host collection
Usage:
hammer host-collection copy [OPTIONS]
Options:
--id ID ID of the host collection
--name NAME Host collection name to search by
--new-name NEW_NAME New host collection name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.36.3. hammer host-collection create
Create a host collection
Usage:
hammer host-collection create [OPTIONS]
Options:
--description DESCRIPTION
--host-ids HOST_IDS List of host ids to replace the hosts in host collection
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--max-hosts MAX_HOSTS Maximum number of hosts in the host collection
--name NAME Host Collection name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--unlimited-hosts UNLIMITED_HOSTS Whether or not the host collection may have unlimited hosts
One of true/false, yes/no, 1/0.
-h, --help Print help2.36.4. hammer host-collection delete
Destroy a host collection
Usage:
hammer host-collection <delete|destroy> [OPTIONS]
Options:
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.36.5. hammer host-collection erratum
Manipulate errata for a host collection
Usage:
hammer host-collection erratum [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
install Install errata on content hosts contained within a host collection
Options:
-h, --help Print help2.36.5.1. hammer host-collection erratum install
Install errata on content hosts contained within a host collection
Usage:
hammer host-collection erratum install [OPTIONS]
Options:
--errata ERRATA List of Errata to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.36.6. hammer host-collection hosts
List all hosts
Usage:
hammer host-collection hosts [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id HOST_COLLECTION_ID Host Collection ID
--include INCLUDE Array of extra information types to include
Possible value(s): 'parameters', 'all_parameters'
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID ID of location
--location-title LOCATION_TITLE Set the current location context for the request
--name HOST_COLLECTION_NAME Host Collection Name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID ID of organization
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--thin THIN Only list ID and name of hosts
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Security | x | |
Bugfix | x | |
Enhancement | x | |
------------|-----|---------|-----
Search / Order fields:
activation_key string
activation_key_id string
addon string
addons_status Values: mismatched, matched, not_specified
ansible_role string
applicable_errata string
applicable_errata_issued date
applicable_rpms string
architecture string
autoheal boolean
boot_time
build Values: true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
created_at datetime
domain string
domain_id integer
environment string
errata_status Values: security_needed, errata_needed, updated, unknown
execution_status Values: ok, error
facts string
global_status Values: ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
id integer
image string
insights_recommendations_count integer
installable_errata string
installed_at datetime
ip string
job_invocation.id string
job_invocation.result Values: cancelled, failed, pending, success
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed Values: true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
params_name string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status Values: mismatched, matched, not_specified
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
role text
role_status Values: mismatched, matched, not_specified
service_level string
sla_status Values: mismatched, matched, not_specified
smart_proxy string
status.applied integer
status.enabled Values: true, false
status.failed integer
status.failed_restarts integer
status.interesting Values: true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status Values: valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor
subscription_uuid string
trace_status Values: reboot_needed, process_restart_needed, updated
upgradable_rpms string
usage text
usage_status Values: mismatched, matched, not_specified
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string2.36.7. hammer host-collection info
Show a host collection
Usage:
hammer host-collection <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Limit | x | x |
Description | x | x |
Total Hosts | x | x |
------------|-----|---------|-----2.36.8. hammer host-collection list
List host collections
Usage:
hammer host-collection <list|index> [OPTIONS]
Options:
--activation-key ACTIVATION_KEY_NAME Activation key name to search by
--activation-key-id ACTIVATION_KEY_ID Activation key identifier
--available-for AVAILABLE_FOR Interpret specified object to return only Host Collections that can be
Associated with specified object. The value 'host' is supported.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID Filter products by host id
--name NAME Host collection name to filter by
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Limit | x | x |
Description | x | x |
------------|-----|---------|-----
Search / Order fields:
host string
name string
organization_id integer2.36.9. hammer host-collection package
Manipulate packages for a host collection
Usage:
hammer host-collection package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
install Install packages on content hosts contained within a host collection
remove Remove packages on content hosts contained within a host collection
update Update packages on content hosts contained within a host collection
Options:
-h, --help Print help2.36.9.1. hammer host-collection package install
Install packages on content hosts contained within a host collection
Usage:
hammer host-collection package install [OPTIONS]
Options:
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--packages PACKAGES Comma-separated list of packages to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.36.9.2. hammer host-collection package remove
Remove packages on content hosts contained within a host collection
Usage:
hammer host-collection package remove [OPTIONS]
Options:
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--packages PACKAGES Comma-separated list of packages to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.36.9.3. hammer host-collection package update
Update packages on content hosts contained within a host collection
Usage:
hammer host-collection package update [OPTIONS]
Options:
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--packages PACKAGES Comma-separated list of packages to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.36.10. hammer host-collection package-group
Manipulate package-groups for a host collection
Usage:
hammer host-collection package-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
install Install package-groups on content hosts contained within a host collection
remove Remove package-groups on content hosts contained within a host collection
update Update package-groups on content hosts contained within a host collection
Options:
-h, --help Print help2.36.10.1. hammer host-collection package-group install
Install package-groups on content hosts contained within a host collection
Usage:
hammer host-collection package-group install [OPTIONS]
Options:
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--package-groups PACKAGE-GROUPS Comma-separated list of package-groups to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.36.10.2. hammer host-collection package-group remove
Remove package-groups on content hosts contained within a host collection
Usage:
hammer host-collection package-group remove [OPTIONS]
Options:
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--package-groups PACKAGE-GROUPS Comma-separated list of package-groups to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.36.10.3. hammer host-collection package-group update
Update package-groups on content hosts contained within a host collection
Usage:
hammer host-collection package-group update [OPTIONS]
Options:
--id HOST_COLLECTION_ID Host Collection ID
--name HOST_COLLECTION_NAME Host Collection Name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--package-groups PACKAGE-GROUPS Comma-separated list of package-groups to install
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.36.11. hammer host-collection remove-host
Remove hosts from the host collection
Usage:
hammer host-collection remove-host [OPTIONS]
Options:
--host-ids HOST_IDS Array of host ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.36.12. hammer host-collection update
Update a host collection
Usage:
hammer host-collection update [OPTIONS]
Options:
--description DESCRIPTION
--host-ids HOST_IDS List of host ids to replace the hosts in host collection
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the host collection
--max-hosts MAX_HOSTS Maximum number of hosts in the host collection
--name NAME Host collection name to search by
--new-name NEW_NAME Host Collection name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--unlimited-hosts UNLIMITED_HOSTS Whether or not the host collection may have unlimited hosts
One of true/false, yes/no, 1/0.
-h, --help Print help2.37. hammer hostgroup
Manipulate hostgroups
Usage:
hammer hostgroup [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
ansible-roles Manage Ansible roles on a hostgroup
create Create a host group
delete, destroy Delete a host group
delete-parameter Delete parameter for a hostgroup
info, show Show a host group
list, index List all host groups
puppet-classes List all Puppet classes
rebuild-config Rebuild orchestration config
sc-params List all smart class parameters
set-parameter Create or update parameter for a hostgroup
update Update a host group
Options:
-h, --help Print help2.37.1. hammer hostgroup ansible-roles
Manage Ansible roles on a hostgroup
Usage:
hammer hostgroup ansible-roles [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
assign Assigns Ansible roles to a hostgroup
list, index List all Ansible roles for a hostgroup
play Runs all Ansible roles on a hostgroup
Options:
-h, --help Print help2.37.1.1. hammer hostgroup ansible-roles assign
Assigns Ansible roles to a hostgroup
Usage:
hammer hostgroup ansible-roles assign [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS Ansible roles to assign to a hostgroup
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Hostgroup name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Hostgroup title
-h, --help Print help2.37.1.2. hammer hostgroup ansible-roles list
List all Ansible roles for a hostgroup
Usage:
hammer hostgroup ansible-roles <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Hostgroup name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Hostgroup title
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Imported at | x | x |
------------|-----|---------|-----2.37.1.3. hammer hostgroup ansible-roles play
Runs all Ansible roles on a hostgroup
Usage:
hammer hostgroup ansible-roles play [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Hostgroup name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Hostgroup title
-h, --help Print help2.37.2. hammer hostgroup create
Create a host group
Usage:
hammer hostgroup create [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS IDs of associated ansible roles
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID Architecture ID
--ask-root-password, --ask-root-pass ASK_ROOT_PW (--ask-root-pass is deprecated: Use --ask-root-password instead)
One of true/false, yes/no, 1/0.
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID Compute profile ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID Compute resource ID
--config-group-ids CONFIG_GROUP_IDS IDs of associated config groups
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--config-groups CONFIG_GROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--content-source CONTENT_SOURCE_NAME Content Source name
--content-source-id CONTENT_SOURCE_ID Content source ID
--content-view CONTENT_VIEW_NAME Name to search by
--content-view-id CONTENT_VIEW_ID Content view ID
--description DESCRIPTION Host group description
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Domain ID
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of parameters
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--kickstart-repository REPOSITORY_NAME Kickstart repository name
--kickstart-repository-id KICKSTART_REPOSITORY_ID Kickstart repository ID
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID Lifecycle environment ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID Media ID
--name NAME Name of the host group
--openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID Operating system ID
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--parent PARENT_NAME Name of parent hostgroup
--parent-id PARENT_ID Parent ID of the host group
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--puppet-ca-proxy PUPPET_CA_PROXY_NAME Name of puppet CA proxy
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID
--puppet-class-ids PUPPETCLASS_IDS List of puppetclass ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--puppet-proxy PUPPET_PROXY_NAME Name of puppet proxy
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID
--pxe-loader PXE_LOADER DHCP filename option (Grub2/PXELinux by default)
Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
--query-organization ORGANIZATION_NAME Organization name to search by
--query-organization-id ORGANIZATION_ID Organization ID to search by
--query-organization-label ORGANIZATION_LABEL Organization label to search by
--realm REALM_NAME Name to search by
--realm-id REALM_ID Realm ID
--root-password, --root-pass ROOT_PASSWORD Root password (--root-pass is deprecated: Use --root-password instead)
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Subnet ID
--subnet6 SUBNET6_NAME Subnet IPv6 name
--subnet6-id SUBNET6_ID Subnet IPv6 ID
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain 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], ... "2.37.3. hammer hostgroup delete
Delete a host group
Usage:
hammer hostgroup <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Hostgroup name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Hostgroup title
-h, --help Print help2.37.4. hammer hostgroup delete-parameter
Delete parameter for a hostgroup
Usage:
hammer hostgroup delete-parameter [OPTIONS]
Options:
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--name NAME Parameter name
-h, --help Print help2.37.5. hammer hostgroup info
Show a host group
Usage:
hammer hostgroup <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Hostgroup name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
--title TITLE Hostgroup title
-h, --help Print help
Predefined field sets:
----------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Title | x | x | x
Puppet Environment | x | x |
Model | x | x |
Description | x | x |
Parent | x | x |
Puppet CA Proxy | x | x |
Puppet Master Proxy | 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 |
Puppetclasses/ | 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 |
----------------------------------|-----|---------|-----2.37.6. hammer hostgroup list
List all host groups
Usage:
hammer hostgroup <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Title | x | x | x
Operating System | x | x |
Puppet Environment | x | x |
Model | x | x |
-------------------|-----|---------|-----
Search / Order fields:
architecture string
class string
config_group string
environment string
host string
id integer
label string
location string
location_id integer
medium string
name string
organization string
organization_id integer
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
params string
template string
title string2.37.7. hammer hostgroup puppet-classes
List all Puppet classes
Usage:
hammer hostgroup puppet-classes [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--location-id LOCATION_ID Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization-id ORGANIZATION_ID Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
config_group string
environment string
host string
hostgroup string
key string
location string
name string
organization string2.37.8. hammer hostgroup rebuild-config
Rebuild orchestration config
Usage:
hammer hostgroup rebuild-config [OPTIONS]
Options:
--children-hosts CHILDREN_HOSTS Operate on child hostgroup hosts
One of true/false, yes/no, 1/0.
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Hostgroup name
--only ONLY Limit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,
Content_Host_Status
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Hostgroup title
-h, --help Print help2.37.9. hammer hostgroup sc-params
List all smart class parameters
Usage:
hammer hostgroup sc-params [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
Puppet class | x | x
Class Id | x | x
--------------|-----|--------
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string2.37.10. hammer hostgroup set-parameter
Create or update parameter for a hostgroup
Usage:
hammer hostgroup set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.37.11. hammer hostgroup update
Update a host group
Usage:
hammer hostgroup update [OPTIONS]
Options:
--ansible-role-ids ANSIBLE_ROLE_IDS IDs of associated ansible roles
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ansible-roles ANSIBLE_ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID Architecture ID
--ask-root-password, --ask-root-pass ASK_ROOT_PW (--ask-root-pass is deprecated: Use --ask-root-password instead)
One of true/false, yes/no, 1/0.
--compute-profile COMPUTE_PROFILE_NAME Compute profile name
--compute-profile-id COMPUTE_PROFILE_ID Compute profile ID
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID Compute resource ID
--config-group-ids CONFIG_GROUP_IDS IDs of associated config groups
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--config-groups CONFIG_GROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--content-source CONTENT_SOURCE_NAME Content Source name
--content-source-id CONTENT_SOURCE_ID Content source ID
--content-view CONTENT_VIEW_NAME Name to search by
--content-view-id CONTENT_VIEW_ID Content view ID
--description DESCRIPTION Host group description
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Domain ID
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--group-parameters-attributes GROUP_PARAMETERS_ATTRIBUTES Array of parameters
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--id ID
--kickstart-repository REPOSITORY_NAME Kickstart repository name
--kickstart-repository-id KICKSTART_REPOSITORY_ID Kickstart repository ID
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID Lifecycle environment ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID Media ID
--name NAME Hostgroup name
--new-name NEW_NAME Name of the host group
--openscap-proxy-id OPENSCAP_PROXY_ID ID of OpenSCAP Capsule
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID Operating system ID
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--parent PARENT_NAME Name of parent hostgroup
--parent-id PARENT_ID Parent ID of the host group
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--puppet-ca-proxy PUPPET_CA_PROXY_NAME Name of puppet CA proxy
--puppet-ca-proxy-id PUPPET_CA_PROXY_ID Puppet CA Capsule ID
--puppet-class-ids PUPPETCLASS_IDS List of puppetclass ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-classes PUPPET_CLASS_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--puppet-proxy PUPPET_PROXY_NAME Name of puppet proxy
--puppet-proxy-id PUPPET_PROXY_ID Puppet Capsule ID
--pxe-loader PXE_LOADER DHCP filename option (Grub2/PXELinux by default)
Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
--query-organization ORGANIZATION_NAME Organization name to search by
--query-organization-id ORGANIZATION_ID Organization ID to search by
--query-organization-label ORGANIZATION_LABEL Organization label to search by
--realm REALM_NAME Name to search by
--realm-id REALM_ID Realm ID
--root-password, --root-pass ROOT_PASSWORD Root password (--root-pass is deprecated: Use --root-password instead)
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID Subnet ID
--subnet6 SUBNET6_NAME Subnet IPv6 name
--subnet6-id SUBNET6_ID Subnet IPv6 ID
--title TITLE Hostgroup title
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain 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], ... "2.38. hammer http-proxy
Manipulate http proxies
Usage:
hammer http-proxy [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an HTTP Proxy
delete, destroy Delete an HTTP Proxy
info, show Show an HTTP Proxy
list, index List of HTTP Proxies
update Update an HTTP Proxy
Options:
-h, --help Print help2.38.1. hammer http-proxy create
Create an HTTP Proxy
Usage:
hammer http-proxy create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME The HTTP Proxy name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--password PASSWORD Password used to authenticate with the HTTP Proxy
--url URL URL of the HTTP Proxy
--username USERNAME Username used to authenticate with the HTTP Proxy
-h, --help Print help2.38.2. hammer http-proxy delete
Delete an HTTP Proxy
Usage:
hammer http-proxy <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.38.3. hammer http-proxy info
Show an HTTP Proxy
Usage:
hammer http-proxy <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Identifier of the HTTP Proxy
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Username | x | x |
URL | x | x |
Locations/ | x | x |
Organizations/ | x | x |
---------------|-----|---------|-----2.38.4. hammer http-proxy list
List of HTTP Proxies
Usage:
hammer http-proxy <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer
url string2.38.5. hammer http-proxy update
Update an HTTP Proxy
Usage:
hammer http-proxy update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME The HTTP Proxy name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--password PASSWORD Password used to authenticate with the HTTP Proxy
--url URL URL of the HTTP Proxy
--username USERNAME Username used to authenticate with the HTTP Proxy
-h, --help Print help2.39. hammer import-templates
Import templates from a git repo or a directory on the server
Usage:
hammer import-templates [OPTIONS]
Options:
--associate ASSOCIATE Associate to OS's, Locations & Organizations. Options are: always,
New or never.
Possible value(s): 'always', 'new', 'never'
--branch BRANCH Branch in Git repo.
--dirname DIRNAME The directory within Git repo containing the templates
--filter FILTER Export templates with names matching this regex (case-insensitive; snippets
Are not filtered).
--force FORCE Update templates that are locked
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lock LOCK Lock imported templates
Possible value(s): 'lock', 'keep_lock_new', 'keep', 'unlock', 'true', 'false', '0', '1'
--negate NEGATE Negate the prefix (for purging).
One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--prefix PREFIX The string all imported templates should begin with.
--repo REPO Override the default repo from settings.
--verbose VERBOSE Show template diff in response
One of true/false, yes/no, 1/0.
-h, --help Print help2.40. hammer job-invocation
Manage job invocations
Usage:
hammer job-invocation [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
cancel Cancel the job
create Create a job invocation
info, show Show job invocation
list, index List job invocations
output View the output for a host
rerun Rerun the job
Options:
-h, --help Print help2.40.1. hammer job-invocation cancel
Cancel the job
Usage:
hammer job-invocation cancel [OPTIONS]
Options:
--force FORCE One of true/false, yes/no, 1/0.
--id ID
--location-id LOCATION_ID Set the current location context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help2.40.2. hammer job-invocation create
Create a job invocation
Usage:
hammer job-invocation create [OPTIONS]
Options:
--async Do not wait for the task
--bookmark BOOKMARK_NAME Name to search by
--bookmark-id BOOKMARK_ID
--concurrency-level CONCURRENCY_LEVEL Run at most N tasks at a time
--cron-line CRONLINE Create a recurring execution
Cron line format 'a b c d e', where:
a. is minute (range: 0-59)
b. is hour (range: 0-23)
c. is day of month (range: 1-31)
d. is month (range: 1-12)
e. is day of week (range: 0-6)
--description-format DESCRIPTION_FORMAT Override the description format from the template for this invocation only
--dynamic Dynamic search queries are evaluated at run time
--effective-user EFFECTIVE_USER What user should be used to run the script (using sudo-like mechanisms).
Defaults to a template parameter or global setting.
--end-time DATETIME Perform no more executions after this time, used with --cron-line
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
--execution-timeout-interval EXECUTION_TIMEOUT_INTERVAL Override the timeout interval from the template for this invocation only
--feature FEATURE Remote execution feature label that should be triggered, job template
Assigned to this feature will be used
--input-files INPUT FILES Read input values from files
Comma-separated list of key=file, where file is a path to a text file to be read
--inputs INPUTS Specify inputs from command line
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--job-template JOB_TEMPLATE_NAME Name to search by
--job-template-id JOB_TEMPLATE_ID The job template to use, parameter is required unless feature was specified
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--max-iteration MAX_ITERATION Repeat a maximum of N times
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--randomized-ordering RANDOMIZED_ORDERING Execute the jobs on hosts in randomized order
One of true/false, yes/no, 1/0.
--search-query SEARCH_QUERY
--start-at DATETIME Schedule the execution for a later time
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
--start-before DATETIME Execution should be cancelled if it cannot be started before --start-at
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
--time-span TIME_SPAN Distribute tasks over N seconds
-h, --help Print help2.40.3. hammer job-invocation info
Show job invocation
Usage:
hammer job-invocation <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location-id LOCATION_ID Set the current location context for the request
--organization-id ORGANIZATION_ID 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
Predefined field sets:
--------------------|-----|--------
FIELDS | ALL | DEFAULT
--------------------|-----|--------
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
Hosts | x | x
--------------------|-----|--------2.40.4. hammer job-invocation list
List job invocations
Usage:
hammer job-invocation <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------------|-----|--------
FIELDS | ALL | DEFAULT
--------------------|-----|--------
ID | x | x
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
--------------------|-----|--------2.40.5. hammer job-invocation output
View the output for a host
Usage:
hammer job-invocation output [OPTIONS]
Options:
--async Do not wait for job to complete, shows current output only
--host HOST_NAME Host name
--host-id HOST_ID
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.40.6. hammer job-invocation rerun
Rerun the job
Usage:
hammer job-invocation rerun [OPTIONS]
Options:
--failed-only FAILED_ONLY One of true/false, yes/no, 1/0.
--id ID
--location-id LOCATION_ID Set the current location context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help2.41. hammer job-template
Manage job templates
Usage:
hammer job-template [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a job template
delete, destroy Delete a job template
dump View job template content
export Export a template including all metadata
import Import a job template from ERB
info, show Show job template details
list, index List job templates
update Update a job template
Options:
-h, --help Print help2.41.1. hammer job-template create
Create a job template
Usage:
hammer job-template create [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--current-user CURRENT_USER Whether the current user login should be used as the effective user
One of true/false, yes/no, 1/0.
--description DESCRIPTION
--description-format DESCRIPTION_FORMAT This template is used to generate the description. Input values can be used
Using the syntax %{package}. You may also include the job category and
Template name using %{job_category} and %{template_name}.
--file TEMPLATE Path to a file that contains the template
--job-category JOB_CATEGORY Job category
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME Template name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--overridable OVERRIDABLE Whether it should be allowed to override the effective user from the
Invocation form.
One of true/false, yes/no, 1/0.
--provider-type PROVIDER_TYPE Provider type
Possible value(s): 'SSH', 'Ansible'
--snippet SNIPPET One of true/false, yes/no, 1/0.
--value VALUE What user should be used to run the script (using sudo-like mechanisms)
-h, --help Print help2.41.2. hammer job-template delete
Delete a job template
Usage:
hammer job-template <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.41.3. hammer job-template dump
View job template content
Usage:
hammer job-template dump [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------
FIELDS
------2.41.4. hammer job-template export
Export a template including all metadata
Usage:
hammer job-template export [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------
FIELDS
------2.41.5. hammer job-template import
Import a job template from ERB
Usage:
hammer job-template import [OPTIONS]
Options:
--file TEMPLATE Path to a file that contains the template - must include ERB metadata
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--overwrite OVERWRITE Overwrite template if it already exists
One of true/false, yes/no, 1/0.
-h, --help Print help2.41.6. hammer job-template info
Show job template details
Usage:
hammer job-template <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Job Category | x | x |
Provider | x | x |
Type | x | x |
Description | x | x |
Inputs | x | x |
Locations/ | x | x |
Organizations/ | x | x |
---------------|-----|---------|-----2.41.7. hammer job-template list
List job templates
Usage:
hammer job-template <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Job Category | x | x |
Provider | x | x |
Type | x | x |
-------------|-----|---------|-----2.41.8. hammer job-template update
Update a job template
Usage:
hammer job-template update [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--current-user CURRENT_USER Whether the current user login should be used as the effective user
One of true/false, yes/no, 1/0.
--description DESCRIPTION
--description-format DESCRIPTION_FORMAT This template is used to generate the description. Input values can be used
Using the syntax %{package}. You may also include the job category and
Template name using %{job_category} and %{template_name}.
--file TEMPLATE Path to a file that contains the template
--id ID
--job-category JOB_CATEGORY Job category
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME Name to search by
--new-name NEW_NAME Template name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--overridable OVERRIDABLE Whether it should be allowed to override the effective user from the
Invocation form.
One of true/false, yes/no, 1/0.
--provider-type PROVIDER_TYPE Provider type
Possible value(s): 'SSH', 'Ansible'
--snippet SNIPPET One of true/false, yes/no, 1/0.
--value VALUE What user should be used to run the script (using sudo-like mechanisms)
-h, --help Print help2.42. hammer lifecycle-environment
Manipulate lifecycle_environments on the server
Usage:
hammer lifecycle-environment [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an environment
delete, destroy Destroy an environment
info, show Show an environment
list, index List environments in an organization
paths List environment paths
update Update an environment
Options:
-h, --help Print help2.42.1. hammer lifecycle-environment create
Create an environment
Usage:
hammer lifecycle-environment create [OPTIONS]
Options:
--description DESCRIPTION Description of the environment
--label LABEL Label of the environment
--name NAME Name of the environment
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Name of organization
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--prior PRIOR Name of the prior environment
--prior-id PRIOR_ID ID of an environment that is prior to the new environment in the chain. It
Has to be either the ID of Library or the ID of an environment at the end
Of a chain.
--registry-name-pattern REGISTRY_NAME_PATTERN Pattern for container image names
--registry-unauthenticated-pull REGISTRY_UNAUTHENTICATED_PULL Allow unauthenticed pull of container images
One of true/false, yes/no, 1/0.
-h, --help Print help2.42.2. hammer lifecycle-environment delete
Destroy an environment
Usage:
hammer lifecycle-environment <delete|destroy> [OPTIONS]
Options:
--id ID ID of the environment
--name NAME Lifecycle environment name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.42.3. hammer lifecycle-environment info
Show an environment
Usage:
hammer lifecycle-environment <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID of the environment
--name NAME Lifecycle environment name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID ID of the organization
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
----------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
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 |
----------------------------|-----|---------|-----2.42.4. hammer lifecycle-environment list
List environments in an organization
Usage:
hammer lifecycle-environment <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--library LIBRARY Set true if you want to see only library environments
Possible value(s): 'true', 'false'
--name NAME Filter only environments containing this name
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Prior | x | x |
-------|-----|---------|-----
Search / Order fields:
id integer
name string
organization_id integer2.42.5. hammer lifecycle-environment paths
List environment paths
Usage:
hammer lifecycle-environment paths [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--permission-type PERMISSION_TYPE The associated permission type. One of (readable | promotable) Default:
Readable
-h, --help Print help
Predefined field sets:
---------------|-----|--------
FIELDS | ALL | DEFAULT
---------------|-----|--------
Lifecycle Path | x | x
---------------|-----|--------2.42.6. hammer lifecycle-environment update
Update an environment
Usage:
hammer lifecycle-environment update [OPTIONS]
Options:
--async ASYNC Do not wait for the update action to finish. Default: true
One of true/false, yes/no, 1/0.
--description DESCRIPTION Description of the environment
--id ID ID of the environment
--name NAME Lifecycle environment name to search by
--new-name NEW_NAME New name to be given to the environment
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Name of the organization
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--registry-name-pattern REGISTRY_NAME_PATTERN Pattern for container image names
--registry-unauthenticated-pull REGISTRY_UNAUTHENTICATED_PULL Allow unauthenticed pull of container images
One of true/false, yes/no, 1/0.
-h, --help Print help2.43. hammer location
Manipulate locations
Usage:
hammer location [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-compute-resource Associate a compute resource
add-domain Associate a domain
add-environment Associate a Puppet environment
add-hostgroup Associate a hostgroup
add-medium Associate a medium
add-organization Associate an organization
add-provisioning-template Associate provisioning templates
add-smart-proxy Associate a smart proxy
add-subnet Associate a subnet
add-user Associate an user
create Create a location
delete, destroy Delete a location
delete-parameter Delete parameter for a location
info, show Show a location
list, index List all locations
remove-compute-resource Disassociate a compute resource
remove-domain Disassociate a domain
remove-environment Disassociate a Puppet environment
remove-hostgroup Disassociate a hostgroup
remove-medium Disassociate a medium
remove-organization Disassociate an organization
remove-provisioning-template Disassociate provisioning templates
remove-smart-proxy Disassociate a smart proxy
remove-subnet Disassociate a subnet
remove-user Disassociate an user
set-parameter Create or update parameter for a location
update Update a location
Options:
-h, --help Print help2.43.1. hammer location add-compute-resource
Associate a compute resource
Usage:
hammer location add-compute-resource [OPTIONS]
Options:
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.2. hammer location add-domain
Associate a domain
Usage:
hammer location add-domain [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.3. hammer location add-environment
Associate a Puppet environment
Usage:
hammer location add-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--id ID
--name NAME Set the current location context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--title TITLE Set the current location context for the request
-h, --help Print help2.43.4. hammer location add-hostgroup
Associate a hostgroup
Usage:
hammer location add-hostgroup [OPTIONS]
Options:
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.5. hammer location add-medium
Associate a medium
Usage:
hammer location add-medium [OPTIONS]
Options:
--id ID
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.6. hammer location add-organization
Associate an organization
Usage:
hammer location add-organization [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Organization ID
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.7. hammer location add-provisioning-template
Associate provisioning templates
Usage:
hammer location add-provisioning-template [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS List of provisioning template ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-search PROVISIONING_TEMPLATE_SEARCH Provisioning template name regex to search, all matching templates will be associated
--provisioning-templates PROVISIONING_TEMPLATE_NAMES List of provisioning template names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Set the current location context for the request
-h, --help Print help2.43.8. hammer location add-smart-proxy
Associate a smart proxy
Usage:
hammer location add-smart-proxy [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--smart-proxy SMART_PROXY_NAME Name to search by
--smart-proxy-id SMART_PROXY_ID
--title TITLE Set the current location context for the request
-h, --help Print help2.43.9. hammer location add-subnet
Associate a subnet
Usage:
hammer location add-subnet [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--title TITLE Set the current location context for the request
-h, --help Print help2.43.10. hammer location add-user
Associate an user
Usage:
hammer location add-user [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.43.11. hammer location create
Create a location
Usage:
hammer location create [OPTIONS]
Options:
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--compute-resources COMPUTE_RESOURCE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environment-ids ENVIRONMENT_IDS Environment IDs (--environment-ids is deprecated: Use --puppet-environment[s|-ids] instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environments ENVIRONMENT_NAMES (--environments is deprecated: Use --puppet-environment[s|-ids] instead)
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ignore-types IGNORE_TYPES List of resources types that will be automatically associated
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--media MEDIUM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium-ids MEDIUM_IDS Medium IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Associated organization IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--parent-id PARENT_ID Parent ID
--partition-table-ids PARTITION_TABLE_IDS Partition template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--partition-tables PARTITION_TABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-templates PROVISIONING_TEMPLATE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment-ids PUPPET_ENVIRONMENT_IDS Environment IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environments PUPPET_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realm-ids REALM_IDS Realm IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realms REALM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--smart-proxies SMART_PROXY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--smart-proxy-ids SMART_PROXY_IDS Capsule IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnets SUBNET_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-ids USER_IDS User IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--users USER_LOGINS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.43.12. hammer location delete
Delete a location
Usage:
hammer location <delete|destroy> [OPTIONS]
Options:
--id ID Location numeric id to search by
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Set the current organization context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.43.13. hammer location delete-parameter
Delete parameter for a location
Usage:
hammer location delete-parameter [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Parameter name
-h, --help Print help2.43.14. hammer location info
Show a location
Usage:
hammer location <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Location numeric id to search by
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Set the current organization context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
--title TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
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 |
Environments/ | x | x |
Hostgroups/ | x | x |
Parameters/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
--------------------|-----|---------|-----2.43.15. hammer location list
List all locations
Usage:
hammer location <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Title | x | x | x
Name | x | x | x
Description | x | x |
------------|-----|---------|-----
Search / Order fields:
description text
id integer
location_id integer
name string
title string2.43.16. hammer location remove-compute-resource
Disassociate a compute resource
Usage:
hammer location remove-compute-resource [OPTIONS]
Options:
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.17. hammer location remove-domain
Disassociate a domain
Usage:
hammer location remove-domain [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.18. hammer location remove-environment
Disassociate a Puppet environment
Usage:
hammer location remove-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--id ID
--name NAME Set the current location context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--title TITLE Set the current location context for the request
-h, --help Print help2.43.19. hammer location remove-hostgroup
Disassociate a hostgroup
Usage:
hammer location remove-hostgroup [OPTIONS]
Options:
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.20. hammer location remove-medium
Disassociate a medium
Usage:
hammer location remove-medium [OPTIONS]
Options:
--id ID
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.21. hammer location remove-organization
Disassociate an organization
Usage:
hammer location remove-organization [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Organization ID
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Set the current location context for the request
-h, --help Print help2.43.22. hammer location remove-provisioning-template
Disassociate provisioning templates
Usage:
hammer location remove-provisioning-template [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS List of provisioning template ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-search PROVISIONING_TEMPLATE_SEARCH Provisioning template name regex to search, all matching templates will be disassociated
--provisioning-templates PROVISIONING_TEMPLATE_NAMES List of provisioning template names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Set the current location context for the request
-h, --help Print help2.43.23. hammer location remove-smart-proxy
Disassociate a smart proxy
Usage:
hammer location remove-smart-proxy [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--smart-proxy SMART_PROXY_NAME Name to search by
--smart-proxy-id SMART_PROXY_ID
--title TITLE Set the current location context for the request
-h, --help Print help2.43.24. hammer location remove-subnet
Disassociate a subnet
Usage:
hammer location remove-subnet [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--title TITLE Set the current location context for the request
-h, --help Print help2.43.25. hammer location remove-user
Disassociate an user
Usage:
hammer location remove-user [OPTIONS]
Options:
--id ID
--name NAME Set the current location context for the request
--title TITLE Set the current location context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.43.26. hammer location set-parameter
Create or update parameter for a location
Usage:
hammer location set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.43.27. hammer location update
Update a location
Usage:
hammer location update [OPTIONS]
Options:
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--compute-resources COMPUTE_RESOURCE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environment-ids ENVIRONMENT_IDS Environment IDs (--environment-ids is deprecated: Use --puppet-environment[s|-ids] instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environments ENVIRONMENT_NAMES (--environments is deprecated: Use --puppet-environment[s|-ids] instead)
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Location numeric id to search by
--ignore-types IGNORE_TYPES List of resources types that will be automatically associated
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--media MEDIUM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium-ids MEDIUM_IDS Medium IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Set the current location context for the request
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS Associated organization IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--parent-id PARENT_ID Parent ID
--partition-table-ids PARTITION_TABLE_IDS Partition template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--partition-tables PARTITION_TABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-templates PROVISIONING_TEMPLATE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment-ids PUPPET_ENVIRONMENT_IDS Environment IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environments PUPPET_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realm-ids REALM_IDS Realm IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realms REALM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--smart-proxies SMART_PROXY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--smart-proxy-ids SMART_PROXY_IDS Capsule IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnets SUBNET_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Set the current location context for the request
--user-ids USER_IDS User IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--users USER_LOGINS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.44. hammer mail-notification
Manage mail notifications
Usage:
hammer mail-notification [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show an email notification
list, index List of email notifications
Options:
-h, --help Print help2.44.1. hammer mail-notification info
Show an email notification
Usage:
hammer mail-notification <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Numerical ID or email notification name
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Description | x | x |
Subscription type | x | x |
------------------|-----|---------|-----2.44.2. hammer mail-notification list
List of email notifications
Usage:
hammer mail-notification <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
description text
name string
user string2.45. hammer medium
Manipulate installation media
Usage:
hammer medium [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-operatingsystem Associate an operating system
create Create a medium
delete, destroy Delete a medium
info, show Show a medium
list, index List all installation media
remove-operatingsystem Disassociate an operating system
update Update a medium
Options:
-h, --help Print help2.45.1. hammer medium add-operatingsystem
Associate an operating system
Usage:
hammer medium add-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Medium name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.45.2. hammer medium create
Create a medium
Usage:
hammer medium create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name of media
--operatingsystem-ids OPERATINGSYSTEM_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--os-family OS_FAMILY Operating system family, available values: AIX, Altlinux, Archlinux,
Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,
Suse, VRP, Windows, Xenserver
--path PATH The path to the medium, can be a URL or a valid NFS server (exclusive of
The architecture).
For example mirror.centos.org/centos/$version/os/$arch
Where $arch will be substituted for the host's actual OS architecture
And $version, $major and $minor will be substituted for the version of the
Operating system.
Solaris and Debian media may also use $release.
-h, --help Print help2.45.3. hammer medium delete
Delete a medium
Usage:
hammer medium <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Medium name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.45.4. hammer medium info
Show a medium
Usage:
hammer medium <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Medium name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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 |
-------------------|-----|---------|-----2.45.5. hammer medium list
List all installation media
Usage:
hammer medium <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Path | x | x |
-------|-----|---------|-----
Search / Order fields:
family string
location string
location_id integer
name string
organization string
organization_id integer
path string2.45.6. hammer medium remove-operatingsystem
Disassociate an operating system
Usage:
hammer medium remove-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Medium name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.45.7. hammer medium update
Update a medium
Usage:
hammer medium update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Medium name
--new-name NEW_NAME Name of media
--operatingsystem-ids OPERATINGSYSTEM_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--os-family OS_FAMILY Operating system family, available values: AIX, Altlinux, Archlinux,
Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,
Suse, VRP, Windows, Xenserver
--path PATH The path to the medium, can be a URL or a valid NFS server (exclusive of
The architecture).
For example mirror.centos.org/centos/$version/os/$arch
Where $arch will be substituted for the host's actual OS architecture
And $version, $major and $minor will be substituted for the version of the
Operating system.
Solaris and Debian media may also use $release.
-h, --help Print help2.46. hammer model
Manipulate hardware models
Usage:
hammer model [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a hardware model
delete, destroy Delete a hardware model
info, show Show a hardware model
list, index List all hardware models
update Update a hardware model
Options:
-h, --help Print help2.46.1. hammer model create
Create a hardware model
Usage:
hammer model create [OPTIONS]
Options:
--hardware-model HARDWARE_MODEL
--info INFO
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vendor-class VENDOR_CLASS
-h, --help Print help2.46.2. hammer model delete
Delete a hardware model
Usage:
hammer model <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Model name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.46.3. hammer model info
Show a hardware model
Usage:
hammer model <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Model name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Vendor class | x | x |
HW model | x | x |
Info | x | x |
Created at | x | x |
Updated at | x | x |
-------------|-----|---------|-----2.46.4. hammer model list
List all hardware models
Usage:
hammer model <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Vendor class | x | x |
HW model | x | x |
-------------|-----|---------|-----
Search / Order fields:
hardware_model string
info text
name string
vendor_class string2.46.5. hammer model update
Update a hardware model
Usage:
hammer model update [OPTIONS]
Options:
--hardware-model HARDWARE_MODEL
--id ID
--info INFO
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Model name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--vendor-class VENDOR_CLASS
-h, --help Print help2.47. hammer module-stream
View Module Streams
Usage:
hammer module-stream [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a module stream
list, index List module streams
Options:
-h, --help Print help2.47.1. hammer module-stream info
Show a module stream
Usage:
hammer module-stream <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A module stream identifier
--name NAME Module stream name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository ID
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
ID | x | x |
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 |
-------------------|-----|---------|-----2.47.2. hammer module-stream list
List module streams
Usage:
hammer module-stream <list|index> [OPTIONS]
Options:
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host-ids HOST_IDS List of host id to list available module streams for
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name-stream-only NAME_STREAM_ONLY Return name and stream information only)
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
ID | x | x |
Module Stream Name | x | x | x
Stream | x | x |
UUID | x | x |
Version | x | x |
Architecture | x | x |
Context | x | x |
-------------------|-----|---------|-----2.48. hammer organization
Manipulate organizations
Usage:
hammer organization [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-compute-resource Associate a compute resource
add-domain Associate a domain
add-environment Associate a Puppet environment
add-hostgroup Associate a hostgroup
add-location Associate a location
add-medium Associate a medium
add-provisioning-template Associate provisioning templates
add-smart-proxy Associate a smart proxy
add-subnet Associate a subnet
add-user Associate an user
create Create organization
delete, destroy Delete an organization
delete-parameter Delete parameter for an organization
info, show Show organization
list, index List all organizations
remove-compute-resource Disassociate a compute resource
remove-domain Disassociate a domain
remove-environment Disassociate a Puppet environment
remove-hostgroup Disassociate a hostgroup
remove-location Disassociate a location
remove-medium Disassociate a medium
remove-provisioning-template Disassociate provisioning templates
remove-smart-proxy Disassociate a smart proxy
remove-subnet Disassociate a subnet
remove-user Disassociate an user
set-parameter Create or update parameter for an organization
update Update organization
Options:
-h, --help Print help2.48.1. hammer organization add-compute-resource
Associate a compute resource
Usage:
hammer organization add-compute-resource [OPTIONS]
Options:
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.2. hammer organization add-domain
Associate a domain
Usage:
hammer organization add-domain [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.3. hammer organization add-environment
Associate a Puppet environment
Usage:
hammer organization add-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--id ID Organization ID
--name NAME Set the current organization context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.4. hammer organization add-hostgroup
Associate a hostgroup
Usage:
hammer organization add-hostgroup [OPTIONS]
Options:
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.5. hammer organization add-location
Associate a location
Usage:
hammer organization add-location [OPTIONS]
Options:
--id ID Organization ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.6. hammer organization add-medium
Associate a medium
Usage:
hammer organization add-medium [OPTIONS]
Options:
--id ID Organization ID
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.7. hammer organization add-provisioning-template
Associate provisioning templates
Usage:
hammer organization add-provisioning-template [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS List of provisioning template ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-search PROVISIONING_TEMPLATE_SEARCH Provisioning template name regex to search, all matching templates will be associated
--provisioning-templates PROVISIONING_TEMPLATE_NAMES List of provisioning template names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.8. hammer organization add-smart-proxy
Associate a smart proxy
Usage:
hammer organization add-smart-proxy [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--smart-proxy SMART_PROXY_NAME Name to search by
--smart-proxy-id SMART_PROXY_ID
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.9. hammer organization add-subnet
Associate a subnet
Usage:
hammer organization add-subnet [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.10. hammer organization add-user
Associate an user
Usage:
hammer organization add-user [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.48.11. hammer organization create
Create organization
Usage:
hammer organization create [OPTIONS]
Options:
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--compute-resources COMPUTE_RESOURCE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--config-template-ids CONFIG_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environment-ids ENVIRONMENT_IDS Environment IDs (--environment-ids is deprecated: Use --puppet-environment[s|-ids] instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environments ENVIRONMENT_NAMES (--environments is deprecated: Use --puppet-environment[s|-ids] instead)
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--label LABEL
--lifecycle-environment-ids LIFECYCLE_ENVIRONMENT_IDS Environment IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environments LIFECYCLE_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Associated location IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--media MEDIUM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium-ids MEDIUM_IDS Medium IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--partition-table-ids PARTITION_TABLE_IDS Partition template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--partition-tables PARTITION_TABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-templates PROVISIONING_TEMPLATE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ptable-ids PTABLE_IDS Partition template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ptables PTABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment-ids PUPPET_ENVIRONMENT_IDS Environment IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environments PUPPET_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realm-ids REALM_IDS Realm IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realms REALM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--smart-proxies SMART_PROXY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--smart-proxy-ids SMART_PROXY_IDS Capsule IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnets SUBNET_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-ids USER_IDS User IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--users USER_LOGINS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.48.12. hammer organization delete
Delete an organization
Usage:
hammer organization <delete|destroy> [OPTIONS]
Options:
--async Do not wait for the task
--id ID
--label LABEL Organization label to search by
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Set the current organization context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.13. hammer organization delete-parameter
Delete parameter for an organization
Usage:
hammer organization delete-parameter [OPTIONS]
Options:
--name NAME Parameter name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Organization ID
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.48.14. hammer organization info
Show organization
Usage:
hammer organization <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--label LABEL Organization label to search by
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Set the current organization context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------|-----|---------|-----
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 |
Environments/ | 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 |
Red Hat Repository URL | x | x |
Service Levels | x | x |
-----------------------|-----|---------|-----2.48.15. hammer organization list
List all organizations
Usage:
hammer organization <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--sort-by SORT_BY Field to sort the results on
--sort-order SORT_ORDER How to order the sorted results (e.g. ASC for ascending)
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
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 string2.48.16. hammer organization remove-compute-resource
Disassociate a compute resource
Usage:
hammer organization remove-compute-resource [OPTIONS]
Options:
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.17. hammer organization remove-domain
Disassociate a domain
Usage:
hammer organization remove-domain [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID Numerical ID or domain name
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.18. hammer organization remove-environment
Disassociate a Puppet environment
Usage:
hammer organization remove-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--id ID Organization ID
--name NAME Set the current organization context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.19. hammer organization remove-hostgroup
Disassociate a hostgroup
Usage:
hammer organization remove-hostgroup [OPTIONS]
Options:
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.20. hammer organization remove-location
Disassociate a location
Usage:
hammer organization remove-location [OPTIONS]
Options:
--id ID Organization ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.21. hammer organization remove-medium
Disassociate a medium
Usage:
hammer organization remove-medium [OPTIONS]
Options:
--id ID Organization ID
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.22. hammer organization remove-provisioning-template
Disassociate provisioning templates
Usage:
hammer organization remove-provisioning-template [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS List of provisioning template ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-search PROVISIONING_TEMPLATE_SEARCH Provisioning template name regex to search, all matching templates will be disassociated
--provisioning-templates PROVISIONING_TEMPLATE_NAMES List of provisioning template names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.23. hammer organization remove-smart-proxy
Disassociate a smart proxy
Usage:
hammer organization remove-smart-proxy [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--smart-proxy SMART_PROXY_NAME Name to search by
--smart-proxy-id SMART_PROXY_ID
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.24. hammer organization remove-subnet
Disassociate a subnet
Usage:
hammer organization remove-subnet [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--title TITLE Set the current organization context for the request
-h, --help Print help2.48.25. hammer organization remove-user
Disassociate an user
Usage:
hammer organization remove-user [OPTIONS]
Options:
--id ID Organization ID
--name NAME Set the current organization context for the request
--title TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.48.26. hammer organization set-parameter
Create or update parameter for an organization
Usage:
hammer organization set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Organization ID
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.48.27. hammer organization update
Update organization
Usage:
hammer organization update [OPTIONS]
Options:
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--compute-resources COMPUTE_RESOURCE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--config-template-ids CONFIG_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environment-ids ENVIRONMENT_IDS Environment IDs (--environment-ids is deprecated: Use --puppet-environment[s|-ids] instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environments ENVIRONMENT_NAMES (--environments is deprecated: Use --puppet-environment[s|-ids] instead)
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--label LABEL
--lifecycle-environment-ids LIFECYCLE_ENVIRONMENT_IDS Environment IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environments LIFECYCLE_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS Associated location IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--media MEDIUM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium-ids MEDIUM_IDS Medium IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Set the current organization context for the request
--new-name NEW_NAME
--new-title NEW_TITLE
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--partition-table-ids PARTITION_TABLE_IDS Partition template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--partition-tables PARTITION_TABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-templates PROVISIONING_TEMPLATE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ptable-ids PTABLE_IDS Partition template IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ptables PTABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environment-ids PUPPET_ENVIRONMENT_IDS Environment IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--puppet-environments PUPPET_ENVIRONMENT_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realm-ids REALM_IDS Realm IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realms REALM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--redhat-repository-url REDHAT_REPOSITORY_URL Red Hat CDN URL
--smart-proxies SMART_PROXY_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--smart-proxy-ids SMART_PROXY_IDS Capsule IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--subnets SUBNET_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Set the current organization context for the request
--user-ids USER_IDS User IDs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--users USER_LOGINS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.49. hammer os
Manipulate operating system
Usage:
hammer os [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-architecture Associate an architecture
add-provisioning-template Associate provisioning templates
add-ptable Associate a partition table
create Create an operating system
delete, destroy Delete an operating system
delete-default-template
delete-parameter Delete parameter for an operating system
info, show Show an operating system
list, index List all operating systems
remove-architecture Disassociate an architecture
remove-provisioning-template Disassociate provisioning templates
remove-ptable Disassociate a partition table
set-default-template
set-parameter Create or update parameter for an operating system
update Update an operating system
Options:
-h, --help Print help2.49.1. hammer os add-architecture
Associate an architecture
Usage:
hammer os add-architecture [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID
--id ID
--title TITLE Operating system title
-h, --help Print help2.49.2. hammer os add-provisioning-template
Associate provisioning templates
Usage:
hammer os add-provisioning-template [OPTIONS]
Options:
--id ID
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS List of provisioning template ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-search PROVISIONING_TEMPLATE_SEARCH Provisioning template name regex to search, all matching templates will be associated
--provisioning-templates PROVISIONING_TEMPLATE_NAMES List of provisioning template names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Operating system title
-h, --help Print help2.49.3. hammer os add-ptable
Associate a partition table
Usage:
hammer os add-ptable [OPTIONS]
Options:
--id ID
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--title TITLE Operating system title
-h, --help Print help2.49.4. hammer os create
Create an operating system
Usage:
hammer os create [OPTIONS]
Options:
--architecture-ids ARCHITECTURE_IDS IDs of associated architectures
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--architectures ARCHITECTURE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION
--family FAMILY
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--major MAJOR
--media MEDIUM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium-ids MEDIUM_IDS IDs of associated media
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--minor MINOR
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--os-parameters-attributes OS_PARAMETERS_ATTRIBUTES Array of parameters
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--partition-table-ids PARTITION_TABLE_IDS IDs of associated partition tables
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--partition-tables PARTITION_TABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--password-hash PASSWORD_HASH Root password hash function to use
Possible value(s): 'SHA256', 'SHA512', 'Base64', 'Base64-Windows', 'MD5'
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated provisioning templates
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-templates PROVISIONING_TEMPLATE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--release-name RELEASE_NAME
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--os-parameters-attributes "name=<string>\,value=<string>, ... "2.49.5. hammer os delete
Delete an operating system
Usage:
hammer os <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--title TITLE Operating system title
-h, --help Print help2.49.6. hammer os delete-default-template
Usage:
hammer os delete-default-template [OPTIONS]
Options:
--id OS ID Operatingsystem id
--type TPL TYPE Type of the provisioning template
-h, --help Print help2.49.7. hammer os delete-parameter
Delete parameter for an operating system
Usage:
hammer os delete-parameter [OPTIONS]
Options:
--name NAME Parameter name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.49.8. hammer os info
Show an operating system
Usage:
hammer os <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
--title TITLE Operating system title
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
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 |
--------------------|-----|---------|-----2.49.9. hammer os list
List all operating systems
Usage:
hammer os <list|index> [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID ID of architecture
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--medium MEDIUM_NAME Medium name
--medium-id MEDIUM_ID ID of medium
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--os-parameters-attributes OS_PARAMETERS_ATTRIBUTES Array of parameters
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--page PAGE Page number, starting at 1
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID ID of template
--search SEARCH Filter results
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--os-parameters-attributes "name=<string>\,value=<string>, ... "
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Title | x | x | x
Release name | x | x |
Family | x | x |
-------------|-----|---------|-----
Search / Order fields:
architecture string
description string
family string
major string
medium string
minor string
name string
params string
template string
title string2.49.10. hammer os remove-architecture
Disassociate an architecture
Usage:
hammer os remove-architecture [OPTIONS]
Options:
--architecture ARCHITECTURE_NAME Architecture name
--architecture-id ARCHITECTURE_ID
--id ID
--title TITLE Operating system title
-h, --help Print help2.49.11. hammer os remove-provisioning-template
Disassociate provisioning templates
Usage:
hammer os remove-provisioning-template [OPTIONS]
Options:
--id ID
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS List of provisioning template ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-template-search PROVISIONING_TEMPLATE_SEARCH Provisioning template name regex to search, all matching templates will be disassociated
--provisioning-templates PROVISIONING_TEMPLATE_NAMES List of provisioning template names
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--title TITLE Operating system title
-h, --help Print help2.49.12. hammer os remove-ptable
Disassociate a partition table
Usage:
hammer os remove-ptable [OPTIONS]
Options:
--id ID
--partition-table PARTITION_TABLE_NAME Partition table name
--partition-table-id PARTITION_TABLE_ID
--title TITLE Operating system title
-h, --help Print help2.49.13. hammer os set-default-template
Usage:
hammer os set-default-template [OPTIONS]
Options:
--id OS ID Operatingsystem id
--provisioning-template-id TPL ID Provisioning template id to be set
-h, --help Print help2.49.14. hammer os set-parameter
Create or update parameter for an operating system
Usage:
hammer os set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--value VALUE Parameter value
-h, --help Print help2.49.15. hammer os update
Update an operating system
Usage:
hammer os update [OPTIONS]
Options:
--architecture-ids ARCHITECTURE_IDS IDs of associated architectures
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--architectures ARCHITECTURE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION
--family FAMILY
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--major MAJOR
--media MEDIUM_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--medium-ids MEDIUM_IDS IDs of associated media
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--minor MINOR
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--os-parameters-attributes OS_PARAMETERS_ATTRIBUTES Array of parameters
Comma separated list of values defined by a schema. See Option details section below.
JSON is acceptable and preferred way for complex parameters
--partition-table-ids PARTITION_TABLE_IDS IDs of associated partition tables
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--partition-tables PARTITION_TABLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--password-hash PASSWORD_HASH Root password hash function to use
Possible value(s): 'SHA256', 'SHA512', 'Base64', 'Base64-Windows', 'MD5'
--provisioning-template-ids PROVISIONING_TEMPLATE_IDS IDs of associated provisioning templates
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--provisioning-templates PROVISIONING_TEMPLATE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--release-name RELEASE_NAME
--title TITLE Operating system title
-h, --help Print help
Option details:
Following parameters accept format defined by its schema (bold are required; <> contain acceptable type; [] contain acceptable value):
--os-parameters-attributes "name=<string>\,value=<string>, ... "2.50. hammer ostree-branch
Manipulate ostree branches
Usage:
hammer ostree-branch [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show an ostree branch
list, index List ostree_branches
Options:
-h, --help Print help2.50.1. hammer ostree-branch info
Show an ostree branch
Usage:
hammer ostree-branch <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID An ostree branch identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Version | x | x |
Commit | x | x |
--------|-----|---------|-----2.50.2. hammer ostree-branch list
List ostree_branches
Usage:
hammer ostree-branch <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
ID | x | x | x
Name | x | x | x
version | x | x |
--------|-----|---------|-----2.51. hammer package
Manipulate packages
Usage:
hammer package [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a package
list, index List packages
Options:
-h, --help Print help2.51.1. hammer package info
Show a package
Usage:
hammer package <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A package identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
ID | x | x | x
Pulp ID | x | x |
UUID | x | x |
Name | x | x | x
Version | x | x |
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 |
----------------------|-----|---------|-----2.51.2. hammer package list
List packages
Usage:
hammer package <list|index> [OPTIONS]
Options:
--available-for AVAILABLE_FOR Return packages that can be added to the specified object. Only the value
'content_view_version' is supported.
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content View Filter identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content View Version identifier
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID Host id to list applicable packages for
--ids IDS Package identifiers to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--packages-restrict-applicable PACKAGES_RESTRICT_APPLICABLE Return packages that are applicable to one or more hosts (defaults to true
If host_id is specified)
One of true/false, yes/no, 1/0.
--packages-restrict-latest PACKAGES_RESTRICT_LATEST Return only the latest version of each package
One of true/false, yes/no, 1/0.
--packages-restrict-upgradable PACKAGES_RESTRICT_UPGRADABLE Return packages that are upgradable on one or more hosts
One of true/false, yes/no, 1/0.
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-----------|-----|--------
FIELDS | ALL | DEFAULT
-----------|-----|--------
ID | x | x
Filename | x | x
Source RPM | x | x
-----------|-----|--------2.52. hammer package-group
Manipulate package groups
Usage:
hammer package-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a package group
list, index List package_groups
Options:
-h, --help Print help2.52.1. hammer package-group info
Show a package group
Usage:
hammer package-group <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A package group identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
---------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------|-----|---------|-----
ID | x | x | x
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 |
---------------------|-----|---------|-----2.52.2. hammer package-group list
List package_groups
Usage:
hammer package-group <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
ID | x | x | x
Package Group Name | x | x | x
Repository Name | x | x |
UUID | x | x |
-------------------|-----|---------|-----2.53. hammer partition-table
Manipulate partition tables
Usage:
hammer partition-table [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-operatingsystem Associate an operating system
create Create a partition table
delete, destroy Delete a partition table
dump View partition table content
info, show Show a partition table
list, index List all partition tables
remove-operatingsystem Disassociate an operating system
update Update a partition table
Options:
-h, --help Print help2.53.1. hammer partition-table add-operatingsystem
Associate an operating system
Usage:
hammer partition-table add-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Partition table name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.53.2. hammer partition-table create
Create a partition table
Usage:
hammer partition-table create [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--description DESCRIPTION
--file LAYOUT Path to a file that contains the partition layout
--host-ids HOST_IDS Array of host IDs to associate with the partition table
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-ids HOSTGROUP_IDS Array of host group IDs to associate with the partition table
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the partition table
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--os-family OS_FAMILY
--snippet SNIPPET One of true/false, yes/no, 1/0.
-h, --help Print help2.53.3. hammer partition-table delete
Delete a partition table
Usage:
hammer partition-table <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Partition table name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.53.4. hammer partition-table dump
View partition table content
Usage:
hammer partition-table dump [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Partition table name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------
FIELDS
------2.53.5. hammer partition-table info
Show a partition table
Usage:
hammer partition-table <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Partition table name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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 |
-------------------|-----|---------|-----2.53.6. hammer partition-table list
List all partition tables
Usage:
hammer partition-table <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
----------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------|-----|---------|-----
Id | x | x | x
Name | x | x | x
OS Family | x | x |
----------|-----|---------|-----
Search / Order fields:
default Values: true, false
family string
layout text
location string
location_id integer
locked Values: true, false
name string
organization string
organization_id integer
snippet Values: true, false
template text
vendor string2.53.7. hammer partition-table remove-operatingsystem
Disassociate an operating system
Usage:
hammer partition-table remove-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Partition table name
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.53.8. hammer partition-table update
Update a partition table
Usage:
hammer partition-table update [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--description DESCRIPTION
--file LAYOUT Path to a file that contains the partition layout
--host-ids HOST_IDS Array of host IDs to associate with the partition table
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-ids HOSTGROUP_IDS Array of host group IDs to associate with the partition table
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-titles HOSTGROUP_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME Partition table name
--new-name NEW_NAME
--operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the partition table
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--os-family OS_FAMILY
--snippet SNIPPET One of true/false, yes/no, 1/0.
-h, --help Print help2.54. hammer ping
Get the status of the server and/or it’s subcomponents
Usage:
hammer ping [OPTIONS] [SUBCOMMAND] [ARG] ...
Parameters:
[ARG] ... Subcommand arguments
[SUBCOMMAND] Subcommand (default: "foreman")
Subcommands:
foreman Shows status of Satellite system and it's subcomponents
katello Shows status of Katello system and it's subcomponents
Options:
-h, --help Print help2.54.1. hammer ping foreman
Shows status of Satellite system and it’s subcomponents
Usage:
hammer ping foreman [OPTIONS]
Options:
-h, --help Print help2.54.2. hammer ping katello
Shows status of Katello system and it’s subcomponents
Usage:
hammer ping katello [OPTIONS]
Options:
-h, --help Print help2.55. hammer policy
Manipulate policies
Usage:
hammer policy [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a Policy
delete, destroy Delete a Policy
hosts List all hosts
info, show Show a Policy
list, index List Policies
update Update a Policy
Options:
-h, --help Print help2.55.1. hammer policy create
Create a Policy
Usage:
hammer policy create [OPTIONS]
Options:
--cron-line CRON_LINE Policy schedule cron line (only if period == “custom”)
--day-of-month DAY_OF_MONTH Policy schedule day of month (only if period == “monthly”)
--deploy-by DEPLOY_BY How the policy should be deployed
Possible value(s): 'puppet', 'ansible', 'manual'
--description DESCRIPTION Policy description
--host-ids HOST_IDS Apply policy to hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-ids HOSTGROUP_IDS Apply policy to host groups
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Policy name
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--period PERIOD Policy schedule period (weekly, monthly, custom)
--scap-content SCAP_CONTENT_TITLE SCAP content title
--scap-content-id SCAP_CONTENT_ID Policy SCAP content ID
--scap-content-profile SCAP_CONTENT_PROFILE_NAME Name to search by
--scap-content-profile-id SCAP_CONTENT_PROFILE_ID Policy SCAP content profile ID
--tailoring-file TAILORING_FILE_NAME Tailoring file name
--tailoring-file-id TAILORING_FILE_ID Tailoring file ID
--tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file profile ID
--weekday WEEKDAY Policy schedule weekday (only if period == “weekly”)
-h, --help Print help2.55.2. hammer policy delete
Delete a Policy
Usage:
hammer policy <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.55.3. hammer policy hosts
List all hosts
Usage:
hammer policy hosts [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID Policy Id
--include INCLUDE Array of extra information types to include
Possible value(s): 'parameters', 'all_parameters'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID ID of location
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Policy name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID ID of organization
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
--thin THIN Only list ID and name of hosts
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
-----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Operating System | x | x |
Host Group | x | x |
IP | x | x |
MAC | x | x |
Global Status | x | x |
Organization | x | |
Location | x | |
Additional Information | x | |
Content View | x | x |
Lifecycle Environment | x | x |
Security | x | |
Bugfix | x | |
Enhancement | x | |
Trace Status | x | x |
-----------------------|-----|---------|-----
Search / Order fields:
activation_key string
activation_key_id string
addon string
addons_status Values: mismatched, matched, not_specified
ansible_role string
applicable_errata string
applicable_errata_issued date
applicable_rpms string
architecture string
autoheal boolean
boot_time
build Values: true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
created_at datetime
domain string
domain_id integer
environment string
errata_status Values: security_needed, errata_needed, updated, unknown
execution_status Values: ok, error
facts string
global_status Values: ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
id integer
image string
insights_recommendations_count integer
installable_errata string
installed_at datetime
ip string
job_invocation.id string
job_invocation.result Values: cancelled, failed, pending, success
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed Values: true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
params_name string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status Values: mismatched, matched, not_specified
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
role text
role_status Values: mismatched, matched, not_specified
service_level string
sla_status Values: mismatched, matched, not_specified
smart_proxy string
status.applied integer
status.enabled Values: true, false
status.failed integer
status.failed_restarts integer
status.interesting Values: true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status Values: valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor
subscription_uuid string
trace_status Values: reboot_needed, process_restart_needed, updated
upgradable_rpms string
usage text
usage_status Values: mismatched, matched, not_specified
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string2.55.4. hammer policy info
Show a Policy
Usage:
hammer policy <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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 |
--------------------------|-----|---------|-----2.55.5. hammer policy list
List Policies
Usage:
hammer policy <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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 string2.55.6. hammer policy update
Update a Policy
Usage:
hammer policy update [OPTIONS]
Options:
--cron-line CRON_LINE Policy schedule cron line (only if period == “custom”)
--day-of-month DAY_OF_MONTH Policy schedule day of month (only if period == “monthly”)
--deploy-by DEPLOY_BY How the policy should be deployed
Possible value(s): 'puppet', 'ansible', 'manual'
--description DESCRIPTION Policy description
--host-ids HOST_IDS Apply policy to hosts
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup-ids HOSTGROUP_IDS Apply policy to host groups
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroups HOSTGROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hosts HOST_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Policy name
--new-name NEW_NAME Policy name
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--period PERIOD Policy schedule period (weekly, monthly, custom)
--scap-content SCAP_CONTENT_TITLE SCAP content title
--scap-content-id SCAP_CONTENT_ID Policy SCAP content ID
--scap-content-profile SCAP_CONTENT_PROFILE_NAME Name to search by
--scap-content-profile-id SCAP_CONTENT_PROFILE_ID Policy SCAP content profile ID
--tailoring-file TAILORING_FILE_NAME Tailoring file name
--tailoring-file-id TAILORING_FILE_ID Tailoring file ID
--tailoring-file-profile-id TAILORING_FILE_PROFILE_ID Tailoring file profile ID
--weekday WEEKDAY Policy schedule weekday (only if period == “weekly”)
-h, --help Print help2.56. hammer prebuild-bash-completion
Prepare map of options and subcommands for Bash completion
Usage:
hammer prebuild-bash-completion [OPTIONS]
Options:
-h, --help Print help2.57. hammer product
Manipulate products
Usage:
hammer product [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a product
delete, destroy Destroy a product
info, show Show a product
list, index List products
remove-sync-plan Delete assignment sync plan and product
set-sync-plan Assign sync plan to product
synchronize Sync all repositories for a product
update Updates a product
update-proxy Updates an HTTP Proxy for a product
Options:
-h, --help Print help2.57.1. hammer product create
Create a product
Usage:
hammer product create [OPTIONS]
Options:
--description DESCRIPTION Product description
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID Identifier of the GPG key
--label LABEL
--name NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID ID of the organization
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert
--ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert
--ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID Plan numeric identifier
-h, --help Print help2.57.2. hammer product delete
Destroy a product
Usage:
hammer product <delete|destroy> [OPTIONS]
Options:
--id ID Product numeric identifier
--name NAME Product name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.57.3. hammer product info
Show a product
Usage:
hammer product <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Product numeric identifier
--name NAME Product name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
---------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
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 |
---------------------|-----|---------|-----2.57.4. hammer product list
List products
Usage:
hammer product <list|index> [OPTIONS]
Options:
--available-for AVAILABLE_FOR Interpret specified object to return only Products that can be associated
With specified object. Only 'sync_plan' is supported.
--custom CUSTOM Return custom products only
One of true/false, yes/no, 1/0.
--enabled ENABLED Return enabled products only
One of true/false, yes/no, 1/0.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--include-available-content INCLUDE_AVAILABLE_CONTENT Whether to include available content attribute in results
One of true/false, yes/no, 1/0.
--name NAME Filter products by name
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Filter products by organization
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--redhat-only REDHAT_ONLY Return Red Hat (non-custom) products only
One of true/false, yes/no, 1/0.
--search SEARCH Search string
--subscription SUBSCRIPTION_NAME Subscription name to search by
--subscription-id SUBSCRIPTION_ID Filter products by subscription
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID Filter products by sync plan id
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
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, false2.57.5. hammer product remove-sync-plan
Delete assignment sync plan and product
Usage:
hammer product remove-sync-plan [OPTIONS]
Options:
--description DESCRIPTION Product description
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID Identifier of the GPG key
--id ID Product numeric identifier
--name NAME Product name to search by
--new-name NEW_NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert
--ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert
--ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key
-h, --help Print help2.57.6. hammer product set-sync-plan
Assign sync plan to product
Usage:
hammer product set-sync-plan [OPTIONS]
Options:
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID Identifier of the GPG key
--id ID Product numeric identifier
--name NAME Product name to search by
--new-name NEW_NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert
--ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert
--ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID Plan numeric identifier
-h, --help Print help2.57.7. hammer product synchronize
Sync all repositories for a product
Usage:
hammer product synchronize [OPTIONS]
Options:
--async Do not wait for the task
--id ID Product ID
--name NAME Product name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.57.8. hammer product update
Updates a product
Usage:
hammer product update [OPTIONS]
Options:
--description DESCRIPTION Product description
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID Identifier of the GPG key
--id ID Product numeric identifier
--name NAME Product name to search by
--new-name NEW_NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--ssl-ca-cert-id SSL_CA_CERT_ID Idenifier of the SSL CA Cert
--ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the SSL Client Cert
--ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the SSL Client Key
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID Plan numeric identifier
-h, --help Print help2.57.9. hammer product update-proxy
Updates an HTTP Proxy for a product
Usage:
hammer product update-proxy [OPTIONS]
Options:
--http-proxy HTTP_PROXY_NAME Name to search by
--http-proxy-id HTTP_PROXY_ID HTTP Proxy identifier to associated
--http-proxy-policy HTTP_PROXY_POLICY Policy for HTTP Proxy for content sync
Possible value(s): 'global_default_http_proxy', 'none', 'use_selected_http_proxy'
--ids IDS List of product ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.58. hammer proxy
Manipulate smart proxies
Usage:
hammer proxy [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
content Manage the capsule content
create Create a capsule
delete, destroy Delete a capsule
import-classes Import puppet classes from puppet Capsule
info, show Show a capsule
list, index List all capsules
refresh-features Refresh capsule features
update Update a capsule
Options:
-h, --help Print help2.58.1. hammer proxy content
Manage the capsule content
Usage:
hammer proxy content [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-lifecycle-environment Add lifecycle environments to the capsule
available-lifecycle-environments List the lifecycle environments not attached to the capsule
cancel-synchronization Cancel running capsule synchronization
info Get current capsule synchronization status
lifecycle-environments List the lifecycle environments attached to the capsule
remove-lifecycle-environment Remove lifecycle environments from the capsule
synchronization-status Get current capsule synchronization status
synchronize Synchronize the content to the capsule
Options:
-h, --help Print help2.58.1.1. hammer proxy content add-lifecycle-environment
Add lifecycle environments to the capsule
Usage:
hammer proxy content add-lifecycle-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
-h, --help Print help2.58.1.2. hammer proxy content available-lifecycle-environments
List the lifecycle environments not attached to the capsule
Usage:
hammer proxy content available-lifecycle-environments [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to limit environments on
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
-------------|-----|---------|-----2.58.1.3. hammer proxy content cancel-synchronization
Cancel running capsule synchronization
Usage:
hammer proxy content cancel-synchronization [OPTIONS]
Options:
--id ID Id of the capsule
--name NAME Name to search by
-h, --help Print help2.58.1.4. hammer proxy content info
Get current capsule synchronization status
Usage:
hammer proxy content info [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to get the status for
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------------------------------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
-------------------------------------------------------------------|-----|--------
Lifecycle Environments/Name | x | x
Lifecycle Environments/Organization | x | x
Lifecycle Environments/Content Views/Name | x | x
Lifecycle Environments/Content Views/Composite | x | x
Lifecycle Environments/Content Views/Last Published | x | x
Lifecycle Environments/Content Views/Content/Hosts | x | x
Lifecycle Environments/Content Views/Content/Products | x | x
Lifecycle Environments/Content Views/Content/Yum repos | x | x
Lifecycle Environments/Content Views/Content/Container Image repos | x | x
Lifecycle Environments/Content Views/Content/Packages | x | x
Lifecycle Environments/Content Views/Content/Package groups | x | x
Lifecycle Environments/Content Views/Content/Errata | x | x
Lifecycle Environments/Content Views/Content/Puppet modules | x | x
-------------------------------------------------------------------|-----|--------2.58.1.5. hammer proxy content lifecycle-environments
List the lifecycle environments attached to the capsule
Usage:
hammer proxy content lifecycle-environments [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to limit environments on
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Organization | x | x |
-------------|-----|---------|-----2.58.1.6. hammer proxy content remove-lifecycle-environment
Remove lifecycle environments from the capsule
Usage:
hammer proxy content remove-lifecycle-environment [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
-h, --help Print help2.58.1.7. hammer proxy content synchronization-status
Get current capsule synchronization status
Usage:
hammer proxy content synchronization-status [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Id of the capsule
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Id of the organization to get the status for
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
--------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
--------------------------------------|-----|--------
Last sync | x | x
Status | x | x
Currently running sync tasks/Task id | x | x
Currently running sync tasks/Progress | x | x
Last failure/Task id | x | x
Last failure/Messages | x | x
--------------------------------------|-----|--------2.58.1.8. hammer proxy content synchronize
Synchronize the content to the capsule
Usage:
hammer proxy content synchronize [OPTIONS]
Options:
--async Do not wait for the task
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--id ID Id of the capsule
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name to search by
--organization NAME Organization name
--organization-id ID Organization ID
--skip-metadata-check SKIP_METADATA_CHECK Skip metadata check on each repository on the capsule
One of true/false, yes/no, 1/0.
-h, --help Print help2.58.2. hammer proxy create
Create a capsule
Usage:
hammer proxy create [OPTIONS]
Options:
--download-policy DOWNLOAD_POLICY Download Policy of the capsule, must be one of immediate, on_demand,
Background, inherit
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--url URL
-h, --help Print help2.58.3. hammer proxy delete
Delete a capsule
Usage:
hammer proxy <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.58.4. hammer proxy import-classes
Import puppet classes from puppet Capsule
Usage:
hammer proxy import-classes [OPTIONS]
Options:
--dryrun Do not run the import
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--except EXCEPT Optional comma-delimited string containing either 'new',
'updated', or 'obsolete' that is used to limit the imported
Puppet classes
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
-h, --help Print help2.58.5. hammer proxy info
Show a capsule
Usage:
hammer proxy <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
URL | x | x |
Features | x | x |
Features/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.58.6. hammer proxy list
List all capsules
Usage:
hammer proxy <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
Id | x | x | x
Name | x | x | x
URL | x | x |
Features | x | x |
---------|-----|---------|-----
Search / Order fields:
feature string
location string
location_id integer
name string
organization string
organization_id integer
url string
Search / Order fields:
feature string
location string
location_id integer
name string
organization string
organization_id integer
url string2.58.7. hammer proxy refresh-features
Refresh capsule features
Usage:
hammer proxy refresh-features [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.58.8. hammer proxy update
Update a capsule
Usage:
hammer proxy update [OPTIONS]
Options:
--download-policy DOWNLOAD_POLICY Download Policy of the capsule, must be one of immediate, on_demand,
Background, inherit
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--url URL
-h, --help Print help2.59. hammer puppet-class
Search puppet modules
Usage:
hammer puppet-class [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a Puppet class
list, index List all Puppet classes
sc-params List all smart class parameters
Options:
-h, --help Print help2.59.1. hammer puppet-class info
Show a Puppet class
Usage:
hammer puppet-class <info|show> [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID of host
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID ID of Puppet class
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Puppet class name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
-h, --help Print help
Predefined field sets:
------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Smart class parameters/ | x | x |
Hostgroups/ | x | x |
Environments/ | x | x |
Parameters/ | x | x |
------------------------|-----|---------|-----2.59.2. hammer puppet-class list
List all Puppet classes
Usage:
hammer puppet-class <list|index> [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID ID of host
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
config_group string
environment string
host string
hostgroup string
key string
location string
name string
organization string2.59.3. hammer puppet-class sc-params
List all smart class parameters
Usage:
hammer puppet-class sc-params [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
--------------|-----|--------
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string2.60. hammer puppet-environment
Manipulate Puppet environments
Usage:
hammer puppet-environment [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an environment
delete, destroy Delete an environment
info, show Show an environment
list, index List all environments
sc-params List all smart class parameters
update Update an environment
Options:
-h, --help Print help2.60.1. hammer puppet-environment create
Create an environment
Usage:
hammer puppet-environment create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.60.2. hammer puppet-environment delete
Delete an environment
Usage:
hammer puppet-environment <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Puppet environment name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.60.3. hammer puppet-environment info
Show an environment
Usage:
hammer puppet-environment <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Puppet environment name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Puppetclasses/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.60.4. hammer puppet-environment list
List all environments
Usage:
hammer puppet-environment <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
content_view string
lifecycle_environment string
location string
location_id integer
name string
organization string
organization_id integer
Search / Order fields:
content_view string
lifecycle_environment string
location string
location_id integer
name string
organization string
organization_id integer2.60.5. hammer puppet-environment sc-params
List all smart class parameters
Usage:
hammer puppet-environment sc-params [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
Puppet class | x | x
Class Id | x | x
--------------|-----|--------
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string2.60.6. hammer puppet-environment update
Update an environment
Usage:
hammer puppet-environment update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Puppet environment name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.61. hammer puppet-module
View Puppet Module details
Usage:
hammer puppet-module [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a puppet module
list, index List puppet_modules
Options:
-h, --help Print help2.61.1. hammer puppet-module info
Show a puppet module
Usage:
hammer puppet-module <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID A puppet module identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Version | x | x |
Author | x | x |
Uuid | x | x |
Summary | x | x |
Description | x | x |
License | x | x |
Project Page | x | x |
Source | x | x |
Dependencies/ | x | x |
File checksums/ | x | x |
Tag List | x | x |
Repositories/Id | x | x |
Repositories/Name | x | x |
------------------|-----|---------|-----2.61.2. hammer puppet-module list
List puppet_modules
Usage:
hammer puppet-module <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
--content-view-filter-id CONTENT_VIEW_FILTER_ID Content view filter identifier
--content-view-filter-rule CONTENT_VIEW_FILTER_RULE_NAME Name to search by
--content-view-filter-rule-id CONTENT_VIEW_FILTER_RULE_ID Content view filter rule identifier
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--ids IDS Ids to filter content by
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Author | x | x |
Version | x | x |
Uuid | x | x |
--------|-----|---------|-----2.62. hammer realm
Manipulate realms
Usage:
hammer realm [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a realm
delete, destroy Delete a realm
info, show Show a realm
list, index List of realms
update Update a realm
Options:
-h, --help Print help2.62.1. hammer realm create
Create a realm
Usage:
hammer realm create [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME The realm name, e.g. EXAMPLE.COM
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realm-proxy-id REALM_PROXY_ID Capsule ID to use within this realm
--realm-type REALM_TYPE Realm type, e.g. Red Hat Identity Management or Active Directory
-h, --help Print help2.62.2. hammer realm delete
Delete a realm
Usage:
hammer realm <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.62.3. hammer realm info
Show a realm
Usage:
hammer realm <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Numerical ID or realm name
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Realm proxy id | x | x |
Realm type | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------|-----|---------|-----2.62.4. hammer realm list
List of realms
Usage:
hammer realm <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
location string
location_id integer
name string
organization string
organization_id integer
type string2.62.5. hammer realm update
Update a realm
Usage:
hammer realm update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Name to search by
--new-name NEW_NAME The realm name, e.g. EXAMPLE.COM
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--realm-proxy-id REALM_PROXY_ID Capsule ID to use within this realm
--realm-type REALM_TYPE Realm type, e.g. Red Hat Identity Management or Active Directory
-h, --help Print help2.63. hammer recurring-logic
Recurring logic related actions
Usage:
hammer recurring-logic [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
cancel Cancel recurring logic
delete Delete all recuring logics filtered by the arguments
info, show Show recurring logic details
list, index List recurring logics
Options:
-h, --help Print help2.63.1. hammer recurring-logic cancel
Cancel recurring logic
Usage:
hammer recurring-logic cancel [OPTIONS]
Options:
--id ID ID of the recurring logic
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.63.2. hammer 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 help2.63.3. hammer recurring-logic info
Show recurring logic details
Usage:
hammer recurring-logic <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID of the recurring logic
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
----------------|-----|--------
FIELDS | ALL | DEFAULT
----------------|-----|--------
ID | x | x
Cron line | x | x
Action | x | x
Last occurrence | x | x
Next occurrence | x | x
Iteration | x | x
Iteration limit | x | x
Repeat until | x | x
State | x | x
----------------|-----|--------2.63.4. hammer recurring-logic list
List recurring logics
Usage:
hammer recurring-logic <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
----------|-----|--------
FIELDS | ALL | DEFAULT
----------|-----|--------
ID | x | x
Cron line | x | x
Iteration | x | x
End time | x | x
State | x | x
----------|-----|--------2.64. hammer remote-execution-feature
Manage remote execution features
Usage:
hammer remote-execution-feature [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show remote execution feature
list, index List remote execution features
update Update a job template
Options:
-h, --help Print help2.64.1. hammer remote-execution-feature info
Show remote execution feature
Usage:
hammer remote-execution-feature <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------|-----|---------|-----
ID | x | x | x
Label | x | x |
Name | x | x | x
Description | x | x |
Job template name | x | x |
Job template ID | x | x |
------------------|-----|---------|-----2.64.2. hammer remote-execution-feature list
List remote execution features
Usage:
hammer remote-execution-feature <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Description | x | x |
Job template name | x | x |
------------------|-----|---------|-----2.64.3. hammer remote-execution-feature update
Update a job template
Usage:
hammer remote-execution-feature update [OPTIONS]
Options:
--id ID
--job-template JOB_TEMPLATE_NAME Name to search by
--job-template-id JOB_TEMPLATE_ID Job template ID to be used for the feature
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.65. hammer report
Browse and read reports
Usage:
hammer report [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete, destroy Delete a report
info, show Show a report
list, index List all reports
Options:
-h, --help Print help2.65.1. hammer report delete
Delete a report
Usage:
hammer report <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.65.2. hammer report info
Show a report
Usage:
hammer report <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Reported at | x | x |
Report status/Applied | x | x |
Report status/Restarted | x | x |
Report status/Failed | x | x |
Report status/Restart Failures | x | x |
Report status/Skipped | x | x |
Report status/Pending | x | x |
Report metrics/config_retrieval | x | x |
Report metrics/exec | x | x |
Report metrics/file | x | x |
Report metrics/package | x | x |
Report metrics/service | x | x |
Report metrics/user | x | x |
Report metrics/yumrepo | x | x |
Report metrics/filebucket | x | x |
Report metrics/cron | x | x |
Report metrics/total | x | x |
Logs/Resource | x | x |
Logs/Message | x | x |
--------------------------------|-----|---------|-----2.65.3. hammer report list
List all reports
Usage:
hammer report <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------|-----|---------|-----
Id | x | x | x
Host | x | x |
Last report | x | x |
Applied | x | x |
Restarted | x | x |
Failed | x | x |
Restart Failures | x | x |
Skipped | x | x |
Pending | x | x |
-----------------|-----|---------|-----
Search / Order fields:
applied integer
environment string
eventful Values: true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer
Search / Order fields:
applied integer
environment string
eventful Values: true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer2.66. hammer report-template
Manipulate report templates
Usage:
hammer report-template [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
clone Clone a template
create Create a report template
delete, destroy Delete a report template
dump View report content
generate Generate report
import Import a report template
info, show Show a report template
list, index List all report templates
report-data Downloads a generated report
schedule Schedule generating of a report
update Update a report template
Options:
-h, --help Print help2.66.1. hammer report-template clone
Clone a template
Usage:
hammer report-template clone [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.66.2. hammer report-template create
Create a report template
Usage:
hammer report-template create [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--default DEFAULT Whether or not the template is added automatically to new organizations and
Locations
One of true/false, yes/no, 1/0.
--description DESCRIPTION
--file LAYOUT Path to a file that contains the report template content
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--snippet SNIPPET One of true/false, yes/no, 1/0.
-h, --help Print help
-i, --interactive Open empty template in an $EDITOR. Upload the result2.66.3. hammer report-template delete
Delete a report template
Usage:
hammer report-template <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.66.4. hammer report-template dump
View report content
Usage:
hammer report-template dump [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------
FIELDS
------2.66.5. hammer report-template generate
Generate report
Usage:
hammer report-template generate [OPTIONS]
Options:
--gzip GZIP Compress the report uzing gzip
One of true/false, yes/no, 1/0.
--id ID
--inputs INPUTS Specify inputs
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--path PATH Path to directory where downloaded content will be saved
--report-format REPORT_FORMAT Report format, defaults to 'csv'
Possible value(s): 'csv', 'json', 'yaml', 'html'
-h, --help Print help2.66.6. hammer report-template import
Import a report template
Usage:
hammer report-template import [OPTIONS]
Options:
--associate ASSOCIATE 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 DEFAULT Makes the template default meaning it will be automatically associated with
Newly created organizations and locations (false by default)
One of true/false, yes/no, 1/0.
--file PATH Path to a file that contains the report template content including metadata
--force FORCE Use if you want update locked templates
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--lock LOCK Lock imported templates (false by default)
One of true/false, yes/no, 1/0.
--name NAME Template name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.66.7. hammer report-template info
Show a report template
Usage:
hammer report-template <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
----------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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 |
----------------------------|-----|---------|-----2.66.8. hammer report-template list
List all report templates
Usage:
hammer report-template <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
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 text2.66.9. hammer report-template report-data
Downloads a generated report
Usage:
hammer report-template report-data [OPTIONS]
Options:
--id ID
--job-id JOB_ID ID assigned to generating job by the schedule command
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--path PATH Path to directory where downloaded content will be saved
-h, --help Print help2.66.10. hammer report-template schedule
Schedule generating of a report
Usage:
hammer report-template schedule [OPTIONS]
Options:
--generate-at GENERATE_AT UTC time to generate report at
--gzip GZIP Compress the report using gzip
One of true/false, yes/no, 1/0.
--id ID
--inputs INPUTS Specify inputs
Comma-separated list of key=value.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mail-to MAIL_TO If set, scheduled report will be delivered via e-mail. Use ',' to
Separate multiple email addresses.
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--path PATH Path to directory where downloaded content will be saved. Only usable if wait is specified
--report-format REPORT_FORMAT 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 help2.66.11. hammer report-template update
Update a report template
Usage:
hammer report-template update [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--default DEFAULT Whether or not the template is added automatically to new organizations and
Locations
One of true/false, yes/no, 1/0.
--description DESCRIPTION
--file REPORT Path to a file that contains the report template content
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--snippet SNIPPET One of true/false, yes/no, 1/0.
-h, --help Print help
-i, --interactive Dump existing template and open it in an $EDITOR. Update with the result2.67. hammer repository
Manipulate repositories
Usage:
hammer repository [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a custom repository
delete, destroy Destroy a custom repository
export Export content from a repository to the configured directory
info, show Show a repository
list, index List of enabled repositories
remove-content Remove content from a repository
synchronize Sync a repository
update Update a repository
upload-content Upload content into the repository
Options:
-h, --help Print help2.67.1. hammer repository create
Create a custom repository
Usage:
hammer repository create [OPTIONS]
Options:
--ansible-collection-requirements ANSIBLE_COLLECTION_REQUIREMENTS Contents of requirement yaml file to sync from URL
--checksum-type CHECKSUM_TYPE Checksum of the repository, currently 'sha1' & 'sha256'
Are supported
--content-type CONTENT_TYPE Type of repo
Possible value(s): 'docker', 'file', 'ostree', 'puppet', 'yum'
--deb-architectures DEB_ARCHITECTURES Comma-separated list of architectures to be synced from deb-archive
--deb-components DEB_COMPONENTS Comma-separated list of repo components to be synced from deb-archive
--deb-releases DEB_RELEASES Comma-separated list of releases to be synced from deb-archive
--description DESCRIPTION Description of the repository
--docker-tags-whitelist DOCKER_TAGS_WHITELIST Comma-separated list of tags to sync for Container Image repository
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--docker-upstream-name DOCKER_UPSTREAM_NAME Name of the upstream docker repository
--download-concurrency DOWNLOAD_CONCURRENCY Used to determine download concurrency of the repository in pulp3. Use
Value less than 20. Defaults to 10
--download-policy DOWNLOAD_POLICY Download policy for yum repos (either 'immediate',
'on_demand', or 'background (deprecated)')
Possible value(s): 'immediate', 'on_demand', 'background'
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID Id of the gpg key that will be assigned to the new repository
--http-proxy HTTP_PROXY_NAME Name to search by
--http-proxy-id HTTP_PROXY_ID ID of a HTTP Proxy
--http-proxy-policy HTTP_PROXY_POLICY Policies for HTTP Proxy for content sync
Possible value(s): 'global_default_http_proxy', 'none', 'use_selected_http_proxy'
--ignorable-content IGNORABLE_CONTENT List of content units to ignore while syncing a yum repository. Must be
Subset of rpm,drpm,srpm,distribution,erratum
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ignore-global-proxy IGNORE_GLOBAL_PROXY If true, will ignore the globally configured Capsule when syncing
One of true/false, yes/no, 1/0.
--label LABEL
--mirror-on-sync MIRROR_ON_SYNC True if this repository when synced has to be mirrored from the source and
Stale rpms removed
One of true/false, yes/no, 1/0.
--name NAME Name of the repository
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--os-versions OS_VERSIONS Identifies whether the repository should be disabled on a client with a
Non-matching OS version. Pass [] to enable regardless of OS version.
Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ostree-upstream-sync-depth OSTREE_UPSTREAM_SYNC_DEPTH If a custom sync policy is chosen for ostree repositories then a
'depth' value must be provided
--ostree-upstream-sync-policy OSTREE_UPSTREAM_SYNC_POLICY Policies for syncing upstream ostree repositories
Possible value(s): 'latest', 'all', 'custom'
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product the repository belongs to
--publish-via-http ENABLE Publish Via HTTP
One of true/false, yes/no, 1/0.
--ssl-ca-cert SSL_CA_CERT Name of content credential containing CA certificate
--ssl-ca-cert-id SSL_CA_CERT_ID Identifier of the content credential containing the SSL CA Cert
--ssl-client-cert SSL_CLIENT_CERT Name of content credential containing client certificate
--ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the content credential containing the SSL Client Cert
--ssl-client-key SSL_CLIENT_KEY Name of content credential containing client key
--ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the content credential containing the SSL Client Key
--upstream-password UPSTREAM_PASSWORD Password of the upstream repository user used for authentication
--upstream-username UPSTREAM_USERNAME Username of the upstream repository user used for authentication
--url URL Repository source url
--verify-ssl-on-sync VERIFY_SSL_ON_SYNC If true, Katello will verify the upstream url's SSL certifcates are
Signed by a trusted CA
One of true/false, yes/no, 1/0.
-h, --help Print help2.67.2. hammer repository delete
Destroy a custom repository
Usage:
hammer repository <delete|destroy> [OPTIONS]
Options:
--id ID
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
-h, --help Print help2.67.3. hammer repository export
Export content from a repository to the configured directory
Usage:
hammer repository export [OPTIONS]
Options:
--async Do not wait for the task
--export-to-iso EXPORT_TO_ISO Export to ISO format
One of true/false, yes/no, 1/0.
--id ID Repository identifier
--iso-mb-size ISO_MB_SIZE Maximum size of each ISO in MB
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--since SINCE Optional date of last export (ex: 2010-01-01T12:00:00Z)
-h, --help Print help2.67.4. hammer repository info
Show a repository
Usage:
hammer repository <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Repository ID
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
-h, --help Print help
Predefined field sets:
----------------------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------------------------------|-----|---------|-----
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 |
Checksum Type | x | x |
Mirror on Sync | x | x |
URL | x | x |
Publish Via HTTP | x | x |
Published At | x | x |
Relative Path | x | x |
Download Policy | x | x |
OSTree Upstream Sync Policy | x | x |
OSTree Upstream Sync Depth | x | x |
Upstream Repository Name | x | x |
Container Image Tags Filter | x | x |
Container Repository Name | x | x |
Ignorable Content Units | 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/Source RPMS | x | x |
Content Counts/Package Groups | x | x |
Content Counts/Errata | x | x |
Content Counts/Puppet Modules | x | x |
Content Counts/Container Image Manifest Lists | x | x |
Content Counts/Container Image Manifests | x | x |
Content Counts/Container Image Tags | x | x |
Content Counts/OSTree Branches | x | x |
Content Counts/Files | x | x |
Content Counts/Module Streams | x | x |
----------------------------------------------|-----|---------|-----2.67.5. hammer repository list
List of enabled repositories
Usage:
hammer repository <list|index> [OPTIONS]
Options:
--ansible-collection ANSIBLE_COLLECTION_NAME Name to search by
--ansible-collection-id ANSIBLE_COLLECTION_ID Id of an ansible collection to find repositories that contain the ansible
Collection
--archived ARCHIVED Show archived repositories
One of true/false, yes/no, 1/0.
--available-for AVAILABLE_FOR Interpret specified object to return only Repositories that can be
Associated with specified object. Only 'content_view' &
'content_view_version' are supported.
--content-type CONTENT_TYPE Limit to only repositories of this type
Possible value(s): 'docker', 'file', 'ostree', 'puppet', 'yum'
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID ID of a content view to show repositories in
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID ID of a content view version to show repositories in
--deb DEB_NAME Name to search by
--deb-id DEB_ID Id of a deb package to find repositories that contain the deb
--description DESCRIPTION Description of the repository
--download-policy DOWNLOAD_POLICY Limit to only repositories with this download policy
Possible value(s): 'immediate', 'on_demand', 'background'
--environment ENVIRONMENT_NAME Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --lifecycle-environment-id instead)
--erratum-id ERRATUM_ID Id of an erratum to find repositories that contain the erratum
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--file-id FILE_ID Id of a file to find repositories that contain the file
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--label LABEL Label of the repository
--library LIBRARY Show repositories in Library and the default content view
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Name of the repository
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID ID of an organization to show repositories in
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--ostree-branch OSTREE_BRANCH_NAME Name to search by
--ostree-branch-id OSTREE_BRANCH_ID Id of an ostree branch to find repositories that contain that branch
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID ID of a product to show repositories of
--rpm-id RPM_ID Id of a rpm package to find repositories that contain the rpm
--search SEARCH Search string
--with-content WITH_CONTENT Only repositories having at least one of the specified content type ex: rpm
, erratum
Possible value(s): 'docker_manifest', 'docker_manifest_list', 'docker_tag', 'docker_blob', 'file', 'ostree', 'puppet_module', 'rpm', 'modulemd', 'erratum', 'distribution', 'package_category', 'package_group', 'yum_repo_metadata_file', 'srpm'
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Product | x | x |
Content Type | 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, false2.67.6. hammer repository remove-content
Remove content from a repository
Usage:
hammer repository remove-content [OPTIONS]
Options:
--content-type CONTENT_TYPE Content type ('deb', 'docker_manifest', 'file',
'ostree', 'puppet_module', 'rpm', 'srpm')
Possible value(s): 'docker_manifest', 'file', 'ostree', 'puppet_module', 'rpm', 'srpm'
--id ID Repository ID
--ids IDS Array of content ids to remove
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--sync-capsule SYNC_CAPSULE Whether or not to sync an external capsule after upload. Default: true
One of true/false, yes/no, 1/0.
-h, --help Print help2.67.7. hammer repository synchronize
Sync a repository
Usage:
hammer repository synchronize [OPTIONS]
Options:
--async Do not wait for the task
--id ID Repository ID
--incremental INCREMENTAL Perform an incremental import
One of true/false, yes/no, 1/0.
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--skip-metadata-check SKIP_METADATA_CHECK Force sync even if no upstream changes are detected. Only used with yum
Repositories.
One of true/false, yes/no, 1/0.
--source-url SOURCE_URL Temporarily override feed URL for sync
--validate-contents VALIDATE_CONTENTS Force a sync and validate the checksums of all content. Only used with yum
Repositories.
One of true/false, yes/no, 1/0.
-h, --help Print help2.67.8. hammer repository update
Update a repository
Usage:
hammer repository update [OPTIONS]
Options:
--ansible-collection-requirements ANSIBLE_COLLECTION_REQUIREMENTS Contents of requirement yaml file to sync from URL
--checksum-type CHECKSUM_TYPE Checksum of the repository, currently 'sha1' & 'sha256'
Are supported
--deb-architectures DEB_ARCHITECTURES Comma-separated list of architectures to be synced from deb-archive
--deb-components DEB_COMPONENTS Comma-separated list of repo components to be synced from deb-archive
--deb-releases DEB_RELEASES Comma-separated list of releases to be synced from deb-archive
--description DESCRIPTION Description of the repository
--docker-digest DIGEST Container Image manifest digest
--docker-tag TAG Container Image tag
--docker-tags-whitelist DOCKER_TAGS_WHITELIST Comma-separated list of tags to sync for Container Image repository
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--docker-upstream-name DOCKER_UPSTREAM_NAME Name of the upstream docker repository
--download-concurrency DOWNLOAD_CONCURRENCY Used to determine download concurrency of the repository in pulp3. Use
value less than 20. Defaults to 10
--download-policy DOWNLOAD_POLICY Download policy for yum repos (either 'immediate',
'on_demand', or 'background (deprecated)')
Possible value(s): 'immediate', 'on_demand', 'background'
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID Id of the gpg key that will be assigned to the new repository
--http-proxy HTTP_PROXY_NAME Name to search by
--http-proxy-id HTTP_PROXY_ID ID of a HTTP Proxy
--http-proxy-policy HTTP_PROXY_POLICY Policies for HTTP Proxy for content sync
Possible value(s): 'global_default_http_proxy', 'none', 'use_selected_http_proxy'
--id ID Repository ID
--ignorable-content IGNORABLE_CONTENT List of content units to ignore while syncing a yum repository. Must be
Subset of rpm,drpm,srpm,distribution,erratum
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ignore-global-proxy IGNORE_GLOBAL_PROXY If true, will ignore the globally configured Capsule when syncing
One of true/false, yes/no, 1/0.
--mirror-on-sync MIRROR_ON_SYNC True if this repository when synced has to be mirrored from the source and
Stale rpms removed
One of true/false, yes/no, 1/0.
--name NAME Repository name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID to search by
--organization-label ORGANIZATION_LABEL Organization label to search by
--os-versions OS_VERSIONS Identifies whether the repository should be disabled on a client with a
Non-matching OS version. Pass [] to enable regardless of OS version.
Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--ostree-upstream-sync-depth OSTREE_UPSTREAM_SYNC_DEPTH If a custom sync policy is chosen for ostree repositories then a
'depth' value must be provided
--ostree-upstream-sync-policy OSTREE_UPSTREAM_SYNC_POLICY Policies for syncing upstream ostree repositories
Possible value(s): 'latest', 'all', 'custom'
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--publish-via-http ENABLE Publish Via HTTP
One of true/false, yes/no, 1/0.
--ssl-ca-cert-id SSL_CA_CERT_ID Identifier of the content credential containing the SSL CA Cert
--ssl-client-cert-id SSL_CLIENT_CERT_ID Identifier of the content credential containing the SSL Client Cert
--ssl-client-key-id SSL_CLIENT_KEY_ID Identifier of the content credential containing the SSL Client Key
--upstream-password UPSTREAM_PASSWORD Password of the upstream repository user used for authentication
--upstream-username UPSTREAM_USERNAME Username of the upstream repository user used for authentication
--url URL Repository source url
--verify-ssl-on-sync VERIFY_SSL_ON_SYNC If true, Katello will verify the upstream url's SSL certifcates are
Signed by a trusted CA
One of true/false, yes/no, 1/0.
-h, --help Print help2.67.9. hammer repository upload-content
Upload content into the repository
Usage:
hammer repository upload-content [OPTIONS]
Options:
--content-type CONTENT_TYPE Content type ('deb', 'docker_manifest', 'file',
'ostree', 'puppet_module', 'rpm', 'srpm')
Possible value(s): 'docker_manifest', 'file', 'ostree', 'puppet_module', 'rpm', 'srpm'
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Repository ID
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--path PATH Upload file, directory of files, or glob of files as content for a repository.
Globs must be escaped by single or double quotes
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
-h, --help Print help
Predefined field sets:
------
FIELDS
------2.68. hammer repository-set
Manipulate repository sets on the server
Usage:
hammer repository-set [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
available-repositories Get list of available repositories for the repository set
disable Disable a repository from the set
enable Enable a repository from the set
info, show Get info about a repository set
list, index List repository sets.
Options:
-h, --help Print help2.68.1. hammer repository-set available-repositories
Get list of available repositories for the repository set
Usage:
hammer repository-set available-repositories [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID of the repository set
--name NAME Repository set name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID ID of a product to list repository sets from
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
Name | x | x | x
Arch | x | x |
Release | x | x |
Registry Name | x | x |
Enabled | x | x |
--------------|-----|---------|-----2.68.2. hammer repository-set disable
Disable a repository from the set
Usage:
hammer repository-set disable [OPTIONS]
Options:
--basearch BASEARCH Basearch to disable
--id ID ID of the repository set to disable
--name NAME Repository set name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID ID of the product containing the repository set
--releasever RELEASEVER Releasever to disable
-h, --help Print help2.68.3. hammer repository-set enable
Enable a repository from the set
Usage:
hammer repository-set enable [OPTIONS]
Options:
--basearch BASEARCH Basearch to enable
--id ID ID of the repository set to enable
--name NAME Repository set name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID ID of the product containing the repository set
--releasever RELEASEVER Releasever to enable
-h, --help Print help2.68.4. hammer repository-set info
Get info about a repository set
Usage:
hammer repository-set <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID of the repository set
--name NAME Repository set name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID ID of a product to list repository sets from
-h, --help Print help
Predefined field sets:
--------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Type | x | x |
URL | x | x |
GPG Key | x | x |
Label | x | x |
Enabled Repositories/ID | x | x |
Enabled Repositories/Name | x | x |
--------------------------|-----|---------|-----2.68.5. hammer repository-set list
List repository sets.
Usage:
hammer repository-set <list|index> [OPTIONS]
Options:
--enabled ENABLED If true, only return repository sets that have been enabled. Defaults to
False
One of true/false, yes/no, 1/0.
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Repository set name to search on
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID ID of a product to list repository sets from
--search SEARCH Search string
--with-active-subscription WITH_ACTIVE_SUBSCRIPTION If true, only return repository sets that are associated with an active
Subscriptions
One of true/false, yes/no, 1/0.
--with-custom WITH_CUSTOM If true, return custom repository sets along with redhat repos
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
ID | x | x | x
Type | x | x |
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
content_label string
content_type string
label string
name string
product_id integer
product_name string2.69. hammer role
Manage user roles
Usage:
hammer role [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
clone Clone a role
create Create a role
delete, destroy Delete a role
filters List all filters
info, show Show a role
list, index List all roles
update Update a role
Options:
-h, --help Print help2.69.1. hammer role clone
Clone a role
Usage:
hammer role clone [OPTIONS]
Options:
--description DESCRIPTION Role description
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME User role name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.69.2. hammer role create
Create a role
Usage:
hammer role create [OPTIONS]
Options:
--description DESCRIPTION Role description
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.69.3. hammer role delete
Delete a role
Usage:
hammer role <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME User role name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.69.4. hammer role filters
List all filters
Usage:
hammer role filters [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID User role id
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME User role name
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
Id | x | x | x
Resource type | x | x |
Search | x | x |
Unlimited? | x | x |
Override? | x | x |
Role | x | x |
Permissions | x | x |
--------------|-----|---------|-----2.69.5. hammer role info
Show a role
Usage:
hammer role <info|show> [OPTIONS]
Options:
--description DESCRIPTION
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME User role name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Builtin | x | x |
Description | x | x |
Locations/ | x | x |
Organizations/ | x | x |
---------------|-----|---------|-----2.69.6. hammer role list
List all roles
Usage:
hammer role <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Builtin | x | x |
--------|-----|---------|-----
Search / Order fields:
builtin Values: true, false
description text
name string
permission string2.69.7. hammer role update
Update a role
Usage:
hammer role update [OPTIONS]
Options:
--description DESCRIPTION Role description
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME User role name
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.70. hammer sc-param
Manipulate smart class parameters
Usage:
hammer sc-param [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-matcher Create an override value for a specific smart class parameter
info, show Show a smart class parameter
list, index List all smart class parameters
remove-matcher Delete an override value for a specific smart class parameter
update Update a smart class parameter
Options:
-h, --help Print help2.70.1. hammer sc-param add-matcher
Create an override value for a specific smart class parameter
Usage:
hammer sc-param add-matcher [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--match MATCH Override match
--omit OMIT Satellite will not send this parameter in classification output
One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID ID of Puppet class
--smart-class-parameter SMART_CLASS_PARAMETER_NAME Smart class parameter name
--smart-class-parameter-id SMART_CLASS_PARAMETER_ID
--value VALUE Override value, required if omit is false
-h, --help Print help2.70.2. hammer sc-param info
Show a smart class parameter
Usage:
hammer sc-param <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Smart class parameter name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID ID of Puppet class
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
------------------------------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
Puppet class | x | x
Class Id | x | x
Description | x | x
Type | x | x
Hidden Value? | x | x
Omit | x | x
Required | x | x
Validator/Type | x | x
Validator/Rule | 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
Override values/Values/Omit | x | x
Environments/ | x | x
Created at | x | x
Updated at | x | x
------------------------------------|-----|--------2.70.3. hammer sc-param list
List all smart class parameters
Usage:
hammer sc-param <list|index> [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--host HOST_NAME Host name
--host-id HOST_ID
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
--search SEARCH Filter results
--show-hidden SHOW_HIDDEN Display hidden values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
--------------|-----|--------
FIELDS | ALL | DEFAULT
--------------|-----|--------
Id | x | x
Parameter | x | x
Default Value | x | x
Override | x | x
Puppet class | x | x
Class Id | x | x
--------------|-----|--------
Search / Order fields:
avoid_duplicates Values: true, false
environment string
key string
merge_default Values: true, false
merge_overrides Values: true, false
override Values: true, false
parameter string
puppetclass string
puppetclass_name string2.70.4. hammer sc-param remove-matcher
Delete an override value for a specific smart class parameter
Usage:
hammer sc-param remove-matcher [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID ID of Puppet class
--smart-class-parameter SMART_CLASS_PARAMETER_NAME Smart class parameter name
--smart-class-parameter-id SMART_CLASS_PARAMETER_ID
-h, --help Print help2.70.5. hammer sc-param update
Update a smart class parameter
Usage:
hammer sc-param update [OPTIONS]
Options:
--avoid-duplicates AVOID_DUPLICATES Remove duplicate values (only array type)
One of true/false, yes/no, 1/0.
--default-value VALUE Value to use when there is no match
--description DESCRIPTION Description of smart class
--hidden-value HIDDEN_VALUE When enabled the parameter is hidden in the UI
One of true/false, yes/no, 1/0.
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--merge-default MERGE_DEFAULT Include default value when merging all matching values
One of true/false, yes/no, 1/0.
--merge-overrides MERGE_OVERRIDES Merge all matching values (only array/hash type)
One of true/false, yes/no, 1/0.
--name NAME Smart class parameter name
--omit OMIT Satellite will not send this parameter in classification output. Puppet
Will use the value defined in the Puppet manifest for this parameter
One of true/false, yes/no, 1/0.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--override OVERRIDE Override this parameter
One of true/false, yes/no, 1/0.
--override-value-order OVERRIDE_VALUE_ORDER The order in which values are resolved
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
--path PATH The order in which values are resolved
--puppet-class PUPPET_CLASS_NAME Puppet class name
--puppet-class-id PUPPET_CLASS_ID ID of Puppet class
--required REQUIRED This parameter is required
One of true/false, yes/no, 1/0.
--validator-rule VALIDATOR_RULE Used to enforce certain values for the parameter values
--validator-type VALIDATOR_TYPE Type of the validator
Possible value(s): 'regexp', 'list', ''
-h, --help Print help2.71. hammer scap-content
Manipulate SCAP contents
Usage:
hammer scap-content [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
bulk-upload Upload scap contents in bulk
create Create SCAP content
delete, destroy Deletes an SCAP content
download Download an SCAP content as XML
info, show Show an SCAP content
list, index List SCAP contents
update Update an SCAP content
Options:
-h, --help Print help2.71.1. hammer scap-content bulk-upload
Upload scap contents in bulk
Usage:
hammer scap-content bulk-upload [OPTIONS]
Options:
--directory DIRECTORY Directory to upload when using “directory” upload type
--files FILES File paths to upload when using “files” upload type
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--type TYPE Type of the upload
Possible value(s): 'files', 'directory', 'default'
-h, --help Print help2.71.2. hammer scap-content create
Create SCAP content
Usage:
hammer scap-content create [OPTIONS]
Options:
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--original-filename ORIGINAL_FILENAME Original file name of the XML file
--scap-file SCAP_FILE SCAP content file
--title TITLE SCAP content name
-h, --help Print help2.71.3. hammer scap-content delete
Deletes an SCAP content
Usage:
hammer scap-content <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--title TITLE SCAP content title
-h, --help Print help2.71.4. hammer scap-content download
Download an SCAP content as XML
Usage:
hammer scap-content download [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--path PATH Path to directory where downloaded file will be saved
--title TITLE SCAP content title
-h, --help Print help2.71.5. hammer scap-content info
Show an SCAP content
Usage:
hammer scap-content <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--title TITLE SCAP content title
-h, --help Print help
Predefined field sets:
---------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------------------|-----|---------|-----
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 |
---------------------------------|-----|---------|-----2.71.6. hammer scap-content list
List SCAP contents
Usage:
hammer scap-content <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
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 string2.71.7. hammer scap-content update
Update an SCAP content
Usage:
hammer scap-content update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--new-title NEW_TITLE SCAP content name
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--original-filename ORIGINAL_FILENAME Original file name of the XML file
--scap-file SCAP_FILE SCAP content file
--title TITLE SCAP content title
-h, --help Print help2.72. hammer scap-content-profile
Manipulate Scap Content Profiles
Usage:
hammer scap-content-profile [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
list, index List SCAP content profiles
Options:
-h, --help Print help2.72.1. hammer scap-content-profile list
List SCAP content profiles
Usage:
hammer scap-content-profile <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
Id | x | x | x
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 string2.73. hammer settings
Change server settings
Usage:
hammer settings [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show a setting
list, index List all settings
set Update a setting
Options:
-h, --help Print help2.73.1. hammer settings info
Show a setting
Usage:
hammer settings <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Setting name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Description | x | x |
Category | x | x |
Settings type | x | x |
Value | x | x |
--------------|-----|---------|-----2.73.2. hammer settings list
List all settings
Usage:
hammer settings <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Full name | x | x |
Value | x | x |
Description | x | x |
------------|-----|---------|-----
Search / Order fields:
description text
name string2.73.3. hammer settings set
Update a setting
Usage:
hammer settings set [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Setting name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--value VALUE
-h, --help Print help2.74. hammer shell
Interactive shell
Usage:
hammer shell [OPTIONS]
Options:
-h, --help Print help2.75. hammer srpm
Manipulate source RPMs
Usage:
hammer srpm [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show SRPM details
list, index List srpms
Options:
-h, --help Print help2.75.1. hammer srpm info
Show SRPM details
Usage:
hammer srpm <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID SRPM details identifier
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Version | x | x |
Architecture | x | x |
Epoch | x | x |
Release | x | x |
Filename | x | x |
Description | x | x |
-------------|-----|---------|-----2.75.2. hammer srpm list
List srpms
Usage:
hammer srpm <list|index> [OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name to search by
--content-view-id CONTENT_VIEW_ID Content view numeric identifier
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
--content-view-version-id CONTENT_VIEW_VERSION_ID Content View Version identifier
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Lifecycle environment name to search by
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization identifier
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID Product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID Repository identifier
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
---------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Filename | x | x |
---------|-----|---------|-----2.76. hammer status
Get the complete status of the server and/or it’s subcomponents
Usage:
hammer status [OPTIONS] [SUBCOMMAND] [ARG] ...
Parameters:
[ARG] ... Subcommand arguments
[SUBCOMMAND] Subcommand (default: "foreman")
Subcommands:
foreman Shows status and version information of Satellite system and it's subcomponents
katello Shows version information
Options:
-h, --help Print help2.76.1. hammer status foreman
Shows status and version information of Satellite system and it’s subcomponents
Usage:
hammer status foreman [OPTIONS]
Options:
-h, --help Print help2.76.2. hammer status katello
Shows version information
Usage:
hammer status katello [OPTIONS]
Options:
-h, --help Print help2.77. hammer subnet
Manipulate subnets
Usage:
hammer subnet [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a subnet
delete, destroy Delete a subnet
delete-parameter Delete parameter for a subnet
info, show Show a subnet
list, index List of subnets
set-parameter Create or update parameter for a subnet
update Update a subnet
Options:
-h, --help Print help2.77.1. hammer subnet create
Create a subnet
Usage:
hammer subnet create [OPTIONS]
Options:
--bmc-id BMC_ID BMC Capsule ID to use within this subnet
--boot-mode BOOT_MODE Default boot mode for interfaces assigned to this subnet.
Possible value(s): 'Static', 'DHCP'
--description DESCRIPTION Subnet description
--dhcp DHCP_NAME DHCP Proxy to use within this subnet
--dhcp-id DHCP_ID DHCP Capsule ID to use within this subnet
--discovery-id DISCOVERY_ID ID of Discovery Capsule to use within this subnet for managing connection
To discovered hosts
--dns DNS_NAME DNS Proxy to use within this subnet
--dns-id DNS_ID DNS Capsule ID to use within this subnet
--dns-primary DNS_PRIMARY Primary DNS for this subnet
--dns-secondary DNS_SECONDARY Secondary DNS for this subnet
--domain-ids DOMAIN_IDS Domains in which this subnet is part
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--externalipam-group EXTERNALIPAM_GROUP External IPAM group - only relevant when IPAM is set to external
--externalipam-id EXTERNALIPAM_ID External IPAM Capsule ID to use within this subnet
--from FROM Starting IP Address for IP auto suggestion
--gateway GATEWAY Subnet gateway
--httpboot-id HTTPBOOT_ID HTTPBoot Capsule ID to use within this subnet
--ipam IPAM IP Address auto suggestion mode for this subnet.
Possible value(s): 'DHCP', 'Internal DB', 'Random DB', 'EUI-64', 'External IPAM', 'None'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--mask MASK Netmask for this subnet
--mtu MTU MTU for this subnet
--name NAME Subnet name
--network NETWORK Subnet network
--network-type NETWORK_TYPE Type or protocol, IPv4 or IPv6, defaults to IPv4
Possible value(s): 'IPv4', 'IPv6'
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--prefix PREFIX Network prefix in CIDR notation (e.g. 64) for this subnet
--remote-execution-proxy-ids REMOTE_EXECUTION_PROXY_IDS List of Capsule IDs to be used for remote execution
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--template-id TEMPLATE_ID Template HTTP(S) Capsule ID to use within this subnet
--tftp TFTP_NAME TFTP Proxy to use within this subnet
--tftp-id TFTP_ID TFTP Capsule ID to use within this subnet
--to TO Ending IP Address for IP auto suggestion
--vlanid VLANID VLAN ID for this subnet
-h, --help Print help2.77.2. hammer subnet delete
Delete a subnet
Usage:
hammer subnet <delete|destroy> [OPTIONS]
Options:
--id ID Subnet numeric identifier
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Subnet name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.77.3. hammer subnet delete-parameter
Delete parameter for a subnet
Usage:
hammer subnet delete-parameter [OPTIONS]
Options:
--name NAME Parameter name
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
-h, --help Print help2.77.4. hammer subnet info
Show a subnet
Usage:
hammer subnet <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Subnet name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Description | x | x |
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 |
------------------------------|-----|---------|-----2.77.5. hammer subnet list
List of subnets
Usage:
hammer subnet <list|index> [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID ID of domain
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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
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 integer2.77.6. hammer subnet set-parameter
Create or update parameter for a subnet
Usage:
hammer subnet set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--value VALUE Parameter value
-h, --help Print help2.77.7. hammer subnet update
Update a subnet
Usage:
hammer subnet update [OPTIONS]
Options:
--bmc-id BMC_ID BMC Capsule ID to use within this subnet
--boot-mode BOOT_MODE Default boot mode for interfaces assigned to this subnet.
Possible value(s): 'Static', 'DHCP'
--description DESCRIPTION Subnet description
--dhcp DHCP_NAME DHCP Proxy to use within this subnet
--dhcp-id DHCP_ID DHCP Capsule ID to use within this subnet
--discovery-id DISCOVERY_ID ID of Discovery Capsule to use within this subnet for managing connection
To discovered hosts
--dns DNS_NAME DNS Proxy to use within this subnet
--dns-id DNS_ID DNS Capsule ID to use within this subnet
--dns-primary DNS_PRIMARY Primary DNS for this subnet
--dns-secondary DNS_SECONDARY Secondary DNS for this subnet
--domain-ids DOMAIN_IDS Domains in which this subnet is part
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--externalipam-group EXTERNALIPAM_GROUP External IPAM group - only relevant when IPAM is set to external
--externalipam-id EXTERNALIPAM_ID External IPAM Capsule ID to use within this subnet
--from FROM Starting IP Address for IP auto suggestion
--gateway GATEWAY Subnet gateway
--httpboot-id HTTPBOOT_ID HTTPBoot Capsule ID to use within this subnet
--id ID Subnet numeric identifier
--ipam IPAM IP Address auto suggestion mode for this subnet.
Possible value(s): 'DHCP', 'Internal DB', 'Random DB', 'EUI-64', 'External IPAM', 'None'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--mask MASK Netmask for this subnet
--mtu MTU MTU for this subnet
--name NAME Subnet name
--network NETWORK Subnet network
--network-type NETWORK_TYPE Type or protocol, IPv4 or IPv6, defaults to IPv4
Possible value(s): 'IPv4', 'IPv6'
--new-name NEW_NAME Subnet name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--prefix PREFIX Network prefix in CIDR notation (e.g. 64) for this subnet
--remote-execution-proxy-ids REMOTE_EXECUTION_PROXY_IDS List of Capsule IDs to be used for remote execution
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--template-id TEMPLATE_ID Template HTTP(S) Capsule ID to use within this subnet
--tftp TFTP_NAME TFTP Proxy to use within this subnet
--tftp-id TFTP_ID TFTP Capsule ID to use within this subnet
--to TO Ending IP Address for IP auto suggestion
--vlanid VLANID VLAN ID for this subnet
-h, --help Print help2.78. hammer subscription
Manipulate subscriptions
Usage:
hammer subscription [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
delete-manifest Delete manifest from Red Hat provider
list, index List organization subscriptions
manifest-history Obtain manifest history for subscriptions
refresh-manifest Refresh previously imported manifest for Red Hat provider
upload Upload a subscription manifest
Options:
-h, --help Print help2.78.1. hammer subscription delete-manifest
Delete manifest from Red Hat provider
Usage:
hammer subscription delete-manifest [OPTIONS]
Options:
--async Do not wait for the task
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization id
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.78.2. hammer subscription list
List organization subscriptions
Usage:
hammer subscription <list|index> [OPTIONS]
Options:
--activation-key ACTIVATION_KEY_NAME Activation key name to search by
--activation-key-id ACTIVATION_KEY_ID Activation key ID
--available-for AVAILABLE_FOR Object to show subscriptions available for, either 'host' or
'activation_key'
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--host HOST_NAME Host name
--host-id HOST_ID Id of a host
--match-host MATCH_HOST Ignore subscriptions that are unavailable to the specified host
One of true/false, yes/no, 1/0.
--match-installed MATCH_INSTALLED Return subscriptions that match installed products of the specified host
One of true/false, yes/no, 1/0.
--no-overlap NO_OVERLAP Return subscriptions which do not overlap with a currently-attached
Subscription
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help Print help
Predefined field sets:
-----------|-----|--------
FIELDS | ALL | DEFAULT
-----------|-----|--------
ID | x | x
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
-----------|-----|--------2.78.3. hammer subscription manifest-history
obtain manifest history for subscriptions
Usage:
hammer subscription manifest-history [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
---------------|-----|--------
FIELDS | ALL | DEFAULT
---------------|-----|--------
Status | x | x
Status Message | x | x
Time | x | x
---------------|-----|--------2.78.4. hammer 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 ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization id
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.78.5. hammer subscription upload
Upload a subscription manifest
Usage:
hammer subscription upload [OPTIONS]
Options:
--async Do not wait for the task
--file MANIFEST Subscription manifest file
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization id
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--repository-url REPOSITORY_URL Repository url
-h, --help Print help2.79. hammer sync-plan
Manipulate sync plans
Usage:
hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a sync plan
delete, destroy Destroy a sync plan
info, show Show a sync plan
list, index List sync plans
update Update a sync plan
Options:
-h, --help Print help2.79.1. hammer sync-plan create
Create a sync plan
Usage:
hammer sync-plan create [OPTIONS]
Options:
--cron-expression CRON EXPRESSION Set this when interval is custom cron
--description DESCRIPTION Sync plan description
--enabled ENABLED Enables or disables synchronization
One of true/false, yes/no, 1/0.
--interval INTERVAL How often synchronization should run
--name NAME Sync plan name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--sync-date SYNC_DATE Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
-h, --help Print help2.79.2. hammer sync-plan delete
Destroy a sync plan
Usage:
hammer sync-plan <delete|destroy> [OPTIONS]
Options:
--id ID Sync plan numeric identifier
--name NAME Sync plan name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.79.3. hammer sync-plan info
Show a sync plan
Usage:
hammer sync-plan <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Sync plan numeric identifier
--name NAME Sync plan name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
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 |
-------------------|-----|---------|-----2.79.4. hammer sync-plan list
List sync plans
Usage:
hammer sync-plan <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--interval INTERVAL Filter by interval
Possible value(s): 'hourly', 'daily', 'weekly', 'custom cron'
--name NAME Filter by name
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--sync-date SYNC_DATE Filter by sync date
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
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 integer2.79.5. hammer sync-plan update
Update a sync plan
Usage:
hammer sync-plan update [OPTIONS]
Options:
--cron-expression CRON_EXPRESSION Add custom cron logic for sync plan
--description DESCRIPTION Sync plan description
--enabled ENABLED Enables or disables synchronization
One of true/false, yes/no, 1/0.
--id ID Sync plan numeric identifier
--interval INTERVAL How often synchronization should run
--name NAME Sync plan name to search by
--new-name NEW_NAME Sync plan name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--sync-date SYNC_DATE Start date and time of the synchronization
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
-h, --help Print help2.80. hammer tailoring-file
Manipulate Tailoring files
Usage:
hammer tailoring-file [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a Tailoring file
delete, destroy Deletes a Tailoring file
download Download a Tailoring file as XML
info, show Show a Tailoring file
list, index List Tailoring files
update Update a Tailoring file
Options:
-h, --help Print help2.80.1. hammer tailoring-file create
Create a Tailoring file
Usage:
hammer tailoring-file create [OPTIONS]
Options:
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Tailoring file name
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--original-filename ORIGINAL_FILENAME Original file name of the XML file
--scap-file SCAP_FILE Tailoring file content
-h, --help Print help2.80.2. hammer tailoring-file delete
Deletes a Tailoring file
Usage:
hammer tailoring-file <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.80.3. hammer tailoring-file download
Download a Tailoring file as XML
Usage:
hammer tailoring-file download [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--name NAME Tailoring file name
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--path PATH Path to directory where downloaded file will be saved
-h, --help Print help2.80.4. hammer tailoring-file info
Show a Tailoring file
Usage:
hammer tailoring-file <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--name NAME Tailoring file name
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help
Predefined field sets:
-----------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------------------------------|-----|---------|-----
Id | x | x | x
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 |
-----------------------------------|-----|---------|-----2.80.5. hammer tailoring-file list
List Tailoring files
Usage:
hammer tailoring-file <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
-------|-----|---------|-----
Search / Order fields:
created_at datetime
filename string
location string
location_id integer
name string
organization string
organization_id integer2.80.6. hammer tailoring-file update
Update a Tailoring file
Usage:
hammer tailoring-file update [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Name to search by
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--name NAME Tailoring file name
--new-name NEW_NAME Tailoring file name
--organization ORGANIZATION_NAME Name to search by
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--original-filename ORIGINAL_FILENAME Original file name of the XML file
--scap-file SCAP_FILE Tailoring file content
-h, --help Print help2.81. hammer task
Tasks related actions.
Usage:
hammer task [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
info, show Show task details
list, index List tasks
progress Show the progress of the task
resume Resume all tasks paused in error state
Options:
-h, --help Print help2.81.1. hammer task info
Show task details
Usage:
hammer task <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID UUID of the task
--location-id LOCATION_ID Set the current location context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------------|-----|--------
FIELDS | ALL | DEFAULT
------------|-----|--------
ID | x | x
Action | x | x
State | x | x
Result | x | x
Started at | x | x
Ended at | x | x
Owner | x | x
Task errors | x | x
------------|-----|--------2.81.2. hammer task list
List tasks
Usage:
hammer task <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-id LOCATION_ID Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization-id ORGANIZATION_ID Set the current organization context for the request
--page PAGE Page number, starting at 1
--parent-task-id PARENT_TASK_ID UUID of the task
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
------------|-----|--------
FIELDS | ALL | DEFAULT
------------|-----|--------
ID | x | x
Action | x | x
State | x | x
Result | x | x
Started at | x | x
Ended at | x | x
Owner | x | x
Task errors | x | x
------------|-----|--------2.81.3. hammer task progress
Show the progress of the task
Usage:
hammer task progress [OPTIONS]
Options:
--id ID UUID of the task
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.81.4. hammer task resume
Resume all tasks paused in error state
Usage:
hammer task resume [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--search SEARCH Resume tasks matching search string
--task-ids TASK_IDS Resume specific tasks by ID
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--tasks TASK_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Predefined field sets:
----------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
----------------------------------------|-----|--------
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
----------------------------------------|-----|--------2.82. hammer template
Manipulate provisioning templates
Usage:
hammer template [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-operatingsystem Associate an operating system
build-pxe-default Update the default PXE menu on all configured TFTP servers
clone Clone a provision template
combination Manage template combinations
create Create a provisioning template
delete, destroy Delete a provisioning template
dump View provisioning template content
info, show Show provisioning template details
kinds List available provisioning template kinds
list, index List provisioning templates
remove-operatingsystem Disassociate an operating system
update Update a provisioning template
Options:
-h, --help Print help2.82.1. hammer template add-operatingsystem
Associate an operating system
Usage:
hammer template add-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.82.2. hammer template build-pxe-default
Update the default PXE menu on all configured TFTP servers
Usage:
hammer template build-pxe-default [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.82.3. hammer template clone
Clone a provision template
Usage:
hammer template clone [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME Template name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.82.4. hammer template combination
Manage template combinations
Usage:
hammer template combination [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Add a template combination
delete, destroy Delete a template combination
info, show Show template combination
list, index List template combination
update Update template combination
Options:
-h, --help Print help2.82.4.1. hammer template combination create
Add a template combination
Usage:
hammer template combination create [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID ID of config template
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
-h, --help Print help2.82.4.2. hammer template combination delete
Delete a template combination
Usage:
hammer template combination <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.82.4.3. hammer template combination info
Show template combination
Usage:
hammer template combination <info|show> [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID ID of config template
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
-h, --help Print help
Predefined field sets:
---------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------------|-----|---------|-----
ID | x | x | x
Provisioning template ID | x | x |
Provisioning template name | x | x |
Hostgroup ID | x | x |
Hostgroup name | x | x |
Environment ID | x | x |
Environment name | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Created at | x | x |
Updated at | x | x |
---------------------------|-----|---------|-----2.82.4.4. hammer template combination list
List template combination
Usage:
hammer template combination <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID ID of config template
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
ID | x | x | x
Provisioning Template | x | x |
Hostgroup | x | x |
Environment | x | x |
----------------------|-----|---------|-----2.82.4.5. hammer template combination update
Update template combination
Usage:
hammer template combination update [OPTIONS]
Options:
--environment ENVIRONMENT_NAME Environment name (--environment is deprecated: Use --puppet-environment[-id] instead)
--environment-id ENVIRONMENT_ID (--environment-id is deprecated: Use --puppet-environment[-id] instead)
--hostgroup HOSTGROUP_NAME Hostgroup name
--hostgroup-id HOSTGROUP_ID ID of host group
--hostgroup-title HOSTGROUP_TITLE Hostgroup title
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--provisioning-template PROVISIONING_TEMPLATE_NAME Name to search by
--provisioning-template-id PROVISIONING_TEMPLATE_ID ID of config template
--puppet-environment PUPPET_ENVIRONMENT_NAME Puppet environment name
--puppet-environment-id PUPPET_ENVIRONMENT_ID
-h, --help Print help2.82.5. hammer template create
Create a provisioning template
Usage:
hammer template create [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--description DESCRIPTION
--file TEMPLATE Path to a file that contains the template
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME Template name
--operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the template
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--type TYPE Template type. Eg. snippet, script, provision
-h, --help Print help2.82.6. hammer template delete
Delete a provisioning template
Usage:
hammer template <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.82.7. hammer template dump
View provisioning template content
Usage:
hammer template dump [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
------
FIELDS
------2.82.8. hammer template info
Show provisioning template details
Usage:
hammer template <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
---------------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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 |
---------------------------------------|-----|---------|-----2.82.9. hammer template kinds
List available provisioning template kinds
Usage:
hammer template kinds [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Name | x | x | x
-------|-----|---------|-----2.82.10. hammer template list
List provisioning templates
Usage:
hammer template <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID ID of operating system
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Type | x | x |
-------|-----|---------|-----
Search / Order fields:
default_template Values: true, false
environment string
hostgroup string
kind string
location string
location_id integer
locked Values: true, false
name string
operatingsystem string
organization string
organization_id integer
snippet Values: true, false
template text
vendor string2.82.11. hammer template remove-operatingsystem
Disassociate an operating system
Usage:
hammer template remove-operatingsystem [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--operatingsystem OPERATINGSYSTEM_TITLE Operating system title
--operatingsystem-id OPERATINGSYSTEM_ID
-h, --help Print help2.82.12. hammer template update
Update a provisioning template
Usage:
hammer template update [OPTIONS]
Options:
--audit-comment AUDIT_COMMENT
--description DESCRIPTION
--file TEMPLATE Path to a file that contains the template
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locked LOCKED Whether or not the template is locked for editing
One of true/false, yes/no, 1/0.
--name NAME Name to search by
--new-name NEW_NAME Template name
--operatingsystem-ids OPERATINGSYSTEM_IDS Array of operating system IDs to associate with the template
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--operatingsystems OPERATINGSYSTEM_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--type TYPE Template type. Eg. snippet, script, provision
-h, --help Print help2.83. hammer template-input
Manage template inputs
Usage:
hammer template-input [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a template input
delete, destroy Delete a template input
info, show Show template input details
list, index List template inputs
update Update a template input
Options:
-h, --help Print help2.83.1. hammer template-input create
Create a template input
Usage:
hammer template-input create [OPTIONS]
Options:
--advanced ADVANCED Input is advanced
One of true/false, yes/no, 1/0.
--default DEFAULT Default value for user input
--description DESCRIPTION Input description
--fact-name FACT_NAME Fact name, used when input type is fact
--hidden-value HIDDEN_VALUE The value contains sensitive information and shouldn not be normally
Visible, useful e.g. for passwords
One of true/false, yes/no, 1/0.
--input-type INPUT_TYPE Input type
Possible value(s): 'user', 'fact', 'variable', 'puppet_parameter'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Input name
--options OPTIONS Selectable values for user inputs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class-name PUPPET_CLASS_NAME Puppet class name, used when input type is puppet_parameter
--puppet-parameter-name PUPPET_PARAMETER_NAME Puppet parameter name, used when input type is puppet_parameter
--required REQUIRED Input is required
One of true/false, yes/no, 1/0.
--resource-type RESOURCE_TYPE For values of type search, this is the resource the value searches in
Possible value(s): 'AnsibleRole', 'AnsibleVariable', 'Architecture', 'Audit', 'AuthSource', 'Bookmark', 'ComputeProfile', 'ComputeResource', 'ConfigGroup', 'ConfigReport', 'DiscoveryRule', 'Domain', 'Environment', 'ExternalUsergroup', 'FactValue', 'Filter', 'ForemanOpenscap::ArfReport', 'ForemanOpenscap::Policy', 'ForemanOpenscap::ScapContent', 'ForemanOpenscap::TailoringFile', 'ForemanTasks::RecurringLogic', 'ForemanTasks::Task', 'ForemanVirtWhoConfigure::Config', 'Host', 'HostClass', 'Hostgroup', 'HttpProxy', 'Image', 'InsightsHit', 'JobInvocation', 'JobTemplate', 'Katello::ActivationKey', 'Katello::ContentView', 'Katello::GpgKey', 'Katello::HostCollection', 'Katello::KTEnvironment', 'Katello::Product', 'Katello::Subscription', 'Katello::SyncPlan', 'KeyPair', 'Location', 'MailNotification', 'Medium', 'Model', 'Operatingsystem', 'Organization', 'Parameter', 'PersonalAccessToken', 'ProvisioningTemplate', 'Ptable', 'Puppetclass', 'PuppetclassLookupKey', 'Realm', 'RemoteExecutionFeature', 'Report', 'ReportTemplate', 'Role', 'Setting', 'SmartProxy', 'SshKey', 'Subnet', 'Template', 'TemplateInvocation', 'User', 'Usergroup'
--template-id TEMPLATE_ID
--value-type VALUE_TYPE Value type, defaults to plain
Possible value(s): 'plain', 'search', 'date'
--variable-name VARIABLE_NAME Variable name, used when input type is variable
-h, --help Print help2.83.2. hammer template-input delete
Delete a template input
Usage:
hammer template-input <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--template-id TEMPLATE_ID
-h, --help Print help2.83.3. hammer template-input info
Show template input details
Usage:
hammer template-input <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--template-id TEMPLATE_ID
-h, --help Print help
Predefined field sets:
----------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Input type | x | x |
Fact name | x | x |
Variable name | x | x |
Puppet parameter name | x | x |
Options | x | x |
Default value | x | x |
----------------------|-----|---------|-----2.83.4. hammer template-input list
List template inputs
Usage:
hammer template-input <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--template-id TEMPLATE_ID
-h, --help Print help
Predefined field sets:
-----------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------|-----|---------|-----
ID | x | x | x
Name | x | x | x
Input type | x | x |
-----------|-----|---------|-----
Search / Order fields:
input_type string
name string2.83.5. hammer template-input update
Update a template input
Usage:
hammer template-input update [OPTIONS]
Options:
--advanced ADVANCED Input is advanced
One of true/false, yes/no, 1/0.
--default DEFAULT Default value for user input
--description DESCRIPTION Input description
--fact-name FACT_NAME Fact name, used when input type is fact
--hidden-value HIDDEN_VALUE The value contains sensitive information and shouldn not be normally
Visible, useful e.g. for passwords
One of true/false, yes/no, 1/0.
--id ID
--input-type INPUT_TYPE Input type
Possible value(s): 'user', 'fact', 'variable', 'puppet_parameter'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME Input name
--options OPTIONS Selectable values for user inputs
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--puppet-class-name PUPPET_CLASS_NAME Puppet class name, used when input type is puppet_parameter
--puppet-parameter-name PUPPET_PARAMETER_NAME Puppet parameter name, used when input type is puppet_parameter
--required REQUIRED Input is required
One of true/false, yes/no, 1/0.
--resource-type RESOURCE_TYPE For values of type search, this is the resource the value searches in
Possible value(s): 'AnsibleRole', 'AnsibleVariable', 'Architecture', 'Audit', 'AuthSource', 'Bookmark', 'ComputeProfile', 'ComputeResource', 'ConfigGroup', 'ConfigReport', 'DiscoveryRule', 'Domain', 'Environment', 'ExternalUsergroup', 'FactValue', 'Filter', 'ForemanOpenscap::ArfReport', 'ForemanOpenscap::Policy', 'ForemanOpenscap::ScapContent', 'ForemanOpenscap::TailoringFile', 'ForemanTasks::RecurringLogic', 'ForemanTasks::Task', 'ForemanVirtWhoConfigure::Config', 'Host', 'HostClass', 'Hostgroup', 'HttpProxy', 'Image', 'InsightsHit', 'JobInvocation', 'JobTemplate', 'Katello::ActivationKey', 'Katello::ContentView', 'Katello::GpgKey', 'Katello::HostCollection', 'Katello::KTEnvironment', 'Katello::Product', 'Katello::Subscription', 'Katello::SyncPlan', 'KeyPair', 'Location', 'MailNotification', 'Medium', 'Model', 'Operatingsystem', 'Organization', 'Parameter', 'PersonalAccessToken', 'ProvisioningTemplate', 'Ptable', 'Puppetclass', 'PuppetclassLookupKey', 'Realm', 'RemoteExecutionFeature', 'Report', 'ReportTemplate', 'Role', 'Setting', 'SmartProxy', 'SshKey', 'Subnet', 'Template', 'TemplateInvocation', 'User', 'Usergroup'
--template-id TEMPLATE_ID
--value-type VALUE_TYPE Value type, defaults to plain
Possible value(s): 'plain', 'search', 'date'
--variable-name VARIABLE_NAME Variable name, used when input type is variable
-h, --help Print help2.84. hammer user
Manipulate users
Usage:
hammer user [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
access-token Managing personal access tokens
add-role Assign a user role
create Create a user
delete, destroy Delete a user
info, show Show a user
list, index List all users
mail-notification Managing personal mail notifications
remove-role Remove a user role
ssh-keys Managing User SSH Keys.
update Update a user
Options:
-h, --help Print help2.84.1. hammer user access-token
Managing personal access tokens
Usage:
hammer user access-token [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a Personal Access Token for a user
info, show Show a Personal Access Token for a user
list, index List all Personal Access Tokens for a user
revoke Revoke a Personal Access Token for a user
Options:
-h, --help Print help2.84.1.1. hammer user access-token create
Create a Personal Access Token for a user
Usage:
hammer user access-token create [OPTIONS]
Options:
--expires-at EXPIRES_AT Expiry Date
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help2.84.1.2. hammer user access-token info
Show a Personal Access Token for a user
Usage:
hammer user access-token <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help
Predefined field sets:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Active | x | x |
Expires at | x | x |
Created at | x | x |
Last used at | x | x |
-------------|-----|---------|-----2.84.1.3. hammer user access-token list
List all Personal Access Tokens for a user
Usage:
hammer user access-token <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help
Predefined field sets:
-----------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-----------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Active | x | x |
Expires at | x | x |
-----------|-----|---------|-----
Search / Order fields:
name string
user_id integer2.84.1.4. hammer user access-token revoke
Revoke a Personal Access Token for a user
Usage:
hammer user access-token revoke [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help2.84.2. hammer user add-role
Assign a user role
Usage:
hammer user add-role [OPTIONS]
Options:
--id ID
--login LOGIN User's login to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help Print help2.84.3. hammer user create
Create a user
Usage:
hammer user create [OPTIONS]
Options:
--admin ADMIN Is an admin account
One of true/false, yes/no, 1/0.
--ask-password ASK_PW One of true/false, yes/no, 1/0.
--auth-source AUTH_SOURCE_NAME Name to search by
--auth-source-id AUTH_SOURCE_ID
--default-location DEFAULT_LOCATION_NAME Default location name
--default-location-id DEFAULT_LOCATION_ID
--default-organization DEFAULT_ORGANIZATION_NAME Default organization name
--default-organization-id DEFAULT_ORGANIZATION_ID
--description DESCRIPTION
--disabled DISABLED One of true/false, yes/no, 1/0.
--firstname FIRSTNAME
--lastname LASTNAME
--locale LOCALE User's preferred locale
Possible value(s): 'ca', 'cs_CZ', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'nl_NL', 'pl', 'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--login LOGIN
--mail MAIL
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--password PASSWORD Required unless user is in an external authentication source
--role-ids ROLE_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--roles ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--timezone TIMEZONE User's timezone
Possible value(s): 'International Date Line West', 'American Samoa', 'Midway Island', 'Hawaii', 'Alaska', 'Pacific Time (US & Canada)', 'Tijuana', 'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US & Canada)', 'Central America', 'Central Time (US & Canada)', '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', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London', 'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern', 'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid', 'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna', 'Warsaw', 'West Central Africa', 'Zagreb', 'Zurich', 'Athens', 'Bucharest', 'Cairo', 'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria', 'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait', 'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Volgograd', 'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Yerevan', 'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai', 'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu', 'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi', 'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei', 'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk', 'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart', 'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji', 'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku'alofa', 'Samoa', 'Tokelau Is.'
-h, --help Print help2.84.4. hammer user delete
Delete a user
Usage:
hammer user <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--login LOGIN User's login to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.84.5. hammer user info
Show a user
Usage:
hammer user <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--login LOGIN User's login to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------------|-----|---------|-----
Id | x | x | x
Login | x | x | x
Name | x | x |
Email | x | x |
Admin | x | x |
Disabled | x | x |
Last login | x | x |
Authorized by | 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 |
--------------------------------|-----|---------|-----2.84.6. hammer user list
List all users
Usage:
hammer user <list|index> [OPTIONS]
Options:
--auth-source-ldap AUTH_SOURCE_LDAP_NAME Name to search by
--auth-source-ldap-id AUTH_SOURCE_LDAP_ID ID of LDAP authentication source
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--role ROLE_NAME User role name
--role-id ROLE_ID ID of role
--search SEARCH Filter results
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help
Predefined field sets:
--------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------|-----|---------|-----
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
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 string2.84.7. hammer user mail-notification
Managing personal mail notifications
Usage:
hammer user mail-notification [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add Add an email notification for a user
list, index List all email notifications for a user
remove Remove an email notification for a user
update Update an email notification for a user
Options:
-h, --help Print help2.84.7.1. hammer user mail-notification add
Add an email notification for a user
Usage:
hammer user mail-notification add [OPTIONS]
Options:
--interval INTERVAL Mail notification interval option, e.g. Daily, Weekly or Monthly. Required
For summary notification
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mail-notification MAIL_NOTIFICATION_NAME Name to search by
--mail-notification-id MAIL_NOTIFICATION_ID
--mail-query MAIL_QUERY Relevant only for audit summary notification
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--subscription SUBSCRIPTION 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 USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.84.7.2. hammer user mail-notification list
List all email notifications for a user
Usage:
hammer user mail-notification <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x |
Name | x | x | x
Description | x | x |
Interval | x | x |
Mail query | x | x |
------------|-----|---------|-----2.84.7.3. hammer user mail-notification remove
Remove an email notification for a user
Usage:
hammer user mail-notification remove [OPTIONS]
Options:
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mail-notification MAIL_NOTIFICATION_NAME Name to search by
--mail-notification-id MAIL_NOTIFICATION_ID
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.84.7.4. hammer user mail-notification update
Update an email notification for a user
Usage:
hammer user mail-notification update [OPTIONS]
Options:
--interval INTERVAL Mail notification interval option, e.g. Daily, Weekly or Monthly. Required
For summary notification
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--mail-notification MAIL_NOTIFICATION_NAME Name to search by
--mail-notification-id MAIL_NOTIFICATION_ID
--mail-query MAIL_QUERY Relevant only for audit summary notification
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--subscription SUBSCRIPTION 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 USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.84.8. hammer user remove-role
Remove a user role
Usage:
hammer user remove-role [OPTIONS]
Options:
--id ID
--login LOGIN User's login to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help Print help2.84.9. hammer user ssh-keys
Managing User SSH Keys.
Usage:
hammer user ssh-keys [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add Add an SSH key for a user
delete, destroy Delete an SSH key for a user
info, show Show an SSH key from a user
list, index List all SSH keys for a user
Options:
-h, --help Print help2.84.9.1. hammer user ssh-keys add
Add an SSH key for a user
Usage:
hammer user ssh-keys add [OPTIONS]
Options:
--key KEY Public SSH key
--key-file KEY_FILE Path to a SSH public key
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help2.84.9.2. hammer user ssh-keys delete
Delete an SSH key for a user
Usage:
hammer user ssh-keys <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help2.84.9.3. hammer user ssh-keys info
Show an SSH key from a user
Usage:
hammer user ssh-keys <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Fingerprint | x | x |
Length | x | x |
Created at | x | x |
Public Key | x | x |
------------|-----|---------|-----2.84.9.4. hammer user ssh-keys list
List all SSH keys for a user
Usage:
hammer user ssh-keys <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
--user USER_LOGIN User's login to search by
--user-id USER_ID ID of the user
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Fingerprint | x | x |
Length | x | x |
Created at | x | x |
------------|-----|---------|-----
Search / Order fields:
name string
user_id integer2.84.10. hammer user update
Update a user
Usage:
hammer user update [OPTIONS]
Options:
--admin ADMIN Is an admin account
One of true/false, yes/no, 1/0.
--ask-password ASK_PW One of true/false, yes/no, 1/0.
--auth-source AUTH_SOURCE_NAME Name to search by
--auth-source-id AUTH_SOURCE_ID
--current-password CURRENT_PASSWORD Required when user want to change own password
--default-location DEFAULT_LOCATION_NAME Default location name
--default-location-id DEFAULT_LOCATION_ID
--default-organization DEFAULT_ORGANIZATION_NAME Default organization name
--default-organization-id DEFAULT_ORGANIZATION_ID
--description DESCRIPTION
--disabled DISABLED One of true/false, yes/no, 1/0.
--firstname FIRSTNAME
--id ID
--lastname LASTNAME
--locale LOCALE User's preferred locale
Possible value(s): 'ca', 'cs_CZ', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'nl_NL', 'pl', 'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--login LOGIN User's login to search by
--mail MAIL
--new-login NEW_LOGIN
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--password PASSWORD Required unless user is in an external authentication source
--role-ids ROLE_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--roles ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--timezone TIMEZONE User's timezone
Possible value(s): 'International Date Line West', 'American Samoa', 'Midway Island', 'Hawaii', 'Alaska', 'Pacific Time (US & Canada)', 'Tijuana', 'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US & Canada)', 'Central America', 'Central Time (US & Canada)', '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', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London', 'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern', 'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid', 'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna', 'Warsaw', 'West Central Africa', 'Zagreb', 'Zurich', 'Athens', 'Bucharest', 'Cairo', 'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria', 'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait', 'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Volgograd', 'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Yerevan', 'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai', 'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu', 'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi', 'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei', 'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk', 'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart', 'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji', 'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku'alofa', 'Samoa', 'Tokelau Is.'
-h, --help Print help2.85. hammer user-group
Manage user groups
Usage:
hammer user-group [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-role Assign a user role
add-user Associate an user
add-user-group Associate an user group
create Create a user group
delete, destroy Delete a user group
external View and manage user group's external user groups
info, show Show a user group
list, index List all user groups
remove-role Remove a user role
remove-user Disassociate an user
remove-user-group Disassociate an user group
update Update a user group
Options:
-h, --help Print help2.85.1. hammer user-group add-role
Assign a user role
Usage:
hammer user-group add-role [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help Print help2.85.2. hammer user-group add-user
Associate an user
Usage:
hammer user-group add-user [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.85.3. hammer user-group add-user-group
Associate an user group
Usage:
hammer user-group add-user-group [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help2.85.4. hammer user-group create
Create a user group
Usage:
hammer user-group create [OPTIONS]
Options:
--admin ADMIN Is an admin user group
One of true/false, yes/no, 1/0.
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--role-ids ROLE_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--roles ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-group-ids USER_GROUP_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-groups USER_GROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-ids USER_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--users USER_LOGINS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.85.5. hammer user-group delete
Delete a user group
Usage:
hammer user-group <delete|destroy> [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.85.6. hammer user-group external
View and manage user group’s external user groups
Usage:
hammer user-group external [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create an external user group linked to a user group
delete, destroy Delete an external user group
info, show Show an external user group for user group
list, index List all external user groups for user group
refresh Refresh external user group
update Update external user group
Options:
-h, --help Print help2.85.6.1. hammer user-group external create
Create an external user group linked to a user group
Usage:
hammer user-group external create [OPTIONS]
Options:
--auth-source AUTH_SOURCE_NAME Name to search by
--auth-source-id AUTH_SOURCE_ID ID of linked authentication source
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME External user group name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help2.85.6.2. hammer user-group external delete
Delete an external user group
Usage:
hammer user-group external <delete|destroy> [OPTIONS]
Options:
--id ID ID or name external user group
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help2.85.6.3. hammer user-group external info
Show an external user group for user group
Usage:
hammer user-group external <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID or name of external user group
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Auth source | x | x |
------------|-----|---------|-----2.85.6.4. hammer user-group external list
List all external user groups for user group
Usage:
hammer user-group external <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Auth source | x | x |
------------|-----|---------|-----2.85.6.5. hammer user-group external refresh
Refresh external user group
Usage:
hammer user-group external refresh [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID ID or name of external user group
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help
Predefined field sets:
------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------|-----|---------|-----
Name | x | x | x
Auth source | x | x |
------------|-----|---------|-----2.85.6.6. hammer user-group external update
Update external user group
Usage:
hammer user-group external update [OPTIONS]
Options:
--auth-source AUTH_SOURCE_NAME Name to search by
--auth-source-id AUTH_SOURCE_ID ID of linked authentication source
--id ID ID or name of external user group
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME External user group name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help2.85.7. hammer user-group info
Show a user group
Usage:
hammer user-group <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
--------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
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 |
--------------------------------|-----|---------|-----2.85.8. hammer user-group list
List all user groups
Usage:
hammer user-group <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Admin | x | x |
-------|-----|---------|-----
Search / Order fields:
name string
role string
role_id integer2.85.9. hammer user-group remove-role
Remove a user role
Usage:
hammer user-group remove-role [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help Print help2.85.10. hammer user-group remove-user
Disassociate an user
Usage:
hammer user-group remove-user [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help Print help2.85.11. hammer user-group remove-user-group
Disassociate an user group
Usage:
hammer user-group remove-user-group [OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help Print help2.85.12. hammer user-group update
Update a user group
Usage:
hammer user-group update [OPTIONS]
Options:
--admin ADMIN Is an admin user group
One of true/false, yes/no, 1/0.
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--role-ids ROLE_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--roles ROLE_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-group-ids USER_GROUP_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-groups USER_GROUP_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--user-ids USER_IDS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--users USER_LOGINS Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
-h, --help Print help2.86. hammer virt-who-config
Manage Virt Who configurations
Usage:
hammer virt-who-config [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a virt-who configuration
delete, destroy Delete a virt-who configuration
deploy Download and execute script for the specified virt-who configuration
fetch Renders a deploy script for the specified virt-who configuration
info, show Show a virt-who configuration
list, index List of virt-who configurations
update Update a virt-who configuration
Options:
-h, --help Print help2.86.1. hammer virt-who-config create
Create a virt-who configuration
Usage:
hammer virt-who-config create [OPTIONS]
Options:
--blacklist BLACKLIST Hypervisor blacklist, applicable only when filtering mode is set to 2.
Wildcards and regular expressions are supported, multiple records must be
Separated by comma.
--debug DEBUG Enable debugging output
One of true/false, yes/no, 1/0.
--exclude-host-parents EXCLUDE_HOST_PARENTS 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 FILTER_HOST_PARENTS 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 MODE Hypervisor filtering mode
Possible value(s): 'none', 'whitelist', 'blacklist'
--http-proxy HTTP_PROXY_NAME Name to search by
--http-proxy-id HTTP_PROXY_ID 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 HYPERVISOR_ID Specifies how the hypervisor will be identified.
Possible value(s): 'hostname', 'uuid', 'hwuuid'
--hypervisor-password HYPERVISOR_PASSWORD Hypervisor password, required for all hypervisor types except for libvirt
--hypervisor-server HYPERVISOR_SERVER Fully qualified host name or IP address of the hypervisor
--hypervisor-type HYPERVISOR_TYPE Hypervisor type
Possible value(s): 'esx', 'rhevm', 'hyperv', 'xen', 'libvirt', 'kubevirt'
--hypervisor-username HYPERVISOR_USERNAME Account name by which virt-who is to connect to the hypervisor.
--interval INTERVAL Configuration interval in minutes
Possible value(s): '60', '120', '240', '480', '720', '1440', '2880', '4320'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Configuration name
--no-proxy NO_PROXY Ignore Proxy. A comma-separated list of hostnames or domains or ip
Addresses to ignore Capsule settings for. Optionally this may be set to *
To bypass proxy settings for all hostnames domains or ip addresses.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--satellite-url SATELLITE_URL Satellite server FQDN
--whitelist WHITELIST Hypervisor whitelist, applicable only when filtering mode is set to 1.
Wildcards and regular expressions are supported, multiple records must be
Separated by comma.
-h, --help Print help2.86.2. hammer virt-who-config delete
Delete a virt-who configuration
Usage:
hammer virt-who-config <delete|destroy> [OPTIONS]
Options:
--id ID Configuration numeric identifier
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.86.3. hammer virt-who-config deploy
Download and execute script for the specified virt-who configuration
Usage:
hammer virt-who-config deploy [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.86.4. hammer virt-who-config fetch
Renders a deploy script for the specified virt-who configuration
Usage:
hammer virt-who-config fetch [OPTIONS]
Options:
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
-o, --output FILE File where the script will be written2.86.5. hammer virt-who-config info
Show a virt-who configuration
Usage:
hammer virt-who-config <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help
Predefined field sets:
----------------------------------------|-----|--------
FIELDS | ALL | DEFAULT
----------------------------------------|-----|--------
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/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
----------------------------------------|-----|--------2.86.6. hammer virt-who-config list
List of virt-who configurations
Usage:
hammer virt-who-config <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Interval | x | x |
Status | x | x |
Last Report At | x | x |
---------------|-----|---------|-----2.86.7. hammer virt-who-config update
Update a virt-who configuration
Usage:
hammer virt-who-config update [OPTIONS]
Options:
--blacklist BLACKLIST Hypervisor blacklist, applicable only when filtering mode is set to 2.
Wildcards and regular expressions are supported, multiple records must be
Separated by comma.
--debug DEBUG Enable debugging output
One of true/false, yes/no, 1/0.
--exclude-host-parents EXCLUDE_HOST_PARENTS 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 FILTER_HOST_PARENTS 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 MODE Hypervisor filtering mode
Possible value(s): 'none', 'whitelist', 'blacklist'
--http-proxy HTTP_PROXY_NAME Name to search by
--http-proxy-id HTTP_PROXY_ID 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 HYPERVISOR_ID Specifies how the hypervisor will be identified.
Possible value(s): 'hostname', 'uuid', 'hwuuid'
--hypervisor-password HYPERVISOR_PASSWORD Hypervisor password, required for all hypervisor types except for libvirt
--hypervisor-server HYPERVISOR_SERVER Fully qualified host name or IP address of the hypervisor
--hypervisor-type HYPERVISOR_TYPE Hypervisor type
Possible value(s): 'esx', 'rhevm', 'hyperv', 'xen', 'libvirt', 'kubevirt'
--hypervisor-username HYPERVISOR_USERNAME Account name by which virt-who is to connect to the hypervisor.
--id ID Configuration numeric identifier
--interval INTERVAL Configuration interval in minutes
Possible value(s): '60', '120', '240', '480', '720', '1440', '2880', '4320'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Name to search by
--new-name NEW_NAME Configuration name
--no-proxy NO_PROXY Ignore Proxy. A comma-separated list of hostnames or domains or ip
Addresses to ignore Capsule settings for. Optionally this may be set to *
To bypass proxy settings for all hostnames domains or ip addresses.
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--satellite-url SATELLITE_URL Satellite server FQDN
--whitelist WHITELIST Hypervisor whitelist, applicable only when filtering mode is set to 1.
Wildcards and regular expressions are supported, multiple records must be
Separated by comma.
-h, --help Print help