pxctl service

pxctl service

pxctl service

Description

Service mode utilities

pxctl service exit

pxctl service exit

Description

Stop the PX daemon

pxctl service call-home

pxctl service call-home <required-argument>

Description

Enable or disable the call home feature

Example

pxctl service call-home <enable|disable>    * Required argument is "enable" or "disable"

pxctl service call-home status

pxctl service call-home status

Description

Check call-home status

pxctl service node-wipe

pxctl service node-wipe

Description

Wipes PX configuration data on this node

pxctl service diags

pxctl service diags

Description

creates a new tgz package with essential diagnostic information.

Flags

Flag	Description
--output, -o (str)	output file name
--dockerhost (str)	docker host daemon Default value: unix:///var/run/docker.sock
--container (str)	PX container ID
--upload, -u (bool)	upload diags to cloud
--profile, -p (bool)	only dump profile
--all, -a (bool)	creates a new tgz package with all the available diagnostic information.
--cluster, -c (bool)	generate diags for all the nodes in the cluster.
--node, -n (str)	generate diags for a specific remote node with the provided NodeIp or NodeID.
--force, -f (bool)	force overwrite existing diags.

pxctl service maintenance

pxctl service maintenance

Description

Maintenance mode operations

Flags

Flag	Description
--exit, -x (bool)	exit maintenance mode
--enter, -e (bool)	enter maintenance mode
--cycle, -c (bool)	cycle maintenance mode

pxctl service email

pxctl service email

Description

Email setting commands

pxctl service email set

pxctl service email set

Description

Configure email settings for alerts.

Flags

Flag	Description
--server, -s (str)	IP or DNS name for smtp server
--smtp-port, -p (str)	IP or DNS name for smtp server
--username, -u (str)	Username to authenticate with smtp-server (if required)
--password (str)	Password to authenticate with smtp-server (if required)
--sender (str)	Sender of alert emails (defaults to noreply@portworx.com) Default value: noreply@portworx.com
--recipient, -r (str)	Recipient of alert emails.
--severity (str)	Minimum severity for email trigger, (warning|critical) Default value: critical

pxctl service email get

pxctl service email get

Description

Get email settings for alerts.

pxctl service email clear

pxctl service email clear

Description

Clear email settings for alerts.

pxctl service slack

pxctl service slack

Description

Slack setting commands

pxctl service slack set

pxctl service slack set

Description

Configure slack settings for alerts.

Flags

Flag	Description
--webhookurl, -w (str)	url of the slack webhook This flag is required.
--severity, -s (str)	Minimum severity for slack trigger, (warning|critical) Default value: critical

pxctl service slack get

pxctl service slack get

Description

Get slack settings for alerts.

pxctl service slack delete

pxctl service slack delete

Description

Delete slack settings for alerts.

pxctl service node

pxctl service node

Description

Node maintenance operations

pxctl service node drain-attachments

pxctl service node drain-attachments

Description

Drain/Remove volume attachments from a node

pxctl service node cordon-attachments

pxctl service node cordon-attachments

Description

Cordons/Disables any new volume attachments from a node. Existing volumes will stay attached

Flags

Flag	Description
--node (str)	ID of the node for which any new volume attachments will be disabled This flag is required.

pxctl service node uncordon-attachments

pxctl service node uncordon-attachments

Description

Re-enables volume attachments for a node.

Flags

Flag	Description
--node (str)	ID of the node for which volume attachments will be re-enabled This flag is required.

pxctl service kvdb

pxctl service kvdb

Description

PX Kvdb operations

pxctl service kvdb restore

pxctl service kvdb restore

Description

Restore keys and values into kvdb from a kvdb.dump file

Example

/opt/pwx/bin/pxctl service kvdb restore --kvdb_dump_file <file_path>

Flags

Flag	Description
--kvdb_dump_file, -k (str)	Kvdb dump file location This flag is required.
--force, -f (bool)	Force will delete any existing keys from kvdb and perform the restore

pxctl service kvdb endpoints

pxctl service kvdb endpoints

Description

List the kvdb client endpoints

pxctl service kvdb members

pxctl service kvdb members

Description

List the kvdb cluster members

pxctl service usage-report

pxctl service usage-report

Description

creates & download tgz package for px consumption reports

Flags

Flag	Description
--download (bool)	generate reports for px consumption