configuration.export

Opis

string configuration.export(object parameters)

Ta metoda umożliwia eksport danych konfiguracyjnych jako 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 User roles.

Parametry

(object) Parametry definiujące obiekty do wyeksportowania oraz format, którego należy użyć.

Parameter Type Description
format string Format, w jakim dane muszą zostać wyeksportowane.

Możliwe wartości:
yaml - YAML;
xml - XML;
json - JSON;
raw - nieprzetworzona tablica PHP.

Zachowanie parametru:
- required
prettyprint boolean Sprawia, że wynik jest bardziej czytelny dla człowieka poprzez dodanie wcięć.

Możliwe wartości:
true - dodaj wcięcia;
false - (domyślnie) nie dodawaj wcięć.
options object Obiekty do wyeksportowania.

Obiekt options zawiera następujące parametry:
host_groups - (array) identyfikatory grup hostów do wyeksportowania;
hosts - (array) identyfikatory hostów do wyeksportowania;
images - (array) identyfikatory obrazów do wyeksportowania;
maps - (array) identyfikatory map do wyeksportowania;
mediaTypes - (array) identyfikatory typów mediów do wyeksportowania;
template_groups - (array) identyfikatory grup szablonów do wyeksportowania;
templates - (array) identyfikatory szablonów do wyeksportowania.

Użytkownicy typu Admin i User mogą eksportować tylko te obiekty, dla których mają uprawnienia read-only lub read-write permission, a także obrazy, ale nie typy mediów.

Zachowanie parametru:
- required

Zwracane wartości

(string) Zwraca serializowany ciąg znaków zawierający żądane dane konfiguracyjne.

Przykłady

Eksportowanie szablonu

Wyeksportuj konfigurację szablonu "10571" jako ciąg XML.

Żądanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>7.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>Czas działania serwera Apache</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>Obciążenie CPU</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>Obciążenie CPU zbyt wysokie na {HOST.HOST} przez 3 minuty</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Status serwera Apache</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
}

Źródło

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