48k.eu-mirror
/
ogcli
mirror of https://git.48k.eu/ogcli/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
39 Commits
1 Branch
21 Tags
167 KiB
Python 100%
 
Go to file
Jose M. Guisado 0f2d1f1dba Show all valid commands when running ogcli --help 
Commands are retrieved using dir() so future commands will show
accordingly.

"ogcli --help" now will print:

usage: ogcli [-h] {create,list,rest,restore,send,set,setup}

positional arguments:
  {create,list,rest,restore,send,set,setup}
                        Subcommand to run

optional arguments:
  -h, --help            show this help message and exit
 		2021-09-27 12:55:36 +02:00
cfg Add ip and port parameters to config 2020-06-19 12:49:49 +02:00
cli ogCLI is AGPLv3+ 2021-05-14 00:26:33 +02:00
.gitignore add .gitignore 2020-06-18 16:53:41 +02:00
COPYING First commit 2020-06-18 16:44:08 +02:00
README.md Add README.md 2021-03-03 11:17:05 +01:00
ogcli Show all valid commands when running ogcli --help 2021-09-27 12:55:36 +02:00

README.md

ogCLI

Manage your OpenGnsys environment from your command line. A CLI for the ogServer REST API.

Installation

This tool is expected to be executed from the OpenGnsys installation environment.

Before running any command copy ogcli.json inside /opt/opengnsys/etc/

Usage

ogcli {command} {object} [{command object options}]

Commands

list

You can list currently connected clients, managed scopes, boot modes, hardware profiles and specific client information.

usage: ogcli list [-h] {clients,scopes,modes,hardware,client}

positional arguments:
  {clients,scopes,modes,hardware,client}

optional arguments:
  -h, --help            show this help message and exit

set

Set properties of the managed computers.

You can modify boot mode using set.

usage: ogcli set [-h] {modes}

positional arguments:
  {modes}

positional arguments:
  {modes}

optional arguments:
  -h, --help  show this help message and exit

Objects

They are subject to the specified command.

  • clients: Currently connected clients to the ogServer
  • client: Any specific client
  • modes: Network boot modes
  • hardware: Hardware profiles
  • scopes: Managed computers, rooms and centers.

Examples

Changing the boot mode of computers in a particular classroom

Fetching a classroom id
ogcli list scopes

{'scope': [{'name': 'Unidad Organizativa (Default)', 'type': 'center', 'id': 1, 'scope': [{'name': 'Aula virtual', 'type': 'room', 'id': 1, ...
Fetching net boot modes
ogcli list modes

{'modes': ['11', 'pxe', '00unknown', '19pxeADMIN', '13', '10', '12']}
Changing boot mode of the classroom
ogcli set modes --room-id 1 --mode pxe

License

ogCLI is released under the GNU Affero Public License v3

Authors

Soleta Networks