Sidebar

fr:manual:api:reference:proxy:update

proxy.update

Description

object proxy.update(object/array proxies)

Cette méthode permet de mettre à jour les proxys existants.

Paramètres

(object/array) Propriétés du proxy à mettre à jour.

La propriété proxyid doit être définie pour chaque proxy, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.

En plus des propriétés de l'objet proxy standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
hosts array Les hôtes qui doivent être surveillés par le proxy. Si un hôte est déjà surveillé par un autre proxy, il sera réaffecté au proxy actuel.

Les hôtes doivent avoir la propriété hostid définie.
interface object Interface de l'hôte en remplacement de l'interface existante pour le proxy passif.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des proxys mis à jour sous la propriété proxyids.

Exemples

Changer les hôtes surveillés par un proxy

Mettre à jour le proxy pour la surveillance des deux hôtes donnés.

Requête :

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

Réponse :

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

Changer le statut du proxy

Changer le proxy en proxy actif et le renommer “Active proxy”.

Requête :

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "host": "Active proxy",
        "status": "5"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

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

Voir également

Source

CProxy::update() dans frontends/php/include/classes/api/services/CProxy.php.