summaryrefslogtreecommitdiff
path: root/docs/vyos.vyos.vyos_ospf_interfaces_module.rst
diff options
context:
space:
mode:
authorNilashish Chakraborty <nilashishchakraborty8@gmail.com>2024-06-25 14:54:01 +0530
committerGitHub <noreply@github.com>2024-06-25 14:54:01 +0530
commitb872b6f21d14ff10c221d84217eb568318e9ad8b (patch)
tree0aacdea877a7e2b209735cd0f7c0b9d62a9446f7 /docs/vyos.vyos.vyos_ospf_interfaces_module.rst
parent37baff3d4d547911bec1387218edfd477ca79062 (diff)
downloadvyos.vyos-b872b6f21d14ff10c221d84217eb568318e9ad8b.tar.gz
vyos.vyos-b872b6f21d14ff10c221d84217eb568318e9ad8b.zip
`vyos.vyos` is no longer deprecated! 🎉 (#348)
* Remove deprecation notice for vyos.vyos Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com> * Add changelog Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com> * fix review comments Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com> * chore: auto fixes from pre-commit.com hooks --------- Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Diffstat (limited to 'docs/vyos.vyos.vyos_ospf_interfaces_module.rst')
-rw-r--r--docs/vyos.vyos.vyos_ospf_interfaces_module.rst174
1 files changed, 86 insertions, 88 deletions
diff --git a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst
index c2c5db6a..1c4b2263 100644
--- a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst
+++ b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst
@@ -471,29 +471,29 @@ Examples
# @vyos:~$ show configuration commands | match "ospf"
- - name: Merge provided configuration with device configuration
- vyos.vyos.vyos_ospf_interfaces:
- config:
- - name: "eth1"
- address_family:
- - afi: "ipv4"
- transmit_delay: 50
- priority: 26
- network: "point-to-point"
- - afi: "ipv6"
- dead_interval: 39
- - name: "bond2"
- address_family:
- - afi: "ipv4"
- transmit_delay: 45
- bandwidth: 70
- authentication:
- md5_key:
- key_id: 10
- key: "1111111111232345"
- - afi: "ipv6"
- passive: True
- state: merged
+ - name: Merge provided configuration with device configuration
+ vyos.vyos.vyos_ospf_interfaces:
+ config:
+ - name: "eth1"
+ address_family:
+ - afi: "ipv4"
+ transmit_delay: 50
+ priority: 26
+ network: "point-to-point"
+ - afi: "ipv6"
+ dead_interval: 39
+ - name: "bond2"
+ address_family:
+ - afi: "ipv4"
+ transmit_delay: 45
+ bandwidth: 70
+ authentication:
+ md5_key:
+ key_id: 10
+ key: "1111111111232345"
+ - afi: "ipv6"
+ passive: true
+ state: merged
# After State:
# --------------
@@ -580,9 +580,6 @@ Examples
# "set interfaces bonding bond2 ipv6 ospfv3 passive"
# ],
-
-
-
# Using replaced:
# Before State:
@@ -598,22 +595,22 @@ Examples
# set interfaces ethernet eth1 ip ospf transmit-delay '50'
# set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39'
- - name: Replace provided configuration with device configuration
- vyos.vyos.vyos_ospf_interfaces:
- config:
- - name: "eth1"
- address_family:
- - afi: "ipv4"
- cost: 100
- - afi: "ipv6"
- ifmtu: 33
- - name: "bond2"
- address_family:
- - afi: "ipv4"
- transmit_delay: 45
- - afi: "ipv6"
- passive: True
- state: replaced
+ - name: Replace provided configuration with device configuration
+ vyos.vyos.vyos_ospf_interfaces:
+ config:
+ - name: "eth1"
+ address_family:
+ - afi: "ipv4"
+ cost: 100
+ - afi: "ipv6"
+ ifmtu: 33
+ - name: "bond2"
+ address_family:
+ - afi: "ipv4"
+ transmit_delay: 45
+ - afi: "ipv6"
+ passive: true
+ state: replaced
# After State:
# -----------
@@ -742,17 +739,18 @@ Examples
# set interfaces ethernet eth1 ipv6 ospfv3 ifmtu '33'
# vyos@vyos:~$
- - name: Override device configuration with provided configuration
- vyos.vyos.vyos_ospf_interfaces:
- config:
- - name: "eth0"
- address_family:
- - afi: "ipv4"
- cost: 100
- - afi: "ipv6"
- ifmtu: 33
- passive: True
- state: overridden
+ - name: Override device configuration with provided configuration
+ vyos.vyos.vyos_ospf_interfaces:
+ config:
+ - name: "eth0"
+ address_family:
+ - afi: "ipv4"
+ cost: 100
+ - afi: "ipv6"
+ ifmtu: 33
+ passive: true
+ state: overridden
+
# After State:
# -----------
@@ -871,11 +869,11 @@ Examples
# set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39'
# vyos@vyos:~$
- - name: Delete device configuration
- vyos.vyos.vyos_ospf_interfaces:
- config:
- - name: "eth0"
- state: deleted
+ - name: Delete device configuration
+ vyos.vyos.vyos_ospf_interfaces:
+ config:
+ - name: "eth0"
+ state: deleted
# After State:
# -----------
@@ -1018,10 +1016,10 @@ Examples
# set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39'
#
- - name: parse configs
- vyos.vyos.vyos_ospf_interfaces:
- running_config: "{{ lookup('file', './parsed.cfg') }}"
- state: parsed
+ - name: parse configs
+ vyos.vyos.vyos_ospf_interfaces:
+ running_config: "{{ lookup('file', './parsed.cfg') }}"
+ state: parsed
# Module Execution:
# ----------------
@@ -1082,29 +1080,29 @@ Examples
# Using rendered:
# --------------
- - name: Render
- vyos.vyos.vyos_ospf_interfaces:
- config:
- - name: "eth1"
- address_family:
- - afi: "ipv4"
- transmit_delay: 50
- priority: 26
- network: "point-to-point"
- - afi: "ipv6"
- dead_interval: 39
- - name: "bond2"
- address_family:
- - afi: "ipv4"
- transmit_delay: 45
- bandwidth: 70
- authentication:
- md5_key:
- key_id: 10
- key: "1111111111232345"
- - afi: "ipv6"
- passive: True
- state: rendered
+ - name: Render
+ vyos.vyos.vyos_ospf_interfaces:
+ config:
+ - name: "eth1"
+ address_family:
+ - afi: "ipv4"
+ transmit_delay: 50
+ priority: 26
+ network: "point-to-point"
+ - afi: "ipv6"
+ dead_interval: 39
+ - name: "bond2"
+ address_family:
+ - afi: "ipv4"
+ transmit_delay: 45
+ bandwidth: 70
+ authentication:
+ md5_key:
+ key_id: 10
+ key: "1111111111232345"
+ - afi: "ipv6"
+ passive: true
+ state: rendered
# Module Execution:
# ----------------
@@ -1137,9 +1135,9 @@ Examples
# set interfaces ethernet eth1 ipv6 ospfv3 dead-interval '39'
# vyos@vyos:~$
- - name: gather configs
- vyos.vyos.vyos_ospf_interfaces:
- state: gathered
+ - name: gather configs
+ vyos.vyos.vyos_ospf_interfaces:
+ state: gathered
# Module Execution:
# -----------------