Skip to content

cub unit cancel

cub unit cancel

Cancel worker operations for units

Synopsis

Cancel the operations queued for, or in progress on, a worker for units, such as invoking an external function.

Examples: 

  # Cancel a single unit by slug
  cub unit cancel my-unit

  # Cancel operations for all units with specific label
  cub unit cancel --space my-space --where "Labels.Tier = 'backend'"

  # Cancel operations for one component's units in dev
  COMPONENT_ID=$(cub component get api -o jq=.Component.ComponentID)
  cub unit cancel --where "Space.ComponentID = '$COMPONENT_ID' AND Space.Labels.Environment = 'dev'"

  # Cancel operations for specific units by slug
  cub unit cancel --space my-space --unit my-unit,another-unit

  # Cancel operations across all spaces
  cub unit cancel --where "Slug = 'backend'"

cub unit cancel [<unit-slug>] [flags]

Options

      --filter string                 Filter entity to apply to the list. Specify as 'space/filter' for cross-space filters or just 'filter' for current space. Supports both slugs and UUIDs. The filter will be combined with any --where clause using AND logic. Examples: "production-filters/security-check", "my-filter-uuid", "validation-rules"
  -h, --help                          help for cancel
      --include-hidden string[="*"]   Also select hidden entities, to list or to act on: those hidden for the given HiddenReasons, comma-separated, as in --include-hidden=BackingUnit, or for any reason when given no value or "*". ConfigHub/YAML Units, which hold the configuration of other entities, are hidden with the reason BackingUnit. A --where naming entities by Slug or ID selects them whether hidden or not
      --unit strings                  target specific units by slug or UUID for bulk cancel (can be repeated or comma-separated)
      --where string                  Filter expression using SQL-inspired syntax. Supports conjunctions with AND. String operators: =, !=, <, >, <=, >=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*. Pattern matching with LIKE/ILIKE uses % and _ wildcards. Regex operators (~, ~*, !~, !~*) support POSIX regular expressions. A related entity is referenced by prefix, as in "UpstreamUnit.Slug = 'base'"; when the reference names a list, a * segment matches any element, as in "FromLink.*.Slug = 'upgrade-app'". Examples: "Slug LIKE 'app-%'", "DisplayName ILIKE '%backend%'", "Slug ~ '^[a-z]+-[0-9]+$'"

Options inherited from parent commands

      --component string   the Component of --variant, when that names the variant alone; --variant <component>/<variant> says the same in one flag
      --context string     The context to use for this command
      --debug              Debug output
      --space string       space to operate in, by slug or UUID. Omitted, a list or bulk operation spans the organization and a single entity is named as <space>/<slug>; "*" means the same as omitting it
      --variant string     variant to operate in, as <component>/<variant>, or as <variant> with --component: the space naming that Component whose Variant label is <variant>. The same scope as --space, named by what it is rather than by the space's slug; the two cannot be combined

SEE ALSO