Supercluster Command-line Reference

The Illumio PCE control interface for Supercluster commands often have restrictions on the type of node they can be run on. For example, setting a cluster's runlevel can be run from any core or data node. Other database specific commands must only be run on specific data nodes. The following tables list the different command line operations you can perform and the specific node (or nodes) the commands must be run on.

Supercluster Commands to Node Reference

This section lists commands you can use to control behavior of PCEs and PCE databases in a Supercluster.

Supercluster PCE Control Commands

The commands have the following general syntax. The --retry-count is optional and defaults to 5.

sudo -u ilo-pce illumio-pce-ctl sub-command--option [--retry-count]

The following table shows commands you can use to control PCE behavior:

Command	Description	Run on Node
`reset`	Revert a PCE to standalone state.	The affected node being repaired to join the Supercluster
`supercluster-assign-leader`	Designate an existing member PCE cluster to be a Supercluster leader.	Any node
`supercluster-drop [failed_pce_fqdn]`	Temporarily drops the failed PCE from the Supercluster, so it is no longer replicated.	Any node
`supercluster-init-leader`	Assign a PCE cluster as the leader of your Supercluster.	Any node
`supercluster-join`	Joins a PCE cluster to a Supercluster. Running this command can take up to 30 minutes depending on the number of PCEs in your Supercluster and size of the PCE database.	On any core node
`supercluster-members`	Displays all current active Supercluster PCEs, members and leader.	On any core node or the data0 node
`supercluster-restore`	Restores a formerly failed leader or member to be restored to the Supercluster. This command can be run for a leader or a member. Executing this command can take up to 1 hour depending on the number of PCEs in the Supercluster and size of the PCE database.	On any core node

Supercluster PCE Database Commands

The commands have the following general syntax. The --retry-count is optional and defaults to 5.

sudo -u ilo-pce illumio-pce-db-management sub-command --option [--retry-count]

The following table shows commands you can use to control PCE database behavior:

Command	Description	Run on Node
`supercluster-data-restore`	Restores a failed PCE's data, using a backup taken from that PCE before the failure.	On one of the data nodes only
`supercluster-quiesce`	Pauses all the pending database replication; for example, during a software upgrade.	Any node

Re-runnable illumio-pce-ctl Arguments

All arguments to illumio-pce-ctl are re-runnable in case of a command failure.

Argument on illumio-pce-ctl	Description
`supercluster-init-leader`	Configures this PCE as the Supercluster leader.
`supercluster-join [supercluster_leader_fqdn]`	Joins this PCE into the Supercluster specified by the FQDN of the Supercluster leader. While this command is running, it temporarily sets the runlevel to 1. When the command is interrupted, you might see runlevel 1 unexpectedly.
`supercluster-assign-leader`	Assigns a new Supercluster leader.
`supercluster-restore failed_pce_fqdn [supercluster_leader_fqdn] [--restore-type single_pce\|entire_supercluster]`	Restores a failed PCE and rejoins it to the Supercluster. Replace `failed_pce_fqdn` with the FQDN of the PCE you are restoring. The `supercluster_leader_fqdn` is required when you are restoring a member PCE, not the leader PCE. While this command is running, it temporarily sets the runlevel to 1. When the command is interrupted, you might see runlevel 1 unexpectedly.
`supercluster-drop [failed_pce_fqdn]`	Temporarily drops the failed PCE from the Supercluster, so it is no longer replicated.
`supercluster-members`	Shows the members in the Supercluster.
`supercluster-config`	Shows the Supercluster configuration.
`supercluster-replication-check [--detailed] [--show-data-detail]`	Displays the state of replication. The `--detailed` option displays more verbose output. The `--show-data-detail` option displays primary keys for the replication data check.

Re-runnable illumio-pce-db-management Arguments

All arguments to illumio-pce-db-management are re-runnable in case of a command failure.

Argument on illumio-pce-db-managment	Description
`supercluster-data-dump --file desired_location_of_backup_file`	Writes the database persistent state in Supercluster to a file.
`supercluster-data-restore --restore-type single_pce\|entire_supercluster [skip-db-restore]`	Restores data and persistent state of a Supercluster database.
`show-supercluster-replication-info`	Display Supercluster node replication information.
`supercluster-quiesce [wait_timeout]`	Quiesces all pending replication.
`supercluster-replication-debug [--detailed]`	Show replication-related information for debugging.

Illumio Core 22.2 Install, Configure, Upgrade