configuration.importcompare

Opis

array configuration.importcompare(object parameters)

Ta metoda pozwala na porównanie importowanego pliku z aktualnymi elementami systemu i pokazuje, co zostanie zmienione, jeśli ten plik importu zostanie zaimportowany.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.

Parametry

(object) Parametry zawierające możliwe dane do zaimportowania i reguły postępowania z danymi.

Parametr	Typ	Opis
format (wymagane)	string	Format serializowanego ciągu znaków. Możliwe wartości: `yaml` - YAML; `xml` - XML; `json` - JSON.
source (wymagane)	string	Serializowany ciąg znaków zawierający dane konfiguracyjne.
rules (wymagane)	object	Reguły dotyczące sposobu importowania nowych i istniejących obiektów. Parametr `rules` jest szczegółowo opisany w poniższej tabeli.

Jeśli nie zostaną podane żadne reguły, nie będzie czego aktualizować, a wynik będzie pusty.

Porównanie zostanie przeprowadzone tylko dla grup hostów i szablonów. Wyzwalacze i wykresy będą porównywane tylko dla zaimportowanych szablonów, a inne będą traktowane jako "nowe".

Obiekt rules obsługuje następujące parametry.

Parametr	Typ	Opis
discoveryRules	object	Reguły importowania reguł LLD. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe reguły LLD zostana stworzone; Domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące reguły LLD zostaną zaktualizowane; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne reguły LLD w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`.
graphs	object	Reguły importowania wykresów. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe wykresy zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące wykresy zostaną zaktualizowane; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne wykresy w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`.
groups	object	Reguły importowania grup hostów. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe grupy hostów zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące grupy hostów zostaną zaktualizowane; domyślnie: `false`.
hosts	object	Reguły importowania hostów. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe hosty zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące hosty zostaną zaktualizowane; domyślnie: `false`. Ten parametr nie ma wpływu na wynik. Jest to dozwolone tylko dla zachowania spójności z `configuration.import`.
httptests	object	Reguły importowania scenariuszy WWW. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe scenariusze WWW zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące scenariusze WWW zostaną zaktualizowane; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne scenariusze WWW w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`.
images	object	Reguły importowania obrazów. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe obrazy zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące obrazy zostaną zaktualizowane; domyślnie: `false`. Ten parametr nie ma wpływu na wynik. Jest to dozwolone tylko dla zachowania spójności z `configuration.import`.
items	object	Reguły importowania pozycji. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe pozycje zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące pozycje zostaną zaktualizowane; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne pozycje w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`.
maps	object	Reguły importowania map. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe mapy zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące mapy zostaną zaktualizowane; domyślnie: `false`. Ten parametr nie ma wpływu na wynik. Jest to dozwolone tylko dla zachowania spójności z `configuration.import`.
mediaTypes	object	Reguły importowania typów mediów. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe typy mediów zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące typy mediów zostaną zaktualizowane; domyślnie: `false`. Ten parametr nie ma wpływu na wynik. Jest to dozwolone tylko dla zachowania spójności z `configuration.import`.
templateLinkage	object	Reguły importowania szablonów powiązanych. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe powiązania pomiędzy szablonami i hostami zostaną stworzone; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne powiązania szablonów w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`. Ten parametr nie ma wpływu na wynik. Jest to dozwolone tylko dla zachowania spójności z `configuration.import`.
templates	object	Reguły importowania szablonów. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe szablony zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące szablony zostaną zaktualizowane; domyślnie: `false`.
templateDashboards	object	Reguły importowania pulpitów szablonów. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe pulpity szablonów zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące pulpity szablonów zostaną zaktualizowane; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne pulpity szablonów w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`.
triggers	object	Reguły importowania wyzwalaczy. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe wyzwalacze zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące wyzwalacze zostaną zaktualizowane; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne wyzwalacze w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`.
valueMaps	object	Reguły importowania mapowania wartości hosta lub szablonu. Obsługiwane parametry: `createMissing` - `(boolean)` jeśli ustawione na `true`, nowe mapowania wartości zostaną stworzone; domyślnie: `false`; `updateExisting` - `(boolean)` jeśli ustawione na `true`, istniejące mapowania wartości zostaną zaktualizowane; domyślnie: `false`; `deleteMissing` - `(boolean)` jeśli ustawione na `true`, nieobecne mapowania wartości w importowanych danych zostaną usunięte z bazy danych; domyślnie: `false`.

Zwracane wartości

(array) Zwraca tablicę ze zmianamy w konfiguracji, które zostaną wprowadzone.

Przykłady

Porównanie importu szablonu

Porównaj szablon zawarty w łańcuchu XML z obecnymi elementami systemu oraz pokaż, co zostanie zmienione, jeżeli ten szablon zostanie zaimportowany.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "configuration.importcompare",
           "params": {
               "format": "xml",
               "rules": {
                   "discoveryRules": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "graphs": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "groups": {
                       "createMissing": true,
                       "updateExisting": true
                   },
                   "httptests": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "items": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "templateLinkage": {
                       "createMissing": true,
                       "deleteMissing": true
                   },
                   "templates": {
                       "createMissing": true,
                       "updateExisting": true
                   },
                   "templateDashboards": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "triggers": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "valueMaps": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   }
               },
               "source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:30:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></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><delay>3m</delay></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>648006da5971424ead0c47ddbbf1ea2e</uuid><name>CPU utilization</name><key>system.cpu.util</key><value_type>FLOAT</value_type><units>%</units><triggers><trigger><uuid>736225012c534ec480c2a66a91322ce0</uuid><expression>avg(/New template/system.cpu.util,3m)>70</expression><name>CPU utilization too high on 'New 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"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": {
               "templates": {
                   "updated": [
                       {
                           "before": {
                               "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
                               "template": "New template",
                               "name": "New template"
                           },
                           "after": {
                               "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
                               "template": "New template",
                               "name": "New template"
                           },
                           "items": {
                               "added": [
                                   {
                                       "after": {
                                           "uuid": "648006da5971424ead0c47ddbbf1ea2e",
                                           "name": "CPU utilization",
                                           "key": "system.cpu.util",
                                           "value_type": "FLOAT",
                                           "units": "%"
                                       },
                                       "triggers": {
                                           "added": [
                                               {
                                                   "after": {
                                                       "uuid": "736225012c534ec480c2a66a91322ce0",
                                                       "expression": "avg(/New template/system.cpu.util,3m)>70",
                                                       "name": "CPU utilization too high on 'New host' for 3 minutes",
                                                       "priority": "WARNING"
                                                   }
                                               }
                                           ]
                                       }
                                   }
                               ],
                               "removed": [
                                   {
                                       "before": {
                                           "uuid": "6805d4c39a624a8bab2cc8ab63df1ab3",
                                           "name": "CPU load",
                                           "key": "system.cpu.load",
                                           "value_type": "FLOAT"
                                       },
                                       "triggers": {
                                           "removed": [
                                               {
                                                   "before": {
                                                       "uuid": "ab4c2526c2bc42e48a633082255ebcb3",
                                                       "expression": "avg(/New template/system.cpu.load,3m)>2",
                                                       "name": "CPU load too high on 'New host' for 3 minutes",
                                                       "priority": "WARNING"
                                                   }
                                               }
                                           ]
                                       }
                                   }
                               ],
                               "updated": [
                                   {
                                       "before": {
                                           "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
                                           "name": "Zabbix agent ping",
                                           "key": "agent.ping"
                                       },
                                       "after": {
                                           "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
                                           "name": "Zabbix agent ping",
                                           "key": "agent.ping",
                                           "delay": "3m"
                                       }
                                   }
                               ]
                           }
                       }
                   ]
               }
           },
           "id": 1
       }

Źródło

CConfiguration::importcompare() w ui/include/classes/api/services/CConfiguration.php.

Documentation