usermacro.update

説明

object usermacro.update(object/array hostMacros)

このメソッドは、既存のホストマクロを更新するためのものです。

このメソッドは 管理者 および スーパ管理者 ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

(object/array) 更新するホストマクロプロパティ

ホストマクロごとにhostmacroidプロパティを定義する必要があります。他のプロパティはすべてオプションです。渡されたプロパティのみが更新され、他のプロパティは変更されません。

戻り値

(object) hostmacroids プロパティの下で更新されたホストマクロの ID を含むオブジェクトを返します。

例

ホストマクロの値の変更

ホストマクロの値を "public" に変更します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "usermacro.update",
           "params": {
               "hostmacroid": "1",
               "value": "public"
           },
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": {
               "hostmacroids": [
                   "1"
               ]
           },
           "id": 1
       }

検出ルールによって作成されたマクロの値を変更します。

検出ルールによって作成された"自動"マクロを"手動"マクロに変換し、その値を"新しい値"に変更します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "usermacro.update",
           "params": {
               "hostmacroid": "1",
               "value": "new-value",
               "automatic": "0"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "hostmacroids": [
                   "1"
               ]
           },
           "id": 1
       }

ソース

CUserMacro::update() in ui/include/classes/api/services/CUserMacro.php.

Documentation

usermacro.update

説明

パラメータ

戻り値

例

ホストマクロの値の変更

検出ルールによって作成されたマクロの値を変更します。

ソース