summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_static_route.py
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/modules/vyos_static_route.py')
-rw-r--r--plugins/modules/vyos_static_route.py12
1 files changed, 11 insertions, 1 deletions
diff --git a/plugins/modules/vyos_static_route.py b/plugins/modules/vyos_static_route.py
index e0c40e7..af9a1e3 100644
--- a/plugins/modules/vyos_static_route.py
+++ b/plugins/modules/vyos_static_route.py
@@ -21,7 +21,7 @@
ANSIBLE_METADATA = {
"metadata_version": "1.1",
- "status": ["preview"],
+ "status": ["deprecated"],
"supported_by": "network",
}
@@ -32,6 +32,10 @@ short_description: Manage static IP routes on Vyatta VyOS network devices
description:
- This module provides declarative management of static IP routes on Vyatta VyOS network
devices.
+deprecated:
+ removed_in: '2.13'
+ alternative: vyos_static_routes
+ why: Updated modules released with more functionality.
notes:
- Tested against VyOS 1.1.8 (helium).
- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html).
@@ -40,17 +44,22 @@ options:
description:
- Network prefix of the static route. C(mask) param should be ignored if C(prefix)
is provided with C(mask) value C(prefix/mask).
+ type: str
mask:
description:
- Network prefix mask of the static route.
+ type: str
next_hop:
description:
- Next hop IP of the static route.
+ type: str
admin_distance:
description:
- Admin distance of the static route.
+ type: int
aggregate:
description: List of static route definitions
+ type: list
state:
description:
- State of the static route configuration.
@@ -58,6 +67,7 @@ options:
choices:
- present
- absent
+ type: str
extends_documentation_fragment:
- vyos.vyos.vyos
"""