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 Devuelve macros globales en lugar de macros de equipo.
globalmacroids string/array Devuelve sólo macros globales con los ID proporcionados.
groupids cadena/matriz Devuelve solo macros de equipo que pertenecen a equipos o plantillas de los grupos de hosts o grupos de plantillas dados.
hostids cadena/matriz Devuelve solo macros que pertenecen a los equipos o plantillas dados.
hostmacroids cadena/matriz Devuelve sólo macros de equipo con los ID proporcionados.
inherited booleano Si se establece en "verdadero", devuelve solo las macros de usuario del prototipo de equipo heredadas de una plantilla.
selectHostGroups query Devuelve los grupos de hosts a los que pertenece la macro de equipo en la propiedad hostgroups.

Se usa solo al recuperar macros de equipo.
selectHosts query Devuelve los equipos a los que pertenece la macro de equipo en la propiedad hosts.

Se usa solo al recuperar macros de equipo.
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 equipo 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 booleano 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
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch booleano
selectGroups
(obsoleto)
query Este parámetro está obsoleto; utilice selectHostGroups o selectTemplateGroups en su lugar.
Devuelva los grupos de equipos y los grupos de plantillas a los que pertenece la macro de equipo en la propiedad groups.< br>
Se utiliza sólo al recuperar macros de equipos.

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.