This is a translation of the original English documentation page. Help us make it better.

Sidebar

Become a monitoring expert!
Sign up for Zabbix training

configuration.export

Description

chaîne configuration.export(paramètres d'objet)

Cette méthode permet d'exporter les données de configuration sous forme de chaîne sérialisée.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôle utilisateur. Voir Rôles utilisateur pour plus d'informations.

Paramètres

(objet) Paramètres définissant les objets à exporter et le format à utiliser.

Paramètre Type Description
format
(obligatoire)
string Format dans lequel les données doivent être exportées.

Valeurs possibles :
yaml - YAML ;
xml - XML ;
json - JSON;
raw - tableau PHP non traité.
prettyprint boolean Rendre la sortie plus lisible par l'homme en ajoutant une indentation.

Valeurs possibles :
true - ajouter une indentation ;
false - (par défaut) ne pas ajouter d'indentation .
options
(obligatoire)
object Objets à exporter.

L'objet options a les paramètres suivants :
groups - (array) IDs of groupes d'hôtes à exporter ;
hosts - (array) ID des hôtes à exporter ;
images - (array) ID des images à exporter ;
maps - ( array) ID des cartes à exporter ;
mediaTypes - (array) ID des types de médias à exporter ;
templates - (array) ID des modèles à exporter.

Valeurs retournées

(string) Renvoie une chaîne sérialisée contenant les données de configuration demandées.

Exemples

Export d'un hôte

Exporter la configuration d'un hôte sous forme de chaîne XML.

Requête :

{
           "jsonrpc": "2.0",
           "method": "configuration.export",
           "params": {
               "options": {
                   "hosts": [
                       "10161"
                   ]
               },
               "format": "xml"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>5.4</version><date>2020-03-13T15:31:45Z</date><groups><group><uuid>6f6799aa69e844b4b3918f779f2abf08</uuid><name>Zabbix servers</name></group></groups><hosts><host><host>Export host</host><name>Export host</name><groups><group><name>Zabbix servers</name></group></groups><interfaces><interface><interface_ref>if1</interface_ref></interface></interfaces><items><item><name>Item</name><key>item.key</key><delay>30s</delay><tags><tag><tag>Application</tag><value>CPU</value></tag></tags><valuemap><name>Host status</name></valuemap><interface_ref>if1</interface_ref><request_method>POST</request_method></item></items><valuemaps><valuemap><name>Host status</name><mappings><mapping><value>0</value><newvalue>Up</newvalue></mapping><mapping><value>2</value><newvalue>Unreachable</newvalue></mapping></mappings></valuemap></valuemaps></host></hosts></zabbix_export>\n",
           "id": 1
       }

Source

CConfiguration::export() dans ui/include/classes/api/services/CConfiguration.php.