W3cubDocs

/Ansible

community.network.vdirect_commit – Commits pending configuration changes on Radware devices

Note

This plugin is part of the community.network collection (version 3.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.

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

Synopsis

  • Commits pending configuration changes on one or more Radware devices via vDirect server.
  • For Alteon ADC device, apply, sync and save actions will be performed by default. Skipping of an action is possible by explicit parameter specifying.
  • For Alteon VX Container device, no sync operation will be performed since sync action is only relevant for Alteon ADC devices.
  • For DefensePro and AppWall devices, a bulk commit action will be performed. Explicit apply, sync and save actions specifying is not relevant.

Requirements

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

  • vdirect-client >= 4.9.0-post4

Parameters

Parameter Choices/Defaults Comments
apply
boolean
    Choices:
  • no
  • yes ←
If no, apply action will not be performed. Relevant for ADC devices only.
devices
string / required
List of Radware Alteon device names for commit operations.
save
boolean
    Choices:
  • no
  • yes ←
If no, save action will not be performed. Relevant for ADC devices only.
sync
boolean
    Choices:
  • no
  • yes ←
If no, sync action will not be performed. Relevant for ADC devices only.
validate_certs
boolean
    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.

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
    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
string / required
vDirect server username, may be set as VDIRECT_USER environment variable.
vdirect_wait
boolean
    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: Commit
  community.network.vdirect_commit:
      vdirect_ip: 10.10.10.10
      vdirect_user: vDirect
      vdirect_password: radware
      devices: ['dev1', 'dev2']
      sync: no

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 actions result

Sample:
Requested actions were successfully performed on all devices.


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/latest/collections/community/network/vdirect_commit_module.html