Note
This plugin is part of the community.network collection.
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.ce_ospf_vrf.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| bandwidth string | Specifies the reference bandwidth used to assign ospf cost. Valid values are an integer, in Mbps, 1 - 2147483648, the default value is 100. | |
| description string | Specifies the description information of ospf process. | |
| lsaaholdinterval string | Specifies the hold interval of arrive LSA when use the intelligent timer. Valid value is an integer, in millisecond, from 0 to 10000, the default value is 500. | |
| lsaainterval string | Specifies the interval of arrive LSA when use the general timer. Valid value is an integer, in millisecond, from 0 to 10000. | |
| lsaalflag boolean |
| Specifies the mode of timer to calculate interval of arrive LSA. If set the parameter but not specifies value, the default will be used. If true use general timer. If false use intelligent timer. |
| lsaamaxinterval string | Specifies the max interval of arrive LSA when use the intelligent timer. Valid value is an integer, in millisecond, from 0 to 10000, the default value is 1000. | |
| lsaastartinterval string | Specifies the start interval of arrive LSA when use the intelligent timer. Valid value is an integer, in millisecond, from 0 to 10000, the default value is 500. | |
| lsaoholdinterval string | Specifies the hold interval of originate LSA . Valid value is an integer, in millisecond, from 0 to 5000, the default value is 1000. | |
| lsaointerval string | Specifies the interval of originate LSA . Valid value is an integer, in second, from 0 to 10, the default value is 5. | |
| lsaointervalflag boolean |
| Specifies whether cancel the interval of LSA originate or not. If set the parameter but noe specifies value, the default will be used. true:cancel the interval of LSA originate, the interval is 0. false:do not cancel the interval of LSA originate. |
| lsaomaxinterval string | Specifies the max interval of originate LSA . Valid value is an integer, in millisecond, from 1 to 10000, the default value is 5000. | |
| lsaostartinterval string | Specifies the start interval of originate LSA . Valid value is an integer, in millisecond, from 0 to 1000, the default value is 500. | |
| ospf string / required | The ID of the ospf process. Valid values are an integer, 1 - 4294967295, the default value is 1. | |
| route_id string | Specifies the ospf private route id,. Valid values are a string, formatted as an IP address (i.e. "10.1.1.1") the length is 0 - 20. | |
| spfholdinterval string | Specifies the hold interval to calculate SPF when use intelligent timer. Valid value is an integer, in millisecond, from 1 to 5000, the default value is 200. | |
| spfinterval string | Specifies the interval to calculate SPF when use second level timer. Valid value is an integer, in second, from 1 to 10. | |
| spfintervalmi string | Specifies the interval to calculate SPF when use millisecond level timer. Valid value is an integer, in millisecond, from 1 to 10000. | |
| spfintervaltype string |
| Specifies the mode of timer which used to calculate SPF. If set the parameter but noe specifies value, the default will be used. If is intelligent-timer, then use intelligent timer. If is timer, then use second level timer. If is millisecond, then use millisecond level timer. |
| spfmaxinterval string | Specifies the max interval to calculate SPF when use intelligent timer. Valid value is an integer, in millisecond, from 1 to 20000, the default value is 5000. | |
| spfstartinterval string | Specifies the start interval to calculate SPF when use intelligent timer. Valid value is an integer, in millisecond, from 1 to 1000, the default value is 50. | |
| state string |
| Specify desired state of the resource. |
| vrf string | Default: "_public_" | Specifies the vpn instance which use ospf,length is 1 - 31. Valid values are a string. |
Note
netconf.local connections for legacy playbooks.- name: Ospf vrf 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 route id
community.network.ce_ospf_vrf:
ospf: 2
route_id: 2.2.2.2
lsaointervalflag: False
lsaointerval: 2
provider: "{{ cli }}"
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 |
| end_state dictionary | verbose mode | k/v pairs of configuration after module execution Sample: {'bandwidthReference': '100', 'description': None, 'lsaArrivalFlag': 'false', 'lsaArrivalHoldInterval': '500', 'lsaArrivalInterval': None, 'lsaArrivalMaxInterval': '1000', 'lsaArrivalStartInterval': '500', 'lsaOriginateHoldInterval': '1000', 'lsaOriginateInterval': '2', 'lsaOriginateIntervalFlag': 'false', 'lsaOriginateMaxInterval': '5000', 'lsaOriginateStartInterval': '500', 'processId': '2', 'routerId': '2.2.2.2', 'spfScheduleHoldInterval': '1000', 'spfScheduleInterval': None, 'spfScheduleIntervalMillisecond': None, 'spfScheduleIntervalType': 'intelligent-timer', 'spfScheduleMaxInterval': '10000', 'spfScheduleStartInterval': '500', 'vrfName': '_public_'} |
| existing dictionary | verbose mode | k/v pairs of existing configuration Sample: {'bandwidthReference': '100', 'description': None, 'lsaArrivalFlag': 'false', 'lsaArrivalHoldInterval': '500', 'lsaArrivalInterval': None, 'lsaArrivalMaxInterval': '1000', 'lsaArrivalStartInterval': '500', 'lsaOriginateHoldInterval': '1000', 'lsaOriginateInterval': '2', 'lsaOriginateIntervalFlag': 'false', 'lsaOriginateMaxInterval': '5000', 'lsaOriginateStartInterval': '500', 'processId': '2', 'routerId': '2.2.2.2', 'spfScheduleHoldInterval': '1000', 'spfScheduleInterval': None, 'spfScheduleIntervalMillisecond': None, 'spfScheduleIntervalType': 'intelligent-timer', 'spfScheduleMaxInterval': '10000', 'spfScheduleStartInterval': '500', 'vrfName': '_public_'} |
| proposed dictionary | verbose mode | k/v pairs of parameters passed into module Sample: {'bandwidth': '100', 'description': None, 'lsaaholdinterval': '500', 'lsaainterval': None, 'lsaalflag': 'False', 'lsaamaxinterval': '1000', 'lsaastartinterval': '500', 'lsaoholdinterval': '1000', 'lsaointerval': '2', 'lsaointervalflag': 'False', 'lsaomaxinterval': '5000', 'lsaostartinterval': '500', 'process_id': '2', 'route_id': '2.2.2.2', 'spfholdinterval': '1000', 'spfinterval': None, 'spfintervalmi': None, 'spfintervaltype': 'intelligent-timer', 'spfmaxinterval': '10000', 'spfstartinterval': '500', 'vrf': '_public_'} |
| updates list / elements=string | always | commands sent to the device Sample: ['ospf 2'] |
© 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_vrf_module.html