community.general.ce_static_route_bfd (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Manages the static routes on HUAWEI CloudEngine switches.

Usage examples

Scanned by Steampunk Spotter

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

  #ip route-static bfd interface-type interface-number nexthop-address [ local-address address ]
  #[ min-rx-interval min-rx-interval | min-tx-interval min-tx-interval | detect-multiplier multiplier ]
  - name: Config an ip route-static bfd 10GE1/0/1 3.3.3.3 min-rx-interval 50 min-tx-interval 50 detect-multiplier 5
    ce_static_route_bfd:
      function_flag: 'singleBFD'
      nhp_interface: 10GE1/0/1
      next_hop: 3.3.3.3
      min_tx_interval: 50
      min_rx_interval: 50
      detect_multiplier: 5
      aftype: v4
      state: present

Scanned by Steampunk Spotter

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

  #undo ip route-static bfd [ interface-type interface-number | vpn-instance vpn-instance-name ] nexthop-address
  - name: undo ip route-static bfd 10GE1/0/1 3.3.3.4
    ce_static_route_bfd:
      function_flag: 'singleBFD'
      nhp_interface: 10GE1/0/1
      next_hop: 3.3.3.4
      aftype: v4
      state: absent

Scanned by Steampunk Spotter

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

  #ip route-static default-bfd { min-rx-interval {min-rx-interval} | min-tx-interval {min-tx-interval} | detect-multiplier {multiplier}}
  - name: Config an ip route-static default-bfd min-rx-interval 50 min-tx-interval 50 detect-multiplier 6
    ce_static_route_bfd:
      function_flag: 'globalBFD'
      min_tx_interval: 50
      min_rx_interval: 50
      detect_multiplier: 6
      aftype: v4
      state: present

Scanned by Steampunk Spotter

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

  - name: undo ip route-static default-bfd
    ce_static_route_bfd:
      function_flag: 'globalBFD'
      aftype: v4
      state: absent
      commands: 'sys,undo ip route-static default-bfd,commit'

Scanned by Steampunk Spotter

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

  - name: Config an ipv4 static route 2.2.2.0/24 2.2.2.1 preference 1 tag 2 description test for staticBFD
    ce_static_route_bfd:
      function_flag: 'staticBFD'
      prefix: 2.2.2.2
      mask: 24
      next_hop: 2.2.2.1
      tag: 2
      description: test
      pref: 1
      aftype: v4
      bfd_session_name: btoa
      state: present

Inputs

    
tag:
    description:
    - Route tag value (numeric).
    type: int

vrf:
    description:
    - VPN instance of destination ip address.
    type: str

mask:
    description:
    - Destination ip mask of static route.
    type: str

pref:
    description:
    - Preference or administrative difference of route (range 1-255).
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify desired state of the resource.
    required: false
    type: str

aftype:
    choices:
    - v4
    - v6
    description:
    - Destination ip address family type of static route.
    required: true
    type: str

prefix:
    description:
    - Destination ip address of static route.
    required: true
    type: str

destvrf:
    description:
    - VPN instance of next hop ip address.
    type: str

commands:
    description:
    - Incoming command line is used to send sys,undo ip route-static default-bfd,commit.
    type: list

next_hop:
    description:
    - Next hop address of static route.
    type: str

description:
    description:
    - Name of the route. Used with the name parameter on the CLI.
    type: str

function_flag:
    choices:
    - globalBFD
    - singleBFD
    - dynamicBFD
    - staticBFD
    description:
    - Used to distinguish between command line functions.
    required: true
    type: str

nhp_interface:
    description:
    - Next hop interface full name of static route.
    type: str

min_rx_interval:
    description:
    - Set the minimum BFD receive interval (range 50-1000).
    type: int

min_tx_interval:
    description:
    - Set the minimum BFD session sending interval (range 50-1000).
    type: int

bfd_session_name:
    description:
    - bfd name (range 1-15).
    type: str

detect_multiplier:
    description:
    - Configure the BFD multiplier (range 3-50).
    type: int

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: bool
end_state:
  description: k/v pairs of switchport after module execution
  returned: always
  sample:
    bfd_session_name: btoa
    description: testing
    function_flag: staticBFD
    mask: '24'
    next_hop: 3.3.3.3
    pref: '100'
    prefix: 192.168.20.0
    tag: 'null'
  type: dict
existing:
  description: k/v pairs of existing switchport
  returned: always
  sample:
    bfd_session_name: btoa
    description: testing
    function_flag: ''
    mask: '24'
    next_hop: ''
    pref: '101'
    prefix: 192.168.20.0
    tag: 'null'
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    bfd_session_name: btoa
    description: testing
    function_flag: staticBFD
    mask: '24'
    next_hop: 3.3.3.3
    pref: '100'
    prefix: 192.168.20.642
    vrf: _public_
  type: dict
updates:
  description: command list sent to the device
  returned: always
  sample:
  - ip route-static 192.168.20.0 255.255.255.0 3.3.3.3 preference 100 description
    testing
  type: list