Organization

Description

The px pxb organization commands let you create and view organizations in Portworx Backup. Organizations are administrative containers that scope users, resources, roles, and licenses. Typical operations are creating new orgs and listing/inspecting existing orgs to discover their UIDs and metadata. Names must be unique within the system and are required for all operations.

Usage

Create Organization

px pxb create organization --name <org-name> [--uid <uid>] [flags]

Get Organization (Inspect)

px pxb get organization --name <org-name> [flags]

Get Organization (List All)

px pxb get organization [flags]

Examples

Basic Organization Operations

Create Organization

# Create an organization with a generated UID
px pxb create organization --name demo-org

# Create with a specific UID (must be globally unique)
px pxb create organization --name prod-org --uid org-prod-001

List and Inspect Organizations

# List all accessible organizations (table output)
px pxb get organization

# JSON output
px pxb get organization --output json

# Inspect a specific organization by name
px pxb get organization --name prod-org

# Names only (useful for scripting)
px pxb get organization --output name

Flags for commands and sub-commands

Create Organization Flags

Required Flags

Flag	Short	Type	Description
--name	-n	string	Name of the organization (required)

Optional Flags

Flag	Short	Type	Description
--uid		string	UID of the organization (optional)

Get Organization Flags

Identification

Flag	Short	Type	Description
--name	-n	string	Name of the organization to inspect

Notes

File vs CLI Flag Precedence

• These commands are simple: configuration files are not required. CLI flags are sufficient.

Dual Mode Operations

• px pxb get organization lists all organizations available to the current user.
• px pxb get organization --name <name> inspects that specific organization.

Constraints and Permissions

• Organization names must be DNS-1123 compliant and unique. Attempts to reuse an existing name will fail.
• Only users with appropriate administrative permissions can create organizations.

Output Format Support

All organization commands support standard output formats:

• --output table (default): human-readable table
• --output json: JSON format
• --output yaml: YAML format
• --output name (for get)

Authentication and Context

All commands automatically include:

• Organization context as provided by the environment (for listing access)
• Authentication token from the command factory