Documentation

vdirect_runnable - Runs templates and workflow actions in Radware vDirect server

New in version 2.5.

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.1.1

Parameters

Parameter Choices/Defaults Comments
action_name
Workflow action name to run.
Required if runnable_type=Workflow.
parameters
Action parameters dictionary. In case of ConfigurationTemplate runnable type,
the device connection details should always be passed as a parameter.
runnable_name
required
vDirect runnable name to run.
May be configuration template name, workflow template name or workflow instance name.
runnable_type
required
    Choices:
  • ConfigurationTemplate
  • Workflow
  • WorkflowTemplate
vDirect runnable type.
vdirect_http_port Default:
2188
vDirect server HTTP port number, may be set as VDIRECT_HTTP_PORT environment variable.
vdirect_https_port Default:
2189
vDirect server HTTPS port number, may be set as VDIRECT_HTTPS_PORT environment variable.
vdirect_ip
required
Primary vDirect server IP address, may be set as VDIRECT_IP environment variable.
vdirect_password
required
vDirect server password, may be set as VDIRECT_PASSWORD environment variable.
vdirect_secondary_ip
Secondary vDirect server IP address, may be set as VDIRECT_SECONDARY_IP environment variable.
vdirect_timeout Default:
60
Amount of time to wait for async operation completion [seconds],
may be set as VDIRECT_TIMEOUT environment variable.
vdirect_use_ssl
    Choices:
  • no
  • yes ←
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.
vdirect_user
required
vDirect server username, may be set as VDIRECT_USER environment variable.
vdirect_validate_certs
    Choices:
  • no
  • yes ←
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.
vdirect_wait
    Choices:
  • no
  • yes ←
Wait for async operation to complete, may be set as VDIRECT_WAIT environment variable.

Notes

Note

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

Examples

- name: vdirect_runnable
  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 Returned Description
result
string
 success
Message detailing run result

Sample:
Workflow action run completed.


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Evgeny Fedoruk @ Radware LTD (@evgenyfedoruk)

Hint

If you notice any issues in this documentation you can edit this document to improve it.