community.network.ce_interface_ospf – Manages configuration of an OSPF interface instanceon HUAWEI CloudEngine switches.
Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.ce_interface_ospf
.
Parameters
Parameter |
Comments |
---|---|
Ospf area associated with this ospf process. Valid values are a string, formatted as an IP address (i.e. “0.0.0.0”) or as an integer between 1 and 4294967295. |
|
Authentication key id when |
|
Specifies the authentication type. Choices:
|
|
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. |
|
Specifies a password for simple authentication. The value is a string of 1 to 8 characters. |
|
The cost associated with this interface. Valid values are an integer in the range from 1 to 65535. |
|
Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer in the range from 1 to 235926000. |
|
Time between sending successive hello packets. Valid values are an integer in the range from 1 to 65535. |
|
Full name of interface, i.e. 40GE1/0/10. |
|
Specifies a process ID. The value is an integer ranging from 1 to 4294967295. |
|
Setting to true will prevent this interface from receiving HELLO packets. Valid values are ‘true’ and ‘false’. Choices:
|
|
Determines whether the config should be present or not on the device. Choices:
|
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: Eth_trunk 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: Enables OSPF and sets the cost on an interface
community.network.ce_interface_ospf:
interface: 10GE1/0/30
process_id: 1
area: 100
cost: 100
provider: '{{ cli }}'
- name: Sets the dead interval of the OSPF neighbor
community.network.ce_interface_ospf:
interface: 10GE1/0/30
process_id: 1
area: 100
dead_interval: 100
provider: '{{ cli }}'
- name: Sets the interval for sending Hello packets on an interface
community.network.ce_interface_ospf:
interface: 10GE1/0/30
process_id: 1
area: 100
hello_interval: 2
provider: '{{ cli }}'
- name: Disables an interface from receiving and sending OSPF packets
community.network.ce_interface_ospf:
interface: 10GE1/0/30
process_id: 1
area: 100
silent_interface: true
provider: '{{ cli }}'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: true |
|
k/v pairs of configuration after module execution Returned: verbose mode Sample: {“area”: “0.0.0.100”, “auth_mode”: “none”, “cost”: “100”, “dead_interval”: “40”, “hello_interval”: “10”, “interface”: “10GE1/0/30”, “process_id”: “1”, “silent_interface”: “false”} |
|
k/v pairs of existing configuration Returned: verbose mode Sample: {“area”: “0.0.0.100”, “process_id”: “1”} |
|
k/v pairs of parameters passed into module Returned: verbose mode Sample: {“area”: “0.0.0.100”, “cost”: “100”, “interface”: “10GE1/0/30”, “process_id”: “1”} |
|
commands sent to the device Returned: always Sample: [“interface 10GE1/0/30”, “ospf enable 1 area 0.0.0.100”, “ospf cost 100”] |
Authors
QijunPan (@QijunPan)