Red Hat SummitChapter 6. ansible
Manage foreman ansible
Usage
hammer ansible [OPTIONS] SUBCOMMAND [ARG] ...
# hammer ansible [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
6.1. ansible inventory
Ansible Inventory
Usage
hammer ansible inventory [OPTIONS] SUBCOMMAND [ARG] ...
# hammer ansible inventory [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
6.1.1. ansible inventory hostgroups
Show Ansible inventory for hostgroups
Usage
hammer ansible inventory hostgroups [OPTIONS]
# hammer ansible inventory hostgroups [OPTIONS]Options
-
--as-json– Full response as json -
--hostgroup-ids LIST– IDs of hostgroups included in inventory -
--hostgroup-titles LIST -
--hostgroups LIST -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
-h,--help– Print help
6.1.2. ansible inventory hosts
Show Ansible inventory for hosts
Usage
hammer ansible inventory hosts [OPTIONS]
# hammer ansible inventory hosts [OPTIONS]Options
-
--as-json– Full response as json -
--host-ids LIST– IDs of hosts included in inventory -
--hosts LIST -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
-h,--help– Print help
6.1.3. ansible inventory schedule
Schedule generating of Ansible Inventory report
Usage
hammer ansible inventory schedule [OPTIONS]
# hammer ansible inventory schedule [OPTIONS]Options
-
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
--report-format ENUM– Report format, defaults tojsonPossible value(s):csv,json,yaml,html -
-h,--help– Print help
6.2. ansible roles
Manage ansible roles
Usage
hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ...
# hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
6.2.1. ansible roles delete
Deletes Ansible role
Usage
hammer ansible roles <delete|destroy> [OPTIONS]
# 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
6.2.2. ansible roles fetch
Fetch Ansible roles available to be synced
Usage
hammer ansible roles fetch [OPTIONS]
# 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
6.2.3. ansible roles import
DEPRECATED: Import Ansible roles
Usage
hammer ansible roles import [OPTIONS]
# 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
6.2.4. ansible roles info
Show role
Usage
hammer ansible roles <info|show> [OPTIONS]
# 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 |
6.2.5. ansible roles list
List Ansible roles
Usage
hammer ansible roles <list|index> [OPTIONS]
# 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,allto 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 |
Search and order fields
-
host– string -
host_id– integer -
hostgroup– string -
hostgroup_id– integer -
id– integer -
name– string -
updated_at– datetime
6.2.6. ansible roles obsolete
DEPRECATED: Obsolete Ansible roles
Usage
hammer ansible roles obsolete [OPTIONS]
# 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
6.2.7. ansible roles play-hostgroups
Runs all Ansible roles on hostgroups
Usage
hammer ansible roles play-hostgroups [OPTIONS]
# 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
6.2.8. ansible roles play-hosts
Runs all Ansible roles on hosts
Usage
hammer ansible roles play-hosts [OPTIONS]
# 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
6.2.9. ansible roles sync
Sync Ansible roles
Usage
hammer ansible roles sync [OPTIONS]
# 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
6.3. ansible variables
Manage ansible variables
Usage
hammer ansible variables [OPTIONS] SUBCOMMAND [ARG] ...
# hammer ansible variables [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
6.3.1. ansible variables add-matcher
Create an override value for a specific ansible variable
Usage
hammer ansible variables add-matcher [OPTIONS]
# 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
6.3.2. ansible variables create
Create Ansible variable
Usage
hammer ansible variables create [OPTIONS]
# 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 VALUEThe 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
6.3.3. ansible variables delete
Deletes Ansible variable
Usage
hammer ansible variables <delete|destroy> [OPTIONS]
# 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
6.3.4. ansible variables import
DEPRECATED: Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles
Usage
hammer ansible variables import [OPTIONS]
# 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
6.3.5. ansible variables info
Show variable
Usage
hammer ansible variables <info|show> [OPTIONS]
# 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 |
6.3.6. ansible variables list
List Ansible variables
Usage
hammer ansible variables <list|index> [OPTIONS]
# 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,allto 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 |
Search and 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
6.3.7. ansible variables obsolete
DEPRECATED: Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles
Usage
hammer ansible variables obsolete [OPTIONS]
# 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
6.3.8. ansible variables remove-matcher
Destroy an override value
Usage
hammer ansible variables remove-matcher [OPTIONS]
# 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
6.3.9. ansible variables update
Updates Ansible variable
Usage
hammer ansible variables update [OPTIONS]
# 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
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}