vdirect_commit - Commits pending configuration changes on Radware devices¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

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

Parameters ¶

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

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.