radware.radware_modules.alteon_config_bgp_peer (0.6.12) — module

create and manage BGP peer 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

create and manage BGP peer 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_bgp_peer:
    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: 3
      state: enabled
      remote_addr: 3.3.3.3
      in_rmap_list:
      - 1
      - 2

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 BGP peer configuration.
    suboptions:
      advertised_route_metric:
        default: null
        description:
        - Set default-metric of advertized routes.
        required: false
        type: int
      advertising_deny_routes:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising deny routes.
        required: false
      advertising_fixed_routes:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising fixed routes.
        required: false
      advertising_ospf_routes:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising OSPF routes.
        required: false
      advertising_rip_routes:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising RIP routes.
        required: false
      advertising_static_routes:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising static routes.
        required: false
      advertising_vip_routes:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising VIP routes.
        required: false
      bfd:
        choices:
        - true
        - false
        default: false
        description:
        - Enable or disable Bidirectional Forwarding Detection (BFD).
        required: false
      connect_retry_interval:
        default: 120
        description:
        - Specifies the connection retry interval in seconds of the BGP peer IP datagram.
        required: false
        type: int
      default_route_action:
        choices:
        - none
        - import_
        - originate
        - redistribute
        default: none
        description:
        - Set the value of default route action.
        required: false
      extended_community_advertisement_status:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising extended community attribute.
        - This field is can be configured only when BGP global mode is FRR.
        - This field is can not be configured on VADC instance.
        required: false
      graceful_restart_status:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable graceful restart for the peer.
        - This field is can be configured only when BGP global mode is FRR.
        - This field is can not be configured on VADC instance.
        required: false
      hold_time:
        default: 180
        description:
        - Specifies the period of time in seconds that will elapse before the
        - peer session is torn down because Alteon has not received a Keep-Alive
        - message from the peer.
        required: false
        type: int
      in_rmap_list:
        default: null
        description:
        - Add or remove route map to the incoming route map list.
        elements: int
        required: false
        type: list
      index:
        default: null
        description:
        - peer ID.
        required: true
        type: int
      ip_version:
        choices:
        - ipv4
        - ipv6
        default: ipv4
        description:
        - The IP address version of the BGP peer address.
        required: false
      keep_alive_time:
        default: 60
        description:
        - The keep-alive time value in seconds of the BGP peer IP datagram.
        required: false
        type: int
      large_community_advertisement_status:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising large community attribute.
        - This field is can be configured only when BGP global mode is FRR.
        - This field is can not be configured on VADC instance.
        required: false
      min_adv_time:
        default: 60
        description:
        - Specifies the minimum time in seconds between advertisements of the BGP peer
          IP datagram.
        required: false
        type: int
      min_as_origination_interval:
        default: 30
        description:
        - Specifies the minimum time in seconds between route originations of the BGP
          peer IP datagram.
        required: false
        type: int
      next_hop_addr:
        default: null
        description:
        - The IP address that Alteon advertises to BGP peers.
        required: false
        type: str
      out_rmap_list:
        default: null
        description:
        - Add or remove route map to the outgoing route map list.
        elements: int
        required: false
        type: list
      password_status:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable using authentication password.
        - This field is can be configured only when BGP global mode is FRR.
        - This field is can not be configured on VADC instance.
        required: false
      peer_password:
        default: null
        description:
        - set authentication password.
        - This field is can be configured only when BGP global mode is FRR.
        - This field is can not be configured on VADC instance.
        required: false
        type: str
      remote_addr:
        default: null
        description:
        - The remote IP address of the BGP peer.
        required: false
        type: str
      remote_as_number:
        default: null
        description:
        - Set the remote automonos system (AS) number of the BGP peer using plain notation.
          0 means none.
        - Use either this or remote_asdot_number (as asdot notation), but not both.
        required: false
        type: int
      remote_asdot_number:
        default: null
        description:
        - Set the remote automonos system (AS) number of the BGP peer, using asdot notation.
        - Use either this or remote_as_number (as plain notation), but not both.
        - This field is available from alteon versions 32.6.10.0, 33.0.5.0 and 33.5.1.0.
        - It is recommended to wrap the text in " ".
        required: false
        type: str
      remote_ipv6_addr:
        default: null
        description:
        - The remote IPv6 address of the BGP peer.
        required: false
        type: str
      standard_community_advertisement_status:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable or disable advertising Standard community attribute.
        - This field is can be configured only when BGP global mode is FRR.
        - This field is can not be configured on VADC instance.
        required: false
      state:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Enable or disable the peer.
        required: false
      ttl:
        default: 1
        description:
        - The time-to-live value in seconds of the BGP peer IP datagram.
        required: false
        type: int
      ttl_security_hops:
        default: 30
        description:
        - Set ttl security hops count.
        - This field is can be configured only when BGP global mode is FRR.
        - This field is can not be configured on VADC instance.
        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