pyspcli 0.1.3

Silverpeak SD-WAN Command Line Interface

Silverpeak/Aruba SD-WAN Command Line Interface This CLI tool is to query the Silverpeal/Aruba SD-WAN orchestrator and output the information in your terminal.

Getting Started

Requierements

• Python >=3.7

• User with API KEY

To get started, install the CLI tool from Pypi

pip3 install pyspcli

or download it directly from github:

pip3 install git+https://github.com/NetDevLazg/spcli.git

Once the installation is successful, you will need to create a file with your api credentials.

• Create a folder in the following directory mkdir ~/.spcli

• Create a yml file with your credentials in .spcli directory

• Using vim

  • vim ~/.spcli/creds.yml

• Using nano

  • nano ~/.spcli/creds.yml

The yml file needs to have the following variables. Example:

url: silverpeak-orch-use1.silverpeak.cloud
token: a38b3360bb4d06fed7e53f77c8752d74bb4faeb4295385a25e02ebc2594d9074a16bb115fce4d4dc9826d824950504b6d23373

After the file is created and saved, please verify the cli tool version using the following command:

sp -v
version...installed: 0.0.6

Possible Errors

If you receive an error saying “Command not found” make sure to add the location where the package is installed to your $PATH

Possible error:

WARNING: The script sp is installed in '/Users/John/Library/Python/3.8/bin' which is not on PATH.

Fix:

export PATH='$PATH:/Users/John/Library/Python/3.8/bin'

Help Function

To check possible commands, use the -h flag after a command. for example:

sp -h
usage: sp [-h] [-d] [-v] {orch,appliance,bgp} ...

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           debug the cli
  -v, --version         shows cli tool version

Silvperpeak Commands:
  {orch,appliance,bgp,flows}
    orch                orchesrator commands
    appliance           edge connect appliance commands
    bgp                 edge connect bgp commands
    flows               flows statistics on edge connect
    ospf                edge connect ospf commands

Examples

Check devices:

sp appliance

+-------+---------------+----------------+-------------------+--------+------------------------+-----------------+-----------------+--------+
|  id   |     site      |       IP       |      serial       |  mode  |       hostName         | softwareVersion | systemBandwidth | haPeer |
+-------+---------------+----------------+-------------------+--------+------------------------+-----------------+-----------------+--------+
| 18.NE | aws-east-2    |  100.100.11.4  | 00-FF-BC-FF-3A-A6 | router | silverpeak-edge-01     |  9.0.6.2_90185  |     1000000     |        |
| 17.NE | aws-east-2    | 100.100.20.241 | 00-FF-BC-FF-3A-A7 | router | silverpeak-edge-02     |  9.0.6.2_90185  |     1000000     |        |
| 14.NE | aws-east-2    | 100.100.0.241  | 00-FF-BC-FF-38-52 | router | silverpeak-edge-03     |  9.0.6.2_90185  |     1000000     |        |
| 13.NE | aws-east-1    | 100.100.0.206  | 00-FF-BC-FF-38-54 | router | silverpeak-edge-04     |  9.0.6.2_90185  |     1000000     |        |
| 15.NE | aws-east-1    |  100.100.4.18  | 00-FF-BC-FF-38-53 | router | silverpeak-edge-05     |  9.0.6.2_90185  |     1000000     |        |
| 16.NE | aws-east-1    | 100.100.12.212 | 00-FF-BC-FF-3A-A5 | router | silverpeak-edge-06     |  9.0.6.2_90185  |     1000000     |        |
+-------+---------------+----------------+-------------------+--------+------------------------+-----------------+-----------------+--------+

Check bgp summary, must pass the appliance ID:

sp bgp -summary 18

+----------------+----------------+-------+----------------+----------+------------------+------------------+-----------+-----------+
|    local_ip    |    peer_ip     |  asn  | peer_state_str | last_err | last_err_subcode | time_established | rcvd_pfxs | sent_pfxs |
+----------------+----------------+-------+----------------+----------+------------------+------------------+-----------+-----------+
| 169.254.240.31 | 169.254.240.32 | 64535 |  Established   |    4     |        0         |      900685      |     1     |     2     |
| 169.254.240.31 | 169.254.240.33 | 64535 |  Established   |    4     |        0         |      900777      |     1     |     2     |
| 169.254.241.31 | 169.254.241.34 | 64534 |  Established   |    4     |        0         |      787280      |     1     |     2     |
| 169.254.241.31 | 169.254.241.35 | 64534 |  Established   |    4     |        0         |      782741      |     1     |     2     |
+----------------+----------------+-------+----------------+----------+------------------+------------------+-----------+-----------+