Administrar el cPanel a través de su interfaz visual es la forma más utilizada por la mayoría de los usuarios, sin embargo, cPanel cuenta con una API que permite administrar sus funciones a través de la línea de comandos, facilitando y agilizando varios procesos. En este artículo aprenderás cómo administrar el cPanel a través de la línea de comandos. ¿Vamos?

Requisitos

Para poder administrar el cPanel a través de la línea de comandos necesitarás:

• Acceso de terminal SSH al servidor. Mira cómo realizar el acceso SSH a tu servidor.
• Necesitas acceso root al servidor o entonces tener un token de API creado. Mira cómo crear un API Token en cPanel.

Cómo administrar el cPanel a través de línea de comandos

Realizar acciones simples en cPanel, como la creación de dominios, creación de correos electrónicos, instalar SSL son acciones que se pueden realizar fácilmente también a través de la línea de comandos a través de las APIs creadas por cPanel & WHM.

El cPanel provee dos API que sirven para acciones a ser ejecutadas a nivel de cPanel (para acciones a nivel de WHM use otra API), la UAPI y la CPAPI2 son ellas, que comparten una biblioteca de funciones similares, pero como la UAPI recibió más actualizaciones, es considerada la más recomendada para ser utilizada. Consulte la documentación oficial de esta API.

Cómo buscar una función específica de la UAPI

Si has accedido a la documentación oficial para utilizar la API, encontrarás allí todas las funciones y ejecuciones posibles, sin embargo, actualmente hay más de 500 comandos dentro de esta API, lo que hace difícil localizar una función concreta que quieras ejecutar en cPanel.

A pesar del gran número de comandos existentes, tenemos algunas formas de buscar una función específica dentro de la biblioteca de funciones UAPI y una de esas formas es con el siguiente comando:

$ /usr/local/cpanel/bin/uapi | egrep -i [TERMINO]

• /usr/local/cpanel/bin/uapi = este es el archivo que contiene todos los binarios para los comandos UAPI, ejecutando este archivo se mostrarán todos los comandos de la biblioteca UAPI
• | = el carácter pipe redirigirá la salida estándar generada al ejecutar el archivo /usr/local/cpanel/bin/apitool para el comando siguiente
• egrep -i [TÉRMINO] = egrep es el comando responsable de filtrar y encontrar determinados patrones en un texto. la flag -i hace que este filtrado no distinga entre mayúsculas y minúsculas y en el parámetro [TÉRMINO] introduces el término por el que deseas filtrar

Por ejemplo, si quieres comprobar algún comando relativo a SSH, puedes ejecutar el comando así:

$ /usr/local/cpanel/bin/uapi | egrep -i ssh

Observa que la línea SSH::get_port ha sido localizada y ahora puedes averiguar en la documentación de la UAPI qué parámetros utilizar para ejecutar este comando.

Ejecutando comandos de la UAPI

Por defecto, los comandos UAPI siguen la siguiente sintaxis:

$ uapi --user=USUARIO --output=TIPO Module function [parámetro=valor] [parámetro=valor]...

• uapi = comando que llama a la biblioteca de comandos UAPI
• --user=USUARIO = reemplaza el término USUARIO por el usuario de cPanel en el que deseas ejecutar el comando
• --output=TIPO = sustituya el término TIPO por el formato de respuesta que deseas recibir la salida del comando (json, jsonpretty, yaml). Este parámetro es opcional
• Module = introduce el módulo del comando que quieres ejecutar, utilizando el ejemplo anterior del SSH::get_port, el módulo aquí sería SSH
• function = introduce la función del comando que quieres ejecutar, utilizando el ejemplo anterior del SSH::get_port, el módulo aquí sería get_port
• [parámetro=valor] = este campo variará de función a otra y debe rellenarse correctamente como sugiere la documentación de la UAPI

Mira un ejemplo de ejecución del comando SSH::get_port:

Conclusiones Finales

En este artículo aprendiste cómo administrar el cPanel a través de la línea de comandos con la UAPI.

También recomiendo estos otros materiales relacionados con este tema:

• Cómo usar el comando sed de Linux
• Cómo usar el comando curl de Linux

¡Hasta la próxima! :^)