Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Únase a nuestro proyecto de traducción y ayude a traducir la documentación de Zabbix a su lengua materna.

module.get

Descripción

integer/array module.get(object parameters)

El método permite recuperar módulos según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Consulte 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
moduleids cadena/matriz Devuelve sólo módulos con los ID proporcionados.
sortfield cadena/matriz Ordena el resultado según las propiedades dadas.

Valores posibles: moduleid, relative_path.
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.
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch booleano

Valores de devueltos

(integer/array) Devuelve:

  • una matriz de objetos;
  • la suma de los objetos devueltos, si el parámetro countOutput está siendo usado

Ejemplos

Recuperar un módulo por ID

Recupere todos los datos sobre los módulos "1", "2" y "25".

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "module.get",
           "params": {
               "output": "extend",
               "moduleids": [
                   "1",
                   "2",
                   "25"
               ]
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "moduleid": "1",
                   "id": "actionlog",
                   "relative_path": "widgets/actionlog",
                   "status": "1",
                   "config": []
               },
               {
                   "moduleid": "2",
                   "id": "clock",
                   "relative_path": "widgets/clock",
                   "status": "1",
                   "config": []
               },
               {
                   "moduleid": "25",
                   "id": "example",
                   "relative_path": "modules/example_module",
                   "status": "1",
                   "config": []
               }
           ],
           "id": 1
       }

Ver también

Fuente

CModule::get() en ui/include/classes/api/services/CModule.php.