This documentation is for an older version of the software. If you are using the current version of Cumulus Linux, this content may not be up to date. The current version of the documentation is available here. If you are redirected to the main page of the user guide, then this page may have been renamed; please search for it there.

IPM Command Line Overview

The IPM CLI (TIPCTL) behaves in a similar manner to the other Cumulus CLIs. It provides help for commands and options, but it does not support TAB completion of commands. The commands support four functional categories-configuration, DHCP (dynamic host control protocol), network OS (operating system), and ZTP (zero-touch provisioning):

  • config: sets the network interface the service is bound to (either eth0 or eth1) and the IP address where it publishes.
  • dhcp: adds and deletes DHCP reservations of IP and hostname options, and shows reservations and leases.
  • nos: manages the mappings between meta-information sent by the ONIE tool and NOS (network operating system) images**.**
  • ztp: manages mappings between ZTP scripts and the meta-information the ZTP tool sends.

The TIPCTL syntax is organized around the command actions-add, delete, show, configure, import, sync, and reset-for each of the functions, as appropriate.

The NetQ IPM command line interface only runs on switches and server hosts implemented with Intel x86 or ARM-based architectures. If you are unsure what architecture your switch or server employs, check the Cumulus Hardware Compatibility List and verify the value in the Platforms tab > CPU column.

CLI Access

Once you have enabled the IPM service (refer to the Activate and Initialize IPM topic) and logged into the NetQ Telemetry Server (TS), simply enter commands at the prompt.

To access the CLI from TS:

  1. Log in to TS. This example uses a username of Cumulus and a Telemetry Server with a name of ts.

    <computer>:~Cumulus$ ssh ts
    
  2. Enter your password, if required, to reach the command prompt. For example:

    Enter passphrase for key '/Users/<username>/.ssh/id_rsa': 
    Welcome to Ubuntu 16.04.3 LTS (GNU/Linux 4.4.0-112-generic x86_64)
     * Documentation:  https://help.ubuntu.com
     * Management:     https://landscape.canonical.com
     * Support:        https://ubuntu.com/advantage
    Last login: Thu Aug 16 06:28:12 2018 from 10.50.11.103
    Cumulus@ts:~$ 
    
  3. Run commands. For example:

    Cumulus@ts:~$ tipctl config setup
    Cumulus@ts:~$ tipctl add ztp 
    

Command Line Structure

The Cumulus NetQ IPM command line has a flat structure as opposed to a modal structure. This means that all commands can be run from the primary prompt instead of only in a specific mode. For example, some command lines require the administrator to switch between a configuration mode and an operation mode. Configuration commands can only be run in the configuration mode and operational commands can only be run in operation mode. This structure requires the administrator to switch between modes to run commands which can be tedious and time consuming. Cumulus NetQ IPM command line enables the administrator to run all of its commands at the same level.

Command Syntax

IPM CLI commands all begin with tipctl. The TIPCTL syntax is organized around the command actions-add, delete, show, configure, import, sync, and reset. The syntax is as follows:

tipctl [--version|--help|-h] add [dhcp <options>|nos <options>|ztp <options>]
tipctl [--version|--help|-h] config [setup <options>|verify <options>]
tipctl [--version|--help|-h] del [dhcp <options>|nos <options>|ztp <options>]
tipctl [--version|--help|-h] show [dhcp <options>|nos <options>|repo <options>|ztp <options>]
SymbolsMeaning
Parentheses ( )Enter one of the objects or keywords
Square brackets [ ]Optional parameter; enter keyword or keyword-value pair as needed
Angle brackets < >Variable value for a keyword or option; required, enter according to your deployment nomenclature
Pipe

Command Prompt

IPM code examples use the following prompt:

  • cumulus@ts:~$ Indicates the user cumulus is logged in to the NetQ Telemetry Server (TS) to run the example command

The TS must be running the Cumulus Linux operating system (OS) and NetQ . Refer to the Install NetQ topic for details.

Command Help

As you enter commands, you can get help with command syntax by entering –help or -h at various points within a command entry. For example, to find out what options are available for DHCP configuration, enter -h after entering a portion of the tipctl add dhcp command. In this example, you can see that there are three possible commands related to DHCP configuration.

cumulus@ts:~$ tipctl add dhcp -h
 
Usage: tipctl add dhcp [OPTIONS] COMMAND [ARGS]...
  Add reservations and subnet pools
 
Options:
  -h, --help  Show this message and exit.
 
Commands:
  load         Load reservations from a CSV file via stdin
  pool         Add DHCP subnet pool
  reservation  Add DHCP reservation
 
cumulus@ts:~$

Command History

The CLI stores commands issued within a session, which enables you to review and rerun commands that have already been run. At the command prompt, press the Up Arrow and Down Arrow keys to move back and forth through the list of commands previously entered. When you have found a given command, you can run the command by pressing Enter, just as you would if you had entered it manually. Optionally you can modify the command before you run it.