Documentation
Table of Contents
template.update
説明
object template.update(object/array templates)
このメソッドで、既存のテンプレートを更新できます。
このメソッドはAdminおよびSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object/array) 更新するテンプレート プロパティ
テンプレートごとに templateid プロパティを定義する必要があります。すべてのプロパティはオプションです。 指定されたプロパティのみが更新され、他のプロパティは変更されません。
このメソッドは標準のテンプレート プロパティに加えて、次のパラメーターを受け入れます。
| パラメータ | タイプ | 説明 |
|---|---|---|
| groups | object/array | ホストグループを使用して、テンプレートが属する現在のホスト グループを置き換えます。 ホストグループには groupid プロパティが定義されている必要があります。 |
| tags | object/array | テンプレートタグを使用して、現在のテンプレート タグを置き換えます。 |
| macros | object/array | ユーザー マクロを使用して、特定のテンプレートの現在のユーザー マクロを置き換えます。 |
| templates | object/array | テンプレート を使用して、現在リンクされているテンプレートを置き換えます。リンクが渡されなかったテンプレートは、リンクのみ解除されます。 テンプレートには templateid プロパティが定義されている必要があります。 |
| templates_clear | object/array | テンプレートで指定されたテンプレートからリンクを解除してクリアします。 テンプレートには templateid プロパティが定義されている必要があります。 |
戻り値
(object) templateids プロパティの下で更新されたテンプレートの ID を含むオブジェクトを返します。
例
Changing the standard template properties
Change the technical name of the template to "Linux by Zabbix agent Custom", the visible name to "My template", and update the template description.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"host": "Linux by Zabbix agent Custom",
"name": "My template",
"description": "This is a custom Linux template."
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template groups
Replace all template groups for the given template with a different one.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"groups": [
{
"groupid": "24"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template tags
Replace all template tags with a different one.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template macros
Replace all template macros with a different one.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"macros": [
{
"macro": "{$MY_MACRO}",
"value": "new_value"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template linked templates
Unlink (without clearing) all templates from the given template and link a different one to it.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"templates": [
{
"templateid": "10087"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Clearing template linked templates
Unlink and clear the given template from a specific linked template.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"templates_clear": [
{
"templateid": "10087"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
ソース
CTemplate::update() in ui/include/classes/api/services/CTemplate.php.