configuration.import
Opis
boolean configuration.import(object parameters)
Ta metoda umożliwia import danych konfiguracyjnych z serializowanego ciągu znaków.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.
Parametry
(object) Parametry zawierające dane do importu oraz reguły określające sposób obsługi tych danych.
| Parametr | Typ | Opis |
|---|---|---|
| format | string | Format serializowanego ciągu znaków. Możliwe wartości: yaml - YAML;xml - XML;json - JSON.Zachowanie parametru: - wymagany |
| source | string | Serializowany ciąg znaków zawierający dane konfiguracyjne. Zachowanie parametru: - wymagany |
| rules | object | Reguły określające sposób importowania nowych i istniejących obiektów. Użytkownicy typu Admin mogą importować tylko te obiekty, do których mają uprawnienia odczyt-zapis permission, a także mapy. Na przykład host i jego encje (pozycje, wyzwalacze, wykresy itd.) mogą zostać zaimportowane tylko wtedy, gdy grupa użytkowników użytkownika ma uprawnienia do grupy hostów, do której będzie należał importowany host. Obrazy i typy nośników nie mogą być importowane przez użytkowników typu Admin. Parametr rules został szczegółowo opisany w poniższej tabeli.Zachowanie parametru: - wymagany |
Jeśli nie podano żadnych reguł, konfiguracja nie zostanie zaktualizowana.
Obiekt rules obsługuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| discoveryRules | object | Reguły określające sposób importowania reguł LLD. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe reguły LLD; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące reguły LLD zostaną zaktualizowane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, reguły LLD nieobecne w importowanych danych zostaną usunięte z bazy danych; domyślnie: false. |
| graphs | object | Reguły określające sposób importowania wykresów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe wykresy; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące wykresy zostaną zaktualizowane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, wykresy nieobecne w importowanych danych zostaną usunięte z bazy danych; domyślnie: false. |
| host_groups | object | Reguły określające sposób importowania grup hostów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe grupy hostów; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące grupy hostów zostaną zaktualizowane; domyślnie: false. |
| template_groups | object | Reguły określające sposób importowania grup szablonów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe grupy szablonów; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące grupy szablonów zostaną zaktualizowane; domyślnie: false. |
| hosts | object | Reguły określające sposób importowania hostów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe hosty; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące hosty zostaną zaktualizowane; domyślnie: false. |
| httptests | object | Reguły określające sposób importowania scenariuszy WWW. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe scenariusze WWW; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące scenariusze WWW zostaną zaktualizowane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, scenariusze WWW nieobecne w importowanych danych zostaną usunięte z bazy danych; domyślnie: false. |
| images | object | Reguły określające sposób importowania obrazów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe obrazy; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące obrazy zostaną zaktualizowane; domyślnie: false. |
| items | object | Reguły określające sposób importowania pozycji. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe pozycje; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące pozycje zostaną zaktualizowane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, pozycje nieobecne w importowanych danych zostaną usunięte z bazy danych; domyślnie: false. |
| maps | object | Reguły określające sposób importowania map. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe mapy; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące mapy zostaną zaktualizowane; domyślnie: false. |
| mediaTypes | object | Reguły określające sposób importowania typów nośników. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe typy nośników; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące typy nośników zostaną zaktualizowane; domyślnie: false. |
| templateLinkage | object | Reguły określające sposób importowania powiązań szablonów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, szablony, które nie są powiązane z importowanym hostem lub szablonem, ale są obecne w importowanych danych, zostaną powiązane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, szablony powiązane z importowanym hostem lub szablonem, ale nieobecne w importowanych danych, zostaną odłączone bez usuwania encji (pozycji, wyzwalaczy itd.) dziedziczonych z odłączonych szablonów; domyślnie: false. |
| templates | object | Reguły określające sposób importowania szablonów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe szablony; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące szablony zostaną zaktualizowane; domyślnie: false. |
| templateDashboards | object | Reguły określające sposób importowania pulpitów szablonów. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe pulpity szablonów; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące pulpity szablonów zostaną zaktualizowane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, pulpity szablonów nieobecne w importowanych danych zostaną usunięte z bazy danych; domyślnie: false. |
| triggers | object | Reguły określające sposób importowania wyzwalaczy. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe wyzwalacze; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące wyzwalacze zostaną zaktualizowane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, wyzwalacze nieobecne w importowanych danych zostaną usunięte z bazy danych; domyślnie: false. |
| valueMaps | object | Reguły określające sposób importowania map wartości hosta lub szablonu. Obsługiwane parametry: createMissing - (boolean) jeśli ustawiono na true, zostaną utworzone nowe mapy wartości; domyślnie: false;updateExisting - (boolean) jeśli ustawiono na true, istniejące mapy wartości zostaną zaktualizowane; domyślnie: false;deleteMissing - (boolean) jeśli ustawiono na true, mapy wartości nieobecne w importowanych danych zostaną usunięte z bazy danych; domyślnie: false. |
Zwracane wartości
(boolean) Zwraca true jeżeli importowanie się powiodło.
Przykłady
Importowanie szablonu
Zaimportuj konfigurację szablonu zawartą w ciągu XML. Jeśli w ciągu XML brakuje jakichkolwiek pozycji lub wyzwalaczy, zostaną one usunięte z bazy danych, a wszystko pozostałe pozostanie bez zmian.
{
"jsonrpc": "2.0",
"method": "configuration.import",
"params": {
"format": "xml",
"rules": {
"templates": {
"createMissing": true,
"updateExisting": true
},
"items": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"triggers": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"valueMaps": {
"createMissing": true,
"updateExisting": false
}
},
"source": "<?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><dt>Server uptime: (.*)<\/dt></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)>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
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
Źródło
CConfiguration::import() w ui/include/classes/api/services/CConfiguration.php.