radware.radware_modules.alteon_config_sideband_policy (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

create and manage sideband policy in Radware Alteon.

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_sideband_policy:
    provider:
      server: 192.168.1.1
      user: admin
      password: admin
      validate_certs: no
      https_port: 443
      ssh_port: 22
      timeout: 5
    state: present
    parameters:
      sideband_policy_id: 3
      name: sideband3
      sideband_policy_state: enabled
      group_id: group1
      appshapes:
        - priority: 3
          name: SecurePath_sideband_script

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 sideband policy configuration.
    suboptions:
      application:
        choices:
        - http
        - dns
        default: http
        description:
        - Set sideband policy application.
        required: false
      appshapes:
        default: null
        description:
        - Associate Appshape scripts to sideband policy.
        elements: dict
        required: false
        suboptions:
          name:
            description:
            - Appshape script name.
            required: false
            type: str
          priority:
            description:
            - Appshape script priority.
            required: true
            type: int
      client_nat_addr:
        default: null
        description:
        - Set cilent IPv4 address.
        required: false
        type: str
      client_nat_mask:
        default: null
        description:
        - Set client NAT mask.
        required: false
        type: str
      client_nat_mode:
        choices:
        - egress
        - address
        default: egress
        description:
        - Set client NAT mode.
        required: false
      client_nat_prefix:
        default: null
        description:
        - Set client NAT prefix.
        required: false
        type: int
      client_nat_v6_addr:
        default: null
        description:
        - Set cilent IPv6 address.
        required: false
        type: str
      destination_port:
        default: null
        description:
        - Set sideband destination application port.
        required: false
        type: int
      fallback_action:
        choices:
        - fallbackClosed
        - fallbackOpen
        default: fallbackOpen
        description:
        - Set the fallback action in case of no-response or failure.
        - This field can be set only when sideband policy is http application mode.
        required: false
      group_id:
        default: null
        description:
        - Set sideband destination group.
        required: false
        type: str
      name:
        default: null
        description:
        - Set Descriptive name for the sideband policy.
        required: false
        type: str
      preserve_client_ip:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Enable/Disable preserving client IP. This field can be set only when sideband
          policy is dns application mode.
        required: false
      sideband_policy_id:
        default: null
        description:
        - sideband policy index.
        required: true
        type: str
      sideband_policy_state:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Enable/Disable the sideband policy.
        required: false
      ssl_policy:
        default: null
        description:
        - Set sideband backend SSL policy. This field can be set only when sideband policy
          is http application mode.
        required: false
        type: str
      timeout:
        default: null
        description:
        - Set sideband timeout.
        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