aos-prov
Aos CLI Tool aos-prov is the unit provisioning tool using gRPC protocol.
The tool can:
- provision a Unit
- create, remove, and start VM group Units
- create and provision new VM group Units in one step
- add or remove dynamical nodes to VM group Units
- download images
- check version information
| sub-command, option | description |
|---|---|
| -V, --version | Shows installed version. |
| -h, --help | Shows general help or help for a selected command. |
| provision | Provisions a Unit. |
| vm-new | Creates a new VMs group Unit. |
| vm-remove | Removes the VMs group Unit. |
| vm-start | Starts the VMs group Unit. |
| unit-new | Creates and provisions a new VMs group Unit. |
| unit-node-add | Adds dynamical node to the already presented VMs group Unit. |
| unit-node-remove | Removes dynamical node from the already presented VMs group Unit. Only "secondary-N" nodes can be removed. |
| download | Downloads image. |
| check-version | Checks current version and latest available version. |
-V, --version
Shows installed version.
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov -V
~/.aos/venv/bin/python3 -m aos_prov -V
-h, --help
Shows general help or help for a selected command.
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov -h
~/.aos/venv/Scripts/python -m aos_prov provision -h
~/.aos/venv/bin/python3 -m aos_prov -h
~/.aos/venv/bin/python3 -m aos_prov provision -h
provision
Provision a Unit.
provision [-h] [-u UNIT] [-p PKCS] [--register-port REGISTER_PORT] [-w N] [--nodes NODES] [--skip-check-version] [--retry-count RETRY_COUNT] [--retry-delay RETRY_DELAY] [--check-software]
| Options | Required | Description | Default |
|---|---|---|---|
| -u, --unit | Unit address in format IP_ADDRESS or IP_ADDRESS:PORT (e.g., "localhost:8089") | ||
| -p, --pkcs12 | Path to user certificate in pkcs12 format | ~/.aos/security/aos-user-oem.p12 | |
| --register-port | Cloud port | 10000 | |
| -w, --wait-unit | Wait for unit to respond for the first time in seconds | 0 | |
| --nodes | Count of nodes for the VMs group Unit | 2 | |
| --retry-count | Number of retries for Cloud operations | 5 | |
| --retry-delay | Delay between retries in seconds | 5.0 | |
| --check-software | Checking for current software version support | False | |
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov provision
~/.aos/venv/bin/python3 -m aos_prov provision
vm-new
Create a new VMs group Unit.
vm-new [-h] -N NAME [-D DISK] [--nodes NODES] [--skip-check-version]
| Options | Required | Description | Default |
|---|---|---|---|
| -N, --name | + | Name of the VMs group Unit | |
| -D, --disk | Full path to the AosCore-powered disk | ||
| --nodes | Count of nodes for the VMs group Unit | 2 | |
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov vm-new -N [NAME]
~/.aos/venv/bin/python3 -m aos_prov vm-new -N [NAME]
vm-remove
Remove the VMs group Unit.
vm-remove [-h] -N NAME [--skip-check-version]
| Options | Required | Description | Default |
|---|---|---|---|
| -N, --name | + | Name of the VMs group Unit | |
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov vm-remove -N [NAME]
~/.aos/venv/bin/python3 -m aos_prov vm-remove -N [NAME]
vm-start
Start the VMs group Unit.
vm-start [-h] -N NAME [-H] [--skip-check-version]
| Options | Required | Description | Default |
|---|---|---|---|
| -N, --name | + | Name of the VMs group Unit | |
| -H, --headless | Start the VMs group Unit in headless mode | ||
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov vm-start -N [NAME]
~/.aos/venv/bin/python3 -m aos_prov vm-start -N [NAME]
unit-new
Create and provision a new VMs group Unit.
unit-new [-h] -N NAME [--disk DISK] [--nodes NODES] [-H] [-w N] [-p PKCS] [--skip-check-version] [--retry-count RETRY_COUNT] [--retry-delay RETRY_DELAY] [--check-software]
| Options | Required | Description | Default |
|---|---|---|---|
| -N, --name | + | Name of the VMs group Unit | |
| --disk | Full path to the AosCore-powered disk | ||
| --nodes | Count of nodes for the Unit | 2 | |
| -H, --headless | Start created VMs group Unit in headless mode | ||
| -w, --wait-unit | Wait for the Unit to respond in seconds | 300 | |
| -p, --pkcs12 | Path to user certificate in pkcs12 format | ~/.aos/security/aos-user-oem.p12 | |
| --retry-count | Number of retries for Cloud operations | 5 | |
| --retry-delay | Delay between retries in seconds | 5.0 | |
| --check-software | Checking for current software version support | False | |
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov unit-new -N [NAME]
~/.aos/venv/bin/python3 -m aos_prov unit-new -N [NAME]
unit-node-add
Add dynamical node to the already presented VMs group Unit.
unit-node-add [-h] -N NAME --disk DISK [-S [START]] [-H] [--skip-check-version]
| Options | Required | Description | Default |
|---|---|---|---|
| -N, --name | + | Name of the VMs group Unit | |
| --disk | + | Full path to the AosCore-powered dynamical disk | |
| -S, --start | Start Node of the VMs group Unit | True | |
| -H, --headless | Start Node of the VMs group Unit in headless mode | ||
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov unit-node-add -N [NAME] --disk [DISK_PATH]
~/.aos/venv/bin/python3 -m aos_prov unit-node-add -N [NAME] --disk [DISK_PATH]
unit-node-remove
Remove dynamical node from the already presented VMs group Unit. Only "secondary-N" nodes can be removed.
unit-node-remove [-h] -N NAME --node NODE [-r [REBOOT]] [--skip-check-version]
| Options | Required | Description | Default |
|---|---|---|---|
| -N, --name | + | Name of the VMs group Unit | |
| --node | + | Node of the VMs group Unit (starts with "secondary") | |
| -r, --reboot | Reboot all nodes into VM Group | True | |
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov unit-node-remove -N [NAME] --node [NODE_NAME]
~/.aos/venv/bin/python3 -m aos_prov unit-node-remove -N [NAME] --node [NODE_NAME]
download
Download image.
download [-h] [-a DOWNLOAD_ADDRESS] [-f] [--skip-check-version]
| Options | Required | Description | Default |
|---|---|---|---|
| -a, --address | Address to download image | ||
| -f, --force | Force overwrite existing file | ||
| --skip-check-version | Skip checking for newest version of the package |
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov download
~/.aos/venv/bin/python3 -m aos_prov download
check-version
Check current version and latest available version.
check-version [-h]
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_prov check-version
~/.aos/venv/bin/python3 -m aos_prov check-version