Aprenda nesse artigo como agilizar os processos administrativos no seu servidor ao gerenciar o WHM através da linha de comando!
O WHM possuí diversas ferramentas para administrar sua hospedagem e por conta da API WHM API 1 também é possível utilizar a maioria dessas ferramentas através da linha de comando do servidor. Nesse artigo você aprenderá a gerenciar seu WHM pelo terminal. Vamos lá?
Requisitos
Para poder gerenciar o WHM através da linha de comando você precisará:
- Acesso ao terminal SSH do servidor. Veja como realizar o acesso SSH ao seu servidor.
O que é whmapi1?
A whmapi1 é uma API do WHM & cPanel que permite que funções do WHM sejam executadas através de uma linha de comando, ou seja, sem a necessidade utilizar a interface visual do WHM. Para executar funções ao nível cPanel, existe outra API que deve ser utilizada, confira o artigo em que falamos dela:
Ter conhecimento sobre a utilização da whmapi1 pode agilizar muita certos procedimentos e acaba sendo a forma mais utilizada por administradores do WHM mais avançados.
Por exemplo: se você deseja verificar informações das contas cPanel que estão em seu WHM você precisará passar pelas páginas Home >>Account Functions >>Modify an Account.
Essas mesmas informações você consegue muito mais facilmente através do comando whmapi1 listaccts na linha de comando do servidor e de forma mais imediata.
Como gerenciar o WHM através da linha de comando
Existem mais de 600 funções no WHM que podem ser executadas via linha de comando, e todas elas estão listadas na documentação oficial da WHM API 1. Como a lista de funções é muito grande, nesse artigo você aprenderá os conceitos básicos para realizar a execução dos comandos da WHM API 1 e depois você pode aprender mais sobre as funções pela da documentação oficial.
Para executar os comandos da WHM API 1, você pode utilizar tanto o local completo da biblioteca da API que é /usr/local/cpanel/bin/whmapi1 ou o comando whmapi1 que faz link direto com esse diretório. Veja a seguir como verificar os comandos disponíveis no seu WHM.
Localizando a biblioteca de comandos da WHM API 1
1. Realize o acesso a um terminal SSH no seu Servidor.
2. Execute o seguinte comando no seu terminal:
$ whmapi1 --help
3. A saída desse comando vai fornecer algumas informações sobre como utilizar os comandos da WHM API 1 e também uma lista completa com os comandos disponibilizados na biblioteca da API.
Como executar comandos da WHM API 1
Apesar de a documentação oficial da WHM API 1 ter todas as informações atualizadas de suas funções, ela não é muita amigável para o usuário de linha de comando que deseja saber como executar os comando da API.
Porém, é possível consultar a documentação antiga da WHM API 1, que apesar de não receber mais atualizações, pelo menos as informações a serem executadas na linha de comando são fornecidas de maneira mais clara. Confira:
1. Acessando a documentação da WHM API 1, você encontrará uma lista com diversas funções do WHM. Para exemplificarmos a execução de um comando, acesse a aba Accounts para ver os comandos relacionados a contas de cPanel e depois clique em accountsummary.
2. Em seguida clique em Command Line. Será exibido a estrutura completa do comando que você pode rodar no terminal do seu servidor e os parâmetros a serem configurados.
Se surgirem dúvidas a respeito de como preencher os parâmetros confira nessa mesma página na tabela parameters como os parâmetros devem ser configurados para execução do comando.
3. Acesse o terminal SSH do seu servidor.
4. Execute o seguinte comando que você encontrou na documentação, mas com os parâmetros preenchidos corretamente
$ whmapi1 accountsummary user=username
Veja o exemplo abaixo a execução do comando accountsummary mostrando informações a respeito de uma conta cPanel:
5. Pronto! Agora você pode gerenciar seu WHM através da linha de comando.
A documentação antiga da WHM API 1 não recebe mais atualizações, podendo ser necessário ter que consultar a documentação oficial em caso de algum erro na execução de um comando.
Considerações Finais
Nesse artigo você aprendeu sobre a WHM API 1 e como utilizá-la para gerenciar o WHM através da linha de comando.
Se você sentiu alguma dificuldade ou então tem alguma sugestão de algo que não foi mencionado, basta deixar aí nos comentários que no futuro podemos estar trazendo atualizações para este artigo. Também indico esses outros materiais relacionados com este assunto:
Até a próxima! :^)