proxy.update

Beschrijving

object proxy.update(object/array proxies)

Deze methode maakt het mogelijk om bestaande proxies bij te werken.

Deze methode is alleen beschikbaar voor gebruikers van het type Super admin. Toestemming om de methode op te roepen kan worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Proxy-eigenschappen die bijgewerkt moeten worden.

De eigenschap proxyid moet gedefinieerd zijn voor elke proxy, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen zullen worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard proxy-eigenschappen accepteert de methode de volgende parameters.

Parameter	Type	Beschrijving
hosts	array	Te bewaken hosts door de proxy. Als een host al wordt bewaakt door een andere proxy, wordt deze opnieuw toegewezen aan de huidige proxy. De hosts moeten de eigenschap `hostid` gedefinieerd hebben.
interface	object	Host interface om het bestaande interface voor de passieve proxy te vervangen. Parametergedrag: - ondersteund als `status` van Proxy-object is ingesteld op "passive proxy"

Retourwaarden

(object) Geeft een object terug met de ID's van de bijgewerkte proxies onder de eigenschap proxyids.

Voorbeelden

Wijzig de door een proxy bewaakte hosts

Werk de proxy bij om de twee opgegeven hosts te bewaken.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "proxy.update",
           "params": {
               "proxyid": "10293",
               "hosts": [
                   {
                       "hostid": "10294"
                   },
                   {
                       "hostid": "10295"
                   }
               ]
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "proxyids": [
                   "10293"
               ]
           },
           "id": 1
       }

Wijzig proxy status

Wijzig de proxy naar een actieve proxy en hernoem deze naar "Actieve proxy".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "proxy.update",
           "params": {
               "proxyid": "10293",
               "host": "Actieve proxy",
               "status": "5"
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "proxyids": [
                   "10293"
               ]
           },
           "id": 1
       }

Voeg een proxy toe aan een proxygroep

Werk proxy met ID "5" bij en voeg deze toe aan proxygroep met ID "1".

Request:

{
         "jsonrpc": "2.0",
         "method": "proxy.create",
         "params": {
         "proxyid": "5",
         "proxy_groupid": "1",
         "local_address": "127.0.0.1"
         },
         "id": 1
         }

Response:

{
         "jsonrpc": "2.0",
         "result": {
         "proxyids": [
         "5"
         ]
         },
         "id": 1
       }

Zie ook

Bron

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

Documentation