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.3).
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.
Aliases: network.radware.vdirect_runnable
Requirements
The below requirements are needed on the host that executes this module.
vdirect-client >= 4.9.0-post4
Parameters
Parameter |
Comments |
---|---|
Workflow action name to run. Required if runnable_type=Workflow. |
|
Action parameters dictionary. In case of the device connection details should always be passed as a parameter. Default: |
|
vDirect runnable name to run. May be configuration template name, workflow template name or workflow instance name. |
|
vDirect runnable type. Choices:
|
|
If may be set as This should only set to Choices:
|
|
vDirect server HTTP port number, may be set as Default: |
|
vDirect server HTTPS port number, may be set as Default: |
|
Primary vDirect server IP address, may be set as |
|
vDirect server password, may be set as |
|
Secondary vDirect server IP address, may be set as |
|
Amount of time to wait for async operation completion [seconds], may be set as Default: |
|
If may be set as Choices:
|
|
vDirect server username, may be set as |
|
Wait for async operation to complete, may be set as Choices:
|
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 |
---|---|
Message detailing run result Returned: success Sample: |