Este conteúdo não está disponível no idioma selecionado.

Chapter 87. sync-plan


Manipulate sync plans

Usage

# hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...
Copy to Clipboard Toggle word wrap

Options

  • -h, --help – Print help

87.1. sync-plan create

Create a sync plan

Usage

# hammer sync-plan create [OPTIONS]
Copy to Clipboard Toggle word wrap

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]
Copy to Clipboard Toggle word wrap

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]
Copy to Clipboard Toggle word wrap

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

Expand
FIELDSALLDEFAULTTHIN

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]
Copy to Clipboard Toggle word wrap

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

Expand
FIELDSALLDEFAULTTHIN

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]
Copy to Clipboard Toggle word wrap

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
Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat