radware.radware_modules.alteon_config_system_vx_peer_sync (0.6.12) — module

Manage VX peer sync in Radware Alteon

| "added in version" 2.9 of radware.radware_modules"

Authors: Leon Meguira (@leonmeguira), Nati Fridman (@natifridman)

stableinterface | supported by certified

Install collection

Install with ansible-galaxy collection install radware.radware_modules:==0.6.12


Add to requirements.yml

  collections:
    - name: radware.radware_modules
      version: 0.6.12

Description

Manage VX peer sync in Radware Alteon.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: alteon configuration command
  radware.radware_modules.alteon_config_system_vx_peer_sync:
    provider: 
      server: 192.168.1.1
      user: admin
      password: admin
      validate_certs: no
      https_port: 443
      ssh_port: 22
      timeout: 5
    state: present
    parameters:
      auto_sync: enabled
      sync_authentication_mode: passphrase
      sync_authentication_passphrase: secret_123
      peer_switches:
        - id: 2
          state: enabled
          ip4_address: 8.8.8.8
          vadc_ids:
            - 4

Inputs

    
state:
    choices:
    - present
    - absent
    - read
    - overwrite
    - append
    default: null
    description:
    - When C(present), guarantees that the object exists with the provided attributes.
    - When C(absent), when applicable removes the object.
    - When C(read), when exists read object from configuration to parameter format.
    - When C(overwrite), removes the object if exists then recreate it
    - When C(append), append object configuration with the provided parameters
    required: true

provider:
    description:
    - Radware Alteon connection details.
    required: true
    suboptions:
      https_port:
        default: null
        description:
        - Radware Alteon https port.
        required: true
      password:
        default: null
        description:
        - Radware Alteon password.
        required: true
      server:
        default: null
        description:
        - Radware Alteon IP address.
        required: true
      ssh_port:
        default: null
        description:
        - Radware Alteon ssh port.
        required: true
      timeout:
        default: null
        description:
        - Timeout for connection.
        required: true
      user:
        default: null
        description:
        - Radware Alteon username.
        required: true
      validate_certs:
        default: null
        description:
        - If C(no), SSL certificates will not be validated.
        - This should only set to C(no) used on personally controlled sites using self-signed
          certificates.
        required: true
        type: bool

parameters:
    description:
    - Parameters for VX peer sync configuration.
    suboptions:
      auto_sync:
        choices:
        - enabled
        - disabled
        default: enabled
        description:
        - The vADC ID.
        required: false
      peer_switches:
        default: null
        description:
        - Peer Switch configuration.
        elements: dict
        required: false
        suboptions:
          id:
            default: null
            description:
            - Peer Switch ID.
            required: true
            type: int
          ip4_address:
            default: null
            description:
            - The IP address of the peer switch.
            required: false
            type: str
          ip6_address:
            default: null
            description:
            - The IP address of the peer switch.
            required: false
            type: str
          ip_ver:
            choices:
            - ipv4
            - ipv6
            default: null
            description:
            - The IP version of the Peer Switch Address.
            required: false
          state:
            choices:
            - enabled
            - disabled
            default: disabled
            description:
            - Specifies whether the peer is enabled.
            required: false
          vadc_ids:
            default: null
            description:
            - vADC ID.
            elements: int
            required: false
            type: list
        type: list
      sync_authentication_mode:
        choices:
        - admin
        - passphrase
        default: null
        description:
        - Enable authentication passphrase.
        required: false
      sync_authentication_passphrase:
        default: null
        description:
        - Authentication Passphrase.
        required: false
        type: str

revert_on_error:
    default: false
    description:
    - If an error occurs, perform revert on alteon.
    required: false
    type: bool

write_on_change:
    default: false
    description:
    - Executes Alteon write calls only when an actual change has been evaluated.
    required: false
    type: bool

Outputs

obj:
  description: parameters object type
  returned: changed, read
  type: dictionary
status:
  description: Message detailing run result
  returned: success
  sample: object deployed successfully
  type: str