configuration.export

Description

string configuration.export(object parameters)

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’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

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

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

Valeurs possibles :
yaml - YAML ;
xml - XML ;
json - JSON ;
raw - tableau PHP non traité.

Comportement du paramètre :
- obligatoire
prettyprint boolean Rend la sortie plus lisible pour l’utilisateur en ajoutant une indentation.

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

L’objet options comporte les paramètres suivants :
host_groups - (array) ID des 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édia à exporter ;
template_groups - (array) ID des groupes de modèles à exporter ;
templates - (array) ID des modèles à exporter.

Les utilisateurs de type Admin et User peuvent exporter uniquement les objets pour lesquels ils disposent d’une permission en lecture seule ou en lecture-écriture, ainsi que les images, mais pas les types de média.

Comportement du paramètre :
- obligatoire

Valeurs retournées

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

Exemples

Exportation d’un modèle

Exportez la configuration du modèle « 10571 » sous forme de chaîne XML.

Requête :

{
    "jsonrpc": "2.0",
    "method": "configuration.export",
    "params": {
        "options": {
            "templates": [
                "10571"
            ]
        },
        "format": "xml"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>8.0</version><template_groups><template_group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></template_group></template_groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter>&lt;dt&gt;Server uptime: (.*)&lt;\/dt&gt;</parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>6805d4c39a624a8bab2cc8ab63df1ab3</uuid><name>CPU load</name><key>system.cpu.load</key><value_type>FLOAT</value_type><triggers><trigger><uuid>ab4c2526c2bc42e48a633082255ebcb3</uuid><expression>avg(/New template/system.cpu.load,3m)&gt;2</expression><name>CPU load too high on {HOST.HOST} for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n",
    "id": 1
}

Source

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