proxy.get

Descrição

integer/array proxy.get(object parameters)

O método permite recuperar proxies de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
proxyids	ID/array	Retorna apenas proxies com os IDs fornecidos.
proxy_groupids	ID/array	Retorna apenas proxies que pertencem aos grupos de proxy fornecidos.
selectAssignedHosts	query	Retorna uma propriedade `assignedHosts` com os hosts atribuídos ao proxy. Suporta `count`.
selectHosts	query	Retorna uma propriedade `hosts` com os hosts monitorados pelo proxy. Suporta `count`.
selectProxyGroup	query	Retorna uma propriedade `proxyGroup` com o objeto de grupo de proxy.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `proxyid`, `name`, `operating_mode`.
countOutput	boolean	Esses parâmetros são descritos no comentário 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

Valores de retorno

(integer/array) Retorna:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperar todos os proxies

Recuperar todos os proxies configurados e suas interfaces.

Requisição:

{
           "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
       }

Veja também

Fonte

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

Documentation