community.general.ce_vrrp (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 VRRP interface attributes on HUAWEI CloudEngine devices.

Usage examples

Scanned by Steampunk Spotter

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

- name: vrrp 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 vrrp version
    ce_vrrp:
      version: v3
      provider: "{{ cli }}"
  - name: Set vrrp gratuitous-arp interval
    ce_vrrp:
      gratuitous_arp_interval: 40
      mlag_id: 4
      provider: "{{ cli }}"
  - name: Set vrrp recover-delay
    ce_vrrp:
      recover_delay: 10
      provider: "{{ cli }}"
  - name: Set vrrp vrid virtual-ip
    ce_vrrp:
      interface: 40GE2/0/8
      vrid: 1
      virtual_ip: 10.14.2.7
      provider: "{{ cli }}"
  - name: Set vrrp vrid admin
    ce_vrrp:
      interface: 40GE2/0/8
      vrid: 1
      vrrp_type: admin
      provider: "{{ cli }}"
  - name: Set vrrp vrid fast_resume
    ce_vrrp:
      interface: 40GE2/0/8
      vrid: 1
      fast_resume: enable
      provider: "{{ cli }}"
  - name: Set vrrp vrid holding-multiplier
    ce_vrrp:
      interface: 40GE2/0/8
      vrid: 1
      holding_multiplier: 4
      provider: "{{ cli }}"
  - name: Set vrrp vrid preempt timer delay
    ce_vrrp:
      interface: 40GE2/0/8
      vrid: 1
      preempt_timer_delay: 10
      provider: "{{ cli }}"
  - name: Set vrrp vrid admin-vrrp
    ce_vrrp:
      interface: 40GE2/0/8
      vrid: 1
      admin_interface: 40GE2/0/9
      admin_vrid: 2
      vrrp_type: member
      provider: "{{ cli }}"
  - name: Set vrrp vrid authentication-mode
    ce_vrrp:
      interface: 40GE2/0/8
      vrid: 1
      is_plain: true
      auth_mode: simple
      auth_key: aaa
      provider: "{{ cli }}"

Inputs

    
vrid:
    default: present
    description:
    - VRRP backup group ID. The value is an integer ranging from 1 to 255.

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

version:
    choices:
    - v2
    - v3
    description:
    - VRRP version. The default version is v2.
    type: str

auth_key:
    description:
    - This object is set based on the authentication type. When noAuthentication is specified,
      the value is empty. When simpleTextPassword or md5Authentication is specified, the
      value is a string of 1 to 8 characters in plaintext and displayed as a blank text
      for security.

is_plain:
    default: 'false'
    description:
    - Select the display mode of an authentication key. By default, an authentication
      key is displayed in ciphertext.
    type: bool

priority:
    description:
    - Configured VRRP priority. The value ranges from 1 to 254. The default value is 100.
      A larger value indicates a higher priority.

auth_mode:
    choices:
    - simple
    - md5
    - none
    description:
    - Authentication type used for VRRP packet exchanges between virtual routers. The
      values are noAuthentication, simpleTextPassword, md5Authentication. The default
      value is noAuthentication.
    type: str

interface:
    description:
    - Name of an interface. The value is a string of 1 to 63 characters.

vrrp_type:
    choices:
    - normal
    - member
    - admin
    description:
    - Type of a VRRP backup group.
    type: str

admin_vrid:
    description:
    - Tracked mVRRP ID. The value is an integer ranging from 1 to 255.

virtual_ip:
    description:
    - Virtual IP address. The value is a string of 0 to 255 characters.

fast_resume:
    choices:
    - enable
    - disable
    description:
    - mVRRP's fast resume mode.
    type: str

recover_delay:
    description:
    - Delay in recovering after an interface goes Up. The delay is used for interface
      flapping suppression. The value is an integer ranging from 0 to 3600. The default
      value is 0 seconds.

admin_flowdown:
    default: 'false'
    description:
    - Disable the flowdown function for service VRRP.
    type: bool

admin_interface:
    description:
    - Tracked mVRRP interface name. The value is a string of 1 to 63 characters.

advertise_interval:
    description:
    - Configured interval between sending advertisements, in milliseconds. Only the master
      router sends VRRP advertisements. The default value is 1000 milliseconds.

holding_multiplier:
    description:
    - The configured holdMultiplier.The value is an integer ranging from 3 to 10. The
      default value is 3.

preempt_timer_delay:
    description:
    - Preemption delay. The value is an integer ranging from 0 to 3600. The default value
      is 0.

admin_ignore_if_down:
    default: 'false'
    description:
    - mVRRP ignores an interface Down event.
    type: bool

gratuitous_arp_interval:
    description:
    - Interval at which gratuitous ARP packets are sent, in seconds. The value ranges
      from 30 to 1200.The default value is 300.

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 aaa params after module execution
  returned: always
  sample:
    auth_mode: simple
    interface: 40GE2/0/8
    is_plain: 'true'
    vrid: '1'
    vrrp_type: normal
  type: dict
existing:
  description: k/v pairs of existing aaa server
  returned: always
  sample:
    auth_mode: none
    interface: 40GE2/0/8
    is_plain: 'false'
    vrid: '1'
    vrrp_type: normal
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    auth_key: aaa
    auth_mode: simple
    interface: 40GE2/0/8
    is_plain: true
    state: present
    vrid: '1'
  type: dict
updates:
  description: command sent to the device
  returned: always
  sample:
    interface 40GE2/0/8: null
    vrrp vrid 1 authentication-mode simple plain aaa: null
  type: list