├── .ansible-lint ├── .gitignore ├── LICENSE ├── README.md ├── ansible-navigator.log ├── ansible.cfg ├── changelogs └── config.yaml ├── collections └── requirements.yml ├── docs └── CODEOWNERS ├── galaxy.yml ├── meta └── runtime.yml ├── network-toolkit-1.0.0.tar.gz ├── playbooks ├── network_backup.yml ├── network_banner.yml ├── network_commands.yml ├── network_l3_interface.yml ├── network_reload.yml ├── network_report.yml ├── network_report_legacy.yml ├── network_restore.yml ├── network_system.yml ├── network_time.yml ├── network_user.yml ├── network_vlans.yml └── templates │ └── backup.j2 ├── roles ├── README.md ├── backup │ ├── README.md │ └── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ ├── main.yml │ │ └── unsupported_platform.yml ├── banner │ ├── README.md │ └── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ ├── main.yml │ │ └── nxos.yml ├── build_report │ ├── README.md │ ├── files │ │ ├── css │ │ │ └── main.css │ │ ├── redhat-ansible-logo.svg │ │ ├── router.png │ │ └── webpage_logo.png │ ├── tasks │ │ └── main.yml │ ├── templates │ │ ├── ansible.j2 │ │ ├── bgp.j2 │ │ ├── bgp_address_family.j2 │ │ ├── header.j2 │ │ ├── interfaces.j2 │ │ ├── l2_interfaces.j2 │ │ ├── l3_interfaces.j2 │ │ ├── lacp.j2 │ │ ├── lldp_interfaces.j2 │ │ ├── ospf.j2 │ │ ├── report.j2 │ │ ├── static.j2 │ │ └── vlans.j2 │ └── vars │ │ └── main.yml ├── build_report_container │ ├── README.md │ ├── files │ │ ├── css │ │ │ └── main.css │ │ ├── redhat-ansible-logo.svg │ │ ├── router.png │ │ └── webpage_logo.png │ ├── tasks │ │ └── main.yml │ ├── templates │ │ ├── ansible.j2 │ │ ├── bgp.j2 │ │ ├── bgp_address_family.j2 │ │ ├── header.j2 │ │ ├── interfaces.j2 │ │ ├── l2_interfaces.j2 │ │ ├── l3_interfaces.j2 │ │ ├── lacp.j2 │ │ ├── lldp_interfaces.j2 │ │ ├── ospf.j2 │ │ ├── report.j2 │ │ ├── static.j2 │ │ └── vlans.j2 │ └── vars │ │ └── main.yml ├── facts │ ├── README.md │ └── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ ├── main.yml │ │ └── unsupported_platform.yml ├── l3_interface │ ├── README.md │ ├── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ ├── main.yml │ │ └── unsupported_platform.yml │ └── vars │ │ └── main.yml ├── read_interfaces │ ├── README.md │ ├── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ ├── main.yml │ │ └── unsupported_platform.yml │ └── vars │ │ └── main.yml ├── reload │ ├── README.md │ ├── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ ├── main.yml │ │ └── unsupported_platform.yml │ └── vars │ │ └── main.yml ├── restore │ ├── README.md │ └── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── ios │ │ ├── merge.yml │ │ └── overwrite.yml │ │ ├── junos.yml │ │ ├── main.yml │ │ └── unsupported_platform.yml ├── system │ ├── README.md │ └── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ └── main.yml ├── user │ ├── README.md │ └── tasks │ │ ├── eos.yml │ │ ├── ios.yml │ │ ├── junos.yml │ │ └── main.yml └── vlans │ ├── README.md │ └── tasks │ ├── eos.yml │ ├── ios.yml │ ├── junos.yml │ ├── main.yml │ └── unsupported_platform.yml ├── setup ├── README.md ├── network_time.json ├── setup.yaml ├── setup_playbook.yaml ├── survey_spec.json ├── system.json └── user.json └── templates ├── eos_show_interface.txt └── eos_show_interface.yaml /.ansible-lint: -------------------------------------------------------------------------------- 1 | exclude_paths: 2 | - network_setup/ 3 | 4 | skip_list: 5 | - role-name[path] # https://issues.redhat.com/browse/AAPRFE-735 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | .DS_Store 3 | ansible.cfg 4 | .vscode/settings.json 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Red Hat Ansible Automation Platform - Network Tool Kit 2 | 3 | This is an Ansible Content Collection focused on the network automation domain. It contains roles and playbooks to help people quickly adopt some network automation use-cases with Ansible Automation Platform. 4 | 5 | ## Install 6 | 7 | You can install this Ansible content with ansible-galaxy 8 | 9 | ``` 10 | ansible-galaxy collection install network.toolkit 11 | ``` 12 | 13 | ## Ansible Network Automation Workshop 14 | 15 | This Ansible Network Collection is used in conjunction with the Ansible Network Automation Workshop. The workshops are instructor-led exercises to teach Ansible Automation. 16 | 17 | Please refer to rollowing links for more information and perscriptive exercises: 18 | - The Workshops Landing Page - [https://ansible.github.io/workshops](https://ansible.github.io/workshops) 19 | - The Github Source - [https://www.github.com/ansible/workshops](https://www.github.com/ansible/workshops) 20 | 21 | ## Network roles 22 | 23 | - [network.toolkit.backup](roles/backup/README.md) 24 | - [network.toolkit.banner](roles/banner/README.md) 25 | - [network.toolkit.build_report](roles/build_report/README.md) 26 | - [network.toolkit.facts](roles/facts/README.md) 27 | - [network.toolkit.l3_interface](roles/l3_interface/README.md) 28 | - [network.toolkit.reload](roles/reload/README.md) 29 | - [network.toolkit.restore](roles/restore/README.md) 30 | - [network.toolkit.system](roles/system/README.md) 31 | - [network.toolkit.user](roles/user/README.md) 32 | 33 | # License 34 | 35 | [GNU General Public License v3.0 or later](LICENSE) 36 | -------------------------------------------------------------------------------- /ansible-navigator.log: -------------------------------------------------------------------------------- 1 | 2025-01-07T17:15:13.305170+00:00 ERROR 'ansible_navigator.actions.images._parse' Unable to extract introspection from stdout 2 | Traceback (most recent call last): 3 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 4 | _warnings, json_str = output.split("{", 1) 5 | ^^^^^^^^^^^^^^^^^^^ 6 | ValueError: not enough values to unpack (expected 2, got 1) 7 | 2025-01-07T17:15:13.310143+00:00 ERROR 'ansible_navigator.actions.images._parse' Image introspection failed (parsed), the return value was: Traceback (most recent call last): 8 | File "/Users/sean/.cache/ansible-navigator/image_introspect.py", line 16, in 9 | from typing import TypeAlias 10 | ImportError: cannot import name 'TypeAlias' from 'typing' (/usr/lib64/python3.9/typing.py) 11 | Traceback (most recent call last): 12 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 13 | _warnings, json_str = output.split("{", 1) 14 | ^^^^^^^^^^^^^^^^^^^ 15 | ValueError: not enough values to unpack (expected 2, got 1) 16 | 2025-01-07T17:15:31.237618+00:00 ERROR 'ansible_navigator.actions.images._parse' Unable to extract introspection from stdout 17 | Traceback (most recent call last): 18 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 19 | _warnings, json_str = output.split("{", 1) 20 | ^^^^^^^^^^^^^^^^^^^ 21 | ValueError: not enough values to unpack (expected 2, got 1) 22 | 2025-01-07T17:15:31.239087+00:00 ERROR 'ansible_navigator.actions.images._parse' Image introspection failed (parsed), the return value was: Traceback (most recent call last): 23 | File "/Users/sean/.cache/ansible-navigator/image_introspect.py", line 16, in 24 | from typing import TypeAlias 25 | ImportError: cannot import name 'TypeAlias' from 'typing' (/usr/lib64/python3.9/typing.py) 26 | Traceback (most recent call last): 27 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 28 | _warnings, json_str = output.split("{", 1) 29 | ^^^^^^^^^^^^^^^^^^^ 30 | ValueError: not enough values to unpack (expected 2, got 1) 31 | 2025-01-07T17:17:24.718515+00:00 ERROR 'ansible_navigator.actions.images._parse' Unable to extract introspection from stdout 32 | Traceback (most recent call last): 33 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 34 | _warnings, json_str = output.split("{", 1) 35 | ^^^^^^^^^^^^^^^^^^^ 36 | ValueError: not enough values to unpack (expected 2, got 1) 37 | 2025-01-07T17:17:24.722272+00:00 ERROR 'ansible_navigator.actions.images._parse' Image introspection failed (parsed), the return value was: Traceback (most recent call last): 38 | File "/Users/sean/.cache/ansible-navigator/image_introspect.py", line 16, in 39 | from typing import TypeAlias 40 | ImportError: cannot import name 'TypeAlias' from 'typing' (/usr/lib64/python3.9/typing.py) 41 | Traceback (most recent call last): 42 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 43 | _warnings, json_str = output.split("{", 1) 44 | ^^^^^^^^^^^^^^^^^^^ 45 | ValueError: not enough values to unpack (expected 2, got 1) 46 | 2025-01-07T17:24:57.087419+00:00 ERROR 'ansible_navigator.actions.images._parse' Unable to extract introspection from stdout 47 | Traceback (most recent call last): 48 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 49 | _warnings, json_str = output.split("{", 1) 50 | ^^^^^^^^^^^^^^^^^^^ 51 | ValueError: not enough values to unpack (expected 2, got 1) 52 | 2025-01-07T17:24:57.091932+00:00 ERROR 'ansible_navigator.actions.images._parse' Image introspection failed (parsed), the return value was: Traceback (most recent call last): 53 | File "/Users/sean/.cache/ansible-navigator/image_introspect.py", line 16, in 54 | from typing import TypeAlias 55 | ImportError: cannot import name 'TypeAlias' from 'typing' (/usr/lib64/python3.9/typing.py) 56 | Traceback (most recent call last): 57 | File "/usr/local/lib/python3.11/site-packages/ansible_navigator/actions/images.py", line 537, in _parse 58 | _warnings, json_str = output.split("{", 1) 59 | ^^^^^^^^^^^^^^^^^^^ 60 | ValueError: not enough values to unpack (expected 2, got 1) 61 | -------------------------------------------------------------------------------- /ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | host_key_checking = False 3 | retry_files_enabled = False 4 | no_target_syslog = False 5 | -------------------------------------------------------------------------------- /changelogs/config.yaml: -------------------------------------------------------------------------------- 1 | changelog_filename_template: ../CHANGELOG.rst 2 | changelog_filename_version_depth: 0 3 | changes_file: changelog.yaml 4 | changes_format: combined 5 | ignore_other_fragment_extensions: true 6 | keep_fragments: false 7 | mention_ancestor: true 8 | new_plugins_after_name: removed_features 9 | notesdir: fragments 10 | prelude_section_name: release_summary 11 | prelude_section_title: Release Summary 12 | sanitize_changelog: true 13 | sections: 14 | - - major_changes 15 | - Major Changes 16 | - - minor_changes 17 | - Minor Changes 18 | - - breaking_changes 19 | - Breaking Changes / Porting Guide 20 | - - deprecated_features 21 | - Deprecated Features 22 | - - removed_features 23 | - Removed Features (previously deprecated) 24 | - - security_fixes 25 | - Security Fixes 26 | - - bugfixes 27 | - Bugfixes 28 | - - known_issues 29 | - Known Issues 30 | title: Network.Toolkit 31 | trivial_section_name: trivial 32 | use_fqcn: true 33 | -------------------------------------------------------------------------------- /collections/requirements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | collections: 3 | - cisco.ios 4 | - arista.eos 5 | - junipernetworks.junos 6 | - awx.awx 7 | -------------------------------------------------------------------------------- /docs/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # These owners will be the default owners for everything in 2 | # the repo. Unless a later match takes precedence, 3 | # @global-owner1 and @global-owner2 will be requested for 4 | # review when someone opens a pull request. 5 | * @IPvSean @dafmendo -------------------------------------------------------------------------------- /galaxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | namespace: network 3 | name: toolkit 4 | version: 1.0.0 5 | readme: README.md 6 | 7 | authors: 8 | - Sean Cavanaugh @IPvSean 9 | - Ajay Chenampara @termlen0 10 | 11 | description: repository of demos to showcase Ansible Network Automation. 12 | 13 | license: 14 | - GPL-3.0-or-later 15 | 16 | tags: 17 | - networking 18 | - tools 19 | 20 | dependencies: 21 | "cisco.ios": ">=2.2.0" 22 | "arista.eos": ">=2.1.2" 23 | "junipernetworks.junos": ">=2.2.0" 24 | "ansible.utils": ">=2.2.0" 25 | 26 | build_ignore: 27 | - network_setup 28 | - '*.tar.gz' 29 | - roles/l3_interface 30 | 31 | 32 | repository: http://github.com/network-automation/toolkit 33 | documentation: http://github.com/network-automation/toolkit 34 | homepage: http://github.com/network-automation/toolkit 35 | issues: https://github.com/network-automation/toolkit/issues 36 | -------------------------------------------------------------------------------- /meta/runtime.yml: -------------------------------------------------------------------------------- 1 | --- 2 | requires_ansible: ">=2.15" -------------------------------------------------------------------------------- /network-toolkit-1.0.0.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/network-automation/toolkit/b457fc3ae85cd92065e207fb1f421a7f1f08bb43/network-toolkit-1.0.0.tar.gz -------------------------------------------------------------------------------- /playbooks/network_backup.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Retrieve network configurations 3 | hosts: network 4 | gather_facts: false 5 | 6 | tasks: 7 | # fail with good error for Automation controller user 8 | - name: Determine that both AAP and Machine credentials are set 9 | ansible.builtin.assert: 10 | that: 11 | - "lookup('env', 'CONTROLLER_USERNAME') !=''" 12 | fail_msg: 13 | - "This Job requires two credentials" 14 | - "Red Hat Ansible Automation Platform credential is not set" 15 | - "Please assign correct credentials to the Job Template" 16 | 17 | - name: Determine that both AAP and Machine credentials are set 18 | ansible.builtin.debug: 19 | msg: 20 | - "{{ lookup('env', 'CONTROLLER_USERNAME') }}" 21 | - "{{ lookup('env', 'CONTROLLER_PASSWORD') }}" 22 | - "{{ lookup('env', 'CONTROLLER_HOST') }}" 23 | 24 | - name: Backup configuration 25 | ansible.builtin.include_role: 26 | name: "../roles/backup" 27 | when: ansible_network_os is defined 28 | 29 | - name: Create time stamp for play 30 | ansible.builtin.set_fact: 31 | datetime: "{{ lookup('pipe', 'date +%Y-%m-%d-%H-%M') }}" 32 | delegate_to: backup-server 33 | delegate_facts: true 34 | run_once: true 35 | 36 | - name: Create a directory if it does not exist 37 | ansible.builtin.file: 38 | path: /backup/ 39 | state: directory 40 | mode: "755" 41 | delegate_to: backup-server 42 | become: true 43 | run_once: true 44 | 45 | - name: Save configuration to backup server 46 | ansible.builtin.copy: 47 | src: "{{ config_output.backup_path }}" 48 | dest: "/backup/{{ hostvars['backup-server'].datetime }}/" 49 | mode: "644" 50 | when: config_output is defined 51 | become: true 52 | delegate_to: backup-server 53 | 54 | - name: Find backups 55 | ansible.builtin.find: 56 | paths: /backup 57 | file_type: directory 58 | register: backups 59 | run_once: true 60 | become: true 61 | delegate_to: backup-server 62 | delegate_facts: true 63 | 64 | - name: Create restore job template 65 | ansible.controller.job_template: 66 | name: "Network Automation - Restore" 67 | job_type: "run" 68 | inventory: "{{ restore_inventory | default('Network Inventory') }}" 69 | project: "{{ restore_project | default('Network Toolkit') }}" 70 | playbook: "{{ restores_playbook | default('playbooks/network_restore.yml') }}" 71 | credential: "{{ restore_credential | default('Network Credential') }}" 72 | survey_enabled: true 73 | survey_spec: "{{ lookup('template', '{{ playbook_dir }}/templates/backup.j2') }}" 74 | validate_certs: false 75 | execution_environment: "network workshop execution environment" 76 | run_once: true 77 | -------------------------------------------------------------------------------- /playbooks/network_banner.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Set router banners 3 | hosts: network 4 | gather_facts: false 5 | 6 | tasks: 7 | - name: Load banner onto network device 8 | vars: 9 | - network_banner: "{{ net_banner | default(None) }}" 10 | - banner_type: "{{ net_type | default('login') }}" 11 | ansible.builtin.include_role: 12 | name: "../roles/banner" 13 | -------------------------------------------------------------------------------- /playbooks/network_commands.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: CLI command playbook 3 | hosts: all 4 | gather_facts: false 5 | vars: 6 | ansible_connection: network_cli 7 | 8 | tasks: 9 | - name: Specified command is run 10 | ansible.netcommon.cli_command: 11 | command: "{{ controller_input | default('show version') }}" 12 | when: ansible_network_os is defined 13 | register: output 14 | 15 | - name: Return results to terminal 16 | ansible.builtin.debug: 17 | msg: "{{ output.stdout_lines }}" 18 | when: ansible_network_os is defined 19 | -------------------------------------------------------------------------------- /playbooks/network_l3_interface.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure l3 interface 3 | hosts: routers 4 | gather_facts: false 5 | 6 | tasks: 7 | 8 | - name: Load l3 interface role 9 | ansible.builtin.include_role: 10 | name: ../roles/l3_interface 11 | -------------------------------------------------------------------------------- /playbooks/network_reload.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reboot network devices 3 | hosts: routers 4 | gather_facts: false 5 | 6 | tasks: 7 | - name: Use reload role 8 | ansible.builtin.include_role: 9 | name: "../roles/reload" 10 | -------------------------------------------------------------------------------- /playbooks/network_report.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Retrieve facts for network infrastructure 3 | hosts: network 4 | gather_facts: false 5 | 6 | tasks: 7 | - name: Load read interfaces role 8 | ansible.builtin.include_role: 9 | name: "../roles/facts" 10 | 11 | - name: Build report with facts 12 | hosts: ansible-1 13 | become: true 14 | gather_facts: false 15 | 16 | tasks: 17 | 18 | - name: Build a report 19 | ansible.builtin.include_role: 20 | name: "../roles/build_report_container" 21 | -------------------------------------------------------------------------------- /playbooks/network_report_legacy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Retrieve facts for network infrastructure 3 | hosts: network 4 | gather_facts: false 5 | 6 | tasks: 7 | - name: Load read interfaces role 8 | ansible.builtin.include_role: 9 | name: "../roles/facts" 10 | 11 | - name: Build report with facts 12 | hosts: ansible-1 13 | gather_facts: false 14 | 15 | tasks: 16 | 17 | - name: Build a report 18 | ansible.builtin.include_role: 19 | name: "../roles/build_report" 20 | -------------------------------------------------------------------------------- /playbooks/network_restore.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Restore router configurations 3 | hosts: network 4 | gather_facts: false 5 | 6 | tasks: 7 | - name: Retreive configuration from backup-server to execution environment 8 | ansible.builtin.fetch: 9 | src: "/backup/{{ rollback_date }}/{{ inventory_hostname }}.txt" 10 | dest: "/tmp/{{ rollback_date }}/" 11 | flat: true 12 | delegate_to: backup-server 13 | when: ansible_network_os is defined 14 | 15 | - name: Load restore role 16 | ansible.builtin.include_role: 17 | name: "../roles/restore" 18 | when: ansible_network_os is defined 19 | -------------------------------------------------------------------------------- /playbooks/network_system.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure system properites 3 | hosts: routers 4 | gather_facts: false 5 | 6 | tasks: 7 | 8 | - name: Load system role 9 | ansible.builtin.include_role: 10 | name: "../roles/system" 11 | -------------------------------------------------------------------------------- /playbooks/network_time.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure network time 3 | hosts: all 4 | connection: network_cli 5 | gather_facts: false 6 | 7 | vars: 8 | ntp_server: "216.239.35.0" 9 | 10 | tasks: 11 | - name: Assert that NTP must be a valid IPv4 address 12 | ansible.builtin.assert: 13 | that: 14 | - "ntp_server | ipaddr" 15 | msg: "'ntp_server' must be a valid IPv4 address" 16 | 17 | - name: Configure NTP 18 | cisco.ios.ios_config: 19 | lines: "ntp server {{ ntp_server }}" 20 | 21 | - name: Fetch NTP status 22 | cisco.ios.ios_command: 23 | commands: 24 | - show ntp config 25 | - show ntp status 26 | register: ntp_config 27 | 28 | - name: Display NTP Status into terminal window 29 | ansible.builtin.debug: 30 | msg: "{{ ntp_config.stdout_lines }}" 31 | -------------------------------------------------------------------------------- /playbooks/network_user.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure user on network devices 3 | hosts: routers 4 | gather_facts: false 5 | 6 | tasks: 7 | - name: Load network user role 8 | ansible.builtin.include_role: 9 | name: "../roles/user" 10 | -------------------------------------------------------------------------------- /playbooks/network_vlans.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure network VLANs 3 | hosts: all 4 | gather_facts: false 5 | vars: 6 | - vlan_state: "{{ net_vlan_state | default('merged') }}" 7 | - vlan_config: "{{ net_vlan_config | default('') }}" 8 | 9 | # you would pass vlan_config like this: 10 | # --- 11 | # net_vlan_config: 12 | # - name: desktops 13 | # vlan_id: 5 14 | # - name: servers 15 | # vlan_id: 10 16 | # - name: dmz 17 | # vlan_id: 20 18 | 19 | tasks: 20 | - name: Assert that VLAN config was sent 21 | ansible.builtin.assert: 22 | that: 23 | - vlan_config != '' 24 | fail_msg: "no 'vlan_config' was sent, please send a valid configuration set as the variable net_vlan_config" 25 | success_msg: "all assertions passed" 26 | 27 | - name: Transform vlan_config into dictionary if coming from controller 28 | ansible.builtin.set_fact: 29 | vlan_config: "{{ net_vlan_config | from_yaml }}" 30 | when: vlan_config is string 31 | 32 | # if using this role from the collection it would be network.toolkit.vlans 33 | - name: Include correct role for network device type 34 | ansible.builtin.include_role: 35 | name: "../roles/vlans" 36 | when: ansible_network_os is defined 37 | -------------------------------------------------------------------------------- /playbooks/templates/backup.j2: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Restore Survey", 3 | "description": "Choose which date you want to restore to", 4 | "spec": [ 5 | { 6 | "type": "multiplechoice", 7 | "new_question": true, 8 | "question_name": "Rollback to which date?", 9 | "question_description": "Rollback revision date, which date do you want to revert to?", 10 | "variable": "rollback_date", 11 | "choices": [ 12 | {% for file in backups.files %} 13 | {% if loop.last %} 14 | "{{file.path.split('/')[-1]}}" 15 | {% else %} 16 | "{{file.path.split('/')[-1]}}", 17 | {% endif %} 18 | {% endfor %} 19 | ], 20 | "required": true, 21 | "default": "{{backups.files[0].path.split('/')[-1]}}" 22 | } 23 | ] 24 | } 25 | -------------------------------------------------------------------------------- /roles/README.md: -------------------------------------------------------------------------------- 1 | # Roles directory 2 | 3 | This contains all the network.toolkit roles 4 | -------------------------------------------------------------------------------- /roles/backup/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.backup 2 | 3 | To use this multi-platform network automation backup role: 4 | 5 | ``` 6 | - name: retrieve router configurations 7 | hosts: all 8 | gather_facts: no 9 | 10 | tasks: 11 | - name: backup configuration 12 | include_role: 13 | name: network.toolkit.backup 14 | when: ansible_network_os is defined 15 | ``` 16 | 17 | Backups are currently stored on the ansible-1 control node as part of the [network workshop](https://ansible.github.io/workshops/exercises/ansible_network/). For a full example please refer to the [network_backup.yml](../../network_backup.yml) example. 18 | -------------------------------------------------------------------------------- /roles/backup/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | - name: Backup arista configuration 2 | arista.eos.eos_config: 3 | backup: true 4 | backup_options: 5 | dir_path: /tmp/ 6 | filename: "{{ inventory_hostname }}.txt" 7 | register: config_output 8 | -------------------------------------------------------------------------------- /roles/backup/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | # This task will backup the configuration 2 | - name: Backup cisco ios configuration 3 | cisco.ios.ios_config: 4 | backup: true 5 | backup_options: 6 | dir_path: /tmp/ 7 | filename: "{{ inventory_hostname }}.txt" 8 | register: config_output 9 | 10 | # This task removes the Current configuration... from the top of IOS routers show run 11 | - name: Remove non config lines - regexp 12 | ansible.builtin.lineinfile: 13 | path: "{{ config_output.backup_path }}" 14 | line: "Building configuration..." 15 | state: absent 16 | delegate_to: localhost 17 | -------------------------------------------------------------------------------- /roles/backup/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | - name: Ensure netconf is running 2 | vars: 3 | ansible_connection: network_cli 4 | junipernetworks.junos.junos_netconf: 5 | 6 | - name: Backup junos configuration 7 | vars: 8 | ansible_connection: netconf 9 | junipernetworks.junos.junos_config: 10 | backup: true 11 | backup_options: 12 | dir_path: /tmp/ 13 | filename: "{{ inventory_hostname }}.txt" 14 | register: config_output 15 | -------------------------------------------------------------------------------- /roles/backup/tasks/main.yml: -------------------------------------------------------------------------------- 1 | - name: Backup network device config 2 | ansible.builtin.include_tasks: "{{ item }}" 3 | with_first_found: 4 | - "{{ role_path }}/tasks/{{ ansible_network_os }}.yml" 5 | - "{{ role_path }}/tasks/unsupported_platform.yml" 6 | -------------------------------------------------------------------------------- /roles/backup/tasks/unsupported_platform.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Unsupported network platform for backup role 3 | ansible.builtin.debug: 4 | msg: "this is not supported for backup role; the {{ ansible_network_os }} does not have any specific information specified" 5 | -------------------------------------------------------------------------------- /roles/banner/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.banner 2 | 3 | To use this multi-platform network automation banner role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: load banner onto network device 9 | vars: 10 | - network_banner: "{{ net_banner | default(None) }}" 11 | - banner_type: "{{ net_type | default('login') }}" 12 | include_role: 13 | name: network.toolkit.banner 14 | ``` 15 | 16 | ## Full Ansible Playbook example: 17 | ``` 18 | --- 19 | - name: set router banners 20 | hosts: routers 21 | gather_facts: no 22 | 23 | tasks: 24 | - name: load banner onto network device 25 | vars: 26 | - network_banner: "{{ net_banner | default(None) }}" 27 | - banner_type: "{{ net_type | default('login') }}" 28 | include_role: 29 | name: network.toolkit.banner 30 | ``` 31 | 32 | ## Additional Info 33 | 34 | There are two variables ready to use for extra_vars and/or Ansible Automation Platform [surveys](https://docs.ansible.com/ansible-tower/latest/html/userguide/job_templates.html#surveys). 35 | 36 | The `network_banner` which is the text you want for the banner, and the `banner_type` which can be 37 | 38 | - login 39 | - motd 40 | - exec (Cisco IOS only) 41 | - incoming (Cisco IOS only) 42 | - slip-ppp (Cisco IOS only) 43 | 44 | This list of parameters is stored in each platform module: 45 | 46 | - [Arista EOS](https://docs.ansible.com/ansible/latest/collections/arista/eos/eos_banner_module.html) 47 | - [Cisco IOS](https://docs.ansible.com/ansible/latest/collections/cisco/ios/ios_banner_module.html) 48 | - [Juniper Junos](https://docs.ansible.com/ansible/latest/collections/junipernetworks/junos/junos_banner_module.html) 49 | -------------------------------------------------------------------------------- /roles/banner/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Add the Arista EOS banner 3 | arista.eos.eos_banner: 4 | text: "{{ network_banner }}" 5 | banner: "{{ banner_type }}" 6 | -------------------------------------------------------------------------------- /roles/banner/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Add the Cisco IOS Banner 3 | cisco.ios.ios_banner: 4 | text: "{{ network_banner }}" 5 | banner: "{{ banner_type }}" 6 | -------------------------------------------------------------------------------- /roles/banner/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Add the Juniper JUNOS banner 3 | junipernetworks.junos.junos_banner: 4 | text: "{{ network_banner }}" 5 | banner: "{{ banner_type }}" 6 | -------------------------------------------------------------------------------- /roles/banner/tasks/main.yml: -------------------------------------------------------------------------------- 1 | - name: Configure banner 2 | ansible.builtin.include_tasks: "{{ ansible_network_os }}.yml" 3 | -------------------------------------------------------------------------------- /roles/banner/tasks/nxos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Add the Cisco NX-OS banner 3 | cisco.nxos.nxos_banner: 4 | text: "{{ network_banner }}" 5 | banner: "{{ banner_type }}" 6 | -------------------------------------------------------------------------------- /roles/build_report/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.build_report 2 | 3 | To use this multi-platform network automation build_report role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: build a report 9 | include_role: 10 | name: build_report 11 | ``` 12 | -------------------------------------------------------------------------------- /roles/build_report/files/css/main.css: -------------------------------------------------------------------------------- 1 | p.hostname { 2 | color: #000000; 3 | font-weight: bolder; 4 | font-size: large; 5 | margin: auto; 6 | width: 50%; 7 | } 8 | 9 | #subtable { 10 | background: #ebebeb; 11 | margin: 0px; 12 | width: 100%; 13 | } 14 | 15 | #subtable tbody tr td { 16 | padding: 5px 5px 5px 5px; 17 | } 18 | 19 | #subtable thead th { 20 | padding: 5px; 21 | } 22 | 23 | * { 24 | -moz-box-sizing: border-box; 25 | -webkit-box-sizing: border-box; 26 | box-sizing: border-box; 27 | font-family: "Open Sans", "Helvetica"; 28 | 29 | } 30 | 31 | a { 32 | color: #ffffff; 33 | } 34 | 35 | p { 36 | color: #ffffff; 37 | } 38 | h1 { 39 | text-align: center; 40 | color: #ffffff; 41 | } 42 | 43 | body { 44 | background:#353a40; 45 | padding: 0px; 46 | margin: 0px; 47 | font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; 48 | } 49 | 50 | table { 51 | border-collapse: separate; 52 | background:#fff; 53 | @include border-radius(5px); 54 | @include box-shadow(0px 0px 5px rgba(0,0,0,0.3)); 55 | } 56 | 57 | .main_net_table { 58 | margin:50px auto; 59 | } 60 | 61 | .main_net_table { 62 | margin:50px auto; 63 | } 64 | 65 | thead { 66 | @include border-radius(5px); 67 | } 68 | 69 | thead th { 70 | font-size:16px; 71 | font-weight:400; 72 | color:#fff; 73 | @include text-shadow(1px 1px 0px rgba(0,0,0,0.5)); 74 | text-align:left; 75 | padding:20px; 76 | border-top:1px solid #858d99; 77 | background: #353a40; 78 | 79 | &:first-child { 80 | @include border-top-left-radius(5px); 81 | } 82 | 83 | &:last-child { 84 | @include border-top-right-radius(5px); 85 | } 86 | } 87 | 88 | tbody tr td { 89 | font-weight:400; 90 | color:#5f6062; 91 | font-size:13px; 92 | padding:20px 20px 20px 20px; 93 | border-bottom:1px solid #e0e0e0; 94 | 95 | } 96 | 97 | tbody tr:nth-child(2n) { 98 | background:#f0f3f5; 99 | } 100 | 101 | tbody tr:last-child td { 102 | border-bottom:none; 103 | &:first-child { 104 | @include border-bottom-left-radius(5px); 105 | } 106 | &:last-child { 107 | @include border-bottom-right-radius(5px); 108 | } 109 | } 110 | 111 | td { 112 | vertical-align: top; 113 | } 114 | 115 | span.highlight { 116 | background-color: yellow; 117 | } 118 | 119 | .expandclass { 120 | color: #5f6062; 121 | } 122 | 123 | .content{ 124 | display:none; 125 | margin: 10px; 126 | } 127 | 128 | header { 129 | width: 100%; 130 | position: initial; 131 | float: initial; 132 | padding: 0; 133 | margin: 0; 134 | border-radius: 0; 135 | height: 88px; 136 | background-color: #171717; 137 | } 138 | 139 | .header-container { 140 | margin: 0 auto; 141 | width: 100%; 142 | height: 100%; 143 | max-width: 1170px; 144 | padding: 0; 145 | float: initial; 146 | display: flex; 147 | align-items: center; 148 | } 149 | 150 | .header-logo { 151 | width: 137px; 152 | border: 0; 153 | margin: 0; 154 | margin-left: 15px; 155 | } 156 | 157 | .header-link { 158 | margin-left: 40px; 159 | text-decoration: none; 160 | cursor: pointer; 161 | text-transform: uppercase; 162 | font-size: 15px; 163 | font-family: 'Red Hat Text'; 164 | font-weight: 500; 165 | } 166 | 167 | .header-link:hover { 168 | text-shadow: 0 0 0.02px white; 169 | text-decoration: none; 170 | } 171 | 172 | table.net_info td { 173 | padding: 5px; 174 | } 175 | 176 | p.expandclass:hover { 177 | text-decoration: underline; 178 | color: #EE0000; 179 | cursor: pointer; 180 | } 181 | 182 | .summary_info { 183 | } 184 | 185 | .ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active, a.ui-button:active, .ui-button:active, .ui-button.ui-state-active:hover { 186 | border: 1px solid #5F0000; 187 | background: #EE0000; 188 | } 189 | 190 | div#net_content { 191 | padding: 0px; 192 | height: auto !important; 193 | } 194 | 195 | img.router_image { 196 | vertical-align: middle; 197 | padding: 0px 10px 10px 10px; 198 | width: 50px; 199 | } 200 | 201 | table.net_info { 202 | width: 100%; 203 | } 204 | 205 | p.internal_label { 206 | color: #000000; 207 | } 208 | -------------------------------------------------------------------------------- /roles/build_report/files/redhat-ansible-logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 9 | Logo-Red_Hat-Ansible_Automation_Platform-A-Reverse-RGB 10 | 12 | 14 | 18 | 21 | 24 | 25 | 28 | 33 | 35 | 48 | 49 | -------------------------------------------------------------------------------- /roles/build_report/files/router.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/network-automation/toolkit/b457fc3ae85cd92065e207fb1f421a7f1f08bb43/roles/build_report/files/router.png -------------------------------------------------------------------------------- /roles/build_report/files/webpage_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/network-automation/toolkit/b457fc3ae85cd92065e207fb1f421a7f1f08bb43/roles/build_report/files/webpage_logo.png -------------------------------------------------------------------------------- /roles/build_report/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Install apache 3 | become: true 4 | ansible.builtin.yum: 5 | name: httpd 6 | state: present 7 | 8 | - name: Change apache to specified port 9 | become: true 10 | ansible.builtin.lineinfile: 11 | path: /etc/httpd/conf/httpd.conf 12 | regexp: '^Listen ' 13 | insertafter: '^#Listen ' 14 | line: 'Listen {{ web_port }}' 15 | 16 | - name: Set nis_enabled flag on and keep it persistent across reboots 17 | become: true 18 | ansible.posix.seboolean: 19 | name: nis_enabled 20 | state: true 21 | persistent: true 22 | 23 | - name: Start httpd 24 | become: true 25 | ansible.builtin.service: 26 | name: httpd 27 | state: started 28 | 29 | - name: Create HTML report 30 | become: true 31 | ansible.builtin.template: 32 | src: report.j2 33 | dest: "{{ file_path }}/index.html" 34 | mode: "644" 35 | 36 | - name: Copy CSS over 37 | become: true 38 | ansible.builtin.copy: 39 | src: "css" 40 | dest: "{{ file_path }}" 41 | directory_mode: true 42 | mode: "644" 43 | 44 | - name: Copy CSS over 45 | become: true 46 | ansible.builtin.copy: 47 | src: "{{ item }}" 48 | dest: "{{ file_path }}" 49 | directory_mode: true 50 | mode: "644" 51 | loop: 52 | - "webpage_logo.png" 53 | - "redhat-ansible-logo.svg" 54 | - "router.png" 55 | 56 | - name: Display link to inventory report 57 | ansible.builtin.debug: 58 | msg: "Please go to http://{{ hostvars[web_host].ansible_host }}:{{ web_port }}" 59 | -------------------------------------------------------------------------------- /roles/build_report/templates/ansible.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

Ansible Automation Info

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 |
Ansible user{{ hostvars[network_switch]['ansible_user'] | default("Unknown") }}
Transport{% set ansible_connection = hostvars[network_switch]['ansible_net_api'] %}{{ transport[ansible_connection] }}
Ansible Mgmt IP{{ hostvars[network_switch]['ansible_host']|default("Unknown") }}
Ansible groups{% for group in hostvars[network_switch]['group_names'] %}{{ group }} {% endfor %}
Ansible core version{% for group in hostvars[network_switch]['ansible_version']['string']|default("Unknown") %}{{ group }} {% endfor %}
Ansible Python{{ hostvars[network_switch]['ansible_playbook_python']|default("Unknown") }}
Python version{{ hostvars[network_switch]['ansible_net_python_version']|default("Unknown") }}
38 |
39 |
40 |
41 | 42 | -------------------------------------------------------------------------------- /roles/build_report/templates/bgp.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

BGP Global Info

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['bgp_global'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_global']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 |
ASNRouter ID
{{ hostvars[network_switch].ansible_network_resources.bgp_global['as_number']|default("Not Configured") }}{{ hostvars[network_switch].ansible_network_resources.bgp_global.bgp['router_id']['address']|default("Not Configured") }}
22 | {% if hostvars[network_switch]['ansible_network_resources']['bgp_global'][ 23 | 'neighbor'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_global'][ 24 | 'neighbor']|length > 0 %} 25 |

BGP Neighbors

26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | {% for bgp_neighbor in hostvars[network_switch].ansible_network_resources.bgp_global.neighbor %} 36 | 37 | 38 | 39 | 40 | {% endfor %} 41 | 42 |
AddressRemote AS
{{ bgp_neighbor['address']|default("Not Configured") }}{{ bgp_neighbor['remote_as']|default("Not Configured") }}
43 | {% endif %} 44 | {% elif hostvars[network_switch]['ansible_network_resources']['bgp_global'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_global']|length == 0 %} 45 | BGP is not configured on this device 46 | {% else %} 47 | No BGP information available 48 | {% endif %} 49 |
50 |
51 |
52 | 53 | -------------------------------------------------------------------------------- /roles/build_report/templates/bgp_address_family.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

BGP Address Family

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family']|length > 0 %} 7 | 8 | {% for address_family in hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family'] %} 9 |

Address Family {{ address_family['afi'] }}

10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | {% if address_family['networks'] is defined %} 20 | {% for bgp_network in address_family['networks'] %} 21 | 22 | 23 | 24 | 25 | {% endfor %} 26 | {% endif %} 27 | 28 |
NetworkMask
{{ bgp_network['address']|default("Not Configured") }}{{ bgp_network['mask']|default("Not Configured") }}
29 | {% endfor %} 30 | 31 | {% elif hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family']|length == 0 %} 32 | no BGP address-family is not configured on this device 33 | {% else %} 34 | No BGP information available 35 | {% endif %} 36 |
37 |
38 |
39 | 40 | -------------------------------------------------------------------------------- /roles/build_report/templates/header.j2: -------------------------------------------------------------------------------- 1 |
2 |
3 |
4 | 5 | 11 | 12 |
13 |
14 | -------------------------------------------------------------------------------- /roles/build_report/templates/interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

Interfaces - MTU/Duplex/Speed

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['interfaces']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | {% for interface in hostvars[network_switch]['ansible_network_resources']['interfaces'] %} 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | {% endfor %} 29 | 30 |
Interface NameDescriptionDuplexEnabledMTUSpeed
{{interface['name']}}{{interface['description']|default("none")}}{{interface['duplex']|default("default")}}{{interface['enabled']}}{{interface['mtu']|default("default")}}{{interface['speed']|default("default")}}
31 | {% elif hostvars[network_switch]['ansible_network_resources']['interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['interfaces']|length == 0 %} 32 | No interfaces configured on this device 33 | {% else %} 34 | No Interface information available 35 | {% endif %} 36 |
37 |
38 |
39 | 40 | -------------------------------------------------------------------------------- /roles/build_report/templates/l2_interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

L2 Interfaces - Trunk/Access Ports

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['l2_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l2_interfaces']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | {% for l2_interface in hostvars[network_switch]['ansible_network_resources']['l2_interfaces'] %} 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | {% endfor %} 27 | 28 |
NameModeAccess VLANTrunk Native VLANTrunk Allowed VLANs
{{l2_interface['name']}}{{l2_interface['mode']|default("Not Configured")}}{{l2_interface['access']['vlan']|default("Not Configured")}}{{l2_interface['trunk']['native_vlan']|default("Not Configured")}}{{l2_interface['trunk']['trunk_allowed_vlans']|default("Not Configured")}}
29 | {% elif hostvars[network_switch]['ansible_network_resources']['l2_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l2_interfaces']|length == 0 %} 30 | L2 information is not configured on this device 31 | {% else %} 32 | No L2 information available 33 | {% endif %} 34 |
35 |
36 |
37 | 38 | -------------------------------------------------------------------------------- /roles/build_report/templates/l3_interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

L3 Interfaces - IP Addresses

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['l3_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l3_interfaces']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | {% for interface in hostvars[network_switch]['ansible_network_resources']['l3_interfaces'] %} 17 | 18 | 19 | 20 | 31 | 32 | 33 | 41 | 42 | 43 | {% endfor %} 44 | 45 |
Interface NameIPv4IPv6
{{interface['name']}} 21 | {% if interface.ipv4 is defined %} 22 | {% for address in interface.ipv4 %} 23 | {{ address['address']|default("Not Configured") }} 24 | {% if address['secondary'] is defined %} 25 | secondary 26 | {% endif %} 27 | {% if loop.length > 1 and not loop.last %}
{% endif %} 28 | {% endfor %} 29 | {% endif %} 30 | 		34 | {% if interface.ipv6 is defined %} 35 | {% for v6address in interface.ipv6 %} 36 | {{v6address['address']|default("Not Configured") }} 37 | {% if loop.length > 1 and not loop.last %}
{% endif %} 38 | {% endfor %} 39 | {% endif %} 40 |
46 | {% elif hostvars[network_switch]['ansible_network_resources']['l3_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l3_interfaces']|length == 0 %} 47 | L3 information is not configured on this device 48 | {% else %} 49 | No L3 information available 50 | {% endif %} 51 |
52 |
53 |
54 | 55 | -------------------------------------------------------------------------------- /roles/build_report/templates/lacp.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

LACP

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['lacp'] is defined and hostvars[network_switch]['ansible_network_resources']['lacp'].keys()|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | {% for property in hostvars[network_switch]['ansible_network_resources']['lacp'] %} 15 | 16 | 17 | 18 | {% endfor %} 19 | 20 |
System Priority
{% if property['system'] is defined %} }{{property['system']['priority']}}{% else %}LACP not configured {% endif %}
21 | {% elif hostvars[network_switch]['ansible_network_resources']['lacp'] is defined and hostvars[network_switch]['ansible_network_resources']['lacp'].keys()|length == 0 %} 22 | LACP is not configured on this device 23 | {% else %} 24 | No LACP information available 25 | {% endif %} 26 |
27 |
28 |
29 | 30 | -------------------------------------------------------------------------------- /roles/build_report/templates/lldp_interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

LLDP Interfaces

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'].keys()|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | {% for interface in hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'] %} 17 | 18 | 19 | 20 | 21 | 22 | {% endfor %} 23 | 24 |
vlan_idNamestate
{{interface['name']}}{{interface['receive']|default("Not Configured")}}{{interface['transmit']|default("Not Configured")}}
25 | {% elif hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'].keys()|length == 0 %} 26 | LLDP is not configured on this device 27 | {% else %} 28 | No LLDP information available 29 | {% endif %} 30 |
31 |
32 |
33 | 34 | -------------------------------------------------------------------------------- /roles/build_report/templates/ospf.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

OSPF Global Info

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['ospfv2'] is defined and hostvars[network_switch]['ansible_network_resources']['ospfv2']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | {% for key,value in hostvars[network_switch]['ansible_network_resources']['ospfv2'].items() %} 16 | 17 | 18 | 19 | 20 | {% endfor %} 21 | 22 |
Process IDRouter ID
{{ value[0].process_id }}{{ value[0].router_id|default("Not Configured") }}
23 | {% elif hostvars[network_switch]['ansible_network_resources']['ospfv2'] is defined and hostvars[network_switch]['ansible_network_resources']['ospfv2']|length == 0 %} 24 | OSPF is not configured on this device 25 | {% else %} 26 | No OSPF information available 27 | {% endif %} 28 |
29 |
30 |
31 | 32 | -------------------------------------------------------------------------------- /roles/build_report/templates/report.j2: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Network Automation Report 5 | 6 | 7 | 8 | 9 | 10 | 19 | 20 | 21 | {% include 'header.j2' %} 22 |
23 |
24 |

Ansible Network Automation Example Report

25 |
26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | {% for network_switch in groups['network']|sort %} 37 | {% if hostvars[network_switch].ansible_facts.network_resources is defined %} 38 | 39 | 72 | 73 | 76 | 81 | 89 | 90 | {% endif %} 91 | {% endfor %} 92 | 93 |
Network DeviceLayer 1Layer 2Layer 3
40 |
41 |

picture of network device{{ hostvars[network_switch].ansible_net_hostname }}

42 |
43 |
44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 |
Platform{% set ansible_network_os = hostvars[network_switch]['ansible_net_system'] %}{{ vendor[ansible_network_os]}} {{hostvars[network_switch]['ansible_net_system'] }}
Code Version{{ hostvars[network_switch]['ansible_net_version'] }}
Model{{ hostvars[network_switch]['ansible_net_model'] }}
Serial Number{{ hostvars[network_switch]['ansible_net_serialnum'] }}
64 | 65 | 66 | {% include 'ansible.j2' %} 67 |
68 | 69 | 70 | 71 | 		74 | {% include 'interfaces.j2' %} 75 | 77 | {% include 'vlans.j2' %} 78 | {% include 'lldp_interfaces.j2' %} 79 | {% include 'l2_interfaces.j2' %} 80 | 82 | {% include 'l3_interfaces.j2' %} 83 | {% include 'lacp.j2' %} 84 | {% include 'static.j2' %} 85 | {% include 'bgp.j2' %} 86 | {% include 'bgp_address_family.j2' %} 87 | {% include 'ospf.j2' %} 88 |
94 |

Created with


red hat ansible automation platform logo 95 |

The source code to create this report can be found at https://github.com/network-automation/toolkit

96 | If you are new to Ansible Automation check out the following links:
97 | Getting Started
98 | Free hands-on workshops
99 | Youtube Videos
100 |

101 |
102 |
103 |
104 | 105 | 106 | -------------------------------------------------------------------------------- /roles/build_report/templates/static.j2: -------------------------------------------------------------------------------- 1 | 2 | {% set static_routes = hostvars[network_switch]['ansible_network_resources']['static_routes'] %} 3 |
4 |
5 |

Static Routes

6 |
7 | {% if static_routes is not none and static_routes|length > 0 %} 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | {% for net_route in static_routes %} 21 | 22 | 23 | {% for address_family in net_route.address_families|default([]) %} 24 | 25 | {% for routes in address_family['routes'] %} 26 | 27 | {% for next_hops in routes['next_hops'] %} 28 | 29 | 30 | 31 | {% endfor %} 32 | {% endfor %} 33 | {% endfor %} 34 | 35 | {% endfor %} 36 | 37 |
VRFAddress-FamilyRouteInterfaceNext-Hop AddressGlobal
{{ net_route['vrf']|default("N/A") }}{{ address_family['afi'] }}{{ routes['dest'] }}{{ next_hops['interface']|default("N/A") }}{{ next_hops['forward_router_address']|default("N/A") }}{{ next_hops['global']|default("N/A") }}
38 | {% elif static_routes is none or static_routes|length == 0 %} 39 | Static Routes are not configured on this device 40 | {% else %} 41 | No Static Route information available 42 | {% endif %} 43 |
44 |
45 |
46 | 47 | -------------------------------------------------------------------------------- /roles/build_report/templates/vlans.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

VLANs

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['vlans'] is defined and hostvars[network_switch]['ansible_network_resources']['vlans']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | {% for vlan in hostvars[network_switch]['ansible_network_resources']['vlans'] %} 17 | 18 | 19 | 20 | 21 | 22 | {% endfor %} 23 | 24 |
vlan_idNamestate
{{vlan['vlan_id']}}{{vlan['name']|default("none")}}{{vlan['state']|default("default")}}
25 | {% elif hostvars[network_switch]['ansible_network_resources']['vlans'] is defined and hostvars[network_switch]['ansible_network_resources']['vlans']|length == 0 %} 26 | VLANs are not configured on this device 27 | {% else %} 28 | No VLAN information available 29 | {% endif %} 30 |
31 |
32 |
33 | 34 | -------------------------------------------------------------------------------- /roles/build_report/vars/main.yml: -------------------------------------------------------------------------------- 1 | file_path: /var/www/html/ 2 | web_host: ansible-1 3 | web_port: 8088 4 | # multi key, same value lookup for cisco 5 | vendor: 6 | ios: &my_value 'Cisco' 7 | nxos: *my_value 8 | iosxr: *my_value 9 | junos: "Juniper" 10 | eos: "Arista" 11 | transport: 12 | cliconf: "network_cli" 13 | netconf: "netconf" 14 | httpapi: "httpapi" 15 | -------------------------------------------------------------------------------- /roles/build_report_container/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.build_report 2 | 3 | To use this multi-platform network automation build_report role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: build a report 9 | include_role: 10 | name: build_report 11 | ``` 12 | -------------------------------------------------------------------------------- /roles/build_report_container/files/css/main.css: -------------------------------------------------------------------------------- 1 | p.hostname { 2 | color: #000000; 3 | font-weight: bolder; 4 | font-size: large; 5 | margin: auto; 6 | width: 50%; 7 | } 8 | 9 | #subtable { 10 | background: #ebebeb; 11 | margin: 0px; 12 | width: 100%; 13 | } 14 | 15 | #subtable tbody tr td { 16 | padding: 5px 5px 5px 5px; 17 | } 18 | 19 | #subtable thead th { 20 | padding: 5px; 21 | } 22 | 23 | * { 24 | -moz-box-sizing: border-box; 25 | -webkit-box-sizing: border-box; 26 | box-sizing: border-box; 27 | font-family: "Open Sans", "Helvetica"; 28 | 29 | } 30 | 31 | a { 32 | color: #ffffff; 33 | } 34 | 35 | p { 36 | color: #ffffff; 37 | } 38 | h1 { 39 | text-align: center; 40 | color: #ffffff; 41 | } 42 | 43 | body { 44 | background:#353a40; 45 | padding: 0px; 46 | margin: 0px; 47 | font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; 48 | } 49 | 50 | table { 51 | border-collapse: separate; 52 | background:#fff; 53 | @include border-radius(5px); 54 | @include box-shadow(0px 0px 5px rgba(0,0,0,0.3)); 55 | } 56 | 57 | .main_net_table { 58 | margin:50px auto; 59 | } 60 | 61 | .main_net_table { 62 | margin:50px auto; 63 | } 64 | 65 | thead { 66 | @include border-radius(5px); 67 | } 68 | 69 | thead th { 70 | font-size:16px; 71 | font-weight:400; 72 | color:#fff; 73 | @include text-shadow(1px 1px 0px rgba(0,0,0,0.5)); 74 | text-align:left; 75 | padding:20px; 76 | border-top:1px solid #858d99; 77 | background: #353a40; 78 | 79 | &:first-child { 80 | @include border-top-left-radius(5px); 81 | } 82 | 83 | &:last-child { 84 | @include border-top-right-radius(5px); 85 | } 86 | } 87 | 88 | tbody tr td { 89 | font-weight:400; 90 | color:#5f6062; 91 | font-size:13px; 92 | padding:20px 20px 20px 20px; 93 | border-bottom:1px solid #e0e0e0; 94 | 95 | } 96 | 97 | tbody tr:nth-child(2n) { 98 | background:#f0f3f5; 99 | } 100 | 101 | tbody tr:last-child td { 102 | border-bottom:none; 103 | &:first-child { 104 | @include border-bottom-left-radius(5px); 105 | } 106 | &:last-child { 107 | @include border-bottom-right-radius(5px); 108 | } 109 | } 110 | 111 | td { 112 | vertical-align: top; 113 | } 114 | 115 | span.highlight { 116 | background-color: yellow; 117 | } 118 | 119 | .expandclass { 120 | color: #5f6062; 121 | } 122 | 123 | .content{ 124 | display:none; 125 | margin: 10px; 126 | } 127 | 128 | header { 129 | width: 100%; 130 | position: initial; 131 | float: initial; 132 | padding: 0; 133 | margin: 0; 134 | border-radius: 0; 135 | height: 88px; 136 | background-color: #171717; 137 | } 138 | 139 | .header-container { 140 | margin: 0 auto; 141 | width: 100%; 142 | height: 100%; 143 | max-width: 1170px; 144 | padding: 0; 145 | float: initial; 146 | display: flex; 147 | align-items: center; 148 | } 149 | 150 | .header-logo { 151 | width: 137px; 152 | border: 0; 153 | margin: 0; 154 | margin-left: 15px; 155 | } 156 | 157 | .header-link { 158 | margin-left: 40px; 159 | text-decoration: none; 160 | cursor: pointer; 161 | text-transform: uppercase; 162 | font-size: 15px; 163 | font-family: 'Red Hat Text'; 164 | font-weight: 500; 165 | } 166 | 167 | .header-link:hover { 168 | text-shadow: 0 0 0.02px white; 169 | text-decoration: none; 170 | } 171 | 172 | table.net_info td { 173 | padding: 5px; 174 | } 175 | 176 | p.expandclass:hover { 177 | text-decoration: underline; 178 | color: #EE0000; 179 | cursor: pointer; 180 | } 181 | 182 | .summary_info { 183 | } 184 | 185 | .ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active, a.ui-button:active, .ui-button:active, .ui-button.ui-state-active:hover { 186 | border: 1px solid #5F0000; 187 | background: #EE0000; 188 | } 189 | 190 | div#net_content { 191 | padding: 0px; 192 | height: auto !important; 193 | } 194 | 195 | img.router_image { 196 | vertical-align: middle; 197 | padding: 0px 10px 10px 10px; 198 | width: 50px; 199 | } 200 | 201 | table.net_info { 202 | width: 100%; 203 | } 204 | 205 | p.internal_label { 206 | color: #000000; 207 | } 208 | -------------------------------------------------------------------------------- /roles/build_report_container/files/redhat-ansible-logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 9 | Logo-Red_Hat-Ansible_Automation_Platform-A-Reverse-RGB 10 | 12 | 14 | 18 | 21 | 24 | 25 | 28 | 33 | 35 | 48 | 49 | -------------------------------------------------------------------------------- /roles/build_report_container/files/router.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/network-automation/toolkit/b457fc3ae85cd92065e207fb1f421a7f1f08bb43/roles/build_report_container/files/router.png -------------------------------------------------------------------------------- /roles/build_report_container/files/webpage_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/network-automation/toolkit/b457fc3ae85cd92065e207fb1f421a7f1f08bb43/roles/build_report_container/files/webpage_logo.png -------------------------------------------------------------------------------- /roles/build_report_container/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Creates directory 3 | ansible.builtin.file: 4 | path: "{{ file_path }}" 5 | state: directory 6 | mode: "775" 7 | recurse: true 8 | 9 | - name: Include selinux role 10 | vars: 11 | selinux_fcontexts: 12 | - {target: '{{ file_path }}(/.*)?', setype: 'httpd_sys_content_t', state: 'present'} 13 | ansible.builtin.include_role: 14 | name: fedora.linux_system_roles.selinux 15 | 16 | - name: Ensure Nginx container is running 17 | containers.podman.podman_container: 18 | name: nginx_container 19 | image: docker.io/nginx:stable-alpine3.17-slim 20 | state: started 21 | ports: 22 | - "{{ web_port }}:80" 23 | volumes: 24 | - "{{ file_path }}:/usr/share/nginx/html:Z" 25 | recreate: true 26 | 27 | - name: Create HTML report 28 | ansible.builtin.template: 29 | src: report.j2 30 | dest: "{{ file_path }}/index.html" 31 | mode: "644" 32 | 33 | - name: Copy CSS over 34 | ansible.builtin.copy: 35 | src: "css" 36 | dest: "{{ file_path }}" 37 | directory_mode: true 38 | mode: "775" 39 | 40 | - name: Copy CSS over 41 | ansible.builtin.copy: 42 | src: "{{ item }}" 43 | dest: "{{ file_path }}" 44 | directory_mode: true 45 | mode: "644" 46 | loop: 47 | - "webpage_logo.png" 48 | - "redhat-ansible-logo.svg" 49 | - "router.png" 50 | 51 | - name: Retrieve public IP address 52 | ansible.builtin.command: curl https://ifconfig.me 53 | register: public_ip_report 54 | ignore_errors: true 55 | 56 | - name: Display link to inventory report 57 | ansible.builtin.debug: 58 | msg: 59 | - "Please go to http://{{ public_ip_report.stdout | default(ansible_fqdn) }}:{{ web_port }}" 60 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/ansible.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

Ansible Automation Info

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 |
Ansible user{{ hostvars[network_switch]['ansible_user'] | default("Unknown") }}
Transport{% set ansible_connection = hostvars[network_switch]['ansible_net_api'] %}{{ transport[ansible_connection] }}
Ansible Mgmt IP{{ hostvars[network_switch]['ansible_host']|default("Unknown") }}
Ansible groups{% for group in hostvars[network_switch]['group_names'] %}{{ group }} {% endfor %}
Ansible core version{% for group in hostvars[network_switch]['ansible_version']['string']|default("Unknown") %}{{ group }} {% endfor %}
Ansible Python{{ hostvars[network_switch]['ansible_playbook_python']|default("Unknown") }}
Python version{{ hostvars[network_switch]['ansible_net_python_version']|default("Unknown") }}
38 |
39 |
40 |
41 | 42 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/bgp.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

BGP Global Info

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['bgp_global'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_global']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 |
ASNRouter ID
{{ hostvars[network_switch].ansible_network_resources.bgp_global['as_number']|default("Not Configured") }}{{ hostvars[network_switch].ansible_network_resources.bgp_global.bgp['router_id']['address']|default("Not Configured") }}
22 | {% if hostvars[network_switch]['ansible_network_resources']['bgp_global'][ 23 | 'neighbor'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_global'][ 24 | 'neighbor']|length > 0 %} 25 |

BGP Neighbors

26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | {% for bgp_neighbor in hostvars[network_switch].ansible_network_resources.bgp_global.neighbor %} 36 | 37 | 38 | 39 | 40 | {% endfor %} 41 | 42 |
AddressRemote AS
{{ bgp_neighbor['address']|default("Not Configured") }}{{ bgp_neighbor['remote_as']|default("Not Configured") }}
43 | {% endif %} 44 | {% elif hostvars[network_switch]['ansible_network_resources']['bgp_global'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_global']|length == 0 %} 45 | BGP is not configured on this device 46 | {% else %} 47 | No BGP information available 48 | {% endif %} 49 |
50 |
51 |
52 | 53 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/bgp_address_family.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

BGP Address Family

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family']|length > 0 %} 7 | 8 | {% for address_family in hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family'] %} 9 |

Address Family {{ address_family['afi'] }}

10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | {% if address_family['networks'] is defined %} 20 | {% for bgp_network in address_family['networks'] %} 21 | 22 | 23 | 24 | 25 | {% endfor %} 26 | {% endif %} 27 | 28 |
NetworkMask
{{ bgp_network['address']|default("Not Configured") }}{{ bgp_network['mask']|default("Not Configured") }}
29 | {% endfor %} 30 | 31 | {% elif hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family'] is defined and hostvars[network_switch]['ansible_network_resources']['bgp_address_family']['address_family']|length == 0 %} 32 | no BGP address-family is not configured on this device 33 | {% else %} 34 | No BGP information available 35 | {% endif %} 36 |
37 |
38 |
39 | 40 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/header.j2: -------------------------------------------------------------------------------- 1 |
2 |
3 |
4 | 5 | 11 | 12 |
13 |
14 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

Interfaces - MTU/Duplex/Speed

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['interfaces']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | {% for interface in hostvars[network_switch]['ansible_network_resources']['interfaces'] %} 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | {% endfor %} 29 | 30 |
Interface NameDescriptionDuplexEnabledMTUSpeed
{{interface['name']}}{{interface['description']|default("none")}}{{interface['duplex']|default("default")}}{{interface['enabled']}}{{interface['mtu']|default("default")}}{{interface['speed']|default("default")}}
31 | {% elif hostvars[network_switch]['ansible_network_resources']['interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['interfaces']|length == 0 %} 32 | No interfaces configured on this device 33 | {% else %} 34 | No Interface information available 35 | {% endif %} 36 |
37 |
38 |
39 | 40 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/l2_interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

L2 Interfaces - Trunk/Access Ports

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['l2_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l2_interfaces']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | {% for l2_interface in hostvars[network_switch]['ansible_network_resources']['l2_interfaces'] %} 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | {% endfor %} 27 | 28 |
NameModeAccess VLANTrunk Native VLANTrunk Allowed VLANs
{{l2_interface['name']}}{{l2_interface['mode']|default("Not Configured")}}{{l2_interface['access']['vlan']|default("Not Configured")}}{{l2_interface['trunk']['native_vlan']|default("Not Configured")}}{{l2_interface['trunk']['trunk_allowed_vlans']|default("Not Configured")}}
29 | {% elif hostvars[network_switch]['ansible_network_resources']['l2_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l2_interfaces']|length == 0 %} 30 | L2 information is not configured on this device 31 | {% else %} 32 | No L2 information available 33 | {% endif %} 34 |
35 |
36 |
37 | 38 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/l3_interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

L3 Interfaces - IP Addresses

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['l3_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l3_interfaces']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | {% for interface in hostvars[network_switch]['ansible_network_resources']['l3_interfaces'] %} 17 | 18 | 19 | 20 | 31 | 32 | 33 | 41 | 42 | 43 | {% endfor %} 44 | 45 |
Interface NameIPv4IPv6
{{interface['name']}} 21 | {% if interface.ipv4 is defined %} 22 | {% for address in interface.ipv4 %} 23 | {{ address['address']|default("Not Configured") }} 24 | {% if address['secondary'] is defined %} 25 | secondary 26 | {% endif %} 27 | {% if loop.length > 1 and not loop.last %}
{% endif %} 28 | {% endfor %} 29 | {% endif %} 30 | 		34 | {% if interface.ipv6 is defined %} 35 | {% for v6address in interface.ipv6 %} 36 | {{v6address['address']|default("Not Configured") }} 37 | {% if loop.length > 1 and not loop.last %}
{% endif %} 38 | {% endfor %} 39 | {% endif %} 40 |
46 | {% elif hostvars[network_switch]['ansible_network_resources']['l3_interfaces'] is defined and hostvars[network_switch]['ansible_network_resources']['l3_interfaces']|length == 0 %} 47 | L3 information is not configured on this device 48 | {% else %} 49 | No L3 information available 50 | {% endif %} 51 |
52 |
53 |
54 | 55 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/lacp.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

LACP

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['lacp'] is defined %} 7 | {% if hostvars[network_switch]['ansible_network_resources']['lacp'] is mapping and hostvars[network_switch]['ansible_network_resources']['lacp']|length > 0 %} 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 21 | 22 | 23 |
System Priority
{% if hostvars[network_switch]['ansible_network_resources']['lacp']['system'] is defined %} 17 | {{hostvars[network_switch]['ansible_network_resources']['lacp']['system']['priority']}} 18 | {% else %}LACP system priority not configured 19 | {% endif %} 20 |
24 | {% elif hostvars[network_switch]['ansible_network_resources']['lacp'] is sequence and hostvars[network_switch]['ansible_network_resources']['lacp']|length > 0 %} 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | {% for property in hostvars[network_switch]['ansible_network_resources']['lacp'] %} 33 | 34 | 39 | 40 | {% endfor %} 41 | 42 |
System Priority
{% if property['system'] is defined %} 35 | {{property['system']['priority']}} 36 | {% else %}LACP system priority not configured 37 | {% endif %} 38 |
43 | {% else %} 44 | LACP is not configured on this device 45 | {% endif %} 46 | {% else %} 47 | No LACP information available 48 | {% endif %} 49 |
50 |
51 |
52 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/lldp_interfaces.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

LLDP Interfaces

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'] is defined %} 7 | {% if hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'] is mapping %} 8 | {% set lldp_interfaces_length = hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'].keys()|list|length %} 9 | {% else %} 10 | {% set lldp_interfaces_length = hostvars[network_switch]['ansible_network_resources']['lldp_interfaces']|length %} 11 | {% endif %} 12 | 13 | {% if lldp_interfaces_length > 0 %} 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | {% if hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'] is mapping %} 24 | {% for interface_name, interface_config in hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'].items() %} 25 | 26 | 27 | 28 | 29 | 30 | {% endfor %} 31 | {% else %} 32 | {% for interface in hostvars[network_switch]['ansible_network_resources']['lldp_interfaces'] %} 33 | 34 | 35 | 36 | 37 | 38 | {% endfor %} 39 | {% endif %} 40 | 41 |
InterfaceReceiveTransmit
{{ interface_name }}{{ interface_config.receive|default("Not Configured") }}{{ interface_config.transmit|default("Not Configured") }}
{{ interface.name }}{{ interface.receive|default("Not Configured") }}{{ interface.transmit|default("Not Configured") }}
42 | {% else %} 43 | LLDP is not configured on this device 44 | {% endif %} 45 | {% else %} 46 | No LLDP information available 47 | {% endif %} 48 |
49 |
50 |
51 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/ospf.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

OSPF Global Info

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['ospfv2'] is defined %} 7 | {% set ospfv2 = hostvars[network_switch]['ansible_network_resources']['ospfv2'] %} 8 | 9 | {# Handle both object format with 'processes' and direct array format #} 10 | {% if ospfv2 is mapping and ospfv2.processes is defined %} 11 | {% set ospf_processes = ospfv2.processes %} 12 | {% elif ospfv2 is sequence %} 13 | {% set ospf_processes = ospfv2 %} 14 | {% else %} 15 | {% set ospf_processes = [] %} 16 | {% endif %} 17 | 18 | {% if ospf_processes|length > 0 %} 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | {% for process in ospf_processes %} 29 | 30 | 31 | 32 | 53 | 54 | {% endfor %} 55 | 56 |
Process IDRouter IDOther Properties
{{ process.process_id|default("Not Configured") }}{{ process.router_id|default("Not Configured") }} 33 | {% if process.redistribute is defined and process.redistribute|length > 0 %} 34 | Redistributing: 35 | {% for redist in process.redistribute %} 36 | {{ redist.routes }}{% if not loop.last %}, {% endif %} 37 | {% endfor %} 38 |
39 | {% endif %} 40 | 41 | {% if process.max_lsa is defined %} 42 | Max LSA: {{ process.max_lsa.count|default("Not Configured") }} 43 |
44 | {% endif %} 45 | 46 | {% if process.areas is defined and process.areas|length > 0 %} 47 | Areas: 48 | {% for area in process.areas %} 49 | {{ area.area_id }}{% if not loop.last %}, {% endif %} 50 | {% endfor %} 51 | {% endif %} 52 |
57 | 58 | {# OSPF Interface Information if available #} 59 | {% if hostvars[network_switch]['ansible_network_resources']['ospf_interfaces'] is defined and 60 | hostvars[network_switch]['ansible_network_resources']['ospf_interfaces']|length > 0 %} 61 |

OSPF Interfaces

62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | {% for interface in hostvars[network_switch]['ansible_network_resources']['ospf_interfaces'] %} 73 | {% if interface.address_family is defined and interface.address_family|length > 0 %} 74 | {% for family in interface.address_family %} 75 | 76 | 77 | 84 | 85 | 93 | 94 | {% endfor %} 95 | {% else %} 96 | 97 | 98 | 99 | 100 | 101 | 102 | {% endif %} 103 | {% endfor %} 104 | 105 |
InterfaceAreaNetwork TypeOther Properties
{{ interface.name }} 78 | {% if family.area is defined %} 79 | {{ family.area.area_id|default("Not Configured") }} 80 | {% else %} 81 | Not Configured 82 | {% endif %} 83 | {{ family.network|default("Not Configured") }} 86 | {% if family.passive is defined %} 87 | Passive: {{ family.passive }} 88 | {% endif %} 89 | {% if family.afi is defined %} 90 |
Address Family: {{ family.afi }} 91 | {% endif %} 92 |
{{ interface.name }}Not ConfiguredNot ConfiguredNo OSPF configuration
106 | {% endif %} 107 | {% else %} 108 | OSPF is not configured on this device 109 | {% endif %} 110 | {% else %} 111 | No OSPF information available 112 | {% endif %} 113 |
114 |
115 |
116 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/report.j2: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Network Automation Report 5 | 6 | 7 | 8 | 9 | 10 | 19 | 20 | 21 | {% include 'header.j2' %} 22 |
23 |
24 |

Ansible Network Automation Example Report

25 |
26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | {% for network_switch in groups['network']|sort %} 37 | {% if hostvars[network_switch].ansible_facts.network_resources is defined %} 38 | 39 | 72 | 73 | 76 | 81 | 89 | 90 | {% endif %} 91 | {% endfor %} 92 | 93 |
Network DeviceLayer 1Layer 2Layer 3
40 |
41 |

picture of network device{{ hostvars[network_switch].ansible_net_hostname }}

42 |
43 |
44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 |
Platform{% set ansible_network_os = hostvars[network_switch]['ansible_net_system'] %}{{ vendor[ansible_network_os]}} {{hostvars[network_switch]['ansible_net_system'] }}
Code Version{{ hostvars[network_switch]['ansible_net_version'] }}
Model{{ hostvars[network_switch]['ansible_net_model'] }}
Serial Number{{ hostvars[network_switch]['ansible_net_serialnum'] }}
64 | 65 | 66 | {% include 'ansible.j2' %} 67 |
68 | 69 | 70 | 71 | 		74 | {% include 'interfaces.j2' %} 75 | 77 | {% include 'vlans.j2' %} 78 | {% include 'lldp_interfaces.j2' %} 79 | {% include 'l2_interfaces.j2' %} 80 | 82 | {% include 'l3_interfaces.j2' %} 83 | {% include 'lacp.j2' %} 84 | {% include 'static.j2' %} 85 | {% include 'bgp.j2' %} 86 | {% include 'bgp_address_family.j2' %} 87 | {% include 'ospf.j2' %} 88 |
94 |

Created with


red hat ansible automation platform logo 95 |

The source code to create this report can be found at https://github.com/network-automation/toolkit

96 | If you are new to Ansible Automation check out the following links:
97 | Getting Started
98 | Free hands-on workshops
99 | Youtube Videos
100 |

101 |
102 |
103 |
104 | 105 | 106 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/static.j2: -------------------------------------------------------------------------------- 1 | 2 | {% if hostvars[network_switch]['ansible_network_resources']['static_routes'] is defined %} 3 | {% set static_routes = hostvars[network_switch]['ansible_network_resources']['static_routes'] %} 4 | {% else %} 5 | {% set static_routes = None %} 6 | {% endif %} 7 |
8 |
9 |

Static Routes

10 |
11 | {% if static_routes is not none and static_routes|length > 0 %} 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | {% for net_route in static_routes %} 25 | 26 | 27 | {% for address_family in net_route.address_families|default([]) %} 28 | 29 | {% for routes in address_family['routes'] %} 30 | 31 | {% for next_hops in routes['next_hops'] %} 32 | 33 | 34 | 35 | {% endfor %} 36 | {% endfor %} 37 | {% endfor %} 38 | 39 | {% endfor %} 40 | 41 |
VRFAddress-FamilyRouteInterfaceNext-Hop AddressGlobal
{{ net_route['vrf']|default("N/A") }}{{ address_family['afi'] }}{{ routes['dest'] }}{{ next_hops['interface']|default("N/A") }}{{ next_hops['forward_router_address']|default("N/A") }}{{ next_hops['global']|default("N/A") }}
42 | {% elif static_routes is none or static_routes|length == 0 %} 43 | Static Routes are not configured on this device 44 | {% else %} 45 | No Static Route information available 46 | {% endif %} 47 |
48 |
49 |
50 | 51 | -------------------------------------------------------------------------------- /roles/build_report_container/templates/vlans.j2: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

VLANs

5 |
6 | {% if hostvars[network_switch]['ansible_network_resources']['vlans'] is defined and hostvars[network_switch]['ansible_network_resources']['vlans']|length > 0 %} 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | {% for vlan in hostvars[network_switch]['ansible_network_resources']['vlans'] %} 17 | 18 | 19 | 20 | 21 | 22 | {% endfor %} 23 | 24 |
vlan_idNamestate
{{vlan['vlan_id']}}{{vlan['name']|default("none")}}{{vlan['state']|default("default")}}
25 | {% elif hostvars[network_switch]['ansible_network_resources']['vlans'] is defined and hostvars[network_switch]['ansible_network_resources']['vlans']|length == 0 %} 26 | VLANs are not configured on this device 27 | {% else %} 28 | No VLAN information available 29 | {% endif %} 30 |
31 |
32 |
33 | 34 | -------------------------------------------------------------------------------- /roles/build_report_container/vars/main.yml: -------------------------------------------------------------------------------- 1 | file_path: /data/report 2 | web_host: ansible-1 3 | web_port: 8088 4 | # multi key, same value lookup for cisco 5 | vendor: 6 | ios: &my_value 'Cisco' 7 | nxos: *my_value 8 | iosxr: *my_value 9 | junos: "Juniper" 10 | eos: "Arista" 11 | transport: 12 | cliconf: "network_cli" 13 | netconf: "netconf" 14 | httpapi: "httpapi" 15 | -------------------------------------------------------------------------------- /roles/facts/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.facts 2 | 3 | To use this multi-platform network automation facts role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: load user role 9 | vars: 10 | network_resource: vlans 11 | include_role: 12 | name: facts 13 | ``` 14 | -------------------------------------------------------------------------------- /roles/facts/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Gather arista eos facts 3 | arista.eos.eos_facts: 4 | gather_subset: config 5 | gather_network_resources: "{{ network_resource | default('all') }}" 6 | -------------------------------------------------------------------------------- /roles/facts/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Gather cisco ios facts 3 | cisco.ios.ios_facts: 4 | gather_subset: config 5 | gather_network_resources: "{{ network_resource | default('all') }}" 6 | -------------------------------------------------------------------------------- /roles/facts/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Gather juniper junos facts 3 | vars: 4 | ansible_connection: netconf 5 | junipernetworks.junos.junos_facts: 6 | gather_network_resources: "{{ network_resource | default('all') }}" 7 | -------------------------------------------------------------------------------- /roles/facts/tasks/main.yml: -------------------------------------------------------------------------------- 1 | - name: Gather network device facts 2 | ansible.builtin.include_tasks: "{{ item }}" 3 | with_first_found: 4 | - "{{ role_path }}/tasks/{{ ansible_network_os }}.yml" 5 | - "{{ role_path }}/tasks/unsupported_platform.yml" 6 | 7 | - name: Display facts 8 | ansible.builtin.debug: 9 | var: ansible_network_resources 10 | -------------------------------------------------------------------------------- /roles/facts/tasks/unsupported_platform.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Unsupported network platform for facts role 3 | ansible.builtin.debug: 4 | msg: "this is not supported for facts role; the {{ ansible_network_os }} does not have any specific information specified" 5 | -------------------------------------------------------------------------------- /roles/l3_interface/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.l3_interface 2 | 3 | To use this multi-platform network automation l3_interface role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: load l3 interface role 9 | include_role: 10 | name: l3_interface 11 | ``` 12 | -------------------------------------------------------------------------------- /roles/l3_interface/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | - name: Configure layer3 interface for eos 2 | arista.eos.eos_l3_interfaces: 3 | config: "{{ l3_interface }}" 4 | -------------------------------------------------------------------------------- /roles/l3_interface/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | - name: Configure layer3 interface for ios 2 | cisco.ios.ios_l3_interfaces: 3 | config: "{{ l3_interface }}" 4 | -------------------------------------------------------------------------------- /roles/l3_interface/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | - name: Configure layer3 interface for junos 2 | junipernetworks.junos.junos_l3_interfaces: 3 | config: "{{ l3_interface }}" 4 | -------------------------------------------------------------------------------- /roles/l3_interface/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Load supported platform file or fail 3 | ansible.builtin.include_tasks: "{{ item }}" 4 | with_first_found: 5 | - "{{ ansible_network_os }}.yml" 6 | - "unsupported_platform.yml" 7 | -------------------------------------------------------------------------------- /roles/l3_interface/tasks/unsupported_platform.yml: -------------------------------------------------------------------------------- 1 | - name: Fail when no network platform support 2 | ansible.builtin.fail: 3 | msg: 4 | - "Network Platform is unsupported at this time" 5 | - "Please refer to https://docs.ansible.com/ansible/latest/network/user_guide/platform_index.html" 6 | -------------------------------------------------------------------------------- /roles/l3_interface/vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | l3_interface: 3 | - ipv4: 4 | - address: "{{ interface_ipv4 | default(omit) }}" 5 | ipv6: 6 | - address: "{{ interface_ipv6 | default(omit) }}" 7 | name: "{{ interface_name }}" 8 | -------------------------------------------------------------------------------- /roles/read_interfaces/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.read_interfaces 2 | 3 | this role will be replaced in the future 4 | -------------------------------------------------------------------------------- /roles/read_interfaces/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | - name: Retrieve arista eos info 2 | arista_eos.eos_facts: 3 | gather_subset: min 4 | gather_network_resources: "{{ network_resources }}" 5 | -------------------------------------------------------------------------------- /roles/read_interfaces/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | - name: Retrieve Cisco ios info 2 | cisco.ios.ios_facts: 3 | gather_subset: min 4 | gather_network_resources: "{{ network_resources }}" 5 | -------------------------------------------------------------------------------- /roles/read_interfaces/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | # https://github.com/ansible/ansible/issues/61183 2 | - name: Retrieve juniper junos info 3 | junipernetworks.junos.junos_facts: 4 | gather_subset: min 5 | gather_network_resources: "{{ network_resources }}" 6 | -------------------------------------------------------------------------------- /roles/read_interfaces/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Load supported platform file or fail 3 | ansible.builtin.include_tasks: "{{ item }}" 4 | with_first_found: 5 | - "{{ ansible_network_os }}.yml" 6 | - "unsupported_platform.yml" 7 | -------------------------------------------------------------------------------- /roles/read_interfaces/tasks/unsupported_platform.yml: -------------------------------------------------------------------------------- 1 | - name: Fail if there is no corresponding network platform task file 2 | ansible.builtin.fail: 3 | msg: 4 | - "Network Platform is unsupported at this time" 5 | - "Please refer to https://docs.ansible.com/ansible/latest/network/user_guide/platform_index.html" 6 | -------------------------------------------------------------------------------- /roles/read_interfaces/vars/main.yml: -------------------------------------------------------------------------------- 1 | network_resources: "interfaces,l3_interfaces" 2 | -------------------------------------------------------------------------------- /roles/reload/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.reload 2 | 3 | To use this multi-platform network automation reload role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: use reload role 9 | include_role: 10 | name: reload 11 | ``` 12 | 13 | ## Full Ansible Playbook example: 14 | 15 | ``` 16 | --- 17 | - name: reboot network devices 18 | hosts: routers 19 | gather_facts: no 20 | 21 | tasks: 22 | 23 | - name: use reload role 24 | include_role: 25 | name: reload 26 | ``` 27 | -------------------------------------------------------------------------------- /roles/reload/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reboot eos device 3 | ansible.netcommon.cli_command: 4 | command: reload 5 | prompt: 6 | - Save? 7 | - confirm 8 | answer: 9 | - y 10 | - y 11 | -------------------------------------------------------------------------------- /roles/reload/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reboot ios device 3 | ansible.netcommon.cli_command: 4 | command: reload 5 | prompt: 6 | - Save? 7 | - confirm 8 | answer: 9 | - y 10 | - y 11 | -------------------------------------------------------------------------------- /roles/reload/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Reboot juniper device 3 | vars: 4 | ansible_connection: network_cli 5 | ansible.netcommon.cli_command: 6 | command: request system reboot 7 | prompt: 8 | - Reboot the system? 9 | answer: 10 | - y 11 | -------------------------------------------------------------------------------- /roles/reload/tasks/main.yml: -------------------------------------------------------------------------------- 1 | - name: Load corresponding network platform 2 | ansible.builtin.include_tasks: "{{ item }}" 3 | with_first_found: 4 | - "{{ ansible_network_os }}.yml" 5 | - "unsupported_platform.yml" 6 | 7 | - name: Reset the connection 8 | ansible.builtin.meta: reset_connection 9 | 10 | - name: Wait for the network device to reload 11 | ansible.builtin.wait_for_connection: 12 | delay: 10 13 | 14 | - name: Get the device uptime 15 | vars: 16 | ansible_connection: network_cli 17 | ansible.netcommon.cli_command: 18 | command: "{{ platform_uptime_command[ansible_network_os] }}" 19 | register: output 20 | 21 | - name: Show the device uptime 22 | ansible.builtin.debug: 23 | msg: "{{ output['stdout_lines'][0] }}" 24 | -------------------------------------------------------------------------------- /roles/reload/tasks/unsupported_platform.yml: -------------------------------------------------------------------------------- 1 | - name: Fail if we don't support the network platform in this role 2 | ansible.builtin.fail: 3 | msg: "{{ ansible_network_os }} is unsupported and unimplemented at this time" 4 | -------------------------------------------------------------------------------- /roles/reload/vars/main.yml: -------------------------------------------------------------------------------- 1 | platform_uptime_command: 2 | ios: show version | i uptime 3 | eos: show version | i Uptime 4 | nxos: show version | grep uptime 5 | vyos: uptime 6 | junos: show system uptime | grep up 7 | -------------------------------------------------------------------------------- /roles/restore/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.restore 2 | 3 | To use this multi-platform network automation restore role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: load restore role 9 | include_role: 10 | name: restore 11 | ``` 12 | 13 | ## Full Ansible Playbook example: 14 | 15 | ``` 16 | --- 17 | - name: restore router configurations 18 | hosts: routers 19 | gather_facts: no 20 | 21 | tasks: 22 | 23 | - name: load restore role 24 | include_role: 25 | name: restore 26 | ``` 27 | -------------------------------------------------------------------------------- /roles/restore/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | - name: Restore selected backup 2 | ansible.builtin.debug: 3 | msg: "restoring from /backup/{{ rollback_date }}/{{ inventory_hostname }}.txt" 4 | 5 | - name: Restore the config 6 | arista.eos.eos_config: 7 | replace: config 8 | src: "/tmp/{{ rollback_date }}/{{ inventory_hostname }}.txt" 9 | 10 | - name: Print to terminal window 11 | ansible.builtin.debug: 12 | msg: "Restore is complete for device {{ inventory_hostname }} is set to {{ rollback_date }} timestamp" 13 | -------------------------------------------------------------------------------- /roles/restore/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | - name: Restore selected backup 2 | ansible.builtin.debug: 3 | msg: "restoring from /backup/{{ rollback_date }}/{{ inventory_hostname }}.txt" 4 | 5 | ## overwrite doesn't work as of June 2025 6 | - name: Include task list in play 7 | ansible.builtin.include_tasks: "ios/{{ restore_mode | default('merge') }}.yml" 8 | 9 | - name: Print to terminal window 10 | ansible.builtin.debug: 11 | msg: "Restore is complete for device {{ inventory_hostname }} is set to {{ rollback_date }} timestamp, restored with restore_mode {{ restore_mode | default('merge') }} " 12 | -------------------------------------------------------------------------------- /roles/restore/tasks/ios/merge.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Restore the config with merge config 3 | cisco.ios.ios_config: 4 | src: "/tmp/{{ rollback_date }}/{{ inventory_hostname }}.txt" 5 | -------------------------------------------------------------------------------- /roles/restore/tasks/ios/overwrite.yml: -------------------------------------------------------------------------------- 1 | --- 2 | ### -O forces scp versus sftp which Cisco IOS does support 3 | - name: Copy file over to flash on network device using SCP 4 | ansible.builtin.shell: > 5 | scp -O -o StrictHostKeyChecking=no 6 | /backup/{{ rollback_date }}/{{ inventory_hostname }}.txt 7 | {{ inventory_hostname }}:'flash:{{ rollback_date }}-{{ inventory_hostname }}.txt' 8 | run_once: true 9 | delegate_to: backup-server 10 | 11 | # - name: Copy file over to flash on network device 12 | # ansible.builtin.shell: > 13 | # scp -O -o StrictHostKeyChecking=no 14 | # /tmp/{{ rollback_date }}/{{ inventory_hostname }}.txt 15 | # {{ ansible_user }}@{{ inventory_hostname }}:'flash:{{ rollback_date }}-{{ inventory_hostname }}.txt' 16 | # delegate_to: localhost 17 | # run_once: true 18 | 19 | # - name: Copy file over to flash on network device 20 | # ansible.netcommon.net_put: 21 | # src: "/tmp/{{ rollback_date }}/{{ inventory_hostname }}.txt" 22 | # dest: "flash:{{ rollback_date }}-{{ inventory_hostname }}.txt" 23 | 24 | - name: Overwrite startup config - overwrite 25 | environment: 26 | ANSIBLE_LIBSSH_PUBLICKEY_ALGORITHMS: ssh-rsa 27 | cisco.ios.ios_command: 28 | commands: 29 | - command: 'configure replace flash://{{ rollback_date }}-{{ inventory_hostname }}.txt force' 30 | -------------------------------------------------------------------------------- /roles/restore/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | - name: Restore selected backup 2 | ansible.builtin.debug: 3 | msg: "restoring from /backup/{{ rollback_date }}/{{ inventory_hostname }}.txt" 4 | 5 | - name: Restore the config 6 | junipernetworks.junos.junos_config: 7 | update: replace 8 | src: "/tmp/{{ rollback_date }}/{{ inventory_hostname }}.txt" 9 | 10 | - name: Print to terminal window 11 | ansible.builtin.debug: 12 | msg: "Restore is complete for device {{ inventory_hostname }} is set to {{ rollback_date }} timestamp" 13 | -------------------------------------------------------------------------------- /roles/restore/tasks/main.yml: -------------------------------------------------------------------------------- 1 | - name: Load platform module for restore 2 | ansible.builtin.include_tasks: "{{ item }}" 3 | with_first_found: 4 | - "{{ role_path }}/tasks/{{ ansible_network_os }}.yml" 5 | - "{{ role_path }}/tasks/unsupported_platform.yml" 6 | -------------------------------------------------------------------------------- /roles/restore/tasks/unsupported_platform.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Unsupported network platform for restore role 3 | ansible.builtin.debug: 4 | msg: "this is not supported for store role; the {{ ansible_network_os }} does not have any specific information specified" 5 | -------------------------------------------------------------------------------- /roles/system/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.system 2 | 3 | To use this multi-platform network automation system role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: load system role 9 | include_role: 10 | name: system 11 | ``` 12 | 13 | ## Full Ansible Playbook example: 14 | 15 | ``` 16 | --- 17 | - name: configure system properites 18 | hosts: routers 19 | gather_facts: no 20 | 21 | tasks: 22 | 23 | - name: load system role 24 | include_role: 25 | name: system 26 | ``` 27 | -------------------------------------------------------------------------------- /roles/system/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | - name: Load Arista eos system properties onto device 2 | arista.eos.eos_system: 3 | domain_name: "{{ network_domain_name | default(omit, True) }}" 4 | domain_search: "{{ network_domain_search | default(omit, True) }}" 5 | hostname: "{{ network_hostname | default(omit, True) }}" 6 | lookup_source: "{{ network_lookup_source | default(omit, True) }}" 7 | name_servers: "{{ network_name_servers | default(omit, True) }}" 8 | -------------------------------------------------------------------------------- /roles/system/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | - name: Load Cisco IOS system properties onto device 2 | cisco.ios.ios_system: 3 | domain_name: "{{ network_domain_name | default(omit, True) }}" 4 | domain_search: "{{ network_domain_search | default(omit, True) }}" 5 | hostname: "{{ network_hostname | default(omit, True) }}" 6 | lookup_source: "{{ network_lookup_source | default(omit, True) }}" 7 | name_servers: "{{ network_name_servers | default(omit, True) }}" 8 | -------------------------------------------------------------------------------- /roles/system/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | - name: Load junos system properties onto device 2 | junipernetworks.junos.junos_system: 3 | domain_name: "{{ network_domain_name | default(omit, True) }}" 4 | domain_search: "{{ network_domain_search | default(omit, True) }}" 5 | hostname: "{{ network_hostname | default(omit, True) }}" 6 | name_servers: "{{ network_name_servers | default(omit, True) }}" 7 | -------------------------------------------------------------------------------- /roles/system/tasks/main.yml: -------------------------------------------------------------------------------- 1 | - name: Load platform module for system 2 | ansible.builtin.include_tasks: "{{ ansible_network_os }}.yml" 3 | -------------------------------------------------------------------------------- /roles/user/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.user 2 | 3 | To use this multi-platform network automation user role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: load user role 9 | ansible.builtin.include_role: 10 | name: user 11 | ``` 12 | 13 | ## Full Ansible Playbook example: 14 | 15 | ``` 16 | --- 17 | - name: configure user on network devices 18 | hosts: routers 19 | gather_facts: no 20 | 21 | tasks: 22 | - name: load user role 23 | ansible.builtin.include_role: 24 | name: user 25 | ``` 26 | -------------------------------------------------------------------------------- /roles/user/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | - name: Load system properties onto Arista EOS 2 | arista.eos.eos_user: 3 | name: "{{ network_name | default(omit, True) }}" 4 | ssh_key: "{{ network_key | default(omit, True) }}" 5 | privilege: "{{ network_privilege | default(omit, True) }}" 6 | configured_password: "{{ network_configured_password | default(omit, True) }}" 7 | when: ansible_network_os is defined 8 | -------------------------------------------------------------------------------- /roles/user/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | - name: Load system properties onto Cisco IOS 2 | cisco.ios.ios_user: 3 | name: "{{ network_name | default(omit, True) }}" 4 | ssh_key: "{{ network_key | default(omit, True) }}" 5 | privilege: "{{ network_privilege | default(omit, True) }}" 6 | configured_password: "{{ network_configured_password | default(omit, True) }}" 7 | when: ansible_network_os is defined 8 | -------------------------------------------------------------------------------- /roles/user/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | - name: Load username and key properties onto device 2 | junipernetworks.junos.junos_user: 3 | name: "{{ network_name | default(omit, True) }}" 4 | sshkey: "{{ network_key | default(omit, True) }}" 5 | when: network_key is defined and network_key 6 | 7 | - name: Change passwrod for Juniper JUNOS 8 | vars: 9 | ansible_connection: network_cli 10 | ansible.netcommon.cli_command: 11 | command: "{{ item }}" 12 | prompt: 13 | - "New password" 14 | - "Retype new password" 15 | answer: 16 | - "{{ network_configured_password }}" 17 | - "{{ network_configured_password }}" 18 | check_all: true 19 | loop: 20 | - "configure" 21 | - "rollback" 22 | - "set system login user {{ network_name }} authentication plain-text-password" 23 | - "set system login user {{ network_name }} class {{ network_juniper_class }}" 24 | - "commit" 25 | when: network_configured_password is defined and network_configured_password 26 | -------------------------------------------------------------------------------- /roles/user/tasks/main.yml: -------------------------------------------------------------------------------- 1 | - name: Load network platform modules 2 | ansible.builtin.include_tasks: "{{ ansible_network_os }}.yml" 3 | -------------------------------------------------------------------------------- /roles/vlans/README.md: -------------------------------------------------------------------------------- 1 | # network.toolkit.vlans 2 | 3 | To use this multi-platform network automation vlans role: 4 | 5 | ## Task example: 6 | 7 | ``` 8 | - name: load user role 9 | ansible.builtin.include_role: 10 | name: network.toolkit.vlans 11 | ``` 12 | 13 | ## Full Ansible Playbook example: 14 | 15 | ``` 16 | --- 17 | - name: configure user on network devices 18 | hosts: routers 19 | gather_facts: no 20 | 21 | tasks: 22 | - name: load user role 23 | ansible.builtin.include_role: 24 | name: network.toolkit.vlans 25 | ``` 26 | -------------------------------------------------------------------------------- /roles/vlans/tasks/eos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure Arista EOS vlans 3 | arista.eos.eos_vlans: 4 | state: "{{ vlan_state }}" 5 | config: "{{ vlan_config }}" 6 | -------------------------------------------------------------------------------- /roles/vlans/tasks/ios.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure Cisco IOS vlans 3 | cisco.ios.ios_vlans: 4 | state: "{{ vlan_state }}" 5 | config: "{{ vlan_config }}" 6 | -------------------------------------------------------------------------------- /roles/vlans/tasks/junos.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure Juniper Junos VLANs 3 | junipernetworks.junos.junos_vlans: 4 | state: "{{ vlan_state }}" 5 | config: "{{ vlan_config }}" 6 | -------------------------------------------------------------------------------- /roles/vlans/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure specified vlans 3 | ansible.builtin.include_tasks: "{{ item }}" 4 | with_first_found: 5 | - "{{ role_path }}/tasks/{{ ansible_network_os }}.yml" 6 | - "{{ role_path }}/tasks/unsupported_platform.yml" 7 | -------------------------------------------------------------------------------- /roles/vlans/tasks/unsupported_platform.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Unsupported network platform for facts role 3 | ansible.builtin.debug: 4 | msg: "this is not supported for VLANs role; the {{ ansible_network_os }} does not have any specific information specified" 5 | -------------------------------------------------------------------------------- /setup/README.md: -------------------------------------------------------------------------------- 1 | # Requirements 2 | 3 | Install Ansible Content Collection 4 | 5 | ``` 6 | ansible-galaxy collection install infra.controller_configuration 7 | ``` 8 | 9 | If you get stuck, check out their [Github repo documentation](https://github.com/redhat-cop/controller_configuration/tree/devel) 10 | 11 | # Set environment variables 12 | 13 | For testing with CLI Ansible, you need to set some environment variables 14 | 15 | - CONTROLLER_HOST 16 | - CONTROLLER_USERNAME 17 | - CONTROLLER_PASSWORD 18 | - CONTROLLER_VERIFY_SSL 19 | 20 | e.g. setup in your bashrc 21 | 22 | ``` 23 | export CONTROLLER_HOST='controller.mydomain' 24 | export CONTROLLER_USERNAME='admin' 25 | export CONTROLLER_PASSWORD='mypassword' 26 | export CONTROLLER_VERIFY_SSL='false' 27 | ``` -------------------------------------------------------------------------------- /setup/network_time.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "", 3 | "description": "", 4 | "spec": [ 5 | { 6 | "question_name": "What is the IP address of your NTP server?", 7 | "question_description": "Please enter a IPv4 address", 8 | "required": true, 9 | "type": "text", 10 | "variable": "ntp_server", 11 | "min": 0, 12 | "max": 1024, 13 | "default": "216.239.35.0", 14 | "choices": "", 15 | "new_question": true 16 | } 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /setup/setup.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # controller_hosts: 3 | # - name: "backup-server" 4 | # description: "this server is where we backup network configuration" 5 | # inventory: "Workshop Inventory" 6 | # variables: 7 | # note: in production these passwords would be encrypted in vault 8 | # ansible_user: "ec2-user" 9 | # ansible_password: "{{ admin_password }}" 10 | # ansible_host: "{{ ansible_host }}" 11 | controller_projects: 12 | - name: "Network Toolkit Project" 13 | organization: "Default" 14 | scm_type: git 15 | scm_url: "https://github.com/network-automation/toolkit" 16 | controller_execution_environments: 17 | - name: "Network Toolkit EE" 18 | image: "quay.io/acme_corp/network-ee" 19 | pull: missing 20 | controller_templates: 21 | - name: "Network Toolkit - Commands" 22 | description: "adhoc cisco commands" 23 | job_type: "run" 24 | ask_inventory_on_launch: true 25 | project: "Network Toolkit Project" 26 | playbook: "playbooks/network_commands.yml" 27 | ask_credential_on_launch: true 28 | survey_enabled: true 29 | survey: "{{ lookup('template', 'survey_spec.json') }}" 30 | execution_environment: "Network Toolkit EE" 31 | - name: "Network Toolkit - Reload" 32 | job_type: "run" 33 | ask_inventory_on_launch: true 34 | project: "Network Toolkit Project" 35 | playbook: "playbooks/network_reload.yml" 36 | ask_credential_on_launch: true 37 | execution_environment: "Network Toolkit EE" 38 | - name: "Network Toolkit - User" 39 | job_type: "run" 40 | ask_inventory_on_launch: true 41 | project: "Network Toolkit Project" 42 | playbook: "playbooks/network_user.yml" 43 | ask_credential_on_launch: true 44 | state: "present" 45 | survey_enabled: true 46 | survey: "{{ lookup('template', 'user.json') }}" 47 | execution_environment: "Network Toolkit EE" 48 | - name: "Network Toolkit - Time" 49 | job_type: "run" 50 | ask_inventory_on_launch: true 51 | project: "Network Toolkit Project" 52 | playbook: "playbooks/network_time.yml" 53 | ask_credential_on_launch: true 54 | survey_enabled: true 55 | survey: "{{ lookup('template', 'network_time.json') }}" 56 | execution_environment: "Network Toolkit EE" 57 | - name: "Network Toolkit - Report" 58 | job_type: "run" 59 | ask_inventory_on_launch: true 60 | project: "Network Toolkit Project" 61 | playbook: "playbooks/network_report.yml" 62 | ask_credential_on_launch: true 63 | execution_environment: "Network Toolkit EE" 64 | - name: "Network Toolkit - Network-System" 65 | job_type: "run" 66 | ask_inventory_on_launch: true 67 | project: "Network Toolkit Project" 68 | playbook: "playbooks/network_system.yml" 69 | ask_credential_on_launch: true 70 | survey_enabled: true 71 | survey: "{{ lookup('template', 'system.json') }}" 72 | execution_environment: "Network Toolkit EE" 73 | -------------------------------------------------------------------------------- /setup/setup_playbook.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Playbook to configure ansible controller post installation 3 | hosts: localhost 4 | connection: local 5 | gather_facts: false 6 | tasks: 7 | - name: Retrieve vars fomr setup.yaml 8 | ansible.builtin.include_vars: 9 | file: setup.yaml 10 | 11 | - name: Call dispatch role 12 | ansible.builtin.include_role: 13 | name: infra.controller_configuration.dispatch 14 | -------------------------------------------------------------------------------- /setup/survey_spec.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "", 3 | "description": "", 4 | "spec": [ 5 | { 6 | "question_name": "Select a command you would like to execute", 7 | "question_description": "Restricted list of commands executable by operator", 8 | "required": true, 9 | "type": "multiplechoice", 10 | "variable": "controller_input", 11 | "min": 0, 12 | "max": 1024, 13 | "default": "show version", 14 | "choices": "show version\nshow ip interface brief\nshow interface description\nshow ip route", 15 | "new_question": true 16 | } 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /setup/system.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "System Survey", 3 | "description": "Prompt for system propertires such as hostname", 4 | "spec": [ 5 | { 6 | "type": "text", 7 | "question_name": "Please enter a hostname", 8 | "question_description": "this will set the hostname of the network device", 9 | "variable": "network_hostname", 10 | "required": false, 11 | "default": "{{inventory_hostname}}" 12 | }, 13 | { 14 | "type": "text", 15 | "question_name": "Domain Name", 16 | "question_description": "Set the IP domain name", 17 | "variable": "network_domain_name", 18 | "required": false, 19 | "default": "" 20 | }, 21 | { 22 | "type": "text", 23 | "question_name": "Please enter a lookup source", 24 | "question_description": "e.g. MgmtEth0/0/CPU0/0, source interface for performing DNS lookups", 25 | "variable": "network_lookup_source", 26 | "required": false, 27 | "default": "" 28 | }, 29 | { 30 | "type": "text", 31 | "question_name": "Please enter the name servers", 32 | "question_description": "e.g. 8.8.8.8, List of DNS name servers by IP address to use to perform name resolution lookups", 33 | "variable": "network_name_servers", 34 | "required": false, 35 | "default": "8.8.8.8" 36 | }, 37 | { 38 | "type": "text", 39 | "question_name": "Please enter the domain search names", 40 | "question_description": "e.g. the ip domain list, resolution for unqualified host names", 41 | "variable": "network_domain_search", 42 | "required": false, 43 | "default": "" 44 | } 45 | ] 46 | } 47 | -------------------------------------------------------------------------------- /setup/user.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "System Survey", 3 | "description": "Prompt for system propertires such as hostname", 4 | "spec": [ 5 | { 6 | "type": "text", 7 | "question_name": "Please enter the username", 8 | "question_description": "this will set the username on the network device", 9 | "variable": "network_name", 10 | "required": false, 11 | "default": "ansible" 12 | }, 13 | { 14 | "type": "text", 15 | "question_name": "Please enter the plain-text password", 16 | "question_description": "this is not required if using an SSH key", 17 | "variable": "network_configured_password", 18 | "required": false, 19 | "default": "ansible123" 20 | }, 21 | { 22 | "type": "textarea", 23 | "question_name": "Please paste the SSH public key here", 24 | "question_description": "this is not required, please leave blank to use plain-text password", 25 | "variable": "network_key", 26 | "required": false, 27 | "default": "" 28 | }, 29 | { 30 | "type": "text", 31 | "question_name": "Please enter a privilege level (for network OS that support it)", 32 | "question_description": "This argument accepts integer values in the range of 1 to 15", 33 | "variable": "network_privilege", 34 | "required": false, 35 | "default": "" 36 | }, 37 | { 38 | "question_description": "non-Juniper devices will ignore this field", 39 | "min": null, 40 | "default": "super-user", 41 | "max": null, 42 | "required": false, 43 | "choices": "operator\nread-only\nsuper-user\nunauthorized", 44 | "variable": "network_juniper_class", 45 | "question_name": "Which login class? (Juniper only)", 46 | "type": "multiplechoice" 47 | } 48 | ] 49 | } 50 | -------------------------------------------------------------------------------- /templates/eos_show_interface.txt: -------------------------------------------------------------------------------- 1 | rtr2#show interfaces 2 | Ethernet1 is up, line protocol is up (connected) 3 | Hardware is Ethernet, address is 022e.dbe8.1375 (bia 022e.dbe8.1375) 4 | Internet address is 172.18.104.95/16 5 | Broadcast address is 255.255.255.255 6 | Address determined by DHCP 7 | IP MTU 1500 bytes , BW 1000000 kbit 8 | Full-duplex, 1Gb/s, auto negotiation: on, uni-link: n/a 9 | Up 10 hours, 51 minutes, 55 seconds 10 | Loopback Mode : None 11 | 3 link status changes since last clear 12 | Last clearing of "show interface" counters never 13 | 5 minutes input rate 950 bps (0.0% with framing overhead), 1 packets/sec 14 | 5 minutes output rate 858 bps (0.0% with framing overhead), 1 packets/sec 15 | 19361 packets input, 2964452 bytes 16 | Received 0 broadcasts, 0 multicast 17 | 0 runts, 0 giants 18 | 0 input errors, 0 CRC, 0 alignment, 0 symbol, 0 input discards 19 | 0 PAUSE input 20 | 23415 packets output, 3417622 bytes 21 | Sent 0 broadcasts, 0 multicast 22 | 0 output errors, 0 collisions 23 | 0 late collision, 0 deferred, 0 output discards 24 | 0 PAUSE output 25 | Loopback0 is up, line protocol is up (connected) 26 | Hardware is Loopback 27 | Internet address is 192.168.2.2/32 28 | Broadcast address is 255.255.255.255 29 | IP MTU 65535 bytes 30 | Up 10 hours, 51 minutes, 58 seconds 31 | Tunnel0 is up, line protocol is up (connected) 32 | Hardware is Tunnel, address is ac12.685f.0800 33 | Internet address is 10.101.101.2/24 34 | Broadcast address is 255.255.255.255 35 | Tunnel source 172.18.104.95, destination 172.18.104.54 36 | Tunnel protocol/transport GRE/IP 37 | Key disabled, sequencing disabled 38 | Checksumming of packets disabled 39 | Tunnel TTL 10, Hardware forwarding not supported 40 | Tunnel TOS 0 41 | Path MTU Discovery 42 | Tunnel transport MTU 1394 bytes 43 | Tunnel underlay VRF "default" 44 | Up 10 hours, 51 minutes, 51 seconds 45 | rtr2#show inter lo0 46 | Loopback0 is up, line protocol is up (connected) 47 | Hardware is Loopback 48 | Internet address is 192.168.2.2/32 49 | Broadcast address is 255.255.255.255 50 | IP MTU 65535 bytes 51 | Up 11 hours, 40 minutes, 10 seconds 52 | -------------------------------------------------------------------------------- /templates/eos_show_interface.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - example: Ethernet1 is up, line protocol is up (connected) 3 | getval: '(?P\S+) is (?P\S+), line protocol is (?P\S+)' 4 | result: 5 | "{{ name }}": 6 | state: 7 | operating: "{{ oper_state }}" 8 | protocol: "{{ proto_state }}" 9 | shared: true 10 | 11 | - example: "Hardware is Ethernet, address is 022e.dbe8.1375 (bia 022e.dbe8.1375)" 12 | getval: '(\s+Hardware is (?P\w+))(,\saddress is (?P\S+))?' 13 | result: 14 | "{{ name }}": 15 | hardware: "{{ hardware_type }}" 16 | mac_address: "{{ mac | default(None) }}" 17 | --------------------------------------------------------------------------------