radware.radware_modules.alteon_config_spanning_tree (0.4.12) — module

Manage spanning tree 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.4.12


Add to requirements.yml

  collections:
    - name: radware.radware_modules
      version: 0.4.12

Description

Manage spanning tree 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_spanning_tree:
    provider: 
      server: 192.168.1.1
      user: admin
      password: admin
      validate_certs: no
      https_port: 443
      ssh_port: 22
      timeout: 5
    state: present
    parameters:
      state: on
      mstp: enabled
      mstp_mode: mstp
      mstp_region_version: 3
      mstp_maximum_hops: 10
      stp_groups:
        - id: 1
          state: on
          bridge_hello_time_second: 10
          pvst_frames_on_untagged_ports: enabled
          vlans:
            - 1
            - 10

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 spanning tree configuration.
    suboptions:
      mstp:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable/Disable Multiple Spanning Tree
        required: false
      mstp_bridge_forward_delay_second:
        default: null
        description:
        - The time, in seconds, that all bridges use for ForwardDelay when this bridge
          is acting as the root.
        required: false
        type: int
      mstp_bridge_max_age_second:
        default: null
        description:
        - The time, in seconds, that all bridges use for MaxAge when this bridge is acting
          as the root.
        required: false
        type: int
      mstp_bridge_priority:
        default: null
        description:
        - The value of the writable portion of the Bridge Identifier comprising of the
          first two octets.
        required: false
        type: int
      mstp_maximum_hops:
        default: null
        description:
        - The maximum number of hops.
        required: false
        type: int
      mstp_mode:
        choices:
        - mstp
        - rstp
        default: null
        description:
        - The mode of the spanning tree.
        required: false
      mstp_region_name:
        default: null
        description:
        - A name for the region.
        required: false
        type: str
      mstp_region_version:
        default: null
        description:
        - The region version.
        required: false
        type: int
      state:
        choices:
        - true
        - false
        default: null
        description:
        - Spanning tree state.
        required: true
      stp_groups:
        default: null
        description:
        - Spanning tree group parameters.
        elements: dict
        required: false
        suboptions:
          bridge_aging_time_second:
            default: 300
            description:
            - The timeout period, in seconds, for aging out dynamically learned forwarding
              information.
            - 0 is to disable.
            required: false
            type: int
          bridge_forward_delay_second:
            default: 15
            description:
            - The time, in seconds, that all bridges use for ForwardDelay when this bridge
              is acting as the root.
            required: false
            type: int
          bridge_hello_time_second:
            default: 2
            description:
            - The time, in seconds, that all bridges use for HelloTime when this bridge
              is acting as the root.
            required: false
            type: int
          bridge_max_age_second:
            default: 20
            description:
            - The time, in seconds, that all bridges use for MaxAge when this bridge is
              acting as the root.
            required: false
            type: int
          bridge_priority:
            default: 32768
            description:
            - The value of the writeable portion of the Bridge ID - that is, the first
              two octets of the (8 octet long) Bridge ID.
            required: false
            type: int
          id:
            default: null
            description:
            - The identifier of this spanning tree group.
            required: true
            type: int
          pvst_frames_on_untagged_ports:
            default: null
            description:
            - Specifies the VLANs in the spanning tree group.
            elements: int
            required: false
            type: list
          state:
            choices:
            - true
            - false
            default: null
            description:
            - Spanning tree state.
            required: false
        type: list

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