ISPmanager API. Backup plans (ISPmanager)
De ISPWiki.
- [#backupplan Configuration backups]
- [#backupplan.edit Création. Modification. Tâche]
- [#backupplan.delete Supprimer]
- [#backupplan.enable Activer]
- [#backupplan.disable Désactiver]
- [#backupplan.dobackup Backup now]
- [#backupplan.content Backup content]
- [#backupplan.content.edit Création. Modification. Données]
- [#backupplan.content.delete Supprimer]
Sommaire |
Configuration backups.
Fonction: backupplan
Résultat: la [api.html#list liste des éléments]
- id - Id.
- name - Nom de tâche.
- enabled - Plan enabled.
- local - Entrepôt local.
- ftp - Storage type FTP-server.
- sftp - Storage type sFTP.
- tgz - Archive format TGZ.
- tar - .
- tbz2 - Archive format TBZ2.
- zip - Archive format ZIP.
- rar - Archive format RAR.
- running - En cours de:.
- empty - This plan is empty.
- period - Période.
Création. Modification. Tâche.
Fonction: backupplan.edit
Cette fonction peut etre utilisée pour afficher un objet, modifier un objet existant et créer un nouvel objet.
Affichage d'un objet:
- Paramètres:
- elid - l'identificateur unique (l'élément "id" de la fonction "backupplan")
- Résultat: la [api.html#param liste des paramètres d'objet]
Création d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- des paramètres de requete supplémentaires...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Modification d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- elid - l'identificateur unique (l'élément "id" de la fonction "backupplan")
- des paramètres de requete supplémentaires...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Liste des paramètres d'objet ou des paramètres de requete supplémentaires (voir ci-dessus):
- name - Nom de tâche.
- storage - Entrepôt.
- ldir - Répertoire.
- ldir - Répertoire.
- ftphost - Serveur.
- ftpuser - Login.
- ftppasswd - Mot de passe.
- ftpdir - Répertoire.
- archiver - Archiver.
- period - Période.
- starttime - Temps de mise en route.
- limit - Nombre.
- id - .
Supprimer.
Fonction: backupplan.delete
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "id" de la fonction "backupplan".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Activer.
Fonction: backupplan.enable
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "id" de la fonction "backupplan".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Désactiver.
Fonction: backupplan.disable
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "id" de la fonction "backupplan".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Backup now.
Fonction: backupplan.dobackup
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "id" de la fonction "backupplan".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Backup content.
Fonction: backupplan.content
Paramètres:
- elid - l'identificateur unique (l'élément "id" de la fonction "backupplan").
Résultat: la [api.html#list liste des éléments]
- name - Identificateur unique d'un élément de liste.
- file - Fichier ou répertoire.
- mysql - Base de données MySQL.
- postgresql - Base de données PostgreSQL.
- mgrdata - Configuration du panneau d'administration ISPmanager.
- email - Boîte email.
- user - Répertoire d'utilisateur.
- exclude - Exclude from backup.
- data - Données.
Création. Modification. Données.
Fonction: backupplan.content.edit
Cette fonction est utilisée pour afficher un objet, modifier un objet existant et créer un nouvel objet.
Affichage d'un objet:
- Paramètres:
- plid - l'identificateur unique de la liste parent (l'élément "id" de la fonction "backupplan").
- elid - l'identificateur unique (l'élément "name" de la fonction "backupplan.content")
- Résultat: la [api.html#param liste des paramètres d'objet]
Création d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- plid - l'identificateur unique de la liste parent (l'élément "id" de la fonction "backupplan").
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Modification d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- plid - l'identificateur unique de la liste parent (l'élément "id" de la fonction "backupplan").
- elid - l'identificateur unique (l'élément "name" de la fonction "backupplan.content")
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Liste des paramètres d'objet ou des paramètres de requete supplémentaires (voir ci-dessus):
- type - Action .
- module - Type des données.
- filedata - Chemin.
- mysqldata - Base de données.
- postgresqldata - Base de données.
- mgrdatadata - Configurations panneau.
- emaildata - Boîte email.
- userdata - Utilisateur.
Supprimer.
Fonction: backupplan.content.delete
Paramètres:
- plid - l'identificateur unique de la liste parent (l'élément "id" de la fonction "backupplan").
- elid - un ou plusieurs identificateurs uniques de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "name" de la fonction "backupplan.content".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
