Docs4dev
Docs
ansible / 2.10 / collections / community / network / ce_ospf_module.html

community.network.ce_ospf – Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_ospf.

Synopsis

  • Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
addr
string
Specifies the address of the network segment where the interface resides. The value is in dotted decimal notation.
area
string
Specifies the area ID. The area with the area-id being 0 is a backbone area. Valid values are a string, formatted as an IP address (i.e. "0.0.0.0") or as an integer between 1 and 4294967295.
auth_key_id
string
Authentication key id when auth_mode is 'hmac-sha256', 'md5' or 'hmac-md5. Valid value is an integer is in the range from 1 to 255.
auth_mode
string
    Choices:
  • none
  • hmac-sha256
  • md5
  • hmac-md5
  • simple
Specifies the authentication type.
auth_text_md5
string
Specifies a password for MD5, HMAC-MD5, or HMAC-SHA256 authentication. The value is a string of 1 to 255 case-sensitive characters, spaces not supported.
auth_text_simple
string
Specifies a password for simple authentication. The value is a string of 1 to 8 characters.
mask
string
IP network wildcard bits in decimal format between 0 and 32.
max_load_balance
string
The maximum number of paths for forward packets over multiple paths. Valid value is an integer in the range from 1 to 64.
nexthop_addr
string
IPv4 address for configure next-hop address's weight. Valid values are a string, formatted as an IP address.
nexthop_weight
string
Indicates the weight of the next hop. The smaller the value is, the higher the preference of the route is. It is an integer that ranges from 1 to 254.
process_id
string / required
Specifies a process ID. The value is an integer ranging from 1 to 4294967295.
state
string
    Choices:
  • present ←
  • absent
Determines whether the config should be present or not on the device.

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.
  • Recommended connection is netconf.
  • This module also works with local connections for legacy playbooks.

Examples

- name: Ospf 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: Configure ospf
    community.network.ce_ospf:
      process_id: 1
      area: 100
      state: present
      provider: "{{ cli }}"

Return Values

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

Key Returned Description
changed
boolean
always
check to see if a change was made on the device

Sample:
True
end_state
dictionary
verbose mode
k/v pairs of configuration after module execution

Sample:
{'areas': [{'areaId': '0.0.0.100', 'areaType': 'Normal'}], 'max_load_balance': '32', 'nexthops': [], 'process_id': '1'}
existing
dictionary
verbose mode
k/v pairs of existing configuration

Sample:
{'areas': [], 'max_load_balance': '32', 'nexthops': [], 'process_id': '1'}
proposed
dictionary
verbose mode
k/v pairs of parameters passed into module

Sample:
{'area': '100', 'process_id': '1'}
updates
list / elements=string
always
commands sent to the device

Sample:
['ospf 1', 'area 0.0.0.100']


Authors

  • QijunPan (@QijunPan)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_ospf_module.html