[comment]: # translation:outdated

[comment]: # ({cd91b3fe-cd91b3fe})
# script.get

[comment]: # ({/cd91b3fe-cd91b3fe})

[comment]: # ({96ec37bc-96ec37bc})
### Descripción

`integer/array image.get(object parameters)`

El método permite recuperar imágenes de acuerdo con los parámetros dados.

::: noteclassic
Este método está disponible para usuarios de cualquier tipo. Permisos
para activar el método se pueden revocar en la configuración de roles de usuario. Ver [User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
para más información.
:::

[comment]: # ({/96ec37bc-96ec37bc})

[comment]: # ({12625b94-c425a65a})
### Parámetros

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

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#tipos_de_datos)|Descripción|
|--|--|------|
|groupids|cadena/matriz|Devuelve sólo scripts que se pueden ejecutar en los grupos de hosts dados.|
|hostids|cadena/matriz|Devuelve sólo scripts que se pueden ejecutar en los hosts dados.|
|scriptids|cadena/matriz|Devuelve sólo scripts con los IDs proporcionados.|
|usrgrpids|cadena/matriz|Devuelve sólo scripts que pueden ser ejecutados por usuarios en los grupos de usuarios dados.|
|selectGroups|consulta|Devuelve una propiedad [groups](/manual/api/reference/hostgroup/object) con grupos de hosts en los que se puede ejecutar el script.|
|selectHosts|consulta|Devuelve una propiedad [hosts](/manual/api/reference/host/object) con hosts en los que se puede ejecutar el script.|
|selectActions|consulta|Devuelve una propiedad [actions](/manual/api/reference/action/object) con acciones a las que están asociadas el script.|
|sortfield|cadena/matriz|Ordena el resultado según las propiedades dadas.<br><br>Los valores posibles son: `scriptid` y `name`.|
|countOutput|booleano|Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en el [reference commentary](/manual/api/reference_commentary#parametros_comunes_del_metodo_get).|
|editable|booleano|^|
|excludeSearch|boolean|^|
|filter|objeto|^|
|limit|entero|^|
|output|consulta|^|
|preservekeys|booleano|^|
|search|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|sortorder|cadena/matriz|^|
|startSearch|booleano|^|

[comment]: # ({/12625b94-c425a65a})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(integer/array)` Devuelve:

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Ejemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({59acc8d9-6d428f32})
#### Recupere todos los scripts

Recupere todos los scripts configurados.

Solicitud:

```json
{
    "jsonrpc": "2.0",
    "method": "script.get",
    "params": {
        "output": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Respuesta:

```json
{
    "jsonrpc": "2.0",
    "result": [    
        {
            "scriptid": "1",
            "name": "Ping",
            "command": "/bin/ping -c 3 {HOST.CONN} 2>&1",
            "host_access": "2",
            "usrgrpid": "0",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "0",
            "execute_on": "1",
            "timeout": "30s",
            "parameters": []
        },
        {
            "scriptid": "2",
            "name": "Traceroute",
            "command": "/usr/bin/traceroute {HOST.CONN} 2>&1",
            "host_access": "2",
            "usrgrpid": "0",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "0",
            "execute_on": "1",
            "timeout": "30s",
            "parameters": []
        },
        {
            "scriptid": "3",
            "name": "Detect operating system",
            "command": "sudo /usr/bin/nmap -O {HOST.CONN} 2>&1",
            "host_access": "2",
            "usrgrpid": "7",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "0",
            "execute_on": "1",
            "timeout": "30s",
            "parameters": []
        },
        {
            "scriptid": "4",
            "name": "Webhook",
            "command": "try {\n var request = new HttpRequest(),\n response,\n data;\n\n request.addHeader('Content-Type: application/json');\n\n response = request.post('https://localhost/post', value);\n\n try {\n response = JSON.parse(response);\n }\n catch (error) {\n response = null;\n }\n\n if (request.getStatus() !== 200 || !('data' in response)) {\n throw 'Unexpected response.';\n }\n\n data = JSON.stringify(response.data);\n\n Zabbix.Log(3, '[Webhook Script] response data: ' + data);\n\n return data;\n}\ncatch (error) {\n Zabbix.Log(3, '[Webhook Script] script execution failed: ' + error);\n throw 'Execution failed: ' + error + '.';\n}",
            "host_access": "2",
            "usrgrpid": "7",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "5",
            "execute_on": "1",
            "timeout": "30s",
            "parameters": [
                {
                    "name": "token",
                    "value": "{$WEBHOOK.TOKEN}"
                },
                {
                    "name": "host",
                    "value": "{HOST.HOST}"
                },
                {
                    "name": "v",
                    "value": "2.2"
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/59acc8d9-6d428f32})

[comment]: # ({b0b740ec-b0b740ec})
### Ver también

-   [Host](/manual/api/reference/host/object#detalles_de_objeto)
-   [Host group](/manual/api/reference/hostgroup/object#detalles_de_objeto)

[comment]: # ({/b0b740ec-b0b740ec})

[comment]: # ({90dfc753-90dfc753})
### Fuente

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

[comment]: # ({/90dfc753-90dfc753})