usermacro.get

Descripción

integer/array usermacro.get(object parameters)

El método permite recuperar macros de equipo y globales según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parameter Type Description
globalmacro flag Devuelve macros globales en lugar de macros de host.
globalmacroids ID/array Devuelve solo macros globales con los IDs dados.
groupids ID/array Devuelve solo macros de host que pertenecen a hosts o templates de los grupos de host o grupos de template dados.
hostids ID/array Devuelve solo macros que pertenecen a los hosts o templates dados.
hostmacroids ID/array Devuelve solo macros de host con los IDs dados.
inherited boolean Si se establece en true, devuelve solo macros de usuario de prototipo de host heredadas de un template.
selectHostGroups query Devuelve los grupos de host 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 template a los que pertenece la macro de template en la propiedad templategroups.

Se usa solo al recuperar macros de template.
selectTemplates query Devuelve los templates a los que pertenece la macro de host en la propiedad templates.

Se usa solo al recuperar macros de host.
sortfield string/array Ordena el resultado por las propiedades dadas.

Valores posibles: macro.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Este parámetro está obsoleto; use selectHostGroups o selectTemplateGroups en su lugar.
Devuelve los grupos de host y grupos de template a los que pertenece la macro de host en la propiedad groups.

Se usa solo al recuperar macros de host.

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar macros de equipo para un equipo

Recuperar 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
}

Recuperar macros globales

Recuperar 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.