usermacro.get

説明

integer/array usermacro.get(object parameters)

このメソッドでは、指定されたパラメータに従ってホストマクロおよびグローバルマクロを取得できます。

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

パラメータ

(object) 必要な出力を定義するパラメータです。

このメソッドは以下のパラメータをサポートしています。

パラメータ 型 説明
globalmacro flag ホストマクロの代わりにグローバルマクロを返します。
globalmacroids ID/array 指定したIDを持つグローバルマクロのみを返します。
groupids ID/array 指定したホストグループまたはテンプレートグループのホストまたはテンプレートに属するホストマクロのみを返します。
hostids ID/array 指定したホストまたはテンプレートに属するマクロのみを返します。
hostmacroids ID/array 指定したIDを持つホストマクロのみを返します。
inherited boolean true に設定した場合、テンプレートから継承されたホストプロトタイプユーザーマクロのみを返します。
selectHostGroups query ホストマクロが属するホストグループを hostgroups プロパティで返します。

ホストマクロを取得する場合にのみ使用されます。
selectHosts query ホストマクロが属するホストを hosts プロパティで返します。

ホストマクロを取得する場合にのみ使用されます。
selectTemplateGroups query テンプレートマクロが属するテンプレートグループを templategroups プロパティで返します。

テンプレートマクロを取得する場合にのみ使用されます。
selectTemplates query ホストマクロが属するテンプレートを templates プロパティで返します。

ホストマクロを取得する場合にのみ使用されます。
sortfield string/array 指定したプロパティで結果をソートします。

指定可能な値: macro。
countOutput boolean これらのパラメータについては、リファレンス解説 を参照してください。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(非推奨)		 query このパラメータは非推奨です。代わりに selectHostGroups または selectTemplateGroups を使用してください。
groups プロパティで、ホストマクロが属するホストグループおよびテンプレートグループを返します。

ホストマクロを取得する場合にのみ使用されます。

戻り値

(integer/array) 次のいずれかを返します:

  • オブジェクトの配列
  • countOutputパラメータが使用されている場合、取得されたオブジェクトの数

例

ホストのホストマクロを取得する

ホスト「10198」に定義されているすべてのホストマクロを取得します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10198"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostmacroid": "9",
            "hostid": "10198",
            "macro": "{$INTERFACE}",
            "value": "eth0",
            "description": "",
            "type": "0",
            "automatic": "0"
        },
        {
            "hostmacroid": "11",
            "hostid": "10198",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0",
            "automatic": "0"
        }
    ],
    "id": 1
}

グローバルマクロの取得

すべてのグローバルマクロを取得します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "globalmacro": true
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "globalmacroid": "6",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0"
        }
    ],
    "id": 1
}

ソース

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