Utilidad Plesk - CLI RPC

El protocolo API XML ha sido diseñado para soportar la interacción entre Plesk y software de terceros de forma remota. Para realizar una operación a través de la API XML, debe enviar un mensaje HTTP con una estructura específica a un determinado endpoint de Plesk (https://<your-host-or-IP>:8443/enterprise/control/agent.php). Plesk recibe el mensaje, lo transforma en instrucciones de operación, intenta realizar las operaciones y devuelve los estados y detalles de la operación. Si desea más información acerca de la estructura de los paquetes y el transporte de mensajes, consulte Modelo Cliente-Servidor y Paquetes API XML.

Paquetes CLI

Comando Descripción de Parámetros Ejemplo
<add>

Añadir dirección IP a una regla.

Requiere<RULEID>IP</RULEID>

Para añadir 1.2.3.4 en la regla SMTP:

<packet><extension><call><flex-firewall-manager><add><SMTP>1.2.3.4</SMTP></add></flex-firewall-manager></call></extension></packet>

<remove>

Borrar dirección IP de una regla.

Requiere <RULEID>IP</RULEID>

Para eliminar 1.2.3.4 en la regla SMTP rule:

<packet><extension><call><flex-firewall-manager><remove><SMTP>1.2.3.4</SMTP></remove></flex-firewall-manager></call></extension></packet>

<find>

Busque la dirección IP en las reglas de Firewall o MailEnable.

Requiere -firewall -mailenable
<PARAM>IP</PARAM>

Buscar 1.2.3.4 en Firewall:

<packet><extension><call><flex-firewall-manager><find><firewall>1.2.3.4</firewall></find></flex-firewall-manager></call></extension></packet>

Buscar 1.2.3.4 en MailEnable:

<packet><extension><call><flex-firewall-manager><find><mailenable>1.2.3.4</mailenable></find></flex-firewall-manager></call></extension></packet>
<enable>

Habilitar una regla.

Requiere <RULEID>

Para activar regla SMTP:

<packet><extension><call><flex-firewall-manager><enable>SMTP</disable></flex-firewall-manager></call></extension></packet>

<disable>

Desactivar una regla

Requiere <RULEID>

Para desactivar regla SMTP:

<packet><extension><call><flex-firewall-manager><disable>SMTP</disable></flex-firewall-manager></call></extension></packet>

<list>

Mostrar la lista de reglas o ID disponibles.

id | exist

<list>ID</list>

Para obtener la lista ListID:

<packet><extension><call><flex-firewall-manager><list>id</list></flex-firewall-manager></call></extension></packet>

Para obtener los nombres de las reglas:

<packet><extension><call><flex-firewall-manager><list>exist</list></flex-firewall-manager></call></extension></packet>

<on>

Activar Firewall de Windows o Activar Extensión.

firewall | extension

<on>ID</on>

Para activar el firewall:

<packet><extension><call><flex-firewall-manager><on>firewall</on></flex-firewall-manager></call></extension></packet>

Para activar la Extensión:

<packet><extension><call><flex-firewall-manager><on>extension</on></flex-firewall-manager></call></extension></packet>

<off>

Desactive el Firewall de Windows o desactive la extensión.

firewall | extension

<off>ID</off>

Para desactivar el firewall:

<packet><extension><call><flex-firewall-manager><off>firewall</off></flex-firewall-manager></call></extension></packet>

Para desactivar Extension:

<packet><extension><call><flex-firewall-manager><off>extension</off></flex-firewall-manager></call></extension></packet>

<status>

Ver el estado del Firewall, Extensión o Protecciones de Windows.

firewall | extension | protection | mailenable | smartermail


<status>ID</status>

Para ver el estado del Firewall:

<packet><extension><call><flex-firewall-manager><status>firewall</status></flex-firewall-manager></call></extension></packet>

Para ver el estado de la extensión:

<packet><extension><call><flex-firewall-manager><status>extension</status></flex-firewall-manager></call></extension></packet>

Para listar el estado de las protecciones:

<packet><extension><call><flex-firewall-manager><status>protection</status></flex-firewall-manager></call></extension></packet>

Para ver el estado de MailEnable:

<packet><extension><call><flex-firewall-manager><status>mailenable</status></flex-firewall-manager></call></extension></packet>

Para listar el estado de SmarterMail:

<packet><extension><call><flex-firewall-manager><status>smartermail</status></flex-firewall-manager></call></extension></packet>

<protection>

Cambiar el estado de protección.

Requiere indicar qué módulo desea cambiar de estado:
SMTP | IMAP | POP | FTP | SECURITY | DB | RDP | WEB


<protection>ID</protection>

Para cambiar el estado HABILITADO/DESHABILITADO del módulo SMTP:

<packet><extension><call><flex-firewall-manager><protection>SMTP</protection></flex-firewall-manager></call></extension></packet>

Para cambiar el estado HABILITADO/DESHABILITADO del módulo RDP:

<packet><extension><call><flex-firewall-manager><protection>RDP</protection></flex-firewall-manager></call></extension></packet>

<whitelist>

Añadir IP a la lista de excepciones.

<whitelist>IP</whitelist>

Para añadir IP:

<packet><extension><call><flex-firewall-manager><whitelist>1.2.3.4</whitelist></flex-firewall-manager></call></extension></packet>

<help> Muestra los comandos disponibles.

Lista de comandos:

<packet><extension><call><flex-firewall-manager><help/></flex-firewall-manager></call></extension></packet>