white-300-x-5

 

v2 [Last Update: July 15, 2025]

Allxon On-Prem OOB CLI Tool 

 

Allxon on-prem OOB CLI Tool streamlines the administration of Out-of-Band (OOB) Enablers from host machines, including Nvidia Jetson devices. This tool enables users to execute power-related actions within an intranet environment. Additionally, Allxon on-prem OOB CLI tool provides interactive modes for several power controls, ensuring an efficient and user-friendly interactive management experience.

 

On This Page ...

 

    1. Getting Started

              1.1    Environment Setup

              1.2   Get the OOB Enabler CLI Tool

             1.3   Permission Modification for OOB Enabler CLI Tool

   2.  Available Functions

2.1   Check Version of OOB Enabler CLI Tool

2.2  Search Available OOB Enablers

2.3 Power Control Actions  

           2.3.1   Power Reset

                 2.3.1.1     Interactive Mode with operation function

                 2.3.1.2    Manually with powerctrl function

           2.3.2  Force Shutdown

                 2.3.2.1     Interactive Mode with operation function

                 2.3.2.2    Manually with powerctrl function

           2.3.3   Power Switch

                 2.3.3.1     Interactive Mode with operation function

                 2.3.3.2    Manually with powerctrl function

 

 

 

 

 


1. Getting Started


1.1 Environment Setup

 

Allxon on-prem OOB CLI Tool serves as a centralized management system, enabling users to control multiple OOB Enablers concurrently.

Connect the host machine and OOB Enablers to a Router to establish communication within the intranet. Ensure Allxon on-prem OOB CLI Tool is installed on the host machine to start the interaction with the OOB Enabler.

 

Requirements:

1. x64 & x86  Microsoft Visual C++ Redistributable packages must be installed. Check here to learn how to install them.

 


1.2 Get Allxon On-Prem OOB CLI Tool

 

On the host machine, download Allxon on-prem OOB CLI Tool by executing the following command. Alternatively, you can download the file directly and transfer it to the host machine.

 

Windows

 

  • or Input the following command in the Powershell:

$ wget https://get.allxon.net/oob/oob-cli-v1.00.1001-win64.exe -OutFile ".\Downloads\oob-cli-v1.00.1001-win64.exe"

 

Jetson, rpi4, rpi5 

 

or input the following command in the Terminal:

$ wget https://get.allxon.net/oob/oob-cli-v1.00.1001-aarch64

 

Ubuntu x64

 

or input the following command in the Terminal:

$ wget https://get.allxon.net/oob/oob-cli-v1.00.1001-x64

 

 

 

Note:

 

1. To switch to On-Prem OOB, please contact our team at service@allxon.com.

  1. 2. OOB Enabler is in the same subnet intranet with the host machine.
  2. 3. The router is capable of assigning DHCP to OOB Enablers and host machine.
  3.  

 


1.3 Permission Modification for OOB CLI Tool  

 

Navigate to the directory where oob-cli is located and grant the execute permission to the file oob-cli by entering the following command:

 

$ chomd +x oob-cli

 

Check if the execution permission has be granted successufly by entering the following command :

$ ./oob-cli

 

 

 

↑ Back to Top

 

 

 


2. Available Functions

List of the options available in this tool

 

Command

Description

version

The version of the Allxon OOB CLI.

operation

This program will guide you step by step to complete the OOB operation.

search

Searching the OOB device in the intranet. The search time is 5 seconds.

powerctrl

Execute the OOB power cycling command that you need.

 

↑ Back to Top

 

 

 


2.1 Check Version of OOB Enabler CLI Tool 

The version returns the version of OOB Enabler for CLI Edge Mode.
$ ./oob-cli version

 

 

 

↑ Back to Top

 

 

 


2.2 Search Available OOB Enablers  

The search function discovers of all the available OOB Enablers across the intranet, regardless of whether they are configured in DHCP mode or have a static IP address.

This function returns the serial numbers and the IP addresses of all the discovered OOB Enablers.

 

$ ./oob-cli search

 

The following search result shows there is 1 OOB Enabler found in the same subnet. Users can perform power-related actions by specifying the IP address or Serial Number of the OOB Enabler.

 

 

Note:

 

1. This tool currently supports scanning up to 10 devices. To increase the limit, feel free to contact our team at service@allxon.com.

 

 

 

↑ Back to Top

 

 

 

 


2.3 Power Control Actions

 

2.3.1 Power Switch

 

2.3.1.1   Interactive mode with operation function

The operation function is an interactive mode which is designed to provide guided experience as you navigate through the process of perfroming power actions. Instead of typing out complex commands, you can simply follow a step-by-step questionnaire to achieve your desired configurations.


  1. Example
  2.  
  3. Use the ./oob-cli operation function with the serial number of the OOB Enabler to perform Power Switch after 1 second.

 

 

 

2.3.1.2   Manually with powerctrl function

 

Use the powerctrl function along with the arguments to perform power switch to the device

Short Term

Argument

Description

-o

 -- oobip

The OOB current IP address that you want to configure. (required)

-m

--model

 The OOB hardware model. (required)
OOB has two hardware models. The argument value represented are 'v1' and 'v2'.
-c  --cmd The OOB supports power cycling commands. (required)
The argument value represented are 'switch', 'forceshutdown', and 'reset'.
'switch' : Send power command to switch the power status.
'forceshutdown' : Send power command to force the system to shut down.
'reset' : Send power command to reset the system. 

-t

--duration

To perform this action, set the -t  argument to 1.

 

$ ./oob-cli powerctrl -o 10.88.17.150 -m v2 -c switch -t 1

 

 

 

 

 

↑ Back to Top

 

 

2.3.2 Force Shutdown

 

2.3.2.1   Interactive mode with operation function

 

The operation function is an interactive mode which is designed to provide guided experience as you navigate through the process of perfroming power actions. Instead of typing out complex commands, you can simply follow a step-by-step questionnaire to achieve your desired configurations.

 

  1. Example
  2.  
  3. Use the ./oob-cli operation function with the serial number of the OOB Enabler to perform force shutdown.
  5.  

 

2.3.2.2  Manually with powerctrl function

 

Use the powerctrl function along with the arguments to perform force shutdown on the device

Short Term

Argument

Description

-o

 -- oobip

The OOB current IP address that you want to configure. (required)

-m

--model

 The OOB hardware model. (required)
OOB has two hardware models. The argument value represented are 'v1' and 'v2'.
-c  --cmd The OOB supports power cycling commands. (required)
The argument value represented are 'switch', 'forceshutdown', and 'reset'.
'switch' : Send power command to switch the power status.
'forceshutdown' : Send power command to force the system to shut down.
'reset' : Send power command to reset the system. 

-t

--duration

To perform this action, set the -t argument to 10.
$ ./oob-cli powerctrl -o 10.88.17.150 -m v2 -c forceshutdown -t 10

 

 

 

↑ Back to Top

 

 

2.3.3 Power Reset

 

2.3.3.1   Interactive mode with operation function

The operation function is an interactive mode which is designed to provide guided experience as you navigate through the process of perfroming power actions. Instead of typing out complex commands, you can simply follow a step-by-step questionnaire to achieve your desired configurations.

 

  • Example
  •  

Use the./oob-cli operation function with the serial number of the OOB Enabler to perform power reset after 1 second.

 

 

2.3.3.2   Manually with powerctrl function

The powerctrl function allows you to send power control commands to an OOB Enabler in the intranet.

 

Short Term

Argument

Description

-o

 -- oobip

The OOB current IP address that you want to configure. (required)

-m

--model

 The OOB hardware model. (required)
OOB has two hardware models. The argument value represented are 'v1' and 'v2'.
-c  --cmd The OOB supports power cycling commands. (required)
The argument value represented are 'switch', 'forceshutdown', and 'reset'.
'switch' : Send power command to switch the power status.
'forceshutdown' : Send power command to force the system to shut down.
'reset' : Send power command to reset the system. 

 

$ ./oob-cli powerctrl -o 10.88.17.150 -m v2 -c reset

 

 

 

↑ Back to Top

 

 

 

  

 

  

 

  •  

 

 

white-300-x-5

Lorem ipsum dolor sit amet, consectetur adipiscing elit Learn More