grafana-util docs

grafana-util-access-org.1

Browser-readable rendering of a generated roff manpage.

This page renders the generated roff manpage into readable HTML for browser use. For richer per-subcommand detail, prefer the command-reference pages.

NAME

grafana-util-access-org - List live or local Grafana organizations, create, modify, export, import, diff, or delete Grafana organizations.

SYNOPSIS

grafana-util access org [OPTIONS]

DESCRIPTION

List live or local Grafana organizations, create, modify, export, import, diff, or delete Grafana organizations.

  • Inspect organization inventory and org users.
  • Inspect organizations from a live Grafana server or from a local export bundle.
  • Create a new organization or rename an existing one.
  • Export or import org bundles between environments.
  • Remove an organization by id or exact name.

BEFORE / AFTER

  • Before: org administration often starts as a one-off admin click path or a script that only works in one environment.
  • After: one namespace covers inventory, rename, export/import, and deletion with repeatable admin-backed access.

COMMON OPTIONS

list
--input-dir, --org-id, --name, --query, --with-users, --table, --csv, --json, --yaml, --output-format
add
--name, --json
modify
--org-id, --name, --set-name, --json
export and diff
--org-id, --name, --output-dir or --diff-dir, --overwrite, --dry-run, --with-users
import
--input-dir, --replace-existing, --dry-run, --yes
delete
--org-id, --name, --yes, --json

SUCCESS CRITERIA

  • org names and ids stay exact across inventory and change flows
  • export and import bundles can be reused when moving between environments
  • privileged actions stay tied to an explicit admin-backed profile instead of an ad hoc token

FAILURE CHECKS

  • if a create, rename, export, import, or delete step fails, confirm the selected profile has the required admin privileges
  • if a name-based lookup returns the wrong org, recheck the exact org id or exact name before retrying
  • if bundle import or export looks incomplete, confirm you are targeting the expected environment

EXAMPLES

List live or local Grafana organizations, create, modify, export, import, diff, or delete Grafana organizations.

grafana-util access org list --profile prod --output-format text

SEE ALSO

grafana-util(1), grafana-util-access(1)