Volume Resource Only Policy

Description

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.

Usage

Create Volume Resource Only Policy

px pxb create volumeresourceonlypolicy --name <name> [flags]

Get Volume Resource Only Policy (Inspect)

px pxb get volumeresourceonlypolicy --name <name> [--uid <uid>] [flags]

Get Volume Resource Only Policy (List All)

px pxb get volumeresourceonlypolicy [flags]

Update Volume Resource Only Policy

px pxb update volumeresourceonlypolicy --name <name> --uid <uid> [flags]

Delete Volume Resource Only Policy

px pxb delete volumeresourceonlypolicy --name <name> [--uid <uid>] [flags]

Update Ownership (Volume Resource Only Policy)

px pxb update ownership volumeresourceonlypolicy --name <name> [--uid <uid>] [flags]

Examples

Create policies

# Skip Portworx volume data
px pxb create volumeresourceonlypolicy \
  --name skip-pxd \
  --volume-types pxd

# Skip specific CSI drivers
px pxb create volumeresourceonlypolicy \
  --name skip-csi \
  --volume-types csi \
  --csi-drivers ebs.csi.aws.com,disk.csi.azure.com

# Skip specific NFS servers
px pxb create volumeresourceonlypolicy \
  --name skip-nfs \
  --volume-types nfs \
  --nfs-servers 192.168.1.100,nfs.example.com

# Create from file
px pxb create volumeresourceonlypolicy --file /path/to/vro-policy-create.json

Get policies

# Inspect by name
px pxb get volumeresourceonlypolicy --name skip-pxd

# Inspect by name and UID (disambiguate)
px pxb get volumeresourceonlypolicy --name skip-csi --uid policy-12345

# List all
px pxb get volumeresourceonlypolicy

# List with JSON output
px pxb get volumeresourceonlypolicy --output json

# Load get config from file (API-shaped request)
px pxb get volumeresourceonlypolicy --file /path/to/vro-policy-get.json

Update policies

# Update volume types
px pxb update volumeresourceonlypolicy \
  --name my-policy --uid policy-12345 \
  --volume-types pxd,csi,nfs

# Update CSI drivers for CSI type
px pxb update volumeresourceonlypolicy \
  --name my-policy --uid policy-12345 \
  --volume-types csi \
  --csi-drivers ebs.csi.aws.com,gp2.csi.aws.com

# Update NFS servers for NFS type
px pxb update volumeresourceonlypolicy \
  --name my-policy --uid policy-12345 \
  --volume-types nfs \
  --nfs-servers 192.168.1.100,192.168.1.101

# Update from file
px pxb update volumeresourceonlypolicy --name my-policy --uid policy-12345 --file /path/to/vro-policy-update.json

Delete policies

# Delete by name
px pxb delete volumeresourceonlypolicy --name deprecated-policy

# Delete by name with UID
px pxb delete volumeresourceonlypolicy --name my-policy --uid policy-12345

# Delete from file
px pxb delete volumeresourceonlypolicy --file /path/to/vro-policy-delete.json

Update ownership

# Add groups and collaborators
px pxb update ownership volumeresourceonlypolicy \
  --name my-policy --uid policy-12345 \
  --add-groups "team1=Read,team2=Write" \
  --add-collaborators "user-123=Read,user-456=Admin"

# Set public access control
px pxb update ownership volumeresourceonlypolicy \
  --name my-policy --uid policy-12345 \
  --public-access-control Read

# Remove groups/collaborators
px pxb update ownership volumeresourceonlypolicy \
  --name my-policy --uid policy-12345 \
  --remove-groups team1,team2 \
  --remove-collaborators user-123

# From file
px pxb update ownership volumeresourceonlypolicy --file /path/to/vro-policy-ownership.json

Flags for commands and sub-commands

Create Volume Resource Only Policy Flags

Flag	Short	Type	Description
--name	-n	string	Name of the policy (required, optional with --file)
--uid		string	UID for the policy (optional)
--volume-types		list	Volume types to skip data for: pxd, csi, nfs (optional with --file, required otherwise)
--csi-drivers		list	CSI drivers to skip data for (requires csi in --volume-types)
--nfs-servers		list	NFS servers to skip data for (requires nfs in --volume-types)
--labels		map	Labels for the policy (key=value)
--file	-f	string	YAML/JSON file with full policy configuration
--volume-types-file		string	YAML/JSON file for volume types
--csi-drivers-file		string	YAML/JSON file for CSI drivers
--nfs-servers-file		string	YAML/JSON file for NFS servers
--labels-file		string	YAML/JSON file for labels

Get Volume Resource Only Policy Flags

Flag	Short	Type	Description
--name	-n	string	Name of the policy to inspect (required for inspect; omit to list all)
--uid		string	UID of the policy (optional; use with --name)
--max-objects		uint	Maximum number of policies to return (client-side limit)
--sort-by		string	Sort field (client-side): name, create_time, update_time
--sort-order		string	Sort order: asc or desc
--file	-f	string	YAML/JSON file with inspect/enumerate configuration

Update Volume Resource Only Policy Flags

Flag	Short	Type	Description
--name	-n	string	Name of the policy to update (optional with --file, required otherwise)
--uid		string	UID of the policy to update (optional)
--volume-types		list	Updated volume types: pxd, csi, nfs
--csi-drivers		list	Updated CSI drivers (requires csi)
--nfs-servers		list	Updated NFS servers (requires nfs)
--labels		map	Updated labels (key=value)
--file	-f	string	YAML/JSON file with full update configuration
--volume-types-file		string	YAML/JSON file for volume types
--csi-drivers-file		string	YAML/JSON file for CSI drivers
--nfs-servers-file		string	YAML/JSON file for NFS servers
--labels-file		string	YAML/JSON file for labels

Delete Volume Resource Only Policy Flags

Flag	Short	Type	Description
--name	-n	string	Name of the policy to delete (optional with --file, required otherwise)
--uid		string	UID of the policy to delete (optional)
--file	-f	string	YAML/JSON file with delete configuration

Update Ownership (Volume Resource Only Policy) Flags

Flag	Short	Type	Description
--name	-n	string	Name of the policy to update ownership for (optional with --file, required otherwise)
--uid		string	UID of the policy (optional)
--add-groups		map	Add groups with access levels (group=Read|Write|Admin)
--add-collaborators		map	Add collaborators with access levels (user=Read|Write|Admin)
--public-access-control		string	Set public access (Read, Write, Admin)
--remove-groups		list	Remove groups
--remove-collaborators		list	Remove collaborators
--file	-f	string	YAML/JSON file with full ownership configuration
--add-groups-file		string	YAML/JSON file with groups to add
--add-collaborators-file		string	YAML/JSON file with collaborators to add

Notes

• Create and Update require valid volume types; allowed: pxd (Portworx), csi, nfs.
• If --csi-drivers is set, --volume-types must include csi.
• If --nfs-servers is set, --volume-types must include nfs.
• Inspect vs List selection for get is based on presence of --name; --uid is optional for disambiguation.
• File vs CLI precedence: when --file is provided, it supplies the full request; avoid combining with other content flags.
• Sorting and limiting are client-side.
• Uses global labels filter for list mode via --labels (global flag).
• Commands honor global options (e.g., --dry-run).

Output Format Support

• --output table (default)
• --output json
• --output yaml
• --output name (for get)

Authentication and Context

• Uses the current organization and auth context from your configuration.
• Ensure you are logged in and have permission to manage policies. See login-logout.md for authentication steps.