px pxe describe

Get information about Portworx resources

Aliases: inspect

note

The following commands support a set of global flags that apply to all px pxe commands.
For details, see the Global Flags section.

px pxe describe clouddrive

Show detailed information about cloud drives for a specific node

Aliases: cd, cloud-drive, cloud-drives, clouddrives

Examples:

  # Inspect cloud drives for a specific node:
  kubectl px pxe describe clouddrive node-123
  
  # Inspect cloud drives for a node in JSON format:
  kubectl px pxe describe clouddrive node-123 -o json
  
  # Inspect cloud drives for a node in YAML format:
  kubectl px pxe describe clouddrive node-123 -o yaml

Flags

Flag	Input type	Description	Default	Required
--output, -o	string	Output in yaml|json	-	Optional

px pxe describe cluster

Show detailed information of a Portworx cluster

Aliases: clusters

Flags

Flag	Input type	Description	Default	Required
--health	bool	Show health information	false	Optional
--output, -o	string	Output in yaml|json|wide	-	Optional

px pxe describe diags

Describe a Portworx diagnostics CR

Aliases: diag, diagnostics

Examples:

  # Describe a diagnostic CR
  kubectl px pxe describe diags my-diag
  
  # Describe a diagnostic CR in JSON format
  kubectl px pxe describe diags my-diag -o json
  
  # Describe a diagnostic CR in YAML format
  kubectl px pxe describe diags my-diag -o yaml

Flags

Flag	Input type	Description	Default	Required
--output, -o	string	Output format (json, yaml)	-	Optional

px pxe describe guest-access

show guest access role

Aliases: ga, guestaccess

Flags

Flag	Input type	Description	Default	Required
--output, -o	string	Output in yaml|json|wide	-	Optional

px pxe describe node

Show detailed information about a Portworx node. You can use the host name, or the node id to specify the node.

Aliases: nodes

Examples:

  # Display detailed information about a node using the host name
  kubectl px pxe describe node node-34-2
  
  # Display detailed information about a node using the node id
  kubectl px pxe describe node 4faf4c...67c2

Flags

Flag	Input type	Description	Default	Required
--output, -o	string	Output in yaml|json|wide	-	Optional

px pxe describe pvc

Show detailed information of Portworx volume for Kubernetes PVCs

Aliases: pvcs

Examples:

  # Describe all pvcs that are Portworx volumes:
  kubectl px pxe describe pvc
  
  # Describe specific pvc called pvc:
  kubectl px pxe describe pvc abc
  
  # Describe list of pvcs (abc, xyz):
  kubectl px pxe describe pvc abc xyz

Flags

Flag	Input type	Description	Default	Required
--all-namespaces	bool	Kubernetes namespace	false	Optional

px pxe describe volume

Show detailed information of Portworx volumes

Aliases: volumes, vol

Examples:

  # Describe all the volumes:
  kubectl px pxe describe volume
  
  # Describe specific volume called "abc":
  kubectl px pxe describe volume abc
  
  # Describe list of volumes (abc, xyz)
  kubectl px pxe describe volume abc xyz

Flags

Flag	Input type	Description	Default	Required
--owner	string	Owner of volume	-	Optional
--show-k8s-info	bool	Show kubernetes information	false	Optional
--volumegroup	string	Volume group id	-	Optional