community.general.vdirect_runnable (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Runs configuration templates, creates workflows and runs workflow actions in Radware vDirect server.

Requirements

• vdirect-client >= 4.9.0-post4

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: vdirect_runnable
  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'}]}

Inputs

    
parameters:
    description:
    - Action parameters dictionary. In case of C(ConfigurationTemplate) runnable type,
    - the device connection details should always be passed as a parameter.

vdirect_ip:
    description:
    - Primary vDirect server IP address, may be set as C(VDIRECT_IP) environment variable.
    required: true

action_name:
    description:
    - Workflow action name to run.
    - Required if I(runnable_type=Workflow).

vdirect_user:
    description:
    - vDirect server username, may be set as C(VDIRECT_USER) environment variable.
    required: true

vdirect_wait:
    default: 'yes'
    description:
    - Wait for async operation to complete, may be set as C(VDIRECT_WAIT) environment
      variable.
    type: bool

runnable_name:
    description:
    - vDirect runnable name to run.
    - May be configuration template name, workflow template name or workflow instance
      name.
    required: true

runnable_type:
    choices:
    - ConfigurationTemplate
    - Workflow
    - WorkflowTemplate
    - Plugin
    description:
    - vDirect runnable type.
    required: true

validate_certs:
    aliases:
    - vdirect_validate_certs
    default: 'yes'
    description:
    - If C(no), SSL certificates will not be validated,
    - may be set as C(VDIRECT_VALIDATE_CERTS) or C(VDIRECT_VERIFY) environment variable.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

vdirect_timeout:
    default: 60
    description:
    - Amount of time to wait for async operation completion [seconds],
    - may be set as C(VDIRECT_TIMEOUT) environment variable.

vdirect_use_ssl:
    default: 'yes'
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection,
    - may be set as C(VDIRECT_HTTPS) or C(VDIRECT_USE_SSL) environment variable.
    type: bool

vdirect_password:
    description:
    - vDirect server password, may be set as C(VDIRECT_PASSWORD) environment variable.
    required: true

vdirect_http_port:
    default: 2188
    description:
    - vDirect server HTTP port number, may be set as C(VDIRECT_HTTP_PORT) environment
      variable.

vdirect_https_port:
    default: 2189
    description:
    - vDirect server HTTPS port number, may be set as C(VDIRECT_HTTPS_PORT) environment
      variable.

vdirect_secondary_ip:
    description:
    - Secondary vDirect server IP address, may be set as C(VDIRECT_SECONDARY_IP) environment
      variable.

Outputs

result:
  description: Message detailing run result
  returned: success
  sample: Workflow action run completed.
  type: str