Before you run eiq-platform

The eiq-platform command line utility requires root-level, admin-level access.

To access the eiq-platform command line utility:

1. Log in to a Intelligence Center instance through SSH.

2. Obtain root-level access.

3. Launch the Intelligence Center Python virtual environment.

4. Export the Intelligence Center environment variables.

To do that, carry out the following steps:

• Open a terminal session.

• In the terminal, log in to the Intelligence Center through SSH:

  # the Intelligence Center user name must have admin access rights

  ssh ${platform_user_name}@${platform_host_name}

   

  # Or:

  ssh ${platform_user_name}@${platform_ip_address}

   

  # Example:

  ssh eldon-[email protected]

   

  # Or:

  ssh eldon-tyrell@173.237.136.98

• Obtain root-level access by running sudo -i:

  # Root-access login shell

  sudo -i

  To access resources as a different user than the currently active one, append -u:

  # Grant the currently logged in user root-level access

  sudo -i

   

  # Grant root-level access to a different user

  sudo -i -u ${user_name}

   

  # Run a command as a different user, with root-level access

  sudo -i -u ${user_name} ${command} ${options}

• Activate a Python virtual environment for the Intelligence Center:

  source /opt/eclecticiq-platform-backend/bin/activate

For further details about each command, append --help to it to view the available switches for the specific command.

View the eiq-platform help

The eiq-platform command line utility includes a built-in help feature with details about the commands you can execute, and the arguments each command accepts.

• Append -help to the eiq-platform to view the general help section covering the command areas.

• Append -help to any eiq-platform ${command} to view contextual help about the specified command.

• Append -help to any eiq-platform ${command} ${subcommand} to view contextual help about the options and arguments the specified command accepts.