radware.radware_modules.alteon_config_l3_gateway (0.6.12) — module

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 l3 gateway in Radware Alteon.

Alteon can be configured with up to 255 gateways.

Gateways 1 to 4 are reserved for default gateway load balancing. Gateways 5 to 259 are used for load-balancing of VLAN-based gateways.

Requirements

• alteon-sdk

Usage examples

Scanned by Steampunk Spotter

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

- name: alteon configuration command
  radware.radware_modules.alteon_config_l3_gateway:
    provider: 
      server: 192.168.1.1
      user: admin
      password: admin
      validate_certs: no
      https_port: 443
      ssh_port: 22
      timeout: 5
    state: present
    parameters:
      index: 6
      state: enabled
      ip4_address: 1.1.1.254
      ip_ver: ipv4
      vlan: 10
      health_check_type: icmp
      health_check_interval_second: 30
      health_check_retries: 3
      route_priority: high
      global_gateway_metric: roundrobin              

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 l3 gateway configuration.
    suboptions:
      global_gateway_metric:
        choices:
        - strict
        - roundrobin
        default: null
        description:
        - Set gateway metric
        - In strict the gateway number determines its level of preference. Gateway 1 acts
          as the preferred default IP gateway until it fails or is disabled, at which,
          point the next in line takes over as the default IP gateway.
        - roundrobin is basic gateway load balancing. Alteon sends each new gateway request
          to the next healthy, enabled gateway in line. All gateway requests to the same
          destination IP address are resolved to the same gateway.
        required: false
      health_check_interval_second:
        default: 2
        description:
        - The interval, in seconds, between heakth check attempts.
        required: false
        type: int
      health_check_retries:
        default: 8
        description:
        - The number of failed attempts to declare the default gateway DOWN.
        required: false
        type: int
      health_check_type:
        choices:
        - arp
        - icmp
        default: icmp
        description:
        - Gateway health check type.
        required: false
      index:
        default: null
        description:
        - Gateway index.
        required: true
        type: int
      ip4_address:
        default: null
        description:
        - IPv4 address.
        required: false
        type: str
      ip6_address:
        default: null
        description:
        - IPv6 address.
        required: false
        type: str
      ip_ver:
        choices:
        - ipv4
        - ipv6
        default: null
        description:
        - IP version.
        required: false
      route_priority:
        choices:
        - low
        - high
        default: null
        description:
        - The priority of the default route for this gateway.
        - High priority means that the default gateway route will have higher priority
          over learned default routes.
        - Low priority means that the default gateway route will have lower priority than
          learned default routes.
        required: false
      state:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Gateway state.
        required: true
      vlan:
        default: null
        description:
        - VLAN ID.
        required: false
        type: int

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