community.network.vdirect_runnable module – Runs templates and workflow actions in Radware vDirect server

Note

This module is part of the community.network collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.network.vdirect_runnable.

Synopsis

  • Runs configuration templates, creates workflows and runs workflow actions in Radware vDirect server.

Requirements

The below requirements are needed on the host that executes this module.

  • vdirect-client >= 4.9.0-post4

Parameters

Parameter

Comments

action_name

string

Workflow action name to run.

Required if runnable_type=Workflow.

parameters

string

Action parameters dictionary. In case of ConfigurationTemplate runnable type,

the device connection details should always be passed as a parameter.

Default: {}

runnable_name

string / required

vDirect runnable name to run.

May be configuration template name, workflow template name or workflow instance name.

runnable_type

string / required

vDirect runnable type.

Choices:

  • "ConfigurationTemplate"

  • "Workflow"

  • "WorkflowTemplate"

  • "Plugin"

validate_certs

aliases: vdirect_validate_certs

boolean

If no, SSL certificates will not be validated,

may be set as VDIRECT_VALIDATE_CERTS or VDIRECT_VERIFY environment variable.

This should only set to no used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

vdirect_http_port

string

vDirect server HTTP port number, may be set as VDIRECT_HTTP_PORT environment variable.

Default: 2188

vdirect_https_port

string

vDirect server HTTPS port number, may be set as VDIRECT_HTTPS_PORT environment variable.

Default: 2189

vdirect_ip

string / required

Primary vDirect server IP address, may be set as VDIRECT_IP environment variable.

vdirect_password

string / required

vDirect server password, may be set as VDIRECT_PASSWORD environment variable.

vdirect_secondary_ip

string

Secondary vDirect server IP address, may be set as VDIRECT_SECONDARY_IP environment variable.

vdirect_timeout

string

Amount of time to wait for async operation completion [seconds],

may be set as VDIRECT_TIMEOUT environment variable.

Default: 60

vdirect_use_ssl

boolean

If no, an HTTP connection will be used instead of the default HTTPS connection,

may be set as VDIRECT_HTTPS or VDIRECT_USE_SSL environment variable.

Choices:

  • false

  • true ← (default)

vdirect_user

string / required

vDirect server username, may be set as VDIRECT_USER environment variable.

vdirect_wait

boolean

Wait for async operation to complete, may be set as VDIRECT_WAIT environment variable.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Requires the Radware vdirect-client Python package on the host. This is as easy as pip install vdirect-client

Examples

- name: Run the module from Ansible playbook
  community.network.vdirect_runnable:
      vdirect_ip: 10.10.10.10
      vdirect_user: vDirect
      vdirect_password: radware
      runnable_type: ConfigurationTemplate
      runnable_name: get_vlans
      parameters: {'vlans_needed':1,'adc':[{'type':'Adc','name':'adc-1'}]}

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

string

Message detailing run result

Returned: success

Sample: "Workflow action run completed."

Authors

  • Evgeny Fedoruk @ Radware LTD (@evgenyfedoruk)