Red Hat SummitChapter 87. sync-plan
Manipulate sync plans
Usage
hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...
# hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
87.1. sync-plan create
Create a sync plan
Usage
hammer sync-plan create [OPTIONS]
# hammer sync-plan create [OPTIONS]Options
-
--cron-expression VALUE– Set this when interval is custom cron -
--description VALUE– Sync plan description -
--enabled BOOLEAN– Enables or disables synchronization -
--interval VALUE– How often synchronization should run -
--name VALUE– Sync plan name -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--sync-date DATETIME– Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered -
-h,--help– Print help
87.2. sync-plan delete
Destroy a sync plan
Usage
hammer sync-plan <delete|destroy> [OPTIONS]
# hammer sync-plan <delete|destroy> [OPTIONS]Options
-
--id NUMBER– Sync plan numeric identifier -
--name VALUE– Sync plan name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
-h,--help– Print help
87.3. sync-plan info
Show a sync plan
Usage
hammer sync-plan <info|show> [OPTIONS]
# hammer sync-plan <info|show> [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--id NUMBER– Sync plan numeric identifier -
--name VALUE– Sync plan name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
| Start date | x | x | |
| Interval | x | x | |
| Enabled | x | x | |
| Cron expression | x | x | |
| Recurring logic id | x | x | |
| Description | x | x | |
| Created at | x | x | |
| Updated at | x | x | |
| Next sync | x | x | |
| Products/id | x | x | |
| Products/name | x | x |
87.4. sync-plan list
List sync plans
Usage
hammer sync-plan <list|index> [OPTIONS]
# hammer sync-plan <list|index> [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--full-result BOOLEAN– Whether or not to show all results -
--interval ENUM– Filter by interval Possible value(s):hourly,daily,weekly,custom cron -
--name VALUE– Filter by name -
--order VALUE– Sort field and order, eg.id DESC -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--page NUMBER– Page number, starting at 1 -
--per-page NUMBER– Number of results per page to return -
--search VALUE– Search string -
--sync-date VALUE– Filter by sync date -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
| Start date | x | x | |
| Interval | x | x | |
| Enabled | x | x | |
| Cron expression | x | x | |
| Recurring logic id | x | x |
Search and order fields
-
enabled– Values: true, false -
interval– string -
name– string -
organization_id– integer
87.5. sync-plan update
Update a sync plan
Usage
hammer sync-plan update [OPTIONS]
# hammer sync-plan update [OPTIONS]Options
-
--cron-expression VALUE– Add custom cron logic for sync plan -
--description VALUE– Sync plan description -
--enabled BOOLEAN– Enables or disables synchronization -
--id NUMBER– Sync plan numeric identifier -
--interval VALUE– How often synchronization should run -
--name VALUE– Sync plan name -
--new-name VALUE– Sync plan name -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--sync-date DATETIME– Start date and time of the synchronization -
-h,--help– Print help
'%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}