-
Notifications
You must be signed in to change notification settings - Fork 61
/
ios_static_route.yaml
138 lines (138 loc) · 5.55 KB
/
ios_static_route.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
module: ios_static_routes
short_description: Resource module to configure static routes.
description: This module configures and manages the static routes on IOS platforms.
version_added: 1.0.0
author:
- Sagar Paul (@KB-perByte)
- Sumit Jaiswal (@justjais)
notes:
- Tested against Cisco IOSXE Version 17.3 on CML.
- This module works with connection C(network_cli).
See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html)
- The module examples uses callback plugin (stdout_callback = yaml) to generate task
output in yaml format.
options:
config:
description: A dictionary of static route options
type: list
elements: dict
suboptions:
vrf:
description:
- IP VPN Routing/Forwarding instance name.
- NOTE, In case of IPV4/IPV6 VRF routing table should pre-exist before configuring.
- NOTE, if the vrf information is not provided then the routes shall be configured
under global vrf.
type: str
address_families:
elements: dict
description:
- Address family to use for the static routes
type: list
suboptions:
afi:
description:
- Top level address family indicator.
required: true
type: str
choices:
- ipv4
- ipv6
routes:
description: Configuring static route
type: list
elements: dict
suboptions:
dest:
description: Destination prefix with its subnet mask
type: str
required: true
topology:
description:
- Configure static route for a Topology Routing/Forwarding instance
- NOTE, VRF and Topology can be used together only with Multicast
and Topology should pre-exist before it can be used
type: str
next_hops:
description:
- next hop address or interface
type: list
elements: dict
suboptions:
forward_router_address:
description: Forwarding router's address
type: str
interface:
description: Interface for directly connected static routes
type: str
dhcp:
description: Default gateway obtained from DHCP
type: bool
distance_metric:
description: Distance metric for this route
type: int
global:
description: Next hop address is global
type: bool
name:
description: Specify name of the next hop
type: str
multicast:
description: multicast route
type: bool
unicast:
description: unicast route (ipv6 specific)
type: bool
permanent:
description: permanent route
type: bool
tag:
description:
- Set tag for this route
- Refer to vendor documentation for valid values.
type: int
track:
description:
- Install route depending on tracked item with tracked object
number.
- Tracking does not support multicast
- Refer to vendor documentation for valid values.
type: int
running_config:
description:
- This option is used only with state I(parsed).
- The value of this option should be the output received from the IOS
device by executing the command B(show running-config | include ip route|ipv6 route).
- The state I(parsed) reads the configuration from C(running_config)
option and transforms it into Ansible structured data as per the
resource module's argspec and the value is then returned in the
I(parsed) key within the result.
type: str
state:
description:
- The state the configuration should be left in
- The states I(rendered), I(gathered) and I(parsed) does not perform any change
on the device.
- The state I(rendered) will transform the configuration in C(config) option to
platform specific CLI commands which will be returned in the I(rendered) key
within the result. For state I(rendered) active connection to remote host is
not required.
- The state I(gathered) will fetch the running configuration from device and transform
it into structured data in the format as per the resource module argspec and
the value is returned in the I(gathered) key within the result.
- The state I(parsed) reads the configuration from C(running_config) option and
transforms it into JSON format as per the resource module parameters and the
value is returned in the I(parsed) key within the result. The value of C(running_config)
option should be the same format as the output of command I(show running-config
| include ip route|ipv6 route) executed on device. For state I(parsed) active
connection to remote host is not required.
type: str
choices:
- merged
- replaced
- overridden
- deleted
- gathered
- rendered
- parsed
default: merged