hostprototype.get

Descrição

integer/array hostprototype.get(object parameters)

O método permite recuperar protótipos de host de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Consulte Funções de usuário para obter mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
hostids ID/array Retorna somente os protótipos de host com os IDs especificados.
discoveryids ID/array Retorna somente os protótipos de host que pertencem às regras LLD especificadas.
inherited boolean Se definido como true, retorna somente os itens herdados de um template.
selectDiscoveryData query Retorna uma propriedade discoveryData com os dados do objeto de descoberta do protótipo de host. O objeto de descoberta do protótipo de host vincula um protótipo de host descoberto ao protótipo de host a partir do qual ele foi descoberto.

Ele tem as seguintes propriedades:
host - (string) ID do host;
parent_hostid - (string) ID do protótipo de host a partir do qual o protótipo de host foi criado;
status - (int) status de descoberta do protótipo de host:
0 - (padrão) o protótipo de host foi descoberto,
1 - o protótipo de host não é mais descoberto;
ts_delete - (timestamp) momento em que um protótipo de host que não é mais descoberto será excluído;
ts_disable - (timestamp) momento em que um protótipo de host que não é mais descoberto será desabilitado;
disable_source - (int) indicador de se o protótipo de host foi desabilitado por uma regra LLD ou manualmente:
0 - (padrão) desabilitado automaticamente,
1 - desabilitado por uma regra LLD.
selectDiscoveryRule query Retorna uma propriedade discoveryRule com a regra LLD à qual o protótipo de host pertence.
selectDiscoveryRulePrototype query Retorna uma propriedade discoveryRulePrototype com o protótipo de regra LLD pai ao qual o protótipo de host pertence.
selectInterfaces query Retorna uma propriedade interfaces com as interfaces personalizadas do protótipo de host.
selectGroupLinks query Retorna uma propriedade groupLinks com os vínculos de grupo do protótipo de host.
selectGroupPrototypes query Retorna uma propriedade groupPrototypes com os protótipos de grupo do protótipo de host.
selectInheritedTags query Retorna uma propriedade inheritedTags com as tags presentes nos templates vinculados.
selectMacros query Retorna uma propriedade macros com as macros do protótipo de host.
selectParentHost query Retorna uma propriedade parentHost com o host ao qual o protótipo de host pertence.
selectTags query Retorna uma propriedade tags com as tags do protótipo de host.
selectTemplates query Retorna uma propriedade templates com os templates vinculados ao protótipo de host.

Suporta count.
sortfield string/array Ordena o resultado pelas propriedades especificadas.

Valores possíveis: hostid, host, name, status, discovered.
countOutput boolean Esses parâmetros estão descritos no comentário de referência.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Retorna:

  • um array de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando protótipos de host de uma regra de LLD

Recupere todos os protótipos de host, seus vínculos de grupo, protótipos de grupo e tags de uma regra de LLD.

Solicitação:

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

Resposta:

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

Veja também

Fonte

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