proxy.create

Description

object proxy.create(object/array proxies)

Cette méthode permet de créer de nouveaux proxies.

Cette méthode est uniquement disponible pour le type d’utilisateur Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

(object/array) Proxys à créer.

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

Paramètre Type Description
hosts array Hôtes à surveiller 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 uniquement la propriété hostid définie.

Valeurs de retour

(object) Renvoie un objet contenant les ID des proxies créés dans la propriété proxyids. L’ordre des ID renvoyés correspond à l’ordre des proxies transmis.

Exemples

Créer un proxy actif

Créez un proxy d’action « Active proxy » et assignez-lui un hôte à surveiller.

Request:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Active proxy",
        "operating_mode": "0",
        "hosts": [
            {
                "hostid": "10279"
            }
        ]
    },
    "id": 1
}

Réponse :

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

Créer un proxy passif

Créez un proxy passif « Passive proxy » et assignez-lui deux hôtes à surveiller.

Requête:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Passive proxy",
        "operating_mode": "1",
        "address": "127.0.0.1",
        "port": "10051",
        "hosts": [
            {
                "hostid": "10192"
            },
            {
                "hostid": "10139"
            }
        ]
    },
    "id": 1
}

Réponse :

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

Création d’un proxy et ajout à un groupe de proxys

Créez un proxy actif « Active proxy » et ajoutez-le au groupe de proxys avec l’ID « 1 ».

Requête:

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "name": "Active proxy",
        "proxy_groupid": "1",
        "operating_mode": "0"
    },
    "id": 1
}

Réponse :

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

Voir aussi

Source

CProxy::create() dans ui/include/classes/api/services/CProxy.php.