veidne.get

Apraksts

integer/array template.get(object parameters)

Šī metode ļauj izgūt veidnes 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 sadaļā Lietotāja lomas.

Parametri

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

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
templateids ID/array Atgriezt tikai veidnes ar norādītajiem veidņu ID.
groupids ID/array Atgriezt tikai veidnes, kas pieder norādītajām veidņu grupām.
parentTemplateids ID/array Atgriezt tikai veidnes, ar kurām norādītā veidne ir saistīta.
hostids ID/array Atgriezt tikai veidnes, kas ir saistītas ar norādītajiem hosts/veidnēm.
graphids ID/array Atgriezt tikai veidnes, kurās ir norādītās diagrammas.
itemids ID/array Atgriezt tikai veidnes, kurās ir norādītie vienumi.
triggerids ID/array Atgriezt tikai veidnes, kurās ir norādītie trigeri.
with_items flag Atgriezt tikai veidnes, kurās ir vienumi.
with_triggers flag Atgriezt tikai veidnes, kurās ir trigeri.
with_graphs flag Atgriezt tikai veidnes, kurās ir diagrammas.
with_httptests flag Atgriezt tikai veidnes, kurās ir tīmekļa scenāriji.
evaltype integer Tagu novērtēšanas metode.

Iespējamās vērtības:
0 - (noklusējums) And/Or;
2 - Or.
tags object/array Atgriezt tikai veidnes ar norādītajiem tagiem.
Formāts: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visas veidnes.

Iespējamās operatora vērtības:
0 - (noklusējums) Satur;
1 - Ir vienāds ar;
2 - Nesatur;
3 - Nav vienāds ar;
4 - Pastāv;
5 - Nepastāv.
inheritedTags boolean Atgriezt veidnes, kurām norādītie tags ir arī saistītajās veidnēs.

Iespējamās vērtības:
true - saistītajām veidnēm jābūt arī norādītajiem tagiem;
false - (noklusējums) saistīto veidņu tagi tiek ignorēti.
selectInheritedTags query Atgriezt inheritedTags īpašību ar tagiem, kas atrodas saistītajās veidnēs.
selectTags query Atgriezt veidnes tagus tags īpašībā.
selectDiscoveryRules query Atgriezt discoveryRules īpašību ar veidnes LLD noteikumiem.

Atbalsta count.
selectHosts query Atgriezt hosts, kas ir saistīti ar veidni, hosts īpašībā.

Atbalsta count.
selectTemplateGroups query Atgriezt veidņu grupas, kurām veidne pieder, templategroups īpašībā.
selectTemplates query Atgriezt veidnes, ar kurām norādītā veidne ir saistīta, templates īpašībā.

Atbalsta count.
selectParentTemplates query Atgriezt veidnes, kas ir saistītas ar norādīto veidni, parentTemplates īpašībā.

Atbalsta count.
selectHttpTests query Atgriezt tīmekļa scenārijus no veidnes httpTests īpašībā.

Atbalsta count.
selectItems query Atgriezt vienumus no veidnes items īpašībā.

Atbalsta count.
selectTriggers query Atgriezt trigerus no veidnes triggers īpašībā.

Atbalsta count.
selectGraphs query Atgriezt diagrammas no veidnes graphs īpašībā.

Atbalsta count.
selectMacros query Atgriezt makro no veidnes macros īpašībā.
selectDashboards query Atgriezt informācijas paneļus no veidnes dashboards īpašībā.

Atbalsta count.
selectValueMaps query Atgriezt valuemaps īpašību ar veidnes vērtību kartēm.
limitSelects integer Ierobežo apakšvaicājumos atgriezto ierakstu skaitu.

Attiecas uz šādiem apakšvaicājumiem:
selectTemplates - rezultāti tiks kārtoti pēc name;
selectHosts - kārtoti pēc host;
selectParentTemplates - kārtoti pēc host;
selectItems - kārtoti pēc name;
selectDiscoveryRules - kārtoti pēc name;
selectTriggers - kārtoti pēc description;
selectGraphs - kārtoti pēc name;
selectDashboards - kārtoti pēc name.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: hostid, host, name, status.
countOutput boolean Šie parametri ir aprakstīti atsauces komentāros.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectDiscoveries query Atgriezt zema līmeņa atklājumus no veidnes discoveries īpašībā.

Atbalsta count.

Šis vaicājums ir novecojis; tā vietā izmantojiet selectDiscoveryRules.

Atgrieztās vērtības

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

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

Piemēri

Veidņu izgūšana pēc nosaukuma

Izgūstiet visus datus par divām veidnēm ar nosaukumiem "Linux by Zabbix agent" un "Windows by Zabbix agent".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": "extend",
        "filter": {
            "host": [
                "Linux by Zabbix agent",
                "Windows by Zabbix agent"
            ]
        }
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxyid": "0",
            "host": "Linux by Zabbix agent",
            "status": "3",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "name": "Linux by Zabbix agent",
            "flags": "0",
            "templateid": "10001",
            "description": "Šī ir oficiāla Linux veidne. Tai ir nepieciešams Zabbix aģents 8.0 vai jaunāks.\r\n\r\nPiezīmes par failu sistēmas (FS) atklāšanu:\r\n- Ext4/3/2 failu sistēma rezervē vietu privileģētai lietošanai; pēc noklusējuma parasti tiek rezervēti 5%.\r\n- BTRFS pēc noklusējuma piešķir 10% no sējuma savām vajadzībām.\r\n- Lai mazinātu iespējamo katastrofu risku, FS lietojuma trigeri ir balstīti uz maksimāli pieejamo vietu.\r\n  - Izmantošanas formula: 'pused = 100 - 100 * (available / total - free + available)'\r\n- FS izmantošanas diagramma, kas iegūta no grafiku prototipiem, atspoguļo FS rezervēto vietu kā starpību starp izmantoto un pieejamo vietu no kopējā sējuma apjoma.\r\n\r\nJūs varat apspriest šo veidni vai atstāt atsauksmes mūsu forumā https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387225-discussion-thread-for-official-zabbix-template-for-linux\r\n\r\nĢenerēts ar oficiālo Zabbix veidņu rīku \"Templator\"",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": "",
            "custom_interfaces": "0",
            "uuid": "f8f7908280354f2abeed07dc788c3747",
            "vendor_name": "Zabbix",
            "vendor_version": "8.0-2",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "wizard_ready": "1",
            "readme": "## Pārskats\r\n\r\nŠī ir oficiāla Linux veidne. Tai ir nepieciešams Zabbix aģents 8.0 vai jaunāks.\r\n\r\n#### Piezīmes par failu sistēmas (FS) atklāšanu:\r\n- Ext4/3/2 FS rezervē vietu privileģētai lietošanai; pēc noklusējuma parasti tiek rezervēti 5%.\r\n- BTRFS pēc noklusējuma piešķir 10% no sējuma savām vajadzībām.\r\n- Lai mazinātu iespējamo katastrofu risku, FS lietojuma trigeri ir balstīti uz maksimāli pieejamo vietu.\r\n  - Izmantošanas formula: `pused = 100 - 100 * (available / total - free + available)`\r\n- FS izmantošanas diagramma, kas iegūta no grafiku prototipiem, atspoguļo FS rezervēto vietu kā starpību starp izmantoto un pieejamo vietu no kopējā sējuma apjoma."
        },
        {
            "proxyid": "0",
            "host": "Windows by Zabbix agent",
            "status": "3",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "name": "Windows by Zabbix agent",
            "flags": "0",
            "templateid": "10081",
            "description": "Šī ir oficiāla Windows veidne. Tai ir nepieciešams Zabbix aģents 8.0 vai jaunāks.\r\n\r\nJūs varat apspriest šo veidni vai atstāt atsauksmes mūsu forumā https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387224-discussion-thread-for-official-zabbix-template-for-windows\r\n\r\nĢenerēts ar oficiālo Zabbix veidņu rīku \"Templator\"",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": "",
            "custom_interfaces": "0",
            "uuid": "13b06904a6bf41cbb795e3193d896340",
            "vendor_name": "Zabbix",
            "vendor_version": "8.0-2",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "wizard_ready": "1",
            "readme": "## Pārskats\r\n\r\nŠī ir oficiāla Windows veidne. Tai ir nepieciešams Zabbix aģents 8.0 vai jaunāks."
        }
    ],
    "id": 1
}

Veidņu grupu izgūšana

Izgūstiet veidņu grupas, kuru dalībnieks ir veidne "Linux by Zabbix aģents".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": ["hostid"],
        "selectTemplateGroups": "extend",
        "filter": {
            "host": [
                "Linux by Zabbix agent"
            ]
        }
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "templateid": "10001",
            "templategroups": [
                {
                    "groupid": "10",
                    "name": "Templates/Operating systems",
                    "uuid": "846977d1dfed4968bc5f8bdb363285bc"
                }
            ]
        }
    ],
    "id": 1
}

Hostu izgūšana pēc veidnes

Izgūstiet hostus, kuriem ir piesaistīta veidne "10001" (Linux by Zabbix aģents).

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": "templateid",
        "templateids": "10001",
        "selectHosts": ["hostid", "name"]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "templateid": "10001",
            "hosts": [
                {
                    "hostid": "10084",
                    "name": "Zabbix server"
                },
                {
                    "hostid": "10603",
                    "name": "Host 1"
                },
                {
                    "hostid": "10604",
                    "name": "Host 2"
                }
            ]
        }
    ],
    "id": 1
}

Meklēšana pēc veidņu tagiem

Iegūstiet veidnes, kurām tags "host-name" ir vienāds ar "{HOST.NAME}".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": ["hostid"],
        "selectTags": "extend",
        "evaltype": 0,
        "tags": [
            {
                "tag": "host-name",
                "value": "{HOST.NAME}",
                "operator": 1
            }
        ]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "templateid": "10402",
            "tags": [
                {
                    "tag": "host-name",
                    "value": "{HOST.NAME}"
                }
            ]
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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