You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ce_ospf - Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.

Options ¶

parameter	required	default	choices	comments
addr	no			Specifies the address of the network segment where the interface resides. The value is in dotted decimal notation.
area	no			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	no			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	no		none hmac-sha256 md5 hmac-md5 simple	Specifies the authentication type.
auth_text_md5	no			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	no			Specifies a password for simple authentication. The value is a string of 1 to 8 characters.
mask	no			IP network wildcard bits in decimal format between 0 and 32.
max_load_balance	no			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	no			IPv4 address for configure next-hop address's weight. Valid values are a string, formatted as an IP address.
nexthop_weight	no			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	yes			Specifies a process ID. The value is an integer ranging from 1 to 4294967295.
state	no	present	present absent	Determines whether the config should be present or not on the device.

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
    ce_ospf:
      process_id: 1
      area: 100
      state: present
      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
changed	check to see if a change was made on the device	always	boolean	True
end_state	k/v pairs of configuration after module execution	verbose mode	dict	{'max_load_balance': '32', 'areas': [{'areaId': '0.0.0.100', 'areaType': 'Normal'}], 'process_id': '1', 'nexthops': []}
existing	k/v pairs of existing configuration	verbose mode	dict	{'max_load_balance': '32', 'areas': [], 'process_id': '1', 'nexthops': []}
proposed	k/v pairs of parameters passed into module	verbose mode	dict	{'process_id': '1', 'area': '100'}
updates	commands sent to the device	always	list	['ospf 1', 'area 0.0.0.100']

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.