hostprototype.get

Опис

integer/array hostprototype.get(object parameters)

Метода омогућава преузимање прототипова домаћина према датим параметрима.

Ова метода је доступна корисницима било ког типа. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Userroles за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter	Type	Опис
hostids	ID/array	Врати само прототипове домаћина са датим ID-ијевима.
discoveryids	ID/array	Врати само прототипове домаћина који припадају датим LLD правилима.
inherited	boolean	Ако је подешено на `true` врати само ставке наслеђене из шаблона.
selectDiscoveryRule	query	Врати својство `discoveryRule` са LLD правилом коме припада прототип домаћина.
selectInterfaces	query	Врати својство `interfaces` са прилагођеним интерфејсима прототипа домаћина.
selectGroupLinks	query	Врати `groupLinks` својство са групним везама прототипа домаћина.
selectGroupPrototypes	query	Врати својство `groupPrototypes` са прототиповима групе прототипа домаћина.
selectMacros	query	Врати својство `macros` са макроима прототипа домаћина.
selectParentHost	query	Врати `parentHost` својство са домаћином којем припада прототип домаћина.
selectTags	query	Врати својство `tags` са ознакама прототипа домаћина.
selectTemplates	query	Врати својство `templates` са шаблонима повезаним са прототипом домаћина. Подржава `count`.
sortfield	string/array	Сортирај резултат према датим својствима. Могуће вредности: `hostid`, `host`, `name`, `status`.
countOutput	boolean	Ови параметри су заједничке за све методе `get` су детаљно описане у reference commentary.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Повратне вредности

(integer/array) Враћа било:

низ објеката;
број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање прототипова домаћина из LLD правила

Преузми све прототипове домаћина, њихове групне везе, прототипове група и ознаке из LLD правила.

Request:

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

Одговор:

{
            "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
       }

Такође погледајте

Извор

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

Documentation