About This Guide

The following sections provide useful information to help you get the most out of this guide.

CLI Tool Versioning

Illumio Core CLI Tool version 1.4.0 and 1.4.1 are compatible with Illumio Core PCE versions 19.3.6-H2, 21.2.4, 21.4.1, and 21.5.1.

The CLI Tool version numbering is independent from the release and version numbering of Illumio Core PCE and VEN. The CLI Tool works with multiple versions of the PCE and the VEN and does not necessarily need software changes in parallel with releases of the PCE or the VEN.

IMPORTANT:

See the Illumio Core CLI Tool 1.4.0 Release Notes and Illumio Core CLI Tool 1.4.1 Release Notesin your respective Illumio Core Technical Documentation portal for the updates to the CLI Tool for these releases.

How to Use This Guide

This guide includes several major sections:

  • Overview to the CLI Tool
  • Installation
  • Formal syntax of the ilo command
  • Tutorials for various operations
  • Uploading vulnerability data
  • Security policy import and export

Before Reading This Guide

Before performing the procedures in this guide, be familiar with the following information:

  • The CLI Tool interacts with the PCE; therefore, be familiar with PCE concepts such as core and data nodes, workloads, and traffic. See the Introduction to the Platform guide.
  • The CLI Tool is often used to upload vulnerability data; therefore, understand how vulnerability data is used in the PCE web console. See Vulnerability Maps in the Visualization Guide.
  • The CLI Tool can be used with workload data; therefore, you must understand what workloads are. See VEN Architecture and Components in the VEN Administration Guide.
  • The CLI Tool can be used with security policy rules, rulesets, labels, and similar resources; therefore, be familiar with these concepts. See The Illumio Policy Model in the Security Policy Guide.

Notational Conventions in This Guide

  • Newly introduced terminology is italicized. Example: activation code (also known as pairing key)
  • Command-line examples are monospace. Example: illumio-ven-ctl --activate
  • Arguments on command lines are monospace italics. Example: illumio-ven-ctl --activate activation_code
  • In some examples, the output might be shown across several lines but is actually on one single line.

  • Command input or output lines not essential to an example are sometimes omitted, as indicated by three periods in a row. Example:

    ...
some command or command output
...