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 Lietotāju lomas.

Parametri

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

Metode atbalsta šādus parametrus.

Parameter Type Description
hostids ID/array Atgriezt tikai hostu prototipus ar norādītajiem ID.
discoveryids ID/array Atgriezt tikai hostu prototipus, kas pieder norādītajiem LLD noteikumiem.
inherited boolean Ja iestatīts uz true, atgriezt tikai no veidnes mantotos vienumus.
selectDiscoveryRule query Atgriezt discoveryRule īpašību ar LLD noteikumu, kuram pieder hosta prototips.
selectInterfaces query Atgriezt interfaces īpašību ar hosta prototipa pielāgotajām saskarnēm.
selectGroupLinks query Atgriezt groupLinks īpašību ar hosta prototipa grupu saitēm.
selectGroupPrototypes query Atgriezt groupPrototypes īpašību ar hosta prototipa grupu prototipiem.
selectMacros query Atgriezt macros īpašību ar hosta prototipa makro.
selectParentHost query Atgriezt parentHost īpašību ar hostu, kuram pieder hosta prototips.
selectTags query Atgriezt tags īpašību ar hosta prototipa tagiem.
selectTemplates query Atgriezt templates īpašību ar veidnēm, kas saistītas ar hosta prototipu.

Atbalsta count.
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, discovered.
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

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

Hosts prototipu izgūšana no LLD noteikuma

Izgūstiet visus hosts 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",
            "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() in ui/include/classes/api/services/CHostPrototype.php.