configuration.export

説明

string configuration.export(object parameters)

このメソッドは、構成データをシリアル化された文字列としてエクスポートできます。

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメータ

(object) エクスポートするオブジェクトと使用するフォーマットを定義するパラメータ。

パラメータ	型	説明
format	string	データをエクスポートするフォーマット。指定可能な値: `yaml` - YAML; `xml` - XML; `json` - JSON; `raw` - 未加工のPHP配列。パラメータの動作: - 必須
prettyprint	boolean	インデントを追加して出力をより人間が読みやすくする。指定可能な値: `true` - インデントを追加; `false` - (デフォルト) インデントを追加しない。
options	object	エクスポートするオブジェクト。 `options`オブジェクトには以下のパラメータがある: `host_groups` - `(array)` エクスポートするホストグループのID; `hosts` - `(array)` エクスポートするホストのID; `images` - `(array)` エクスポートするイメージのID; `maps` - `(array)` エクスポートするマップのID; `mediaTypes` - `(array)` エクスポートするメディアタイプのID; `template_groups` - `(array)` エクスポートするテンプレートグループのID; `templates` - `(array)` エクスポートするテンプレートのID。 AdminおよびUserタイプのユーザーは、読み取り専用または読み書きの権限を持つオブジェクトおよびイメージのみエクスポートでき、メディアタイプはエクスポートできません。パラメータの動作: - 必須

戻り値

(string) 要求された構成データを含むシリアル化された文字列を返します。

例

テンプレートのエクスポート

テンプレート "10571" の設定をXML文字列としてエクスポートします。

リクエスト:

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

レスポンス:

{
           "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
       }

ソース

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

Documentation

configuration.export

説明

パラメータ

戻り値

例

テンプレートのエクスポート

ソース