usermacro.createglobal

説明

object usermacro.createglobal(object/array globalMacros)

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

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

パラメータ

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

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

戻り値

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

例

グローバルマクロの作成

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

リクエスト:

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

レスポンス:

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

ソース

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

Documentation

usermacro.createglobal

説明

パラメータ

戻り値

例

グローバルマクロの作成

ソース