diff options
Diffstat (limited to 'docs/vyos.vyos.vyos_ospf_interfaces_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_ospf_interfaces_module.rst | 215 |
1 files changed, 108 insertions, 107 deletions
diff --git a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst index a74f53ca..9cf292a9 100644 --- a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst @@ -18,6 +18,7 @@ Version added: 1.2.0 Synopsis -------- - This module manages OSPF configuration of interfaces on devices running VYOS. +- The provided examples of commands are valid for VyOS 1.4+ @@ -499,14 +500,14 @@ Examples # -------------- # vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345' - # set interfaces bonding bond2 ip ospf bandwidth '70' - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth1 ip ospf network 'point-to-point' - # set interfaces ethernet eth1 ip ospf priority '26' - # set interfaces ethernet eth1 ip ospf transmit-delay '50' - # set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39' + # set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345' + # set protocols ospf interface bond2 bandwidth '70' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth1 network 'point-to-point' + # set protocols ospf interface eth1 priority '26' + # set protocols ospf interface eth1 transmit-delay '50' + # set protocols ospfv3 interface eth1 dead-interval '39' # "after": [ # " @@ -570,14 +571,14 @@ Examples # ], # "changed": true, # "commands": [ - # "set interfaces ethernet eth1 ip ospf transmit-delay 50", - # "set interfaces ethernet eth1 ip ospf priority 26", - # "set interfaces ethernet eth1 ip ospf network point-to-point", - # "set interfaces ethernet eth1 ipv6 ospfv3 dead-interval 39", - # "set interfaces bonding bond2 ip ospf transmit-delay 45", - # "set interfaces bonding bond2 ip ospf bandwidth 70", - # "set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key 1111111111232345", - # "set interfaces bonding bond2 ipv6 ospfv3 passive" + # "set protocols ospf interface eth1 transmit-delay 50", + # "set protocols ospf interface eth1 priority 26", + # "set protocols ospf interface eth1 network point-to-point", + # "set protocols ospfv3 interface eth1 dead-interval 39", + # "set protocols ospf interface bond2 transmit-delay 45", + # "set protocols ospf interface bond2 bandwidth 70", + # "set protocols ospf interface bond2 authentication md5 key-id 10 md5-key 1111111111232345", + # "set protocols ospfv3 interface bond2 passive" # ], # Using replaced: @@ -586,14 +587,14 @@ Examples # ------------ # vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345' - # set interfaces bonding bond2 ip ospf bandwidth '70' - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth1 ip ospf network 'point-to-point' - # set interfaces ethernet eth1 ip ospf priority '26' - # set interfaces ethernet eth1 ip ospf transmit-delay '50' - # set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39' + # set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345' + # set protocols ospf interface bond2 bandwidth '70' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth1 network 'point-to-point' + # set protocols ospf interface eth1 priority '26' + # set protocols ospf interface eth1 transmit-delay '50' + # set protocols ospfv3 interface eth1 dead-interval '39' - name: Replace provided configuration with device configuration vyos.vyos.vyos_ospf_interfaces: @@ -616,10 +617,10 @@ Examples # ----------- # vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth1 ip ospf cost '100' - # set interfaces ethernet eth1 ipv6 ospfv3 ifmtu '33' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth1 cost '100' + # set protocols ospfv3 interface eth1 ifmtu '33' # vyos@vyos:~$ # Module Execution @@ -709,14 +710,14 @@ Examples # ], # "changed": true, # "commands": [ - # "set interfaces ethernet eth1 ip ospf cost 100", - # "set interfaces ethernet eth1 ipv6 ospfv3 ifmtu 33", - # "delete interfaces ethernet eth1 ip ospf network point-to-point", - # "delete interfaces ethernet eth1 ip ospf priority 26", - # "delete interfaces ethernet eth1 ip ospf transmit-delay 50", - # "delete interfaces ethernet eth1 ipv6 ospfv3 dead-interval 39", - # "delete interfaces bonding bond2 ip ospf authentication", - # "delete interfaces bonding bond2 ip ospf bandwidth 70" + # "set protocols ospf interface eth1 cost 100", + # "set protocols ospfv3 interface eth1 ifmtu 33", + # "delete protocols ospf interface eth1 network point-to-point", + # "delete protocols ospf interface eth1 priority 26", + # "delete protocols ospf interface eth1 transmit-delay 50", + # "delete protocols ospfv3 interface eth1 dead-interval 39", + # "delete protocols ospf interface bond2 authentication", + # "delete protocols ospf interface bond2 bandwidth 70" # ], # @@ -727,16 +728,16 @@ Examples # ------------ # vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345' - # set interfaces bonding bond2 ip ospf bandwidth '70' - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth1 ip ospf cost '100' - # set interfaces ethernet eth1 ip ospf network 'point-to-point' - # set interfaces ethernet eth1 ip ospf priority '26' - # set interfaces ethernet eth1 ip ospf transmit-delay '50' - # set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39' - # set interfaces ethernet eth1 ipv6 ospfv3 ifmtu '33' + # set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345' + # set protocols ospf interface bond2 bandwidth '70' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth1 cost '100' + # set protocols ospf interface eth1 network 'point-to-point' + # set protocols ospf interface eth1 priority '26' + # set protocols ospf interface eth1 transmit-delay '50' + # set protocols ospfv3 interface eth1 dead-interval '39' + # set protocols ospfv3 interface eth1 ifmtu '33' # vyos@vyos:~$ - name: Override device configuration with provided configuration @@ -755,9 +756,9 @@ Examples # ----------- # 200~vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces ethernet eth0 ip ospf cost '100' - # set interfaces ethernet eth0 ipv6 ospfv3 ifmtu '33' - # set interfaces ethernet eth0 ipv6 ospfv3 'passive' + # set protocols ospf interface eth0 cost '100' + # set protocols ospfv3 interface eth0 ifmtu '33' + # set protocols ospfv3 interface eth0 'passive' # vyos@vyos:~$ # # @@ -839,13 +840,13 @@ Examples # ], # "changed": true, # "commands": [ - # "delete interfaces bonding bond2 ip ospf", - # "delete interfaces bonding bond2 ipv6 ospfv3", - # "delete interfaces ethernet eth1 ip ospf", - # "delete interfaces ethernet eth1 ipv6 ospfv3", - # "set interfaces ethernet eth0 ip ospf cost 100", - # "set interfaces ethernet eth0 ipv6 ospfv3 ifmtu 33", - # "set interfaces ethernet eth0 ipv6 ospfv3 passive" + # "delete protocols ospf interface bond2", + # "delete protocols ospfv3 interface bond2", + # "delete protocols ospf interface eth1", + # "delete protocols ospfv3 interface eth1", + # "set protocols ospf interface eth0 cost 100", + # "set protocols ospfv3 interface eth0 ifmtu 33", + # "set protocols ospfv3 interface eth0 passive" # ], # @@ -856,17 +857,17 @@ Examples # ------------- # vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345' - # set interfaces bonding bond2 ip ospf bandwidth '70' - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth0 ip ospf cost '100' - # set interfaces ethernet eth0 ipv6 ospfv3 ifmtu '33' - # set interfaces ethernet eth0 ipv6 ospfv3 'passive' - # set interfaces ethernet eth1 ip ospf network 'point-to-point' - # set interfaces ethernet eth1 ip ospf priority '26' - # set interfaces ethernet eth1 ip ospf transmit-delay '50' - # set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39' + # set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345' + # set protocols ospf interface bond2 bandwidth '70' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth0 cost '100' + # set protocols ospfv3 interface eth0 ifmtu '33' + # set protocols ospfv3 interface eth0 'passive' + # set protocols ospf interface eth1 network 'point-to-point' + # set protocols ospf interface eth1 priority '26' + # set protocols ospf interface eth1 transmit-delay '50' + # set protocols ospfv3 interface eth1 dead-interval '39' # vyos@vyos:~$ - name: Delete device configuration @@ -879,14 +880,14 @@ Examples # ----------- # vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345' - # set interfaces bonding bond2 ip ospf bandwidth '70' - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth1 ip ospf network 'point-to-point' - # set interfaces ethernet eth1 ip ospf priority '26' - # set interfaces ethernet eth1 ip ospf transmit-delay '50' - # set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39' + # set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345' + # set protocols ospf interface bond2 bandwidth '70' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth1 network 'point-to-point' + # set protocols ospf interface eth1 priority '26' + # set protocols ospf interface eth1 transmit-delay '50' + # set protocols ospfv3 interface eth1 dead-interval '39' # vyos@vyos:~$ # # @@ -995,25 +996,25 @@ Examples # ], # "changed": true, # "commands": [ - # "delete interfaces ethernet eth0 ip ospf", - # "delete interfaces ethernet eth0 ipv6 ospfv3" + # "delete protocols ospf interface eth0", + # "delete protocols ospfv3 interface eth0" # ], # # Using parsed: # parsed.cfg: - # set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345' - # set interfaces bonding bond2 ip ospf bandwidth '70' - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth0 ip ospf cost '50' - # set interfaces ethernet eth0 ip ospf priority '26' - # set interfaces ethernet eth0 ipv6 ospfv3 instance-id '33' - # set interfaces ethernet eth0 ipv6 ospfv3 'mtu-ignore' - # set interfaces ethernet eth1 ip ospf network 'point-to-point' - # set interfaces ethernet eth1 ip ospf priority '26' - # set interfaces ethernet eth1 ip ospf transmit-delay '50' - # set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39' + # set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345' + # set protocols ospf interface bond2 bandwidth '70' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth0 cost '50' + # set protocols ospf interface eth0 priority '26' + # set protocols ospfv3 interface eth0 instance-id '33' + # set protocols ospfv3 interface eth0 'mtu-ignore' + # set protocols ospf interface eth1 network 'point-to-point' + # set protocols ospf interface eth1 priority '26' + # set protocols ospf interface eth1 transmit-delay '50' + # set protocols ospfv3 interface eth1 dead-interval '39' # - name: parse configs @@ -1108,14 +1109,14 @@ Examples # ---------------- # "rendered": [ - # "set interfaces ethernet eth1 ip ospf transmit-delay 50", - # "set interfaces ethernet eth1 ip ospf priority 26", - # "set interfaces ethernet eth1 ip ospf network point-to-point", - # "set interfaces ethernet eth1 ipv6 ospfv3 dead-interval 39", - # "set interfaces bonding bond2 ip ospf transmit-delay 45", - # "set interfaces bonding bond2 ip ospf bandwidth 70", - # "set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key 1111111111232345", - # "set interfaces bonding bond2 ipv6 ospfv3 passive" + # "set protocols ospf interface eth1 transmit-delay 50", + # "set protocols ospf interface eth1 priority 26", + # "set protocols ospf interface eth1 network point-to-point", + # "set protocols ospfv3 interface eth1 dead-interval 39", + # "set protocols ospf interface bond2 transmit-delay 45", + # "set protocols ospf interface bond2 bandwidth 70", + # "set protocols ospf interface bond2 authentication md5 key-id 10 md5-key 1111111111232345", + # "set protocols ospfv3 interface bond2 passive" # ] # @@ -1125,14 +1126,14 @@ Examples # Native Config: # vyos@vyos:~$ show configuration commands | match "ospf" - # set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345' - # set interfaces bonding bond2 ip ospf bandwidth '70' - # set interfaces bonding bond2 ip ospf transmit-delay '45' - # set interfaces bonding bond2 ipv6 ospfv3 'passive' - # set interfaces ethernet eth1 ip ospf network 'point-to-point' - # set interfaces ethernet eth1 ip ospf priority '26' - # set interfaces ethernet eth1 ip ospf transmit-delay '50' - # set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39' + # set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345' + # set protocols ospf interface bond2 bandwidth '70' + # set protocols ospf interface bond2 transmit-delay '45' + # set protocols ospfv3 interface bond2 'passive' + # set protocols ospf interface eth1 network 'point-to-point' + # set protocols ospf interface eth1 priority '26' + # set protocols ospf interface eth1 transmit-delay '50' + # set protocols ospfv3 interface eth1 dead-interval '39' # vyos@vyos:~$ - name: gather configs @@ -1251,7 +1252,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div>The set of commands pushed to the remote device.</div> <br/> <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">["set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345'", "set interfaces bonding bond2 ip ospf bandwidth '70'", "set interfaces bonding bond2 ip ospf transmit-delay '45'"]</div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">["set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345'", "set protocols ospf interface bond2 bandwidth '70'", "set protocols ospf interface bond2 transmit-delay '45'"]</div> </td> </tr> <tr> @@ -1302,7 +1303,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div>The provided configuration in the task rendered in device-native format (offline).</div> <br/> <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">["set interfaces bonding bond2 ip ospf authentication md5 key-id 10 md5-key '1111111111232345'", "set interfaces bonding bond2 ip ospf bandwidth '70'", "set interfaces bonding bond2 ip ospf transmit-delay '45'"]</div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">["set protocols ospf interface bond2 authentication md5 key-id 10 md5-key '1111111111232345'", "set protocols ospf interface bond2 bandwidth '70'", "set protocols ospf interface bond2 transmit-delay '45'"]</div> </td> </tr> </table> |