proxy.get

Descripció

integer/array proxy.get(object parameters)

El mètode permet recuperar proxys segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
proxyids ID/array Retorna només proxys amb els identificadors donats.
selectAssignedHosts query Retorna una propietat assignedHosts amb els equips assignats al proxy.

Admet count.
selectHosts query Retorna una propietat hosts amb els equips monitorats pel proxy.
selectProxyGroup query Retorna una propietat proxyGroup amb l'objecte del grup de proxys.
sortfield string/array Ordena el resultat per les propietats donades.

Els valors possibles són: proxyid, name i operating_mode.
countOutput boolean Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar tots els proxys

Recuperar tots els proxys configurats i les seves interfícies.

Petició:

{
           "jsonrpc": "2.0",
           "method": "proxy.get",
           "params": {
               "output": "extend"
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "proxyid": "11",
                   "name": "Active proxy",
                   "proxy_groupid": "0",
                   "local_address": "",
                   "local_port": "10051",
                   "operating_mode": "0",
                   "description": "",
                   "allowed_addresses": "",
                   "address": "127.0.0.1",
                   "port": "10051",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "custom_timeouts": "0",
                   "timeout_zabbix_agent": "",
                   "timeout_simple_check": "",
                   "timeout_snmp_agent": "",
                   "timeout_external_check": "",
                   "timeout_db_monitor": "",
                   "timeout_http_agent": "",
                   "timeout_ssh_agent": "",
                   "timeout_telnet_agent": "",
                   "timeout_script": "",
                   "last_access": "1693391880",
                   "version": "70000",
                   "compatibility": "1",
                   "state": "1"
               },
               {
                   "proxyid": "12",
                   "name": "Passive proxy",
                   "proxy_groupid": "1",
                   "local_address": "127.0.0.1",
                   "local_port": "10051",
                   "operating_mode": "1",
                   "description": "",
                   "allowed_addresses": "",
                   "address": "127.0.0.1",
                   "port": "10051",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "custom_timeouts": "1",
                   "timeout_zabbix_agent": "5s",
                   "timeout_simple_check": "5s",
                   "timeout_snmp_agent": "5s",
                   "timeout_external_check": "5s",
                   "timeout_db_monitor": "5s",
                   "timeout_http_agent": "5s",
                   "timeout_ssh_agent": "5s",
                   "timeout_telnet_agent": "5s",
                   "timeout_script": "5s",
                   "lastaccess": "1693391875",
                   "version": "60400",
                   "compatibility": "2",
                   "state": "2"
               }
           ],
           "id": 1
       }

Veieu també

Font

CProxy::get() in ui/include/classes/api/services/CProxy.php.