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.