Documentation
Table of Contents
usermacro.get
Descripción
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.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| globalmacro | flag | Devolver macros globales en lugar de macros de equipo. |
| globalmacroids | ID/array | Devolver solo las macros globales con los IDs indicados. |
| groupids | ID/array | Devolver solo las macros de equipo que pertenezcan a equipos o plantillas de los grupos de equipos o grupos de plantillas indicados. |
| hostids | ID/array | Devolver solo las macros que pertenezcan a los equipos o plantillas indicados. |
| hostmacroids | ID/array | Devolver solo las macros de equipo con los IDs indicados. |
| inherited | booleano | Si se establece en true, devolver solo las macros de usuario prototipo de equipo heredadas de una plantilla. |
| selectHostGroups | consulta | Devolver los grupos de equipos a los que pertenece la macro de equipo en la propiedad hostgroups.Se utiliza solo al recuperar macros de equipo. |
| selectHosts | consulta | Devolver los equipos a los que pertenece la macro de equipo en la propiedad hosts.Se utiliza solo al recuperar macros de equipo. |
| selectTemplateGroups | consulta | Devolver los grupos de plantillas a los que pertenece la macro de plantilla en la propiedad templategroups.Se utiliza solo al recuperar macros de plantilla. |
| selectTemplates | consulta | Devolver las plantillas a las que pertenece la macro de equipo en la propiedad templates.Se utiliza solo al recuperar macros de equipo. |
| sortfield | string/array | Ordenar el resultado por las propiedades indicadas. Valores posibles: macro. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | string/array | |
| startSearch | booleano |
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
}Recuperar macros de host para una plantilla
Recuperar las macros de host definidas para la plantilla "10265" que contengan "STATUS" en el nombre de la macro.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10265",
"search": {
"macro": "STATUS"
}
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "6709",
"hostid": "10265",
"macro": "{$APACHE.STATUS.HOST}",
"value": "",
"description": "El nombre de host o la dirección IP del host de la página de estado de Apache.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "1",
"section_name": "",
"label": "Host de estado de Apache",
"description": "Nombre de host o dirección IP del host de la página de estado de Apache.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "814",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PATH}",
"value": "server-status?auto",
"description": "La ruta URL de la página de estado de Apache.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "3",
"section_name": "",
"label": "Ruta de la página de estado de Apache",
"description": "Ruta URL de la página de estado de Apache.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "815",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PORT}",
"value": "80",
"description": "El puerto de la página de estado de Apache.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "2",
"section_name": "",
"label": "Puerto de la página de estado de Apache",
"description": "En el rango de 1 a 65535 inclusive.",
"required": "1",
"regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",
"options": []
}
},
{
"hostmacroid": "816",
"hostid": "10265",
"macro": "{$APACHE.STATUS.SCHEME}",
"value": "http",
"description": "El esquema de la solicitud, que puede ser HTTP o HTTPS.",
"type": "0",
"automatic": "0",
"config": {
"type": "2",
"priority": "4",
"section_name": "",
"label": "Esquema de solicitud",
"description": "Esquema de solicitud, que puede ser HTTP o HTTPS.",
"required": "0",
"regex": "",
"options": [
{
"value": "http",
"text": "HTTP"
},
{
"value": "https",
"text": "HTTPS"
}
]
}
}
],
"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.