usermacro.create

説明

object usermacro.create(object/array hostMacros)

このメソッドは、新しいホストマクロを作成することができます。

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

パラメータ

(object/array) 作成するホストマクロ

このメソッドは標準のホスト マクロ プロパティ を持つホストマクロを受け入れます。

戻り値

(object) hostmacroids プロパティの下で作成されたホスト マクロの ID を含むオブジェクトを返します。 返される ID の順序は、渡されたホスト マクロの順序と一致します。

例

ホストマクロの作成

ホスト"10198"で値"public"を持つホストマクロ"{$SNMP_COMMUNITY}"を作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "usermacro.create",
    "params": {
        "hostid": "10198",
        "macro": "{$SNMP_COMMUNITY}",
        "value": "public"
    },
    "id": 1
}

レスポンス:

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

ソース

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