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āja lomas.

Parametri

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

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
hostids ID/array Atgriezt tikai hosts prototipus ar norādītajiem ID.
discoveryids ID/array Atgriezt tikai hosts prototipus, kas pieder norādītajiem LLD noteikumiem.
inherited boolean Ja iestatīts uz true, atgriezt tikai no veidnes mantotos vienumus.
selectDiscoveryData query Atgriezt discoveryData rekvizītu ar hosts prototipa atklāšanas objekta datiem. Hosts prototipa atklāšanas objekts sasaista atklātu hosts prototipu ar hosts prototipu, no kura tas tika atklāts.

Tam ir šādi rekvizīti:
host - (string) hosts ID;
parent_hostid - (string) hosts prototipa ID, no kura tika izveidots hosts prototips;
status - (int) hosts prototipa atklāšanas statuss:
0 - (noklusējums) hosts prototips ir atklāts,
1 - hosts prototips vairs nav atklāts;
ts_delete - (timestamp) laiks, kad hosts prototips, kas vairs netiek atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad hosts prototips, kas vairs netiek atklāts, tiks atspējots;
disable_source - (int) indikators, kas norāda, vai hosts prototipu atspējoja LLD noteikums vai manuāli:
0 - (noklusējums) atspējots automātiski,
1 - atspējoja LLD noteikums.
selectDiscoveryRule query Atgriezt discoveryRule rekvizītu ar LLD noteikumu, kuram pieder hosts prototips.
selectDiscoveryRulePrototype query Atgriezt discoveryRulePrototype rekvizītu ar vecākelementa LLD noteikuma prototipu, kuram pieder hosts prototips.
selectInterfaces query Atgriezt interfaces rekvizītu ar hosts prototipa pielāgotajām saskarnēm.
selectGroupLinks query Atgriezt groupLinks rekvizītu ar hosts prototipa grupu saitēm.
selectGroupPrototypes query Atgriezt groupPrototypes rekvizītu ar hosts prototipa grupu prototipiem.
selectInheritedTags query Atgriezt inheritedTags rekvizītu ar tagiem, kas atrodas saistītajās veidnēs.
selectMacros query Atgriezt macros rekvizītu ar hosts prototipa makro.
selectParentHost query Atgriezt parentHost rekvizītu ar hosts, kuram pieder hosts prototips.
selectTags query Atgriezt tags rekvizītu ar hosts prototipa tagiem.
selectTemplates query Atgriezt templates rekvizītu ar veidnēm, kas saistītas ar hosts prototipu.

Atbalsta count.
sortfield string/array Kārtot rezultātu pēc norādītajiem rekvizītiem.

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 šīm vērtībām:

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

Piemēri

Hostu prototipu izgūšana no LLD noteikuma

Izgūstiet visus hostu 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",
            "uuid": "051a1469d4d045cbbf818fcc843a352e",
            "flags": "2",
            "inventory_mode": "-1",
            "tags": [
                {
                    "tag": "datacenter",
                    "value": "{#DATACENTER.NAME}"
                },
                {
                    "tag": "instance-type",
                    "value": "{#INSTANCE_TYPE}"
                }
            ],
            "groupLinks": [
                {
                    "group_prototypeid": "4",
                    "hostid": "10092",
                    "groupid": "7",
                    "templateid": "0"
                }
            ],
            "groupPrototypes": [
                {
                    "group_prototypeid": "7",
                    "hostid": "10092",
                    "name": "{#CLUSTER.NAME}",
                    "templateid": "0"
                }
            ],
            "interfaces": [
                {
                    "main": "1",
                    "type": "2",
                    "useip": "1",
                    "ip": "127.0.0.1",
                    "dns": "",
                    "port": "161",
                    "available": "0",
                    "error": "",
                    "errors_from": "0",
                    "disable_until": "0",
                    "details": {
                        "version": "2",
                        "bulk": "1",
                        "community": "{$SNMP_COMMUNITY}",
                        "max_repetitions": "10",
                        "retries": "5"
                    }
                }
            ]
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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