├── FreeZTP-100.png ├── LICENSE ├── README.md ├── TIPS.md └── ztp.py /FreeZTP-100.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PackeTsar/freeztp/d4b9b2b46b1e2eefcd20714c73b9f15ccf9719d4/FreeZTP-100.png -------------------------------------------------------------------------------- /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 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FreeZTP ![FreeZTP][logo] 2 | 3 | A Zero-Touch Provisioning system built for Cisco Catalyst switches. 4 | 5 | 6 | ----------------------------------------- 7 | ## VERSION ## 8 | The version of FreeZTP documented here is: **v1.5.1** 9 | 10 | 11 | ----------------------------------------- 12 | ## TABLE OF CONTENTS ## 13 | 1. [What is FreeZTP](#what-is-freeztp) 14 | 2. [Requirements](#requirements) 15 | 3. [Installation](#installation) 16 | 4. [Getting Started](#getting-started) 17 | 5. [Terminology](#terminology) 18 | 6. [ZTP Process](#ztp-process) 19 | 7. [Command Interface](#command-interface) 20 | 8. [DHCP Functionality](#dhcp-functionality) 21 | 9. [Advanced Usage](#advanced-usage) 22 | 10. [Upgrading](#upgrading) 23 | 11. [External Keystores](#external-keystores) 24 | 12. [Integrations](#integrations) 25 | 13. [Usage Tips](/TIPS.md) 26 | 14. [Versions](#versions) 27 | 15. [Contributing](#contributing) 28 | 29 | 30 | 31 | ----------------------------------------- 32 | ## WHAT IS FREEZTP ## 33 | FreeZTP is a dynamic TFTP server built to automatically configure Cisco Catalyst switches upon first boot (Zero-Touch Provisioning). FreeZTP does this using the 'AutoInstall' feature built into Cisco IOS and automatically enabled by default. FreeZTP configures switches with individual, "templatized" configurations based upon the unique ID of the switch (usually the serial number). 34 | 35 | 36 | ----------------------------------------- 37 | ## REQUIREMENTS ## 38 | OS: Tested on **CentOS/RHEL 7 and 8** (Recommended), **Ubuntu 16 and 18**, and **Raspbian** 39 | 40 | Interpreter: **Python 2.7.5+** 41 | 42 | 43 | ----------------------------------------- 44 | ## INSTALLATION ## 45 | 46 | 47 | FreeZTP Installation Video 48 | 49 | 50 | The installation of FreeZTP is quick and easy using the built-in installer. Click the picture on the right to watch a quick 7 minute video on the installation, initial configuration, and first switch deployment with FreeZTP. 51 | 52 | Make sure you are logged in as root or are able to `sudo su` to install and operate FreeZTP. 53 | 54 | 1. Install OS with appropriate IP and OS settings and update to latest patches (recommended). Check out the below links for easy Post-Install processes for OS's supported by FreeZTP. 55 | - **CentOS 7:** [CentOS Minimal Server - Post-Install Setup][centos-post-install] 56 | - Make sure to install Git for a CentOS install 57 | - `sudo yum install git -y` 58 | - Install Python2 PIP 59 | - `sudo yum install python2-pip` 60 | - **CentOS 8:** 61 | - Make sure to install Git for a CentOS install 62 | - `sudo yum install git -y` 63 | - Install Python2 PIP 64 | - `sudo yum install python2-pip` 65 | - Create `python` Symlink 66 | - `sudo ln -s /usr/bin/python2.7 /usr/bin/python` 67 | - Create `pip` Symlink 68 | - `sudo ln -s /usr/bin/pip2 /usr/bin/pip` 69 | - **Ubuntu 16:** [Ubuntu Minimal Server - Post-Install Setup][ubuntu-post-install] 70 | - Make sure to install python-pip and git for Ubuntu 71 | - `sudo apt install -y python-pip` 72 | - `sudo apt-get install -y git` 73 | - **Ubuntu 18 or 20:** 74 | - Install Git and Curl Clients 75 | - `apt install git` 76 | - `apt install curl` 77 | - Install Python2 and create a symlink for it 78 | - `sudo apt install python2` 79 | - Use `sudo apt-get install python-pip` on Ubuntu 18 80 | - `sudo ln -s /usr/bin/python2.7 /usr/bin/python` 81 | - Install PIP for Python2 82 | - `curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py` 83 | - `sudo python get-pip.py` 84 | - **Raspbian:** [Raspbian Minimal Server - Post-Install Setup][raspbian-post-install] 85 | - Make sure to install python-pip and git for Raspbian 86 | - `sudo apt install -y python-pip` 87 | - `sudo apt-get install -y git` 88 | 2. Download the FreeZTP repository using Git 89 | - `git clone https://github.com/packetsar/freeztp.git` 90 | 3. Change to the directory where the FreeZTP main code file (ztp.py) is stored: `cd freeztp` 91 | 4. Run the FreeZTP program in install mode to perform the installation: `sudo python ztp.py install`. Make sure the machine has internet access as this process will download and install several packages for this to happen. 92 | - FreeZTP will perform the install of the packages and services for full operation. 93 | - The installation will also install a CLI completion (helper) script. You will need to logout and log back into your SSH session to activate this completion script. 94 | 95 | 96 | ----------------------------------------- 97 | ## GETTING STARTED ## 98 | The ZTP server comes with an [almost] fully functional default configuration, ready to serve out a basic config to switches. You can view the configuration (after installation) by issuing the command `ztp show config`. 99 | 100 | The only part missing on the configuration is an IP lease range for DHCPD. You will need to add this IP range in order to enable the DHCPD service to hand out IP addresses (see below instructions). After this range is added and the DHCPD service restarted, you can connect the ZTP server directly to the switch (on any of its ports), power on the switch, and watch it go! 101 | 102 | 1. Configure DHCPD using the ZTP commands 103 | - During installation, ZTP will install the DHCPD service, detect the network interfaces in Linux, and configure DHCPD scopes for each of the interfaces. The created DHCPD scopes will be inactive to serve DHCPD as they will have no addresses available to lease. 104 | - If you want to use the automatically generated DHCPD scope (the new switches will be on the same VLAN as one of FreeZTPs interfaces), you just need to specify a first and last address for the lease range. After configured, you will need to commit the ZTP DHCPD configuration. Committing the DHCPD configuration (`ztp request dhcpd-commit`) automatically compiles/saves the DHCP configuration and restarts the DHCPD service. Below is example of how to do this. 105 | 106 | 107 | ztp set dhcpd INTERFACE-ETH0 first-address 192.168.1.100 108 | ztp set dhcpd INTERFACE-ETH0 last-address 192.168.1.200 109 | # 110 | ztp request dhcpd-commit 111 | 112 | 113 | - If the switches will not be on the same VLAN, then create a new scope (you can use the existing scope configuration commands as a reference). 114 | - There are other basic DHCPD options included in the scope settings like `dns-servers`, `domain-name`, and `gateway` which can be set as needed. Make sure to do a `ztp request dhcpd-commit` after any changes to DHCPD configurations. 115 | 2. Start configuring switches! 116 | - FreeZTP comes with a default configuration which is ready to configure switches. A default-keystore is configured which will hand out a basic (non-individualized) config to a newly booted switch. 117 | - There are a few example templates, keystores, associations, and an ID array already in the default config which you can reference. Feel free to modify them to do what you want, or blow them away and customize everything. 118 | - Once you have the ZTP configuration set, restart the ZTP service (`ztp service restart`) for your changes to take effect. 119 | - Boot up a switch (with a blank configuration) and watch it grab a DHCP address and contact ZTP for image upgrades and configurations. 120 | - Be patient when the switch boots up as it sometimes takes a few (1-3) minutes after the "press RETURN to get started" message to begin the AutoInstall process. 121 | - You can watch for action in ZTP by checking the DHCP leases (`ztp show dhcpd leases`) and watching the active logs (`ztp show log tail`). 122 | - You can also see the history of devices which have gone through the provisioning process using `ztp show provisioning`. 123 | 124 | 125 | ----------------------------------------- 126 | ## TERMINOLOGY ## 127 | Due to the unique nature of how FreeZTP works and performs discovery of switches, there are a few terms you will need to know to understand the application. 128 | - **Template** 129 | - FreeZTP relies on the Jinja2 templating standard to take a common Cisco IOS configuration and templatize it: creating variables (with the `{{ i_am_a_variable }}` syntax) in the template where unique values can be inserted for a specific switch upon a configuration pull. 130 | - FreeZTP uses two different template types: the 'initial-template', and the custom named final templates. 131 | - The initial-template is used to set the switch up for discovery. You will most likely never need to change the initial-template configuration. It has a default configuration that will most likely work for you. 132 | - Named (final) templates are used to push the final configuration once the discovery is complete and the switch has been identified (this will make more sense in the **ZTP Process** section). You will definitely be changing the named templates to fit the configurations you want your switches to have. 133 | - **Template Example Config** 134 | 135 | ztp set template SHORT_TEMPLATE ^ 136 | hostname {{ hostname }} 137 | ! 138 | interface Vlan1 139 | ip address {{ vl1_ip_address }} 255.255.255.0 140 | no shut 141 | ! 142 | end 143 | ^ 144 | 145 | - **Keystore** 146 | - The counterpart to the template (specifically: named templates) is the keystore. The keystore is the part of the ZTP configuration which holds the unique configuration values for specific switches (or for many switches). The keystore provides those values for the merge of the final-template once the switch has been identified by the discovery process. 147 | - **Keystore ID** 148 | - A Keystore ID is the named identifier for a specific store which holds a set of key-value pairs. 149 | - ie "SOMEID" in: `ztp set keystore SOMEID hostname SOMEDEVICE` 150 | - **Keystore Key** 151 | - A Keystore Key is the key side of a certain key-value pair which resides under a named Keystore ID. 152 | - ie "hostname" in: `ztp set keystore SOMEID hostname SOMEDEVICE` 153 | - **Keystore Value** 154 | - A Keystore Value is the value side of a certain key-value pair which resides under a named Keystore ID. 155 | - ie "SOMEDEVICE" in: `ztp set keystore SOMEID hostname SOMEDEVICE` 156 | - **Keystore Hierarchy** 157 | - The hierarchy of the Keystore works as follows: A Keystore ID can contain multiple (unique) keys, each key with a different value. The Keystore can contain multiple IDs, each with its own set of key-value pairs. 158 | - **Keystore Example Config** 159 | 160 | ztp set keystore STACK1 vl1_netmask 255.255.255.0 161 | ztp set keystore STACK1 vl1_ip_address 10.0.0.200 162 | ztp set keystore STACK1 hostname CORESWITCH 163 | 164 | - **ID Arrays** 165 | - An ID Array is a method of mapping one or more Real switch IDs (ie: serial numbers) to a specific keystore. Multiple Real IDs can be mapped to the same Keystore ID, which comes in handy when building a configuration for a switch stack (which will assume the serial number of the stack master when it boots up). 166 | - The ID array has two pieces: 167 | - The **Array Name** is the name of the specific array. The Array Name must match a Keystore ID in order to assign its real-IDs to that Keystore. 168 | - The **Array ID List** is a list of Real switch IDs (serial numbers) which, when searched for, will resolve to the Array Name before mapping to a Keystore ID. When configuring an IDArray in the CLI, each ID in the list is separated by a space. 169 | - **ID Array Example Config** 170 | 171 | ztp set idarray STACK1 SERIAL1 SERIAL2 SERIAL3 172 | 173 | - **Associations** 174 | - An association is a configuration element which maps a keystore to a named template. An association is required for each keystore in order to tell FreeZTP which template to use to do the merge when using certain keystore. 175 | - **Association Example Config** 176 | 177 | ztp set association id STACK1 template LONG_TEMPLATE 178 | 179 | - **Others** 180 | - The `default-keystore` setting allows you to specify a keystore which will be matched in the event that the switch has a real-ID (ie: serial number) which is not configured in any Keystore or IDArray. It can be set to `None` if you don't want a functional default keystore. 181 | - The `default-template` setting associates all keystores to a template when a keystore has no specific association (ie: `ztp set association id STACK1 template LONG_TEMPLATE`) 182 | - The `imagefile` setting specifies the image file you want to have switches use for software upgrades. The image file must exist in the TFTP root directory (/etc/ztp/tftproot/ by default). The TFTP root directory is set with the configuration command `ztp set tftproot /etc/ztp/tftproot/`. 183 | - The `image-supression` setting prevents a second attempt by a switch to download its software image. This exists because some switches may upgrade their software, reboot into the new software version, begin the AutoInstall process again and try to upgrade again. The image-supression time setting is in seconds and is 3600 seconds (1 hour) by default. 184 | - The `delay-keystore` setting delays the internal lookup of a keystore by ZTP for the specified number of milliseconds (1000 msec by default). This prevents ZTP from checking the SNMP discovery status before it has a chance to finish discovering the switch's real-ID using the configured SNMP OIDs. 185 | 186 | 187 | ----------------------------------------- 188 | ## ZTP PROCESS ## 189 | FreeZTP relies on the 'AutoInstall' function of a Cisco Catalyst switch to configure the switch upon first boot. The process followed to configure the switch is outlined below. 190 | 191 | The new switch should have one of its ports connected to a network (likely an upstream switch) which has the FreeZTP server accessible. The FreeZTP server can be on the same VLAN as the new switch (so it can serve up DHCP addresses directly) or on a different VLAN which has a gateway and an IP helper pointed at the FreeZTP server so it can serve up DHCP. 192 | 193 | #### 1. STEP 1 - POWER ON: Initial boot up and DHCP leasing 194 | - NOTE: _Once the operating system is loaded on the switch and it completes the boot-up process (after the "press RETURN to get started" message), it will start the AutoInstall process_ 195 | - **Step 1.1:** The switch will enable all of its ports as access ports for VLAN 1. 196 | - **Step 1.2:** The switch will enable interface (SVI) Vlan1 and begin sending out DHCP requests from interface Vlan1. 197 | - **Step 1.3:** The switch will get a DHCP lease from the ZTP server or from a different DHCP server. The lease will contain DHCP option 150 (TFTP Server) which points at the IP of the ZTP server. 198 | - **Step 1.4:** To upgrade, or not to upgrade: 199 | - IF DHCP option 125 was configured (`ztp set dhcpd SCOPENAME imagediscoveryfile-option enable`) and that option is handed to the switch in its DHCP lease, then the switch will proceed to **Step 2**. 200 | - IF DHCP option 125 was not configured (`ztp set dhcpd SCOPENAME imagediscoveryfile-option disable`), the switch will proceed to **Step 3**. 201 | 202 | #### 2. STEP 2 - IOS Upgrade: The imagediscoveryfile is used to discover the IOS image file 203 | - NOTE: _DHCP Option 125 will contain (in hex form) the name of the imagediscoveryfile setting ("freeztp_ios_upgrade" by default in the ZTP configuration) which is a fictitious file containing the name of the .bin or .tar file the switch needs to download for the upgrade._ 204 | - **Step 2.1:** The switch will send a TFTP request to ZTP requesting the imagediscoveryfile ("freeztp_ios_upgrade" by default). 205 | - **Step 2.1.1:** FreeZTP will check the file download log (seen by using `ztp show downloads`) to see if the "freeztp_ios_upgrade" file has been downloaded by that IP address within the image-supression timeframe (set with `set image-supression `). This time-saving feature prevents some switch models from upgrading their IOS, automatically rebooting, then attempting the upgrade again after a reboot (which results in the switch downloading the IOS image a second time, just to abort the upgrade since the software is the same version). 206 | - If a valid suppression entry is found, then ZTP will return the "freeztp_ios_upgrade" file containing a bogus value; causing the switch to fail the IOS download and move on to configuration downloads in **Step 3**. 207 | - If a valid suppression entry is NOT found, ZTP will continue from **Step 2.2**. 208 | - **Step 2.2:** FreeZTP will check its "imagefile" (`ztp set imagefile someIOSfile.bin`) setting and dynamically generate a "freeztp_ios_upgrade" file containing the name of that .bin or .tar file. This "freeztp_ios_upgrade" file is then sent to the switch to be downloaded. 209 | - **Step 2.3:** The switch reads the file and determines what .bin or .tar file it should download as its upgrade image. Once determined, the switch sends a TFTP download request to ZTP for that .bin or .tar filename . 210 | - **Step 2.4:** If the .bin or .tar file does not exist, the switch abandons the upgrade attempt and proceeds to **Step 3**. If the .bin or .tar file does exist, then the ZTP server allows the switch to download it with TFTP. 211 | - **Step 2.5:** Once fully downloaded, the switch will install the image and upgrade itself. Depending on the switch model, it may or may not automatically reboot itself. After the upgrade, the switch will start the ZTP process over, but will likely bypass the IOS upgrade step due to the image-supression function in **Step 2.1.1**. 212 | 213 | #### 3. STEP 3 - INITIAL-CONFIG: An initial config is generated, sent, and loaded for switch (target) discovery 214 | - **Step 3.1:** The switch will send a TFTP request for a file named "**network-confg**" to the IP address specified in the DHCP option 150 (which should be the ZTP server). 215 | - **Step 3.2:** When the request for the "network-confg" file is received by the ZTP server, it generates the config by performing an automatic merge with the `initial-template`: 216 | - **Step 3.2.1:** The `{{ autohostname }}` variable in the initial-template is filled by an automatically generated hexadecimal temporary name (example: ZTP-22F1388804). This temporary name is saved in memory by the ZTP server for future reference because the switch will use it's temporary hostname to request a new TFTP file in **Step 5.1**. 217 | - **Step 3.2.2:** The SNMP `{{ community }}` variable is filled with the value set in the `community` configuration field 218 | - **Step 3.3:** This merged configuration is passed to the Cisco switch as the "network-confg" file. The switch loads it into its active running-config and proceeds to **Step 5** (ZTP performs **Step 4** in the mean time). 219 | - NOTE: _You can see an example initial configuration from the ZTP server by issuing the command_ `ztp request initial-merge` 220 | 221 | #### 4. STEP 4 - SNMP DISCOVERY: The ZTP server discovers the switch's "Real ID" (ie: serial number) using SNMP 222 | - **Step 4.1:** After the initial config file is passed to and loaded by the switch, the ZTP server initiates a SNMP discovery of the switch's serial number, or "Real ID" 223 | - **Step 4.1.1:** The SNMP requests target the source IP of the switch which was used to originally request the "network-confg" file in **Step 3.1** 224 | - **Step 4.1.2:** The SNMP requests use the value of the `community` configuration field as the authentication community (which the switch should honor once it loads the configuration from the "network-confg" file) 225 | - **Step 4.1.3:** The SNMP requests use the OIDs set with `ztp set snmpoid NAME `. The FreeZTP default configuration comes with a few different OIDs pre-configured for some popular switch models. 226 | - NOTE: _You may need to add an OID based on the switch model you are discovering. You can test the configured OIDs for returned values using the command_ `ztp request snmp-test ` _. Your switch will need to be accessible and ready to accept the ZTP configured community_ 227 | - **Step 4.1.4:** Once the SNMP query succeeds, the ZTP server maps the Real ID (ie: serial number) of the discovered switch to its temporary hostname generated in **Step 3.2.1** 228 | 229 | #### 5. STEP 5 - FINAL CONFIG REQUEST: The switch requests the final configuration file and the ZTP server generates it based on the ZTP configuration 230 | - **Step 5.1:** After the switch loads the "network-confg" file into its running-config, it sends out a new TFTP request to the ZTP server for a new configuration file. The file name for the new TFTP request is based upon the hostname passed to the switch in the initial ("network-confg") file (example filename: "ZTP-22F1388804-confg") from **Step 3.2.1**. 231 | - **Step 5.2 (FIND A KEYSTORE ID):** ZTP attempts to find a usable Keystore ID to create the final configuration: 232 | - **Step 5.2.1 (USING THE REAL ID):** ZTP uses the requested filename (example filename: "ZTP-22F1388804-confg") to look up the Real ID (serial number) of the requesting switch (it was saved in **Step 4.1.4**). If the Real ID of the requesting switch is known, the ZTP server attempts to use that ID to find a suitable Keystore ID: 233 | - **Step 5.2.1.1:** The Real ID of the switch is used to search through all of the Keystore IDs to see if one of them matches the Real ID. If a Keystore ID matches, then the server proceeds to **Step 5.3** with that Keystore ID. 234 | - **Step 5.2.1.2:** If there is no match between the Real ID and a Keystore ID, then the server looks to the ID Arrays for a match. It searches through the ID list in each IDArray, once a match is found, the server resolves the Real ID to the IDArray Name and re-searches the Keystore IDs for a match using the resolved IDArray name. Once a match is found, the server continues to **Step 5.3** with the matched Keystore ID. 235 | - **Step 5.2.2 (USING THE DEFAULT KEYSTORE):** If ZTP was unable to determine the ID of the switch, or the ID of the switch does not match either a Keystore ID or an ID Array, then ZTP will look to see if a default Keystore ID has been configured using the `default-keystore` setting. If a default Keystore ID is set, and that Keystore ID is actually configured with at least one key/value pair, then ZTP will continue on through the process using that Keystore ID. 236 | - NOTE: _If the `default-keystore` is set to_ `None`_, or the default-keystore name does not actually exist as a configured Keystore ID, then ZTP will send a "no such file" failure message to the switch as a response to the TFTP request_ 237 | - NOTE: _You can test the default-keystore configuration by issuing the command_ `ztp request default-keystore-test` 238 | - **Step 5.3 (FIND THE ASSOCIATED TEMPLATE):** Once a candidate Keystore ID is found, the server checks to see if an `association` exists in the ZTP configuration to associate the Keystore ID with a template. 239 | - If a specific association exists for that Keystore ID, ZTP performs the Jinja2 merge of the final configuration using the associated template. 240 | - If a specific association does NOT exist for that Keystore ID, ZTP checks the `default-template` setting for a usable template for a Jinja2 merge. If the setting points to an existing template, ZTP performs the Jinja2 merge of the final configuration using the default template. 241 | - NOTE: _If no association exists for the Keystore ID, or an association exists, but the associated template name doesn't match any configured template, AND ZTP cannot find a usable default template, then ZTP will send a "no such file" failure message to the switch as a response to the TFTP request_ 242 | - **Step 5.4 (COMPLETE THE FINAL CONFIG):** After the matching keystore and an associated template have been found, the ZTP server will perform the Jinja2 merge between the template and the key/value pairs in the Keystore ID. This configuration is then passed to the switch in response to its TFTP request made in **Step 5.1**. 243 | - NOTE: _You can see this merged configuration by issuing the command_ `ztp request merge-test ` 244 | - NOTE: _If you configured static IP addresses in the final-template, the switch will then start using those static IPs and can be remotely accessible via them (assuming you also included config for AAA and SSH)_ 245 | - NOTE: _The switch does not save the new configurations into its startup-config. That has to be done manually_ 246 | 247 | #### Ladder Diagram #### 248 | 249 | **SWITCH** -----> Step 2.1: File "freeztp_ios_upgrade" requested -------------------------------> **ZTP Server** 250 | 251 | **SWITCH** <----- Step 2.1.1 or 2.2: Auto-generated "freeztp_ios_upgrade" file sent to switch <-- **ZTP Server** 252 | 253 | **SWITCH** -----> Step 2.3: .bin or .tar file requested ----------------------------------------> **ZTP Server** 254 | 255 | **SWITCH** <----- Step 2.4: .bin or .tar file sent to switch if it exists <---------------------- **ZTP Server** 256 | 257 | **SWITCH** -----> Step 3.1: File "network-confg" requested -------------------------------------> **ZTP Server** 258 | 259 | **SWITCH** <----- Step 3.3: Auto-generated initial config passed to switch <--------------------- **ZTP Server** 260 | 261 | **SWITCH** <----- Step 4: ZTP server performs discovery of Real ID using SNMP <---------------- **ZTP Server** 262 | 263 | **SWITCH** -----> Step 5.1: Switch requests new file based on new hostname ---------------------> **ZTP Server** 264 | 265 | **SWITCH** <----- Step 5.4: ZTP responds to TFTP request with final config <--------------------- **ZTP Server** 266 | 267 | 268 | ----------------------------------------- 269 | ## COMMAND INTERFACE ## 270 | The FreeZTP service runs in the background as a system service. All commands to the FreeZTP service start with `ztp` at the command line. For example: you can check the status of the background service using the command `ztp show status`, you can check the current configuration of the ZTP server with the command `ztp show config`. 271 | 272 | The command interface is fully featured with helpers which can be seen either by hitting ENTER with an incomplete command in the prompt, or by using the TAB key to display available options/autocomplete the command (similar to a Cisco IOS command line, but without the use of the question mark). 273 | 274 | All commands which change the ZTP configuration use the `set` or `clear` arguments. Commands issued with the `set` argument will overwrite an existing configuration item if that item already exists. The `clear` argument allows you to remove configuration items. 275 | 276 | The initial and final template configurations are entered as multi-line text blocks. To facilitate this, you must specify a delineation character in the `set` command. As an example, you will issue the command `ztp set template MY_TEMPLATE ^` where the carat (`^`) character is set as the delineation character. After that command is issued, you can paste in the multi-line Cisco IOS template text. Once finished, enter that delineation character (`^` in this case) on a line by itself to exit the text block entry mode. 277 | 278 | For configuration changes to take effect, you must always restart the ZTP service using the `ztp service restart` command. 279 | 280 | Below is the CLI guide for FreeZTP. You can see this at the command line by entering `ztp` and hitting ENTER (after installation). 281 | ``` 282 | ---------------------------------------------------------------------------------------------------------------------------------------------- 283 | ARGUMENTS | DESCRIPTIONS 284 | ---------------------------------------------------------------------------------------------------------------------------------------------- 285 | - run | Run the ZTP main program in shell mode begin listening for TFTP requests 286 | ---------------------------------------------------------------------------------------------------------------------------------------------- 287 | - install | Run the ZTP installer 288 | - upgrade | Run the ZTP upgrade process to update the software 289 | ---------------------------------------------------------------------------------------------------------------------------------------------- 290 | - show (config|run) (raw) | Show the current ZTP configuration 291 | - show status | Show the status of the ZTP background service 292 | - show version | Show the current version of ZTP 293 | - show log (tail) () | Show or tail the log file 294 | - show downloads (live) | Show list of TFTP downloads 295 | - show dhcpd leases (current|all|raw) | Show DHCPD leases 296 | - show provisioning | Show list of provisioned devices 297 | ---------------------------------------------------------------------------------------------------------------------------------------------- 298 | ---------------------------------------------------------------------------------------------------------------------------------------------- 299 | --------------------------------------------------- SETTINGS YOU PROBABLY SHOULDN'T CHANGE --------------------------------------------------- 300 | - set suffix | Set the file name suffix used by target when requesting the final config 301 | - set initialfilename | Set the file name used by the target during the initial config request 302 | - set community | Set the SNMP community you want to use for target ID identification 303 | - set snmpoid | Set named SNMP OIDs to use to pull the target ID during identification 304 | - set initial-template | Set the initial configuration j2 template used for target identification 305 | - set tftproot | Set the root directory for TFTP files 306 | - set imagediscoveryfile | Set the name of the IOS image discovery file used for IOS upgrades 307 | - set file-cache-timeout | Set the timeout for cacheing of files. '0' disables caching. 308 | --------------------------------------------------------- SETTINGS YOU SHOULD CHANGE --------------------------------------------------------- 309 | - set template | Create/Modify a named J2 tempate which is used for the final config push 310 | - set keystore | Create a keystore entry to be used when merging final configurations 311 | - set idarray ... | Create an ID array to allow multiple real ids to match one keystore id 312 | - set association id template | Associate a keystore id or an idarray to a specific named template 313 | - set default-keystore (none|keystore-id) | Set a last-resort keystore and template for when target identification fails 314 | - set default-template (none|template_name) | Set a last-resort template for when no keystore/template association is found 315 | - set imagefile | Set the image file name to be used for upgrades (must be in tftp root dir) 316 | - set image-supression | Set the seconds to supress a second image download preventing double-upgrades 317 | - set delay-keystore | Set the miliseconds to delay the processing of a keystore lookup 318 | - set dhcpd [parameters] | Configure DHCP scope(s) to serve IP addresses to ZTP clients 319 | ---------------------------------------------------------------------------------------------------------------------------------------------- 320 | ---------------------------------------------------------------------------------------------------------------------------------------------- 321 | - clear snmpoid | Delete an SNMP OID from the configuration 322 | - clear template | Delete a named configuration template 323 | - clear keystore (all|) | Delete an individual key or a whole keystore ID from the configuration 324 | - clear idarray | Delete an ID array from the configuration 325 | - clear association | Delete an association from the configuration 326 | - clear dhcpd | Delete a DHCP scope 327 | - clear log | Delete the logging info from the logfile 328 | - clear downloads | Delete the list of TFTP downloads 329 | - clear provisioning | Delete the list of provisioned devices 330 | ---------------------------------------------------------------------------------------------------------------------------------------------- 331 | - request merge-test | Perform a test jinja2 merge of the final template with a keystore ID 332 | - request initial-merge | See the result of an auto-merge of the initial-template 333 | - request default-keystore-test | Check that the default-keystore is fully configured to return a template 334 | - request snmp-test | Run a SNMP test using the configured community and OID against an IP 335 | - request dhcp-option-125 (windows|cisco) | Show the DHCP Option 125 Hex value to use on the DHCP server for OS upgrades 336 | - request dhcpd-commit | Compile the DHCP config, write to config file, and restart the DHCP service 337 | - request auto-dhcpd | Automatically detect local interfaces and build DHCP scopes accordingly 338 | - request ipc-console | Connect to the IPC console to run commands (be careful) 339 | ---------------------------------------------------------------------------------------------------------------------------------------------- 340 | - service (start|stop|restart|status) | Start, Stop, or Restart the installed ZTP service 341 | ---------------------------------------------------------------------------------------------------------------------------------------------- 342 | - version | Show the current version of ZTP 343 | ---------------------------------------------------------------------------------------------------------------------------------------------- 344 | ``` 345 | 346 | The following is the default configuration seen on the ZTP server after installation when doing a `ztp show config`. 347 | 348 | ``` 349 | ####################################################### 350 | # 351 | # 352 | # 353 | ztp set suffix -confg 354 | ztp set initialfilename network-confg 355 | ztp set community secretcommunity 356 | ztp set tftproot /etc/ztp/tftproot/ 357 | ztp set imagediscoveryfile freeztp_ios_upgrade 358 | ztp set file-cache-timeout 10 359 | ztp set snmpoid WS-C2960_SERIAL_NUMBER 1.3.6.1.2.1.47.1.1.1.1.11.1001 360 | ztp set snmpoid WS-C3850_SERIAL_NUMBER 1.3.6.1.2.1.47.1.1.1.1.11.1000 361 | # 362 | # 363 | ztp set initial-template ^ 364 | hostname {{ autohostname }} 365 | ! 366 | snmp-server community {{ community }} RO 367 | ! 368 | end 369 | ^ 370 | # 371 | # 372 | # 373 | ####################################################### 374 | # 375 | # 376 | # 377 | ztp set dhcpd INTERFACE-ETH0 subnet 192.168.1.0/24 378 | ztp set dhcpd INTERFACE-ETH0 lease-time 3600 379 | ztp set dhcpd INTERFACE-ETH0 imagediscoveryfile-option enable 380 | ztp set dhcpd INTERFACE-ETH0 ztp-tftp-address 192.168.1.11 381 | # 382 | # 383 | # 384 | ####################################################### 385 | # 386 | # 387 | # 388 | ztp set template SHORT_TEMPLATE ^ 389 | hostname {{ hostname }} 390 | ! 391 | interface Vlan1 392 | ip address {{ vl1_ip_address }} 255.255.255.0 393 | no shut 394 | ! 395 | end 396 | ^ 397 | # 398 | # 399 | # 400 | ####################################################### 401 | # 402 | # 403 | # 404 | ztp set template LONG_TEMPLATE ^ 405 | hostname {{ hostname }} 406 | ! 407 | interface Vlan1 408 | ip address {{ vl1_ip_address }} {{ vl1_netmask }} 409 | no shut 410 | ! 411 | !{% for interface in range(1,49) %} 412 | interface GigabitEthernet1/0/{{interface}} 413 | description User Port (VLAN 1) 414 | switchport access vlan 1 415 | switchport mode access 416 | no shutdown 417 | !{% endfor %} 418 | ! 419 | ip domain-name test.com 420 | ! 421 | username admin privilege 15 secret password123 422 | ! 423 | aaa new-model 424 | ! 425 | ! 426 | aaa authentication login CONSOLE local 427 | aaa authorization console 428 | aaa authorization exec default local if-authenticated 429 | ! 430 | crypto key generate rsa modulus 2048 431 | ! 432 | ip ssh version 2 433 | ! 434 | line vty 0 15 435 | login authentication default 436 | transport input ssh 437 | line console 0 438 | login authentication CONSOLE 439 | end 440 | ^ 441 | # 442 | # 443 | # 444 | ####################################################### 445 | # 446 | # 447 | # 448 | ztp set keystore DEFAULT_VALUES vl1_ip_address dhcp 449 | ztp set keystore DEFAULT_VALUES hostname UNKNOWN_HOST 450 | # 451 | ztp set keystore SERIAL100 vl1_ip_address 10.0.0.201 452 | ztp set keystore SERIAL100 hostname SOMEDEVICE 453 | # 454 | ztp set keystore STACK1 vl1_netmask 255.255.255.0 455 | ztp set keystore STACK1 vl1_ip_address 10.0.0.200 456 | ztp set keystore STACK1 hostname CORESWITCH 457 | # 458 | # 459 | # 460 | ztp set idarray STACK1 SERIAL1 SERIAL2 SERIAL3 461 | # 462 | # 463 | # 464 | ztp set association id SERIAL100 template SHORT_TEMPLATE 465 | ztp set association id STACK1 template LONG_TEMPLATE 466 | # 467 | # 468 | # 469 | ztp set default-keystore DEFAULT_VALUES 470 | ztp set default-template LONG_TEMPLATE 471 | ztp set imagefile cat3k_caa-universalk9.SPA.03.06.06.E.152-2.E6.bin 472 | ztp set image-supression 3600 473 | ztp set delay-keystore 1000 474 | # 475 | # 476 | # 477 | ####################################################### 478 | ``` 479 | 480 | 481 | ----------------------------------------- 482 | ## DHCP FUNCTIONALITY ## 483 | FreeZTP installs a DHCP service during the install. This DHCP service is used to serve IP addresses to switches with the appropriate options included. 484 | 485 | FreeZTP commands can be used to fully configure the DHCP server. Scopes and options are created using the syntax `ztp set dhcpd SCOPENAME