From 14f4768413076984cb4ba5d42995b6a5ebf3d55c Mon Sep 17 00:00:00 2001 From: Peter Sprygada Date: Thu, 22 Feb 2018 09:42:52 -0500 Subject: [PATCH] initial commit --- .gitignore | 4 + .travis.yml | 29 ++ CONTRIBUTING.md | 79 ++++ LICENSE | 674 ++++++++++++++++++++++++++++++++++ README.md | 44 +++ action_plugins/text_parser.py | 446 ++++++++++++++++++++++ defaults/main.yml | 2 + docs/parser_directives.md | 143 ++++++++ docs/template_directives.md | 261 +++++++++++++ handlers/main.yml | 2 + meta/main.yml | 34 ++ tasks/main.yml | 2 + tests/inventory | 2 + tests/test.yml | 5 + vars/main.yml | 2 + 15 files changed, 1729 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 action_plugins/text_parser.py create mode 100644 defaults/main.yml create mode 100644 docs/parser_directives.md create mode 100644 docs/template_directives.md create mode 100644 handlers/main.yml create mode 100644 meta/main.yml create mode 100644 tasks/main.yml create mode 100644 tests/inventory create mode 100644 tests/test.yml create mode 100644 vars/main.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fac12a2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +*.py[co] +*.swp +*.swo +*.bak diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..36bbf62 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,29 @@ +--- +language: python +python: "2.7" + +# Use the new container infrastructure +sudo: false + +# Install ansible +addons: + apt: + packages: + - python-pip + +install: + # Install ansible + - pip install ansible + + # Check ansible version + - ansible --version + + # Create ansible.cfg with correct roles_path + - printf '[defaults]\nroles_path=../' >ansible.cfg + +script: + # Basic role syntax check + - ansible-playbook tests/test.yml -i tests/inventory --syntax-check + +notifications: + webhooks: https://galaxy.ansible.com/api/v1/notifications/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..88459ab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,79 @@ +# Developer Guide +This role is developed and mantained by the Ansible Network Working Group. +Contributions to this role are welcomed. This document will provide inviduals +with information about how to contribute to the further development of this +role. + +## Contributing +There are many ways you can contribute to this role. Adding new artifacts such +as modules and plugins, testing and/or reviewing and updating documentation. + +### Adding support for a new platform +To add support for a new platform to this role, there are a couple of things +that need to be done. + +1) Create the module for the platform specific implementation in Ansible. The +module can be contributed directly to Ansible core, distributed through Ansible +Galaxy or added to this role. + +2) Optional Steps + +a) If adding the module code directly to this role, add the module +to ```library/``` + +b) If the new platform module is distributed through another Galaxy +role, please update [README](README.md) Dependencies section to include the +name of the Galaxy role that includes the module. + +3) Once the module has been created, the add a new task in ```tasks/``` for the +specific platform to be supported. Use any of the existing platform +implementations as a guide. + +4) (Optional) If a configuration parameter is not supported, then the +implementation in tasks should detect that and provide a warning message. + +5) Update the ```meta/main.yaml``` file to add the newly provided platform to +the ```platforms``` meta data. + +### Adding platform specific arguments +Sometimes there is a need to add platform specific arguments to a role for use +by a platform specific module. This can be accomplished by adding the adding +the arguments under a platform specific key. + +Note: It is the responsibility of the task writer to handle the implementation +of the platform specific arguments. + +Here is an example that implements a platform specific argument: + +``` +tasks: + - name: configure network device resource + include_role: + name: net_system + vars: + resource: + foo: bar + ios: + foo: baz +``` + +### Adding documentation for a platform specific implementation +While not required, there are times when providing implementation nodes are +advantageous to instructing the playbook writer how to implement platform +specific arguments. In order to provide platform specific documentation, +create a file in the docs directory using Github Markdown. The file name +should be the platform name. + +For instance, let's assume we want to create implementation nodes for a +fictitious platform call `foo`. Create a new file in docs/ called `foo.md` and +then add a link to [README](README.md) pointing to `docs/foo.md` in the `PLATFORM +NOTES` section. + +## Bug Reporting +If you have found a bug in the with the current role please open a [Github +issue](../../issues) + +## Contact +* [#ansible-network IRC channel](https://webchat.freenode.net/?channels=ansible-network) on Freenode.net + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e471b4 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Role Name: network-engine +This role provides the foundation for building network roles by providing +modules and plugins that are common to all Ansible Network roles. All of +the artifacts in this role can be used independent of the platform that is +being managed. + +Any open bugs and/or feature requests are tracked in [Github issues](../../issues). + +Interested in contributing to this role, please see [CONTRIBUTING](CONTRIBUTING.md) + +## Requirements +None + +## Role Tasks +The following are the available tasks provided by this role for use in +playbooks. + +None + +## Role Variables +The following are the list of variables this role accepts + +None + +## Modules +The following is a list of modules that are provided by this role. + +* text_parser [[source]](library/text_parser.py) + +## Plugins +The following is a list of plugins that are provided by this role. + +None + +## Dependencies +The following is the list of dependencies on other roles this role requires. + +None + +## License +GPLv3 + +## Author Information +Ansible Network Engineering Team diff --git a/action_plugins/text_parser.py b/action_plugins/text_parser.py new file mode 100644 index 0000000..3b6348e --- /dev/null +++ b/action_plugins/text_parser.py @@ -0,0 +1,446 @@ +# (c) 2017, Ansible by Red Hat, inc +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . +# +import os +import re +import copy +import json +import collections + +from ansible import constants as C +from ansible.plugins.action import ActionBase +from ansible.module_utils.network.common.utils import to_list +from ansible.module_utils.six import iteritems, string_types +from ansible.module_utils._text import to_bytes, to_text +from ansible.errors import AnsibleError, AnsibleUndefinedVariable, AnsibleFileNotFound + +try: + from __main__ import display +except ImportError: + from ansible.utils.display import Display + display = Display() + +def warning(msg): + if C.ACTION_WARNINGS: + display.warning(msg) + + +class ActionModule(ActionBase): + + NAMED_PATTERNS = { + 'ALPHAS': '(\w+)', + 'NUMS': '(\d+)', + 'IPV4': '(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])' + } + + VALID_FILE_EXTENSIONS = ('.yaml', '.yml', '.json') + VALID_GROUP_DIRECTIVES = ('context', 'block') + VALID_ACTION_DIRECTIVES = ('pattern_match', 'export_facts', 'lines_template', 'json_template') + VALID_DIRECTIVES = VALID_GROUP_DIRECTIVES + VALID_ACTION_DIRECTIVES + + def run(self, tmp=None, task_vars=None): + if task_vars is None: + task_vars = dict() + + result = super(ActionModule, self).run(tmp, task_vars) + + try: + parser = self._task.args['parser'] + contents = self._task.args['contents'] + except KeyError as exc: + return {'failed': True, 'msg': 'missing required argument: %s' % exc} + + if not os.path.exists(parser) and not os.path.isfile(parser): + raise AnsibleError("parser is either missing or invalid") + + self.ds = {'contents': contents} + self.ds.update(task_vars) + + tasks = self._loader.load_from_file(parser) + + for task in tasks: + name = task.pop('name', None) + register = task.pop('register', None) + + display.vvvv('processing directive: %s' % name) + + when = task.pop('when', None) + if when is not None: + if not self._check_conditional(when, task_vars): + warning('skipping task due to conditional check failure') + continue + + loop = task.pop('loop', None) + if loop: + loop = self.template(loop, self.ds) + + if isinstance(loop, collections.Mapping): + loop_result = list() + for loop_key, loop_value in iteritems(loop): + self.ds['item'] = {'key': loop_key, 'value': loop_value} + res = self._process_directive(task) + loop_result.append(res) + self.ds[register] = loop_result + + elif isinstance(loop, collections.Iterable) and not isinstance(loop, string_types): + loop_result = list() + for loop_item in loop: + self.ds['item'] = loop_item + res = self._process_directive(task) + loop_result.extend(to_list(res)) + self.ds[register] = loop_result + + else: + res = self._process_directive(task) + if register: + self.ds[register] = res + + if 'facts' in self.ds: + result['ansible_facts'] = {'network_facts': self.ds['facts']} + + return result + + def do_block(self, block): + + results = list() + registers = {} + + for entry in block: + task = entry.copy() + + name = task.pop('name', None) + register = task.pop('register', None) + + when = task.pop('when', None) + if when is not None: + if not self._check_conditional(when, task_vars): + warning('skipping task due to conditional check failure') + continue + + loop = task.pop('loop', None) + if loop: + loop = self.template(loop, self.ds) + + if 'block' in task: + res = self.do_block(task['block']) + if res: + results.append(res) + if register: + registers[register] = res + + elif isinstance(loop, collections.Iterable) and not isinstance(loop, string_types): + loop_result = list() + + for loop_item in loop: + self.ds['item'] = loop_item + loop_result.append(self._process_directive(task)) + + results.append(loop_result) + + if register: + registers[register] = loop_result + + else: + res = self._process_directive(task) + if res: + results.append(res) + if register: + registers[register] = res + + return registers + + def _process_directive(self, task): + for directive, args in iteritems(task): + if directive not in self.VALID_DIRECTIVES: + raise AnsibleError('invalid directive in parser: %s' % directive) + meth = getattr(self, 'do_%s' % directive) + if meth: + if directive in self.VALID_GROUP_DIRECTIVES: + return meth(args) + elif directive in self.VALID_ACTION_DIRECTIVES: + return meth(**args) + + def do_export_facts(self, **kwargs): + self.ds['facts'] = self.template(kwargs, self.ds) + + def _greedy_match(self, contents, start, end=None, match_all=None): + """ Filter a section of the contents text for matching + + :args contents: The contents to match against + :args start: The start of the section data + :args end: The end of the section data + :args match_all: Whether or not to match all of the instances + + :returns: a list object of all matches + """ + ds = self.ds if isinstance(self.ds['contents'], string_types) else self.ds['contents'] + + contents = self.template(contents, ds) + section_data = list() + + if match_all: + while True: + section_range = self._get_section_range(contents, start, end) + if not section_range: + break + + sidx, eidx = section_range + + if eidx is not None: + section_data.append(contents[sidx: eidx]) + contents = contents[eidx:] + else: + section_data.append(contents[sidx:]) + break + + else: + section_data.append(contents) + + return section_data + + def do_pattern_match(self, regex, contents=None, match_all=None, match_until=None, match_greedy=None): + """ Perform the regular expression match against the contents + + :args regex: The regular expression pattern to use + :args contents: The contents to run the pattern against + :args match_all: Specifies if all matches of pattern should be returned + or just the first occurence + + :returns: list object of matches or None if there where no matches found + """ + contents = contents or "{{ contents }}" + + if match_greedy: + return self._greedy_match(contents, regex, end=match_until, match_all=match_all) + + pattern = self.template(regex, self.NAMED_PATTERNS) + contents = self.template(contents, self.ds) + + if match_all: + match = re.findall(pattern, contents, re.M) + if match: + return match + else: + match = re.search(pattern, contents, re.M) + if match: + return list(match.groups()) + + return None + + def do_json_template(self, template): + """ Handle the json_template directive + + :args template: the data structure to template + + :return: the templated data + """ + return self._process_items(template) + + def do_line_template(self, args): + pass + + def _process_items(self, template, variables=None): + + templated_items = {} + variables = variables or self.ds + + for item in template: + key = self.template(item['key'], variables) + + when = item.get('when') + if when is not None: + if not self._check_conditional(when, variables): + warning("skipping due to conditional failure") + continue + + if 'value' in item: + value = item.get('value') + items = None + item_type = None + + elif 'object' in item: + items = item.get('object') + item_type = 'dict' + + elif 'elements' in item: + items = item.get('elements') + item_type = 'list' + + when = item.get('when') + + loop = item.get('repeat_for') + loop_data = self.template(loop, variables) if loop else None + loop_var = item.get('repeat_var', 'item') + + if items: + if loop: + if isinstance(loop_data, collections.Iterable) and not isinstance(loop_data, string_types): + templated_value = list() + + for loop_item in loop_data: + variables[loop_var] = loop_item + templated_value.append(self._process_items(items, variables)) + + if item_type == 'list': + templated_items[key] = templated_value + + elif item_type == 'dict': + if key not in templated_items: + templated_items[key] = {} + + for t in templated_value: + templated_items[key].update(t) + else: + templated_items[key] = [] + + else: + val = self._process_items(items, variables) + + if item_type == 'list': + templated_value = [val] + else: + templated_value = val + + templated_items[key] = templated_value + + else: + templated_value = self.template(value, variables) + templated_items[key] = templated_value + + return templated_items + + def _get_section_range(self, contents, start, end=None): + + try: + context_start_re = re.compile(start, re.M) + if end: + context_end_re = re.compile(end, re.M) + include_end = True + else: + context_end_re = context_start_re + include_end = False + except KeyError as exc: + raise AnsibleError('Missing required key %s' % to_text(exc)) + + context_start = re.search(context_start_re, contents) + if not context_start: + return + + string_start = context_start.start() + end = context_start.end() + 1 + + context_end = re.search(context_end_re, contents[end:]) + if not context_end: + return (string_start, -1) + + if include_end: + string_end = end + context_end.end() + else: + string_end = end + context_end.start() + + return (string_start, string_end) + + def _get_context_data(self, entry, contents): + name = entry['name'] + + context = entry.get('context', {}) + context_data = list() + + if context: + while True: + context_range = self._get_context_range(name, context, contents) + + if not context_range: + break + + start, end = context_range + + if end is not None: + context_data.append(contents[start: end]) + contents = contents[end:] + else: + context_data.append(contents[start:]) + break + + else: + context_data.append(contents) + + return context_data + + def _get_context_matches(self, entry, context_data): + matches = list() + + for data in context_data: + variables = {'matches': list()} + + for match in entry['matches']: + when = entry.get('when') + + if when is not None: + if not self._check_conditional(when, variables): + warning('skipping match statement due to conditional check') + continue + + pattern = self.template(match['pattern'], self.NAMED_PATTERNS) + match_var = match.get('match_var') + match_all = match.get('match_all') + + if match_all: + res = re.findall(pattern, data, re.M) + else: + match = re.search(pattern, data, re.M) + if match: + res = list(match.groups()) + else: + res = None + + if match_var: + variables[match_var] = res + + variables['matches'].append(res) + + matches.append(variables) + return matches + + def template(self, data, variables, convert_bare=False): + + if isinstance(data, collections.Mapping): + templated_data = {} + for key, value in iteritems(data): + templated_key = self.template(key, variables, convert_bare=convert_bare) + templated_data[templated_key] = self.template(value, variables, convert_bare=convert_bare) + return templated_data + + elif isinstance(data, collections.Iterable) and not isinstance(data, string_types): + return [self.template(i, variables, convert_bare=convert_bare) for i in data] + + else: + data = data or {} + tmp_avail_vars = self._templar._available_variables + self._templar.set_available_variables(variables) + try: + resp = self._templar.template(data, convert_bare=convert_bare) + resp = self._coerce_to_native(resp) + except AnsibleUndefinedVariable: + resp = None + pass + finally: + self._templar.set_available_variables(tmp_avail_vars) + return resp + + def _coerce_to_native(self, value): + if not isinstance(value, bool): + try: + value = int(value) + except Exception as exc: + if value is None or len(value) == 0: + return None + pass + return value + + def _check_conditional(self, when, variables): + conditional = "{%% if %s %%}True{%% else %%}False{%% endif %%}" + return self.template(conditional % when, variables) diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..2e77215 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,2 @@ +--- +# defaults file for network-engine \ No newline at end of file diff --git a/docs/parser_directives.md b/docs/parser_directives.md new file mode 100644 index 0000000..40b62f0 --- /dev/null +++ b/docs/parser_directives.md @@ -0,0 +1,143 @@ +CLI Parser Directives +===================== +The ```text_parser``` module is a module that can be used to parse the results of +text strings into Ansible facts. The primary motivation for developing the +```text_parser``` module is to convert structured ASCII text output (such as +those returned from network devices) into structured JSON data structures +sutable to be used as host facts. + +The parser file format is loosely based on the Ansible playbook directives +language. It uses the Ansible directive language to ease the transition from +writing playbooks to writing parsers. Below is the set of supported directives +the ```text_parser``` module recognizes along with a description of the +directives basic functionality. + +## Parser language +The parse supports an Ansible-like playbook parser language that is loosely +designed after the current Ansible language. It implements a set of directives +that are designed to perform specific actions. + +The parser format uses YAML formatting, providing a list sequential list of +directives to be performed on the contents (provided by the module argument). +The overall general structure of a directive is as follows: + +``` +- name: some description name of the task to be performed + directive: + key: value + key: value + directive_option: value + directive_option: value +``` + +The ```text_parser``` currently supports the following directives: + +* pattern_match +* pattern_group +* json_template +* export_facts + +In addition to the directives, the following common directive options are +currently supported. + +* name +* block +* loop +* when +* register + +The following sections provide more details about how to use the parser +directives to parse text into JSON structure. + +## Directive Options +This section provides details on the various options that are available to be +configured on any directive. + +### name +All entries in the parser file many contain a ```name``` directive. The +```name``` directive can be used to provide an arbitrary description as to the +purpose of the parser items. + +The use of ```name``` is optional for all directives. + +### register +The ```register``` directive option can be used same as would be used in an +Ansible playbook. It will register the results of the directive operation into +the named variable such that it can be retrieved later. + +However, be sure to make note that registered variables are not available +outside of the parser context. Any values registered are only availalbe within +the scope of the parser activities. If you want to provide values back to the +playbook, use the [export-facts](#export_facts) directive. + +### loop +Sometimes it is necessary to loop over a directive in order to process values. +Using the ```loop``` option, the parser will iterate over the directive and +provide each of the values provided by the loop contents to the directive for +processing. + +Access to the individual items is the same as it would be for Ansible +playbooks. When iterating over a list of items, you can access the individual +item using the ```{{ item }}``` variable. When looping over a hash, you can +access ```{{ item.key }}``` and ```{{ item.value }}```. + +### when +The ```when``` option allows for a conditional to be placed on the directive to +decided if it is executed or not. The ```when``` option operates the same as +it would in an Ansible playbook. + +For example, let's assume we only want to match perform the match statement +when the value of ```ansible_network_os``` is set to ``ios```. We would apply +the ```when``` conditional as such: + +``` +- name: conditionally matched var + pattern_match: + regex: "hostname (.+)" + when: ansible_network_os == 'ios' +``` + +### block +The use of ```block``` allows for grouping items together to perform a common +set of matches. Typically this directive will be used when you need to iterate +over a block of text to find multiple matches. + +## Directives +The directives perform actions on the contents using regular expressions to +extract various values. Each directive provides some additional arguments that +can be used to perform its operation. + +### pattern_match +The ```pattern_match``` directive is used to extract one or more values from +the structured ASCII text based on regular expressions. + +The following arguments are supported for this directive: + +* regex +* contents +* match_all +* match_greedy + + +### pattern_group +The ```pattern_group``` directive can be used to group multiple +```pattern_match``` results together. + + +The following arguments are supported for this directive: + +### json_template +The ```json_template``` directive will create a JSON data structure based on a +template. This directive will allow you to template out a multi-level JSON +blob. + +The following arguments are supported for this directive: + +* template + + +### export_facts +The ```export_facts``` directive takes an arbitrary set of key / value pairs +and exposes (returns) them back to the playbook global namespace. Any key / +value pairs that are provided in this directive become available on the host. + diff --git a/docs/template_directives.md b/docs/template_directives.md new file mode 100644 index 0000000..abc2276 --- /dev/null +++ b/docs/template_directives.md @@ -0,0 +1,261 @@ +CLI Template Directives +======================= +The ```network_template``` module supports a number of keyword based objectives that +handle how to process the template. Templates are broken up into a series +of blocks that process lines. Blocks are logical groups that have a common +set of properties in common. + +Blocks can also include other template files and are processed in the same +manner as lines. See includes below for a description on how to use the +the include directive. + +The template module works by processing the lines directives in sequential +order. The module will attempt to template each line in the lines directive +and, if successful, add the line to the final output. Values used for +variable substitution come from the host facts. If the line could not +be successfully templated, the line is skipped and a warning message is +displayed that the line could not be templated. + +There are additional directives that can be combined to support looping over +lists and hashes as well as applying conditional statements to blocks, lines +and includes. + +# name +Entries in the template may contain a ```name``` field. The ```name``` field +is used to provide a description of the entry. It is also used to provide +feedback when processing the template to indicate when an entry is +skipped or fails. + +# lines +The ```lines``` directive provides an ordered list of statements to attempt +to template. Each entry in the ```lines``` directive will be evaluated for +variable substitution. If the entry can be successfully templated, then the +output will be added to the final set of entries. If the entry cannot be +successfully templated, then the entry is ignored (skipped) and a warning +message is provided. If the entry in the ```lines``` directive contains +only static text (no variables), then the line will always be processed. + +The ```lines``` directive also supports standard Jinja2 filters as well as any +Ansible specific Jinja2 filters. For example, lets assume we want to add a +default value if a more specific value was not assigned by a fact. + +``` +- name: render the system hostname + lines: + - "hostname {{ hostname | default(inventory_hostname_short }}" +``` + + +# block +A group of ```lines``` directives can be combined into a ```block``` +directive. These ```block``` directives are used to apply a common set of +values to one or more ```lines``` or ```includes``` entries. + +For instance, a ```block``` directive that contains one or more ```lines``` +entries could be use the same set of ```loop``` values or have a +common ```when``` conditional statement applied to them. + +# include +Sometimes it is advantageous to break up templates into separate files and +combine them. The ```include``` directive will instruct the current template +to load another template file and process it. + +The ```include``` directive also supports variable substitution for the +provided file name and can be processed with the ```loop``` and ```when``` +directives. + +# when +The ```when``` directive allows for conditional statements to be applied to +a set of ```lines```, a ```block``` and/or the ```include``` directive. The +```when``` statement is evaluated prior to processing the statements and if +the condition is true, the statements will attempt to be templated. If the +statement is false, the statements are skipped and a message returned. + +# loop +Depending on the input facts, sometimes it is necessary to iterate over a +set of statements. The ```loop``` directive allows the same set of statements +to be processed in such a manner. The ```loop``` directive takes, as input, +the name of a fact that is either a list or a hash and iterates over the +statements for each entry. + +When the provided fact is a list of items, the value will be assigned to a +variable called ```item``` and can be referenced by the statements. + +When the provided fact is a hash of items, the hash key will be assigned to +the ```item.key``` variable and the hash value will be assigned to the +```item.value``` variable. Both can then be referenced by the statements. + +# loop_control +The ```loop_control``` directive allows the template to configure aspects +related to how loops are process. This directive provides a set of suboptions +to configure how loops are processed. + +## loop_var +The ```loop_var``` directive allows the template to override the default +variable name ```item```. This is useful when handling nested loops such +that both inner and outer loops values can be accessed. + +When setting the ```loop_var``` to some string, the string will replace +```item``` as the variable name used to access the values. + +For example, lets assume instead of using item, we want to use a different +variable name such as entry: + +``` +- name: render entries + lines: + - "hostname {{ entry.hostname }}" + - "domain-name {{ entry.domain_name }}" + loop: "{{ system }}" + loop_control: + loop_var: entry +``` + +# join +When building template statements that include optional values for +configuration, the ```join``` directive can be useful. The ```join``` +directive instructs the template to combine the templated lines together +into a single string to insert into the configuration. + +For example, lets assume there is a need to add the following statement to +the configuration: + +``` +ip domain-name ansible.com vrf management +ip domain-name redhat.com +``` + +To support templating the above lines, the facts might include the domain-name +and the vrf name values. Here is the example facts: + +``` +--- +system: + - domain_name: ansible.com + vrf: management + - domain_name redhat.com +``` + +And the template statement would be the following: + +``` +- name: render domain-name + lines: + - "ip domain-name {{ item.domain_name }}" + - "vrf {{ item.vrf }}" + loop: "{{ system }}" + join: yes +``` + +When this entry is processed, the first iteration will successfully template +both lines and add ```ip domain-name ansible.com vrf management``` to the +output. + +When the second entry is processed, the first line will be successfully +templated but since there is no management key, the second line will return a +null value. The final line added to the configuration will be ``` ip +domain-name redhat.com```. + +If the ```join``` directive had been omitted, then the final set of +configuration statements would be as follows: + +``` +ip domain-name ansible.com +vrf management +ip domain-name redhat.com +``` + +# join_delimiter +When the ```join``` delimiter is used, the templated values are combined into a +single string that is added to the final output. The lines are joined using a +space. The delimiting character used when processing the ```join``` can be +modified using ```join_delimiter``` directive. + +Here is an example of using the this directive. Take the following entry: + +``` +- name: render domain-name + lines: + - "ip domain-name {{ item.domain_name }}" + - "vrf {{ item.vrf }}" + loop: "{{ system }}" + join: yes + join_delimiter: , +``` + +When the preceding statements are processed, the final output would be +(assuming all variables are provided): + +``` +ip domain-name ansible.com,vrf management +ip domain-name redhat.com +``` + +# indent +The ```indent``` directive is used to add one or more leading spaces to the +final templated statement. It can be used to recreated a structured +configuration file. + +Take the following template entry as an example: + +``` +- name: render the interface context + lines: "interface Ethernet0/1" + +- name: render the interface configuration + lines: + - "ip address 192.168.10.1/24" + - "no shutdown" + - "description this is an example" + indent: 3 + +- name: render the interface context + lines: "!" +``` + +Then the statements above are processed, the output will look like the +following: + +``` +interface Ethernet0/1 + ip address 192.168.10.1/24 + no shutdown + description this is an example +! +``` + +# required +The ```required``` directive specifies that all of the statements must be +templated otherwise a failure is generated. Essentially it is a way to +make certain that the variables are defined. + +For example, take the following: + +``` +- name: render router ospf context + lines: + - "router ospf {{ process_id }}" + required: yes +``` + +When the above is processed, if the variable ```process_id``` is not present, +then the statement cannot be templated. Since the ```required``` directive +is set to true, the statement will cause the template to generate a failure +message. + +# missing_key +By default, when statements are processed and a variable is undefined, the +module will simply display a warning message to the screen. In some cases, it +is desired to either suppress warning messages on a missing key or to force the +module to fail on a missing key. + +To change the default behaviour, use the ```missing_key``` directive. This +directive accepts one of three choices: + +* ignore +* warn (default) +* fail + +The value of this directive will instruct the template how to handle any +condition where the desired variable is undefined. + diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..14d243e --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,2 @@ +--- +# handlers file for network-engine \ No newline at end of file diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..0a69c9c --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,34 @@ +--- +galaxy_info: + author: Ansible Network + description: This role is developed and maintained by the Ansible Network team + company: Red Hat + + issue_tracker_url: http://github.com/ansible-network/network-engine/issues + + license: GPLv3 + + min_ansible_version: 1.2 + + # If this a Container Enabled role, provide the minimum Ansible Container version. + # min_ansible_container_version: + + # Optionally specify the branch Galaxy will use when accessing the GitHub + # repo for this role. During role install, if no tags are available, + # Galaxy will use this branch. During import Galaxy will access files on + # this branch. If Travis integration is configured, only notifications for this + # branch will be accepted. Otherwise, in all cases, the repo's default branch + # (usually master) will be used. + #github_branch: + + platforms: + all + + galaxy_tags: + - ansible-network + - networking + - core + - supported + - cli + +dependencies: [] diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..14580b1 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,2 @@ +--- +# tasks file for network-engine \ No newline at end of file diff --git a/tests/inventory b/tests/inventory new file mode 100644 index 0000000..878877b --- /dev/null +++ b/tests/inventory @@ -0,0 +1,2 @@ +localhost + diff --git a/tests/test.yml b/tests/test.yml new file mode 100644 index 0000000..92ad039 --- /dev/null +++ b/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - network-engine \ No newline at end of file diff --git a/vars/main.yml b/vars/main.yml new file mode 100644 index 0000000..5db5963 --- /dev/null +++ b/vars/main.yml @@ -0,0 +1,2 @@ +--- +# vars file for network-engine \ No newline at end of file