W3cubDocs

/Ansible

ce_static_route - Manages static route configuration on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages the static routes on HUAWEI CloudEngine switches.

Options

parameter required default choices comments
aftype
 yes
  • v4
  • v6
Destination ip address family type of static route.
description
 no
Name of the route. Used with the name parameter on the CLI.
destvrf
 no
VPN instance of next hop ip address.
mask
 yes
Destination ip mask of static route.
next_hop
 no
Next hop address of static route.
nhp_interface
 no
Next hop interface full name of static route.
pref
 no
Preference or administrative difference of route (range 1-255).
prefix
 yes
Destination ip address of static route.
state
 no present
  • present
  • absent
Specify desired state of the resource.
tag
 no
Route tag value (numeric).
vrf
 no
VPN instance of destination ip address.

Examples

- name: static route 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: Config a ipv4 static route, next hop is an address and that it has the proper description
    ce_static_route:
      prefix: 2.1.1.2
      mask: 24
      next_hop: 3.1.1.2
      description: 'Configured by Ansible'
      aftype: v4
      provider: "{{ cli }}"
  - name: Config a ipv4 static route ,next hop is an interface and that it has the proper description
    ce_static_route:
      prefix: 2.1.1.2
      mask: 24
      next_hop: 10GE1/0/1
      description: 'Configured by Ansible'
      aftype: v4
      provider: "{{ cli }}"
  - name: Config a ipv6 static route, next hop is an address and that it has the proper description
    ce_static_route:
      prefix: fc00:0:0:2001::1
      mask: 64
      next_hop: fc00:0:0:2004::1
      description: 'Configured by Ansible'
      aftype: v6
      provider: "{{ cli }}"
  - name: Config a ipv4 static route, next hop is an interface and that it has the proper description
    ce_static_route:
      prefix: fc00:0:0:2001::1
      mask: 64
      next_hop: 10GE1/0/1
      description: 'Configured by Ansible'
      aftype: v6
      provider: "{{ cli }}"
  - name: Config a VRF and set ipv4 static route, next hop is an address and that it has the proper description
    ce_static_route:
      vrf: vpna
      prefix: 2.1.1.2
      mask: 24
      next_hop: 3.1.1.2
      description: 'Configured by Ansible'
      aftype: v4
      provider: "{{ cli }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
end_state
k/v pairs of switchport after module execution
 always dict {'prefix': '192.168.20.0', 'next_hop': '3.3.3.3', 'description': 'testing', 'tag': 'null', 'pref': '100', 'mask': '24'}
changed
check to see if a change was made on the device
 always boolean True
updates
command list sent to the device
 always list ['ip route-static 192.168.20.0 255.255.255.0 3.3.3.3 preference 100 description testing']
proposed
k/v pairs of parameters passed into module
 always dict {'prefix': '192.168.20.642', 'next_hop': '3.3.3.3', 'description': 'testing', 'pref': '100', 'mask': '24', 'vrf': '_public_'}
existing
k/v pairs of existing switchport
 always dict {}

Notes

Note

  • If no vrf is supplied, vrf is set to default. If state=absent, the route will be removed, regardless of the non-required parameters.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ce_static_route_module.html