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.

Parametrs Tips Apraksts
globalmacro flag Atgriezt globālos makrosus hosts makrosu vietā.
globalmacroids ID/array Atgriezt tikai globālos makrosus ar norādītajiem ID.
groupids ID/array Atgriezt tikai hosts makrosus, kas pieder hostiem vai veidnēm no norādītajām hostu grupām vai veidņu grupām.
hostids ID/array Atgriezt tikai makrosus, kas pieder norādītajiem hostiem vai veidnēm.
hostmacroids ID/array Atgriezt tikai hosts makrosus ar norādītajiem ID.
inherited boolean Ja iestatīts uz true, atgriezt tikai hosts prototipa lietotāja makrosus, kas mantoti no veidnes.
selectHostGroups query Atgriezt hostu grupas, kurām hosts makross pieder, īpašībā hostgroups.

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

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

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

Izmanto tikai, izgūstot hosts makrosus.
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

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
}

Hosta makrosu izgūšana veidnei

Izgūstiet hostam definētos makrosus veidnei "10265", kuru makrosa nosaukumā ir "STATUS".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10265",
        "search": {
            "macro": "STATUS"
        }
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostmacroid": "6709",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.HOST}",
            "value": "",
            "description": "Apache statusa lapas hosta resursdatora nosaukums vai IP adrese.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "1",
                "priority": "1",
                "section_name": "",
                "label": "Apache statusa hosts",
                "description": "Apache statusa lapas hosta resursdatora nosaukums vai IP adrese.",
                "required": "1",
                "regex": "",
                "options": []
            }
        },
        {
            "hostmacroid": "814",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.PATH}",
            "value": "server-status?auto",
            "description": "Apache statusa lapas URL ceļš.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "1",
                "priority": "3",
                "section_name": "",
                "label": "Apache statusa lapas ceļš",
                "description": "Apache statusa lapas URL ceļš.",
                "required": "1",
                "regex": "",
                "options": []
            }
        },
        {
            "hostmacroid": "815",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.PORT}",
            "value": "80",
            "description": "Apache statusa lapas ports.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "1",
                "priority": "2",
                "section_name": "",
                "label": "Apache statusa lapas ports",
                "description": "Diapazonā no 1 līdz 65535 ieskaitot.",
                "required": "1",
                "regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",
                "options": []
            }
        },
        {
            "hostmacroid": "816",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.SCHEME}",
            "value": "http",
            "description": "Pieprasījuma shēma, kas var būt HTTP vai HTTPS.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "2",
                "priority": "4",
                "section_name": "",
                "label": "Pieprasījuma shēma",
                "description": "Pieprasījuma shēma, kas var būt HTTP vai HTTPS.",
                "required": "0",
                "regex": "",
                "options": [
                    {
                        "value": "http",
                        "text": "HTTP"
                    },
                    {
                        "value": "https",
                        "text": "HTTPS"
                    }
                ]
            }
        }
    ],
    "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.