Documentation
Table of Contents
usermacro.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array usermacro.get(object parameters)
El m¨¦todo permite recuperar macros de equipo y globales de acuerdo con los par¨¢metros dados.
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. Los permisos para llamar al m¨¦todo se puede revocar en la configuraci¨®n de roles de usuario. Ver Roles de usuario para obtener m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| globalmacro | flag | Devuelve macros globales en lugar de macros de host. |
| globalmacroids | ID/array | Devuelve s¨®lo macros globales con los ID proporcionados. |
| groupids | ID/matriz | Devuelve solo macros de host que pertenecen a hosts o plantillas de los grupos de hosts o grupos de plantillas dados. |
| hostids | ID/matriz | Devuelve s¨®lo macros que pertenecen a los hosts o plantillas dados. |
| hostmacroids | ID/array | Devuelve s¨®lo macros de host con los ID proporcionados. |
| heredado | booleano | Si se establece en "verdadero", devuelve solo las macros de usuario del prototipo de host heredadas de una plantilla. |
| selectHostGroups | query | Devuelve los grupos de hosts a los que pertenece la macro de host en la propiedad hostgroups.Se usa solo al recuperar macros de host. |
| selectHosts | query | Devuelve los hosts a los que pertenece la macro de host en la propiedad hosts.Se usa solo al recuperar macros de host. |
| selectTemplateGroups | query | Devuelve los grupos de plantillas a los que pertenece la macro de plantilla en la propiedad templategroups.Se usa solo al recuperar macros de plantilla. |
| selectTemplates | query | Devuelve las plantillas a las que pertenece la macro de host en la propiedad templates.Se usa solo al recuperar macros de host. |
| sortfield | string/array | Ordena el resultado seg¨²n las propiedades dadas. Valores posibles: macro. |
| countOutput | boolean | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en detalle en la p¨¢gina comentario de referencia. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| ±ô¨ª³¾¾±³Ù±ð | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| ³¦±ô²¹²õ¾±´Ú¾±³¦²¹³¦¾±¨®²Ô | cadena/matriz | |
| iniciarBuscar | booleano | |
| selectGroups (obsoleto) |
query | Este par¨¢metro est¨¢ obsoleto; utilice selectHostGroups o selectTemplateGroups en su lugar.Devuelva los grupos de hosts y los grupos de plantillas a los que pertenece la macro de host en la propiedad groups.< br>Se utiliza s¨®lo al recuperar macros de host. |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el par¨¢metro
countOutputha sido usado.
Ejemplos
Recuperar macros de equipo para un equipo
Recupere todas las macros de equipo definidas para el equipo "10198".
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10198"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "9",
"hostid": "10198",
"macro": "{$INTERFACE}",
"value": "eth0",
"description": "",
"type": "0",
"automatic": "0"
},
{
"hostmacroid": "11",
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0",
"automatic": "0"
}
],
"id": 1
}Recuperando macros globales
Recupera todas las macros globales.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"globalmacro": true
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"globalmacroid": "6",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0"
}
],
"id": 1
}Fuente
CUserMacro::get() en ui/include/classes/api/services/CUserMacro.php.