Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

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 dados.
groupids ID/array Devolver solo las macros de equipo que pertenecen a equipos o plantillas de los grupos de equipos o grupos de plantillas dados.
hostids ID/array Devolver solo las macros que pertenecen a los equipos o plantillas dados.
hostmacroids ID/array Devolver solo las macros de equipo con los IDs dados.
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 dadas.

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
selectGroups
(obsoleto)
consulta Este parámetro está obsoleto, por favor utilice selectHostGroups o selectTemplateGroups en su lugar.
Devuelve los grupos de equipos y grupos de plantillas a los que pertenece la macro de equipo en la propiedad groups.

Se utiliza solo al recuperar macros de equipo.

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar macros de equipo para un equipo

Recupere todas las macros de equipo definidas para el equipo "10198".

Solicitud:

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

Solicitud:

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