Préface 4. Conventions typographiques... 4 Feedback A propos de ce document 6. Remarques sur le processus du provisioning 8. Déployer le Panel 9

Transcription

1 Parallels Panel

2 Sommaire Préface 4 Conventions typographiques... 4 Feedback... 5 A propos de ce document 6 Remarques sur le processus du provisioning 8 Déployer le Panel 9 Déploiement autonome Obtenir l ID du numéro de build Obtenir la liste des composants du produit Installer le Panel Referentiel du CLI de l Outil d installation (en bref) Script d installation (Linux/Unix) Deployer dans l environnement Parallels Containers Parallels Containers pour Unix Parallels Containers pour Windows Configurer un miroir avec l utilitaire Rsync Creer un miroir des distributions Linux/Unix Creer un miroir des distributions Windows Présentation des opérations de configuration 32 Initialiser le Panel Installer la cle de licence Relooker le Panel en fonction de la marque Liens des services personnalises Configurer le DNS Changer le template d enregistrement SOA Configurer les templates d enregistrements de ressources Installer les certificats SSL Créer des domaines et des sous-domaines Installer des applications Importer le pack d application Installer l application Definir les Catalogues d APS disponibles Fichier de configuration du Catalogue APS Configurer via l API à distance 48 Utiliser l API à distance A propos de l API a distance Paquets API RPC Creer un logiciel client Configurer le Panel... 88

3 Préface 3 Initialiser le Panel Installer la clé de licence Configurer le DNS Installer les certificats SSL Créer des domaines Créer des sous-domaines Définir les catalogues d APS disponibles Installer des applications Configurer via CLI 206 A propos du CLI du Panel Configurer le Panel Initialiser le Panel Installer la clé de licence Relooker le Panel en fonction de la marque Configurer le DNS Installer les certificats SSL Créer des domaines Créer des sous-domaines Définir les catalogues d APS disponibles Installer des applications

4 4 Préface Préface Dans cette section : Conventions typographiques... 4 Feedback... 5 Conventions typographiques Avant d utiliser ce guide, il est important de comprendre les conventions de la documentation qui sont utilisées. Les types suivants de formatage dans le texte représentent des informations spécifiques. Convention de formatage Type d informations Exemple Gras spécial Italique Monospace Eléments que vous devez sélectionner comme les options de menu, les boutons de commande ou les éléments dans une liste. Titres des chapitres, des sections, et sous-sections. Utilisé pour surligner l importance d un point, présenter un terme ou désigner une variable de la ligne de commande qui est remplacée par une véritable valeur ou un véritable nom. Les noms des commandes, fichiers et répertoires. Allez dans l onglet Système. Lisez le chapitre Administration de base. Le système prend en charge la recherche des «caractères génériques». Le fichier de licence est situé dans le répertoire ses.

5 Préface 5 Convention de formatage Type d informations Exemple Préformaté Sortie de l ordinateur à # ls al /files l écran dans vos sessions total de la ligne de commande ; code source dans les langues de programmation XML, C++, ou autres. Gras préformaté MAJUSCULES TOUCHE+TOUCHE Ce que vous tapez, pour le contraster avec la sortie de l ordinateur à l écran. Noms des touches sur le clavier. Les combinaisons de touche sur lequelles l utilisateur doit appuyer et laisser la touche enfoncée puis appuyer sur l autre touche. # cd /root/rpms/php MAJ, CTRL, ALT CTRL+P, ALT+F4 Feedback Vous avez trouvé une erreur dans ce guide? Vous avez des idées ou des suggestions dont vous voulez nous faire part pour améliorer ce guide? Veuillez adresser vos commentaires à l aide du formulaire en ligne Quand vous nous signalez une erreur, merci de préciser le titre du guide, du chapitre et de la section, ainsi que la partie du texte dans laquelle vous avez relevé une erreur.

6 C H A P I T R E 1 A propos de ce document Objectifs Ce document vise à donner les informations essentielles sur le provisioning de Parallels Small Business Panel (ci-après nommé le Panel), informations qui devraient aider les hébergeurs (HSP) à proposer des solutions d hébergement complètes à leurs clients. Ce document s adresse aux développeurs HSP qui veulent mettre en place le provisioning du Panel, à savoir automatiser son déploiement/installation et la configuration suivante afin de répondre aux besoins particuliers des clients. Ce document présente des conseils sur ce que nous croyons être les meilleures pratiques (entièrement testées et garanties) pour installer et configurer le Panel dans le cadre du provisioning. Ce document ne prétend pas être la description entièrement fonctionnelle des interfaces de programmation ou API : les opérations et options au-delà de ce cadre ne sont pas décrites. Contexte En bref De nos jours, les fournisseurs de services passent des offres d hébergement d infrastructures non gérées aux offres de services gérés à valeur ajoutée. Les packs d hébergement vendus aux clients incluent non seulement l environnement du serveur virtuel ou physique avec des installations de panneaux de contrôle en option mais également les noms de domaines et certificats SSL. L approche SaaS devient de plus en plus populaire parmi les clients, en particulier parmi les petites entreprises. C est pourquoi les packs d hébergement commencent également à inclure des jeux prédéfinis d applications installées sur les domaines clients. De nombreuses offres contiennent aussi des services hébergés, comme la messagerie, les outils de collaboration et la gestion de contenus. Autrement dit, pour les installations du Panel, cela signifie que le fournisseur doit pouvoir exécuter la configuration du panneau juste après son installation, ce qui inclut : Configuration DNS Configuration du domaine (site Web) Déploiement du certificat SSL Installation des applications APS Pour simplifier les ajouts de services des fournisseurs, Parallels propose ce présent document en vue d expliquer comment le déploiement et la configuration du Panel peuvent être mis en place et intégrés dans une application de provisioning.

7 A propos de ce document 7 Le chapitre Remarques sur le processus du provisioning décrit brièvement les moments importants qui affectent tout le processus du provisioning. Le chapitre Déployer le Panel se concentre sur l étape de Déploiement du provisioning du Panel. Il couvre à la fois l installation dans les environnements Parallels Containers et les installations autonomes. Il traite également d un autre sujet relatif à la création de miroirs personnalisés du répertoire de distributions de Parallels Small Business Panel. Les trois chapitres suivants sont dédiés à l étape de Configuration du provisioning du Panel : Le chapitre Présentation des opérations de configuration explique la signification et le volume des opérations de configuration. Le chapitre Configurer via l API à distance est axé sur l exécution de la configuration du Panel à l aide de l API XML distante. Ce chapitre explique l API à distance : Il apporte une présentation du protocole API RPC et des exemples d outils qui interagissent avec le serveur du Panel via ce protocole. Il décrit également dans le détail les requêtes qu un outil tiers doit émettre pour exécuter les opérations de configuration du Panel ainsi que les réponses reçues pour chaque opération. Le chapitre Configurer via le CLI porte sur la configuration du Panel via l interface de la ligne de commande du Panel. Ce chapitre commence par présenter les bases du CLI puis décrit en détail les commandes à exécuter pour configurer le Panel.

8 C H A P I T R E 2 Remarques sur le processus du provisioning Lors du provisioning de Parallels Small Business Panel pour Windows, patientez cinq minutes entre le déploiement du produit et sa configuration. Un tel délai de configuration est requis en raison des scripts de post-installation qui prennent du temps pour enregistrer et configurer les composants tiers. Les opérations de provisioning exécutées pendant cette période risquent d échouer.

9 C H A P I T R E 3 Déployer le Panel Ce chapitre porte sur l étape de Déploiement du provisioning de Parallels Small Business Panel. Ce chapitre couvre à la fois l installation dans les environnements Parallels Containers et les installations autonomes. Il traite également d un autre sujet relatif à la création des miroirs personnalisés du répertoire de distributions du Panel. Dans ce chapitre : Déploiement autonome Deployer dans l environnement Parallels Containers Configurer un miroir avec l utilitaire Rsync... 26

10 10 Déployer le Panel Déploiement autonome Cette section présente l automatisation du déploiement du Panel dans un environnement non Parallels Containers, basé soit sur Linux/Unix soit sur Windows. Elle résume les bases de l installation du Panel puis indique les instructions pour installer le produit à l aide de l interface de la ligne de commande. Pour en savoir plus sur les pré-requis de l installation, reportez-vous au Guide d installation situé sur la page de documentation de Parallels Small Business Panel ( Le déploiement autonome du Panel s exécute à l aide de l utilitaire d installation de Parallels. Cet utilitaire se connecte à un serveur de mises à jour de Parallels Small Business Panel dans lequel les packs du Panel sont stockés, récupère les packs requis et les installe. L Outil d installation de Parallels fonctionne en mode interactif (via une interface utilisateur graphique Web ou de la ligne de commande), ou en mode automatique lorsqu il est exécuté à partir de la ligne de commande avec des options spécifiques indiquées. Ce dernier mode permet d automatiser le déploiement du Panel à l aide des scripts du shell. Il existe plusieurs distributions de l Outil d installation de Parallels créées pour différents systèmes d exploitation et plates-formes. C est pourquoi, vous pouvez être sûr que l Outil d installation de Parallels répondra à vos systèmes d exploitation hôtes. Normalement, les binaires de l Outil d installation de Parallels sont distribués au format suivant : parallels_installer_v<version de l installateur>_os_<version du système d exploitation>_<plate-forme>. Remarque : En décrivant l interface de la ligne de commande (CLI) de l Outil d installation de Parallels, nous partons du principe que l Utilitaire d installation de Parallels s appelle parallels_installer. Les répertoires officiels de Parallels Small Business Panel sont autoinstall.plesk.com (packs Linux/Unix) et autoinstall-win.parallels.com (packs Windows). Vous pouvez souhaiter configurer des miroirs personnalisés (cf. page 26) des répertoires du Panel dans votre environnement d hébergement pour gagner du temps, du trafic et certainement sécuriser l installation. Dans cette section : Obtenir l ID du numéro de build Obtenir la liste des composants du produit Installer le Panel Referentiel du CLI de l Outil d installation (en bref) Script d installation (Linux/Unix)... 18

11 Déployer le Panel 11 Obtenir l ID du numéro de build L ID du numéro de build est un identifiant unique du build de Panel, par exemple, Parallels Small Business Panel Pour obtenir une liste des ID des numéros de build, émettez la commande suivante : parallels_installer show-all-releases sur un serveur Linux/Unix parallels_installer.exe show-all-releases sur un serveur Windows Une liste des versions du produit s affichera. Par exemple : PPSMBE_10_2_0 (Parallels Small Business Panel )

12 12 Déployer le Panel Obtenir la liste des composants du produit Pour obtenir une liste des composants de la version, émettez la commande au format suivant : parallels_installer select-release-id <ID> --show-components Pour Parallels Small Business Panel 10.2 : parallels_installer select-release-id PPSMBE_10_2_0 --show-components sur un serveur Linux/Unix parallels_installer.exe select-release-id PPSMBE_10_2_0_WIN show-components Une liste des composants s affiche avec les noms des composants dans la partie gauche, l indication de savoir si ce composant peut être installé ([installer]) ou mis à niveau ([mettre à niveau]), avec des brèves descriptions sur la partie de droite : base [installer] - Packs de base de Parallels Small Business Panel autoinstaller [installer] - Outil d installation des produits Parallels postfix [installer] - Serveur de messagerie de Postfix php5 [installer] - Prise en charge de PHP5 postgresql [installer] - Prise en charge de PostgreSQL api [installer] - API de Parallels Small Business Panel siteeditor [installer] - Site Editor setemplates [installer] - Templates de Site Editor mod_python [installer] - Module Apache mod_python ruby [installer] - Prise en charge de Ruby on Rails firewall [installer] - Add-on du pare-feu vpn [installer] - Add-on VPN fileserver [installer] - Add-on du serveur de fichiers watchdog [installer] - Add-on de surveillance du système (Watchdog) drweb [install] - Parallels Premium Antivirus spamassassin [installer] - Prise en charge de SpamAssassin backup [installer] - Gestionnaire de sauvegardes backup-vz [installer] - Prise en charge de la réinstallation du Gestionnaire de sauvegardes PVC de-de-locale [installer] - Pack de langue allemande ja-jp-locale [installer] - Pack de langue japonaise es-es-locale [installer] - Pack de langue espagnole ru-ru-locale [installer] - Pack de langue russe fr-fr-locale [installer] - Pack de langue française it-it-locale [installer] - Pack de langue italienne zh-cn-locale [installer] - Pack de langue chinoise pour la Chine zh-tw-locale [installer] - Pack de langue chinoise pour Taïwan

13 Déployer le Panel 13 nl-nl-locale [installer] - Pack de langue néerlandaise pour les Pays-Bas atmail [installer] - Prise en charge de la messagerie Web Atmail

14 14 Déployer le Panel Installer le Panel Pour installer Parallels Small Business Panel, émettez la commande au format suivant : parallels_installer <options sources des packs>--select-release-id <ID> <options d installation des composants> [autres options] sachant que les options sources des packs définissent l emplacement dans lequel l Outil d installation doit recevoir les packs du Panel à installer <options sources des packs> = source <URL> si vous utilisez un miroir du serveur des mises à jour du Panel OU source <chemin d accès> si vous utilisez le système de fichier local OU Aucun si vous installez à partir du serveur de mises à jour du Panel Les options d installation des composants (cf. page 12) définissent les composants du Panel à installer <options d installation des composants> = install-everything OU install-component component1 [--install-component composant2 [... [--install-component composantn]]] autres options parmi lesquelles la définition des paramètres proxy, la journalisation de l installation, etc. Pour en savoir plus, veuillez vous reporter à la section Référentiel du CLI de l Outil d installation (cf. page 15) Exemples, Linux/Unix 1. La commande suivante installe Parallels Small Business Panel 10.2 (l ID du numéro de build est PPSMBE_10_2_0) à partir du miroir configuré sur le serveur disponible via HTTP sur l hôte ppsmbe-mirror.example.com. Les fichiers d installation seront temporairement stockés dans /tmp/ppsmbe, et le statut d installation sera signalé par mail à admin@example.com. Les composants installés sont les packs basiques du Panel, le serveur PostgreSQL et le filtre anti-spam SpamAssassin../parallels_installer source --target /tmp/ppsmbe select-release-id PPSMBE_10_2_0 --install-component base install-component postgresql install-component spamassassin notify- admin@example.com 2. La commande suivante exécute l installation complète (tous les composants du produit disponibles sont installés) de Parallels Small Business Panel 10.2 (l ID du numéro de build est PPSMBE_10_2_0) à partir du serveur de mises à jour de Parallels. La sortie de l Outil d installation sera redirigée vers un fichier XML../parallels_installer select-release-id PPSMBE_10_2_0 --install-everything enable-xml-output

15 Déployer le Panel 15 Exemples, Windows 1.La commande suivante installe Parallels Small Business Panel 10.2 (l ID du numéro de build est PPSMBE_10_2_0_WIN) à partir du miroir configuré sur le serveur disponible via HTTP sur l hôte ppsmbe-mirror.example.com. Les fichiers d installation seront temporairement stockés dans le dossier %SystemDrive%\Parallels\ et le statut d installation sera signalé par mail à admin@example.com. Le composants installés sont les packs basiques du Panel, un serveur de nom Bind, un serveur de messagerie MailEnable, un moteur de script PHP, Site Editor, et de la messagerie Web Horde. parallels_installer.exe source --target %SystemDrive%\Parallels select-release-id PPSMBE_10_2_0_WIN install-component base install-component dns install-component mailenable install-component php5 --install-component siteeditor install-component webmail notify- admin@example.com 2.La commande suivante exécute l installation complète (tous les composants du produit disponibles sont installés) de Parallels Small Business Panel 10.2 (release ID is PPSMBE_10_2_0_WIN) à partir du serveur de mises à jour de Parallels. La sortie de l Outil d installation sera redirigée vers un fichier XML. parallels_installer.exe select-release-id PPSMBE_10_2_0_WIN install-everything enable-xml-output Referentiel du CLI de l Outil d installation (en bref) Ce référentiel couvre les options de l Outil d installation de Parallels qui sont particulièrement importantes pour installer le Panel via le CLI uniquement. Pour en savoir plus sur les options associées à la mise à niveau du Panel déjà installé ou au système d exploitation hôte, émettez la commande suivante : parallels_installer help Option --source <chemin d accès> <url> --target <chemin d accès> Description et arguments possibles Lors de la récupération des packs du Panel à partir d un système de fichier local, indiquez l option --source à pointer vers le fichier.inf3 qui contient les informations sur le build du Panel que vous voulez installer. Lors de la récupération des packs du Panel à partir d un serveur réseau, indiquez l option --source <URL> à pointer vers le répertoire dans lequel se trouve le miroir du serveur de mises à jour du Panel. Par défaut, l Outil d installation enregistre les fichiers récupérés dans le répertoire /<nom de l utilisateur actuel>/psa. Par exemple, si l Outil d installation a été exécuté par l utilisateur root, le répertoire /root/psa sera créé et utilisé. Si vous voulez utiliser un répertoire personnalisé pour stocker les fichiers récupérés, utilisez l option target. Exemple : --target /opt/storage/psa OU --target D:\temp

16 16 Déployer le Panel Option --proxy-host <adresse réseau> --proxy-port <numéro de port> Description et arguments possibles En utilisant un serveur proxy ou un pare-feu, utilisez cette option pour indiquer le nom de domaine du serveur proxy ou l adresse IP. Exemple : --proxy-host proxy.example.com Le port par défaut pour connecter au serveur proxy est : Si votre serveur proxy utilise différents numéros de ports, vous devez l indiquer à l aide de cette option. Options d authentification du proxy : --proxy-user <nom-d utilisateur> --proxy-password <mot-de-passe> --show-releases --show-all-releases --select-release-id <ID> --select-release-lat est --show-components --install-component <nom-du-composant> --install-everything --show-os-list --no-space-check --no-daemon --notify- < > Exemple : --proxy-port 5741 Si votre serveur proxy requière une authentification, vous devez utiliser ces options pour authentifier l Outil d installation sur le serveur proxy. Exemple : --proxy-user smith proxy-password f1sz9anq4eno52 Indiquez cette option pour récupérer une liste des numéros de versions disponibles pour le système d exploitation dans lequel l outil d installation est installé. Vous obtiendrez une liste des identifiants et des descriptions de versions. Les identifiants des versions sont ce que vous devrez utiliser. Cette option indique toutes les versions disponibles à partir du serveur de mises à jour du Panel. Utilisez cette option pour indiquer une version précise que vous voulez installer ou dont vous voulez voir les propriétés. Utilisez cette option pour sélectionner le dernier numéro de version disponible pour votre système d exploitation. Indiquez ceci pour obtenir les informations sur les composants disponibles pour le numéro de version sélectionné. Les noms et descriptions des composants s afficheront. Les noms des composants sont ce que vous devez indiquer lorsque vous sélectionnez d autres composants à installer. Utilisez cette option pour indiquer un composant que vous souhaitez installer. Si vous voulez installer deux ou plusieurs composants à la fois, répétez cette option pour chaque composant. Exemple : --install-component base install-component postgresql install-component spamassassin Utilisez cette option pour installer tous les composants de la version sélectionnée. Utilisez cette option pour découvrir les systèmes d exploitation pris en charge dans la version du Panel que vous avez sélectionnée. Installe les packs même si vous n avez pas beaucoup d espace disque. Exécute le processus d installation en arrière-plan. Utilisez cette option pour que le programme d installation envoie vos rapports de statut par mail. Un rapport complet réussi inclut une liste des packs mis à jour/installés avec un log détaillé.

17 Déployer le Panel 17 Option --enable-xml-output --query-status --truncate-log --separate-log --debug --version Description et arguments possibles Cette option est conçue pour communiquer avec le Panel et peut être utilisée pour interagir avec d autres applications. Lorsque vous indiquez cette option, toute la sortie de l outil d installation est au format XML. Notez que cette option interdit à l outil d installation de signaler les erreurs par code de sortie. Le code de sortie est toujours zéro et toutes les erreurs sont signalées dans la sortie XML. Comme la base de données RPM ne permet pas plusieurs accès, l outil d installation verrouille sa fonctionnalité. Exécutez cette option pour voir si l outil d installation est actif. Le verrouillage sera alors vérifié et retournera soit un code de sortie (0 - l outil d installation n est pas occupé, 1 - l outil d installation fonctionne et est occupé), soit une sortie au format XML. Nettoie le fichier au démarrage de l Outil d installation des produits Parallels. Utilise le nouveau fichier log à chaque démarrage de l Outil d installation des produits Parallels. Active la sortie détaillée dans le fichier de log. Affiche la version de l Outil d installation des produits Parallels.

18 18 Déployer le Panel Script d installation (Linux/Unix) Cette section donne des informations sur l intégration et l exécution d un script d installation et illustre ces opérations par un ensemble de scripts d installation. Notes sur l intégration et les exécutions Pour éviter d avoir à insérer un mot de passe à chaque fois que vous voulez vous connecter via SSH aux serveurs dans lesquels le Panel doit être installé, placez votre clé publique dans la liste des clés autorisées d un utilisateur au nom duquel le script est exécuté sur chaque serveur (voir la documentation SSH pour en savoir plus sur la procédure). Si vous avez un miroir local du serveur de mises à jour du Panel (comme décrit dans la section Configurer les miroirs (cf. page 26)), utilisez l option suivante : source <URL du miroir> Par défaut, tous les packs téléchargés sont stockés dans le répertoire /root/psa. Pour utiliser un autre répertoire, utilisez l option suivante : target <nom-du-répertoire> Scripts modèles 1.Ce script modèle est applicable si l Outil d installation de Parallels est auparavant envoyé dans le serveur cible et le bit d exécution est configuré dans ses droits. #!/bin/sh SERVERS_LIST= node1.example.com node2.example.com for current_server in $SERVERS_LIST; do scp parallels_installer root@$current_server: ssh -f root@$current_server parallels_installer source --target /tmp/ppsmbe select-release-id PPSMBE_10_2_0 --install-component base install-component postgresql install-component asp notify- admin@example.com done 2. Ce script modèle est applicable si le fichier binaire de l Outil d installation de Parallels est directement reçu d un emplacement réseau (l URL d exemple doit être substitué par un lien correct de téléchargement de l outil d installation). #!/bin/sh SERVERS_LIST= node1.example.com node2.example.com for current_server in $SERVERS_LIST; do

19 Déployer le Panel 19 ssh -f wget -o parallels_installer;chmod 755./parallels_installer;./parallels_installer source --target /tmp/ppsmbe select-release-id PPSMBE_10_2_0 --install-component base install-component postgresql install-component spamassassin notify- done

20 20 Déployer le Panel Deployer dans l environnement Parallels Containers Cette section ne traite que les étapes essentielles à exécuter via le CLI de Parallels Containers pour déployer le Panel. L accent est porté sur la création d un conteneur avec Parallels Small Business Panel. Pour en savoir plus sur le CLI de Parallels Containers ou sur l API de Parallels Containers (XML ou SOAP), reportez-vous à la documentation des développeurs de Parallels Containers (anglais) ( Déployer le Panel dans un environnement Parallels Containers implique les deux étapes suivantes : 1. Installer le template d application du Panel sur un noeud matériel ou hardware node. 2. Créer un conteneur et déployer l application à partir du template. La première étape doit être exécutée une seule fois sur chaque hardware node : Dès qu un template d application est installé sur un hardware node, il peut être déployé dans autant de conteneurs que vous le souhaitez. Au lieu de créer un nouveau conteneur à chaque déploiement d un conteneur avec le Panel, vous avez toujours la possibilité de cloner un conteneur existant installé dans le Panel qui agit en tant que conteneur modèle. Dans cette section : Parallels Containers pour Unix Parallels Containers pour Windows... 24

21 Déployer le Panel 21 Parallels Containers pour Unix Deux templates EZ templates sont disponibles pour Parallels Small Business Panel 10.2 : ppsmbe10 Contient les composants coeur du Panel. ppsmbe10-extended Contient tous les autres composants comme le filtre anti-spam SpamAssassin, le framework Ruby-on-Rails, Parallels Premium Antivirus, les templates supplémentaires de Site Editor et autres composants. Si vous souhaitez installer une version étendue de Panel, installez les deux templates. Pour installer le template du Panel sur le hardware node cible, vous pouvez procéder des deux manières suivantes : utiliser l utilitaire vzup2date. Pour en savoir plus, reportez-vous au Guide de référence de Parallels Containers pour Linux (anglais) situé dans le Réseau IT de Parallels (PTN) ( télécharger le template directement à partir du site Web Parallels ( et installer l utilitaire vzpkg Une fois le template activé sur un hardware node, le jeu coeur de fichiers est alors déployé, y compris la définition du répertoire des packs d application. Lorsque l application est installée dans un conteneur, Parallels Containers communique avec le répertoire (le répertoire par défaut de Parallels Small Business Panel pour Linux/Unix est le serveur de mises à jour de Parallels sur récupère les packs d application et les installe dans le conteneur. Les packs sont stockés dans le cache du node jusqu à ce qu ils soient nettoyés. Ils sont ensuite récupérés du répertoire une fois l application installée dans le conteneur. Pour sauvegarder le trafic et la date/l heure, vous pouvez utiliser un miroir personnalisé du répertoire du Panel. Pour installer le template du Panel sur un hardware node de Parallels Containers à l aide de l utilitaire vzpkg, procédez comme suit : 1. Obtenez un template de Panel à partir du site Web de Parallels ( et envoyez-le dans l hardware node cible de Parallels Containers. 2. Installez le template d application en émettant une commande au format suivant : vzpkg install template [-q <-d <nombre>>] <chemin_d accès_au_pack>... sachant que -q désactive le logging pour l écran et le fichier de logs -d --debug <nombre> définit le niveau de verbosité du log de 0 à 10 Par exemple, la commande suivante installe les composants coeurs et étendus du Panel :

22 22 Déployer le Panel # vzpkg install template ppsmbe10-debian-5.0-x86-ez prl noarch.rpm ppsmbe10-extended-debian-5.0-x86-ez prl noarch.rpm Pour utiliser un miroir personnalisé, procédez comme suit : 1. Configurez un miroir comme expliqué dans la section Créer un miroir des distributions Linux/Unix (cf. page 27). 2. Sur l hardware node, éditez le fichier indiquant l URL du répertoire : a. Ouvrez pour éditer le fichier /vz/template/linux/<version-de-l os>/<plate-forme>/ config/app/<nom-du-template-d app>/default/reposito ries. C est /vz/template/linux/<os-version>/<platform>/config/app/ppsmbe10/ default/repositories et /vz/template/linux/<os-version>/<platform>/config/app/ppsmbe10- extended/default/repositories. Editez les deux si les deux templates sont installés. b. Remplacez les URL du serveur de mises à jour de Parallels par celles correspondantes et enregistrez le fichier. 3. Nettoyez ou réinitialisez les métadonnées des packs. Vous pouvez y parvenir, par exemple, avec la commande vzpkgclean. Pour en savoir plus, reportez-vous au Guide de référence de Parallels Containers pour Linux (anglais) situé dans le Réseau IT de Parallels (PTN) ( Pour créer un nouveau conteneur et l installer dans le Panel, procédez comme suit : 1. Créez un conteneur, et si vous le souhaitez, configurez-le en fonction de vos besoins. Emettez les commandes suivantes : vzctl create <ID_CT> [options] vzctl set <ID_CT><nom_du_paramètre><valeur> [--save] sachant que <ID_CT> définit un numéro ID arbitraire du conteneur supérieur à 100, qui est unique sur l hardware node --save dit à vzctl d enregistrer ou non les changements dans le fichier de configuration du conteneur Remarque : Pour en savoir plus sur la création des conteneurs et les options de configuration, reportez-vous au Guide de référence de Parallels Containers pour Linux (anglais) situé dans le Réseau IT de Parallels (PTN) ( Par exemple, les commandes ci-dessous permettent les actions suivantes :

23 Déployer le Panel créer un conteneur portant l ID 444 avec l IP , basé sur le template d OS par défaut défini dans le fichier de configuration générale de Parallels Containers 2. définir des barrières et limites de la mémoire du noyau non échangeable, de la mémoire privée (ou potentiellement privée), du nombre des fichiers ouverts par tous les processus des conteneurs, de l espace disque et d un nombre total d inodes de disque (fichiers, répertoires, liens symboliques) qui peuvent être alloués par le conteneur 3. sauvegarder les valeurs de la limite/barrière pour le fichier de configuration des conteneurs 4. gérer le conteneur à l aide du navigateur Web (en interdisant la gestion hors ligne avec offline_management no ) Remarque : Il est capital que vous définissiez exactement cette option comme dans l'exemple. Sinon, le Panel ne sera pas accessible via un navigateur Web. # vzctl create ipadd # vzctl set save kmemsize : privvmpages : numfile 12000: diskspace : diskinodes : offline_management no 2. Démarrez le conteneur nouvellement créé : # vzctl start <ID_CT> 3. Installez le template du Panel dans le conteneur : vzpkg install <ID_CT> <nom_du_template_ppsmbe>... Par exemple, la commande suivante installe les coeurs et les composants supplémentaires du Panel. # vzpkg install 444 ppsmbe10 ppsmbe10-extended Pour cloner un conteneur, procédez comme suit : Emettez la commande au format suivant : vzmlocal -C {CT List} {CT List} = <ID_CT_source>:<ID_CT_cible>[:[<dstCT_private>][:<dstCT_root>]] [...] Vous devez indiquer l ID du conteneur source (<ID_CT_source>) et celui du conteneur cible (<ID_CT_cible>). Vous n êtes pas obligé d indiquer le chemin d accès de la sphère privée du conteneur cible (<dstct_private>) et le chemin d accès root (<dstct_root>); vous pouvez ainsi écraser les chemins par défaut - /vz/private/<dst_ct_id> et /vz/root/<dst_ct_id>, en fonction. Pour en savoir plus sur les options de commande, reportez-vous au Guide de référence de Parallels Containers pour Linux (anglais) situé dans le Réseau IT de Parallels (PTN) ( Par exemple, pour cloner le conteneur avec le Panel créé lors de la procédure précédente : # vzmlocal -C 444:445

24 24 Déployer le Panel Parallels Containers pour Windows Pour installer le template du Panel sur un hardware node de Parallels Containers, procédez comme suit : 1. Obtenez le template de Panel à partir du site Web de Parallels ( et envoyez-le dans l hardware node cible de Parallels Containers. 2. Installez les templates d application du Panel. En cas d installation sur Microsoft Windows Server 2003, installez également Microsoft.NET Framework v.2.0 ou versions ultérieures en émettant une commande du format suivant : vzpkgdeploy [-q -v] -i <fichier-du-template> sachant que -q désactive le logging pour l écran et le fichier de logs -v définit le niveau de log sur la valeur la plus élevée pour cette session vzpkgdeploy Par exemple : >vzpkgdeploy -i ppsmbe_10.2.0_ efd >vzpkgdeploy -i dotnet2.0_frmwk efd Remarque : Il faut installer un template en plus du.net Framework uniquement sur Windows Server 2003 (PVC 4.0, VZ 3.5.1). Cette installation n est pas requise sur Windows Server 2008 (PVC 4.5). Pour créer un nouveau conteneur et l installer dans le Panel, procédez comme suit : 1. Créez un conteneur, et si vous le souhaitez, configurez-le en fonction de vos besoins. Emettez les commandes suivantes : vzctl create <ID_CT> --pkgset name [options] vzctl set <ID_CT><nom_du_paramètre><valeur> [--save] sachant que <ID_CT> définit un numéro ID arbitraire du conteneur supérieur à 100, qui est unique sur l hardware node --pkgset name dénote le template d OS à utiliser lors de la création d un conteneur --save dit à vzctl d enregistrer ou non les changements dans le fichier de configuration du conteneur Remarque : Pour en savoir plus sur la création des conteneurs et les options de configuration, reportez-vous au Guide de référence de Parallels Containers pour Windows (anglais) situé dans le Réseau IT de Parallels (PTN) (

25 Déployer le Panel 25 Par exemple, les commandes ci-dessous permettent les actions suivantes : créer un conteneur portant l ID 444 avec l IP , basé sur le template d OS w2k3 définir une limite d espace disque à plus de 4 gigaoctets, une limite de mémoire privée à 1 gigaoctet et un mot de passe Admin comme suit P4$$w0rd gérer le conteneur à l aide du navigateur Web (en interdisant la gestion hors ligne avec offline_management no ) Remarque : Il est capital que vous définissiez exactement cette option comme dans l'exemple. Sinon, le Panel ne sera pas accessible via un navigateur Web. >vzctl create pkgset w2k3 --ipadd >vzctl set save diskspace vprvmem userpasswd Administrator:P4$$w0rd offline_management no 2. Démarrez le conteneur nouvellement créé : >vzctl start <ID_CT> 3. Installez Microsoft.NET framework version 2.0 ou versions ultérieures dans votre conteneur : vzpkgadd <CT_ID> <nom_du template_dotnet> Par exemple : >vzpkgadd 444 dotnet2.0_frmwk / Installez le template du Parallels Small Business Panel dans le conteneur : vzpkgadd <ID_CT> <nom_du template_ppsmbe> Par exemple : >vzpkgadd 444 ppsmbe_10.2.0_ Pour cloner un conteneur, procédez comme suit : Emettez une commande au format suivant : vzmlocal -C <Liste_CT> <CT_List> = <IDCT_source>:<IDCT_cible>[:<cible_privé>] [options] Vous devez indiquer l ID du conteneur source (<IDCT_source>) et celui du conteneur cible (<IDCT_cible>). Vous n êtes pas obligé d indiquer le chemin d accès de la sphère privée du conteneur cible (<dest_private>) ; vous pouvez ainsi écraser le chemin d accès par défaut de X:\vz\private\<CT_ID>. Pour en savoir plus sur les options de commande, reportez-vous au Guide de référence de Parallels Containers pour Windows (anglais) situé dans le Réseau IT de Parallels (PTN) ( Par exemple, pour cloner le conteneur avec le Panel créé lors de la procédure précédente : >vzmlocal -C 444:445

26 26 Déployer le Panel Configurer un miroir avec l utilitaire Rsync Cette section décrit comment créer un miroir local du serveur de mises à jour de Parallels pour les distributions Linux/Unix et Windows de Parallels Small Business Panel sur un serveur Linux à l aide de Rsync. Rsync est un utilitaire open source qui permet de créer des miroirs qui prennent en charge un jeu souhaité des distributions du Panel, dont celles de Parallels Containers. Le miroir du répertoire de Parallels Small Business Panel pour Linux peut servir les installations autonomes et celles de Parallels Containers (dépend du volume des packs en miroir). Dans cette section : Creer un miroir des distributions Linux/Unix Creer un miroir des distributions Windows... 30

27 Déployer le Panel 27 Creer un miroir des distributions Linux/Unix Le répertoire de Parallels Small Business Panel pour Linux/Unix situé sur autoinstall.plesk.com est structuré comme suit (nous listons uniquement les fichiers et répertoires pour mettre en miroir les packs du Panel) : <NOM_PRODUIT>_<version_produit>/ Plusieurs sous-répertoires sont nommés en fonction des versions du Panel. Dans notre cas, les sous-répertoires intéressants sont les suivants : a PPSMBE_<version>/ par ex., PPSMBE_ dans lesquels les packs du Panel sont situés b SETEMPLATES_<version>/ par ex.., SETEMPLATES_1.0.0 dans lequel sont situés les packs pour les plus de 200 autres templates de designs pour site du composant Site Editor. En réalité, ce n est pas un véritable produit en lui-même mais un composant du Panel, placé dans un répertoire séparé du produit pour gagner de l espace disque et économiser du trafic. Chacun de ces sous-répertoires contient les fichiers suivants : dist-<type>-<nom-de-l os>-<version>-<architecture>/ Contient les packs de distribution du Panel ou des templates de design par ex., dist-deb-debian-5.0-x86_64/ ou dist-deb-debian-all-all/ update-<type>-<nom-de-l os>-<version>-<architecture> Contient les mises à jour du système pour le système d exploitation du serveur ; <type> est le type de pack : rpm, deb, pkg thirdparty-<type>-<nom-de-l os>-<version>-<architecture>/ Contient les packs tiers supplémentaires <NOM_PRODUIT>_<version-parallels-panel>-<nom-de-l os>-<architec ture>.inf3 Fichiers de configuration de l Outil d installation de Parallels par ex., ppsmbe suse11.1-x86_64.inf3, setemplates deball-all.inf3 products.inf3 Fichier de configuration de l Outil d installation de Parallels qui décrit les produits du Panel ppsmbe.inf3, setemplates.inf3 Fichiers de configuration de l Outil d installation de Parallels qui décrivent les différentes versions du Panel et autres composants PPSMBE10/ Métadonnées de Parallels Small Business Panel utilisées pour installer le Panel dans Parallels Containers à l aide des templates EZ.

28 28 Déployer le Panel debian/, ubuntu/ Répertoires utilisés en tant que répertoires apt-get pour installer les produits Parallels à l aide des templates EZ et l Outil d installation des produits Parallels Pour configurer un miroir pour le Panel, procédez comme suit : 1. Connectez-vous au serveur dans lequel vous allez configurer un miroir. 2. Créez un répertoire dans lequel les fichiers doivent résider. A des fins d illustration, nous appelerons ce répertoire destination_directory/. 3. Dans ce répertoire, créez deux sous-répertoires : debian/ et ubuntu/. 4. Pour configurer un miroir, utilisez les commandes suivantes. Cette commande télécharge le répertoire /PPSMBE_ sur le répertoire des mises à jour de Parallels dans destination_directory. # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/ppsmbe_ destination_directory Cette commande télécharge le répertoire /SETEMPLATES_1.0.0 sur le répertoire des mises à jour de Parallels dans destination_directory. # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/setemplates_1.0.0 destination_directory Ces commandes téléchargent les contenus pour installer les packs Ubuntu et Debian de Parallels Small Business Panel via l Outil d installation de Parallels. # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/debian/ppsmbe_ destination_directory/debian # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/ubuntu/ppsmbe_ destination_directory/ubuntu Ces commandes téléchargent les contenus pour installer les packs Ubuntu et Debian des autres templates de Site Editor via l Outil d installation de Parallels. # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/debian/setemplates _1.0.0 destination_directory/debian # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/ubuntu/setemplates _1.0.0 destination_directory/ubuntu Ces commandes téléchargent les contenus pour installer les packs Ubuntu et Debian du Panel via les templates EZ de Parallels Containers. Si vous configurez un miroir pour un environnement non Parallels Containers, ignorez cette étape. # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/debian/ppsmbe_10.2.0/ destination_directory/debian/ppsmbe10 # rsync -au delete rsync://rsync.autoinstall.plesk.com/autoinstall/ubuntu/ppsmbe_10.2.0/ destination_directory/ubuntu/ppsmbe10

29 Déployer le Panel 29 Cette commande crée un lien symbolique utilisé pour installer le Panel via les templates EZ de Parallels Containers sur les systèmes d exploitation basés sur RPM. Si vous configurez un miroir pour un environnement non Parallels Containers, ignorez cette étape. # cd destination_directory; ln -s PPSMBE_ PPSMBE10 Cette commande télécharge les fichiers de configuration de l Outil d installation de Parallels. # rsync -auv delete rsync://rsync.autoinstall.plesk.com/ autoinstall/products.inf3 autoinstall/versions.inf3 autoinstall/ppsmbe.inf3 autoinstall/setemplates.inf3 destination_directory 5. Editez les fichiers de configuration de l Outil d installation de Parallels pour définir les produits, versions et plates-formes à prendre en charge par le miroir. a. Editez le fichier products.inf3 supprimant tous les éléments product sauf celui portant l'id ppsmbe. Ne décochez pas l'élément product portant l'id setemplates ; de même si vous voulez que le jeu de templates de designs pour sites de Site Editor soit pris en charge. b. Editez le fichier ppsmbe.inf3 supprimant tous les éléments build sauf ceux des systèmes d'exploitation et de l'architecture que vous souhaitez que le miroir prenne en charge. c. Editez le fichier setemplates.inf3 supprimant tous les éléments build sauf ceux des systèmes d'exploitation et de l'architecture pour lesquels vous voulez que les templates de designs pour sites de Site Editor soient pris en charge. Remarque : Pour en savoir plus sur l utilitaire Rsync, visitez

30 30 Déployer le Panel Creer un miroir des distributions Windows Le répertoire de Parallels Small Business Panel pour Windows situé sur est structuré comme suit (nous listons uniquement les fichiers et répertoires pour mettre en miroir les packs du Panel) : <NOM_PRODUIT>_<version_produit>/ Plusieurs sous-répertoires sont nommés en fonction des versions du Panel. Dans notre cas, le sous-répertoire intéressant est PPSMBE-WIN_<version>/, par ex., PPSMBE-WIN_10.2.0/ Chacun de ces sous-répertoires contient les fichiers suivants : dist-<type>-<nom-de-l os>-<version>-<architecture>/ Contient les packs de distribution du Panel ou des templates de design, par ex., dist-msi-microsoft-2003-i386/ thirdparty-<type>-<nom-de-l os>-<version>-<architecture> packs tiers supplémentaires ppsmbe-<version-parallels-panel>-<nom-de l os>-<architecture>.inf3 Fichiers de configuration de l Outil d installation de Parallels products.inf3 Fichier de configuration de l Outil d installation de Parallels qui décrit les produits du Panel ppsmbe.inf3 Fichiers de configuration de l Outil d installation de Parallels qui décrit les différentes versions du Panel et autres composants Pour configurer un miroir pour le Panel, procédez comme suit : 1. Connectez-vous au serveur dans lequel vous allez configurer un miroir. 2. Créez un répertoire dans lequel les fichiers doivent résider. A des fins d illustration, nous appellerons ce répertoire destination_directory/. 3. Pour configurer un miroir, utilisez les commandes suivantes. Cette commande télécharge le répertoire PPSMBE-WIN_10.2.0/ sur le répertoire des mises à jour de Parallels dans destination_directory/. # rsync -au delete rsync://rsync.autoinstall-win.parallels.com/autoinstall/ppsmbe-win _ destination_directory Cette commande télécharge les fichiers de configuration de l Outil d installation de Parallels. # rsync -auv delete rsync://rsync.autoinstall-win.parallels.com/ autoinstall/products. inf3 autoinstall/ppsmbe.inf3 destination_directory

31 Déployer le Panel Editez les fichiers de configuration de l Outil d installation de Parallels pour définir les produits, versions et plates-formes à prendre en charge par le miroir. a. Editez le fichier products.inf3 supprimant tous les éléments product sauf celui portant l'id ppsmbe. Ne décochez pas l'élément product portant l'id setemplates ; de même si vous voulez que le jeu de templates de designs pour sites de Site Editor soit pris en charge. b. Editez le fichier ppsmbe.inf3 supprimant tous les éléments build sauf ceux des systèmes d'exploitation et de l'architecture que vous souhaitez que le miroir prenne en charge. Remarque : Pour en savoir plus sur l utilitaire Rsync, visitez

32 C H A P I T R E 4 Présentation des opérations de configuration Ca chapitre présente les opérations qui composent l étape de configuration du provisioning de Parallels Small Business Panel. Les descriptions des opérations sont structurées dans ce chapitre de sorte qu elles correspondent à l ordre dans lequel elles sont le plus performantes. Dans ce chapitre : Initialiser le Panel Installer la cle de licence Relooker le Panel en fonction de la marque Liens des services personnalises Configurer le DNS Installer les certificats SSL Créer des domaines et des sous-domaines Installer des applications Definir les Catalogues d APS disponibles... 45

33 Présentation des opérations de configuration 33 Initialiser le Panel La première chose à faire dans le Panel après l avoir installé, c est l initialiser. Il est interdit d exécuter toute autre opération dans le GUI du Panel ou via l API. L initialisation configure les paramètres suivants du Panel : l adresse mail de l administrateur le nouveau mot de passe de l administrateur au lieu de celui par défaut (facultatif) langue du Panel Si la langue n est pas configurée lors de l initialisation du Panel, l Anglais US (en-us) sera utilisé. La langue de l interface peut être changée ultérieurement par l admin du Panel, et ce à tout moment (pourvu que le composant (cf. page 12) de la langue requise soit installé). Si vous avez une traduction personnalisée du Panel, un pack de langue personnalisé doit être importé dans le Panel avant l initialisation. Pour en savoir plus, reportez-vous à Parallels Small Business Panel : Le Guide de localisation est situé dans page de documentation ( du Panel. Liens rapides Initialiser le Panel à l aide de l API à distance (cf. page 88) Initialiser le Panel à l aide du CLI (cf. page 209) Installer la cle de licence Le Panel est distribué avec la clé de licence par défaut qui prend en charge un nombre limité de comptes utilisateur. Il est nécessaire d obtenir une clé de licence qui corresponde au mieux aux besoins des utilisateurs. Outre la principale clé de licence qui définit les fonctionnalités majeures du Panel, d autres clés de licence peuvent être installées, permettant ainsi d utiliser les add-ons du Panel comme la solution Parallels Premium Antivirus. Liens rapides Installer la clé de licence à l aide de l API à distance (cf. page 93) Installer la clé de licence à l aide du CLI (cf. page 210)

34 34 Présentation des opérations de configuration Relooker le Panel en fonction de la marque Logo Les aspects suivants relatifs à la marque du Panel sont compris dans le cadre du provisioning du Panel : l URL et l image de logo du Panel le lien du bouton Assistance Remarque : Ces deux éléments sont pris en charge uniquement dans le CLI. Le type de logo du Panel s affiche dans l angle gauche supérieur du Panel. Par défaut, il s agit d une image GIF 141*29 pixels avec le type de logo du produit Parallels Small Business Panel. En cliquant dessus, il redirige vers le site Web de Parallels. Vous pouvez changer par vous-même l image du logo par défaut et l URL. Assistance Le bouton Assistance est situé sur l onglet Paramètres auquel l Admin du Panel peut accéder. Par défaut, cliquer sur le bouton ouvre le formulaire de demande d assistance sur le site Web de Parallels, qui doit normalement être rempli et envoyé par l administrateur. Si vous planifiez de proposer l assistance technique à vos clients, vous pouvez changer l URL qui s ouvre en cliquant sur le bouton Assistance. Liens rapides Relooker le Panel en fonction de la marque à l aide du CLI (cf. page 210) Liens des services personnalises L interface utilisateur de Parallels Small Business Panel contient plusieurs liens vers les services suivants : Service Description Comment accéder Par défaut Boutique en ligne Parallels Vend/Met à niveau les licences générales et les add-on du Panel. Paramètres > Gestion des clés de licence : liens Aller dans la Boutique en ligne pour acheter les add-ons de Panel et Aller dans la Boutique en ligne pour mettre à niveau la clé de licence du Panel Boutique en ligne de Parallels

35 Présentation des opérations de configuration 35 Boutique en ligne du Marketplace des applications (voir la Remarque en-dessous du tableau) Vend les licences pour les applications du Marketplace Applications & Scripts > Marketplace des applications : Acheter maintenant Boutique Marketplace de Parallels Boutiques des Packs utilisateur Vend les packs utilisateur du Panel Utilisateurs > Comptes utilisateurs : le lien Acheter un pack utilisateur supplémentaire Assistant Démarrer > Utilisateurs : le lien Acheter un pack utilisateur supplémentaire Mail > Adresses mail : le lien Acheter un pack utilisateur supplémentaire Paramètres > Gestion des clés de licence : le lien Aller dans le Marketplace des applications pour acheter des packs utilisateur Boutique Marketplace de Parallels Boutique en ligne des certificats CA Vend les certificats SSL CA. Paramètres > Certificats SSL > Ajouter les certificats SSL: le bouton Acheter un certificat SSL myplesk.com Registrar du nom de domaine Vend les noms de domaines Sites Web & Domaines : le bouton Enregistrer le nom de domaine myplesk.com

36 36 Présentation des opérations de configuration Remarque : Notez la différence : Le Catalogue du Marketplace d applications est un service qui offre une liste détaillée des applications disponibles. La boutique en ligne du Marketplace d applications est un service de ventes des licences pour ces applications. Les URL des Catalogues d applications (dont le Marketplace d applications) sont également personnalisables. Reportez-vous à la section Définir les catalogues APS disponibles (cf. page 45) pour en savoir plus. Vous pouvez vouloir personnaliser les URL qui s ouvrent lorsque vous cliquez sur les liens dans les cas suivants : Vous êtes Partenaire Parallels et vendez des licences du Panel et ses add-ons Vous êtes Partenaire Parallels et vendez les packs utilisateur du Panel Vous êtes Partenaire Parallels et vendez des licences pour les applications du Marketplace Vous offrez des services d enregistrement du nom de domaine Vous vendez des certificats CA Les liens sont personnalisés en modifiant le fichier de configuration du Panel smb.ini. Une fois la personnalisation requise exécutée dans le fichier de configuration, il peut être envoyé à un nombre illimité d instances du Panel, remplaçant ainsi la configuration par défaut. Rien de spécial n est nécessaire pour y parvenir. Veuillez utiliser les appels de ligne de commande standards. Le fichier de configuration du Panel Emplacement : Sur Unix/Linux : $PRODUCT_ROOT/admin/smb/application/config/smb.ini Sur Windows : %plesk_dir%\admin\smb\application\config\smb.ini (%plesk_dir% est une variable de l environnement définissant le répertoire d installation du Panel) Configuration des liens du service : [marketplace] panelandaddonslicensesstore = url = userpacksurl = buysslcertificatesurl = registerdomainsurl = Par défaut, le fichier de configuration ne contient pas cette section, vous devez manuellement ajouter le titre de la section ([marketplace]) et les chaînes suivantes en fonction de ce que vous voulez personnaliser : Si vous changez l URL de la boutique en ligne vendant le Panel et ses add-ons : panelandaddonslicensesstore =

37 Présentation des opérations de configuration 37 Si vous changez l URL de la boutique en ligne vendant les licences des applications du Marketplace : url = Si vous changez l URL de la boutique en ligne vendant les Packs utilisateurs : userpacksurl = Si vous changez l URL des certificats CA vendant le service : buysslcertificatesurl = Si vous changez l URL du service d enregistrement du nom de domaine : registerdomainsurl = Pour annuler ces personnalisations et revenir aux valeurs par défaut, supprimez une chaîne appropriée de smb.ini.

38 38 Présentation des opérations de configuration Configurer le DNS Parallels Small Business Panel est installé avec le serveur DNS configuré comme serveur de nom maître pour les domaines créés et hébergés avec le Panel. Lors du provisioning du Panel, vous pouvez désactiver le service DNS ou le configurer comme vous le souhaitez. Si votre environnement de travail détient un serveur de nom configuré pour servir tous les domaines hébergés, la plupart du temps, vous n avez pas besoin de serveur DNS séparé dans chaque serveur doté de l instance du Panel. Il nous faut aussi préciser qu en cas d environnement Parallels Containers, les conteneurs avec le Panel, dans lequel le serveur DNS s exécute, consomme beaucoup moins de ressources ce qui réduit modérement la densité de l environnement de l hébergement complet. Pour que les zones DNS des domaines gérés par le Panel soient servies par un serveur DNS distant, désactivez le service DNS lors du dimensionnement d une instance du Panel. Si vos clients décident que leurs domaines soient servis par un serveur DNS local, ils pourront toujours l activer ultérieurement. Si vous voulez que les domaines gérés par le Panel soient servis par un service DNS local, vous pouvez toujours modifier les zones DNS de la manière qui vous convient. Le Panel offre un template personnalisable de la zone DNS qui contient les templates des enregistrements DNS SOA et autres enregistrements de ressources. A la création d un compte de domaine, sa zone DNS est créée en partant sur la base du template. Donc, afin de configurer les zones DNS pour les domaines gérés par le Panel, vous ne devez qu éditer le template de la zone DNS. Liens rapides Configurer le DNS à l aide de l API à distance (cf. page 99) Configurer le DNS à l aide du CLI (cf. page 212) Dans cette section : Changer le template d enregistrement SOA Configurer les templates d enregistrements de ressources... 39

39 Présentation des opérations de configuration 39 Changer le template d enregistrement SOA Le template de l enregistrement SOA du Panel permet de changer les champs d enregistrements suivants : ttl (time to live ou durée de vie) Actualiser Réessayer Expirer Minimum (CLI Unix uniquement) Format sn (= numéro de série) Format du numéro de série de la zone : yyyymmdd ou heure Unix (time stamp) Configurer les templates d enregistrements de ressources Le template de la zone DNS du Panel prend en charge les types de ressources suivants : A NS CNAME MX PTR TXT AXFR SRV

40 40 Présentation des opérations de configuration Installer les certificats SSL Utiliser un protocole Secure Sockets Layer sur un domaine requière tout d abord l installation d un certificat SSL. Dans le Panel, les certificats SSL sont connectés aux domaines via les adresses IP : un certificat est affecté à une adresse IP et utilisé lorsque vous accédez à un domaine hébergé sur cette IP. En général, le certificat sera utilisé lorsque vous essaierez d accéder via HTTPS à tous les domaines hébergés sur cette IP. Donc, pour installer le certificat SSL, vous devez importer un certificat dans le Panel et l affecter à une adresse IP. Lorsqu un compte de domaine est créé sur une telle adresse IP, le paramètre d hébergement du domaine Support SSL est automatiquement activé et le certificat installé est utilisé pour accéder au domaine. Liens rapides Installer les certificats SSL à l aide de l API à distance (cf. page 128) Installer les certificats SSL à l aide du CLI (cf. page 218)

41 Présentation des opérations de configuration 41 Créer des domaines et des sous-domaines Domaines Le processus de création et de configuration des domaines et sous-domaines a été reconçu dans Parallels Small Business Panel, et simplifié autant que possible. L idée est qu à la création d un sous-domaine, vous devez indiquer les paramètres d hébergement les plus importants et le reste des paramètres d hébergement sera automatiquement configuré de la manière qui convient le mieux. Donc, pour créer un domaine, vous devez indiquer les arguments suivants : Nom de domaine. Adresse IP. Si l adresse IP est associée à un certificat SSL (cf. page 40), le support SSL est automatiquement activé pour le domaine créé sur cette IP. Propriétés de l hébergement Web requises : login et mot de passe du compte FTP qui seront utilisés pour envoyer le contenu du site Web. Lorsqu une application Web est installée sur un domaine, le Panel configure automatiquement tous les services requis pour l application. C est pourquoi l adresse IP, le login FTP et le mot de passe sont les seuls paramètres de l hébergement qui doivent être indiqués à la création du domaine. Liens rapides Créer des domaines à l aide de l API à distance (cf. page 135) Créer des domaines à l aide du CLI (cf. page 220) Sous-domaines Lors de la création d un sous-domaine, vous devez indiquer au moins le nom du préfixe du sous-domaine et le domaine parent. Un contenu du sous-domaine est normalement situé dans le répertoire /httpdocs/subdomains/subdomain-name de l hôte virtuel du domaine. Le Panel pour Windows prend également en charge les sous-domaines dans le sous-dossier - sous-domaines mappés dans un répertoire situé dans le dossier /httpdocs. Cela est particulièrement utile si vous voulez qu une application Web installée soit accessible en tant que sous-domaine. Par exemple, une application WordPress est normalement accessible via des URL comme comme, Avec le sous-domaine sur le sous-dossier, vous pouvez rendre l application accessible via Pour créer un sous-domaine régulier, vous devez indiquer un nom de domaine parent, le nom du sous-domaine et les propriétés de l hébergement du sous-domaine.

42 42 Présentation des opérations de configuration Remarque : Par défaut, le contenu du sous-domaine est accessible sous le même compte FTP en tant que domaine parent. Ainsi, vous n êtes pas obligé d indiquer les propriétés du compte FTP sauf si un compte FTP séparé est requis pour accéder au contenu du sous-domaine. Pour créer un sous-domaine dans le sous-dossier (prise en charge uniquement sur Windows), indiquez un nom de domaine/sous-domaine parent, le nom du sous-domaine et le chemin vers un dossier sur lequel le sous-domaine est créé. Remarque : Pour les sous-domaines dans le sous-dossier, il est impossible de créer un compte utilisateur FTP séparé : le compte utilisateur FTP d un domaine/sous-domaine parent est toujours utilisé. Liens rapides Créer des sous-domaines à l aide d une API à distance (cf. page 141) Créer des sous-domaines à l aide du CLI (cf. page 220)

43 Présentation des opérations de configuration 43 Installer des applications Parallels Small Business Panel prend en charge les applications APS. Ces applications Web sont packagées conformément à l APS, Application Provisioning Standard ( qui est devenu le modèle SaaS pour l industrie de l hébergement. Nous différencions le terme Pack d application - une archive zip avec l application Web packagée de manière à correspondre au format APS. Contrairement à l application elle-même qui est installée dans le pack. L installation d une application sur le domaine ou le sous-domaine s exécute en deux étapes : 1. Obtenir le pack d application et l importer dans le Panel. 2. Installer le template d application à partir du pack sur un domaine ou un sous-domaine. Liens rapides Installer les applications à l aide de l API à distance (cf. page 150) Installer les applications à l aide du CLI (cf. page 223) Dans cette section : Importer le pack d application Installer l application... 44

44 44 Présentation des opérations de configuration Importer le pack d application Un pack d application peut être obtenu et importé de deux manières : Un pack, que vous avez certainement créé par vous-même, est envoyé manuellement à l hôte dans lequel le Panel est installé puis importé manuellement dans le Panel. Un pack est téléchargé et automatiquement importé dans le Panel à partir d un Catalogue APS (un service Web permettant d accéder aux packs d applications stockés à distance). Vous pouvez télécharger et importer plusieurs applications à la fois. Le Panel prend en charge le suivi du statut des téléchargements. Le Panel prend en charge l obtention des packs d applications à partir de plusieurs instances du Catalogue APS. Les Catalogues APS disponibles sont définis dans le fichier Fichier de configuration du Catalogue APS (cf. page 45), qui peut être personnalisé pour s adapter à l instance du Panel dans un environnement d hébergement particulier. Installer l application Lors de l installation d une application, il vous faut indiquer : Le pack d application à partir duquel l application est installée. Identification soit par ses informations nom-version-numéro de version soit par l ID du pack. Ces données peuvent être obtenues en récupérant les packs disponibles. Récupérer les packs disponibles aboutit à une liste détaillée des packs d applications importés dans le Panel, dont les identifiants requis. Domaine ou sous-domaine cible. Propriétés de l installation. Elles sont propres à l application. Il peut s agir d applications sans aucune propriété d installation ou paramètre. L API du Panel ne prend pas en charge l obtention d informations sur les paramètres des applications. Vous devez donc y parvenir en utilisant l API du Catalogue APS ( ou en analysant un fichier de métadonnées du pack. Le format APS est décrit dans les Indications du format APS (anglais).

45 Présentation des opérations de configuration 45 Definir les Catalogues d APS disponibles La liste des Catalogues APS définis dans le fichier de configuration sert les deux objectifs suivants: 1. Les applications de ces catalogues peuvent être directement installées sur un domaine à l aide de l API du Panel. Remarque : Installer les applications à partir d un catalogue APS non listé dans le fichier de configuration est impossible. 2. Ce catalogue ne s affiche pas pour les utilisateurs du Panel sur l écran Applications & Scripts, et les utilisateurs peuvent installer les applications de leur propre chef. Le Catalogue APS est un nom généralisé de ce service, il peut prendre les formes spécifiques suivantes : Catalogue APS sur apscatalog.com ( Le service du Catalogue APS officiel est pris en charge par Parallels. Remarque : Il est essentiel que apscatalog.com soit présent dans la configuration lorsque les sites Web avec les applications APS sont migrés vers le Panel via la sauvegarde/restauration. Le Catalogue APS personnalisé, un miroir local du service déployé dans l environnement d hébergement et offrant un accès à des applications spécifiques. Pour en savoir plus sur la mise en place d un miroir local du Catalogue APS, reportez-vous à la documentation disponible sur le site officiel d APS via Vous pouvez vouloir définir les Catalogues APS disponibles dans les cas suivants : a Lors du provisioning du Panel, vous voulez installer les applications à partir de votre Catalogue APS personnalisé. Dans ce cas, vous ajoutez une entrée pour votre Catalogue dans le fichier de configuration. b Vous voulez que les utilisateurs du Panel accèdent à votre Catalogue APS personnalisé à la place ou avec ceux fournis par le Panel par défaut. Dans ce cas, vous ajoutez une entrée pour votre Catalogue dans le fichier de configuration et si vous le souhaitez, vous pouvez supprimer des entrées existantes. c Vous voulez que les utilisateurs du Panel n aient pas accès aux Catalogues APS. Dans ce cas, vous pouvez supprimer toutes les entrées du fichier de configuration. Pour changer la liste des Catalogues APS disponibles, vous devez exécuter les opérations suivantes : 1. Modifiez l exemple de Catalogue APS (cf. page 47) en fonction de vos besoins. 2. Importez votre fichier de configuration dans le Panel à l aide des méthodes suivantes :

46 46 Présentation des opérations de configuration Copier votre fichier de personnalisation personnalisé et remplacer celui par défaut par l OS standard Importer à l aide de l API de provisionning du Panel Liens rapides Définir les Catalogues APS disponibles à l aide de l API à distance (cf. page 146) Définir les Catalogues APS disponibles à l aide du CLI (cf. page 222) Dans cette section : Fichier de configuration du Catalogue APS... 47

47 Présentation des opérations de configuration 47 Fichier de configuration du Catalogue APS Emplacement Format Sur Linux/Unix : /usr/local/psa/admin/smb/application/config/aps/catalogs.ini Sur Windows : %plesk_dir%\admin\smb\application\config\aps\catalogs.ini Le fichier de configuration du Catalogue APS est un document texte au format suivant : [apscatalog] ;Mot-clé servant d identificateur interne de la ressource des applications APS. type = apscatalog ;définition du type de ressources des applications APS, il peut s agir de marketplace ou d apscatalog ;marketplace est un type utilisé pour indiquer le service Application Marketplace ;apscatalog est un type commun qui doit être utilisé pour tout Catalogue APS (service Catalogue APS officiel et miroirs locaux) url = ;URL des ressources d applications APS [marketplace] type = marketplace url = protocol = all-app [APSCatalogLocalMirror] type = apscatalog name.en-us = APS Catalog (local) ;titre des ressources d applications APS tel qu il sera affiché dans le GUI du Panel dans le fichier de traduction correspondant description.en-us = Local instance of APS catalog ;description des resources des applications APS tel qu elle sera affichée dans le GUI du Panel dans le fichier de traduction correspondant url = apscatalog.example.com

48 C H A P I T R E 5 Configurer via l API à distance Ce chapitre porte sur l exécution de la configuration du Panel à l aide de l API à distance du Panel. La section Utiliser l API à distance (cf. page 49) inclut la présentation du protocole API RPC et des exemples d outils permettant d interagir avec le serveur géré du Panel via ce protocole. La section Configurer le Panel (cf. page 88) décrit en détail les messages de requêtes qu un outil tiers doit émettre pour exécuter les opérations de configuration du Panel; ainsi que les messages de réponses reçus pour chaque opération. Dans ce chapitre : Utiliser l API à distance Configurer le Panel... 88

49 Configurer via l API à distance 49 Utiliser l API à distance Cette section explique en quoi consiste l API à distance du Panel, son fonctionnement et comment créer une application client qui communiquera avec le Panel via l API à distance. Dans cette section : A propos de l API a distance Paquets API RPC Creer un logiciel client... 56

50 50 Configurer via l API à distance A propos de l API a distance Pour prendre en charge l interaction entre le Panel et un logiciel tiers, le Panel offre l API basée sur XML. Cette interface présente tout un jeu de fonctions pour gérer les objets logiques du Panel. Le protocole API RPC a été conçu pour appeler ces fonctions API à distance. C est le protocole XML-over-HTTP qui échange les données sous la forme de paquets spécifiquement formatés. L interaction entre le Panel et le logiciel tiers est basée sur le modèle de programmation client-serveur. Figure 1:Interaction entre Parallels Panel et le logiciel client tiers La partie Serveur est présentée par le serveur API RPC du Panel (ci-dessous appelé le serveur) qui est une partie du Panel. Le logiciel partie client doit être créé par une tierce partie. Le scénario d interaction se présente comme suit : 1. L application cliente forme un paquet de requêtes XML (ci-dessous appelées paquet API RPC ou le paquet), ajoute une en-tête HTTP standard et l envoie au serveur. 2. Le serveur reçoit le paquet, le valide et appelle les fonctions internes du Panel pour exécuter les opérations requises. 3. Le serveur forme le paquet de réponses contenant les détails sur l opération exécutée et le renvoie. 4. Le client reçoit ce paquet (le statut de l opération, et si possible, un message d erreur ou les paramètres d opération) et récupère les informations. L interaction se termine. Versions API prises en charge La version actuelle de Panel prend en charge uniquement la version du protocole API RPC.

51 Configurer via l API à distance 51 Paquets API RPC Le paquet API RPC est un simple document XML inclus dans le corps du message HTTP. Nous différentions deux types de paquets : paquets de requêtes : formés par le logiciel partie client et envoyés au serveur par l API à distance paquets de réponses : formés par le serveur et envoyés au client Un paquet de réponses contient le statut d exécution de l opération requise et peut contenir un message d erreur en cas d échec de l opération. Dans cette section : Structure du paquet Exemples de paquet Validation des paquets... 55

52 52 Configurer via l API à distance Structure du paquet Nous différentions les parties du paquet API RPC suivantes : 1. En-tête HTTP : partie transport. Outre les autres infos standards, elle doit contenir les données du serveur dans lequel l opération sera exécutée et les données d identifiants de l administrateur du Panel. 2. En-tête du paquet : indiquant la version du protocole API RPC. 3. Corps du paquet : déterminant les opérations qui doivent être exécutées par le serveur. Le corps du paquet est structuré comme suit : <[operator]> <[operation]> <[parameter1]> </[parameter1]>... <[parameter2]> </[parameter2]> </[operation]> </[operator]> Cet exemple indique la structure common du corps du paquet contenant un élément [operator] et un élément [operation]. Dans une mise en place particulière, les éléments [operator], [operation], [parameter] doivent être remplacés par de vrais opérateurs, opérations et paramètres. Remarque : Il peut y avoir plusieurs opérations dans un opérateur et plusieurs sections d opérateur dans un seul paquet. Par la suite, lorsque nous parlerons de l en-tête et du corps du paquet XML, nous nous réfèrerons à ces deux éléments en utilisant le terme paquet.

53 Configurer via l API à distance 53 Exemples de paquet Voici un exemple de message de requête API RPC envoyé au serveur : POST /enterprise/control/agent.php HTTP/1.1 Host: :8443 Accept: / HTTP_AUTH_LOGIN: admin HTTP_AUTH_PASSWD: setup Pragma: no-cache Content-Length: 1398 Content-Type: text/xml <?xml version= 1.0 encoding= UTF-8 standalone= no?> <packet version= > <smb> <initial_setup> <password>p4$$w0rd</password> <admin_ >johndoe@example.com </admin_ > <locale>de-de</locale> </initial_setup> </smb> En-tête HTTP L en-tête HTTP indique que la méthode HTTP utilisée est POST, l agent de traitement est situé dans /enterprise/control/agent.php, et la version HTTP est 1.1. L élément Host indique l adresse IP et le port du serveur du Panel auquel le message s adresse. Les éléments HTTP_AUTH_LOGIN et HTTP_AUTH_PASSWD contiennent les identifiants de connexion de l administrateur du Panel. Le Content-Type doit être text/xml. La longueur du message passé est également requise. Début de la partie XML En-tête du paquet L attribut version indique la version requise du protocole API RPC du Panel. Corps du paquet Démarre toujours à partir de l onglet de l opérateur associé. Ce paquet spécifique utilise l opérateur smb pour initialiser un logiciel du Panel récemment installé. Les éléments compris dans le noeud initial_setup contiennent les données nécessaires pour initialiser le Panel : le mot de passe et l adresse mail de l admin du Panel ainsi que la langue. Balise fermant le paquet Les deux paquets - de requêtes et de réponses - sont similaires au niveau de la structure mais les en-têtes HTTP et les corps sont différents. Le message envoyé par le serveur en réponse à la demande ci-dessus peut ressembler à ceci : HTTP/ OK Transfer-Encoding: chunked Content-type: text/html Date : Fri, 03 Apr :54:56 GMT Server: sw-cp-server/1.0.0 <?xml version= 1.0 encoding= UTF-8 standalone= no?> <packet version= > En-tête standard de la réponse du serveur HTTP Le type MIME est text/xml. L élément Server indique que la demande a été traitée par le Panel du côté serveur. En-tête standard d un document XML correct En-tête du paquet XML

54 54 Configurer via l API à distance <smb> <initial_setup> <result> <status>ok</status> </result> </initial_setup> </smb> Corps du paquet Le noeud root du corps du paquet est l opérateur smb. Les lignes nichées indiquent que l initialisation du Panel a réussi. Balise fermant le paquet

55 Configurer via l API à distance 55 Validation des paquets Le serveur API RPC du Panel est structuré sous forme d agents - ou d opérateurs - gérés par le moteur de l Agent. Chaque agent est un bloc logique en charge du traitement d un certain groupe de commandes et le moteur de l Agent fait office de dispatcher des paquets. En outre, le moteur de l Agent est associé à plusieurs jeux de fichiers de schéma XML. Chaque jeu est associé à une certaine version API RPC. Un point d entrée de chaque version est le fichier agent_input.xsd qui fait référence à tous les schémas d entrée de la même version. Le serveur API RPC du Panel fonctionne comme suit : Tout d abord, le paquet XML pur, son en-tête HTTP retirée, va dans le moteur de l Agent. Le moteur de l Agent récupère la version API RPC de l en-tête du paquet, choisit le jeu de approprié de schémas XML et switche dans le bon schéma agent_input.xsd. Ce schéma valide le niveau d opération du paquet après la validation de chaque section d opérateur du paquet avec le schéma correspondant. Figure 2: Validation des paquets côté serveur Si le paquet est considéré comme incorrect, le moteur de l Agent forme un rapport d erreur et le renvoie au client. Si tous les éléments du paquet sont bien validés, le moteur de l Agent vérifie s il a tous les modules de l agent nécessaires pour continuer le processus et les invoque l un après l autre. Chaque agent (opérateur) invoqué reçoit sa section de paquet pour opérateur, l analyse, forme les appels de fonctions internes et retourne le résultat des commandes exécutées au moteur de l Agent.

56 56 Configurer via l API à distance Creer un logiciel client L application client doit mettre en place les étapes suivantes d échanges de données : conversion de la commande requise en paquet XML compatible avec API RPC préparation du paquet à fournir via HTTP et envoi dans le Panel réception de la réponse du Panel et extraction des informations résultantes du paquet Figure 3: Structure des applications côté client Le schéma ci-dessus démontre comment une application cliente peut être structurée et comment cette structure sert le roulement des données. Chaque module de cette application modèle est en charge d une tâche particulière, c est à dire : 1. L éditeur de paquets XML accepte une commande à partir du GUI de l application ou d un module tiers. L éditeur de paquets XML contient un convertisseur de commandes en XML pour chaque commande connue. Le format de ce paquet XML résultant est totalement conforme à la version API RPC prise en charge par l application cliente. 2. L expéditeur de paquets HTTP accepte le paquet XML. Le paquet ne contient aucune information sur le serveur cible et sur les détails de l accès. L expéditeur de paquets HTTP doit stocker ces paramètres ou doit pouvoir les obtenir sur demande. L expéditeur de paquets HTTP forme une en-tête HTTP avec les identifiants de connexion de l utilisateur du Panel et envoie le serveur API RPC du Panel via le protocole API RPC. 3. Le destinataire de paquets HTTP reçoit le paquet HTTP du côté serveur, supprime l en-tête HTTP et migre la réponse XML pure vers l analyseur (parser) de paquets XML. 4. L analyseur de paquets XML analyse le paquet de réponse XML pour le statut de l exécution et forme un message d erreur correspondant si le résultat est négatif. Puis il envoie les données traitées et extraites dans le GUI ou dans le module d appel. Le schéma ci-dessus indique les opérations HTTP en tant que partie de la bibliothèque HTTP. En fait, ces opérations peuvent être intégrées depuis le début mais l approche la plus simple est d utiliser une bibliothèque HTTP testée et prête à l emploi. La division entre expéditeur HTTP et destinataire HTTP se fait sous certaines conditions : Cette division a été effectuée dans le seul but de séparer les opérations HTTP envoyées et reçues sur le plan graphique.

57 Configurer via l API à distance 57 Dans cette section : Créer un paquet de requêtes Envoyer un message de requête Analyser la reponse Traiter les erreurs Exemples de codes client Créer un paquet de requêtes Au moment de former le paquet de requêtes API RPC, l application cliente reçoit la commande du GUI ou d un module logiciel afin d exécuter une opération (ou plusieurs) sur un ou plusieurs objets du Panel. Cette application doit convertir la commande requise au format d un paquet XML compatible avec l API XML du Panel. Pour intégrer le convertisseur commande en paquet XML, rappelez-vous comment les paquets API RPC sont structurés et comment ils sont traités par le serveur Panel (cf. page 51). Afin d ajouter la validation du paquet de requêtes créé dans le convertisseur, utilisez le jeu des fichiers de schémas XML à partir de l installation du Panel : PRODUCT_ROOT_D/admin/htdocs/schemas/rpc/ sur Linux/Unix sachant que PRODUCT_ROOT_D est une variable définissant le répertoire d installation du Panel. %plesk_dir%\admin\htdocs\schemas\rpc\ sur Windows sachant que %plesk_dir% est une variable définissant le répertoire d installation du Panel. Assurez-vous d utiliser agent_input.xsd en tant que point d entrée de la validation.

58 58 Configurer via l API à distance Envoyer un message de requête Lorsque le paquet API RPC du Panel est prêt, il doit être intégré dans l en-tête HTTP et envoyé dans le serveur indiqué. Pour exécuter ces tâches, nous vous suggérons d utiliser une bibliothèque cliente HTTP/FTP. Cette section démontre comment l exécuter dans PHP à l aide du moteur CURL - une bibliothèque gratuite de transferts URL côté client prise en charge dans PHP et versions ultérieures. Pour former l en-tête HTTP, le moteur CURL requière les paramètres suivants : L URL du serveur cible est formée sous la forme d une chaîne disponible au format suivant : define ( HOST, ); define ( PORT, 8443); define ( PATH, enterprise/control/agent.php ); $url = HOST. :. PORT. /. PATH; L étendue des éléments de l en-tête est la suivante : $headers = array( HTTP_AUTH_LOGIN: admin, HTTP_AUTH_PASSWD: setup, Content-Type: text/xml ); Le moteur CURL est alors initialisé et configuré pour utiliser HTTPS, et tous les paramètres requis pour l en-tête HTTP sont passés dedans : // initialize the curl engine $ch = curl_init(); // set the curl options: // do not check the name of SSL certificate of the remote server curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); // do not check up the remote server certificate curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // pass in the header elements curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); // pass in the url of the target server curl_setopt($ch, CURLOPT_URL, $url);

59 Configurer via l API à distance 59 Un autre paramètre requis par le moteur CURL est le paquet API RPC du Panel. Supposons que le paquet est formé comme suit : $packet = <<<EOP <?xml version= 1.0 encoding= UTF-8?> <packet version= > <smb> <initial_setup> <password>p4$$w0rd</password> <admin_ >johndoe@example.com</admin_ > </initial_setup> </smb> EOP; Maintenant, laissez-nous vous expliquer que le moteur CURL de la part duquel nous attendons une requête depuis le serveur; passe dans le paquet à fournir et déclenche le transfert : // tell CURL to return the result rather than to load it to the browser curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // pass in the packet to deliver curl_setopt($ch, CURLOPT_POSTFIELDS, $packet); // perform the CURL request and return the result $retval = curl_exec($ch); // close the CURL session curl_close($ch); Une fois la requête exécutée, CURL obtient le paquet HTTP résultant du coté client, supprime l en-tête HTTP et la variable $retval obtient la part XML pure du paquet de réponse.

60 60 Configurer via l API à distance Analyser la reponse Vous pouvez utiliser toute bibliothèque de clients HTTP/FTP pour transférer la requête dans le Panel et obtenir le résultat. En général, le paquet HTTP résultant sera structuré comme décrit dans la section Structure du paquet (cf. page 52). Si le moteur CURL est utilisé, le résultat sera retourné au format XML pur. La structure du paquet XML pur retourné par le serveur API RPC du Panel est définie par les schémas XML. Le Packet est un noeud root de chaque paquet de réponses XML, l attribut version retourne la version du protocole API RPC du Panel fonctionnant sur le serveur. Un paquet de réponse contient soit la réponse d opérateurs particuliers soit l erreur d application du panel retournée dans le noeud system. Pour en savoir plus sur la signification des noeuds system et output, reportez-vous à la section Traiter les erreurs (cf. page 62). Pour examiner la structure des réponses, vous avez besoin du schéma agent_output.xsd. Ce schéma énumère les types de données de réponses pour tous les opérateurs pris en charge par une version indiquée d API RPC, et signale également les schémas de sortie correspondant à ces opérateurs. Dans chaque élément [operator] d un paquet de réponses, un type de données de réponses classique contient un ou plusieurs éléments result. Cet élément est représenté par un type complexe qui inclut généralement le type resulttype défini dans le schéma common.xsd comme suit : <xs:complextype name= resulttype > <xs:sequence> <xs:element name= status type= result_status ></xs:element> <xs:element name= errcode type= unsignedint minoccurs= 0 ></xs:element>

61 Configurer via l API à distance 61 <xs:element name= errtext type= xs:string minoccurs= 0 ></xs:element> </xs:sequence> </xs:complextype> L élément result peut également contenir des éléments nichés en option si certains sont définis sous le type complexe. En général, le format du paquet retourné par le serveur API RPC du Panel apparaît comme suit : <?xml= 1.0 encoding= UTF-8?> <packet version= > <[operator]> <[operation]> [ ] <result>... </result> <result>... </result>... <result>... </result> </[operation]> </[operator]> Ici, [operator] représente l opérateur utilisé dans le paquet de requêtes et [operation] représente l opération exécutée. L élément RESULT est toujours utilisé pour isoler les informations requises et le statut de l exécution de l opération accomplie. La section RESULT contient toujours l élément STATUS qui détient le statut de l exécution de l opération accomplie. Remarque : Un vrai paquet de réponses XML peut contenir plus d une opération dans la section de l opérateur si le paquet d entrée est requis pour plusieurs opérations. Un paquet de réponses peut contenir plus d une section d opérateur si le paquet d entrée est requis pour les opérations sur plusieurs objets du Panel.

62 62 Configurer via l API à distance Traiter les erreurs La partie du serveur fait un rapport sur deux types d erreurs au logiciel client. Il s agit des erreurs suivantes : erreurs de vérification et erreurs d exécution (s il faut exécuter l opération requise). Si une erreur de tout type se produit, sa description que renvoie le serveur géré par le Panel contient toujours les paramètres suivants : status avec la valeur error errcode code d erreur, un nombre unique identifiant l erreur errtext message d erreur, une description de l erreur lisible par l Homme Une description de l erreur est définie par le type resulttype dans le schéma common.xsd (dans la plupart des cas) ou par les types sur lesquels ils sont basés (en fonction de l opérateur). Erreurs de vérification Le paquet HTTP entrant passe par un certain nombre de vérifications côté serveur avant d être considéré comme étant valide et prêt à être exécuté. Voici certaines de ces vérifications : vérification de l en-tête HTTP-POST vérification de la prise en charge ou non de la version du protocole API RPC indiquée vérification de la méthode d authentification (données d identification ou clé secrète) vérification de l état des droits de l utilisateur remote_access_interface... vérification de la validité du paquet vérification de la disponibilité des agents requis dans la version actuelle du Panel L une de ces vérifications peut échouer, rendant les exécutions des autres commandes et vérifications impossible. Comme le côté serveur est resté bloqué lors des premières étapes de vérification (par ex., il n a pas encore exécuté l opération requise), le paquet de réponses est formé avec les éléments suivants : system contenant la description d une erreur; définie par le type resulttype dans le schéma common.xsd output, un élément optionnel contenant un message pris depuis stderr (si non vide) du composant échoué; défini par le type garbageoutput dans le schéma plesk_common.xsd Par exemple, la réponse reçue du serveur API RPC du Panel lorsque vous avez tenté d utiliser une version non existante du protocole API RPC ressemble à ceci : <packet version= > <system>

63 Configurer via l API à distance 63 <status>error</status> <errcode>1005</errcode> <errtext>api RPC protocol version not supported.</errtext> </system> <output> </output> Erreurs d exécution Si toutes les vérifications ont été réussies; les agents sélectionnés essayent d exécuter en série les opérations requises. Si l une des opérations échoue, l agent associé signale l erreur d exécution. Tous les rapports sont regroupés par le moteur de l Agent qui forme un paquet de réponses basé sur les schémas XML sortants. Par exemple, si un domaine n a pas été créé, l opérateur domain formera une réponse d erreur à l aide du schéma domain_output.xsd : <packet version= > <domain> <add> <result> <status>error</status> <errcode>2300</errcode> <errtext>failed to add domain.</errtext> </result> </add> </domain> Exemples de codes client Cette section présente des exemples d applications clientes dans PHP, C# et VB.NET qui illustrent comment utiliser le protocole API RPC. Dans cette section : Application cliente PHP Client Application cliente C# Application cliente VB.NET... 78

64 64 Configurer via l API à distance Application cliente PHP Client L exemple de code suivant présente l application cliente prête à l emploi écrite en PHP. Remarque : Si vous voulez utiliser cet exemple, assurez-vous que vous avez PHP ou version ultérieure. Pour en savoir plus, visitez ou (anglais). Commentaires class ApiRequestException function domainsinforequest() function curlinit() Etend la classe Exception standard. Visitez (anglais) pour en savoir plus. Utilise le modèle DOM pour composer un paquet de requêtes XML. Retourne l objet DOM résultant. Initialise la session CURL avec les options nécessaires comme suit : CURLOPT_URL CURLOPT_RETURNTRANS FER CURLOPT_POST CURLOPT_SSL_VERIFYPE ER CURLOPT_SSL_VERIFYHO ST CURLOPT_HTTPHEADER indique l URL de destination définir sur true signifie que la sortie sera renvoyée à partir du serveur sous forme de chaîne. définir sur true signifie que le paquet sera envoyé via HTTP POST. définir sur false empêche CURL de vérifier le certificat du pair. définir sur false empêche CURL de vérifier l hôte. indique une plage de champs d en-têtes HTTP à définir. Retourne le gestionnaire de la session URL.

65 Configurer via l API à distance 65 function sendrequest() function parseresponse() function checkresponse() Envoie le paquet HTTP à l aide de CURL et obtient le paquet de réponses XML (sans l en-tête HTTP). Ferme la session CURL et retourne le paquet résultant (un texte plein avec les balises XML). Pour en savoir plus sur le moteur CURL, visitez (anglais). Obtient le paquet de réponses (texte plein) en tant que paramètre. Analyse le paquet à l aide de SimpleXML et renvoie l objet SimpleXMLElement dans lequel le paquet est structuré sous forme d arborescence. Pour en savoir plus sur l extension SimpleXML de PHP, visitez (anglais). Obtient le paquet de réponses de type SimpleXMLEelement et vérifie le noeud result. Si le noeud détient error, la fonction envoie une exception avec une chaîne passée dans le noeud errtext. La fonction main() invoque ces fonctions dans l ordre où ils sont considérés. Tout d abord, elle appelle domaininforequest() pour former un paquet comme suit : <?xml version= 1.0 encoding= UTF-8?> <packet version= > <domain> <get> <filter/> <dataset> <limits/> <prefs/> <user/> <hosting/> <stat/> <gen_info/> </dataset> </get> </domain> Puis curlinit() est appelée pour initialiser la session CURL avec les options. La fonction sendrequest envoie un paquet avec l en-tête HTTP comme suit :

66 66 Configurer via l API à distance POST /enterprise/control/agent.php HTTP/1.1 Host: :8443 HTTP_AUTH_LOGIN: Login HTTP_AUTH_PASSWD: qwedsa HTTP_PRETTY_PRINT: Vrai Content-Length: 294 Content-Type: text/xml Le paquet de réponses XML reçu du serveur géré par le Panel peut ressembler à ceci : <?xml version= 1.0 encoding= UTF-8?> <packet version= > <domain> <get> <result> <status>ok</status> <id>1234</id> <value> <gen_info> <cr_date> </cr_date> <name>example.com</name> <display_name>example</display_name> <status>64</status> <real_size>0</real_size> <client_id>46</client_id> <dns_ip_address> </dns_ip_address> <htype>none</htype> </gen_info> </value> </result> </get> </domain> Une fois le paquet de réponses reçu et analysé avec la fonction parseresponse(), l itérateur foreach se fait l écho des contenus du noeud result.

67 Configurer via l API à distance 67 Exemple de code <?php /** Reports error during API RPC request */ class ApiRequestException extends Exception {} /** Returns DOM object representing request for information about all available DOMDocument */ function domainsinforequest() { $xmldoc = new DomDocument( 1.0, UTF-8 ); $xmldoc->formatoutput = true; // <packet> $packet = $xmldoc->createelement( packet ); $packet->setattribute( version, ); $xmldoc->appendchild($packet); // <packet/domain> $domain = $xmldoc->createelement( domain ); $packet->appendchild($domain); // <packet/domain/get> $get = $xmldoc->createelement( get ); $domain->appendchild($get); // <packet/domain/get/filter> $filter = $xmldoc->createelement( filter ); $get->appendchild($filter); // <packet/domain/get/dataset> $dataset = $xmldoc->createelement( dataset ); $get->appendchild($dataset); // dataset elements $dataset->appendchild($xmldoc->createelement( hosting )); $dataset->appendchild($xmldoc->createelement( gen_info )); return $xmldoc; }

68 68 Configurer via l API à distance /** Prepares CURL to perform the Panel API resource */ function curlinit($host, $login, $password) { $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, ); } curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($curl, CURLOPT_HTTPHEADER, array( HTTP_AUTH_LOGIN: {$login}, HTTP_AUTH_PASSWD: {$password}, HTTP_PRETTY_PRINT: TRUE, Content-Type: text/xml ) ); return $curl; /** Performs a Panel API request, returns raw API response text ApiRequestException */ function sendrequest($curl, $packet) { curl_setopt($curl, CURLOPT_POSTFIELDS, $packet); $result = curl_exec($curl); if (curl_errno($curl)) { $errmsg = curl_error($curl); $errcode = curl_errno($curl); curl_close($curl); throw new ApiRequestException($errmsg, $errcode); } curl_close($curl); return $result;

69 Configurer via l API à distance 69 } /** Looks if API responded with correct data ApiRequestException */ function parseresponse($response_string) { $xml = new SimpleXMLElement($response_string); if (!is_a($xml, SimpleXMLElement )) throw new ApiRequestException( Cannot parse server response: {$response_string} ); } return $xml; /** Check data in API ApiRequestException */ function checkresponse(simplexmlelement $response) { $resultnode = $response->domain->get->result; // check if request was successful if ( error == (string)$resultnode->status) throw new ApiRequestException( The Panel API returned an error:. (string)$resultnode->result->errtext); } // // int main() // $host = ; $login = admin ; $password = qwedsa ; $curl = curlinit($host, $login, $password); try { $response = sendrequest($curl, domainsinforequest()->savexml()); $responsexml = parseresponse($response);

70 70 Configurer via l API à distance checkresponse($responsexml); } catch (ApiRequestException $e) { } echo $e; die(); // Explore the result foreach ($responsexml->xpath( /packet/domain/get/result ) as $resultnode) { echo Domain id:. (string)$resultnode->id. ; echo (string)$resultnode->data->gen_info->name. (. (string)$resultnode->data->gen_info->dns_ip_address. )\n ; }?> Application cliente C# L exemple de code suivant présente l application cliente prête à l emploi écrite en C#. Commentaires La classe Requête met en place l envoi d un paquet de requêtes au serveur géré par le Panel via HTTP et la réception d un paquet de réponses. Il comprend les membres suivants : public string Hostname public string Login public string Password public string Protocol public ValidationEventHandler XmlSchemaValidation public string AgentEntryPoint public string InputValidationSchema public string OutputValidationSchema Détient le nom de l hôte (adresse IP) du serveur géré par le Panel vers lequel le paquet de requêtes est envoyé. Par défaut, c est localhost. Détient le login de l administrateur du Panel. Par défaut, c est admin. Détient le mot de passe de l administrateur du Panel. Par défaut, c est setup. Détient la version du protocle API RPC utilisé pour interagir avec le Panel. Un gestionnaire est utilisé pour recevoir les erreurs de validation du schéma. Détient l URL de l Agent du Panel qui traitera le paquet de requêtes du côté serveur. Détient l URL du schéma de validation qui sera appliquée au paquet de requêtes avant de l envoyer côté serveur. Détient l URL du schéma de validation qui sera appliquée au paquet de réponses après avoir été reçu côté client.

71 Configurer via l API à distance 71 public XmlDocument Send (XmlDocument) public XmlDocument Send (Stream) public XmlDocument Send (string) private HttpWebRequest SendRequest (string) private XmlDocument ParseAndValidate (TextReader, string) private XmlDocument GetResponse (HttpWebRequest) Obtient le paquet de requêtes (sous la forme de l objet XmlDocument) dans son paramètre d entrée. Envoie une demande et obtient la réponse sous la forme de l objet XmlDocument. Obtient le paquet de requêtes (un flux) dans son paramètre d entrée. Valide le paquet de requêtes à l aide du schéma de validation agent_input.xsd. Invoque la fonction du membre Send(XmlDocument). Obtient l URL du paquet de requêtes (fichier XML) dans son paramètre d entrée. Valide le paquet de requêtes à l aide du schéma de validation agent_input.xsd. Invoque la fonction du membre Send(XmlDocument). Forme une requête HTTP : place l en-tête HTTP et le paquet XML de série dans l objet de type HttpWebRequest. Renvoie cet objet. Obtient l URI du schéma agent_input.xsd et un lecteur des caractères d une chaîne ou String Reader (avec l URI du paquet XML à valider) dans ses paramètres d entrée. Valide le paquet et le renvoie de manière structurée sous la forme d une arborescence (un objet XmlDocument). Obtient le paquet de requêtes HTTP (HttpWebRequest object) dans son paramètre d entrée. Envoie le paquet via HTTP, reçoit le paquet de réponses de la part du serveur, le valide à l aide du schéma agent_output.xsd et renvoie le paquet XML de réponses de manière structurée sous la forme d une arborescence (un objet XmlDocument). La classe Programme intègre l application de la console client. static void Main (string[]) Un point d entrée vers l application PanelApiRpcClient. Obtient une gamme d arguments (chaînes de caractère) dans son paramètre d entrée. Les arguments sont : [0] - le nom d hôte (adresse IP) du serveur géré par le Panel, [1] - le login de l administrateur du Panel, [2] - le mot de passe de l administrateur du Panel, [3] - le protocole API RPC utilisé, [4] - un chemin d accès du fichier XML avec un paquet de requêtes XML. La fonction forme un paquet de requêtes de type Requête (voir ci-dessus), le valide, envoie une demande au Panel et le paquet XML résultant.

72 72 Configurer via l API à distance private static bool RemoteCertificateValidation (object, X509Certificate, X509Chain, SslPolicyErrors) private static void XmlSchemaValidation (object, ValidationEventArgs) static void PrintResult(XmlDocument) La fonction vérifie le certificat SSL distant pour authentifier le serveur. Si le serveur n est pas authentifié, il renvoie false. Gestionnaire d évenements d erreurs de validation. La fonction sort le paquet de réponses (un objet XmlDocument) dans la console.

73 Configurer via l API à distance 73 L application cliente peut être lancée à partir de la ligne de commande comme suit : PanelApiRpcClient admin_login admin_passwd c:\requests\addnewdomain.xml Le paquet de requêtes est passé dans le fichier AddNewDomain.xml : <?xml version= 1.0 encoding= UTF-8?> <packet version= > <domain> <add> <gen_setup> <name>example.com</name> <ip_address> </ip_address> </gen_setup> <hosting> <vrt_hst> <property> <name>ftp_login</name> <value>fpt16se4fdf0</value> </property> <property> <name>ftp_password</name> <value>qweqwe</value> </property> <ip_address> </ip_address> </vrt_hst> </hosting> </add> </domain> Le paquet de réponses reçu du serveur peut ressembler à ceci : <?xml version= 1.0?> <packet version= > <domain> <add> <result> <status>ok</status>

74 74 Configurer via l API à distance <id>6</id> <guid>5c0e a bcc0-881d691bfdef</guid> </result> </add> </domain> Ce paquet renvoie le résultat de l opération add et l ID et le GUID du domaine qui vient d être créé. Exemple de code using System; using System.Net; using System.Text; using System.IO; using System.Xml; using System.Xml.Schema; using System.Security.Cryptography.X509Certificates; using System.Net.Security; namespace PanelApiRpcClient { public class Request { // Public interface // public string Hostname = localhost ; // Panel Hostname public string Login = admin_login ; // Administrator s Login public string Password = admin_passwd ; // Administrator s Password public string Protocol = ; // API RPC Version Protocol. // Handler for receiving information about document type definition (DTD), // XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) // schema validation errors. public ValidationEventHandler XmlSchemaValidation = null; public Request() {

75 Configurer via l API à distance 75 } public string AgentEntryPoint { get { return + Hostname + :8443/enterprise/control/agent.php ; } } public string InputValidationSchema { get { return + Hostname + :8443/schemas/rpc/ + Protocol + /agent_input.xsd ; } } public string OutputValidationSchema { get { return + Hostname + :8443/schemas/rpc/ + Protocol + /agent_output.xsd ; } } public XmlDocument Send(XmlDocument packet) { HttpWebRequest request = SendRequest(packet.OuterXml); XmlDocument result = GetResponse(request); return result; } public XmlDocument Send(Stream packet) { using (TextReader reader = new StreamReader(packet)) { return Send(ParseAndValidate(reader, InputValidationSchema)); } } public XmlDocument Send(string packeturi) { using (TextReader reader = new StreamReader(packetUri)) { return Send(ParseAndValidate(reader, InputValidationSchema)); } // Private interface // } // Sending a request message // private HttpWebRequest SendRequest(string message) { HttpWebRequest request = (HttpWebRequest)WebRequest.Create(AgentEntryPoint); request.method = POST ; request.headers.add( HTTP_AUTH_LOGIN, Login); request.headers.add( HTTP_AUTH_PASSWD, Password); request.contenttype = text/xml ; request.contentlength = message.length; ASCIIEncoding encoding = new ASCIIEncoding(); byte[] buffer = encoding.getbytes(message); using (Stream stream = request.getrequeststream()) {

76 76 Configurer via l API à distance stream.write(buffer, 0, message.length); } return request; } // Parsing and validating packet // private XmlDocument ParseAndValidate(TextReader xml, string schemauri) { XmlSchemaSet schemas = new XmlSchemaSet(); schemas.add(null, schemauri); XmlReaderSettings settings = new XmlReaderSettings(); if (XmlSchemaValidation!= null) settings.validationeventhandler += new ValidationEventHandler(XmlSchemaValidation); settings.validationtype = ValidationType.Schema; settings.validationflags = XmlSchemaValidationFlags.ProcessSchemaLocation; settings.schemas = schemas; XmlDocument document = new XmlDocument(); using (XmlReader reader = XmlTextReader.Create(xml, settings)) { document.load(reader); } return document; } private XmlDocument GetResponse(HttpWebRequest request) { using (HttpWebResponse response = (HttpWebResponse)request.GetResponse()) using (Stream stream = response.getresponsestream()) using (TextReader reader = new StreamReader(stream)) { return ParseAndValidate(reader, OutputValidationSchema); } } class Program } { static void Main(string[] args) {

77 Configurer via l API à distance 77 if (args.length < 5) { Console.WriteLine( Usage: PanelApiRpcClient <Hostname> <Login> <Password> <Protocol> <Request> ); Console.WriteLine( ); Console.WriteLine( Hostname - Panel host name ); Console.WriteLine( Login - Administrator s login ); Console.WriteLine( Password - Administrator s password ); Console.WriteLine( Protocol - API RPC protocol version ); Console.WriteLine( Request - Request file path (*.xml) ); return; } // Verifies the remote Secure Sockets Layer (SSL) certificate // used for authentication. ServicePointManager.ServerCertificateValidationCallback = new RemoteCertificateValidationCallback(RemoteCertificateValidation); Request request = new Request(); request.xmlschemavalidation = XmlSchemaValidation; request.hostname = args[0]; // ; request.login = args[1]; // admin ; request.password = args[2]; // setup ; request.protocol = args[3]; // ; string packet = args[4]; // request.xml ; try { XmlDocument result = request.send(packet); PrintResult(result); } catch (Exception e) { Console.WriteLine( Request error: {0}, e.message); } } // The following method is invoked by the RemoteCertificateValidationDelegate. private static bool RemoteCertificateValidation(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslpolicyerrors) { if (sslpolicyerrors!= SslPolicyErrors.RemoteCertificateNotAvailable)

78 78 Configurer via l API à distance return true; Console.WriteLine( Certificate error: {0}, sslpolicyerrors); // Do not allow this client to communicate with unauthenticated servers. return false; } // private static void XmlSchemaValidation(object sender, ValidationEventArgs e) { Console.WriteLine( Validation error: {0}, e.message); } static void PrintResult(XmlDocument document) { XmlTextWriter writer = new XmlTextWriter(Console.Out); writer.formatting = Formatting.Indented; document.writeto(writer); } writer.flush(); Console.WriteLine(); } } Application cliente VB.NET L exemple de code suivant présente l application cliente prête à l emploi écrite en VB.NET. Commentaires La classe Requête intègre l envoi d un paquet de requêtes au serveur géré par le Panel via HTTP et la réception d un paquet de réponses. Il comprend les membres suivants : public string Hostname public string Login public string Password public string Protocol public XmlSchemaValidation Détient le nom de l hôte (adresse IP) du serveur géré par le Panel vers lequel le paquet de requêtes est envoyé. Par défaut, c est localhost. Détient le login de l administrateur du Panel. Par défaut, c est admin. Détient le mot de passe de l administrateur du Panel. Par défaut, c est setup. Détient la version du protocole API RPC utilisé pour interagir avec le Panel. Un gestionnaire est utilisé pour recevoir les erreurs de validation du schéma.

79 Configurer via l API à distance 79 Public ReadOnly Property AgentEntryPoint Public ReadOnly Property InputValidationSchema Public ReadOnly Property OutputValidationSchema Public Function Send(ByVal packet As XmlDocument) Public Function Send(ByVal packet As Stream) Public Function Send(ByVal packeturi As String) Private Function SendRequest(ByVal message As String) Private Function ParseAndValidate(ByVal xml As TextReader, ByVal schemauri As String) Private Function GetResponse(ByVal request As HttpWebRequest) Détient l URL de l Agent du Panel qui traitera le paquet de requêtes côté serveur. Détient l URL du schéma de validation qui sera appliqué au paquet de requêtes avant de l envoyer côté serveur. Détient l URL du schéma de validation qui sera appliquée au paquet de réponses après avoir été reçu côté client. Obtient le paquet de requêtes (sous la forme de l objet XmlDocument) dans son paramètre d entrée. Envoie une demande et obtient la réponse sous la forme de l objet XmlDocument. Obtient le paquet de requêtes (un flux) dans son paramètre d entrée. Valide le paquet de requêtes à l aide du schéma de validation. Invoque la fonction du membre Send(XmlDocument). Obtient l URL du paquet de requêtes (fichier XML) dans son paramètre d entrée. Valide le paquet de requêtes à l aide du schéma de validation. Invoque la fonction du membre Send(XmlDocument). Forme une requête HTTP : place l en-tête HTTP et le paquet XML de série dans l objet de type HttpWebRequest. Renvoie cet objet. Obtient l URI du schéma de validation et un lecteur des caractères d une chaîne ou String Reader (avec l URI du paquet XML à valider) dans ses paramètres d entrée. Valide le paquet et le renvoie de manière structurée sous la forme d une arborescence (un objet XmlDocument). Obtient le paquet de requêtes HTTP (objet HttpWebRequest) dans son paramètre d entrée. Envoie le paquet via HTTP, reçoit le paquet de réponses du serveur, le valide à l aide du schéma de validation et renvoie le paquet de réponses XML de manière structurée sous la forme d une arborescence (objet XmlDocument).

80 80 Configurer via l API à distance La classe Programme intègre l application de la console client. Shared Sub Main(ByVal args As String()) Private Shared Function RemoteCertificateValidation( ByVal sender As Object, ByVal certificate As X509Certificate, ByVal chain As X509Chain, ByVal sslpolicyerrors As SslPolicyErrors) Un point d entrée vers l application PanelApiRpcClient. Obtient une gamme d arguments (chaînes de caractère) dans son paramètre d entrée. Les arguments sont : [0] - le nom d hôte (adresse IP) du serveur géré par le Panel, [1] - le mot de passe de l administrateur du Panel, [2] - le mot de passe de l administrateur du Panel, [3] - le protocole API RPC utilisé, [4] - un chemin d accès du fichier XML avec un paquet de requêtes XML. La fonction forme un paquet de requêtes de type Requête (voir ci-dessus), le valide, envoie une demande au Panel et le paquet XML résultant. La fonction vérifie le certificat SSL distant pour authentifier le serveur. Si le serveur n est pas authentifié, il renvoie false. Private Shared Sub XmlSchemaValidation(ByVal sender As Object, ByVal e As ValidationEventArgs) Gestionnaire d évenéments d erreurs de validation. Private Shared Sub PrintResult(ByVal document As XmlDocument) La fonction produit le paquet de réponses (un objet XmlDocument) dans la console. L application cliente peut être lancée à partir de la ligne de commande comme suit : PanelApiRpcClient admin_login admin_passwd c:\requests\request.xml Le paquet de requêtes est passé dans le fichier request.xml :

81 Configurer via l API à distance 81 <?xml version= 1.0 encoding= UTF-8?> <packet version= > <domain> <add> <gen_setup> <name>example.com</name> <ip_address> </ip_address> </gen_setup> <hosting> <vrt_hst> <property> <name>ftp_login</name> <value>fp16se4fdf0</value> </property> <property> <name>ftp_password</name> <value>qweqwe</value> </property> <ip_address> </ip_address> </vrt_hst> </hosting> </add> </domain> Le paquet de réponses reçu à partir du serveur peut ressembler à ceci : <?xml version= 1.0?> <packet version= > <domain> <add> <result> <status>ok</status> <id>6</id> <guid>5c0e a bcc0-881d691bfdef</guid> </result> </add>

82 82 Configurer via l API à distance </domain> Ce paquet renvoie le résultat de l opération add et l ID et le GUID du domaine qui vient d être créé. Exemple de code Imports System Imports System.Net Imports System.Text Imports System.IO Imports System.Xml Imports System.Xml.Schema Imports System.Security.Cryptography.X509Certificates Imports System.Net.Security Namespace ParallelsPanelApiRpcClient Public Class Request Public interface Public Hostname As String = localhost The Panel Host name Public Login As String = admin_login Administrator s Login Public Password As String = admin_setup Administrator s Password Public Protocol As String = API RPC Version Protocol Handler for receiving information about document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) schema validation errors. Public XmlSchemaValidation As ValidationEventHandler Public ReadOnly Property AgentEntryPoint As String Get Return ( & Me.Hostname & :8443/enterprise/control/agent.php ) End Get End Property Public ReadOnly Property InputValidationSchema As String Get

83 Configurer via l API à distance 83 Return String.Concat(New String() { Me.Hostname, :8443/schemas/rpc/, Me.Protocol, /agent_input.xsd }) End Get End Property Public ReadOnly Property OutputValidationSchema As String Get Return String.Concat(New String() { Me.Hostname, :8443/schemas/rpc/, Me.Protocol, /agent_output.xsd }) End Get End Property Public Function Send(ByVal packet As XmlDocument) As XmlDocument Dim request As HttpWebRequest = Me.SendRequest(packet.OuterXml) Return Me.GetResponse(request) End Function Public Function Send(ByVal packet As Stream) As XmlDocument Using reader As TextReader = New StreamReader(packet) Return Me.Send(Me.ParseAndValidate(reader, Me.InputValidationSchema)) End Using End Function Public Function Send(ByVal packeturi As String) As XmlDocument Using reader As TextReader = New StreamReader(packetUri) Return Me.Send(Me.ParseAndValidate(reader, Me.InputValidationSchema)) End Using End Function Private interface Sending a request message Private Function SendRequest(ByVal message As String) As HttpWebRequest

84 84 Configurer via l API à distance Dim request As HttpWebRequest = DirectCast(WebRequest.Create(Me.AgentEntryPoint), HttpWebRequest) request.method = POST request.headers.add( HTTP_AUTH_LOGIN, Me.Login) request.headers.add( HTTP_AUTH_PASSWD, Me.Password) request.contenttype = text/xml request.contentlength = message.length Dim bytes As Byte() = New ASCIIEncoding().GetBytes(message) Using stream As Stream = request.getrequeststream stream.write(bytes, 0, message.length) End Using Return request End Function Parsing and validating packet Private Function ParseAndValidate(ByVal xml As TextReader, ByVal schemauri As String) As XmlDocument Dim schemas As New XmlSchemaSet schemas.add(nothing, schemauri) Dim settings As New XmlReaderSettings If (Not Me.XmlSchemaValidation Is Nothing) Then AddHandler settings.validationeventhandler, New ValidationEventHandler(AddressOf Me.XmlSchemaValidation.Invoke) End If settings.validationtype = ValidationType.Schema settings.validationflags = (settings.validationflags Or XmlSchemaValidationFlags.ProcessSchemaLocation) settings.schemas = schemas Dim document As New XmlDocument Using reader As XmlReader = XmlReader.Create(xml, settings) document.load(reader) End Using Return document End Function

85 Configurer via l API à distance 85 Private Function GetResponse(ByVal request As HttpWebRequest) As XmlDocument Using response As HttpWebResponse = DirectCast(request.GetResponse, HttpWebResponse) Using stream As Stream = response.getresponsestream Using reader As TextReader = New StreamReader(stream) return Me.ParseAndValidate(reader, Me.OutputValidationSchema) End Using End Using End Using End Function End Class Friend Class Program Else Shared Sub Main(ByVal args As String()) If (args.length < 5) Then Console.WriteLine( Usage: PanelApiRpcClient <Hostname> <Login> <Password> <Protocol> <Request> ) Console.WriteLine( ) Console.WriteLine( Host name - The Panel s host name ) Console.WriteLine( Login - Administrator s login ) Console.WriteLine( Password - Administrator s password ) Console.WriteLine( Protocol - API RPC protocol version ) Console.WriteLine( Request - Request file path (*.xml) ) Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication. ServicePointManager.ServerCertificateValidationCallback = New RemoteCertificateValidationCallback(AddressOf Program.RemoteCertificateValidation) Dim request As New Request request.xmlschemavalidation = New ValidationEventHandler(AddressOf Program.XmlSchemaValidation) request.hostname = args(0) ;

86 86 Configurer via l API à distance request.login = args(1) admin ; request.password = args(2) setup ; request.protocol = args(3) ; Dim packeturi As String = args(4) request.xml ; Try Program.PrintResult(request.Send(packetUri)) Catch exception As Exception Console.WriteLine( Request error: {0}, exception.message) End Try End If End Sub The following method is invoked by the RemoteCertificateValidationDelegate. Private Shared Function RemoteCertificateValidation(ByVal sender As Object, ByVal certificate As X509Certificate, ByVal chain As X509Chain, ByVal sslpolicyerrors As SslPolicyErrors) As Boolean If (sslpolicyerrors <> SslPolicyErrors.RemoteCertificateNotAvailable) Then Return True End If Console.WriteLine( Certificate error: {0}, sslpolicyerrors) Do not allow this client to communicate with unauthenticated servers. Return False End Function Private Shared Sub XmlSchemaValidation(ByVal sender As Object, ByVal e As ValidationEventArgs) Console.WriteLine( Validation error: {0}, e.message) End Sub Private Shared Sub PrintResult(ByVal document As XmlDocument) Dim w As New XmlTextWriter(Console.Out) w.formatting = Formatting.Indented document.writeto(w) w.flush Console.WriteLine End Sub

87 Configurer via l API à distance 87 End Class End Namespace

88 88 Configurer via l API à distance Configurer le Panel Cette section explique dans le détail comment chaque opération de configuration du Panel est exécutée à l aide de l API distante. Dans cette section : Initialiser le Panel Installer la clé de licence Configurer le DNS Installer les certificats SSL Créer des domaines Créer des sous-domaines Définir les catalogues d APS disponibles Installer des applications Initialiser le Panel Pour initialiser le Panel via API RPC, émettez un paquet de requêtes XML avec le noeud d opération smb/initial_setup: <packet version= > <smb> <initial_setup>... </initial_setup> </smb> Dans cette section : Structure d un paquet de requêtes Exemples de requête Structure du paquet de réponses Exemples de réponse... 92

89 Configurer via l API à distance 89 Structure d un paquet de requêtes Le noeud initial_setup est structuré comme suit : password, requis Indique un nouveau mot de passe de l administrateur du Panel. Type de données : serverpassword (plesk_server.xsd). Chaîne de 5 à 14 caractères. admin_ , requis Indique une adresse mail de l administrateur du Panel. Type de données : type (common.xsd). Chaîne de 3 à 255 caractères. locale, facultatif Indique le fichier de traduction du Panel - code de langue et culture qui sera utilisé dans l interface du Panel. Type de données : chaîne.

90 90 Configurer via l API à distance Exemples de requête Un paquet de requêtes initialisant le Panel ressemble à ceci : <packet version= > <smb> <initial_setup> <password>p4$$w0rd</password> <admin_ >johndoe@example.com</admin_ > </initial_setup> </smb> Un paquet de requêtes qui initialise le Panel et configure l Allemand (Allemagne) comme langue par défaut ressemble à ceci : <packet version= > <smb> <initial_setup> <password>p4$$w0rd</password> <admin_ >johndoe@example.com</admin_ > <locale>de-de</locale> </initial_setup> </smb>

91 Configurer via l API à distance 91 Structure du paquet de réponses Le noeud initial_setup du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. Erreurs spécifiques de l opération 1003, Erreur d initialisation du moteur de l agent. Le Panel est déjà initialisé. 1019, Valeur incorrecte. Le fichier de traduction indiqué n est pas disponible.

92 92 Configurer via l API à distance Exemples de réponse Une réponse positive reçue du serveur ressemble à ceci : <packet version= > <smb> <initial_setup> <result> <status>ok</status> </result> </initial_setup> </smb> La réponse négative suivante est reçue si le Panel est déjà initialisé. <packet version= > <smb> <initial_setup> <result> <status>error</status> <errcode>1003</errcode> <errtext>initial setup already completed</errtext> </result> </initial_setup> </smb> La réponse négative suivante est reçue si le fichier de traduction indiqué n est pas disponible. <packet version= > <smb> <initial_setup> <result> <status>error</status> <errcode>1019</errcode> <errtext>locale en-us2 is not installed on server</errtext> </result>

93 Configurer via l API à distance 93 </initial_setup> </smb> Installer la clé de licence Pour installer une clé de licence à l aide de API RPC, émettez un paquet de requêtes XML avec le noeud d opération server/lic_install: <packet version= > <server> <lic_install>... </lic_install> </server> Dans cette section : Structure d un paquet de requêtes Exemples de requete Structure du paquet de réponses Exemples de réponse Structure d un paquet de requêtes Un paquet de requêtes XML installant une clé de licence inclut le noeud d opération server/lic_install et est structuré comme suit license, requis Contient les données clés de licence. Type de données : base64. additional_key, facultatif Indique si la clé qui sera installée est une clé supplémentaire. Type de données : aucun.

94 94 Configurer via l API à distance Exemples de requete Ce paquet installe une clé de licence (principale) par défaut pour Parallels Small Business Panel pour Linux/Unix, avec lequel le produit est distribué. <packet version= > <server>

95 Configurer via l API à distance 95 <lic_install> <license>pd94bwwgdmvyc2lvbj0ims4wiiblbmnvzgluzz0ivvrgltgiid8+ia0klsa8chatc2 1iLXVuaXgtMTA6a2V5IGNvcmU6Zm9ybWF0PSJvcGVuZnVzaW9uLTMiIHhtbG5zOmNvcm U9Imh0dHA6Ly9wYXJhbGxlbHMuY29tL3NjaGVtYXMva2V5cy9jb3JlLzMiIHhtbG5zOnBwLX NtYi11bml4LTEwPSJodHRwOi8vcGFyYWxsZWxzLmNvbS9zY2hlbWFzL2tleXMvcHJvZHVjd HMvcHAtc21iL3VuaXgvMTAuMCI+DQotIDwhLS0gVW5pcXVlIHByb2R1Y3QgS2V5IG51bWJ lcg0kicatlt4gdqogidxjb3jlomtles1udw1izxigy29yztp0exblpsjzdhjpbmciplnnqi4wm DAwMDAwMDwvY29yZTprZXktbnVtYmVyPiANCi0gPCEtLSBLZXkgdmVyc2lvbg0KICAtLT4 gdqogidxjb3jlomtles12zxjzaw9uignvcmu6dhlwzt0ic3ryaw5nij4wmdawpc9jb3jlomtl es12zxjzaw9upianci0gpcetlsblzxkgzgvzy3jpchrpb24nciagls0+ia0klsa8y29yzt pkzxnjcmlwdglvbj4nciagpgnvcmu6a2v5dhlwzt5qyxjhbgxlbhmgugfuzwwgmtagu0 1CIEVkaXRpb24gZm9yIFVuaXgvTGludXg8L2NvcmU6a2V5dHlwZT4gDQogIDwvY29yZTpk ZXNjcmlwdGlvbj4NCi0gPCEtLSBQcm9kdWN0IHdoaWNoIHRoaXMgbGljZW5zZSBpcyBpbn RlbmRlZCB0byB3b3JrIG9uDQogIC0tPiANCiAgPGNvcmU6cHJvZHVjdCBjb3JlOnR5cGU9In N0cmluZyI+cHAtc21iLXVuaXg8L2NvcmU6cHJvZHVjdD4gDQotIDwhLS0gU3VwcG9ydGVkI HByb2R1Y3QgdmVyc2lvbg0KICAtLT4gDQogIDxjb3JlOnZlcnNpb24gY29yZTp0eXBlPSJzdH JpbmciPjEwLjA8L2NvcmU6dmVyc2lvbj4gDQotIDwhLS0gRGF0ZSBhZnRlciB3aGljaCB0aGlz IGxpY2Vuc2UgYmVjb21lcyB1c2FibGUgKGluY2x1c2l2ZSkNCiAgLS0+IA0KICA8Y29yZTpzd GFydC1kYXRlIGNvcmU6dHlwZT0iZGF0ZSI+aW5zdGFudDwvY29yZTpzdGFydC1kYXRlPiA NCi0gPCEtLSBEYXRlIGJlZm9yZSB3aGljaCB0aGlzIGxpY2Vuc2UgaXMgdXNhYmxlIChleGN sdxnpdmupdqogic0tpianciagpgnvcmu6zxhwaxjhdglvbi1kyxrlignvcmu6dhlwzt0iz GF0ZSI+bmV2ZXI8L2NvcmU6ZXhwaXJhdGlvbi1kYXRlPiANCi0gPCEtLSBVUkwgb2YgdGhlI HNlcnZpY2UgZW5kcG9pbnQgdG8gdXNlIHdoZW4gcGVyZm9ybWluZyBhbiBhdXRvdXBkYX RlDQogIC0tPiANCiAgPGNvcmU6bGljZW5zZS1zZXJ2ZXItdXJsIGNvcmU6dHlwZT0ic3RyaW 5nIj5odHRwczovL2thLnBhcmFsbGVscy5jb206NTIyNC94bWxycGM8L2NvcmU6bGljZW5zZS 1zZXJ2ZXItdXJsPiANCi0gPCEtLSBEYXRlIHdoZW4gcHJvZHVjdCB3aWxsIHRyeSB0byBwZ XJmb3JtIGFuIGF1dG91cGRhdGUNCiAgLS0+IA0KICA8Y29yZTp1cGRhdGUtZGF0ZSBjb3Jl OnR5cGU9ImRhdGUiPmluc3RhbnQ8L2NvcmU6dXBkYXRlLWRhdGU+IA0KICA8Y29yZTp1 cgrhdgutdglja2v0ignvcmu6aglkzgvupsj0cnvliibjb3jlonr5cgu9inn0cmluzyi+ls0tls 0tc21iXzEwX3VuaXhfZGVmYXVsdC0tLS0tLS08L2NvcmU6dXBkYXRlLXRpY2tldD4gDQotID whls0gu01cifvzzxjzdqogic0tpianciagphbwlxntyi11bml4ltewonntyi11c2vycybjb3j lonr5cgu9imludgvnzxiipje8l3bwlxntyi11bml4ltewonntyi11c2vycz4gdqotidwhls0g TnVtYmVyIG9mIGRvbWFpbnMNCiAgLS0+IA0KICA8cHAtc21iLXVuaXgtMTA6ZG9tYWlucyB jb3jlonr5cgu9imludgvnzxiipje8l3bwlxntyi11bml4ltewomrvbwfpbnm+ia0klsa8is0 tiefiawxpdhkgdg8gdxnlifnwyw1bc3nhc3npbg0kicatlt4gdqogidxwcc1zbwitdw5pec 0xMDpzcGFtYXNzYXNpbi1zdXBwb3J0IGNvcmU6dHlwZT0iYm9vbGVhbiI+dHJ1ZTwvcHAtc 21iLXVuaXgtMTA6c3BhbWFzc2FzaW4tc3VwcG9ydD4gDQotIDwhLS0gQVBTIEFwcGxpY2F 0aW9uDQogIC0tPiANCiAgPHBwLXNtYi11bml4LTEwOmFwcy1hcHAgY29yZTp0eXBlPSJzd HJpbmciPmh0dHA6Ly93d3cubWFnaWNzcGFtLmNvbS88L3BwLXNtYi11bml4LTEwOmFwcy 1hcHA+IA0KLSA8IS0tIEFQUyBBcHBsaWNhdGlvbg0KICAtLT4gDQogIDxwcC1zbWItdW5pe C0xMDphcHMtYXBwIGNvcmU6dHlwZT0ic3RyaW5nIj5odHRwOi8vd3d3LnBpbm5hY2xlY2Fy dc5jb20vpc9wcc1zbwitdw5pec0xmdphchmtyxbwpianci0gpcetlsbbufmgqxbwbgljy XRpb24NCiAgLS0+IA0KICA8cHAtc21iLXVuaXgtMTA6YXBzLWFwcCBjb3JlOnR5cGU9InN0 cmluzyi+ahr0chm6ly93d3cua2vlcgl0lmnvbs91bmxpbwl0zwq8l3bwlxntyi11bml4lte womfwcy1hcha+ia0klsa8is0tiefquybbchbsawnhdglvbg0kicatlt4gdqogidxwcc1zb WItdW5peC0xMDphcHMtYXBwIGNvcmU6dHlwZT0ic3RyaW5nIj5odHRwOi8vd3d3LnN5bW FudGVjLmNvbS9ub3J0b24vaW50ZXJuZXQtc2VjdXJpdHk8L3BwLXNtYi11bml4LTEwOmFw cy1hcha+ia0klsa8is0tiefquybbchbsawnhdglvbg0kicatlt4gdqogidxwcc1zbwitdw5 pec0xmdphchmtyxbwignvcmu6dhlwzt0ic3ryaw5nij5odhrwoi8vd3d3lmludgvyc3bpc muuy29tl2vtywlsbwfya2v0zxivpc9wcc1zbwitdw5pec0xmdphchmtyxbwpianci0gpc EtLSBBUFMgQXBwbGljYXRpb24NCiAgLS0+IA0KICA8cHAtc21iLXVuaXgtMTA6YXBzLWF wccbjb3jlonr5cgu9inn0cmluzyi+ahr0cdovl3d3dy5pbnrlcnnwaxjllmnvbs9rbm93bgv kz2vtyw5hz2vylzwvchatc21ilxvuaxgtmta6yxbzlwfwcd4gdqotidxkc2lnolnpz25hdh

96 96 Configurer via l API à distance VyZSB4bWxuczpkc2lnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5L3htbGRzaWcjIj4NCi 0gPGRzaWc6U2lnbmVkSW5mbz4NCiAgPGRzaWc6Q2Fub25pY2FsaXphdGlvbk1ldGhvZC BBbGdvcml0aG09Imh0dHA6Ly9wYXJhbGxlbHMuY29tL3NjaGVtYXMva2V5cy9jb3JlLzMjY2 Fub25pY2FsaXplIiAvPiANCiAgPGRzaWc6U2lnbmF0dXJlTWV0aG9kIEFsZ29yaXRobT0iaH R0cDovL3d3dy53My5vcmcvMjAwMS8wNC94bWxkc2lnLW1vcmUjcnNhLXNoYTI1NiIgLz4gD QotIDxkc2lnOlJlZmVyZW5jZSBVUkk9IiI+DQotIDxkc2lnOlRyYW5zZm9ybXM+DQogIDxkc2ln OlRyYW5zZm9ybSBBbGdvcml0aG09Imh0dHA6Ly93d3cudzMub3JnL1RSLzIwMDEvUkVDL XhtbC1jMTRuLTIwMDEwMzE1I1dpdGhDb21tZW50cyIgLz4gDQogIDxkc2lnOlRyYW5zZm9y bsbbbgdvcml0ag09imh0dha6ly9wyxjhbgxlbhmuy29tl3njagvtyxmva2v5cy9jb3jllzmj dhjhbnnmb3jtiiavpianciagpc9kc2lnolryyw5zzm9ybxm+dqogidxkc2lnokrpz2vzde1ld GhvZCBBbGdvcml0aG09Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvMDQveG1sZW5jI3NoYTI 1NiIgLz4gDQogIDxkc2lnOkRpZ2VzdFZhbHVlPlRrUzk2YnlycEpVdTVpUTdIbkhZYUhhMTIra 2lPYmZhRXBYMC9TWU5iV2M9PC9kc2lnOkRpZ2VzdFZhbHVlPiANCiAgPC9kc2lnOlJlZmV yzw5jzt4nciagpc9kc2lnolnpz25lzeluzm8+dqogidxkc2lnolnpz25hdhvyzvzhbhvlpmz vcuxyvfertwhrum44y2nzsmdou1zhnujuvi9kautavgjjdk9qunbxcw5xadlxei9nqmf KY0pDNnFnZUNkMHJ4OFZsWERxcm0yVUYgS1I1d0dWeFM1ZSt6NWNqREFEcVUyRStG OXRaUndubXRuamZ4dHV0THZibjVyS0FYc1VtWTQ2OU1EcjNQeFRYbi9mYjZycmpvbGZO OCBOWVE1WUVtMDkyd3IrWTg2TGNIVkhKM2ZXK01sQWd3WXpua0lzdFVQSE1JMVVkYl gwzwkvwtfmcstsc0dssnnhz2drnw56mzgralv5ifrvudbrk2vrunaxcufva09owuyy M21FT1FuQ2V5eFNqQ3FrejNyZEhkaVFFQTBKcmhYMGowYWZYWDJkL2JRUnZVeU93U FBsVWhzNU4gY3FjcndRRDdMQ0lsOE9Udk5FaFRrNFo0OGdaM1ZIRzJ2bitpVGc9PTwvZH NpZzpTaWduYXR1cmVWYWx1ZT4gDQotIDxkc2lnOktleUluZm8+DQotIDxkc2lnOlg1MDlEY XRhPg0KICA8ZHNpZzpYNTA5Q2VydGlmaWNhdGU+TUlJRW5EQ0NBb1FDQVJFd0RRW UpLb1pJaHZjTkFRRUZCUUF3Z2FZeEN6QUpCZ05WQkFZVEFrSk5NUXN3Q1FZRFZRUUl Fd0pJVFRFUiBNQThHQTFVRUJ4TUlTR0Z0YVd4MGIyNHhIREFhQmdOVkJBb1RFMU5YY zi5bwrdqklimnhryvc1bmn5qk1kr1f4sfrbykjntlzcqxnuiezfbhvkr1z5ym1gc0lfu mxkbvzzyjncdfpxntbnund3r2dzrfzruurfee5muvncewiyotbjr05sy25scfptbgp ZWFJsTVJ3d0dnWUogS29aSWh2Y05BUWtCRmcxcllVQnpkM052Wm5RdVkyOXRNQjRYR FRBNU1EWXdNakEyTURrek0xb1hEVE0yTVRBeE9EQTJNRGt6TTFvdyBnWUF4Q3pBSkJ ntlzcqvluqwtktk1rc3dduvlevlfrsuv3skluvevstue4r0exvuvcee1ju0dgdgfxed BiMjR4SERBYUJnTlZCQW9UIEUxTlhjMjltZENCSWIyeGthVzVuY3lCTWRHUXhIVEFiQmdO VkJBc1RGRWx1ZEdWeWJtRnNJRVJsZG1Wc2IzQnRaVzUwTVJRd0VnWUQgVlFRREV3d HdjQzF6YldJdGRXNXBlRENDQVNJd0RRWUpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0N BUW9DZ2dFQkFNYzR0RWVhRFMzciBDS0sxQ1RaUm9aMTdGVzU5Z0tBbTlOQmt6V3Zw ZW9VM0lnZU5SMTMrdWs0My9lYW1EQkNHZTBtQnNwb05vWjErWDk3RXVGYzB4b2RvIG g0nvgrrunizk5kme1adzvrsfljwwf1m2kxsvbbakzmdm5dce52zxc1whpxqzcwz0xlen ZNaWxRbWxTYWpLSEFEL0EvMGhzYkI0aDkgeVdxNTZPcDRiT1hUTDVKN0NZV1JHeVRS afv1mnfpbjz2y2o3q2rkb05oewhrddjtylarndlvmxfjdjmvofz3ynzrmzzhtvltvlblms BHRk50MlE3RkhKUUxicW1pY1doL0JBWkpjU2FGMWlPSUhuZ2VIbG9uSGptbzdJWUEvSX cytuzmt0dpam82kzg2m0dubdjuoxa0dgxgihzhnwhomwfpnhkybddovzftczhvt1j SclVlMENBd0VBQVRBTkJna3Foa2lHOXcwQkFRVUZBQU9DQWdFQUgrcnFFdkhNdEFRa StWOHEgSDdFM3VSRk8xaVA1QzBVejlDQVdMZ0QyNWthWTlSaUV1K1ZNcGtyZ2RwMkR KZUxIaWd5Q3MyM3dUbkZ6SS9qMUJNRjJ1VGdKS1B6MiBSOTA2YVcyR0tJWWpIencvd3 BmUDUxck9CWTVQNlhpdXNtM2NGdk8zTnJ4Z0hJSy9WV3N5WW1EN25mMksyZUptQmsv ZU85TklaalBoIGRkS2NrYmNZRVhRN3dzd2l0dDlYcTFuckg2eFNXT1lIVUUwcHI0QW1jVXc3 TDdRQVUzdDBVM0lIQzNHYmVyVE1RNERSL2xDTFV5a24gUkl3aDNKQXZkYVFJZnA2TW 9yNkY0VWtrMWh2bzkwVTR1VHFEbXc4RFJHcVRoOCtPUEY1V1dTL0MyK0o0bThOWTND WjZpa3FIc0FpcCB5Si9uR1pqU3cvdHc4N0xMWHBMMzJhRkFLcGpjOGc1MkZuc3YzVDlwdj RHd0Q2V0hHYU1DNUVsL21XSWplSE5pLytPTk5hbkdHbHJxIHVLQ1p2UktHenJRNjV4bHIy eeovtxftwdv3cwdtk3r5se1xy3bwvfpzdmf6cxztzfrubllnwlhwd1m1ywxqqlawb3f Wd09wVDFLUksgY0o3bXVaYzNUWlJ1OHY0b2pWa1dWTlF2QVNUUFNsdXFkcW42RFdw V2V3UEQ0ZXg3c2ZJam52N1phWmtZV2tPL3VDam9SeE4wbmFtVSBlVk5QemZSNXJ5em Vjalozb0g0L1NXTGFYeHFiQ2k0QzBjMFlVeTZBMkZkejVKK3RwWUdFbkVFMENpcDFyRjVn MFJhMURBZXV4ZFFaIEMwang3NlNsQ1VjSWhGQ0p4RmRxMk5JMHZJVnlVNTl6R2NrY3E

97 Configurer via l API à distance 97 3WVZZVlJ2czNVc2crb1pNRTBKbTFjPTwvZHNpZzpYNTA5Q2VydGlmaWNhdGU+IA0KICA 8L2RzaWc6WDUwOURhdGE+DQogIDwvZHNpZzpLZXlJbmZvPg0KICA8L2RzaWc6U2lnbm F0dXJlPg0KICA8L3BwLXNtYi11bml4LTEwOmtleT4=</license> </lic_install> </server> Ce paquet de requêtes installe la clé de licence supplémentaire. Veuillez noter que le contenu du noeud licence est un code base64 valide et non une clé de licence. Donc, si vous émettez ce paquet de requêtes, vous recevrez l erreur <packet version= > <server> <lic_install> <license>tgv0ihvzigp1c3qgchjldgvuzcb0agf0ihroaxmgaxmgysbqyxjhbgxlbhmg UGFuZWwgbGljZW5zZSBrZXkuCk9mIGNvdXJzZSwgd2UgY291bGQgbm90IGluY2x1ZGUg YSByZWFsIGxpY2Vuc2Uga2V5IGluIHRoZSBkb2N1bWVudGF0aW9uLgpUaGFuayB5b3Ug Zm9yIHVuZGVyc3RhbmRpbmcu</license> <additional_key/> </lic_install> </server> Structure du paquet de réponses Le noeud lic_install du paquet de réponses est structuré comme suit :

98 98 Configurer via l API à distance result, requis Contient la réponse récupérée du serveur. status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : unsignedint. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. Exemples de réponse Une réponse positive reçue du serveur ressemble à ceci : <packet version= > <server> <lic_install> <result> <status>ok</status> </result> </lic_install> </server> Une telle erreur est reçue si le paquet de requêtes essaie d installer une clé de licence incorrecte. <packet version= > <server> <lic_install> <result> <status>error</status> <errcode>1020</errcode> <errtext>the uploaded key file is not valid or does not contain a license key.</errtext> </result> </lic_install> </server>

99 Configurer via l API à distance 99 Configurer le DNS Pour configurer le service DNS du Panel via le protocole API RPC, utilisez l opérateur dns comme décrit plus loin. Dans cette section : Désactiver le service DNS Changer le template d enregistrement SOA Configurer les templates d enregistrements de ressources Désactiver le service DNS Pour désactiver le service DNS du Panel à l aide d API RPC, émettez le paquet de requêtes XML contenant le noeud d opération dns/disable: <packet version= > <dns> <disable/> </dns> Dans cette section : Paquet de requêtes Paquet de réponses Paquet de requêtes Le paquet de requêtes suivant désactive le service DNS : <packet version= > <dns> <disable/> </dns>

100 100 Configurer via l API à distance Paquet de réponses Le noeud disable du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. Exemple La réponse positive ressemble à ceci : <packet version= > <dns> <disable> <result> <status>ok</status> </result> </disable> </dns>

101 Configurer via l API à distance 101 Changer le template d enregistrement SOA Pour configurer un nouveau template SOA, émettez le paquet de requêtes XML contenant le noeud d opération dns/set : <packet version= > <dns> <set>... </set> </dns> Dans cette section : Structure d un paquet de requêtes Exemples de requête Structure du paquet de réponses Exemples de réponse Structure d un paquet de requêtes Pour configurer un nouveau template SOA, émettez le paquet de requêtes XML contenant le noeud d opération dns/set et structuré comme suit :

102 102 Configurer via l API à distance soa, requis Indique les paramètres SOA. Type de données : SOAType (plesk_dns.xsd). ttl, facultatif Indique la valeur du paramètre ttl. Le Panel fixe la valeur par défaut à un jour. Type de données : unsignedint. refresh, facultatif Indique la valeur du paramètre d actualisation : refresh. Le Panel fixe la valeur par défaut à trois heures. Type de données : unsignedint. retry, facultatif Indique la valeur du paramètre de retentative : retry. Le Panel fixe la valeur par défaut à une heure. Type de données : unsignedint. expire, facultatif Indique la valeur du paramètre d expiration : expire. (valeur 32 bits signée en secondes.) Le Panel fixe la valeur par défaut à une semaine. Type de données : unsignedint. minimum, facultatif Indique la valeur du paramètre minimum : minimum. Le Panel fixe la valeur par défaut à trois heures. Type de données : unsignedint. Exemples de requête Ce paquet actualise un template d enregistrement SOA afin qu il définisse l intervalle TTL sur 32 heures, l intervalle d actualisation sur 6 heures et l intervalle de retentative sur 15 minutes. Laissez les valeurs par défaut du Panel pour les intervalles d expiration et minimum. <packet version= > <dns> <set> </set> <soa> </dns> <ttl>115200</ttl> <refresh>21600</refresh> <retry>900</retry> </soa>

103 Configurer via l API à distance 103 Structure du paquet de réponses Le noeud set du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne.

104 104 Configurer via l API à distance Exemples de réponse La réponse positive du serveur ressemble à ceci : <packet version= > <dns> <set> <result> <status>ok</status> </result> </set> </dns> La réponse négative suivante est reçue si une valeur indiquée est quelque peu trop grande : PAQUET DE REQUETES <packet version= > <dns> <set> <soa> <refresh> </refresh> </soa> </set> </dns> PAQUET DE REPONSES <packet version= > <system> <status>error</status> <errcode>1014</errcode> <errtext>parser error: Request is invalid</errtext> </system>

105 Configurer via l API à distance 105 Configurer les templates d enregistrements de ressources A l aide d API RPC, vous pouvez modifier les enregistrements de ressources dans le template de la zone DNS de la manière suivante : ajouter de nouveaux enregistrements de ressources supprimer des enregistrements de ressources existants (vous pouvez récupérer la liste des enregistrements de ressources déjà dans le template) Dans cette section : Ajouter un template d enregistrement de ressources Récupérer les informations à propos du template de la zone DNS Supprimer un template d enregistrement de ressources Ajouter un template d enregistrement de ressources Pour ajouter un template pour l enregistrement de ressources de la zone DNS, émettez un paquet de requêtes XML avec le noeud d opération dns/add-rec: <packet version= > <dns> <add_rec>... </add_rec> </dns> Dans cette section : Structure d un paquet de requêtes Exemples de requête Structure du paquet de réponses Exemples de réponse

106 106 Configurer via l API à distance Structure d un paquet de requêtes Un paquet de requêtes XML ajoutant un nouvel enregistrement DNS dans le template de la zone DNS inclut le noeud d opération dns/add_rec qui est présenté par le type dnsrecord (plesk_dns.xsd) et structuré comme suit :

107 Configurer via l API à distance 107 type, requis Indique le type de l enregistrement DNS. Type de données : chaîne. Valeurs autorisées : A NS CNAME MX PTR TXT SOA AXFR SRV. host, requis Indique le nom de l hôte dans lequel le paramètre des enregistrements s applique. Type de données : chaîne. value, requis Indique la valeur qui sera liée à la valeur host. Type de données : chaîne. La valeur contient les éléments substituables <domaine> ou <ip> qui seront remplacés par l adresse IP réelle/le nom d hôte lorsqu un fichier de zone DNS est créé lors de la création d un domaine. opt, facultatif Détient les informations facultatives sur l enregistrement DNS. Type de données : chaîne. Remarque : Dans le cas d un enregistrement SRV, le noeud opt peut contenir un code XML supplémentaire au format suivant :<Srv Protocol= Port= Priority= Weight= />. Vous pouvez ajouter plusieurs enregistrements DNS à l aide d un seul paquet. Ajoutez autant d opérations <add-rec> que le nombre d enregistrements DNS que vous voulez ajouter. <dns> <add_rec>... </add_rec>... <add_rec>... </add_rec> </dns>

108 108 Configurer via l API à distance Exemples de requête Template d enregistrement NS <packet version= > <dns> </dns> <add_rec> <type>ns</type> <host/> <value>ns.<domain></value> </add_rec> La zone DNS créée lors de la création d un domaine example.com contiendra l enregistrement de ressources suivant : example.com. NS ns.example.com. ns.example.com devient alors le nom du serveur de l hôte example.com. Ce paquet de requêtes ajoute au template de la zone DNS un enregistrement qui fait de provider-dns-server.example.com un serveur de nom pour un domaine. <packet version= > <dns> <add_rec> <type>ns</type> <host/> <value>provider-dns-server.example.com</value> </add_rec> </dns> Template d enregistrement A <packet version= > <dns> <add_rec> <type>a</type> <host>mail</host>

109 Configurer via l API à distance 109 </dns> <value><ip></value> </add_rec> La zone DNS créée lors de la création du domaine example.com (hébergé sur IP ) contiendra l enregistrement des ressources suivant : mail.example.com. A qui définit l adresse IP pour l hôte mail.example.com. Template d enregistrement CNAME <packet version= > <dns> <add_rec> <type>cname</type> <host>www</host> <value>ns.<domain></value> </add_rec> </dns> La zone DNS créée lors de la création d un domaine example.com contiendra l enregistrement de ressources suivant : www NS ns ns.example.com est alors un alias de Template d enregistrement MX <packet version= > <dns> <add_rec> <type>mx</type> <host/> <value>exchange.<domain></value> <opt>0</opt> </add_rec> </dns>

110 110 Configurer via l API à distance La zone DNS créée lors de la création d un domaine example.com contiendra l enregistrement de ressources suivant : example.com. MX 0 exchange.example.com. mail.example.com est alors le serveur de messagerie principal pour le domaine example.com. Template d enregistrement PTR <packet version= > <dns> <add_rec> <type>ptr</type> <host><ip></host> <value>community</value> <opt>24</opt> </add_rec> </dns> La zone DNS créée lors de la création du domaine example.com (hébergé sur IP ) contiendra l enregistrement des ressources suivant : /24 PTR community.example.com ce qui fait du domaine community.example.com le pointeur du nom de domaine pour le sous-réseau /24. Template d enregistrement TXT <packet version= > <dns> <add_rec> <type>txt</type> <host>about</host> <value>delivered by the best provider</value> </add_rec> </dns> La zone DNS créée lors de la création d un domaine example.com contiendra l enregistrement de ressources suivant :

111 Configurer via l API à distance 111 about TXT Delivered by the best provider qui ajoute une description textuelle Delivered by the best provider dans le domaine about.example.com. Template d enregistrement SRV <packet version= > <dns> <add_rec> <type>srv</type> <host>_ldap._tcp</host> <value> </value> <opt> </opt> </add_rec> </dns> La zone DNS créée lors de la création d un domaine example.com contiendra l enregistrement de ressources suivant : _LDAP._tcp SRV ce qui fait qu un client du service LDAP sur le domaine example.com exécute un lookup SRV de Ajouter plusieurs enregistrements Le paquet de requêtes suivant ajoute en même temps tous les enregistrements des exemples ci-dessus : <packet version= > <dns> <add_rec> <type>ns</type> <host/> <value>ns.<domain></value> </add_rec> <add_rec> <type>ns</type> <host/> <value>provider-dns-server.example.com</value> </add_rec>

112 112 Configurer via l API à distance <add_rec> <type>a</type> <host>mail</host> <value><ip></value> </add_rec> <add_rec> <type>cname</type> <host>www</host> <value>ns.<domain></value> </add_rec> <add_rec> <type>mx</type> <host/> <value>exchange.<domain></value> <opt>0</opt> </add_rec> <add_rec> <type>ptr</type> <host><ip></host> <value>community</value> <opt>24</opt> </add_rec> <add_rec> <type>txt</type> <host>about</host> <value>delivered by the best provider</value> </add_rec> <add_rec> <type>srv</type> <host>_ldap._tcp</host> <value> </value> <opt> </opt> </add_rec> </dns>

113 Configurer via l API à distance 113 Structure du paquet de réponses Le noeud add_rec du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. id, requis en cas de réussite de l opération Retourne l identifiant unique de l enregistrement DNS qui vient d être ajouté. Type de données : nombre entier.

114 114 Configurer via l API à distance Exemples de réponse Une réponse positive ressemble à ceci : <packet version= > <dns> <add_rec> <result> <status>ok</status> <id>17</id> </result></add_rec> </dns> Une telle réponse négative est reçue si un paquet de requêtes a indiqué des valeurs incorrectes pour l enregistrement des ressources qui vient d être ajouté (dans notre exemple, il n est pas correctement compris et un hôte incorrect est indiqué pour l enregistrement SRV): PAQUET DE REQUETES <packet version= > <dns> <add_rec> <type>srv</type> <host>_ldap._tcp.ldap.domain-test tst.</host> <value> </value> <opt> </opt> </add_rec> </dns> PAQUET DE REPONSES <packet version= > <dns> <add_rec> <result> <status>error</status> <errcode>1019</errcode> <errtext>incorrect DNS record values were specified.</errtext>

115 Configurer via l API à distance 115 </result> </add_rec> </dns> Récupérer les informations à propos du template de la zone DNS Pour récupérer les informations à propos des enregistrements de ressource dans le template de la zone DNS, émettez le paquet XML avec le noeud d opération dns/get_rec: <packet version= > <dns> <get_rec> <filter/> <template/> </get_rec> </dns> Dans cette section : Structure du paquet de reponses Exemples de reponse

116 116 Configurer via l API à distance Structure du paquet de reponses Le noeud get_rec du paquet XML sortant est structuré comme suit :

117 Configurer via l API à distance 117 result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. id, requis en cas de réussite de l opération Retourne l identifiant unique de l enregistrement DNS qui vient d être ajouté. Type de données : nombre entier. data, requis en cas de réussie de l opération. Détient une collecte des données d enregistrement de ressources. type, requis Indique le type de l enregistrement DNS. Type de données : chaîne. Valeurs autorisées : A NS CNAME MX PTR TXT SOA AXFR SRV. host, requis Indique le nom de l hôte utilisé par le DNS. Type de données : chaîne. value, requis Indique la valeur qui sera liée à la valeur host. Type de données : chaîne. La valeur contient la variable <domaine> ou <ip> qui sera remplacée par l adresse IP réelle/le nom d hôte lorsqu un fichier de zone DNS est créé lors de la création d un domaine. opt, facultatif Détient les informations facultatives sur l enregistrement DNS. Type de données : chaîne.

118 118 Configurer via l API à distance Exemples de reponse La réponse suivante est recue si le template de la zone DNS ne contient pas d enregistrement d une seule ressource : PAQUET DE REQUETES <packet version= > <dns> <get_rec> <filter/> <template/> </get_rec> </dns> PAQUET DE REPONSES <packet version= > <dns> <get_rec/> </dns> La réponse suivante contient une description du template de la zone DNS du Panel par défaut : PAQUET DE REQUETES <packet version= > <dns> <get_rec> <filter/> <template/> </get_rec> </dns> PAQUET DE REPONSES <packet version= > <dns>

119 Configurer via l API à distance 119 <get_rec> <result> <status>ok</status> <id>1</id> <data> <type>ns</type> <host><domain>.</host> <value>ns.<domain>.</value> <opt/> </data> </result> <result> <status>ok</status> <id>2</id> <data> <type>a</type> <host>ns.<domain>.</host> <value><ip></value> <opt/> </data> </result> <result> <status>ok</status> <id>3</id> <data> <type>a</type> <host><domain>.</host> <value><ip></value> <opt/> </data> </result> <result> <status>ok</status> <id>4</id> <data> <type>a</type> <host>webmail.<domain>.</host>

120 120 Configurer via l API à distance <value><ip></value> <opt/> </data> </result> <result> <status>ok</status> <id>5</id> <data> <type>mx</type> <host><domain>.</host> <value>mail.<domain>.</value> <opt>10</opt> </data> </result> <result> <status>ok</status> <id>6</id> <data> <type>a</type> <host>mail.<domain>.</host> <value><ip></value> <opt/> </data> </result> <result> <status>ok</status> <id>7</id> <data> <type>cname</type> <host>ftp.<domain>.</host> <value><domain>.</value> <opt/> </data> </result> <result> <status>ok</status> <id>8</id>

121 Configurer via l API à distance 121 <data> <type>ptr</type> <host><ip> / 24</host> <value><domain>.</value> <opt>24</opt> </data> </result> </get_rec> </dns> Supprimer un template d enregistrement de ressources Pour supprimer un enregistrement de ressources du template de la zone DNS, émettez un paquet XML contenant le noeud d opération dns/del_rec: <packet version= > <dns> <del_rec>... </del_rec> </dns> Dans cette section : Structure d un paquet de requêtes Exemples de requête Structure du paquet de réponses Exemples de réponse

122 122 Configurer via l API à distance Structure d un paquet de requêtes Un paquet de requêtes XML supprimant un enregistrement DNS inclut le noeud d opération del_rec structuré comme suit : filter, requis Indique la règle de filtre. Type de données : dnsselectionfiltertype (dns_input.xsd). S il est laissé vierge (<filter/>), tous les templates d enregistrement sont supprimés. id, facultatif Indique l ID du template de l enregistrement de ressource à supprimer. Type de données : id_type (common.xsd). template, requis Indique que les templates d enregistrement sont supprimés. Type de données : aucun.

123 Configurer via l API à distance 123 Exemples de requête Ce paquet de requêtes supprime l enregistrement portant l ID 7 du template de la zone DNS. <packet version= > <dns> <del_rec> <filter> <id>7</id> </filter> <template/> </del_rec> </dns> Ce paquet de requêtes supprime les enregistrements portant l ID 1-5 du template de la zone DNS. <packet version= > <dns> <del_rec> <filter> <id>1</id> <id>2</id> <id>3</id> <id>4</id> <id>5</id> </filter> <template/> </del_rec> </dns> Ce paquet supprime tous les enregistrements du template de la zone DNS. <packet version= > <dns> <del_rec> <filter/>

124 124 Configurer via l API à distance <template/> </del_rec> </dns> Structure du paquet de réponses Le noeud del_rec du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. id, requis en cas de réussite de l opération Retourne l identifiant unique de l enregistrement DNS supprimé. Type de données : nombre entier.

125 Configurer via l API à distance 125 Exemples de réponse La réponse positive reçue du serveur ressemble à ceci (la suppression de tous les enregistrements de la zone DNS est réussie) : PAQUET DE REQUETES <packet version= > <dns> <del_rec> <filter/> <template/> </del_rec> </dns> PAQUET DE REPONSES <packet version= > <dns> <del_rec> <result> <status>ok</status> <id>1</id> </result> <result> <status>ok</status> <id>2</id> </result> <result> <status>ok</status> <id>3</id> </result> <result> <status>ok</status> <id>4</id> </result> <result> <status>ok</status>

126 126 Configurer via l API à distance <id>5</id> </result> <result> <status>ok</status> <id>6</id> </result> <result> <status>ok</status> <id>7</id> </result> <result> <status>ok</status> <id>8</id> </result> <result> <status>ok</status> <id>9</id> </result> <result> <status>ok</status> <id>10</id> </result> <result> <status>ok</status> <id>11</id> </result> <result> <status>ok</status> <id>12</id> </result> </del_rec> </dns> Une telle réponse négative est reçue si l enregistrement indiqué à supprimer n existe pas :

127 Configurer via l API à distance 127 PAQUET DE REQUETES <packet version= > <dns> <del_rec> <filter> <id>1</id> <id>2</id> <id>3</id> <id>4</id> <id>5</id> </filter> <template/> </del_rec> </dns> PAQUET DE REPONSES <packet version= > <dns> <del_rec> <result> <status>error</status> <errcode>1013</errcode> <errtext>dns record does not exist.</errtext> <id>1</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>dns record does not exist.</errtext> <id>2</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>dns record does not exist.</errtext>

128 128 Configurer via l API à distance <id>3</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>dns record does not exist.</errtext> <id>4</id> </result> <result> <status>error</status> <errcode>1013</errcode> <errtext>dns record does not exist.</errtext> <id>5</id> </result> </del_rec> </dns> Installer les certificats SSL Pour installer un certificat SSL, émettez un paquet de requêtes XML contenant le noeud d opération certificate/install : <packet version= > <certificate> <install> </install> </certificate> Dans cette section : Structure d un paquet de requêtes Exemple de requête Structure du paquet de réponses Exemples de réponse

129 Configurer via l API à distance 129 Structure d un paquet de requêtes Le noeud install du paquet de requêtes XML est structuré comme suit : name, requis Indique le nom sous lequel le certificat sera affiché dans le Panel. Type de données : chaîne. admin, requis Indique que le certificat est importé dans le répertoire du serveur. Type de données : aucun. content, requis Contient toutes les données constituant le certificat. Type de données : aucun. csr, requis Indique le certificat CSR (demande de signature du certificat). Type de données : chaîne. pvt, requis Indique le certificat avec une clé privée. Type de données : chaîne. cert, facultatif Contient le corps du certificat. Type de données : chaîne. ca, facultatif Contient le corps de l autorité du certificat. Type de données : chaîne. ip_address, requis Indique l adresse IP vers laquelle le certificat sera affecté. Type de données : ip_type (common.xsd).

130 130 Configurer via l API à distance Exemple de requête Ce paquet installe un certificat CA qui sera affiché dans le Panel sous le nom common, et affecté à l adresse IP <packet version= > <certificate> <install> <name>common</name> <admin/> <content> <csr>-----begin CERTIFICATE REQUEST----- MIICwTCCAakCAQAwfDELMAkGA1UEBhMCVVMxEDAOBgNVBAgTB2dlb3JnaWExEDAO BgNVBAcTB0F0bGFudGExEjAQBgNVBAoTCURvZSwgTHRkLjEUMBIGA1UEAxMLam9o bmrvzs5vcmcxhzadbgkqhkig9w0bcqewegpkb2vaam9obmrvzs5vcmcwggeima0g CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC7AQlX0pXqCs61ZUZ28zJ9PAG0yxvV 2pJnJTMqrudyi/3vV8IZrBUUWMthf7tQmMSSyZWAqM+7n4Q9Y4f5WuR+3ReM5kxC hbqnorjpdumv1+zhb9q21ufa5eeptydm/lr2jajpkjd078rh76pvzm3esjml3+ue 3Dg0DeKDelDKa4SYzW1JJnoen4UXX37lIHdBnIj+NCQbHRSiGD6w6mMyiCMOzXCp SBiGXgRRcaOVl50OeAdVKkwpJaae1K7K3q9j/LkAlOa1C8kuwdaCtKC+jFCE72I0 Q8TnIn7ahPy0yd2EgzZ42Ys8D3PziqGax8I/e6BbEOfzi0n1HD9GCzaPAgMBAAGg ADANBgkqhkiG9w0BAQQFAAOCAQEAhoSVmInXLQDJu8jrZTVvFUx6O6aHOUkUf/G8 Wnc2x7w+Qo7XHMHVDCUcP3K+bEw9oKxfpvRXP9XTVhX2jABHrxywLyjg4cXwaUgR t7ulvplq0sum5xntbypadsqzz7ktaa6q3omafndy8yg9j/l2zlcl9jjzlaunrwzn fmbn9ip3pcc8n9of9+pfpxgvhtlc1o27w9wj0rdk3hf6rg37qcujsnn6xxob41q8 ZZbX2Vbskz0WJ1IcxsfWDJ/HFdho7GrrD/wujNpwkTPc3xe2AHcfQX8c/92xyra/ kdzxsddfd7iwa5bbwgm8qwll9ywudpiz8vsgw96d/qije9uvka== -----END CERTIFICATE REQUEST-----</csr> <pvt>-----begin RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAyxfczy4HqgwOI6yxEa+dLaMLe5zC0ijcawsha8oFtJlxv/DM 9INpdKjv9HaInrR0StjG9HgqTpYrhOCJxeB07/gGsQ82xsvbcKANuCSQKInpwVim GUsisGNrfnbKIoAewN21ENCZQrufcQNWNzTx/GjVCXqa/Sy4pXJ6Jud0dzA/+Vis SBw5Oo4IqI2MDvuoDk+exQLdgM45Vgq4d3A9+ESzmRmjmdovhNxnXdvMxA5RSrF+ GZlBTFftsLQsnfnNiMR6ZTFgNCt2vdDmUAV9iix2B1PuoH94TRCJRG5tVCFtfVzS Rjo4ZzoiUs57efb3Oe56Lb64Ubi9ZRzNhdkGLwIDAQABAoIBABJdOAQr31mK+YRU SzaUMJw9z/3/cMZcF4I+YWlDvTxVW6nFdmLttw1rcTcjuLrRCmryKxtT+k9c2NaN DygrYaeJP+GmxIc5S8BlWJg8BiUEQ3TONUa4OozEkKXAzApOl3lNEuBQXGtiV8p6 SMN5MCBowkq3IWifMJsVPOJjr25Pby04HCPeeM+cnEiPnMrBjK4OGH8/pKqedf05 EcjnFKGFP2G0BUEhLX7ooMhB+AbjoIbGFXlBIzhaofs8zzSjNkKJ9i4LQMEe0GDf zcge4gehw+fdculhg1zo7fojc0ldvur4deomzainriwdwxbokvwgsenm20yxydcl t+dsreecgyea+snpkzdqc0vf6me6wo8eqmu6abpjobknw0i8+g8ndrkmcjq8fexd +D447fCMORUdqGFH8aMWDp392z4JX3+ksSN9XtyEEKB3fsknENsDZKVJvh9U+gUD DO12mC1PleQBHBjN7Wlsg4mPZNv3cxUQLhFU0qW/moQdy0JrDfv+51ECgYEAz1Ww OJolOjKhPkGxiDY9sh95E/rpuwkGjb0qiS/UFHHuLc9pDYHyKRpPggdT4nEuBz34 crpihmgxbkezuxgepvdist0aobowcqfy4haj8ps08rzupcjsk413gyei/ckxacqk byyhlkseavrcmmfc98i2fmbbnp+ckelhfzvytx8cgyeayp6x39yseihrx4sq8ivu 3j89fnPjo7GxinPZFU3kQJWtROdsKIurAmVNWFrA6lgkh3xCIEqqOVklyv+0n5k+ NsXNjaWPLYyRe0xcRcRmudtKelu+zxAJW+lSb7OR4QD6arzvAmbIFb7C8wLlGpc9 es9lf9pe88kf4jacixljpaecgyeaj4swtwlzbsjwygz3yaovkuwi8qdnxlvx+r2x XmVjokgCi2rGo5hszLIvi6mBFQwgvtjTsZJ/1Mg4z6i/g8sosONJA5OvHXXfWnIE

131 Configurer via l API à distance 131 f9zxu4xf5q4s6cx/f+r4czahcvsph6wfrpz9txytq3fe2uk8ctxfxif3kyjnwf7o ma6yxqccgyeapqdvvr92ysyzudtkygn5rd5bajsgpywpshs5lpkbq4n/tkszzo1v Bxq2AbPRohXasWEAdfgfss1mcwX9xnKO/DhnxXE8KVFXKVehGmUth0WqA5qtL4xD h4hm3v7dcmqybvzpmlwxfz5is1fiflahlfex4h3s1rirtj+t6hodvf4= -----END RSA PRIVATE KEY-----</pvt> <cert>-----begin CERTIFICATE----- MIIDiTCCAnECBETUDecwDQYJKoZIhvcNAQEEBQAwgYgxCzAJBgNVBAYTAlJVMQww CgYDVQQIEwNOU08xDDAKBgNVBAcTA05TSzEUMBIGA1UEChMLRGFtYWdlIEluYy4x CzAJBgNVBAsTAlFBMRcwFQYDVQQDEw53d3cuc3dzb2Z0LmNvbTEhMB8GCSqGSIb3 DQEJARYScmJ1c3lndWluQHBsZXNrLnJ1MB4XDTA2MDgwNTAzMTgwMVoXDTA3MDgw NTAzMTgwMVowgYgxCzAJBgNVBAYTAlJVMQwwCgYDVQQIEwNOU08xDDAKBgNVBAcT A05TSzEUMBIGA1UEChMLRGFtYWdlIEluYy4xCzAJBgNVBAsTAlFBMRcwFQYDVQQD Ew53d3cuc3dzb2Z0LmNvbTEhMB8GCSqGSIb3DQEJARYScmJ1c3lndWluQHBsZXNr LnJ1MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyxfczy4HqgwOI6yx Ea+dLaMLe5zC0ijcawsha8oFtJlxv/DM9INpdKjv9HaInrR0StjG9HgqTpYrhOCJ xeb07/ggsq82xsvbckanucsqkinpwvimgusisgnrfnbkioaewn21enczqrufcqnw NzTx/GjVCXqa/Sy4pXJ6Jud0dzA/+VisSBw5Oo4IqI2MDvuoDk+exQLdgM45Vgq4 d3a9+eszmrmjmdovhnxnxdvmxa5rsrf+gzlbtfftslqsnfnnimr6ztfgnct2vddm UAV9iix2B1PuoH94TRCJRG5tVCFtfVzSRjo4ZzoiUs57efb3Oe56Lb64Ubi9ZRzN hdkglwidaqabma0gcsqgsib3dqebbauaa4ibaqbh8mtx3q3csbujzwfy3kivobgh yelljoq87qv5rht5yktutys3ogxsdd0so/usg/akl34ctpkjl/vqytzkmsfq5pxy MlY6Q+GCd9FgL5pBn1S8HSZLpTBWZc25mNe3mXbCQzI03r4W+dQajAgAgDKpnRjg mblrg98+hwol033pvgunrwpos3lo5jia5z3f0mks8sv3x18duoslevilhj0ttz/p B7x0kIUee8A95Q00EDh+4IaPSMOqiFrVIlsHEuPV33aCAz2Dk2TxzplsoNz61BFA i3cm04gz1h9w/yzkcycqiwumizsgusbln0hbetid1u/nadtic776yguyai+/ -----END CERTIFICATE-----</cert> <ca> -----BEGIN CERTIFICATE (DEBUT DU CERTIFICAT)----- MIIEjDCCA3SgAwIBAgIJAL4AGzKhkL5wMA0GCSqGSIb3DQEBBQUAMIGKMQswCQYD VQQGEwJSVTELMAkGA1UECBMCTlYxFDASBgNVBAcTC05vdm9zaWJpcnNrMRIwEAYD VQQKEwlQYXJhbGxlbHMxDjAMBgNVBAsTBVBsZXNrMQ0wCwYDVQQDEwRhYmVsMSU w IwYJKoZIhvcNAQkBFhZhYmVseWFldkBwYXJhbGxlbHMuY29tMB4XDTA5MDQyODAz NDMxMloXDTEwMDQyODAzNDMxMlowgYoxCzAJBgNVBAYTAlJVMQswCQYDVQQIEwJO VjEUMBIGA1UEBxMLTm92b3NpYmlyc2sxEjAQBgNVBAoTCVBhcmFsbGVsczEOMAwG A1UECxMFUGxlc2sxDTALBgNVBAMTBGFiZWwxJTAjBgkqhkiG9w0BCQEWFmFiZWx5 YWV2QHBhcmFsbGVscy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB AQDlslx5nXTQTvoic3GgW4HH5n5PoCz95Z9XNtCykwv0M2HdhMeNvde1NYDvkipa FHzVPEH7eBgjAsHR4y1J4zVGAs2KiJF0W81vi5YAVMOJ7Ysyz8WLP0PQWTmUoMFM

132 132 Configurer via l API à distance ae0p7m788tphl328chdpjtjlcf6w9fkzddzrvdek04ojp2cro6ffmh7wjpcajvh/ 3EuYpc7xBNC6Wf8Gk6tB5kCCe7wpHyXsc7ve97nn30p6rUXypBNHYmLujMCtS90I K2xOCaSsCwkeUQ4mpXrr5lK7yM07b322vNZBiMTHV8DnaOWDPIcEIFl8NmOJovub dg5wdxopa6secqlaf95lvulragmbaagjgfiwge8whqydvr0obbyeflsg4v0zc0i0 prftcygaitgz5ikcmig/bgnvhsmegbcwgbsaflsg4v0zc0i0prftcygaitgz5ikc oygqpignmigkmqswcqydvqqgewjsvtelmakga1uecbmctlyxfdasbgnvbactc0 5v dm9zawjpcnnrmriweaydvqqkewlqyxjhbgxlbhmxdjambgnvbastbvbszxnrmq0w CwYDVQQDEwRhYmVsMSUwIwYJKoZIhvcNAQkBFhZhYmVseWFldkBwYXJhbGxlbHMu Y29tggkAvgAbMqGQvnAwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAQEA dekv4dzmr7rp0dlyqdpdvigu7fe+7r5u87mz3e9ctapycbg4ktzas53b3itsaqv2 yjxnktqw2/l5xusw+oxhgpwc0z58jscyqnw/hkvheurgbyliooaks9vaayi3ma0t O1cB1vnAgmB8puV6IdEKuvUimgbJhiGIpqTiL+2/YgSnkGhRuYlxuFB6U8WPgrUN UMt0linQtUsxMJCghMA3T8cODGon4ugZ0cCJmDfpkStI3jUuoxulSX2I8xmUQtGe 2Q/sUQaWgJhe4RDoth6w7E9GE8733WGhC1mIjxyJMx4vmu4ofLAwN6XUzJJ3eC7s P34vOGq/sqxG/U+BbUu71A== -----END CERTIFICATE (FIN DU CERTIFICAT)----- </ca> </content> <ip_address> </ip_address> </install> </certificate> Structure du paquet de réponses Le noeud install du paquet XML sortant est structuré comme suit :

133 Configurer via l API à distance 133 result, requis Contient la réponse reçue du serveur. status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : unsignedint. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne.

134 134 Configurer via l API à distance Exemples de réponse La réponse positive du serveur ressemble à ceci : <packet version= > <certificate> <install> <result> <status>ok</status> </result> </install> </certificate> Les réponses négatives du serveur ressemblent à ceci : <packet version= > <certificate> <install> <result> <status>error</status> <errcode>8002</errcode> <errtext>unable to set csr content to certificate : CSR field contains an improper value : openssl failed: </errtext> </result> </install> </certificate> <packet version= > <certificate> <install> <result> <status>error</status> <errcode>8006</errcode> <errtext>unable to set certificate name : </errtext> </result> </install>

135 Configurer via l API à distance 135 </certificate> Créer des domaines Pour créer un compte de domaine, émettez un paquet de requêtes XML contenant le noeud d opération domain/add: <packet version= > <domain> <add> </add> </domain> Dans cette section : Structure d un paquet de requêtes Exemples de requête Structure du paquet de réponses Exemples de réponse Structure d un paquet de requêtes Un paquet de requêtes XML créant un compte de domaine inclut le noeud d opération domain/add structuré comme suit :

136 136 Configurer via l API à distance gen_setup, requis Détient les informations les plus importantes sur le compte du domaine. Type de données : aucun. name, requis Indique le nom du domaine. Type de données : domainname (plesk_domain.xsd). ip_address, requis Indique l IP sur lequel le domaine est hébergé. Type de données : ip_address (common.xsd). hosting, requis Indique les paramètres d hébergement pour le domaine. Type de données : domainhostingagentset (plesk_domain.xsd). vrt_hst, requis Indique les paramètres d hébergement pour le domaine. Type de données : domainphhostingset (plesk_domain.xsd). Structuré comme suit : property, requis Indique un paramètre d hébergement. Type de données : PleskPhysHostingPropertyType (plesk_domain.xsd). name, requis Indique un nom de paramètre d hébergement. Type de données : chaîne. value, requis Indique une valeur de paramètre d hébergement. Type de données : aucune. ip_address, required Indique l adresse IP du domaine. Type de données : ip_address (common.xsd).

137 Configurer via l API à distance 137 Exemples de requête Cette requête crée le domaine example.com hébergé sur IP <packet version= > <domain> <add> <gen_setup> <name>example.com</name> <ip_address> </ip_address> </gen_setup> <hosting> <vrt_hst> <property> <name>ftp_login</name> <value>fp16se4fdf0</value> </property> <property> <name>ftp_password</name> <value>qweqwe</value> </property> <ip_address> </ip_address> </vrt_hst> </hosting> </add> </domain>

138 138 Configurer via l API à distance Structure du paquet de réponses Le noeud add du paquet de réponses est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. id, requis en cas de réussite de l opération Retourne l identifiant unique du compte de domaine qui vient d être créé. Type de données : nombre entier. guid, requis en cas de réussite de l opération Retourne l identifiant unique global du compte de domaine qui vient d être créé. Type de données : chaîne.

139 Configurer via l API à distance 139 Exemples de réponse Une réponse positive obtenue du serveur après l ajout d un nouveau compte de domaine ressemble à ceci : <packet version= > <domain> <add> <result> <status>ok</status> <id>6</id> <guid>5c0e a bcc0-881d691bfdef</guid> </result> </add> </domain> Une réponse négative peut ressembler à ceci (vous pouvez obtenir un code d erreur différent en fonction de la cause de l erreur) : <packet version= > <domain> <add> <result> <status>error</status> <errcode>1023</errcode> <errtext>operation failed.</errtext> </result> </add> </domain> Une telle réponse négative est reçue si un paquet de requêtes n indique pas tous les paramètres d hébergement requis : PAQUET DE REQUETES <packet version= > <domain>

140 140 Configurer via l API à distance <add> <gen_setup> <name>sample.com</name> <ip_address> </ip_address> </gen_setup> <hosting> <vrt_hst> <property> <name>ftp_password</name> <value>fp16sdfdfrttg0</value> </property> <ip_address> </ip_address> </vrt_hst> </hosting> </add> </domain> PAQUET DE REPONSES <packet version= > <domain> <add> <result> <status>error</status> <errcode>2204</errcode> <errtext>unable to update hosting preferences. system user update is failed: Unable to check system user existence: login name is empty. Incorrect fields: login.</errtext> </result> </add> </domain>

141 Configurer via l API à distance 141 Créer des sous-domaines Pour créer un compte de sous-domaine, émettez un paquet de requêtes XML contenant le noeud d opération subdomain/add : <packet version= > <subdomain> <add> </add> </subdomain> Dans cette section : Structure d un paquet de requêtes Exemples de requête Structure du paquet de réponses Exemples de réponse Structure d un paquet de requêtes Un paquet de requêtes XML ajoutant de nouveaux sous-domaines inclut le noeud d opération subdomain/add structuré comme suit :

142 142 Configurer via l API à distance parent, requis Indique un nom de domaine/sous-domaine sur lequel un sous-domaine est créé. (Le sous-domaine parent est pris en charge sur Windows uniquement.) Type de données : chaîne. name, requis Indique un nom du sous-domaine. Type de données : chaîne. home, requis si un sous-domaine est créé sur le sous-dossier (Windows uniquement) Indique un chemin d accès au répertoire d accueil du sous-domaine. Type de données : chaîne. S il est laissé vierge (<home/>), le répertoire root du domaine parent est utilisé. property, facultatif Indique un paramètre d hébergement d un sous-domaine créé. Type de données : SubdomainPropertyType (subdomain.xsd). name, requis Indique un nom de paramètre d hébergement. Type de données : chaîne. value, requis Indique une valeur de paramètre d hébergement. Type de données : aucun.

143 Configurer via l API à distance 143 Exemples de requête Ce paquet crée un sous-domaine forum.example.com: <packet version= > <subdomain> <add> <parent>example.com</parent> <name>forum</name> <property> <name>ftp_login</name> <value>john</value> </property> <property> <name>ftp_password</name> <value>sample</value> </property> </add> </subdomain> Créer un sous-domaine sur le sous-dossier Ce paquet crée le sous-domaine blog.example.com sur le sous-dossier /httpdocs/blogengine: <packet version= > <subdomain> <add> <parent>example.com</parent> <name>blog</name> <home>/httpdocs/blogengine</home> </add> </subdomain>

144 144 Configurer via l API à distance Structure du paquet de réponses Le noeud add du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. id, requis en cas de réussite de l opération Retourne l identifiant unique du sous-domaine créé.type de données : id_type (common.xsd). Erreurs spécifiques à l opération Un sous-domaine portant ce nom existe déjà Impossible de trouver le domaine/sous-domaine parent Propriété incorrecte indiquée Echec de l opération.

145 Configurer via l API à distance 145 Exemples de réponse Une réponse positive reçue du serveur lors de la création du sous-domaine ressemble à ceci : <packet version= > <subdomain> <add> <result> <status>ok</status> <id>1</id> </result> </add> </subdomain> Une telle réponse négative est reçue si un sous-domaine indiqué existe déjà : PAQUET DE REQUETES <packet version= > <subdomain> <add> <parent>example.com</parent> <name>blog</name> </add> </subdomain> PAQUET DE REPONSES <packet version= > <subdomain> <add> <result> <status>error</status> <errcode>1007</errcode> <errtext>the subdomain with such name already exists.</errtext> </result> </add>

146 146 Configurer via l API à distance </subdomain> Définir les catalogues d APS disponibles Pour importer la liste personnalisée (fichier de configuration) des Catalogues d APS dans le Panel, émettez le paquet de requêtes XML avec le noeud d opération aps/import-config: <packet version= > <aps> <import-config>... </import-config> </aps> Le fichier de configuration (cf. page 47) doit auparavant être envoyé au serveur à l aide de l opérateur upload (cf. page 151). Dans cette section : Structure d un paquet de requêtes Exemples de requête Structure du paquet de réponses Exemples de réponse Structure d un paquet de requêtes Le noeud import-config du paquet de requêtes XML est structuré comme suit : filename, requis Indique le nom du fichier de configuration envoyé vers le serveur. Type de données : chaîne. La valeur doit être le nom de fichier temporaire renvoyé dans la réponse upload (cf page 160) (dans l élément upload/result/file ).

147 Configurer via l API à distance 147 Exemples de requête Les paquets de requêtes important la configuration du Catalogue APS auparavant envoyés au serveur ressemblent à ceci. Sur Linux/Unix : <packet version= > <aps> <import-config> <filename>/usr/local/psa/tmp/li_8fzruf</filename> </import-config> </aps> Sur Windows : <packet version= > <aps> <import-config> <filename> C:/Program Files/Parallels/Plesk/tmp/li_9D.tmp </filename> </import-config> </aps>

148 148 Configurer via l API à distance Structure du paquet de réponses Le noeud import-config du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne.

149 Configurer via l API à distance 149 Exemples de réponse Une réponse positive reçue du serveur ressemble à ceci : <packet version= > <aps> <install> <result> <status>ok</status> </result> </install> </aps> Une telle réponse négative est reçue si un fichier requis n a pas été trouvé : <packet version= > <aps> <import-config> <result> <status>error</status> <errcode>1013</errcode> <errtext>file /usr/local/psa/tmp/li_8fzruf does not exist</errtext> </result> </import-config> </aps> Une telle réponse négative est reçue si un fichier requis a des droits d accès incorrects (la plupart du temps, cela s explique par l envoi différent de celui effectué à partir de l agent upload) : <packet version= > <aps> <import-config> <result> <status>error</status> <errcode>1023</errcode> <errtext>unable to use specified file as config file</errtext>

150 150 Configurer via l API à distance </result> </import-config> </aps> Installer des applications Pour installer les applications sur les domaines et les sous-domaines, utilisez l opérateur aps comme décrit plus loin. Dans cette section : Importer les packs d application Installer l application Importer les packs d application Dans cette section : Envoyer des fichiers au serveur Importer le pack d application envoyé Télécharger le pack d application du Catalogue APS Obtenir le statut de la tâche de téléchargement

151 Configurer via l API à distance 151 Envoyer des fichiers au serveur Pour envoyer les fichiers au serveur géré par le Panel, l opérateur upload est envoyé. A l inverse d autres opérateurs, l opérateur upload n utilise pas une structure de paquet de requêtes standard. A la place, il utilise la méthode POST ( pour envoyer les fichiers. Lorsqu une requête est traitée par le Panel, la réponse est donnée dans le paquet de réponses XML régulier. Après l envoi d un fichier au Panel, il peut être utilisé dans d autres opérations. Remarque : Vous pouvez également envoyer des fichiers à l aide des gestionnaires FTP, mais dans un tel cas, veuillez garder à l esprit que les droits sur les fichiers envoyés peuvent être incorrects pour d autres opérations API RPC sur les fichiers. Donc, nous vous conseillons vivement d utiliser l opérateur upload. Dans cette section : Envoyer des fichiers à l aide de curl Envoyer des fichiers à l aide de PHP Envoyer des fichiers à l aide de.net Structure du paquet de réponses Exemples de réponse Envoyer des fichiers à l aide de curl Pour envoyer un fichier, procédez comme suit : 1. Créez une connexion SSH au serveur Unix dans lequel le fichier est situé. 2. Tapez la chaîne suivante dans le shell d Unix : curl -k -F myfile=@install.log -H HTTP_AUTH_LOGIN:admin -H HTTP_AUTH_PASSWD:password php Arguments curl -k Indique que curl ( est utilisé. Vous devez l installer dans la machine Unix. La connexion SSL est utilisée. -F myfile=@install.log Le fichier install.log doit être envoyé. Vous pouvez envoyer plusieurs fichiers dans un seul paquet. -H HTTP_AUTH_LOGIN:admin Indique le login de l administrateur du Panel. Substituez la valeur admin par votre login dans le Panel. -H HTTP_AUTH_PASSWD:password

152 152 Configurer via l API à distance Indique le mot de passe de l administrateur du Panel. Substituez votre mot de passe pour accéder au Panel par la valeur du mot de passe. Indique l adresse du serveur du Panel. Substituez la valeur <panel-ip> par l adresse IP du serveur. 3. Appuyez sur la touche ENTREE.

153 Configurer via l API à distance 153 Envoyer des fichiers à l aide de PHP Il s agit d un exemple de script PHP envoyant les fichiers au Panel. Changez HOST, LOGIN, PASSWD, et FILENAME par les données d accès du Panel. HOST Login PASSWD FILENAME Nom ou adresse IP du serveur géré par le Panel. Nom de login de l administrateur du Panel. Mot de passe de l administrateur du Panel. Nom complet du fichier à envoyer. <?php define( HOST, ); define( PATH, /enterprise/control/agent.php ); define( LOGIN, admin ); define( PASSWD, setup ); define( FILENAME,../../data.rpm ); function write_callback($ch, $data) { echo $data; return strlen($data); } function uploadfile($filename) {$url = HOST. :8443. PATH; $headers = array( HTTP_AUTH_LOGIN:. LOGIN, HTTP_AUTH_PASSWD:. PASSWD, HTTP_PRETTY_PRINT: TRUE, Content-Type: multipart/form-data;, ); // Initialize the curl engine $ch = curl_init(); // Set the curl options curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);

154 154 Configurer via l API à distance // this line makes it work under https curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); // Set the URL to be processed curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_POSTFIELDS, array ( sampfile )); $result = curl_exec($ch); if (curl_errno($ch)) { echo \n\n \n. curl error number:. curl_errno($ch); echo \n\ncurl error:. curl_error($ch); } curl_close($ch); //fclose($fp); return; } uploadfile(realpath(filename));?>

155 Configurer via l API à distance 155 Envoyer des fichiers à l aide de.net Ce code source.net envoie les fichiers vers le Panel. Changez les valeurs des variables Hostname, Login, Password, et de Protocol avec les paramètres de l instance du Panel. Changez la valeur de la variable Filename avec le nom complet du fichier que vous voulez envoyer. Filename Hostname Login Pasword Protocol Nom complet du fichier à envoyer. Nom ou adresse IP du serveur géré par le Panel. Nom de login de l administrateur du Panel. Mot de passe de l administrateur du Panel. Version du protocole API RPC. using System; using System.Net; using System.Text; using System.IO; using System.Xml; using System.Xml.Schema; using System.Security.Cryptography.X509Certificates; using System.Net.Security; namespace ConsoleApplication1 { public class Request { // Public interface // public string Filename =./tmp/myfile.sh ; // Upload file name; public string Hostname = localhost ; // The Panel s host name public string Login = admin ; // Administrator Login public string Password = setup ; // Administrator Password public string Protocol = ; // API RPC Version Protocol. // Handler for receiving information about document type definition (DTD),

156 156 Configurer via l API à distance // XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) schema validation errors. public ValidationEventHandler XmlSchemaValidation = null; public Request() { } public string AgentEntryPoint { get { return + Hostname + :8443/enterprise/control/agent.php ; } } public string InputValidationSchema { get { return + Hostname + :8443/schemas/rpc/ + Protocol + /agent_input.xsd ; } } public string OutputValidationSchema { get { return + Hostname + :8443/schemas/rpc/ + Protocol + /agent_output.xsd ; } } public XmlDocument UploadFile(string uploadfile) { HttpWebRequest request = (HttpWebRequest)WebRequest.Create(AgentEntryPoint); string boundary = DateTime.Now.Ticks.ToString( x ); request.headers.add( HTTP_AUTH_LOGIN, Login); request.headers.add( HTTP_AUTH_PASSWD, Password); request.contenttype = multipart/form-data; boundary= + boundary; request.method = POST ; // Build up the post message header StringBuilder sb = new StringBuilder(); sb.append( ); sb.append(boundary); sb.append( \r\n ); sb.append( Content-Disposition: form-data; name=\ ); sb.append( sampfile ); sb.append( \ ; filename=\ ); sb.append(path.getfilename(uploadfile)); sb.append( \ ); sb.append( \r\n ); sb.append( Content-Type: ); sb.append( application/octet-stream ); sb.append( \r\n ); sb.append( \r\n ); string postheader = sb.tostring();

157 Configurer via l API à distance 157 byte[] postheaderbytes = Encoding.UTF8.GetBytes(postHeader); // Build the trailing boundary string as a byte array // ensuring the boundary appears on a line by itself byte[] boundarybytes = Encoding.ASCII.GetBytes( \r\n + boundary + \r\n ); FileStream filestream = new FileStream(uploadfile, FileMode.Open, FileAccess.Read); long length = postheaderbytes.length + filestream.length + boundarybytes.length; request.contentlength = length; Stream stream = request.getrequeststream(); stream.write(postheaderbytes, 0, postheaderbytes.length); // Write out the file contents byte[] buffer = new Byte[checked((uint)Math.Min(4096, (int)filestream.length))]; int bytesread = 0; while ((bytesread = filestream.read(buffer, 0, buffer.length))!= 0) stream.write(buffer, 0, bytesread); // Write out the trailing boundary stream.write(boundarybytes, 0, boundarybytes.length); XmlDocument result = GetResponse(request); return result; } // Private interface // // Parsing and validating packet // private XmlDocument ParseAndValidate(TextReader xml, string schemauri) { XmlSchemaSet schemas = new XmlSchemaSet(); schemas.add(null, schemauri); XmlReaderSettings settings = new XmlReaderSettings(); if (XmlSchemaValidation!= null) settings.validationeventhandler += new ValidationEventHandler(XmlSchemaValidation); settings.validationtype = ValidationType.Schema;

158 158 Configurer via l API à distance settings.validationflags = XmlSchemaValidationFlags.ProcessSchemaLocation; settings.schemas = schemas; XmlDocument document = new XmlDocument(); using (XmlReader reader = XmlTextReader.Create(xml, settings)) { document.load(reader); } return document; } private XmlDocument GetResponse(HttpWebRequest request) { using (HttpWebResponse response = (HttpWebResponse)request.GetResponse()) using (Stream stream = response.getresponsestream()) using (TextReader reader = new StreamReader(stream)) { return ParseAndValidate(reader, OutputValidationSchema); } } } class Program { static void Main(string[] args) { if (args.length < 4) { Console.WriteLine( Usage: ParalLelSpaNelapirpcclient <Hostname> <Login> <Password> <FileName> ); Console.WriteLine( ); Console.WriteLine( Hostname - The Panel s host name ); Console.WriteLine( Login - Administrator login ); Console.WriteLine( Password - Administrator password ); Console.WriteLine( FileName - Upload file name ); return; } // Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication. ServicePointManager.ServerCertificateValidationCallback =

159 Configurer via l API à distance 159 new RemoteCertificateValidationCallback(RemoteCertificateValidation); Request request = new Request(); request.xmlschemavalidation = XmlSchemaValidation; try { XmlDocument result = request.uploadfile(filename); PrintResult(result); } catch (Exception e) { Console.WriteLine( Request error: {0}, e.message); } } // The following method is invoked by the RemoteCertificateValidationDelegate. private static bool RemoteCertificateValidation(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslpolicyerrors) { if (sslpolicyerrors!= SslPolicyErrors.RemoteCertificateNotAvailable) return true; Console.WriteLine( Certificate error: {0}, sslpolicyerrors); // Do not allow this client to communicate with unauthenticated servers. return false; } // private static void XmlSchemaValidation(object sender, ValidationEventArgs e) { Console.WriteLine( Validation error: {0}, e.message); } static void PrintResult(XmlDocument document) { XmlTextWriter writer = new XmlTextWriter(Console.Out); writer.formatting = Formatting.Indented; document.writeto(writer); writer.flush(); Console.WriteLine();

160 160 Configurer via l API à distance } } } Structure du paquet de réponses Le noeud upload du paquet XML sortant est structuré comme suit : result, requis Contient la réponse reçue du serveur. Type de données : resulttype (common.xsd). status, requis Indique le statut d exécution de l opération. Type de données : chaîne. Valeurs autorisées : ok erreur. errcode, requis en cas d échec de l opération Renvoie le code d erreur. Type de données : nombre entier. errtext, requis en cas d échec de l opération Renvoie le message d erreur. Type de données : chaîne. name, requis Indique le nom du fichier envoyé. Type de données : chaîne. file, requis Indique le nom complet du fichier créé temporairement. Type de données : chaîne.