vdirect_client 4.1.1-12

Radware vDirect server python REST client

A REST-based python client for Radware vDirect

An auto-generated REST-based client for Radware vDirect

Client features:

• Supports asynchronous mode. The default behaviour of the client is to wait for requested operation completion. This behaviour can be overidden. See FAQ for more details.

• Supports vDirect server HA. If the client is configured with a secondary vDirect IP address, it will automatically try to switch to the secondary vDirect server instance if the primary vDirect server is not available.

• API call result is a tuple with four entries:

  1. HTTP response code. Example: 404. (int)

  2. HTTP response reason. Example: Not found. (string)

  3. The response as a string.

  4. The response as a dict (most of the time).

To understand which payloads to send and their expected response, developers should consult the vDirect REST API docs (https://<vdirect seerver IP address>:2189/docs/api-docs/).

Basic client usage:

from vdirect_client import rest_client
    from vdirect_client.rest_client import RestClient

    def show(result):
            print result[rest_client.RESP_STATUS]
            print result[rest_client.RESP_REASON]
            print result[rest_client.RESP_STR]
            print result[rest_client.RESP_DATA]

    ip = <vDirect server IP address>
    user = <vDirect server user name>
    password = <vDirect server password>

    client = RestClient(ip, user, password)
    data = {"tenants":[],"parameters":{"vipAddress":"1.1.1.1","ServerIps":["1.2.3.4","1.2.3.5"]},
                                                                       "devices":{"adc":{"deviceId":{"name":"Site1.vx2"}}}}
    show(client.workflowTemplate.create_workflow(data,'caching_enh','inst1'))
    show(client.ha.get_ha_config())
    show(client.ha.get_ha_status())
    show(client.template.list())
    show(client.template.run_template({},"A"))
    show(client.defensePro.list())

FAQ:

Q:

What do RestClient init parameters mean?

A:

RestClient init parameters description:

• vdirect_ip: The primary / standalone vDirect server IP address (string)

• vdirect_user: The vDirect server user name (string)

• vdirect_password: The vDirect server user password (string)

• wait: Wait for asynchronous operations to complete (boolean). Default is True

• secondary_vdirect_ip: The secondary vDirect server IP address (string). Relevant for vDirect server HA pair

• https_port: The https vDirect server port. Default is 2189 (integer)

• http_port: The http vDirect server port. Default is 2188 (integer)

• timeout: Time period (seconds) to wait for asynchronous operations completion (integer). Relevant for case where “wait” parameter is set to True. Default is 60 seconds

• https: Use HTTPS connections (boolean), Default is True

• strict_http_results: If set to True, only accept success HTTP status codes and throw exception for 4xx and 5xx status codes. Default is False

• verify: Verify SSL certificates on HTTPS connections (boolean). Default is True

Q:

I want to use vdirect_client in several occasions and avoid passing init paramters again and again. How can I achieve it?

A:

You can use environment variables instead of any RestClient init parameter. Following is a map of init parameters and their respective environment variable names:

• vdirect_ip - VDIRECT_IP

• vdirect_user - VDIRECT_USER

• vdirect_password - VDIRECT_PASSWORD

• wait = VDIRECT_WAIT

• secondary_vdirect_ip - VDIRECT_SECONDARY_IP

• https_port - VDIRECT_HTTPS_PORT

• http_port - VDIRECT_HTTP_PORT

• timeout - VDIRECT_TIMEOUT

• https - VDIRECT_HTTPS

• strict_http_results- VDIRECT_STRICT_HTTP_RESULT

• verify - VDIRECT_VERIFY

Q:

How do I disable SSL certificates verification on HTTPS connection?

A:

To disable SSL certificates verification, set the RestClient init “verify” parameter to False. You can also set environment variable VDIRECT_VERIFY to False.

Q:

Why do I see method names ending with numbers, e.g. “create0”, “list2”, “acquire0”, and others?

A:

vdirect_client code is a generated code and those method names are the result of technical constraints.

Q:

What are asynchronous operations?

A:

See vDirect REST API docs (https://<vdirect seerver IP address>:2189/docs/api-docs/async.html).

Q:

How do I know if my requested asynchronous operation succeeded?

A:

See vDirect REST API docs (https://<vdirect seerver IP address>:2189/docs/api-docs/async.html).

Q:

How do I know if my requested asynchronous operation completed?

A:

See vDirect REST API docs (https://<vdirect seerver IP address>:2189/docs/api-docs/async.html).

Q:

What is the difference between synchronous and asynchronous modes?

A:

See vDirect REST API docs (https://<vdirect seerver IP address>:2189/docs/api-docs/async.html). Following is a python code sample demonstrating how to get the URI token from response and sample the operation completion and success with it:

    import json
    import requests

from vdirect_client import rest_client
    from vdirect_client.rest_client import RestClient

    ip = <vDirect server IP address>
    user = <vDirect server user name>
    password = <vDirect server password>

    # creating rest client with wait parameter set to False
    client = RestClient(ip, user, password, wait=False)
    data = {"tenants":[],"parameters":{"vipAddress":"1.1.1.1","ServerIps":["1.2.3.4","1.2.3.5"]},
                                                                       "devices":{"adc":{"deviceId":{"name":"Site1.vx2"}}}}
    # Requesting operation and getting the operation URI token for completion sampling
    ret = client.workflowTemplate.create_workflow(data,'caching_enh','inst1')
    token_uri = ret[rest_client.RESP_DATA]['uri']

    # Getting the URI and checking the completion
    ret = requests.get(token_uri, auth=(user, password), verify=False)
    content = json.loads(ret.content)

    print content['complete']
    print content['success']

Q:

What is HA vDirect and how does it work?

A:

vdirect_client supports vDirect server HA mode, See vDirect documentation for further information (https://<vdirect seerver IP address>:2189/docs/api-docs/examples/haServer/index.html)