https://github.com/networkop/airctl

Last synced: about 1 year ago
JSON representation

Host: GitHub
URL: https://github.com/networkop/airctl
Owner: networkop
Created: 2021-06-02T21:16:57.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2021-06-23T15:11:42.000Z (about 5 years ago)
Last Synced: 2025-02-12T23:45:05.125Z (over 1 year ago)
Language: Go
Size: 385 KB
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Unofficial CLI client for air.nvidia.com

## Installation

To install the latest stable version run:

```
curl -L https://github.com/networkop/airctl/releases/latest/download/airctl_linux_x86_64.tar.gz | tar -zxvf - -C ~/.local/bin
```

### Build from source

This comman will install the latest version from the `main` branch:
```
$ go install github.com/networkop/airctl@latest
$ ls ~/go/bin/airctl
/home/user/go/bin/airctl
```

## Usage

```

### airctl defines a number of top-level verbs allowing interaction with platform resources

$ airctl
unofficial CLI client for air.nvidia.com

Usage:
airctl [command]

Available Commands:
get Display one or many resources
set Update existing resources
create Create a resource from a file
delete Delete resources by name or ID
login Authenticate with air.nvidia.com
help Help about any command

Flags:
-d, --debug Enable debug-level logging
-h, --help help for airctl
-v, --version version for airctl

Use "airctl [command] --help" for more information about a command.

### Let's try to login

$ airctl login bla
Login Failed

### This time with the correct token

$ airctl login eyJ0eXAiOiJK...
Authentication successful

### Let's see what trainings we've got available

### Currently there are no sims running

$ airctl get sim
+------+----+-------+
| NAME | ID | STATE |
+------+----+-------+
+------+----+-------+

### This is how you would create a sim

$ airctl create sim
Error: Either simID or topoID must be provided
Usage:
airctl create sim [flags]

Flags:
-c, --citc Create a citc sim
-h, --help help for sim
-s, --sim string ID of an existing sim to clone
-t, --topo string ID of an existing topo to create

Global Flags:
-d, --debug Enable debug-level logging

Either simID or topoID must be provided

### Let's create a sim based off the Cumulus Linux Test Drive training

$ airctl create sim -s 66aa0e94-e9f2-4bc7-af3a-caa9e67390c0
8f1740ac-eeb9-4b88-8e54-70ac2468c314
$ airctl get sim
+------+--------------------------------------+---------+
| NAME | ID | STATE |
+------+--------------------------------------+---------+
| | 8f1740ac-eeb9-4b88-8e54-70ac2468c314 | LOADING |
+------+--------------------------------------+---------+

### Now let's create a CITC sim

$ airctl create sim -c
01bed997-9eec-40c8-8f5e-56c6b1f30ab8

### Now we have 2 sims

### For each sim we can view more details

$ airctl get sim 8f1740ac-eeb9-4b88-8e54-70ac2468c314
{
"name": "",
"id": "8f1740ac-eeb9-4b88-8e54-70ac2468c314",
"url": "https://air.nvidia.com/api/v1/simulation/8f1740ac-eeb9-4b88-8e54-70ac2468c314/",
"state": "LOADED",
"title": "NVIDIA Cumulus Linux Test Drive",
"services": []
}

### Now let's see how to create a service

$ airctl create sim -h
Create simulation from topology or another sim

Usage:
airctl create sim [flags]

Flags:
-c, --citc Create a citc sim
-h, --help help for sim
-s, --sim string ID of an existing sim to clone
-t, --topo string ID of an existing topo to create

Global Flags:
-d, --debug Enable debug-level logging

### Currently only SSH service is supported

$ airctl create svc -n my-ssh -s 8f1740ac-eeb9-4b88-8e54-70ac2468c314 oob-mgmt-server:eth0
cbc1bc4c-44fa-418f-b9a8-de46959075ef

### Here are the details for all services

$ airctl get svc
+--------+--------------------------------------+--------------------------------------------------------------------------------+------+---------------------------------------------+
| NAME | ID | SIM | TYPE | LINK |
+--------+--------------------------------------+--------------------------------------------------------------------------------+------+---------------------------------------------+
| my-ssh | cbc1bc4c-44fa-418f-b9a8-de46959075ef | https://air.nvidia.com/api/v1/simulation/8f1740ac-eeb9-4b88-8e54-70ac2468c314/ | ssh | ssh://cumulus@worker04.air.nvidia.com:27017 |
+--------+--------------------------------------+--------------------------------------------------------------------------------+------+---------------------------------------------+

### The link can be used with the standard ssh client

$ ssh ssh://cumulus@worker04.air.nvidia.com:27017
The authenticity of host '[worker04.air.nvidia.com]:27017 ([147.75.49.29]:27017)' can't be established.
ECDSA key fingerprint is SHA256:2gi+bqJHFCZw1IefBtUdXuAIp7XERPuJ4vyom+CsZhg.
Are you sure you want to continue connecting (yes/no/[fingerprint])? ^C

### Each sim can be paused or unpaused

$ airctl set sim -h
Set the state of a simulation

Usage:
airctl set sim ( ID | Name ) up | down [flags]

Flags:
-h, --help help for sim

Global Flags:
-d, --debug Enable debug-level logging

### Let's pause one of the sims

$ airctl set sim 8f1740ac-eeb9-4b88-8e54-70ac2468c314 down

### Note the change in the status

### We can also delete all of the resources in one go

$ airctl del sim $(airctl get sim -q)
$ airctl get sim
+------+----+-------+
| NAME | ID | STATE |
+------+----+-------+
+------+----+-------+

### However services are not cleaned up

$ airctl get svc
+--------+--------------------------------------+--------------------------------------------------------------------------------+------+---------------------------+
| NAME | ID | SIM | TYPE | LINK |
+--------+--------------------------------------+--------------------------------------------------------------------------------+------+---------------------------+
| my-ssh | cbc1bc4c-44fa-418f-b9a8-de46959075ef | https://air.nvidia.com/api/v1/simulation/8f1740ac-eeb9-4b88-8e54-70ac2468c314/ | ssh | ssh://cumulus@$host:27017 |
+--------+--------------------------------------+--------------------------------------------------------------------------------+------+---------------------------+

### Most of the get/set/delete operations accept both ID and name

$ airctl del svc my-asd
Could not find a match for my-asd

### If name doesn't match, you'll get an error

$ airctl del svc my-ssh
cbc1bc4c-44fa-418f-b9a8-de46959075ef

### Otherwise the ID of the deleted service is returned and now they're all gone

$ airctl get svc
+------+----+-----+------+------+
| NAME | ID | SIM | TYPE | LINK |
+------+----+-----+------+------+
+------+----+-----+------+------+
```

## Login Token

At this point the token can only be extracted from one of the existing web UI API calls and needs to be refreshed ever 24h.

![](token.jpg)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/networkop/airctl

Awesome Lists containing this project

README