Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.
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.12.
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-report Browse and read reports content-credentials Manipulate content credentials on the server content-export Prepare content for export to a disconnected Katello content-import Import content from an upstream archive. content-units Manipulate content units 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 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 host Manipulate hosts host-collection Manipulate host collections host-registration Host Registration 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 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 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 scap-content Manipulate SCAP contents scap-content-profile Manipulate Scap Content Profiles settings Change server settings shell Interactive shell simple-content-access Simple content access commands 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 webhook Manage webhooks webhook-template Manipulate webhook templates Options: --[no-]use-defaults Enable/disable stored defaults. Enabled by default --autocomplete VALUE Get list of possible endings --csv Output as CSV (same as --output=csv) --csv-separator VALUE Character to separate the values --fetch-ca-cert VALUE Fetch CA certificate from server and exit --interactive BOOLEAN Explicitly turn interactive mode on/off --no-headers Hide headers from output --output ENUM Set output format Possible value(s): 'base', 'table', 'silent', 'csv', 'yaml', 'json' --output-file VALUE Path to custom output file --show-ids Show ids of associated resources --ssl-ca-file VALUE Configure the file containing the CA certificates --ssl-ca-path VALUE Configure the directory containing the CA certificates --ssl-client-cert VALUE Configure the client's public certificate --ssl-client-key VALUE Configure the client's private key --ssl-with-basic-auth Use standard authentication in addition to client certificate authentication --verify-ssl BOOLEAN Configure SSL verification of remote system --version Show version -c, --config VALUE Path to custom config file -d, --debug Show debugging output -h, --help Print help -p, --password VALUE Password to access the remote system -q, --quiet Completely silent -r, --reload-cache Force reload of Apipie cache -s, --server VALUE Remote system address -u, --username VALUE Username to access the remote system -v, --[no-]verbose Be verbose (or not). True by default Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2. hammer activation-key
Manipulate activation keys
Usage: hammer activation-key [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-host-collection Associate a resource add-subscription Add subscription content-override Override product content defaults copy Copy an activation key create Create an activation key delete, destroy 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 help
2.2.1. hammer activation-key add-host-collection
Associate a resource
Usage: hammer activation-key add-host-collection [OPTIONS] Options: --host-collection VALUE Host collection name to search by --host-collection-id NUMBER Id of the host collection --id VALUE ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.2. hammer activation-key add-subscription
Add subscription
Usage: hammer activation-key add-subscription [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --quantity NUMBER Quantity of this subscription to add --subscription VALUE Subscription name to search by --subscription-id NUMBER Subscription identifier --subscriptions SCHEMA Array of subscriptions to add -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains 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 VALUE Label of the content --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --override-name VALUE Override parameter key or name. To enable or disable a repo select 'enabled'. Default value: enabled Default: "enabled" --remove Remove a content override --value VALUE Override value. Note for repo enablement you can use a boolean value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.4. hammer activation-key copy
Copy an activation key
Usage: hammer activation-key copy [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --new-name VALUE Name of new activation key --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.5. hammer activation-key create
Create an activation key
Usage: hammer activation-key create [OPTIONS] Options: --auto-attach BOOLEAN Auto attach subscriptions upon registration --content-view VALUE Content view name to search by --content-view-id NUMBER Content view id --description VALUE Description --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment id --max-hosts NUMBER Maximum number of registered content hosts --name VALUE Name --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --purpose-addons LIST Sets the system add-ons --purpose-role VALUE Sets the system purpose usage --purpose-usage VALUE Sets the system purpose usage --release-version VALUE Content release version --service-level VALUE Service level --unlimited-hosts Set hosts max to unlimited -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.6. hammer activation-key delete
Destroy an activation key
Usage: hammer activation-key <delete|destroy> [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.7. hammer activation-key host-collections
List associated host collections
Usage: hammer activation-key host-collections [OPTIONS] Options: --available-for VALUE Interpret specified object to return only Host Collections that can be associated with specified object. The value 'host' is supported. --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host-id NUMBER Filter products by host id --id VALUE ID of activation key --name VALUE Name of activation key --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --sort-by VALUE Field to sort the results on --sort-order VALUE How to order the sorted results (e.g. ASC for ascending) -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.8. hammer activation-key info
Show an activation key
Usage: hammer activation-key <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -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 | ------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.9. hammer activation-key list
List activation keys
Usage: hammer activation-key <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --name VALUE Activation key name to filter by --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help 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 | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: addon string content_view string content_view_id integer description text environment string name string organization_id integer role string subscription_id string subscription_name string usage string
2.2.10. hammer activation-key product-content
List associated products
Usage: hammer activation-key product-content [OPTIONS] Options: --content-access-mode-all BOOLEAN Get all content available, not just that provided by subscriptions --content-access-mode-env BOOLEAN Limit content to just that available in the activation key's content view version --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE 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 | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.11. hammer activation-key remove-host-collection
Disassociate a resource
Usage: hammer activation-key remove-host-collection [OPTIONS] Options: --host-collection VALUE Host collection name to search by --host-collection-id NUMBER Id of the host collection --id VALUE ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.12. hammer activation-key remove-subscription
Remove subscription
Usage: hammer activation-key remove-subscription [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --subscription-id VALUE ID of subscription -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.13. hammer activation-key subscriptions
List associated subscriptions
Usage: hammer activation-key subscriptions [OPTIONS] Options: --activation-key VALUE Activation key name to search by --activation-key-id VALUE Activation key ID --available-for VALUE Object to show subscriptions available for, either 'host' or 'activation_key' --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id VALUE Id of a host --id VALUE ID of the activation key --match-host BOOLEAN Ignore subscriptions that are unavailable to the specified host --match-installed BOOLEAN Return subscriptions that match installed products of the specified host --name VALUE Activation key name to search by --no-overlap BOOLEAN Return subscriptions which do not overlap with a currently-attached subscription --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help 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 -----------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.2.14. hammer activation-key update
Update an activation key
Usage: hammer activation-key update [OPTIONS] Options: --auto-attach BOOLEAN Auto attach subscriptions upon registration --content-view VALUE Content view name to search by --content-view-id NUMBER Content view id --description VALUE Description --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER ID of the activation key --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment id --max-hosts NUMBER Maximum number of registered content hosts --name VALUE Name --new-name VALUE Name --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --purpose-addons LIST Sets the system add-ons --purpose-role VALUE Sets the system purpose usage --purpose-usage VALUE Sets the system purpose usage --release-version VALUE Content release version --service-level VALUE Service level --unlimited-hosts Set hosts max to unlimited -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.3. hammer admin
Administrative server-side tasks
Usage: hammer admin [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: logging Logging verbosity level setup Options: -h, --help Print help
2.3.1. hammer admin logging
Logging verbosity level setup
Usage: hammer admin logging [OPTIONS] Options: --no-backup Skip configuration backups creation. --prefix VALUE Operate on prefixed environment (e.g. chroot). -a, --all Apply to all components. -c, --components LIST Components to apply, use --list to get them. -d, --level-debug Increase verbosity level to debug. -h, --help Print help -l, --list List available components. -n, --dry-run Do not apply specified changes. -p, --level-production Decrease verbosity level to standard. Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4. hammer ansible
Manage foreman ansible
Usage: hammer ansible [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: roles Manage ansible roles variables Manage ansible variables Options: -h, --help Print help
2.4.1. hammer ansible roles
Manage ansible roles
Usage: hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete, destroy Deletes Ansible role fetch Fetch Ansible roles available to be synced import DEPRECATED: Import Ansible roles info, show Show role list, index List Ansible roles obsolete DEPRECATED: Obsolete Ansible roles play-hostgroups Runs all Ansible roles on hostgroups play-hosts Runs all Ansible roles on hosts sync Sync Ansible roles Options: -h, --help Print help
2.4.1.1. hammer ansible roles delete
Deletes Ansible role
Usage: hammer ansible roles <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.1.2. hammer ansible roles fetch
Fetch Ansible roles available to be synced
Usage: hammer ansible roles fetch [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to fetch from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.1.3. hammer ansible roles import
DEPRECATED: Import Ansible roles
Usage: hammer ansible roles import [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from --role-names LIST Ansible role names to be imported -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.1.4. hammer ansible roles info
Show role
Usage: hammer ansible roles <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Imported at | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.1.5. hammer ansible roles list
List Ansible roles
Usage: hammer ansible roles <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Imported at | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: host string host_id integer hostgroup string hostgroup_id integer id integer name string updated_at datetime
2.4.1.6. hammer ansible roles obsolete
DEPRECATED: Obsolete Ansible roles
Usage: hammer ansible roles obsolete [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.1.7. hammer ansible roles play-hostgroups
Runs all Ansible roles on hostgroups
Usage: hammer ansible roles play-hostgroups [OPTIONS] Options: --hostgroup-ids LIST IDs of hostgroups to play roles on --hostgroup-titles LIST --hostgroups LIST --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.1.8. hammer ansible roles play-hosts
Runs all Ansible roles on hosts
Usage: hammer ansible roles play-hosts [OPTIONS] Options: --host-ids LIST IDs of hosts to play roles on --hosts LIST --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.1.9. hammer ansible roles sync
Sync Ansible roles
Usage: hammer ansible roles sync [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to sync from --role-names LIST Ansible role names to be synced -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2. hammer ansible variables
Manage ansible variables
Usage: hammer ansible variables [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-matcher Create an override value for a specific ansible variable create Create Ansible variable delete, destroy Deletes Ansible variable import DEPRECATED: 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 DEPRECATED: Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles remove-matcher Destroy an override value update Updates Ansible variable Options: -h, --help Print help
2.4.2.1. hammer ansible variables add-matcher
Create an override value for a specific ansible variable
Usage: hammer ansible variables add-matcher [OPTIONS] Options: --ansible-variable VALUE Name to search by --ansible-variable-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --match VALUE Override match --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --value VALUE Override value, required if omit is false -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2.2. hammer ansible variables create
Create Ansible variable
Usage: hammer ansible variables create [OPTIONS] Options: --ansible-role VALUE Name to search by --ansible-role-id NUMBER Role ID --avoid-duplicates BOOLEAN Remove duplicate values (only array type) --default-value VALUE Default value of variable --description VALUE Description of variable --hidden-value BOOLEAN When enabled the parameter is hidden in the UI --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --merge-default BOOLEAN Include default value when merging all matching values --merge-overrides BOOLEAN Merge all matching values (only array/hash type) --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --override BOOLEAN Whether to override variable or not --override-value-order VALUE The order in which values are resolved --validator-rule VALUE Used to enforce certain values for the parameter values --validator-type ENUM Types of validation values Possible value(s): 'regexp', 'list' --variable VALUE Name of variable --variable-type ENUM Types of variable values Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2.3. hammer ansible variables delete
Deletes Ansible variable
Usage: hammer ansible variables <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2.4. hammer ansible variables import
DEPRECATED: Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles
Usage: hammer ansible variables import [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2.5. hammer ansible variables info
Show variable
Usage: hammer ansible variables <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 ------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2.6. hammer ansible variables list
List Ansible variables
Usage: hammer ansible variables <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help 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 --------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: ansible_role string avoid_duplicates Values: true, false imported Values: true, false key string merge_default Values: true, false merge_overrides Values: true, false name string override Values: true, false parameter string
2.4.2.7. hammer ansible variables obsolete
DEPRECATED: Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles
Usage: hammer ansible variables obsolete [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2.8. hammer ansible variables remove-matcher
Destroy an override value
Usage: hammer ansible variables remove-matcher [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.4.2.9. hammer ansible variables update
Updates Ansible variable
Usage: hammer ansible variables update [OPTIONS] Options: --ansible-role VALUE Name to search by --ansible-role-id NUMBER Role ID --avoid-duplicates BOOLEAN Remove duplicate values (only array type) --default-value VALUE Default value of variable --description VALUE Description of variable --hidden-value BOOLEAN When enabled the parameter is hidden in the UI --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --merge-default BOOLEAN Include default value when merging all matching values --merge-overrides BOOLEAN Merge all matching values (only array/hash type) --name VALUE Name to search by --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --override BOOLEAN Whether to override variable or not --override-value-order LIST The order in which values are resolved --validator-rule VALUE Used to enforce certain values for the parameter values --validator-type ENUM Types of validation values Possible value(s): 'regexp', 'list' --variable VALUE Name of variable --variable-type ENUM Types of variable values Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.5. hammer architecture
Manipulate architectures
Usage: hammer architecture [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-operatingsystem Associate an operating system create Create an architecture delete, 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 help
2.5.1. hammer architecture add-operatingsystem
Associate an operating system
Usage: hammer architecture add-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Architecture name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.5.2. hammer architecture create
Create an architecture
Usage: hammer architecture create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --operatingsystem-ids LIST Operating system IDs --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.5.3. hammer architecture delete
Delete an architecture
Usage: hammer architecture <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Architecture name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.5.4. hammer architecture info
Show an architecture
Usage: hammer architecture <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Architecture name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.5.5. hammer architecture list
List all architectures
Usage: hammer architecture <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string
2.5.6. hammer architecture remove-operatingsystem
Disassociate an operating system
Usage: hammer architecture remove-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Architecture name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.5.7. hammer architecture update
Update an architecture
Usage: hammer architecture update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --operatingsystem-ids LIST Operating system IDs --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.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 help
2.6.1. hammer arf-report delete
Delete an ARF Report
Usage: hammer arf-report <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.6.2. hammer arf-report download
Download bzipped ARF report
Usage: hammer arf-report download [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --path VALUE Path to directory where downloaded file will be saved -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.6.3. hammer arf-report download-html
Download ARF report in HTML
Usage: hammer arf-report download-html [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --path VALUE Path to directory where downloaded file will be saved -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.6.4. hammer arf-report info
Show an ARF report
Usage: hammer arf-report <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request -h, --help Print help 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 | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.6.5. hammer arf-report list
List ARF reports
Usage: hammer arf-report <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help 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 | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: compliance_policy string compliance_status Values: compliant, incompliant, inconclusive comply_with string eventful Values: true, false host string host_collection string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string inconclusive_with string last_for Values: host, policy last_report datetime lifecycle_environment string location string location_id integer log text not_comply_with string openscap_proxy string organization string organization_id integer origin string policy string reported datetime resource text xccdf_rule_failed string xccdf_rule_name text xccdf_rule_othered string xccdf_rule_passed string
2.7. hammer audit
Search audit trails.
Usage: hammer audit [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show an audit list, index List all audits Options: -h, --help Print help
2.7.1. hammer audit info
Show an audit
Usage: hammer audit <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | --------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.7.2. hammer audit list
List all audits
Usage: hammer audit <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help 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 | | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: action string auditable_id integer authored_by_user string authored_by_user.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 remote_address string request_uuid string setting string time datetime type Values: role, ptable, provisioning_template, user, filter, architecture, bookmark, compute_profile, domain, hostgroup, http_proxy, image, key_pair, medium, model, personal_access_token, report_template, realm, smart_proxy, ssh_key, subnet, usergroup, job_template, remote_execution_feature, job_invocation, ansible_role, discovery_rule, katello/activation_key, katello/content_view, katello/content_credential, katello/host_collection, katello/kt_environment, katello/product, katello/sync_plan, foreman_virt_who_configure/config, foreman_openscap/policy, foreman_openscap/scap_content, foreman_openscap/tailoring_file, foreman_openscap/oval_content, foreman_openscap/oval_policy, compute_attribute, lookup_value, katello/repository, katello/host/content_facet, katello/hostgroup/content_facet, katello/host/subscription_facet, katello/root_repository, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, setting, smart_class_parameter user string username string
2.8. hammer auth
Foreman connection login/logout
Usage: hammer auth [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: login Set credentials logout Wipe your credentials status Information about current connections Options: -h, --help Print help
2.8.1. hammer auth login
Set credentials
Usage: hammer auth login [OPTIONS] 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 help
2.8.1.1. hammer auth login basic
provide username and password
Usage: hammer auth login basic [OPTIONS] Options: -h, --help Print help -p, --password VALUE Password to access the remote system -u, --username VALUE Username to access the remote system Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.8.1.2. hammer auth login oauth
supports for both with/without 2fa
Usage: hammer auth login oauth [OPTIONS] Options: -a, --oidc-authorization-endpoint VALUE Openidc provider URL which issues authentication code (two factor only) -c, --oidc-client-id VALUE Client id used in the Openidc provider -f, --two-factor Authenticate with two factor -h, --help Print help -p, --password VALUE Password to access the remote system -r, --oidc-redirect-uri VALUE Redirect URI for the authentication code grant flow -t, --oidc-token-endpoint VALUE Openidc provider URL which issues access token -u, --username VALUE Username to access the remote system Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.8.2. hammer auth logout
Wipe your credentials
Usage: hammer auth logout [OPTIONS] Options: -h, --help Print help
2.8.3. hammer auth status
Information about current connections
Usage: hammer auth status [OPTIONS] Options: -h, --help Print help
2.9. hammer auth-source
Manipulate auth sources
Usage: hammer auth-source [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: external Manage external auth sources ldap Manage LDAP auth sources list, index List all auth sources Options: -h, --help Print help
2.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 help
2.9.1.1. hammer auth-source external info
Show an external authentication source
Usage: hammer auth-source external <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Locations/ | x | x | Organizations/ | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.9.1.2. hammer auth-source external list
List external authentication sources
Usage: hammer auth-source external <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer
2.9.1.3. hammer auth-source external update
Update organization and location for Auth Source
Usage: hammer auth-source external update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.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 help
2.9.2.1. hammer auth-source ldap create
Create an LDAP authentication source
Usage: hammer auth-source ldap create [OPTIONS] Options: --account VALUE --account-password VALUE Required if onthefly_register is true --attr-firstname VALUE Required if onthefly_register is true --attr-lastname VALUE Required if onthefly_register is true --attr-login VALUE Required if onthefly_register is true --attr-mail VALUE Required if onthefly_register is true --attr-photo VALUE --base-dn VALUE --groups-base VALUE Groups base DN --host VALUE The hostname of the LDAP server --ldap-filter VALUE LDAP filter --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --onthefly-register BOOLEAN --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --port NUMBER Defaults to 389 --server-type ENUM Type of the LDAP server Possible value(s): 'free_ipa', 'active_directory', 'posix' --tls BOOLEAN --use-netgroups BOOLEAN Use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa --usergroup-sync BOOLEAN Sync external user groups on login -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.9.2.2. hammer auth-source ldap delete
Delete an LDAP authentication source
Usage: hammer auth-source ldap <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.9.2.3. hammer auth-source ldap info
Show an LDAP authentication source
Usage: hammer auth-source ldap <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 -------------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.9.2.4. hammer auth-source ldap list
List all LDAP authentication sources
Usage: hammer auth-source ldap <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x Server | x | x | Port | x | x | Ldaps? | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer
2.9.2.5. hammer auth-source ldap update
Update an LDAP authentication source
Usage: hammer auth-source ldap update [OPTIONS] Options: --account VALUE --account-password VALUE Required if onthefly_register is true --attr-firstname VALUE Required if onthefly_register is true --attr-lastname VALUE Required if onthefly_register is true --attr-login VALUE Required if onthefly_register is true --attr-mail VALUE Required if onthefly_register is true --attr-photo VALUE --base-dn VALUE --groups-base VALUE Groups base DN --host VALUE The hostname of the LDAP server --id VALUE --ldap-filter VALUE LDAP filter --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --onthefly-register BOOLEAN --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --port NUMBER Defaults to 389 --server-type ENUM Type of the LDAP server Possible value(s): 'free_ipa', 'active_directory', 'posix' --tls BOOLEAN --use-netgroups BOOLEAN Use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa --usergroup-sync BOOLEAN Sync external user groups on login -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.9.3. hammer auth-source list
List all auth sources
Usage: hammer auth-source <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------|-----|---------|----- Id | x | x | x Name | x | x | x Type of auth source | x | x | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer
2.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 help
2.10.1. hammer bookmark create
Create a bookmark
Usage: hammer bookmark create [OPTIONS] Options: --controller VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --public BOOLEAN --query VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.10.2. hammer bookmark delete
Delete a bookmark
Usage: hammer bookmark <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.10.3. hammer bookmark info
Show a bookmark
Usage: hammer bookmark <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.10.4. hammer bookmark list
List all bookmarks
Usage: hammer bookmark <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help 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 | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: controller string name string
2.10.5. hammer bookmark update
Update a bookmark
Usage: hammer bookmark update [OPTIONS] Options: --controller VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --public BOOLEAN --query VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.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 help
2.11.1. hammer bootdisk generic
Download generic image
Usage: hammer bootdisk generic [OPTIONS] Options: --file VALUE File or device to write image to --force Force writing to existing destination (device etc.) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --sudo Use sudo to write to device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.11.2. hammer bootdisk host
Download host image
Usage: hammer bootdisk host [OPTIONS] Options: --file VALUE File or device to write image to --force Force writing to existing destination (device etc.) --full BOOLEAN True for full, false for basic reusable image --host VALUE Host name --host-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --sudo Use sudo to write to device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.11.3. hammer bootdisk subnet
Download subnet generic image
Usage: hammer bootdisk subnet [OPTIONS] Options: --file VALUE File or device to write image to --force Force writing to existing destination (device etc.) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --subnet VALUE Subnet name --subnet-id VALUE --sudo Use sudo to write to device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.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 info, show Show a capsule list, index List all capsules refresh-features Refresh capsule features update Update a capsule Options: -h, --help Print help
2.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 help
2.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 VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the lifecycle environment --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.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 LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to limit environments on --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Organization | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.1.3. hammer capsule content cancel-synchronization
Cancel running capsule synchronization
Usage: hammer capsule content cancel-synchronization [OPTIONS] Options: --id NUMBER Id of the capsule --name VALUE Name to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.1.4. hammer capsule content info
Get current capsule synchronization status
Usage: hammer capsule content info [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to get the status for --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help 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 -------------------------------------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
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 LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to limit environments on --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Organization | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
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 VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the lifecycle environment --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.1.7. hammer capsule content synchronization-status
Get current capsule synchronization status
Usage: hammer capsule content synchronization-status [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to get the status for --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help 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 --------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
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 --content-view VALUE Content view name to search by --content-view-id NUMBER Id of the content view to limit the synchronization on --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the environment to limit the synchronization on --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID --repository VALUE Repository name to search by --repository-id NUMBER Id of the repository to limit the synchronization on --skip-metadata-check BOOLEAN Skip metadata check on each repository on the capsule -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.2. hammer capsule create
Create a capsule
Usage: hammer capsule create [OPTIONS] Options: --download-policy VALUE Download Policy of the capsule, must be one of on_demand, immediate, inherit --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --url VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.3. hammer capsule delete
Delete a capsule
Usage: hammer capsule <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.4. hammer capsule info
Show a capsule
Usage: hammer capsule <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --include-status BOOLEAN Flag to indicate whether to include status or not --include-version BOOLEAN Flag to indicate whether to include version or not --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Status | x | x | Url | x | x | Features | x | x | Version | x | x | Host_count | x | x | Features/name | x | x | Features/version | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.5. hammer capsule list
List all capsules
Usage: hammer capsule <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --include-status BOOLEAN Flag to indicate whether to include status or not --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Status | x | x | Url | x | x | Features | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: feature string location string location_id integer name string organization string organization_id integer url string
2.12.6. hammer capsule refresh-features
Refresh capsule features
Usage: hammer capsule refresh-features [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.12.7. hammer capsule update
Update a capsule
Usage: hammer capsule update [OPTIONS] Options: --download-policy VALUE Download Policy of the capsule, must be one of on_demand, immediate, inherit --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --url VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.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 help
2.13.1. hammer compute-profile create
Create a compute profile
Usage: hammer compute-profile create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.13.2. hammer compute-profile delete
Delete a compute profile
Usage: hammer compute-profile <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute profile name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.13.3. hammer compute-profile info
Show a compute profile
Usage: hammer compute-profile <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute profile name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | ------------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.13.4. hammer compute-profile list
List of compute profiles
Usage: hammer compute-profile <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string
2.13.5. hammer compute-profile update
Update a compute profile
Usage: hammer compute-profile update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.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 help
2.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 VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string 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 compute_vnic_profile Vnic Profile Rackspace: --interface: VMware: --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware AzureRM: --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false)
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 VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string 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 KEY_VALUE_LIST Compute resource attributes --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values Can be specified multiple times. --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values Can be specified multiple times. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string 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_vnic_profile Vnic Profile --compute-attributes: cluster ID or name of cluster to use template Hardware profile to use cores Integer value, number of cores sockets Integer value, number of sockets memory Amount of memory, integer value in bytes ha Boolean, set 1 to high availability display_type Possible values: VNC, SPICE keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE. Rackspace: --volume: --interface: --compute-attributes: flavor_id VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware --compute-attributes: cluster Cluster ID from VMware corespersocket Number of cores per socket (applicable to hardware versions < 10 only) cpus CPU count memory_mb Integer number, amount of memory in MB path Path to folder resource_pool Resource Pool ID from VMware firmware automatic/bios/efi guest_id Guest OS ID form VMware hardware_version Hardware version ID from VMware memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine annotation Annotation Notes scsi_controllers List with SCSI controllers definitions type - ID of the controller from VMware key - Key of the controller (e.g. 1000) AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite) --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false) --compute-attributes: resource_group Existing Azure Resource Group of user vm_size VM Size, eg. Standard_A0 etc. username The Admin username password The Admin password platform OS type eg. Linux ssh_key_data SSH key for passwordless authentication os_disk_caching OS disk caching premium_os_disk Premium OS Disk, Boolean as 0 or 1 script_command Custom Script Command script_uris Comma seperated file URIs
2.13.6.4. hammer compute-profile values remove-interface
Remove compute profile interface
Usage: hammer compute-profile values remove-interface [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface-id NUMBER Interface id --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.13.6.5. hammer compute-profile values remove-volume
Remove compute profile volume
Usage: hammer compute-profile values remove-volume [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume-id NUMBER Volume id -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.13.6.6. hammer compute-profile values update
Update compute profile values
Usage: hammer compute-profile values update [OPTIONS] Options: --compute-attributes KEY_VALUE_LIST Compute resource attributes, should be comma separated list of values --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values Can be specified multiple times. --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values Can be specified multiple times. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string 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_vnic_profile Vnic Profile --compute-attributes: cluster ID or name of cluster to use template Hardware profile to use cores Integer value, number of cores sockets Integer value, number of sockets memory Amount of memory, integer value in bytes ha Boolean, set 1 to high availability display_type Possible values: VNC, SPICE keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE. Rackspace: --volume: --interface: --compute-attributes: flavor_id VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware --compute-attributes: cluster Cluster ID from VMware corespersocket Number of cores per socket (applicable to hardware versions < 10 only) cpus CPU count memory_mb Integer number, amount of memory in MB path Path to folder resource_pool Resource Pool ID from VMware firmware automatic/bios/efi guest_id Guest OS ID form VMware hardware_version Hardware version ID from VMware memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine annotation Annotation Notes scsi_controllers List with SCSI controllers definitions type - ID of the controller from VMware key - Key of the controller (e.g. 1000) AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite) --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false) --compute-attributes: resource_group Existing Azure Resource Group of user vm_size VM Size, eg. Standard_A0 etc. username The Admin username password The Admin password platform OS type eg. Linux ssh_key_data SSH key for passwordless authentication os_disk_caching OS disk caching premium_os_disk Premium OS Disk, Boolean as 0 or 1 script_command Custom Script Command script_uris Comma seperated file URIs
2.13.6.7. hammer compute-profile values update-interface
Update compute profile interface
Usage: hammer compute-profile values update-interface [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values --interface-id NUMBER Interface id --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string 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 compute_vnic_profile Vnic Profile Rackspace: --interface: VMware: --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware AzureRM: --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false)
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 VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values --volume-id NUMBER Volume id -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string 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: associate-vms Associate VMs to Hosts 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 vnic-profiles List available vnic profiles for a compute resource, for RHEV only zones List available zone for a compute resource Options: -h, --help Print help
2.14.1. hammer compute-resource associate-vms
Associate VMs to Hosts
Usage: hammer compute-resource associate-vms [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE Associate a specific VM -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.2. hammer compute-resource clusters
List available clusters for a compute resource
Usage: hammer compute-resource clusters [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.3. hammer compute-resource create
Create a compute resource
Usage: hammer compute-resource create [OPTIONS] Options: --app-ident VALUE Client ID for AzureRm --caching-enabled BOOLEAN Enable caching, for VMware only --cloud VALUE Cloud --datacenter VALUE For RHEV, VMware Datacenter --description VALUE --display-type ENUM For Libvirt and RHEV only Possible value(s): 'VNC', 'SPICE' --domain VALUE For RHEL OpenStack Platform (v3) only --email VALUE Email for GCE only --key-path VALUE Certificate path for GCE only --keyboard-layout ENUM For RHEV only Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --ovirt-quota VALUE For RHEV only, ID or Name of quota to use --password VALUE Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 --project VALUE Project id for GCE only --project-domain-id VALUE For RHEL OpenStack Platform (v3) only --project-domain-name VALUE For RHEL OpenStack Platform (v3) only --provider VALUE Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm --public-key VALUE For RHEV only --public-key-path FILE Path to a file that contains oVirt public key (For oVirt only) --region VALUE For AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region --secret-key VALUE Client Secret for AzureRm --server VALUE For VMware --set-console-password BOOLEAN For Libvirt and VMware only --sub-id VALUE Subscription ID for AzureRm --tenant VALUE For RHEL OpenStack Platform and AzureRm only --url VALUE URL for Libvirt, RHEV and RHEL OpenStack Platform --user VALUE Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for EC2. --zone VALUE For GCE only -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.4. hammer compute-resource delete
Delete a compute resource
Usage: hammer compute-resource <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.5. hammer compute-resource flavors
List available flavors for a compute resource
Usage: hammer compute-resource flavors [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.6. hammer compute-resource folders
List available folders for a compute resource
Usage: hammer compute-resource folders [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.7. 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 help
2.14.7.1. hammer compute-resource image available
Show images available for addition
Usage: hammer compute-resource image available [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Name | x | x | x Uuid | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.7.2. hammer compute-resource image create
Create an image
Usage: hammer compute-resource image create [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE --user-data BOOLEAN Whether or not the image supports user data --username VALUE --uuid VALUE Template ID in the compute resource -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.7.3. hammer compute-resource image delete
Delete an image
Usage: hammer compute-resource image <delete|destroy> [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.7.4. hammer compute-resource image info
Show an image
Usage: hammer compute-resource image <info|show> [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE ID of compute resource --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.7.5. hammer compute-resource image list
List all images for a compute resource
Usage: hammer compute-resource image <list|index> [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE ID of compute resource --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help 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 | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: architecture integer compute_resource string name string operatingsystem integer user_data Values: true, false username string
2.14.7.6. hammer compute-resource image update
Update an image
Usage: hammer compute-resource image update [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE --user-data BOOLEAN Whether or not the image supports user data --username VALUE --uuid VALUE Template ID in the compute resource -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.8. hammer compute-resource images
List available images for a compute resource
Usage: hammer compute-resource images [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Uuid | x | x | Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.9. hammer compute-resource info
Show a compute resource
Usage: hammer compute-resource <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.10. hammer compute-resource list
List all compute resources
Usage: hammer compute-resource <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Provider | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: id integer location string location_id integer name string organization string organization_id integer type string
2.14.11. hammer compute-resource networks
List available networks for a compute resource
Usage: hammer compute-resource networks [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.12. hammer compute-resource resource-pools
List resource pools for a compute resource cluster
Usage: hammer compute-resource resource-pools [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.13. hammer compute-resource security-groups
List available security groups for a compute resource
Usage: hammer compute-resource security-groups [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.14. hammer compute-resource storage-domains
List storage domains for a compute resource
Usage: hammer compute-resource storage-domains [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --storage-domain VALUE -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.15. hammer compute-resource storage-pods
List storage pods for a compute resource
Usage: hammer compute-resource storage-pods [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --storage-pod VALUE -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.16. hammer compute-resource update
Update a compute resource
Usage: hammer compute-resource update [OPTIONS] Options: --app-ident VALUE Client ID for AzureRm --caching-enabled BOOLEAN Enable caching, for VMware only --cloud VALUE Cloud --datacenter VALUE For RHEV, VMware Datacenter --description VALUE --display-type ENUM For Libvirt and RHEV only Possible value(s): 'VNC', 'SPICE' --domain VALUE For RHEL OpenStack Platform (v3) only --email VALUE Email for GCE only --id VALUE --key-path VALUE Certificate path for GCE only --keyboard-layout ENUM For RHEV only Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Compute resource name --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --ovirt-quota VALUE For RHEV only, ID or Name of quota to use --password VALUE Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 --project VALUE Project id for GCE only --project-domain-id VALUE For RHEL OpenStack Platform (v3) only --project-domain-name VALUE For RHEL OpenStack Platform (v3) only --provider VALUE Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm --public-key VALUE For RHEV only --public-key-path FILE Path to a file that contains oVirt public key (For oVirt only) --region VALUE For AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region --secret-key VALUE Client Secret for AzureRm --server VALUE For VMware --set-console-password BOOLEAN For Libvirt and VMware only --sub-id VALUE Subscription ID for AzureRm --tenant VALUE For RHEL OpenStack Platform and AzureRm only --url VALUE URL for Libvirt, RHEV and RHEL OpenStack Platform --user VALUE Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for EC2. --zone VALUE For GCE only -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.17. 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 help
2.14.17.1. hammer compute-resource virtual-machine delete
Delete a Virtual Machine
Usage: hammer compute-resource virtual-machine <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE Virtual machine id, for gce use virtual machine name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.17.2. hammer compute-resource virtual-machine info
Show a virtual machine
Usage: hammer compute-resource virtual-machine <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE 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 -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.17.3. hammer compute-resource virtual-machine power
Power a Virtual Machine
Usage: hammer compute-resource virtual-machine power [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE Virtual machine id, for gce use virtual machine name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.18. hammer compute-resource virtual-machines
List available virtual machines for a compute resource
Usage: hammer compute-resource virtual-machines [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.19. hammer compute-resource vnic-profiles
List available vnic profiles for a compute resource, for RHEV only
Usage: hammer compute-resource vnic-profiles [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Vnic profile id | x | x | x Name | x | x | x Network id | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.14.20. hammer compute-resource zones
List available zone for a compute resource
Usage: hammer compute-resource zones [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.15. 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 help
2.15.1. hammer config-report delete
Delete a report
Usage: hammer config-report <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.15.2. hammer config-report info
Show a report
Usage: hammer config-report <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------------|-----|---------|----- Id | x | x | x Host | x | x | Reported at | x | x | Origin | x | x | Report status/applied | x | x | Report status/restarted | x | x | Report status/failed | x | x | Report status/restart failures | x | x | Report status/skipped | x | x | Report status/pending | x | x | Report metrics/config_retrieval | x | x | Report metrics/exec | x | x | Report metrics/file | x | x | Report metrics/package | x | x | Report metrics/service | x | x | Report metrics/user | x | x | Report metrics/yumrepo | x | x | Report metrics/filebucket | x | x | Report metrics/cron | x | x | Report metrics/total | x | x | Logs/resource | x | x | Logs/message | x | x | --------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.15.3. hammer config-report list
List all reports
Usage: hammer config-report <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Host | x | x | Last report | x | x | Origin | x | x | Applied | x | x | Restarted | x | x | Failed | x | x | Restart failures | x | x | Skipped | x | x | Pending | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: applied integer eventful Values: true, false failed integer failed_restarts integer host string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string last_report datetime location string log text organization string origin string pending integer reported datetime resource text restarted integer skipped integer
2.16. hammer content-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 help
2.16.1. hammer content-credentials create
Create a Content Credential
Usage: hammer content-credentials create [OPTIONS] Options: --content-type VALUE Type of content: “cert”, “gpg_key” --name VALUE Name of the Content Credential --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path FILE Key file -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.16.2. hammer content-credentials delete
Destroy a Content Credential
Usage: hammer content-credentials <delete|destroy> [OPTIONS] Options: --id NUMBER Content Credential ID --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.16.3. hammer content-credentials info
Show a Content Credential
Usage: hammer content-credentials <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Content Credential numeric identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help 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 | --------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.16.4. hammer content-credentials list
List Content Credentials
Usage: hammer content-credentials <list|index> [OPTIONS] Options: --content-type VALUE Type of content --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --name VALUE Name of the Content Credential --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Content type | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.16.5. hammer content-credentials update
Update a Content Credential
Usage: hammer content-credentials update [OPTIONS] Options: --content-type VALUE Type of content: “cert”, “gpg_key” --id NUMBER Content Credential ID --name VALUE Name of the Content Credential --new-name VALUE Name of the Content Credential --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path FILE Key file -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17. hammer content-export
Prepare content for export to a disconnected Katello
Usage: hammer content-export [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: complete Prepare content for a full export to a disconnected Katello generate-metadata Writes export metadata to disk for use by the importing Katello. This command only needs to be used if the export was performed asynchronously or if the metadata was lost incremental Prepare content for an incremental export to a disconnected Katello list, index View content view export histories Options: -h, --help Print help
2.17.1. hammer content-export complete
Prepare content for a full export to a disconnected Katello
Usage: hammer content-export complete [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: library Performs a full export of the organization's library environment repository Performs a full export of a repository version Performs a full export a content view version Options: -h, --help Print help
2.17.1.1. hammer content-export complete library
Performs a full export of the organization’s library environment
Usage: hammer content-export complete library [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this organization are unexportable. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17.1.2. hammer content-export complete repository
Performs a full export of a repository
Usage: hammer content-export complete repository [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --id NUMBER Repository identifier --name VALUE Filter repositories by name. --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17.1.3. hammer content-export complete version
Performs a full export a content view version
Usage: hammer content-export complete version [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this version are unexportable. --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Filter versions by version number. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17.2. hammer content-export generate-metadata
Writes export metadata to disk for use by the importing Katello. This command only needs to be used if the export was performed asynchronously or if the metadata was lost
Usage: hammer content-export generate-metadata [OPTIONS] Options: --id VALUE Generate metadata based on specified export history --task-id VALUE Generate metadata based on output of the specified export task -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17.3. hammer content-export incremental
Prepare content for an incremental export to a disconnected Katello
Usage: hammer content-export incremental [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: library Performs an incremental export of the organization's library environment repository Performs an incremental export of a repository version Performs an incremental export of a content view version Options: -h, --help Print help
2.17.3.1. hammer content-export incremental library
Performs an incremental export of the organization’s library environment
Usage: hammer content-export incremental library [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this organization are unexportable. --from-history-id NUMBER Export history identifier used for incremental export. If not provided the most recent export history will be used. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17.3.2. hammer content-export incremental repository
Performs an incremental export of a repository
Usage: hammer content-export incremental repository [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --from-history-id NUMBER Export history identifier used for incremental export. If not provided the most recent export history will be used. --id NUMBER Repository identifier --name VALUE Filter repositories by name. --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17.3.3. hammer content-export incremental version
Performs an incremental export of a content view version
Usage: hammer content-export incremental version [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this version are unexportable. --from-history-id NUMBER Export history identifier used for incremental export. If not provided the most recent export history will be used. --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Filter versions by version number. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.17.4. hammer content-export list
View content view export histories
Usage: hammer content-export <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --destination-server VALUE Destination Server name --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --id NUMBER Content view version export history identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --type ENUM Export Types Possible value(s): 'complete', 'incremental' -h, --help Print help Predefined field sets: ------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------------|-----|---------|----- Id | x | x | x Destination server | x | x | Path | x | x | Type | x | x | Content view version | x | x | Content view version id | x | x | Created at | x | x | Updated at | x | x | ------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_view_id integer content_view_version_id integer id integer type string
2.18. hammer content-import
Import content from an upstream archive.
Usage: hammer content-import [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: library Imports a content archive to an organization's library lifecycle environment list, index View content view import histories repository Imports a repository version Imports a content archive to a content view version Options: -h, --help Print help
2.18.1. hammer content-import library
Imports a content archive to an organization’s library lifecycle environment
Usage: hammer content-import library [OPTIONS] Options: --async Do not wait for the task --metadata-file VALUE Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path VALUE Directory containing the exported Content View Version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.18.2. hammer content-import list
View content view import histories
Usage: hammer content-import <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --id NUMBER Content view version import history identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --type ENUM Import Types Possible value(s): 'complete', 'incremental' -h, --help Print help Predefined field sets: ------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------------|-----|---------|----- Id | x | x | x Path | x | x | Type | x | x | Content view version | x | x | Content view version id | x | x | Created at | x | x | Updated at | x | x | ------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_view_id integer content_view_version_id integer id integer type string
2.18.3. hammer content-import repository
Imports a repository
Usage: hammer content-import repository [OPTIONS] Options: --async Do not wait for the task --metadata-file VALUE Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path VALUE Directory containing the exported Content View Version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.18.4. hammer content-import version
Imports a content archive to a content view version
Usage: hammer content-import version [OPTIONS] Options: --async Do not wait for the task --metadata-file VALUE Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path VALUE Directory containing the exported Content View Version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.19. hammer content-units
Manipulate content units
Usage: hammer content-units [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a content unit list, index List content_units Options: -h, --help Print help
2.19.1. hammer content-units info
Show a content unit
Usage: hammer content-units <info|show> [OPTIONS] Options: --content-type VALUE Possible values: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A content unit identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Version | x | x | Filename | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.19.2. hammer content-units list
List content_units
Usage: hammer content-units <list|index> [OPTIONS] Options: --content-type VALUE Possible values: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Version | x | x | Filename | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20. 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 purge Delete old versions of a content view remove Remove versions and/or environments from a content view and reassign systems and keys remove-from-environment Remove a content view from an environment remove-repository Disassociate a resource remove-version Remove a content view version from a composite view update Update a content view version View and manage content view versions Options: -h, --help Print help
2.20.1. hammer content-view add-repository
Associate a resource
Usage: hammer content-view add-repository [OPTIONS] Options: --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 VALUE Content view name to search by --content-view-id NUMBER Content view id to search by --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 help
2.20.3.1. hammer content-view component add
Add components to the content view
Usage: hammer content-view component add [OPTIONS] Options: --component-content-view VALUE Content View name of the component who's latest version is desired --component-content-view-id VALUE Content View identifier of the component who's latest version is desired --component-content-view-version VALUE Content View Version number of the component. Either use this or --component-content-view-version-id option --component-content-view-version-id VALUE Content View Version identifier of the component --composite-content-view VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view identifier --latest Select the latest version of the components content view is desired --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view id --fields LIST Show specified fields or predefined field sets only. (See below) --organization[-id|-label] VALUE Organization name/label/id to search by -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Content view id | x | x | Name | x | x | Version | x | x | Component id | x | x | x Current version | x | x | Version id | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 VALUE Array of component content view identfiers to remove. Comma separated list of values --component-content-views VALUE Array of component content view names to remove. Comma separated list of values --component-ids LIST Array of content view component IDs to remove. Identifier of the component association --composite-content-view VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view identifier --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 VALUE Content View name of the component who's latest version is desired --component-content-view-id VALUE Content View identifier of the component who's latest version is desired --component-content-view-version VALUE Content View Version number of the component. Either use this or --component-content-view-version-id option --component-content-view-version-id VALUE Content View Version identifier of the component --composite-content-view VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view identifier --id NUMBER Content view component ID. Identifier of the component association --latest Select the latest version of the components content view is desired --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.4. hammer content-view copy
Copy a content view
Usage: hammer content-view copy [OPTIONS] Options: --id NUMBER Content view numeric identifier --name VALUE Content view name to search by --new-name VALUE New content view name --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.5. hammer content-view create
Create a content view
Usage: hammer content-view create [OPTIONS] Options: --auto-publish BOOLEAN Enable/Disable auto publish of composite view --component-ids LIST List of component content view version ids for composite views --composite Create a composite content view --description VALUE Description for the content view --import-only Designate this Content View for importing from upstream servers only. --label VALUE Content view label --name VALUE Name of the content view --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository-ids LIST List of repository ids --solve-dependencies BOOLEAN Solve RPM dependencies by default on Content View publish, defaults to false -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.6. hammer content-view delete
Delete a content view
Usage: hammer content-view delete [OPTIONS] Options: --async Do not wait for the task --id NUMBER Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 help
2.20.7.1. hammer content-view filter add-repository
Associate a resource
Usage: hammer content-view filter add-repository [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --id VALUE Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.7.2. hammer content-view filter create
create a filter for a content view
Usage: hammer content-view filter create [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --description VALUE Description of the filter --inclusion BOOLEAN Specifies if content should be included or excluded, default: inclusion=false --name VALUE Name of the filter --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --original-module-streams BOOLEAN Add all module streams without errata to the included/excluded list. (module stream filter only) --original-packages BOOLEAN Add all packages without errata to the included/excluded list. (package filter only) --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repositories LIST --repository-ids LIST List of repository ids --type VALUE Type of filter (e.g. rpm, package_group, erratum, erratum_id, erratum_date, docker, modulemd) -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.7.3. hammer content-view filter delete
delete a filter
Usage: hammer content-view filter <delete|destroy> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --id NUMBER Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.7.4. hammer content-view filter info
show filter info
Usage: hammer content-view filter <info|show> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help 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 | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.7.5. hammer content-view filter list
list filters
Usage: hammer content-view filter <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --name VALUE Filter content view filters by name --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --types LIST Types of filters -h, --help Print help 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 | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_type Values: rpm, package_group, erratum, docker, modulemd inclusion_type Values: include, exclude name string
2.20.7.6. hammer content-view filter remove-repository
Disassociate a resource
Usage: hammer content-view filter remove-repository [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --id VALUE Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 help
2.20.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 VALUE Package: architecture --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --date-type VALUE Erratum: search using the 'Issued On' or 'Updated On' column of the errata. Values are 'issued'/'updated' --end-date VALUE Erratum: end date (YYYY-MM-DD) --errata-id VALUE Erratum: id --errata-ids LIST Erratum: IDs or a select all object --max-version VALUE Package: maximum version --min-version VALUE Package: minimum version --module-stream-ids LIST Module stream ids --name LIST Package, package group, or docker tag names --names VALUE Package and package group names --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --start-date VALUE Erratum: start date (YYYY-MM-DD) --types LIST Erratum: types (enhancement, bugfix, security) --uuid VALUE Package group: uuid --version VALUE Package: version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --id NUMBER Rule identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Rule identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help 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 | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.7.7.4. hammer content-view filter rule list
List filter rules
Usage: hammer content-view filter rule <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --errata-id VALUE Errata_id of the content view filter rule --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --name VALUE Name of the content view filter rule --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help 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 | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.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 VALUE Package: architecture --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --end-date VALUE Erratum: end date (YYYY-MM-DD) --errata-id VALUE Erratum: id --id NUMBER Rule identifier --max-version VALUE Package: maximum version --min-version VALUE Package: minimum version --name VALUE Package, package group, or docker tag: name --new-name VALUE Package, package group, or docker tag: name --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --start-date VALUE Erratum: start date (YYYY-MM-DD) --types LIST Erratum: types (enhancement, bugfix, security) --version VALUE Package: version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.7.8. hammer content-view filter update
update a filter
Usage: hammer content-view filter update [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --description VALUE Description of the filter --id NUMBER Filter identifier --inclusion BOOLEAN Specifies if content should be included or excluded, default: inclusion=false --name VALUE New name for the filter --new-name VALUE New name for the filter --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --original-module-streams BOOLEAN Add all module streams without errata to the included/excluded list. (module stream filter only) --original-packages BOOLEAN Add all packages without errata to the included/excluded list. (package filter only) --repositories LIST --repository-ids LIST List of repository ids -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.8. hammer content-view info
Show a content view
Usage: hammer content-view <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help 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 | 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 | 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 | -----------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.9. hammer content-view list
List content views
Usage: hammer content-view <list|index> [OPTIONS] Options: --composite BOOLEAN Filter only composite content views --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --include-generated BOOLEAN Include content views generated by imports/exports. Defaults to false --label VALUE Label of the content view --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --name VALUE Name of the content view --noncomposite BOOLEAN Filter out composite content views --nondefault BOOLEAN Filter out default content views --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --without LIST Do not include this array of content views -h, --help Print help 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 | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: composite boolean generated_for integer label string name string organization_id integer
2.20.10. hammer content-view publish
Publish a content view
Usage: hammer content-view publish [OPTIONS] Options: --async Do not wait for the task --description VALUE Description for the new published content view version --id NUMBER Content view identifier --is-force-promote BOOLEAN Force content view promotion and bypass lifecycle environment restriction --lifecycle-environment-ids LIST Identifiers for Lifecycle Environment --lifecycle-environments LIST Names for Lifecycle Environment --major NUMBER Override the major version number --minor NUMBER Override the minor version number --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --repos-units SCHEMA Specify the list of units in each repo -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --repos-units "label=<string>\,rpm_filenames=<array>, ... "
2.20.11. 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 NUMBER Count of unused versions to keep Default: 3 --id VALUE Content View numeric identifier --name VALUE Content View name --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.12. 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 LIST Content view version identifiers to be deleted --content-view-versions LIST --destroy-content-view BOOLEAN Delete the content view with all the versions and environments --environment-ids LIST (--environment-ids is deprecated: Use --lifecycle-environment-ids instead) --environments LIST (--environments is deprecated: Use --lifecycle-environments instead) --id NUMBER Content view numeric identifier --key-content-view-id NUMBER Content view to reassign orphaned activation keys to --key-environment-id NUMBER Environment to reassign orphaned activation keys to --lifecycle-environment-ids LIST Environment numeric identifiers to be removed --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --system-content-view-id NUMBER Content view to reassign orphaned systems to --system-environment-id NUMBER Environment to reassign orphaned systems to -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.13. 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 VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Content view numeric identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.14. hammer content-view remove-repository
Disassociate a resource
Usage: hammer content-view remove-repository [OPTIONS] Options: --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.15. hammer content-view remove-version
Remove a content view version from a composite view
Usage: hammer content-view remove-version [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.16. hammer content-view update
Update a content view
Usage: hammer content-view update [OPTIONS] Options: --auto-publish BOOLEAN Enable/Disable auto publish of composite view --component-ids LIST List of component content view version ids for composite views --description VALUE Description for the content view --id NUMBER Content view identifier --import-only BOOLEAN Designate this Content View for importing from upstream servers only. Defaults to false --name VALUE New name for the content view --new-name VALUE New name for the content view --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --repository-ids LIST List of repository ids --solve-dependencies BOOLEAN Solve RPM dependencies by default on Content View publish, defaults to false -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.17. 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 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 help
2.20.17.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 VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.17.2. 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 VALUE Content view version number --content-view-version-id NUMBER Content View Version Ids to perform an incremental update on. May contain composites as well as one or more components to update. --deb-ids LIST Deb Package ids to copy into the new versions --debs LIST --description VALUE The description for the new generated Content View Versions --errata-ids LIST Errata ids to copy into the new versions --host-ids LIST IDs of hosts to update --lifecycle-environment-ids LIST List of lifecycle environment IDs to update the content view version in --lifecycle-environments LIST List of lifecycle environment names to update the content view version in --organization VALUE Organization name for resolving lifecycle environment names --organization-id VALUE Organization id for resolving lifecycle environment names --package-ids LIST Package ids to copy into the new versions --packages LIST --propagate-all-composites BOOLEAN If true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment --resolve-dependencies BOOLEAN If true, when adding the specified errata or packages, any needed dependencies will be copied as well. Defaults to true --update-all-hosts BOOLEAN Update all editable and applicable hosts within the specified Content View and \ Lifecycle Environments -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.17.3. hammer content-view version info
Show content view version
Usage: hammer content-view version <info|show> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help 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 | -----------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.17.4. hammer content-view version list
List content view versions
Usage: hammer content-view version <list|index> [OPTIONS] Options: --composite-version-id NUMBER Filter versions that are components in the specified composite version --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Filter versions by environment --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --triggered-by-id NUMBER Filter composite versions whose publish was triggered by the specified component version --version VALUE Filter versions by version number -h, --help Print help 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 | -----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_view_id integer repository string version string
2.20.17.5. 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 VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --description VALUE The description for the content view version promotion --force Force content view promotion and bypass lifecycle environment restriction --from-lifecycle-environment VALUE Environment name from where to promote its version from (if version is unknown) --from-lifecycle-environment-id VALUE Id of the environment from where to promote its version from (if version is unknown) --id NUMBER Content view version identifier --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --to-lifecycle-environment VALUE Name of the target environment --to-lifecycle-environment-id VALUE Id of the target environment --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.17.6. 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 VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --force BOOLEAN Force metadata regeneration to proceed. Dangerous when repositories use the 'Complete Mirroring' mirroring policy --id NUMBER Content view version identifier --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.20.17.7. hammer content-view version update
Update a content view version
Usage: hammer content-view version update [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --description VALUE The description for the content view version --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --new-version VALUE --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.21. 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 package list, index List deb packages Options: -h, --help Print help
2.21.1. hammer deb-package info
Show a deb package
Usage: hammer deb-package <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A deb package identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help 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 | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.21.2. hammer deb-package list
List deb packages
Usage: hammer deb-package <list|index> [OPTIONS] Options: --available-for VALUE Return deb packages that can be added to the specified object. Only the value 'content_view_version' is supported. --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content View Filter identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content View Version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER Host id to list applicable deb packages for --ids LIST Deb package identifiers to filter content by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --packages-restrict-applicable BOOLEAN Return deb packages that are applicable to one or more hosts (defaults to true if host_id is specified) --packages-restrict-upgradable BOOLEAN Return deb packages that are upgradable on one or more hosts --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: ---------|-----|-------- FIELDS | ALL | DEFAULT ---------|-----|-------- Id | x | x Filename | x | x ---------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.22. hammer defaults
Defaults management
Usage: hammer defaults [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add Add a default parameter to config delete Delete a default param list List all the default parameters providers List all the providers Options: -h, --help Print help
2.22.1. hammer defaults add
Add a default parameter to config
Usage: hammer defaults add [OPTIONS] Options: --param-name VALUE The name of the default option (e.g. organization_id) --param-value VALUE The value for the default option --provider VALUE The name of the provider providing the value. For list available providers see `hammer defaults providers` -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.22.2. hammer defaults delete
Delete a default param
Usage: hammer defaults delete [OPTIONS] Options: --param-name VALUE The name of the default option -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.22.3. hammer defaults list
List all the default parameters
Usage: hammer defaults list [OPTIONS] Options: -h, --help Print help
2.22.4. hammer defaults providers
List all the providers
Usage: hammer defaults providers [OPTIONS] Options: -h, --help Print help
2.23. 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 help
2.23.1. hammer discovery auto-provision
Auto provision a host
Usage: hammer discovery auto-provision [OPTIONS] Options: --all Auto provision all discovered hosts --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.23.2. hammer discovery delete
Delete a discovered host
Usage: hammer discovery <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.23.3. hammer discovery facts
List all fact values
Usage: hammer discovery facts [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|-------- FIELDS | ALL | DEFAULT -------|-----|-------- Fact | x | x Value | x | x -------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: fact string fact_short_name string facts string host string host.hostgroup string host_id integer location string location_id integer name string organization string organization_id integer origin string reported_at datetime short_name string type string value string
2.23.4. hammer discovery info
Show a discovered host
Usage: hammer discovery <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.23.5. hammer discovery list
List all discovered hosts
Usage: hammer discovery <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort results --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page VALUE Paginate results --per-page VALUE Number of entries per request --search VALUE Filter results -h, --help Print help 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 | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.23.6. hammer discovery provision
Provision a discovered host
Usage: hammer discovery provision [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id NUMBER Required if host is managed and value is not inherited from host group --ask-root-password BOOLEAN --build BOOLEAN --capabilities VALUE --domain VALUE Domain name --domain-id NUMBER Required if host is managed and value is not inherited from host group --enabled BOOLEAN --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --id VALUE --image VALUE Name to search by --image-id NUMBER --interface KEY_VALUE_LIST Interface parameters Can be specified multiple times. --ip VALUE Not required if using a subnet with DHCP Capsule --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mac VALUE Not required if it's a virtual machine --managed BOOLEAN --medium VALUE Medium name --medium-id VALUE Required if not imaged based provisioning and host is managed and value is not inherited from host group --model VALUE Model name --model-id NUMBER --name VALUE --new-name VALUE --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER Required if host is managed and value is not inherited from host group --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --overwrite BOOLEAN --owner-id NUMBER --owner-type ENUM Host's owner type Possible value(s): 'User', 'Usergroup' --parameters KEY_VALUE_LIST Host parameters --partition-table VALUE Partition table name --partition-table-id NUMBER --progress-report-id VALUE UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks --provision-method ENUM Possible value(s): 'build', 'image' --pxe-loader ENUM DHCP filename option (Grub2 or PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --root-password VALUE --sp-subnet-id NUMBER --subnet VALUE Subnet name --subnet-id NUMBER Required if host is managed and value is not inherited from host group -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.23.7. hammer discovery reboot
Reboot a host
Usage: hammer discovery reboot [OPTIONS] Options: --all Reboot all discovered hosts --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.23.8. hammer discovery refresh-facts
Refresh the facts of a host
Usage: hammer discovery refresh-facts [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.24. 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 help
2.24.1. hammer discovery-rule create
Create a discovery rule
Usage: hammer discovery-rule create [OPTIONS] Options: --enabled BOOLEAN Flag is used for temporary shutdown of rules --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER The hostgroup that is used to auto provision a host --hostgroup-title VALUE Hostgroup title --hostname VALUE Defines a pattern to assign human-readable hostnames to the matching hosts --hosts-limit VALUE Enables to limit maximum amount of provisioned hosts per rule --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST Location ID for provisioned hosts --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Represents rule name shown to the users --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST Organization ID for provisioned hosts --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --priority NUMBER Puts the rules in order, low numbers go first. Must be greater then zero --search VALUE Query to match discovered hosts for the particular rule -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.24.2. hammer discovery-rule delete
Delete a rule
Usage: hammer discovery-rule <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.24.3. hammer discovery-rule info
Show a discovery rule
Usage: hammer discovery-rule <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help 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 | ------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.24.4. hammer discovery-rule list
List all discovery rules
Usage: hammer discovery-rule <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort results --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page VALUE Paginate results --per-page VALUE Number of entries per request --search VALUE Filter results -h, --help Print help 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 | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.24.5. hammer discovery-rule update
Update a rule
Usage: hammer discovery-rule update [OPTIONS] Options: --enabled BOOLEAN Flag is used for temporary shutdown of rules --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER The hostgroup that is used to auto provision a host --hostgroup-title VALUE Hostgroup title --hostname VALUE Defines a pattern to assign human-readable hostnames to the matching hosts --hosts-limit VALUE Enables to limit maximum amount of provisioned hosts per rule --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST Location ID for provisioned hosts --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Represents rule name shown to the users --new-name VALUE Represents rule name shown to the users --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST Organization ID for provisioned hosts --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --priority NUMBER Puts the rules in order, low numbers go first. Must be greater then zero --search VALUE Query to match discovered hosts for the particular rule -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.25. hammer docker
Manipulate docker content
Usage: hammer docker [OPTIONS] SUBCOMMAND [ARG] ... Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: manifest Manage docker manifests tag Manage docker tags Options: -h, --help Print help
2.25.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 help
2.25.1.1. hammer docker manifest info
Show a docker manifest
Usage: hammer docker manifest <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A docker manifest identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help 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 | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.25.1.2. hammer docker manifest list
List docker_manifests
Usage: hammer docker manifest <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help 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 | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.25.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 help
2.25.2.1. hammer docker tag info
Show a docker tag
Usage: hammer docker tag <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A docker tag identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help 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 | ---------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.25.2.2. hammer docker tag list
List docker_tags
Usage: hammer docker tag <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: --------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------|-----|---------|----- Id | x | x | x Tag | x | x | x Repository id | x | x | --------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.26. 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 help
2.26.1. hammer domain create
Create a domain
Usage: hammer domain create [OPTIONS] Options: --description VALUE Full name describing the domain --dns VALUE Name of DNS proxy to use within this domain --dns-id VALUE ID of DNS proxy to use within this domain --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The full DNS domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.26.2. hammer domain delete
Delete a domain
Usage: hammer domain <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.26.3. hammer domain delete-parameter
Delete parameter for a domain
Usage: hammer domain delete-parameter [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --name VALUE Parameter name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.26.4. hammer domain info
Show a domain
Usage: hammer domain <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Numerical ID or domain name --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --show-hidden-parameters BOOLEAN Display hidden parameter values -h, --help Print help 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 | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.26.5. hammer domain list
List of domains
Usage: hammer domain <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --subnet VALUE Subnet name --subnet-id VALUE ID of subnet -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: fullname string location string location_id integer name string organization string organization_id integer params string
2.26.6. hammer domain set-parameter
Create or update parameter for a domain
Usage: hammer domain set-parameter [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --hidden-value BOOLEAN Should the value be hidden --name VALUE Parameter name --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: "string" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.26.7. hammer domain update
Update a domain
Usage: hammer domain update [OPTIONS] Options: --description VALUE Full name describing the domain --dns VALUE Name of DNS proxy to use within this domain --dns-id VALUE ID of DNS proxy to use within this domain --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The full DNS domain name --new-name VALUE The full DNS domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string
2.27. 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 help
2.27.1. hammer erratum info
Show an erratum
Usage: hammer erratum info [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE An erratum identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help 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 ------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or