2.81. hammer sync-plan
同期プランを操作します。
Usage:
hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a sync plan
delete, destroy Destroy a sync plan
info, show Show a sync plan
list, index List sync plans
update Update a sync plan
Options:
-h, --help Print help2.81.1. hammer sync-plan create
同期プランを作成します。
Usage:
hammer sync-plan create [OPTIONS]
Options:
--cron-expression CRON EXPRESSION Set this when interval is custom cron
--description DESCRIPTION Sync plan description
--enabled ENABLED Enables or disables synchronization
One of true/false, yes/no, 1/0.
--interval INTERVAL How often synchronization should run
--name NAME Sync plan name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--sync-date SYNC_DATE Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
-h, --help Print help2.81.2. hammer sync-plan delete
同期プランを破棄します。
Usage:
hammer sync-plan <delete|destroy> [OPTIONS]
Options:
--id ID Sync plan numeric identifier
--name NAME Sync plan name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help2.81.3. hammer sync-plan info
同期プランを表示します。
Usage:
hammer sync-plan <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID Sync plan numeric identifier
--name NAME Sync plan name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Start date | x | x |
Interval | x | x |
Enabled | x | x |
Cron expression | x | x |
Recurring logic id | x | x |
Description | x | x |
Created at | x | x |
Updated at | x | x |
Next sync | x | x |
Products/id | x | x |
Products/name | x | x |
-------------------|-----|---------|-----2.81.4. hammer sync-plan list
同期プランの一覧を表示します。
Usage:
hammer sync-plan <list|index> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--full-result FULL_RESULT Whether or not to show all results
One of true/false, yes/no, 1/0.
--interval INTERVAL Filter by interval
Possible value(s): 'hourly', 'daily', 'weekly', 'custom cron'
--name NAME Filter by name
--order ORDER Sort field and order, eg. 'id DESC'
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--sync-date SYNC_DATE Filter by sync date
-h, --help Print help
Predefined field sets:
-------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Start date | x | x |
Interval | x | x |
Enabled | x | x |
Cron expression | x | x |
Recurring logic id | x | x |
-------------------|-----|---------|-----
Search / Order fields:
enabled Values: true, false
interval string
name string
organization_id integer2.81.5. hammer sync-plan update
同期プランを更新します。
Usage:
hammer sync-plan update [OPTIONS]
Options:
--cron-expression CRON_EXPRESSION Add custom cron logic for sync plan
--description DESCRIPTION Sync plan description
--enabled ENABLED Enables or disables synchronization
One of true/false, yes/no, 1/0.
--id ID Sync plan numeric identifier
--interval INTERVAL How often synchronization should run
--name NAME Sync plan name to search by
--new-name NEW_NAME Sync plan name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID Organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--organization-title ORGANIZATION_TITLE Organization title
--sync-date SYNC_DATE Start date and time of the synchronization
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
-h, --help Print help