Red Hat Summitこのコンテンツは選択した言語では利用できません。
Chapter 74. report-template
Manipulate report templates
Usage
hammer report-template [OPTIONS] SUBCOMMAND [ARG] ...
# hammer report-template [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
74.1. report-template clone
リンクのコピーリンクがクリップボードにコピーされました!
Clone a template
Usage
hammer report-template clone [OPTIONS]
# hammer report-template clone [OPTIONS]Options
-
--id VALUE -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--name VALUE– Template name -
--new-name VALUE -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
-h,--help– Print help
74.2. report-template create
リンクのコピーリンクがクリップボードにコピーされました!
Create a report template
Usage
hammer report-template create [OPTIONS]
# hammer report-template create [OPTIONS]Options
-
--audit-comment VALUE -
--default BOOLEAN– Whether or not the template is added automatically to new organizations and locations -
--description VALUE -
--file FILE– Path to a file that contains the report template content -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-ids LIST– REPLACE locations with given ids -
--location-title VALUE– Set the current location context for the request -
--location-titles LIST -
--locations LIST -
--locked BOOLEAN– Whether or not the template is locked for editing -
--name VALUE -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-ids LIST– REPLACE organizations with given ids. -
--organization-title VALUE– Set the current organization context for the request -
--organization-titles LIST -
--organizations LIST -
--snippet BOOLEAN -
-h,--help– Print help -
-i,--interactive– Open empty template in an $EDITOR. Upload the result
74.3. report-template delete
リンクのコピーリンクがクリップボードにコピーされました!
Delete a report template
Usage
hammer report-template <delete|destroy> [OPTIONS]
# hammer report-template <delete|destroy> [OPTIONS]Options
-
--id VALUE -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--name VALUE– Name to search by -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
-h,--help– Print help
74.4. report-template dump
リンクのコピーリンクがクリップボードにコピーされました!
View report content
Usage
hammer report-template dump [OPTIONS]
# hammer report-template dump [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--id VALUE -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--name VALUE– Name to search by -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
-h,--help– Print help
Predefined field sets
| FIELDS |
74.5. report-template export
リンクのコピーリンクがクリップボードにコピーされました!
Export a report template to ERB
Usage
hammer report-template export [OPTIONS]
# hammer report-template export [OPTIONS]Options
-
--id VALUE -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--name VALUE– Name to search by -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
--path VALUE– Path to directory where downloaded content will be saved -
-h,--help– Print help
74.6. report-template generate
リンクのコピーリンクがクリップボードにコピーされました!
Generate report
Usage
hammer report-template generate [OPTIONS]
# hammer report-template generate [OPTIONS]Options
-
--gzip BOOLEAN– Compress the report uzing gzip -
--id VALUE -
--inputs KEY_VALUE_LIST– Specify inputs -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--name VALUE– Name to search by -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
--path VALUE– Path to directory where downloaded content will be saved -
--report-format ENUM– Report format, defaults tocsvPossible value(s):csv,json,yaml,html -
-h,--help– Print help
74.7. report-template import
リンクのコピーリンクがクリップボードにコピーされました!
Import a report template
Usage
hammer report-template import [OPTIONS]
# hammer report-template import [OPTIONS]Options
-
--associate ENUM– Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s):new,always,never -
--default BOOLEAN– Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) -
--file FILE– Path to a file that contains the report template content including metadata -
--force BOOLEAN– Use if you want update locked templates -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-ids LIST– REPLACE locations with given ids -
--location-title VALUE– Set the current location context for the request -
--location-titles LIST -
--locations LIST -
--lock BOOLEAN– Lock imported templates (false by default) -
--name VALUE– Template name -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-ids LIST– REPLACE organizations with given ids. -
--organization-title VALUE– Set the current organization context for the request -
--organization-titles LIST -
--organizations LIST -
-h,--help– Print help
74.8. report-template info
リンクのコピーリンクがクリップボードにコピーされました!
Show a report template
Usage
hammer report-template <info|show> [OPTIONS]
# hammer report-template <info|show> [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--id VALUE -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--name VALUE– Name to search by -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
| Description | x | x | |
| Locked | x | x | |
| Default | x | x | |
| Created at | x | x | |
| Updated at | x | x | |
| Locations/ | x | x | |
| Organizations/ | x | x | |
| Template inputs/id | x | x | |
| Template inputs/name | x | x | |
| Template inputs/description | x | x | |
| Template inputs/required | x | x | |
| Template inputs/options | x | x |
74.9. report-template list
リンクのコピーリンクがクリップボードにコピーされました!
List all report templates
Usage
hammer report-template <list|index> [OPTIONS]
# hammer report-template <list|index> [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Scope by locations -
--location-title VALUE– Set the current location context for the request -
--order VALUE– Sort and order by a searchable field, e.g.<field> DESC -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Scope by organizations -
--organization-title VALUE– Set the current organization context for the request -
--page NUMBER– Page number, starting at 1 -
--per-page VALUE– Number of results per page to return,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 |
Search and order fields
-
default– Values: true, false -
id– integer -
location– string -
location_id– integer -
locked– Values: true, false -
name– string -
organization– string -
organization_id– integer -
snippet– Values: true, false -
template– text
74.10. report-template report-data
リンクのコピーリンクがクリップボードにコピーされました!
Downloads a generated report
Usage
hammer report-template report-data [OPTIONS]
# hammer report-template report-data [OPTIONS]Options
-
--id VALUE -
--job-id VALUE– ID assigned to generating job by the schedule command -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--name VALUE– Name to search by -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
--path VALUE– Path to directory where downloaded content will be saved -
-h,--help– Print help
74.11. report-template schedule
リンクのコピーリンクがクリップボードにコピーされました!
Schedule generating of a report
Usage
hammer report-template schedule [OPTIONS]
# hammer report-template schedule [OPTIONS]Options
-
--generate-at VALUE– UTC time to generate report at -
--gzip BOOLEAN– Compress the report using gzip -
--id VALUE -
--inputs KEY_VALUE_LIST– Specify inputs -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-title VALUE– Set the current location context for the request -
--mail-to VALUE– If set, scheduled report will be delivered via e-mail. Use,to separate multiple email addresses. -
--name VALUE– Name to search by -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-title VALUE– Set the current organization context for the request -
--path VALUE– Path to directory where downloaded content will be saved. Only usable if wait is specified -
--report-format ENUM– Report format, defaults tocsvPossible value(s):csv,json,yaml,html -
--wait– Turns a command to be active, wait for the result and download it right away -
-h,--help– Print help
74.12. report-template update
リンクのコピーリンクがクリップボードにコピーされました!
Update a report template
Usage
hammer report-template update [OPTIONS]
# hammer report-template update [OPTIONS]Options
-
--audit-comment VALUE -
--default BOOLEAN– Whether or not the template is added automatically to new organizations and locations -
--description VALUE -
--file FILE– Path to a file that contains the report template content -
--id VALUE -
--location VALUE– Set the current location context for the request -
--location-id NUMBER– Set the current location context for the request -
--location-ids LIST– REPLACE locations with given ids -
--location-title VALUE– Set the current location context for the request -
--location-titles LIST -
--locations LIST -
--locked BOOLEAN– Whether or not the template is locked for editing -
--name VALUE -
--new-name VALUE -
--organization VALUE– Set the current organization context for the request -
--organization-id NUMBER– Set the current organization context for the request -
--organization-ids LIST– REPLACE organizations with given ids. -
--organization-title VALUE– Set the current organization context for the request -
--organization-titles LIST -
--organizations LIST -
--snippet BOOLEAN -
-h,--help– Print help -
-i,--interactive– Dump existing template and open it in an $EDITOR. Update with the result
'%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}