hostprototype.get

Apraksts

integer/array hostprototype.get(object parameters)

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

Parametri

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

Metode atbalsta šādus parametrus.

Parameter Type Description
hostids ID/array Atgriež tikai hostu prototipus ar norādītajiem ID.
discoveryids ID/array Atgriež tikai hostu prototipus, kas pieder norādītajiem LLD noteikumiem.
inherited boolean Ja iestatīts uz true, atgriež tikai vienumus, kas mantoti no veidnes.
selectDiscoveryData query Atgriež discoveryData īpašību ar hosta prototipa atklāšanas objekta datiem. Hosta prototipa atklāšanas objekts saista atklātu hosta prototipu ar hosta prototipu, no kura tas tika atklāts.

Tam ir šādas īpašības:
host - (string) hosta ID;
parent_hostid - (string) hosta prototipa ID, no kura hosta prototips ir izveidots;
status - (int) hosta prototipa atklāšanas statuss:
0 - (noklusējums) hosta prototips ir atklāts,
1 - hosta prototips vairs nav atklāts;
ts_delete - (timestamp) laiks, kad hosta prototips, kas vairs nav atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad hosta prototips, kas vairs nav atklāts, tiks atspējots;
disable_source - (int) indikators, vai hosta 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 Atgriež discoveryRule īpašību ar LLD noteikumu, kuram pieder hosta prototips.
selectDiscoveryRulePrototype query Atgriež discoveryRulePrototype īpašību ar vecāko LLD noteikuma prototipu, kuram pieder hosta prototips.
selectInterfaces query Atgriež interfaces īpašību ar hosta prototipa pielāgotajām saskarnēm.
selectGroupLinks query Atgriež groupLinks īpašību ar hosta prototipa grupu saitēm.
selectGroupPrototypes query Atgriež groupPrototypes īpašību ar hosta prototipa grupu prototipiem.
selectMacros query Atgriež macros īpašību ar hosta prototipa makro.
selectParentHost query Atgriež parentHost īpašību ar hostu, kuram pieder hosta prototips.
selectTags query Atgriež tags īpašību ar hosta prototipa tagiem.
selectTemplates query Atgriež templates īpašību ar veidnēm, kas saistītas ar hosta prototipu.

Atbalsta count.
sortfield string/array Kārto rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: hostid, host, name, status, discovered.
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 šiem:

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

Piemēri

Host prototipu izgūšana no LLD noteikuma

Izgūt visus host prototipus, to grupu saites, grupu prototipus un tagus no LLD noteikuma.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "hostprototype.get",
    "params": {
        "output": "extend",
        "selectInterfaces": "extend",
        "selectGroupLinks": "extend",
        "selectGroupPrototypes": "extend",
        "selectTags": "extend",
        "discoveryids": "23554"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10092",
            "host": "{#HV.UUID}",
            "name": "{#HV.UUID}",
            "status": "0",
            "templateid": "0",
            "flags": "2",
            "discover": "0",
            "custom_interfaces": "1",
            "inventory_mode": "-1",
            "groupLinks": [
                {
                    "group_prototypeid": "4",
                    "hostid": "10092",
                    "groupid": "7",
                    "templateid": "0"
                }
            ],
            "groupPrototypes": [
                {
                    "group_prototypeid": "7",
                    "hostid": "10092",
                    "name": "{#CLUSTER.NAME}",
                    "templateid": "0"
                }
            ],
            "tags": [
                {
                    "tag": "datacenter",
                    "value": "{#DATACENTER.NAME}"
                },
                {
                    "tag": "instance-type",
                    "value": "{#INSTANCE_TYPE}"
                }
            ],
            "interfaces": [
                {
                    "main": "1",
                    "type": "2",
                    "useip": "1",
                    "ip": "127.0.0.1",
                    "dns": "",
                    "port": "161",
                    "details": {
                        "version": "2",
                        "bulk": "1",
                        "community": "{$SNMP_COMMUNITY}",
                        "max_repetitions": "10"
                    }
                }
            ]
        }
    ],
    "id": 1
}

Skatīt arī

Avots

CHostPrototype::get() iekš ui/include/classes/api/services/CHostPrototype.php.