--- title: "Relianoid Command Line Interface noid-cli User Guide" description: "# What is `noid-cli` `noid-cli` is the acronym of **RELIANOID Command Line Interface**. This tool allows managing multiple load balancers from a command line or automation of load balancer actions in the operation scripts. `noid-cli` is a wrapper of the…" url: "https://www.relianoid.com/resources/knowledge-base/howtos/relianoid-command-line-interface-noid-cli-user-guide/" updated: "2024-08-26" category: "Howto's" --- # Relianoid Command Line Interface noid-cli User Guide # What is `noid-cli` `noid-cli` is the acronym of **RELIANOID Command Line Interface**. This tool allows managing multiple load balancers from a command line or automation of load balancer actions in the operation scripts. `noid-cli` is a wrapper of the **API** (RELIANOID Application Programming Interface), it has an autocompletion feature to navigate easier through the load balancer modules and its objects. It can be used with RELIANOID load balancers with version EE 8.1 or higher. # First steps with `noid-cli` ## Installation `noid-cli` is available in the official RELIANOID APT repositories and it can be installed in a RELIANOID load balancer using: ``` apt-get update && apt-get install noid-cli ``` Also, this package is also valid for any Debian, Ubuntu or any distro based in **deb** packages in order to launch commands remotely to your load balancers. ## User Profiles **User Profiles** contain the information in regards to the load balancer where the commands will be executed and the user who will execute the command. The **user** feature is only available for RELIANOID Enterprise and it is managed in the RBAC module, the commands will be executed depend on the user's permissions. `noid-cli` is able to manage different profiles. ## Setup Before running `noid-cli` a **API key** is required. It can be enabled from the RELIANOID Web GUI, in the menu **System > User**. [![relianoid configure api user permissions](https://static.relianoid.com/wp-content/uploads/2020/04/relianoid_configure_user_api_permissions-1024x365.webp)](https://static.relianoid.com/wp-content/uploads/2020/04/relianoid_configure_user_api_permissions.webp) Once `noid-cli` is installed, it can be started by executing `noid-cli` in the shell. If it is executed from the load balancer, it will run with the default profile **localhost** which manages the local load balancer and the ZAPI key will be requested. In any other case, the configuration assistant will be started. [![relianoid noid-cli command line user interface](https://static.relianoid.com/wp-content/uploads/2024/06/relianoid-noid-cli-command-line-user-interface.webp)](https://static.relianoid.com/wp-content/uploads/2024/06/relianoid-noid-cli-command-line-user-interface.webp) If the profile settings have to be modified or another profile has to be created, the `noid-cli` **profile** object should be executed. It is possible to set the profile during the `noid-cli` invocation time using the **-p** option like it's shown below. ``` root@noid-ee-01:~$ noid-cli -p my_profile ``` or using the command with `noid-cli` in an interactive mode: ``` noid-cli: profile apply my_profile ``` # How it is used `noid-cli` has two working modes: 1. Launched without arguments, the `noid-cli` shell is executed in interactive mode. This mode provides autocompletion and it does not finish once a command is executed, to exit from the `noid-cli` shell, type **quit** or press **Ctrl+D**. 2. `noid-cli` is invoked with arguments. This will execute the command, without entering into the `noid-cli` interactive shell, and the return back to the system console. Let's see below the commands available in the RELIANOID Command Line Interface. ## Commands A command has the following syntax: ``` root@noid-ee-01:~$ noid-cli [ options ] [ object ] [action] [ ids list ] [ parameters ] ``` As an example: ``` root@noid-ee-01:~$ noid-cli -nc -p test-lb2 farms-services-backend set farm1 service1 0 -ip 1.1.1.1 -port 80 ^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^ ^^^ ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^ options object action ids list parameters ``` Find below the description of every parameter. **options**: They are set in the `noid-cli` invocation. The complete option list is detailed in the help. **object**: It is the kind of load balancer object that is selected. **action**: It is the verb that will be executed. **ids list**: They are the identifiers that refer to the object. These IDs are related to the module. **parameters**: They are the parameters to set in the object. Mostly, they are expected when an object is created/added or modified. All these parameters can be used in JSON format using the **-j** (**--json**) option. The expected command arguments can be retrieved pressing **Enter**. Sometimes parameters are not expanded until the previous arguments are set. `noid-cli` has an auto-completion functionality that can be triggered pressing double **TAB** button. The updated help can be checked with the command below. ``` root@noid-ee-01:~$ noid-cli help ``` ## Output Data The `noid-cli` prompt will change the color depending on the command error code. So the output will be shown in **green** if the command was successful or **red** if there was an error during the command execution. Also, the profile name will be printed as **grey** when `noid-cli` couldn't connect to the load balancer. For such kind of errors, it is useful to review the profile configuration and the load balancer ZAPI key. The output is printed in a colored JSON format, but they can be disabled using the option **-nc** (**--no-colors**). Some information messages could be shown, those messages are omitted when `noid-cli` is launched in command execution mode (without interactive `noid-cli`). The error messages are displayed through the **STDERR** output. # Command Examples A complete list of examples can be queried in the [ZAPI documentation](https://www.relianoid.com/zapidocv4.0/). Here only some useful examples: Get system info ``` root@noid-ee-01:~$ noid-cli system get ``` Get system stats ``` root@noid-ee-01:~$ noid-cli statistic-system get ``` List an overview of the farms ``` root@noid-ee-01:~$ noid-cli farm list ``` Create a farm ``` root@noid-ee-01:~$ noid-cli farm create -profile http -farmname farm1 -vip 10.0.0.241 -vport 443 ``` Retrieve the configuration of a farm ``` root@noid-ee-01:~$ noid-cli farm get farm1 ``` Modify a farm ``` root@noid-ee-01:~$ noid-cli farm set farm1 -listener https ``` Restart a farm ``` root@noid-ee-01:~$ noid-cli farm restart farm1 ``` Create a service ``` root@noid-ee-01:~$ noid-cli farm-service add farm1 -id images ``` Modify a service ``` root@noid-ee-01:~$ noid-cli farm-service set farm1 images -urlp /images ``` Add a backend ``` root@noid-ee-01:~$ noid-cli farm-service-backend add farm1 images -ip 10.0.4.40 -port 443 ``` Modify a backend ``` root@noid-ee-01:~$ noid-cli farm-service-backend set farm1 images 0 -priority 1 ``` Delete a backend ``` root@noid-ee-01:~$ noid-cli farm-service-backend remove farm1 images 0 ``` Unset a backend in maintenance mode ``` root@noid-ee-01:~$ noid-cli farm-service-backend maintenance farm1 images 0 ``` Set a backend in maintenance mode ``` root@noid-ee-01:~$ noid-cli farm-service-backend non_maintenance farm1 images 0 ``` Enjoy `noid-cli`, the RELIANOID Command Line Interface! ### 📄 Download this document in PDF format