usermacro.get

Apraksts

integer/array usermacro.get(object parameters)

Metode ļauj izgūt hosta un globālos makrosus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parameter Type Description
globalmacro flag Atgriezt globālos makro, nevis host makro.
globalmacroids ID/array Atgriezt tikai globālos makro ar norādītajiem ID.
groupids ID/array Atgriezt tikai host makro, kas pieder hostiem vai veidnēm no norādītajām host grupām vai veidņu grupām.
hostids ID/array Atgriezt tikai makro, kas pieder norādītajiem hostiem vai veidnēm.
hostmacroids ID/array Atgriezt tikai host makro ar norādītajiem ID.
inherited boolean Ja iestatīts uz true, atgriezt tikai host prototipa lietotāja makro, kas mantoti no veidnes.
selectHostGroups query Atgriezt host grupas, kurām host makro pieder, hostgroups īpašībā.

Izmanto tikai, izgūstot host makro.
selectHosts query Atgriezt hostus, kuriem host makro pieder, hosts īpašībā.

Izmanto tikai, izgūstot host makro.
selectTemplateGroups query Atgriezt veidņu grupas, kurām veidnes makro pieder, templategroups īpašībā.

Izmanto tikai, izgūstot veidņu makro.
selectTemplates query Atgriezt veidnes, kurām host makro pieder, templates īpašībā.

Izmanto tikai, izgūstot host makro.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: macro.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Šis parametrs ir novecojis, lūdzu, tā vietā izmantojiet selectHostGroups vai selectTemplateGroups.
Atgriezt host grupas un veidņu grupas, kurām host makro pieder, groups īpašībā.

Izmanto tikai, izgūstot host makro.

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Hosta makrosu izgūšana hostam

Izgūstiet visus hosta makrosus, kas definēti hostam "10198".

Pieprasījums:

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

Atbilde:

{
    "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
}

Globālo makrosu izgūšana

Izgūstiet visus globālos makrosus.

Pieprasījums:

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

Atbilde:

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

Avots

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