px pxb Command Reference

📄️ Cluster Configuration

The px pxb config commands manage the PX-Backup CLI configuration stored in ~/.pxb/config. Use these commands to initialize the config file, set or update configuration values, view the active configuration, and check status including authentication information.

📄️ Authentication Token

This guide explains how px pxb handles authentication tokens with Keycloak and how to configure Keycloak to issue longer‑lived tokens for PX‑Backup. Token lifetimes are determined server-side by Keycloak's configuration. It follows the same structure and conventions as backup.md.

📄️ TLS Certificate

TLS setup for px-backup on OpenShift with pxb. This guide explains how to enable TLS for the px-backup gRPC server, generate a certificate that works for both internal and external traffic, configure the OpenShift Route, verify readiness/connectivity, and use px pxb with TLS. It follows the same structure and conventions as backup.md and is copy/paste‑friendly.

📄️ login/logout

Authenticate to PX-Backup and manage session tokens stored in ~/.pxb/config. Use login to obtain and persist an authentication token (via browser or username/password). Use logout to clear tokens from the config (and optionally from environment variables and the legacy token file).

📄️ Cloud Credential

The px pxb cloudcredential commands manage credentials for cloud and platform providers used by backup.

📄️ Backup Location

The px pxb backuplocation commands manage backup locations used to store backups. A backup location.

📄️ Cluster

The px pxb cluster commands manage clusters registered with PX-Backup. You can update cluster connectivity and credentials, inspect/list clusters, delete clusters with safety options, share/unshare access to a cluster with users and groups, and manage granular backup sharing permissions for all backups on a cluster.

📄️ Schedule Policy

The px pxb schedulepolicy commands manage reusable backup schedule policies that define when and how often backups run. Policies can include any combination of interval, daily, weekly, and monthly schedules; each with retention and optional incremental-count settings. Policies also support object-lock and auto-delete options and can be labeled for organization and filtering.

📄️ Rule

The px pxb rule commands manage pre/post execution rules used by backups. A rule defines one or more actions to run in targeted pods before or after backup operations. You can create, update, list/inspect, delete rules, and update rule ownership/access.

📄️ Role

Manage access control roles for PX-Backup. A role defines which PX-Backup services and APIs a user can access. Use these commands to create, get (inspect/list), update, and delete roles.

📄️ License

The px pxb license commands manage PX-Backup licensing - activate a license using multiple methods, retrieve license status and airgapped usage reports, and update the usage-based activation ID. Commands support JSON/YAML file input and global output formats.

📄️ Backup

The px pxb backup command provides comprehensive backup management capabilities for Kubernetes.

📄️ Volume Resource Only Policy

Manage Volume Resource Only Policies that define which volume types should have their data skipped during backups. These policies let you back up only the volume metadata/resources (not data) for selected volume types (pxd/Portworx, csi, nfs), CSI drivers, or NFS servers—useful for performance and cost optimization when data is replicated elsewhere.

📄️ Backup Schedule

The px pxb backupschedule commands manage recurring backup schedules. A backup schedule ties a.

📄️ Restore

The px pxb restore commands create and manage restores from backups. You can restore applications.

📄️ receiver and recipient

Manage alert notification plumbing -.

📄️ Version

Print the px pxb client and server version information. By default, the command prints -.

📄️ organization

The px pxb organization commands let you create and view organizations in PX-Backup. Organizations are.

📄️ dry-run

Use the global --dry-run flag to validate inputs and view the request payload without making any server changes. px pxb performs schema and business-logic checks, validates any --file YAML/JSON, prints a human-readable summary (Checks Passed / Warnings / Errors), and shows the effective request body that would be sent. No network calls are made in dry-run mode.

📄️ get resourcetypes

The px pxb get resourcetypes command retrieves the list of Kubernetes resource types that are supported by PX-Backup for a specific cluster. This command helps you discover which resource types can be included in backup operations for a given cluster, enabling you to understand the backup capabilities and plan your backup strategies accordingly.