usermacro.create

説明

object usermacro.create(object/array hostMacros)

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

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

パラメータ

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

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

戻り値

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

例

ホストマクロの作成

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

Request:

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

Response:

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

ソース

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