Docs4dev
Docs
ansible / 2.4 / vdirect_file_module.html

vdirect_file - Uploads a new or updates an existing runnable file into Radware vDirect server

New in version 2.4.

Synopsis

  • Uploads a new or updates an existing configuration template or workflow template into the Radware vDirect server. All parameters may be set as environment variables.

Requirements (on host that executes module)

  • vdirect-client >= 4.1.1

Options

parameter required default choices comments
file_name
 yes
vDirect runnable file name to be uploaded.
May be velocity configuration template (.vm) or workflow template zip file (.zip).
vdirect_http_port
 no 2188
vDirect server HTTP port number, may be set as VDIRECT_HTTP_PORT environment variable.
vdirect_https_port
 no 2189
vDirect server HTTPS port number, may be set as VDIRECT_HTTPS_PORT environment variable.
vdirect_ip
 yes
Primary vDirect server IP address, may be set as VDIRECT_IP environment variable.
vdirect_password
 yes None
vDirect server password, may be set as VDIRECT_PASSWORD environment variable.
vdirect_secondary_ip
 no None
Secondary vDirect server IP address, may be set as VDIRECT_SECONDARY_IP environment variable.
vdirect_timeout
 no 60
Amount of time to wait for async operation completion [seconds],
may be set as VDIRECT_TIMEOUT environment variable.
vdirect_use_ssl
 no yes
  • yes
  • no
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
 yes None
vDirect server username, may be set as VDIRECT_USER environment variable.
vdirect_validate_certs
 no yes
  • yes
  • no
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
 no yes
  • yes
  • no
Wait for async operation to complete, may be set as VDIRECT_WAIT environment variable.

Examples

- name: vdirect_file
  vdirect_file:
      vdirect_primary_ip: 10.10.10.10
      vdirect_user: vDirect
      vdirect_password: radware
      file_name: /tmp/get_vlans.vm

Return Values

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

name description returned type sample
result
Message detailing upload result
success string Workflow template created

Notes

Note

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

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vdirect_file_module.html