ansible.builtin.ce_bfd_view (v2.5.12) — module

Install Ansible via pip

Install with pip install ansible==2.5.12

Description

Manages BFD session view configuration on HUAWEI CloudEngine devices.

Usage examples

Scanned by Steampunk Spotter

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

- name: bfd view module test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:
  - name: Set the local discriminator of a BFD session to 80 and the remote discriminator to 800
    ce_bfd_view:
      session_name: atob
      local_discr: 80
      remote_discr: 800
      state: present
      provider: '{{ cli }}'

  - name: Set the minimum interval for receiving BFD packets to 500 ms
    ce_bfd_view:
      session_name: atob
      min_rx_interval: 500
      state: present
      provider: '{{ cli }}'

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines whether the config should be present or not on the device.
    required: false

tos_exp:
    default: null
    description:
    - Specifies a priority for BFD control packets. The value is an integer ranging from
      0 to 7. The default value is 7, which is the highest priority.
    required: false

admin_down:
    default: false
    description:
    - Enables the BFD session to enter the AdminDown state. By default, a BFD session
      is enabled. The default value is bool type.
    required: false

description:
    default: null
    description:
    - Specifies the description of a BFD session. The value is a string of 1 to 51 case-sensitive
      characters with spaces.
    required: false

local_discr:
    default: null
    description:
    - Specifies the local discriminator of a BFD session. The value is an integer that
      ranges from 1 to 16384.
    required: false

detect_multi:
    default: null
    description:
    - Specifies the local detection multiplier of a BFD session. The value is an integer
      that ranges from 3 to 50.
    required: false

remote_discr:
    default: null
    description:
    - Specifies the remote discriminator of a BFD session. The value is an integer that
      ranges from 1 to 4294967295.
    required: false

session_name:
    default: null
    description:
    - Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive
      characters without spaces.
    required: true

wtr_interval:
    default: null
    description:
    - Specifies the WTR time of a BFD session. The value is an integer that ranges from
      1 to 60, in minutes. The default value is 0.
    required: false

min_rx_interval:
    default: null
    description:
    - Specifies the minimum interval for sending BFD packets. The value is an integer
      that ranges from 50 to 1000, in milliseconds.
    required: false

min_tx_interval:
    default: null
    description:
    - Specifies the minimum interval for receiving BFD packets. The value is an integer
      that ranges from 50 to 1000, in milliseconds.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs of configuration after module execution
  returned: always
  sample:
    session:
      adminDown: 'false'
      createType: SESS_STATIC
      description: null
      detectMulti: '3'
      localDiscr: '80'
      minRxInt: null
      minTxInt: null
      remoteDiscr: '800'
      sessName: atob
      tosExp: null
      wtrTimerInt: null
  type: dict
existing:
  description: k/v pairs of existing configuration
  returned: always
  sample:
    session:
      adminDown: 'false'
      createType: SESS_STATIC
      description: null
      detectMulti: '3'
      localDiscr: null
      minRxInt: null
      minTxInt: null
      remoteDiscr: null
      sessName: atob
      tosExp: null
      wtrTimerInt: null
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    admin_down: false
    description: null
    detect_multi: null
    local_discr: 80
    min_rx_interval: null
    min_tx_interval: null
    remote_discr: 800
    session_name: atob
    state: present
    tos_exp: null
    wtr_interval: null
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - bfd atob
  - discriminator local 80
  - discriminator remote 800
  type: list