Files
docker-docs/data/sbx_cli/sbx_policy_inspect.yaml
David Karlsson 1773367159 Sync sbx CLI reference from release/v0.51 (#26514)
Vendor the checked-in CLI YAML from Docker Sandboxes release/v0.51 at
7d55286de0c7. This updates command help, adds `sbx policy check http`,
and replaces seven agent-specific create pages with redirects to `sbx
create`.

Validation: full site build with Hugo 0.169.0; upstream byte-for-byte
comparison; all 115 command pages, reference links, and seven redirects
checked; template formatting and whitespace checks passed.
2026-11-04 10:10:52 +01:00

49 lines
1.8 KiB
YAML

name: sbx policy inspect
synopsis: Show policy or rule details
description: |-
Inspect full detail for a selected policy or rule.
The selector may be a policy ID, policy name, rule ID, or rule name.
Selecting a policy lists every resource with its decision, rule, and status,
plus a rule table showing each rule's RULE_ID, whether it is editable, and
either the exact removal command or the reason it is read-only. Selecting a
rule shows only that rule with the same editability detail. RULE_ID is the
identifier accepted by "sbx policy rm network --id" (local rules only). Use
"sbx policy ls" to find policy names and "sbx policy ls --wide" to find rule
IDs and resource values.
usage: sbx policy inspect POLICY|RULE [flags]
options:
- name: format
usage: 'Output format: table, json or yaml'
- name: help
shorthand: h
default_value: "false"
usage: help for inspect
- name: json
default_value: "false"
usage: Output in JSON format
inherited_options:
- name: cloud
default_value: "false"
usage: |
Dispatch to Docker Cloud Sandboxes API instead of local sandboxd (supported by a growing set of verbs — run 'sbx --cloud --help' for the current list)
- name: debug
shorthand: D
default_value: "false"
usage: Enable debug logging
- name: no-input
default_value: "false"
usage: |
Never prompt; commands that need an answer fail with the command to run instead
example: |4-
# Inspect a policy by name
sbx policy inspect "Developer access"
# Inspect a rule by ID
sbx policy inspect 2d3c1f0e-4a73-4e05-bc9d-f2f9a4b50d67
# Machine-readable output for scripting
sbx policy inspect "Developer access" --json
see_also:
- sbx policy - Manage sandbox policies