triggerprototype.get

Apraksts

integer/array triggerprototype.get(object parameters)

Šī metode ļauj izgūt trigeru prototipus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Tiesības izsaukt šo metodi var atsaukt lietotāja lomas iestatījumos. Plašāku informāciju skatiet User roles.

Parametri

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

Metode atbalsta šādus parametrus.

Parameter Type Description
active flag Atgriezt tikai iespējotos trigeru prototipus, kas pieder uzraudzītiem hostiem.
discoveryids ID/array Atgriezt tikai trigeru prototipus, kas pieder norādītajiem LLD noteikumiem.
functions string/array Atgriezt tikai trigerus, kas izmanto norādītās funkcijas.

Skatiet lapu Supported functions, lai iegūtu atbalstīto funkciju sarakstu.
group string Atgriezt tikai trigeru prototipus, kas pieder hostiem vai veidnēm no hostu grupām vai veidņu grupām ar norādīto nosaukumu.
groupids ID/array Atgriezt tikai trigeru prototipus, kas pieder hostiem vai veidnēm no norādītajām hostu grupām vai veidņu grupām.
host string Atgriezt tikai trigeru prototipus, kas pieder hostiem ar norādīto nosaukumu.
hostids ID/array Atgriezt tikai trigeru prototipus, kas pieder norādītajiem hostiem.
inherited boolean Ja iestatīts uz true, atgriezt tikai trigeru prototipus, kas mantoti no veidnes.
maintenance boolean Ja iestatīts uz true, atgriezt tikai iespējotos trigeru prototipus, kas pieder hostiem tehniskās apkopes režīmā.
min_severity integer Atgriezt tikai trigeru prototipus ar smaguma pakāpi, kas ir lielāka vai vienāda ar norādīto smaguma pakāpi.
monitored flag Atgriezt tikai iespējotos trigeru prototipus, kas pieder uzraudzītiem hostiem un satur tikai iespējotus vienumus.
templated boolean Ja iestatīts uz true, atgriezt tikai trigeru prototipus, kas pieder veidnēm.
templateids ID/array Atgriezt tikai trigeru prototipus, kas pieder norādītajām veidnēm.
triggerids ID/array Atgriezt tikai trigeru prototipus ar norādītajiem ID.
expandExpression flag Izvērst funkcijas un makro trigeru izteiksmē.
selectDependencies query Atgriezt trigeru prototipus un trigerus, no kuriem trigeru prototips ir atkarīgs, dependencies īpašībā.
selectDiscoveryData query Atgriezt discoveryData īpašību ar trigeru prototipa atklāšanas objekta datiem. Trigeru prototipa atklāšanas objekts sasaista atklātu trigeru prototipu ar trigeru prototipu, no kura tas tika atklāts.

Tam ir šādas īpašības:
parent_triggerid - (ID) trigeru prototipa ID, no kura ir izveidots trigeru prototips;
status - (int) trigeru prototipa atklāšanas statuss:
0 - (noklusējums) trigeru prototips ir atklāts,
1 - trigeru prototips vairs nav atklāts;
ts_delete - (timestamp) laiks, kad tiks dzēsts trigeru prototips, kas vairs nav atklāts;
ts_disable - (timestamp) laiks, kad tiks atspējots trigeru prototips, kas vairs nav atklāts;
disable_source - (int) indikators, vai trigeru prototips tika atspējots ar LLD noteikumu vai manuāli:
0 - (noklusējums) atspējots automātiski,
1 - atspējots ar LLD noteikumu.
selectDiscoveryRule query Atgriezt LLD noteikumu, kuram pieder trigeru prototips, discoveryRule īpašībā.
selectDiscoveryRulePrototype query Atgriezt discoveryRulePrototype īpašību ar vecāko LLD noteikuma prototipu, kuram pieder trigeru prototips.
selectFunctions query Atgriezt funkcijas, kas izmantotas trigeru prototipā, functions īpašībā.

Funkciju objekti attēlo funkcijas, kas izmantotas trigeru izteiksmē, un tiem ir šādas īpašības:
functionid - (ID) funkcijas ID;
itemid - (ID) vienuma ID, kas izmantots funkcijā;
function - (string) funkcijas nosaukums;
parameter - (string) funkcijai nodotais parametrs. Vaicājuma parametrs atgrieztajā virknē tiek aizstāts ar simbolu $.
selectHostGroups query Atgriezt hostu grupas, kurām pieder trigeru prototips, hostgroups īpašībā.
selectHosts query Atgriezt hostus, kuriem pieder trigeru prototips, hosts īpašībā.
selectItems query Atgriezt vienumus un vienumu prototipus, kas izmantoti trigeru prototipā, items īpašībā.
selectTags query Atgriezt trigeru prototipa tagus tags īpašībā.
selectTemplateGroups query Atgriezt veidņu grupas, kurām pieder trigeru prototips, templategroups īpašībā.
filter object Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram.

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir vai nu viena vērtība, vai vērtību masīvs, ar ko salīdzināt.

Neatbalsta text datu tipa īpašības.

Atbalsta papildu īpašības:
host - hosta tehniskais nosaukums, kuram pieder trigeru prototips;
hostid - hosta ID, kuram pieder trigeru prototips.
limitSelects integer Ierobežo ierakstu skaitu, ko atgriež apakšatlases.

Tiek piemērots šādām apakšatlasēm:
selectHosts - rezultāti tiks kārtoti pēc host.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: triggerid, description, status, priority, discovered.
countOutput boolean Šie parametri ir aprakstīti reference commentary.
editable boolean
excludeSearch boolean
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

Iegūt trigeru prototipus no LLD noteikuma

Iegūst visus trigeru prototipus un to funkcijas no LLD noteikuma.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "triggerprototype.get",
    "params": {
        "output": "extend",
        "selectFunctions": "extend",
        "discoveryids": "22450"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13272",
            "expression": "{12598}<20",
            "description": "Free inodes is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "6ce467d05e8745409a177799bed34bb3",
            "url_name": "",
            "functions": [
                {
                    "functionid": "12598",
                    "itemid": "22454",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        },
        {
            "triggerid": "13266",
            "expression": "{13500}<20",
            "description": "Free disk space is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "74a1fc62bfe24b7eabe4e244c70dc384",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13500",
                    "itemid": "22686",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Konkrēta trigera prototipa izgūšana ar tagiem

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "triggerprototype.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17373"
        ]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17373",
            "description": "Brīvā diska vieta ir mazāka par 20% sējumā {#FSNAME}",
            "tags": [
                {
                    "tag": "volume",
                    "value": "{#FSNAME}"
                },
                {
                    "tag": "type",
                    "value": "{#FSTYPE}"
                }
            ]
        }
    ],
    "id": 1
}

Skatīt arī

Avots

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