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. Atļaujas izsaukt šo metodi var tikt atsauktas 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.

Parametrs Tips Apraksts
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 vienumus, kas mantoti no veidnes.
selectDiscoveryData query Atgriezt discoveryData īpašību ar hosta prototipa atklāšanas objekta datiem. Hosta prototipa atklāšanas objekts sasaista 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 tika izveidots;
status - (int) hosta prototipa atklāšanas statuss:
0 - (noklusējums) hosta prototips ir atklāts,
1 - hosta prototips vairs netiek atklāts;
ts_delete - (timestamp) laiks, kad hosta prototips, kas vairs netiek atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad hosta prototips, kas vairs netiek 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 Atgriezt discoveryRule īpašību ar LLD noteikumu, kuram pieder hosta prototips.
selectDiscoveryRulePrototype query Atgriezt discoveryRulePrototype īpašību ar vecāka LLD noteikuma prototipu, 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.
selectInheritedTags query Atgriezt inheritedTags īpašību ar birkām, kas atrodas piesaistītajās veidnēs.
selectMacros query Atgriezt macros īpašību ar hosta prototipa makrosiem.
selectParentHost query Atgriezt parentHost īpašību ar hostu, kuram pieder hosta prototips.
selectTags query Atgriezt tags īpašību ar hosta prototipa birkām.
selectTemplates query Atgriezt templates īpašību ar veidnēm, kas piesaistītas hosta prototipam.

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ā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 šī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 kārtulas

Izgūst visus hostu prototipus, to grupu saites, grupu prototipus un birkas no LLD kārtulas.

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"
                    }
                }
            ]
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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