usermacro.createglobal

説明

object usermacro.createglobal(object/array globalMacros)

このメソッドを使用すると、新しいグローバルマクロを作成できます。

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

パラメータ

(object/array) 作成するグローバルマクロ。

このメソッドは、標準のグローバルマクロのプロパティを持つグローバルマクロを受け付けます。

戻り値

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

例

グローバルマクロの作成

値が "public" のグローバルマクロ {$SNMP_COMMUNITY} を作成します。

Request:

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

Response:

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

ソース

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