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 host.
globalmacroids string/array Devuelve sólo macros globales con los ID proporcionados.
groupids cadena/matriz Devuelve solo macros de host que pertenecen a hosts o plantillas de los grupos de hosts dados.
hostids cadena/matriz Devuelve sólo macros que pertenecen a los hosts o plantillas dados.
hostmacroids string/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.
selectGroups query Devuelve los grupos de hosts a los que pertenece la macro de host en la propiedad groups.

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

Valor posible: 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
límite entero
salida consulta
preservekeys booleano
buscar objeto
searchByAny booleano
searchWildcardsEnabled booleano
clasificación cadena/matriz
iniciarBuscar booleano

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 de 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"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Respuesta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostmacroid": "9",
            "hostid": "10198",
            "macro": "{$INTERFACE}",
            "value": "eth0",
            "description": "",
            "type": "0"
        },
        {
            "hostmacroid": "11",
            "hostid": "10198",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0"
        }
    ],
    "id": 1
}

Recuperando macros globales

Recupera todas las macros globales.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "globalmacro": true
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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.