[comment]: # translation:outdated

[comment]: # ({31d5554a-31d5554a})
# hostprototype.get

[comment]: # ({/31d5554a-31d5554a})

[comment]: # ({d1534f8a-d1534f8a})
### Descrição

`integer/array hostprototype.get(object parameters)`

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

::: noteclassic
Este método está disponível para usuários de qualquer tipo. Permissões
para chamar o método pode ser revogado nas configurações de função do usuário. Veja [Usuário
funções](/manual/web_interface/frontend_sections/administration/user_roles)
Para maiores informações.
:::

[comment]: # ({/d1534f8a-d1534f8a})

[comment]: # ({0d6ab1f2-0d6ab1f2})
### Parâmetros

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

O método oferece suporte aos seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|---------|----------------------------------- ------------|-----------|
|hostids|string/array|Retorna apenas protótipos de host com os IDs fornecidos.|
|discoveryids|string/array|Retorna apenas o protótipo do host que pertence às regras LLD fornecidas.|
|inherited|boolean|Se definido como `true`, retornará apenas itens herdados de um modelo.|
|selectDiscoveryRule|query|Retorne uma propriedade [discoveryRule](/manual/api/reference/discoveryrule/object#lld_rule) com a regra LLD à qual o protótipo do host pertence.|
|selectInterfaces|query|Retorne uma propriedade [interfaces](/manual/api/reference/hostprototype/object#custom_interface) com interfaces customizadas de protótipo de host.|
|selectGroupLinks|query|Retorne uma propriedade [groupLinks](/manual/api/reference/hostprototype/object#group_link) com os links de grupo do protótipo do host.|
|selectGroupPrototypes|query|Retorne uma propriedade [groupPrototypes](/manual/api/reference/hostprototype/object#group_prototype) com os protótipos de grupo do protótipo do host.|
|selectMacros|query|Retorne uma propriedade [macros](/manual/api/reference/usermacro/object) com macros de protótipo de host.|
|selectParentHost|query|Retorne uma propriedade [parentHost](/manual/api/reference/host/object) com o host ao qual o protótipo do host pertence.|
|selectTags|query|Retorne uma propriedade [tags](/manual/api/reference/hostprototype/object#host_prototype_tag) com tags de protótipo do host.|
|selectTemplates|query|Retorne uma propriedade [templates](/manual/api/reference/template/object) com os modelos vinculados ao protótipo do host.<br><br>Suporta `count`.|
|sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `hostid`, `host`, `name` e `status`.|
|countOutput|boolean|Estes parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes na página [Informações genéricas da API Zabbix](/manual/api/reference_commentary#common_get_method_parameters).|
|editável|booleano|^|
|excludePesquisa|boolean|^|
|filtro|objeto|^|
|limite|inteiro|^|
|saída|consulta|^|
|preservekeys|boolean|^|
|pesquisar|objeto|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|ordem de classificação|cadeia/matriz|^|
|startSearch|boolean|^|

[comment]: # ({/0d6ab1f2-0d6ab1f2})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(integer/array)` Retorna:

- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro `countOutput` tiver
    sido usado.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({a91c8b17-a91c8b17})
#### Recuperando protótipos de host de uma regra LLD

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

Solicitação:

``` {.java}
{
    "jsonrpc": "2.0",
    "método": "hostprototype.get",
    "parâmetros": {
        "saída": "estender",
        "selectInterfaces": "extender",
        "selectGroupLinks": "estender",
        "selectGroupPrototypes": "estender",
        "selectTags": "estender",
        "discoveryids": "23554"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Resposta:

``` {.java}
{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "hostid": "10092",
            "host": "{#HV.UUID}",
            "name": "{#HV.UUID}",
            "estado": "0",
            "templateid": "0",
            "descobrir": "0",
            "custom_interfaces": "1",
            "inventory_mode": "-1",
            "groupLinks": [
                {
                    "group_prototypeid": "4",
                    "hostid": "10092",
                    "groupid": "7",
                    "templateid": "0"
                }
            ],
            "grupoProtótipos": [
                {
                    "group_prototypeid": "7",
                    "hostid": "10092",
                    "name": "{#CLUSTER.NAME}",
                    "templateid": "0"
                }
            ],
            "Tag": [
                {
                    "tag": "Datacenter",
                    "valor": "{#DATACENTER.NAME}"
                },
                {
                    "tag": "Tipo de instância",
                    "valor": "{#INSTANCE_TYPE}"
                }
            ],
            "interfaces": [
                {
                    "principal": "1",
                    "tipo 2",
                    "useip": "1",
                    "ip": "127.0.0.1",
                    "dns": "",
                    "porta": "161",
                    "detalhes": {
                        "versão 2",
                        "em massa": "1",
                        "community": "{$SNMP_COMMUNITY}"
                    }
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/a91c8b17-a91c8b17})

[comment]: # ({749ec170-749ec170})
### Veja também

- [Link do grupo](object#group_link)
- [Protótipo do grupo](object#group_prototype)
-   [Do utilizador
    macro](/manual/api/reference/usermacro/object#hosttemplate_level_macro)

[comment]: # ({/749ec170-749ec170})

[comment]: # ({437ab274-437ab274})
### Fonte

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

[comment]: # ({/437ab274-437ab274})