usermacro.createglobal

説明

object usermacro.createglobal(object/array globalMacros)

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

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

パラメータ

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

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

戻り値

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

グローバル マクロの作成

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

Request:

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

Response:

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

ソース

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