PCE Control Interface and Commands
The Illumio PCE control interface illumio-pce-ctl
is a command-line tool for performing key tasks for operating your PCE cluster, such as starting and stopping nodes, setting cluster runlevels, and checking the cluster status.
Important
In this guide, all command-line examples based on an RPM installation. When you install the PCE using the tarball, you must modify the commands based on your PCE user account and the directory where you installed the software.
The PCE includes other command-line utilities used to set up and operate your PCE:
illumio-pce-env
: Verify and collect information about the PCE runtime environment.illumio-pce-db-management
: Manage the PCE database.supercluster-sub-command
: Manage specific Supercluster operations.
The PCE control interface can only be executed by the PCE runtime user (ilo-pce
), which is created during the PCE RPM installation.
Control Command Access with /usr/bin
For easier command execution, PCE installation creates softlinks in /usr/bin
by default for the Illumio PCE control commands. The /usr/bin
directory is usually included by default in the PATH
environment variable in most Linux systems. When your PATH
does not include /usr/bin
, add it to your PATH
with the following command. You might want to add this command to your login files ($HOME/.bashrc
or $HOME/.cshrc
).
export PATH=$PATH:/usr/bin
Syntax of illumio-pce-ctl
To make it simpler to run the PCE command-line tools, you can run the following Linux softlink commands or add them to your PATH
environment variable.
$ cd /usr/bin sudo ln -s /opt/illumio-pce/illumio-pce-ctl ./illumio-pce-ctl sudo ln -s /opt/illumio-pce/illumio-pce-db-management ./illumio-pce-db-management sudo ln -s /opt/illumio-pce/illumio-pce-env ./illumio-pce-env
After these commands are executed, you can run the PCE command-line tools using the following syntax:
sudo -u ilo-pce illumio-pce-ctl sub-command --option
Where:
sub-command
is an argument displayed by illumio-pce-ctl --help
.