Table of Contents
hostprototype.update
Descrição
object hostprototype.update(object/array hostPrototypes)
Este método permite atualizar protótipos de host existentes.
Este método está disponível apenas para os tipos de usuário Admin e Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.
Parâmetros
(object/array) Propriedades do protótipo de host a serem atualizadas.
A propriedade hostid deve ser definida para cada protótipo de host, todas as outras propriedades são opcionais. Somente as propriedades passadas serão atualizadas, todas as outras permanecerão inalteradas.
Além das propriedades padrão do protótipo de host, o método aceita os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| groupLinks | array | Vínculos de grupo para substituir os vínculos de grupo atuais no protótipo de host. Comportamento do parâmetro: - somente leitura para objetos herdados |
| groupPrototypes | array | Protótipos de grupo para substituir os protótipos de grupo existentes no protótipo de host. Todos os protótipos de grupo que não estiverem listados na solicitação serão removidos. Comportamento do parâmetro: - somente leitura para objetos herdados |
| macros | object/array | Macros de usuário para substituir as macros de usuário atuais. Todas as macros que não estiverem listadas na solicitação serão removidas. |
| tags | object/array | Tags do protótipo de host para substituir as tags atuais. Todas as tags que não estiverem listadas na solicitação serão removidas. Comportamento do parâmetro: - somente leitura para objetos herdados |
| interfaces | object/array | Interfaces customizadas do protótipo de host para substituir as interfaces atuais. O objeto de interface customizada deve conter todos os seus parâmetros. Todas as interfaces que não estiverem listadas na solicitação serão removidas. Comportamento do parâmetro: - suportado se custom_interfaces do objeto protótipo de host estiver definido como "usar interfaces customizadas de protótipos de host"- somente leitura para objetos herdados |
| templates | object/array | Templates para substituir os templates atualmente vinculados. Os templates devem ter apenas a propriedade templateid definida. |
Valores de retorno
(object) Retorna um objeto contendo os IDs dos protótipos de host atualizados na propriedade hostids.
Exemplos
Desabilitando um protótipo de host
Desabilite um protótipo de host, ou seja, defina seu status como "1".
{
"jsonrpc": "2.0",
"method": "hostprototype.update",
"params": {
"hostid": "10092",
"status": 1
},
"id": 1
}Resposta:
Atualizando tags de protótipos de host
Substitua as tags do protótipo de host por novas.
{
"jsonrpc": "2.0",
"method": "hostprototype.update",
"params": {
"hostid": "10092",
"tags": [
{
"tag": "datacenter",
"value": "{#DATACENTER.NAME}"
},
{
"tag": "instance-type",
"value": "{#INSTANCE_TYPE}"
}
]
},
"id": 1
}Resposta:
Atualizando interfaces personalizadas de protótipos de host
Substitua as interfaces herdadas por interfaces personalizadas de protótipos de host.
{
"jsonrpc": "2.0",
"method": "hostprototype.update",
"params": {
"hostid": "10092",
"custom_interfaces": "1",
"interfaces": [
{
"main": "1",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}"
}
}
]
},
"id": 1
}Resposta:
Veja também
- Vínculo de grupo
- Protótipo de grupo
- Tag de protótipo de host
- Interface personalizada
- Macro de usuário
Fonte
CHostPrototype::update() em ui/include/classes/api/services/CHostPrototype.php.