community.network.vdirect_file – Uploads a new or updates an existing runnable file into Radware vDirect server

From Get docs
Ansible/docs/2.11/collections/community/network/vdirect file module


community.network.vdirect_file – Uploads a new or updates an existing runnable file into Radware vDirect server

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

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


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

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

  • vdirect-client >= 4.9.0-post4

Parameters

Parameter Choices/Defaults Comments

file_name

string / required

vDirect runnable file name to be uploaded.

May be velocity configuration template (.vm) or workflow template zip file (.zip).

validate_certs

boolean

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


aliases: vdirect_validate_certs

vdirect_http_port

string

Default:

2188

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

vdirect_https_port

string

Default:

2189

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

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

Default:

60

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

may be set as VDIRECT_TIMEOUT environment variable.

vdirect_use_ssl

boolean

  • 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

string / required

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

vdirect_wait

boolean

  • 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: Upload a new or updates an existing runnable file
  community.network.vdirect_file:
      vdirect_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, the following are the fields unique to this module:

Key Returned Description

result

string

success

Message detailing upload result


Sample:

Workflow template created




Authors

  • Evgeny Fedoruk @ Radware LTD (@evgenyfedoruk)

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