Files
docker-docs/data/cli/dhi/docker_dhi_mirror_stop.yaml
Craig Osterhout 06c982499b dhi: cli update (#24539)
<!--Delete sections as needed -->

## Description

Updated DHI CLI reference and how-to topic.
- dhi cli plugin is now part of Desktop 4.65
- pulled the latest version of CLI docs from upstream and updated
`dhictl` examples to `docker dhi`
- updated how-to based on latest cli ref


## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-03-26 10:25:31 -07:00

73 lines
2.4 KiB
YAML
Generated

command: docker dhi mirror stop
short: Stop mirroring one or more Docker Hardened Images
long: |-
Stop mirroring one or more Docker Hardened Image repositories.
Multiple repositories can be specified as positional arguments.
Each repository can be specified as:
- namespace/name (e.g., myorg/dhi-python) - org must match --org flag or config
- name only (e.g., dhi-python) - the namespace can be omitted for simplicity
and the command will default to the current org automatically
Examples:
# Stop mirroring a single repository
docker dhi mirror stop myorg/dhi-python --org myorg
# Stop mirroring using just the name (defaults to current org)
docker dhi mirror stop dhi-python --org myorg
# Stop mirroring multiple repositories
docker dhi mirror stop dhi-python dhi-golang dhi-node --org myorg
# Stop mirroring and delete the repositories
docker dhi mirror stop dhi-python dhi-golang --org myorg --delete
# Stop mirroring, delete without confirmation prompt
docker dhi mirror stop dhi-python dhi-golang --org myorg --delete --force
# Stop mirroring all repositories matching a filter (using shell substitution)
docker dhi mirror stop $(docker dhi mirror list --org myorg --filter golang --json | jq -r '.[].repository') --org myorg
usage: docker dhi mirror stop <repository> [repository...]
pname: docker dhi mirror
plink: docker_dhi_mirror.yaml
options:
- option: delete
value_type: bool
default_value: "false"
description: Delete the repositories after stopping mirroring
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Skip confirmation prompt when deleting repositories
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false