├── LICENSE.txt ├── README.md ├── assets ├── Hyper-V VM Sync.ps1 ├── TRMM-Network-Scanner ├── TRMM-create-update.ps1 ├── UniFi AP Sync.ps1 ├── create.ps1 ├── delete.ps1 ├── read.ps1 └── update.ps1 ├── clients └── create.ps1 ├── contacts ├── create.ps1 ├── delete.ps1 ├── read.ps1 └── update.ps1 ├── credentials ├── create.ps1 ├── read.ps1 └── update.ps1 ├── documents ├── create.ps1 ├── read.ps1 └── update.ps1 ├── networks └── read.ps1 ├── payments └── read.ps1 └── tickets ├── create.ps1 └── read.ps1 /LICENSE.txt: -------------------------------------------------------------------------------- 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 -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell Examples 2 | 3 |
4 | 5 |

ITFlow

6 | 7 |

8 | IT documentation, ticketing and accounting system for small MSPs. 9 |
10 |
11 | View demo 12 |
13 | Username: demo@demo | Password: demo 14 |
15 |
16 | About 17 | · 18 | Docs 19 | · 20 | Forum 21 | · 22 | Report Bug 23 | · 24 | Request Feature 25 | · 26 | Security 27 |

28 |
29 | 30 | -- 31 | 32 | ## PowerShell API Examples 33 | 34 | This repo contains some PowerShell examples on how to interact with the ITFlow API. You should be able to convert the examples here into other languages fairly easily, but feel free to reach out on the Forum for help. 35 | 36 | Contributions are welcome, please raise a PR! 37 | -------------------------------------------------------------------------------- /assets/Hyper-V VM Sync.ps1: -------------------------------------------------------------------------------- 1 | # Hyper-V to ITFlow 2 | 3 | # Example script to sync data from Hyper-V into a single ITFlow client 4 | # This could be adapted to sync different VMs to multiple clients, but would need a way to define which VM is for what client 5 | 6 | 7 | ####################################################################################################### 8 | # Functions 9 | 10 | # Function to check if a string ($itfAssetID) contains only numbers 11 | function Is-Numeric ($Value) { 12 | return $Value -match "^[\d\.]+$" 13 | } 14 | ####################################################################################################### 15 | 16 | 17 | 18 | ####################################################################################################### 19 | # HYPER-V Settings 20 | 21 | # Host 22 | $hypHost = ' '; 23 | 24 | ####################################################################################################### 25 | 26 | 27 | 28 | ####################################################################################################### 29 | # ITFlow Settings 30 | # https://itflow.org/docs.php?doc=api 31 | 32 | # ITFlow Base URL 33 | $itfBaseURL = 'http://127.0.0.1/itflow' 34 | 35 | # ITFlow API Key 36 | $itfAPIKey = ' ' 37 | 38 | # ITFlow Client ID (for adding assets) 39 | $itfClientID = ' ' 40 | 41 | 42 | $itfReadURL = $itfBaseURL + "/api/v1/assets/read.php?api_key=" + $itfAPIKey 43 | $itfCreateURL = $itfBaseURL + "/api/v1/assets/create.php" 44 | $itfUpdateURL = $itfBaseURL + "/api/v1/assets/update.php" 45 | 46 | ###################################################################################################### 47 | 48 | # ITFlow credential check 49 | $iftLoginTest = Invoke-RestMethod -Method GET -Uri $itfReadURL -ErrorAction Stop 50 | if(!$?){ 51 | Write-Host "ITFLOW - Something went wrong connecting to $itfReadURL" 52 | Exit 53 | } 54 | Write-Host -ForegroundColor Green "ITFLOW - Successfully authenticated." 55 | 56 | 57 | Write-Host 58 | Write-Host "------" 59 | Write-Host 60 | 61 | # Get all Hyper-V VMs on this host 62 | $VMs = Get-VM -ComputerName $hypHost | Select -ExpandProperty Networkadapters | select VMName, MacAddress, IPAddresses 63 | 64 | if($VMs -eq $null){ 65 | Write-Host "No VMs found! Do you have rights to run Get-VM?" 66 | } 67 | 68 | foreach ($VM in $VMs) { 69 | 70 | $urlName = $itfReadURL + "&asset_name=" + $VM.VMName 71 | 72 | # Variables 73 | $itfAssetID = $false 74 | $name = $VM.VMName 75 | $mac = $VM.MacAddress 76 | $ip = $VM.IPAddresses[0] # Just the first (hopefully IPv4) 77 | 78 | # ITFlow - query via asset name 79 | $itfAssetName = Invoke-RestMethod -Method GET -Uri "$urlName" 80 | 81 | 82 | # Checks to determine the ITFlow asset ID 83 | 84 | if($itfAssetName.success -eq "True"){ 85 | $itfAssetID = $itfAssetName.data.asset_id 86 | } 87 | 88 | # Check if asset already exists (if ITFlow knows about the VM) 89 | 90 | if(Is-Numeric $itfAssetID){ 91 | # We found the asset - update details 92 | 93 | Write-Host -ForegroundColor Green "Found asset" $name "as ITFlow ID" $itfAssetID " - updating it.." 94 | 95 | # Asset attributes to be updated 96 | $itfAssetClientID = $itfAssetName.data.asset_client_id 97 | $body = @" 98 | { 99 | "api_key" : "$itfAPIKey", 100 | "asset_id" : "$itfAssetID", 101 | "asset_name" : "$name", 102 | "asset_type" : "Virtual Machine", 103 | "asset_model" : "$hypHost", 104 | "asset_ip" : "$ip", 105 | "asset_mac" : "$mac", 106 | "client_id" : "$itfAssetClientID" 107 | } 108 | "@ # This seemingly cannot be indented.. 109 | 110 | 111 | # Update asset 112 | Invoke-RestMethod -Method Post -Uri $itfUpdateURL -Body $body 113 | 114 | } 115 | 116 | else{ 117 | # Couldn't find asset, add it 118 | 119 | Write-Host -ForegroundColor Yellow "Could not find asset" $name "- adding it.." 120 | 121 | # New asset attributes 122 | $body = @" 123 | { 124 | "api_key" : "$itfAPIKey", 125 | "asset_name" : "$name", 126 | "asset_type" : "Virtual Machine", 127 | "asset_model" : "$hypHost", 128 | "asset_ip" : "$ip", 129 | "asset_mac" : "$mac", 130 | "asset_notes" : "Added via script", 131 | "client_id" : "$itfClientID" 132 | } 133 | "@ # This seemingly cannot be indented.. 134 | 135 | 136 | # Add asset 137 | Invoke-RestMethod -Method Post -Uri $itfCreateURL -Body $body 138 | 139 | } 140 | 141 | # Blank line for console output readability 142 | Write-Host 143 | } 144 | -------------------------------------------------------------------------------- /assets/TRMM-Network-Scanner: -------------------------------------------------------------------------------- 1 | <# 2 | .SYNOPSIS 3 | Create an asset in ITFlow for every MAC address found on the nertwork. 4 | 5 | .DESCRIPTION 6 | If an asset is in ITFlow with a matching MAC address, the IP address, location ID, and network ID will be updated. This script will download oui.txt in a resource subdirectory of the script root from ieee.org. This will determine the vendor of the asset by MAC address. The vendor could be the manufacturer of the nic, but that can be used in combination with other details to determine the details of assts found. Any devices found without a hostname will be given the name "generic" in ITFlow.The asset running the script will be ignored by ITFlow. 7 | 8 | This Network Scanner allows you to scan every IPv4-Range you want (172.16.1.47 to 172.16.2.5 would work). But the default is to scan an entire subnet based on an IPv4-Address within the subnet and the subnetmask/CIDR. The recommended script arguments can be changed according to the network. 9 | 10 | .REQUIREMENTS 11 | - ITFlow API key. 12 | - Global key in TacticalRMM named "ITFlow_API" with your ITFlow API key as the value. 13 | - Global key in TacticalRMM named "ITFlow_url" with your ITFlow URL as the value. 14 | - Client custom field in TacticalRMM named "ITFlow_client_ID". 15 | - Site custom field in TacticalRMM named "ITFlow_location_ID" 16 | - Site custom field in TacticalRMM named "ITFlow_network_ID" 17 | - Each client in TacticalRMM should have its ITFlow_client_ID populated with the client_id found in ITFlow. 18 | To find the ID, check the URL in ITFlow once you select a client. 19 | - Each client site in TacticalRMM should have ITFlow_location_ID and ITFlow_network_ID populated with the IDs. 20 | To find the IDs run this script on one PC. Assign the PC to a location and network in ITFlow. Run this script again and take note of the location and network IDs. 21 | 22 | .NOTES 23 | - Every line of code used in this script that scans the network is from https://github.com/BornToBeRoot/PowerShell_IPv4NetworkScanner. A big thank you to those involved in that project for the great work. 24 | - Uses MAC addresses found on network to check if assets exists in ITFlow. 25 | - Make sure to add the below script arguments to the script arguments section in TacticalRMM. 26 | - This script can be adapted to any RMM. TacticalRMM is only used to store and supply the ITFlow URL, ITFlow API key, client IDs, location IDs, network IDs, and IP of machine running the script. 27 | 28 | .SCRIPT_ARGUMENTS 29 | -CIDR 24 30 | -EnableMACResolving 31 | -IPv4Address {{agent.local_ips}} 32 | -ITFlow_API {{global.ITFlow_API}} 33 | -ITFlow_url {{global.ITFlow_url}} 34 | -ITFlow_client_ID {{client.ITFlow_client_ID}} 35 | -ITFlow_location_ID {{site.ITFlow_location_ID}} 36 | -ITFlow_network_ID {{site.ITFlow_network_ID}} 37 | 38 | .VERSION 39 | - v1.0 Initial Release 40 | 41 | #> 42 | 43 | 44 | [CmdletBinding(DefaultParameterSetName = 'CIDR')] 45 | Param( 46 | [string] $ITFlow_API, 47 | [string] $ITFlow_url, 48 | [string] $ITFlow_client_ID, 49 | [string] $ITFlow_location_ID, 50 | [string] $ITFlow_network_ID, 51 | [Parameter( 52 | ParameterSetName = 'Range', 53 | Position = 0, 54 | Mandatory = $true, 55 | HelpMessage = 'Start IPv4-Address like 192.168.1.10')] 56 | [IPAddress]$StartIPv4Address, 57 | 58 | [Parameter( 59 | ParameterSetName = 'Range', 60 | Position = 1, 61 | Mandatory = $true, 62 | HelpMessage = 'End IPv4-Address like 192.168.1.100')] 63 | [IPAddress]$EndIPv4Address, 64 | 65 | [Parameter( 66 | ParameterSetName = 'CIDR', 67 | Position = 0, 68 | Mandatory = $true, 69 | HelpMessage = 'IPv4-Address which is in the subnet')] 70 | [Parameter( 71 | ParameterSetName = 'Mask', 72 | Position = 0, 73 | Mandatory = $true, 74 | HelpMessage = 'IPv4-Address which is in the subnet')] 75 | [IPAddress]$IPv4Address, 76 | 77 | [Parameter( 78 | ParameterSetName = 'CIDR', 79 | Position = 1, 80 | Mandatory = $true, 81 | HelpMessage = 'CIDR like /24 without "/"')] 82 | [ValidateRange(0, 31)] 83 | [Int32]$CIDR, 84 | 85 | [Parameter( 86 | ParameterSetName = 'Mask', 87 | Position = 1, 88 | Mandatory = $true, 89 | Helpmessage = 'Subnetmask like 255.255.255.0')] 90 | [ValidateScript({ 91 | if ($_ -match "^(254|252|248|240|224|192|128).0.0.0$|^255.(254|252|248|240|224|192|128|0).0.0$|^255.255.(254|252|248|240|224|192|128|0).0$|^255.255.255.(254|252|248|240|224|192|128|0)$") { 92 | return $true 93 | } 94 | else { 95 | throw "Enter a valid subnetmask (like 255.255.255.0)!" 96 | } 97 | })] 98 | [String]$Mask, 99 | 100 | [Parameter( 101 | Position = 2, 102 | HelpMessage = 'Maxmium number of ICMP checks for each IPv4-Address (Default=2)')] 103 | [Int32]$Tries = 2, 104 | 105 | [Parameter( 106 | Position = 3, 107 | HelpMessage = 'Maximum number of threads at the same time (Default=256)')] 108 | [Int32]$Threads = 256, 109 | 110 | [Parameter( 111 | Position = 4, 112 | HelpMessage = 'Resolve DNS for each IP (Default=Enabled)')] 113 | [Switch]$DisableDNSResolving, 114 | 115 | [Parameter( 116 | Position = 5, 117 | HelpMessage = 'Resolve MAC-Address for each IP (Default=Disabled)')] 118 | [Switch]$EnableMACResolving, 119 | 120 | [Parameter( 121 | Position = 6, 122 | HelpMessage = 'Get extendend informations like BufferSize, ResponseTime and TTL (Default=Disabled)')] 123 | [Switch]$ExtendedInformations, 124 | 125 | [Parameter( 126 | Position = 7, 127 | HelpMessage = 'Include inactive devices in result')] 128 | [Switch]$IncludeInactive 129 | ) 130 | 131 | Begin { 132 | Write-Host "Script started at $(Get-Date)" 133 | 134 | $OUIListPath = "$PSScriptRoot\Resources\oui.txt" 135 | 136 | function Convert-Subnetmask { 137 | [CmdLetBinding(DefaultParameterSetName = 'CIDR')] 138 | param( 139 | [Parameter( 140 | ParameterSetName = 'CIDR', 141 | Position = 0, 142 | Mandatory = $true, 143 | HelpMessage = 'CIDR like /24 without "/"')] 144 | [ValidateRange(0, 32)] 145 | [Int32]$CIDR, 146 | 147 | [Parameter( 148 | ParameterSetName = 'Mask', 149 | Position = 0, 150 | Mandatory = $true, 151 | HelpMessage = 'Subnetmask like 255.255.255.0')] 152 | [ValidateScript({ 153 | if ($_ -match "^(254|252|248|240|224|192|128).0.0.0$|^255.(254|252|248|240|224|192|128|0).0.0$|^255.255.(254|252|248|240|224|192|128|0).0$|^255.255.255.(255|254|252|248|240|224|192|128|0)$") { 154 | return $true 155 | } 156 | else { 157 | throw "Enter a valid subnetmask (like 255.255.255.0)!" 158 | } 159 | })] 160 | [String]$Mask 161 | ) 162 | 163 | Begin { 164 | 165 | } 166 | 167 | Process { 168 | switch ($PSCmdlet.ParameterSetName) { 169 | "CIDR" { 170 | # Make a string of bits (24 to 11111111111111111111111100000000) 171 | $CIDR_Bits = ('1' * $CIDR).PadRight(32, "0") 172 | 173 | # Split into groups of 8 bits, convert to Ints, join up into a string 174 | $Octets = $CIDR_Bits -split '(.{8})' -ne '' 175 | $Mask = ($Octets | ForEach-Object -Process { [Convert]::ToInt32($_, 2) }) -join '.' 176 | } 177 | 178 | "Mask" { 179 | # Convert the numbers into 8 bit blocks, join them all together, count the 1 180 | $Octets = $Mask.ToString().Split(".") | ForEach-Object -Process { [Convert]::ToString($_, 2) } 181 | $CIDR_Bits = ($Octets -join "").TrimEnd("0") 182 | 183 | # Count the "1" (111111111111111111111111 --> /24) 184 | $CIDR = $CIDR_Bits.Length 185 | } 186 | } 187 | 188 | [pscustomobject] @{ 189 | Mask = $Mask 190 | CIDR = $CIDR 191 | } 192 | } 193 | 194 | End { 195 | 196 | } 197 | } 198 | 199 | # Helper function to convert an IPv4-Address to Int64 and vise versa 200 | function Convert-IPv4Address { 201 | [CmdletBinding(DefaultParameterSetName = 'IPv4Address')] 202 | param( 203 | [Parameter( 204 | ParameterSetName = 'IPv4Address', 205 | Position = 0, 206 | Mandatory = $true, 207 | HelpMessage = 'IPv4-Address as string like "192.168.1.1"')] 208 | [IPaddress]$IPv4Address, 209 | 210 | [Parameter( 211 | ParameterSetName = 'Int64', 212 | Position = 0, 213 | Mandatory = $true, 214 | HelpMessage = 'IPv4-Address as Int64 like 2886755428')] 215 | [long]$Int64 216 | ) 217 | 218 | Begin { 219 | 220 | } 221 | 222 | Process { 223 | switch ($PSCmdlet.ParameterSetName) { 224 | # Convert IPv4-Address as string into Int64 225 | "IPv4Address" { 226 | $Octets = $IPv4Address.ToString().Split(".") 227 | $Int64 = [long]([long]$Octets[0] * 16777216 + [long]$Octets[1] * 65536 + [long]$Octets[2] * 256 + [long]$Octets[3]) 228 | } 229 | 230 | # Convert IPv4-Address as Int64 into string 231 | "Int64" { 232 | $IPv4Address = (([System.Math]::Truncate($Int64 / 16777216)).ToString() + "." + ([System.Math]::Truncate(($Int64 % 16777216) / 65536)).ToString() + "." + ([System.Math]::Truncate(($Int64 % 65536) / 256)).ToString() + "." + ([System.Math]::Truncate($Int64 % 256)).ToString()) 233 | } 234 | } 235 | 236 | [pscustomobject] @{ 237 | IPv4Address = $IPv4Address 238 | Int64 = $Int64 239 | } 240 | } 241 | 242 | End { 243 | 244 | } 245 | } 246 | 247 | # Helper function to create a new Subnet 248 | function Get-IPv4Subnet { 249 | [CmdletBinding(DefaultParameterSetName = 'CIDR')] 250 | param( 251 | [Parameter( 252 | Position = 0, 253 | Mandatory = $true, 254 | HelpMessage = 'IPv4-Address which is in the subnet')] 255 | [IPAddress]$IPv4Address, 256 | 257 | [Parameter( 258 | ParameterSetName = 'CIDR', 259 | Position = 1, 260 | Mandatory = $true, 261 | HelpMessage = 'CIDR like /24 without "/"')] 262 | [ValidateRange(0, 31)] 263 | [Int32]$CIDR, 264 | 265 | [Parameter( 266 | ParameterSetName = 'Mask', 267 | Position = 1, 268 | Mandatory = $true, 269 | Helpmessage = 'Subnetmask like 255.255.255.0')] 270 | [ValidateScript({ 271 | if ($_ -match "^(254|252|248|240|224|192|128).0.0.0$|^255.(254|252|248|240|224|192|128|0).0.0$|^255.255.(254|252|248|240|224|192|128|0).0$|^255.255.255.(254|252|248|240|224|192|128|0)$") { 272 | return $true 273 | } 274 | else { 275 | throw "Enter a valid subnetmask (like 255.255.255.0)!" 276 | } 277 | })] 278 | [String]$Mask 279 | ) 280 | 281 | Begin { 282 | 283 | } 284 | 285 | Process { 286 | # Convert Mask or CIDR - because we need both in the code below 287 | switch ($PSCmdlet.ParameterSetName) { 288 | "CIDR" { 289 | $Mask = (Convert-Subnetmask -CIDR $CIDR).Mask 290 | } 291 | "Mask" { 292 | $CIDR = (Convert-Subnetmask -Mask $Mask).CIDR 293 | } 294 | } 295 | 296 | # Get CIDR Address by parsing it into an IP-Address 297 | $CIDRAddress = [System.Net.IPAddress]::Parse([System.Convert]::ToUInt64(("1" * $CIDR).PadRight(32, "0"), 2)) 298 | 299 | # Binary AND ... this is how subnets work. 300 | $NetworkID_bAND = $IPv4Address.Address -band $CIDRAddress.Address 301 | 302 | # Return an array of bytes. Then join them. 303 | $NetworkID = [System.Net.IPAddress]::Parse([System.BitConverter]::GetBytes([UInt32]$NetworkID_bAND) -join (".")) 304 | 305 | # Get HostBits based on SubnetBits (CIDR) // Hostbits (32 - /24 = 8 -> 00000000000000000000000011111111) 306 | $HostBits = ('1' * (32 - $CIDR)).PadLeft(32, "0") 307 | 308 | # Convert Bits to Int64 309 | $AvailableIPs = [Convert]::ToInt64($HostBits, 2) 310 | 311 | # Convert Network Address to Int64 312 | $NetworkID_Int64 = (Convert-IPv4Address -IPv4Address $NetworkID.ToString()).Int64 313 | 314 | # Convert add available IPs and parse into IPAddress 315 | $Broadcast = [System.Net.IPAddress]::Parse((Convert-IPv4Address -Int64 ($NetworkID_Int64 + $AvailableIPs)).IPv4Address) 316 | 317 | # Change useroutput ==> (/27 = 0..31 IPs -> AvailableIPs 32) 318 | $AvailableIPs += 1 319 | 320 | # Hosts = AvailableIPs - Network Address + Broadcast Address 321 | $Hosts = ($AvailableIPs - 2) 322 | 323 | # Build custom PSObject 324 | [pscustomobject] @{ 325 | NetworkID = $NetworkID 326 | Broadcast = $Broadcast 327 | IPs = $AvailableIPs 328 | Hosts = $Hosts 329 | } 330 | } 331 | 332 | End { 333 | 334 | } 335 | } 336 | } 337 | 338 | Process { 339 | # Calculate Subnet (Start and End IPv4-Address) 340 | if ($PSCmdlet.ParameterSetName -eq 'CIDR' -or $PSCmdlet.ParameterSetName -eq 'Mask') { 341 | # Convert Subnetmask 342 | if ($PSCmdlet.ParameterSetName -eq 'Mask') { 343 | $CIDR = (Convert-Subnetmask -Mask $Mask).CIDR 344 | } 345 | 346 | # Create new subnet 347 | $Subnet = Get-IPv4Subnet -IPv4Address $IPv4Address -CIDR $CIDR 348 | 349 | # Assign Start and End IPv4-Address 350 | $StartIPv4Address = $Subnet.NetworkID 351 | $EndIPv4Address = $Subnet.Broadcast 352 | } 353 | 354 | # Convert Start and End IPv4-Address to Int64 355 | $StartIPv4Address_Int64 = (Convert-IPv4Address -IPv4Address $StartIPv4Address.ToString()).Int64 356 | $EndIPv4Address_Int64 = (Convert-IPv4Address -IPv4Address $EndIPv4Address.ToString()).Int64 357 | 358 | # Check if range is valid 359 | if ($StartIPv4Address_Int64 -gt $EndIPv4Address_Int64) { 360 | Write-Error -Message "Invalid IP-Range... Check your input!" -Category InvalidArgument -ErrorAction Stop 361 | } 362 | 363 | # Calculate IPs to scan (range) 364 | $IPsToScan = ($EndIPv4Address_Int64 - $StartIPv4Address_Int64) 365 | 366 | Write-Host "Scanning range from $StartIPv4Address to $EndIPv4Address ($($IPsToScan + 1) IPs)" 367 | Write-Host "Running with max $Threads threads" 368 | Write-Host "ICMP checks per IP: $Tries" 369 | 370 | # Properties which are displayed in the output 371 | $PropertiesToDisplay = @() 372 | $PropertiesToDisplay += "IPv4Address", "Status" 373 | 374 | if ($DisableDNSResolving -eq $false) { 375 | $PropertiesToDisplay += "Hostname" 376 | } 377 | 378 | if ($EnableMACResolving) { 379 | $PropertiesToDisplay += "MAC" 380 | } 381 | 382 | # Create resource folder at script root if doesn't exist 383 | New-Item -ItemType Directory -Force -Path $PSScriptRoot\Resources 384 | Write-Host "Creating directory if necessary..." 385 | 386 | $OUIFile = "$PSScriptRoot\Resources\oui.txt" 387 | 388 | # Get oui data to find vendor name by MAC address only file doesn't exist or is 30+ days old 389 | if (!(Test-Path $OUIFile -PathType Leaf) -Or (Test-Path $OUIFile -OlderThan (Get-Date).AddDays(-30))) 390 | { 391 | $LatestOUIs = (Invoke-WebRequest -UseBasicParsing -Uri "https://standards-oui.ieee.org/oui/oui.txt").Content 392 | 393 | $Output = "" 394 | 395 | foreach($Line in $LatestOUIs -split '[\r\n]') 396 | { 397 | if($Line -match "^[A-F0-9]{6}") 398 | { 399 | # Line looks like: 2405F5 (base 16) Integrated Device Technology (Malaysia) Sdn. Bhd. 400 | $Output += ($Line -replace '\s+', ' ').Replace(' (base 16) ', '|').Trim() + "`n" 401 | } 402 | } 403 | 404 | Out-File -InputObject $Output -FilePath "$OUIFile" 405 | Write-Host "Downloading oui.txt..." 406 | } 407 | 408 | # Check if it is possible to assign vendor to MAC --> import CSV-File 409 | if ($EnableMACResolving) { 410 | if (Test-Path -Path $OUIListPath -PathType Leaf) { 411 | $OUIHashTable = @{ } 412 | 413 | Write-Host "Read oui.txt and fill hash table..." 414 | 415 | foreach ($Line in Get-Content -Path $OUIListPath) { 416 | if (-not([String]::IsNullOrEmpty($Line))) { 417 | try { 418 | $HashTableData = $Line.Split('|') 419 | $OUIHashTable.Add($HashTableData[0], $HashTableData[1]) 420 | } 421 | catch [System.ArgumentException] { } # Catch if mac is already added to hash table 422 | } 423 | } 424 | 425 | $AssignVendorToMAC = $true 426 | 427 | $PropertiesToDisplay += "Vendor" 428 | } 429 | else { 430 | $AssignVendorToMAC = $false 431 | 432 | Write-Warning -Message "No OUI-File to assign vendor with MAC-Address found! Execute the script ""Create-OUIListFromWeb.ps1"" to download the latest version. This warning does not affect the scanning procedure." 433 | } 434 | } 435 | 436 | if ($ExtendedInformations) { 437 | $PropertiesToDisplay += "BufferSize", "ResponseTime", "TTL" 438 | } 439 | 440 | # Scriptblock --> will run in runspaces (threads)... 441 | [System.Management.Automation.ScriptBlock]$ScriptBlock = { 442 | Param( 443 | $IPv4Address, 444 | $Tries, 445 | $DisableDNSResolving, 446 | $EnableMACResolving, 447 | $ExtendedInformations, 448 | $IncludeInactive 449 | ) 450 | 451 | # +++ Send ICMP requests +++ 452 | $Status = [String]::Empty 453 | 454 | for ($i = 0; $i -lt $Tries; i++) { 455 | try { 456 | $PingObj = New-Object System.Net.NetworkInformation.Ping 457 | 458 | $Timeout = 1000 459 | $Buffer = New-Object Byte[] 32 460 | 461 | $PingResult = $PingObj.Send($IPv4Address, $Timeout, $Buffer) 462 | 463 | if ($PingResult.Status -eq "Success") { 464 | $Status = "Up" 465 | break # Exit loop, if host is reachable 466 | } 467 | else { 468 | $Status = "Down" 469 | } 470 | } 471 | catch { 472 | $Status = "Down" 473 | break # Exit loop, if there is an error 474 | } 475 | } 476 | 477 | # +++ Resolve DNS +++ 478 | $Hostname = "generic" 479 | 480 | if ((-not($DisableDNSResolving)) -and ($Status -eq "Up" -or $IncludeInactive)) { 481 | try { 482 | $Hostname = ([System.Net.Dns]::GetHostEntry($IPv4Address).HostName) 483 | } 484 | catch { } # No DNS 485 | } 486 | 487 | # +++ Get MAC-Address +++ 488 | $MAC = [String]::Empty 489 | 490 | if (($EnableMACResolving) -and (($Status -eq "Up") -or ($IncludeInactive))) { 491 | $Arp_Result = (arp -a).ToUpper().Trim() 492 | 493 | foreach ($Line in $Arp_Result) { 494 | if ($Line.Split(" ")[0] -eq $IPv4Address) { 495 | $MAC = [Regex]::Matches($Line, "([0-9A-F][0-9A-F]-){5}([0-9A-F][0-9A-F])").Value 496 | } 497 | } 498 | } 499 | 500 | # +++ Get extended informations +++ 501 | $BufferSize = [String]::Empty 502 | $ResponseTime = [String]::Empty 503 | $TTL = $null 504 | 505 | if ($ExtendedInformations -and ($Status -eq "Up")) { 506 | try { 507 | $BufferSize = $PingResult.Buffer.Length 508 | $ResponseTime = $PingResult.RoundtripTime 509 | $TTL = $PingResult.Options.Ttl 510 | } 511 | catch { } # Failed to get extended informations 512 | } 513 | 514 | # +++ Result +++ 515 | if (($Status -eq "Up") -or ($IncludeInactive)) { 516 | [pscustomobject] @{ 517 | IPv4Address = $IPv4Address 518 | Status = $Status 519 | Hostname = $Hostname 520 | MAC = $MAC 521 | BufferSize = $BufferSize 522 | ResponseTime = $ResponseTime 523 | TTL = $TTL 524 | } 525 | } 526 | else { 527 | $null 528 | } 529 | } 530 | 531 | Write-Host "Setting up RunspacePool..." 532 | 533 | # Create RunspacePool and Jobs 534 | $RunspacePool = [System.Management.Automation.Runspaces.RunspaceFactory]::CreateRunspacePool(1, $Threads, $Host) 535 | $RunspacePool.Open() 536 | [System.Collections.ArrayList]$Jobs = @() 537 | 538 | Write-Host "Setting up jobs..." 539 | 540 | # Set up jobs for each IP... 541 | for ($i = $StartIPv4Address_Int64; $i -le $EndIPv4Address_Int64; $i++) { 542 | # Convert IP back from Int64 543 | $IPv4Address = (Convert-IPv4Address -Int64 $i).IPv4Address 544 | 545 | # Create hashtable to pass parameters 546 | $ScriptParams = @{ 547 | IPv4Address = $IPv4Address 548 | Tries = $Tries 549 | DisableDNSResolving = $DisableDNSResolving 550 | EnableMACResolving = $EnableMACResolving 551 | ExtendedInformations = $ExtendedInformations 552 | IncludeInactive = $IncludeInactive 553 | } 554 | 555 | # Catch when trying to divide through zero 556 | try { 557 | $Progress_Percent = (($i - $StartIPv4Address_Int64) / $IPsToScan) * 100 558 | } 559 | catch { 560 | $Progress_Percent = 100 561 | } 562 | 563 | Write-Progress -Activity "Setting up jobs..." -Id 1 -Status "Current IP-Address: $IPv4Address" -PercentComplete $Progress_Percent 564 | 565 | # Create new job 566 | $Job = [System.Management.Automation.PowerShell]::Create().AddScript($ScriptBlock).AddParameters($ScriptParams) 567 | $Job.RunspacePool = $RunspacePool 568 | 569 | $JobObj = [pscustomobject] @{ 570 | RunNum = $i - $StartIPv4Address_Int64 571 | Pipe = $Job 572 | Result = $Job.BeginInvoke() 573 | } 574 | 575 | # Add job to collection 576 | [void]$Jobs.Add($JobObj) 577 | } 578 | 579 | Write-Host "Waiting for jobs to complete & starting to process results..." 580 | 581 | # Total jobs to calculate percent complete, because jobs are removed after they are processed 582 | $Jobs_Total = $Jobs.Count 583 | 584 | # Process results, while waiting for other jobs 585 | Do { 586 | # Get all jobs, which are completed 587 | $Jobs_ToProcess = $Jobs | Where-Object -FilterScript { $_.Result.IsCompleted } 588 | 589 | # If no jobs finished yet, wait 500 ms and try again 590 | if ($null -eq $Jobs_ToProcess) { 591 | Write-Host "No jobs completed, wait 250ms..." 592 | 593 | Start-Sleep -Milliseconds 250 594 | continue 595 | } 596 | 597 | # Get jobs, which are not complete yet 598 | $Jobs_Remaining = ($Jobs | Where-Object -FilterScript { $_.Result.IsCompleted -eq $false }).Count 599 | 600 | # Catch when trying to divide through zero 601 | try { 602 | $Progress_Percent = 100 - (($Jobs_Remaining / $Jobs_Total) * 100) 603 | } 604 | catch { 605 | $Progress_Percent = 100 606 | } 607 | 608 | Write-Host "Waiting for jobs to complete... ($($Threads - $($RunspacePool.GetAvailableRunspaces())) of $Threads threads running)" -Id 1 -PercentComplete $Progress_Percent -Status "$Jobs_Remaining remaining..." 609 | 610 | Write-Host "Processing $(if($null -eq $Jobs_ToProcess.Count){"1"}else{$Jobs_ToProcess.Count}) job(s)..." 611 | 612 | # Processing completed jobs 613 | foreach ($Job in $Jobs_ToProcess) { 614 | # Get the result... 615 | $Job_Result = $Job.Pipe.EndInvoke($Job.Result) 616 | $Job.Pipe.Dispose() 617 | 618 | # Remove job from collection 619 | $Jobs.Remove($Job) 620 | 621 | # Check if result contains status 622 | if ($Job_Result.Status) { 623 | if ($AssignVendorToMAC) { 624 | $Vendor = [String]::Empty 625 | 626 | # Check if MAC is null or empty 627 | if (-not([String]::IsNullOrEmpty($Job_Result.MAC))) { 628 | # Split it, so we can search the vendor (XX-XX-XX-XX-XX-XX to XXXXXX) 629 | $MAC_VendorSearch = $Job_Result.MAC.Replace("-", "").Substring(0, 6) 630 | 631 | $Vendor = $OUIHashTable.Get_Item($MAC_VendorSearch) 632 | } 633 | 634 | $asset_ip = $Job_Result.IPv4Address 635 | $asset_mac = $Job_Result.MAC.Replace("-", ":") 636 | $asset_name = $Job_Result.Hostname 637 | $local_ip = (Get-WmiObject -Class Win32_NetworkAdapterConfiguration | where {$_.DHCPEnabled -ne $null -and $_.DefaultIPGateway -ne $null}).IPAddress | Select-Object -First 1 638 | 639 | # Read Module 640 | $read_module = "/api/v1/assets/read.php" 641 | 642 | # Search all clients in ITFlow by MAC address to see if this asset already exists 643 | $uri_read = $ITFlow_url + $read_module + "?api_key=" + $ITFlow_API + "&asset_mac=" + $asset_mac 644 | 645 | # Force TLS 1.2 for this script 646 | [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 647 | 648 | # Check if asset exists in ITFlow database 649 | $exists = Invoke-RestMethod -Method GET -Uri $uri_read 650 | $asset_id = $exists.data.asset_id 651 | $asset_location_id = $ITFlow_location_ID 652 | $asset_network_id = $ITFlow_network_ID 653 | 654 | # Data 655 | $create_body = @" 656 | { 657 | "api_key" : "$ITFlow_API", 658 | "asset_name" : "$asset_name", 659 | "asset_make" : "$Vendor", 660 | "asset_ip" : "$asset_ip", 661 | "asset_mac" : "$asset_mac", 662 | "asset_status" : "Deployed", 663 | "client_id" : "$ITFlow_client_ID", 664 | "asset_location_id" : "$asset_location_id", 665 | "asset_network_id" : "$asset_network_id", 666 | "asset_type" : "Other" 667 | } 668 | "@ 669 | 670 | # Data 671 | $update_body = @" 672 | { 673 | "api_key" : "$ITFlow_API", 674 | "asset_ip" : "$asset_ip", 675 | "client_id" : "$ITFlow_client_ID", 676 | "asset_location_id" : "$asset_location_id", 677 | "asset_network_id" : "$asset_network_id", 678 | "asset_id" : "$asset_id" 679 | } 680 | "@ 681 | 682 | # If the asset exists update it, if not create it unless it's this PC. 683 | if ( ( $exists.success -eq "False" ) -And ( $Job_Result.IPv4Address -ne $local_ip ) ) { 684 | $module = "/api/v1/assets/create.php" 685 | $ITFlowResult = "Asset does not exist - Creating... " 686 | $uri_write = $ITFlow_url + $module 687 | $write = Invoke-RestMethod -Method Post -Uri $uri_write -Body $create_body 688 | } 689 | 690 | if ( ( $exists.success -eq "False" ) -And ( $Job_Result.IPv4Address -eq $local_ip ) ) { 691 | $module = "/api/v1/assets/create.php" 692 | $ITFlowResult = "Ignoring PC running the script. " 693 | } 694 | 695 | if ( $exists.success -eq "True" ) { 696 | $module = "/api/v1/assets/update.php" 697 | $ITFlowResult = "Asset already exists - Updating... " 698 | $uri_write = $ITFlow_url + $module 699 | $write = Invoke-RestMethod -Method Post -Uri $uri_write -Body $update_body 700 | } 701 | 702 | if ($exists.success -eq "True" -And $write.success -eq "True") { 703 | $ITFlowResult += " Asset updated." 704 | } 705 | 706 | if ($exists.success -eq "True" -And $write.success -eq "False") { 707 | $ITFlowResult += " No changes to update." 708 | } 709 | 710 | if ($exists.success -eq "False" -And $write.success -eq "True") { 711 | $ITFlowResult += " Asset created." 712 | } 713 | 714 | if ($exists.success -eq "False" -And $write.success -eq "False") { 715 | $ITFlowResult += " Failed to create asset." 716 | } 717 | 718 | [pscustomobject] @{ 719 | IPv4Address = $Job_Result.IPv4Address 720 | Status = $ITFlowResult 721 | Hostname = $Job_Result.Hostname 722 | MAC = $Job_Result.MAC 723 | Vendor = $Vendor 724 | BufferSize = $Job_Result.BufferSize 725 | ResponseTime = $Job_Result.ResponseTime 726 | TTL = $ResuJob_Resultlt.TTL 727 | } | Select-Object -Property $PropertiesToDisplay 728 | 729 | } 730 | else { 731 | $Job_Result | Select-Object -Property $PropertiesToDisplay 732 | } 733 | } 734 | } 735 | 736 | } While ($Jobs.Count -gt 0) 737 | 738 | Write-Host "Closing RunspacePool and free resources..." 739 | 740 | # Close the RunspacePool and free resources 741 | $RunspacePool.Close() 742 | $RunspacePool.Dispose() 743 | 744 | Write-Host "Script finished at $(Get-Date)" 745 | } 746 | 747 | End { 748 | 749 | } 750 | -------------------------------------------------------------------------------- /assets/TRMM-create-update.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .SYNOPSIS 3 | Create or update asset from Tactical RMM to ITFlow. Uses MAC address to check if asset exists in ITFlow. 4 | 5 | .REQUIREMENTS 6 | - ITFlow API key. 7 | - Global key in TacticalRMM named "ITFlow_API" with your ITFlow API key as the value. 8 | - Global key in TacticalRMM named "ITFlow_url" with your ITFlow URL as the value. 9 | - Client custom field in TacticalRMM named "ITFlow_client_ID". 10 | - Site custom field in TacticalRMM named "ITFlow_location_ID" 11 | - Site custom field in TacticalRMM named "ITFlow_network_ID" 12 | - Each client in TacticalRMM should have its ITFlow_client_ID populated with the client_id found in ITFlow. 13 | To find the ID, check the URL in ITFlow once you select a client. 14 | - Each client site in TacticalRMM should have ITFlow_location_ID and ITFlow_network_ID populated with the IDs. 15 | To find the IDs run this script on one PC. Assign the PC to a location and network in ITFlow. Run this script again and take note of the location and network IDs. 16 | 17 | .NOTES 18 | - Uses PC MAC address to check if asset exists in ITFlow. 19 | - Make sure to add the below script arguments to the script arguments section in TacticalRMM. 20 | - This script can be adapted to any RMM. TacticalRMM is only used to store the ITFlow URL, ITFlow API key, and client IDs. 21 | 22 | .SCRIPT_ARGUMENTS 23 | -ITFlow_API {{global.ITFlow_API}} 24 | -ITFlow_url {{global.ITFlow_url}} 25 | -ITFlow_client_ID {{client.ITFlow_client_ID}} 26 | -ITFlow_location_ID {{site.ITFlow_location_ID}} 27 | -ITFlow_network_ID {{site.ITFlow_network_ID}} 28 | 29 | .VERSION 30 | - v1.3 - 2024-06-12 - JQ - Fixed asset_make spelling, Remove Inc. from Make string, remove Microsoft from OS String, Capitalize First letter of each word in Make String, except for HP capitize both letters. 31 | - v1.2 Changed search from serial to MAC address, added location ID and network ID 32 | - v1.1 Added verbosity, forced TLS 1.2, added exit if API read failure 33 | - v1.0 Initial Release 34 | 35 | #> 36 | 37 | param( 38 | [string] $ITFlow_API, 39 | [string] $ITFlow_url, 40 | [string] $ITFlow_client_ID, 41 | [string] $ITFlow_location_ID, 42 | [string] $ITFlow_network_ID 43 | ) 44 | 45 | # Function to capitalize the first letter of each word and handle specific cases 46 | function Capitalize-FirstLetter { 47 | param ( 48 | [string]$inputString 49 | ) 50 | if ($inputString -eq "hp") { 51 | return "HP" 52 | } elseif ($inputString -eq "ibm") { 53 | return "IBM" 54 | } else { 55 | return ($inputString -split ' ' | ForEach-Object { 56 | if ($_.Length -gt 1) { 57 | $_.Substring(0,1).ToUpper() + $_.Substring(1).ToLower() 58 | } else { 59 | $_.ToUpper() 60 | } 61 | }) -join ' ' 62 | } 63 | } 64 | 65 | # Get PC info 66 | $asset_name = $Env:ComputerName 67 | $asset_make = (Get-WmiObject -Class Win32_ComputerSystem).Manufacturer 68 | $asset_make = $asset_make -replace 'Inc\.', '' -replace 'inc\.', '' -replace 'Inc', '' -replace 'inc', '' 69 | $asset_make = Capitalize-FirstLetter -inputString $asset_make 70 | $asset_model = (Get-WmiObject -Class:Win32_ComputerSystem).Model 71 | $asset_serial = (Get-WmiObject -Class:Win32_BIOS).SerialNumber 72 | $asset_os = (Get-WmiObject Win32_OperatingSystem).Caption -replace 'Microsoft', '' 73 | $asset_mac = (Get-WmiObject -Class Win32_NetworkAdapterConfiguration | where {$_.DHCPEnabled -ne $null -and $_.DefaultIPGateway -ne $null}).macaddress | Select-Object -First 1 74 | $install = ([DateTime](Get-Item -Force 'C:\System Volume Information\').CreationTime).ToString('yyyy/MM/dd') 75 | $local_ip = (Get-WmiObject -Class Win32_NetworkAdapterConfiguration | where {$_.DHCPEnabled -ne $null -and $_.DefaultIPGateway -ne $null}).IPAddress | Select-Object -First 1 76 | 77 | # Check if laptop 78 | function Test-IsLaptop { 79 | $HardwareType = (Get-CimInstance -Class Win32_ComputerSystem -Property PCSystemType).PCSystemType 80 | # https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-computersystem 81 | # Mobile = 2 82 | $HardwareType -eq 2 83 | } 84 | 85 | # Check if server OS 86 | function Test-IsServer { 87 | $osInfo = (Get-CimInstance -Class:Win32_OperatingSystem).ProductType 88 | $osInfo -ne 1 89 | } 90 | 91 | # If asset is server os, type is server. Otherwise, if chasis is mobile, type is laptop. Otherwise, type is desktop. 92 | if (Test-IsServer) { 93 | $asset_type = "Server" 94 | } else { 95 | if (Test-IsLaptop) { 96 | $asset_type = "Laptop" 97 | } else { 98 | $asset_type = "Desktop" 99 | } 100 | } 101 | 102 | # Read Module 103 | $read_module = "/api/v1/assets/read.php" 104 | 105 | # Search all clients in ITFlow by serial to see if this asset already exists 106 | $uri_read = $ITFlow_url + $read_module + "?api_key=" + $ITFlow_API + "&asset_mac=" + $asset_mac 107 | 108 | # Force TLS 1.2 for this script 109 | [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 110 | 111 | # Check if PC exists in ITFlow database 112 | $exists = Invoke-RestMethod -Method GET -Uri $uri_read 113 | 114 | $asset_id = $exists.data.asset_id 115 | $asset_location_id = $ITFlow_location_ID 116 | $asset_network_id = $ITFlow_network_ID 117 | 118 | # If the asset exists update it, if not create it. 119 | if ($exists.success -eq "False") { 120 | $module = "/api/v1/assets/create.php" 121 | Write-Host "Asset does not exist - Creating..." 122 | } else { 123 | if ($exists.success -eq "True") { 124 | $module = "/api/v1/assets/update.php" 125 | Write-Host "ITFlow IDs - Location ID: " $exists.data.asset_location_id "Network ID: " $exists.data.asset_network_id 126 | 127 | if ( $ITFlow_location_ID -eq "0" ) { 128 | $asset_location_id = $exists.data.asset_location_id 129 | } 130 | 131 | if ( $ITFlow_network_ID -eq "0" ) { 132 | $asset_network_id = $exists.data.asset_network_id 133 | } 134 | 135 | Write-Host "Asset already exists - Updating..." 136 | } else { 137 | Write-Host "API connection error. Aborting..." 138 | Exit 139 | } 140 | } 141 | 142 | # Data 143 | $body = @" 144 | { 145 | "api_key" : "$ITFlow_API", 146 | "asset_name" : "$asset_name", 147 | "asset_type" : "$asset_type", 148 | "asset_make" : "$asset_make", 149 | "asset_model" : "$asset_model", 150 | "asset_serial" : "$asset_serial", 151 | "asset_os" : "$asset_os", 152 | "asset_ip" : "$local_ip", 153 | "asset_mac" : "$asset_mac", 154 | "asset_install_date" : "$install", 155 | "asset_status" : "Deployed", 156 | "client_id" : "$ITFlow_client_ID", 157 | "asset_location_id" : "$asset_location_id", 158 | "asset_network_id" : "$asset_network_id", 159 | "asset_id" : "$asset_id" 160 | } 161 | "@ 162 | 163 | $uri_write = $ITFlow_url + $module 164 | $write = Invoke-RestMethod -Method Post -Uri $uri_write -Body $body 165 | 166 | if ($exists.success -eq "True" -And $write.success -eq "True") { 167 | Write-Host "Asset updated." 168 | } 169 | 170 | if ($exists.success -eq "True" -And $write.success -eq "False") { 171 | Write-Host "No changes to update." 172 | } 173 | 174 | if ($exists.success -eq "False" -And $write.success -eq "True") { 175 | Write-Host "Asset created." 176 | } 177 | if ($exists.success -eq "False" -And $write.success -eq "False") { 178 | Write-Host "Failed to create asset." 179 | } 180 | -------------------------------------------------------------------------------- /assets/UniFi AP Sync.ps1: -------------------------------------------------------------------------------- 1 | # UniFi API access 2 | 3 | # Example script to sync data from a single site into a single ITFlow client 4 | # This could be adapted to sync multiple sites to multiple clients, but would need a way to define which UniFi site ID relates to which client 5 | # (see: https://gcits.com/knowledge-base/sync-unifi-sites-with-it-glue/ for inspiration) 6 | 7 | 8 | ####################################################################################################### 9 | # Functions 10 | 11 | # Function to check if a string ($itfAssetID) contains only numbers 12 | function Is-Numeric ($Value) { 13 | return $Value -match "^[\d\.]+$" 14 | } 15 | ####################################################################################################### 16 | 17 | 18 | ####################################################################################################### 19 | # UniFi Settings 20 | # https://blog.darrenjrobinson.com/accessing-your-ubiquiti-unifi-network-configuration-with-powershell/ 21 | 22 | # Unifi Controller Login Base URI 23 | $unfURL = '' # e.g 'https://192.168.1.2:8443' 24 | 25 | # Identifier of the site in UniFi. Set to default for the default site 26 | $unfSiteID = "default" 27 | 28 | # UniFi Admin Username 29 | $unfUsername = '' 30 | 31 | # UniFi Password 32 | $unfPassword = "" 33 | 34 | $unfAuthBody = @{"username" = $unfUsername; "password" = $unfPassword } 35 | $unfHeaders = @{"Content-Type" = "application/json" } 36 | $unfLogin = $null 37 | ####################################################################################################### 38 | 39 | 40 | ####################################################################################################### 41 | # ITFlow Settings 42 | # https://itflow.org/docs.php?doc=api 43 | 44 | # ITFlow Base URL 45 | $itfBaseURL = 'http://127.0.0.1/itflow' 46 | 47 | # ITFlow API Key 48 | $itfAPIKey = ' ' 49 | 50 | # ITFlow Client ID (for adding assets) 51 | $itfClientID = ' ' 52 | 53 | 54 | $itfReadURL = $itfBaseURL + "/api/v1/assets/read.php?api_key=" + $itfAPIKey 55 | $itfCreateURL = $itfBaseURL + "/api/v1/assets/create.php" 56 | $itfUpdateURL = $itfBaseURL + "/api/v1/assets/update.php" 57 | 58 | ###################################################################################################### 59 | 60 | 61 | # UniFi Login 62 | $unfLogin = Invoke-RestMethod -Method Post -Uri "$($unfURL)/api/login" -Body ($unfAuthBody | convertto-json) -Headers $unfHeaders -SessionVariable UBNT -ErrorAction Stop 63 | 64 | # Check UniFi login success 65 | if($unfLogin.meta.rc -notContains "ok" -or $unfLogin.meta.rc -contains "error"){ 66 | Write-Host "UNIFI - Something went wrong connecting to $($unfURL) as $($unfUsername)" 67 | Write-Host $unfLogin 68 | Exit 69 | } 70 | Write-Host -ForegroundColor Green "UNIFI - Successfully authenticated." 71 | 72 | # ITFlow credential check 73 | $iftLoginTest = Invoke-RestMethod -Method GET -Uri $itfReadURL -ErrorAction Stop 74 | if(!$?){ 75 | Write-Host "ITFLOW - Something went wrong connecting to $itfReadURL" 76 | Exit 77 | } 78 | Write-Host -ForegroundColor Green "ITFLOW - Successfully authenticated." 79 | 80 | 81 | Write-Host 82 | Write-Host "------" 83 | Write-Host 84 | 85 | # Get all Devices for this site 86 | $unfDevices = Invoke-RestMethod -Method Get -Uri "$($unfURL)/api/s/$($unfSiteID)/stat/device" -WebSession $UBNT -Headers $unfHeaders 87 | 88 | foreach ($AP in $unfDevices.data) { 89 | 90 | $urlName = $itfReadURL + "&asset_name=" + $AP.Name 91 | $urlSerial = $itfReadURL + "&asset_serial=" + $AP.serial 92 | 93 | # Variables 94 | $itfAssetID = $false 95 | $name = $AP.name 96 | $serial = $AP.serial 97 | $model = $AP.model 98 | $os = $AP.version 99 | $ip = $AP.ip 100 | $mac = $AP.mac 101 | 102 | # ITFlow - query via asset serial number 103 | $itfAssetSN = Invoke-RestMethod -Method GET -Uri "$urlSerial" 104 | 105 | # ITFlow - query via asset name 106 | $itfAssetName = Invoke-RestMethod -Method GET -Uri "$urlName" 107 | 108 | # Checks to determine the ITFlow asset ID 109 | 110 | if($itfAssetSN.success -eq "True"){ 111 | $itfAssetID = $itfAssetSN.data.asset_id 112 | $itfAssetClientID = $itfAssetSN.data.asset_client_id 113 | #Write-Host -ForegroundColor Green $AP.Name "lookup success via SN. ITFlow ID" $itfAssetID 114 | } 115 | elseif($itfAssetName.success -eq "True"){ 116 | $itfAssetID = $itfAssetName.data.asset_id 117 | $itfAssetClientID = $itfAssetName.data.asset_client_id 118 | #Write-Host -ForegroundColor Green $AP.Name "lookup success via name. ITFlow ID:" $itfAssetID 119 | } 120 | 121 | # Check if asset already exists (if ITFlow knows about the AP) 122 | 123 | if(Is-Numeric $itfAssetID){ 124 | # We found the asset - update details 125 | 126 | Write-Host -ForegroundColor Green "Found asset" $name $serial "as ITFlow ID" $itfAssetID " - updating it.." 127 | 128 | # Asset attributes to be updated 129 | $body = @" 130 | { 131 | "api_key" : "$itfAPIKey", 132 | "asset_id" : "$itfAssetID", 133 | "asset_name" : "$name", 134 | "asset_type" : "Access Point", 135 | "asset_make" : "UniFi", 136 | "asset_model" : "$model", 137 | "asset_serial" : "$serial", 138 | "asset_os" : "$os", 139 | "asset_ip" : "$ip", 140 | "asset_mac" : "$mac", 141 | "client_id" : "$itfAssetClientID" 142 | } 143 | "@ # This seemingly cannot be indented.. 144 | 145 | 146 | # Update asset 147 | Invoke-RestMethod -Method Post -Uri $itfUpdateURL -Body $body 148 | 149 | } 150 | 151 | else{ 152 | # Couldn't find asset, add it 153 | 154 | Write-Host -ForegroundColor Yellow "Could not find asset" $AP.Name $AP.Serial "- adding it.." 155 | 156 | # New asset attributes 157 | $body = @" 158 | { 159 | "api_key" : "$itfAPIKey", 160 | "asset_name" : "$name", 161 | "asset_type" : "Access Point", 162 | "asset_make" : "UniFi", 163 | "asset_model" : "$model", 164 | "asset_serial" : "$serial", 165 | "asset_os" : "$os", 166 | "asset_ip" : "$ip", 167 | "asset_mac" : "$mac", 168 | "asset_notes" : "Added via script", 169 | "client_id" : "$itfClientID" 170 | } 171 | "@ # This seemingly cannot be indented.. 172 | 173 | 174 | # Add asset 175 | Invoke-RestMethod -Method Post -Uri $itfCreateURL -Body $body 176 | 177 | } 178 | 179 | # Blank line for console output readability 180 | Write-Host 181 | } 182 | -------------------------------------------------------------------------------- /assets/create.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Create asset(s) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | $body = @" 14 | { 15 | "api_key" : "$apiKey", 16 | "asset_name" : "My Laptop 2", 17 | "asset_type" : "Laptop", 18 | "asset_make" : "Dell", 19 | "asset_model" : "Optiplex", 20 | "asset_serial" : "XYZ", 21 | "asset_os" : "Windows 10", 22 | "asset_ip" : "192.168.10.10", 23 | "asset_mac" : "", 24 | "asset_status" : "Deployed", 25 | "asset_purchase_date" : "0000-00-00", 26 | "asset_warranty_expire" : "0000-00-00", 27 | "asset_install_date" : "0000-00-00", 28 | "asset_notes" : "This is a cool laptop!", 29 | "asset_vendor_id" : "", 30 | "asset_location_id" : "", 31 | "asset_contact_id" : "", 32 | "asset_network_id" : "16", 33 | "client_id" : "10" 34 | } 35 | "@ 36 | 37 | # Module / Endpoint 38 | $module = "/api/v1/assets/create.php" 39 | 40 | # Build URI from defined data 41 | $uri = $siteUrl + $module 42 | 43 | # Request 44 | # Use Invoke-WebRequest instead to see more info about the request/response 45 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 46 | 47 | -------------------------------------------------------------------------------- /assets/delete.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Delete asset 5 | 6 | # API Key 7 | $apiKey = "B0pqpqXmVi12borC" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | # Asset ID to delete 14 | # Client ID is required if the API key used has scope/access to all clients 15 | $body = @" 16 | { 17 | "api_key" : "$apiKey", 18 | "asset_id" : "9", 19 | "client_id" : "1" 20 | } 21 | "@ 22 | 23 | # Module / Endpoint 24 | $module = "/api/v1/assets/delete.php" 25 | 26 | # Build URI from defined data 27 | $uri = $siteUrl + $module 28 | 29 | # Request 30 | # Use Invoke-WebRequest instead to see more info about the request/response 31 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 32 | 33 | -------------------------------------------------------------------------------- /assets/read.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Read assets 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Module / Endpoint 13 | $module = "/api/v1/assets/read.php" 14 | 15 | # Build URI from defined data 16 | # Will return all assets by default (single client/all clients depends on API key scope) 17 | $uri = $siteUrl + $module + "?api_key=" + $apiKey 18 | 19 | 20 | # Other URL examples 21 | 22 | # All assets for a specific client ID 23 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&client_id=10" 24 | 25 | # All assets of a specific type 26 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&asset_type=Laptop" 27 | 28 | # Specific asset ID 29 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&asset_id=22" 30 | 31 | 32 | # Specific asset name 33 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&asset_name=SRV01" 34 | 35 | 36 | # Request 37 | # Use Invoke-WebMethod instead to see more info about the request/response 38 | Invoke-RestMethod -Method GET -Uri $uri -------------------------------------------------------------------------------- /assets/update.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Update asset(s) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | # Unspecified values will not be modified 14 | # Client ID is required if the API key used has scope/access to all clients 15 | # (ensure to remove trailing comma from network id if removing). 16 | $body = @" 17 | { 18 | "api_key" : "$apiKey", 19 | "asset_id" : "34", 20 | "asset_name" : "My Laptop 2", 21 | "asset_type" : "Laptop", 22 | "asset_make" : "Dell", 23 | "asset_model" : "Optiplex", 24 | "asset_serial" : "XYZ", 25 | "asset_os" : "Windows 10", 26 | "asset_ip" : "192.168.10.10", 27 | "asset_mac" : "", 28 | "asset_status" : "Deployed", 29 | "asset_purchase_date" : "", 30 | "asset_warranty_expire" : "2024-02-01", 31 | "asset_install_date" : "", 32 | "asset_notes" : "This is a cool laptop!", 33 | "asset_vendor_id" : "", 34 | "asset_location_id" : "", 35 | "asset_contact_id" : "", 36 | "asset_network_id" : "0", 37 | "client_id" : "1" 38 | } 39 | "@ 40 | 41 | # Module / Endpoint 42 | $module = "/api/v1/assets/update.php" 43 | 44 | # Build URI from defined data 45 | $uri = $siteUrl + $module 46 | 47 | # Request 48 | # Use Invoke-WebRequest instead to see more info about the request/response 49 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 50 | 51 | -------------------------------------------------------------------------------- /clients/create.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Create client(s) 5 | 6 | # API Key (must be an ALL client API key) 7 | $apiKey = "05438411f4fd492f" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | $body = @" 14 | { 15 | "api_key" : "$apiKey", 16 | "client_name" : "Contoso", 17 | "client_type" : "Consultancy", 18 | "client_website" : "contoso.org", 19 | "client_referral" : "sally@itflow.org", 20 | "client_rate" : "250", 21 | "client_currency_code" : "USD", 22 | "client_net_terms" : "30", 23 | "client_tax_id_number" : "987654321Z", 24 | "client_is_lead" : "0", 25 | "client_notes" : "New client" 26 | } 27 | "@ 28 | 29 | # Module / Endpoint 30 | $module = "/api/v1/clients/create.php" 31 | 32 | # Build URI from defined data 33 | $uri = $siteUrl + $module 34 | 35 | # Request 36 | # Use Invoke-WebRequest instead to see more info about the request/response 37 | Invoke-RestMethod -Method Post -Uri $uri -Body $body -------------------------------------------------------------------------------- /contacts/create.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Create contact(s) 5 | 6 | # API Key 7 | $apiKey = "05438411f4fd492f" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | $body = @" 14 | { 15 | "api_key" : "$apiKey", 16 | "contact_name" : "Sally Suzie", 17 | "contact_title" : "Head of Accounting", 18 | "contact_department" : "Accounts", 19 | "contact_email" : "sally@itflow.org", 20 | "contact_phone" : "123456", 21 | "contact_extension" : "", 22 | "contact_mobile" : "", 23 | "contact_notes" : "We like Sally - she pays us!", 24 | "contact_auth_method" : "local", 25 | "contact_important" : "1", 26 | "contact_billing" : "1", 27 | "contact_technical" : "0", 28 | "contact_location_id" : "0", 29 | "client_id" : "1" 30 | } 31 | "@ 32 | 33 | # Module / Endpoint 34 | $module = "/api/v1/contacts/create.php" 35 | 36 | # Build URI from defined data 37 | $uri = $siteUrl + $module 38 | 39 | # Request 40 | # Use Invoke-WebRequest instead to see more info about the request/response 41 | Invoke-RestMethod -Method Post -Uri $uri -Body $body -------------------------------------------------------------------------------- /contacts/delete.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Delete contact 5 | 6 | # API Key 7 | $apiKey = "6j6vczwbONUt4JQZ" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | # Contact ID to delete 14 | # Client ID is required if the API key used has scope/access to all clients 15 | $body = @" 16 | { 17 | "api_key" : "$apiKey", 18 | "contact_id" : "47", 19 | "client_id" : "10" 20 | } 21 | "@ 22 | 23 | # Module / Endpoint 24 | $module = "/api/v1/contacts/delete.php" 25 | 26 | # Build URI from defined data 27 | $uri = $siteUrl + $module 28 | 29 | # Request 30 | # Use Invoke-WebRequest instead to see more info about the request/response 31 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 32 | 33 | -------------------------------------------------------------------------------- /contacts/read.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Read contacts 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Module / Endpoint 13 | $module = "/api/v1/contacts/read.php" 14 | 15 | # Build URI from defined data 16 | # Will return all contacts by default (single client/all clients depends on API key scope) 17 | $uri = $siteUrl + $module + "?api_key=" + $apiKey 18 | 19 | 20 | # Other URL examples 21 | 22 | # All contacts for a specific client ID 23 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&client_id=10" 24 | 25 | # Contact via email 26 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&contact_email=someone@example.com" 27 | 28 | # Contact via number 29 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&contact_phone_or_mobile=1199" 30 | 31 | # Specific contact ID 32 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&contact_id=22" 33 | 34 | 35 | # Request 36 | # Use Invoke-WebMethod instead to see more info about the request/response 37 | Invoke-RestMethod -Method GET -Uri $uri -------------------------------------------------------------------------------- /contacts/update.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Update contact(s) 5 | 6 | # API Key 7 | $apiKey = "05438411f4fd492f" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | $body = @" 14 | { 15 | "api_key" : "$apiKey", 16 | "contact_id" : "48", 17 | "contact_name" : "Suzanne Sallie", 18 | "contact_title" : "Head of Accounting", 19 | "contact_department" : "Accounts", 20 | "contact_email" : "sally@itflow.org", 21 | "contact_phone" : "1234567", 22 | "contact_extension" : "", 23 | "contact_mobile" : "", 24 | "contact_notes" : "We like Suzanne - she pays us (a lot)!", 25 | "contact_auth_method" : "local", 26 | "contact_important" : "1", 27 | "contact_billing" : "1", 28 | "contact_technical" : "0", 29 | "contact_location_id" : "0", 30 | "client_id" : "1" 31 | } 32 | "@ 33 | 34 | # Module / Endpoint 35 | $module = "/api/v1/contacts/update.php" 36 | 37 | # Build URI from defined data 38 | $uri = $siteUrl + $module 39 | 40 | # Request 41 | # Use Invoke-WebRequest instead to see more info about the request/response 42 | Invoke-RestMethod -Method Post -Uri $uri -Body $body -ErrorVariable $a -------------------------------------------------------------------------------- /credentials/create.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Create credential(s) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Credential decryption key 10 | $credKey = "JKyA0daoyOv7oKpw" 11 | 12 | # Base site URL 13 | $siteUrl = "https://demo.itflow.org" 14 | 15 | # Data 16 | $body = @" 17 | { 18 | "api_key" : "$apiKey", 19 | "api_key_decrypt_password" : "$credKey", 20 | "login_name" : "SRV-03 ILO", 21 | "login_description" : "Lights out for SRV-03", 22 | "login_uri" : "https://10.0.0.1", 23 | "login_uri_2" : "", 24 | "login_username" : "admin", 25 | "login_password" : "Passw0rd", 26 | "login_otp_secret" : "", 27 | "login_note" : "Very important login entry", 28 | "login_important" : "0", 29 | "login_contact_id" : "0", 30 | "login_vendor_id" : "0", 31 | "login_asset_id" : "0", 32 | "login_software_id" : 0, 33 | "client_id" : "1" 34 | } 35 | "@ 36 | 37 | # Module / Endpoint 38 | $module = "/api/v1/credentials/create.php" 39 | 40 | # Build URI from defined data 41 | $uri = $siteUrl + $module 42 | 43 | # Request 44 | # Use Invoke-WebRequest instead to see more info about the request/response 45 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 46 | -------------------------------------------------------------------------------- /credentials/read.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Read credentials (originally called "logins") 5 | # Warning: Anyone in possession of the API Key & Decryption key can decrypt all credentials/logins via the API. 6 | # Whilst running this script directly on user endpoints is convenient, consider how you will keep the keys safe from compromise. 7 | 8 | # API Key 9 | $apiKey = "a1wEoh1F3omPhea6" 10 | 11 | # Credential decryption key 12 | $credKey = "JKyA0daoyOv7oKpw" 13 | 14 | # Base site URL 15 | $siteUrl = "https://demo.itflow.org" 16 | 17 | # Module / Endpoint 18 | $module = "/api/v1/credentials/read.php" 19 | 20 | # Build URI from defined data 21 | # Will return all assets by default (single client/all clients depends on API key scope) 22 | $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&api_key_decrypt_password=" + $credKey 23 | 24 | # Another URL example: Specific credential/login ID 25 | #$uri = $siteUrl + $module + "?api_key=" + $apiKey + "&api_key_decrypt_password=" + $credKey + "&login_id=7" 26 | 27 | # Request 28 | # Use Invoke-WebMethod instead to see more info about the request/response 29 | $a = Invoke-RestMethod -Method GET -Uri $uri 30 | -------------------------------------------------------------------------------- /credentials/update.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Update credential(s) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Credential decryption key 10 | $credKey = "JKyA0daoyOv7oKpw" 11 | 12 | # Base site URL 13 | $siteUrl = "https://demo.itflow.org" 14 | 15 | # Data 16 | # Required fields are API Key, API Decryption Key, Login ID and Client ID 17 | # Only specify the fields you need to update, see create.ps1 for column names 18 | $body = @" 19 | { 20 | "api_key" : "$apiKey", 21 | "api_key_decrypt_password" : "$credKey", 22 | "login_id" : "6", 23 | "login_username" : "new_username", 24 | "login_password" : "changedPassword-123", 25 | "client_id" : "1" 26 | } 27 | "@ 28 | 29 | # Module / Endpoint 30 | $module = "/api/v1/credentials/update.php" 31 | 32 | # Build URI from defined data 33 | $uri = $siteUrl + $module 34 | 35 | # Request 36 | # Use Invoke-WebRequest instead to see more info about the request/response 37 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 38 | -------------------------------------------------------------------------------- /documents/create.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Create documents(s) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | $body = @" 14 | { 15 | "api_key" : "$apiKey", 16 | "document_name" : "My example document", 17 | "document_description" : "Initial add", 18 | "document_content" : "This is an example document", 19 | "client_id" : "10" 20 | } 21 | "@ 22 | 23 | # Module / Endpoint 24 | $module = "/api/v1/documents/create.php" 25 | 26 | # Build URI from defined data 27 | $uri = $siteUrl + $module 28 | 29 | # Request 30 | # Use Invoke-WebRequest instead to see more info about the request/response 31 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 32 | 33 | -------------------------------------------------------------------------------- /documents/read.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Read documents 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Module / Endpoint 13 | $module = "/api/v1/documents/read.php" 14 | 15 | # Build URI from defined data 16 | # Will return all assets by default (single client/all clients depends on API key scope) 17 | $uri = $siteUrl + $module + "?api_key=" + $apiKey 18 | 19 | 20 | # Other URL examples 21 | 22 | # All documents for a specific client ID 23 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&client_id=10" 24 | 25 | # Specific document ID 26 | #$uri = $siteUrl + $module + "?api_key=" + $apiKey + "&document_id=41" 27 | 28 | 29 | # Request 30 | # Use Invoke-WebMethod instead to see more info about the request/response 31 | Invoke-RestMethod -Method GET -Uri $uri -------------------------------------------------------------------------------- /documents/update.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Update documents(s) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | $body = @" 14 | { 15 | "api_key" : "$apiKey", 16 | "document_id" : "42", 17 | "document_name" : "Test doc", 18 | "document_description" : "Updated via API", 19 | "document_content" : "I updated this test doc via the API!!", 20 | "client_id" : "1" 21 | } 22 | "@ 23 | 24 | # Module / Endpoint 25 | $module = "/api/v1/documents/update.php" 26 | 27 | # Build URI from defined data 28 | $uri = $siteUrl + $module 29 | 30 | # Request 31 | # Use Invoke-WebRequest instead to see more info about the request/response 32 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 33 | 34 | -------------------------------------------------------------------------------- /networks/read.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Read networks 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Module / Endpoint 13 | $module = "/api/v1/networks/read.php" 14 | 15 | # Build URI from defined data 16 | # Will return all networks by default (single client/all clients depends on API key scope) 17 | $uri = $siteUrl + $module + "?api_key=" + $apiKey 18 | 19 | # Other URL examples 20 | 21 | # Specific network ID 22 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&network_id=22" 23 | 24 | # Request 25 | # Use Invoke-WebMethod instead to see more info about the request/response 26 | Invoke-RestMethod -Method GET -Uri $uri 27 | -------------------------------------------------------------------------------- /payments/read.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Read payments (requires "All Clients" API key) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Module / Endpoint 13 | $module = "/api/v1/payments/read.php" 14 | 15 | # Build URI from defined data 16 | # Will return all payments by default 17 | $uri = $siteUrl + $module + "?api_key=" + $apiKey 18 | 19 | 20 | # Other URL examples (uncomment to use) 21 | 22 | # Specific payment ID 23 | # $payment_id = 1 24 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&payment_id=" + $payment_id 25 | 26 | 27 | # Specific invoice ID 28 | # $payment_invoice_id = 46 29 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&payment_invoice_id=" + $payment_invoice_id 30 | 31 | # Request 32 | # Use Invoke-WebMethod instead to see more info about the request/response 33 | $payments = (Invoke-RestMethod -Method GET -Uri $uri).data 34 | 35 | 36 | # Show payments 37 | For ($i=0; $i -le ($payments.Count - 1); $i++) { 38 | Write-Host "`n" 39 | Write-Host "Date:" $payments[$i].payment_date 40 | Write-Host "Method:" $payments[$i].payment_method 41 | Write-Host "Amount:" $payments[$i].payment_amount 42 | Write-Host "Invoice ID:" $payments[$i].payment_invoice_id 43 | Write-Host "Ref:" $payments[$i].payment_reference 44 | } -------------------------------------------------------------------------------- /tickets/create.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Create ticket(s) 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Data 13 | $body = @" 14 | { 15 | "api_key" : "$apiKey", 16 | "ticket_subject" : "Having issues with database", 17 | "ticket_details" : "User X is having issues with the database", 18 | "ticket_priority" : "Low", 19 | "ticket_assigned_to" : "0", 20 | "ticket_contact_id" : "0", 21 | "client_id" : "5" 22 | } 23 | "@ 24 | 25 | # Module / Endpoint 26 | $module = "/api/v1/tickets/create.php" 27 | 28 | # Build URI from defined data 29 | $uri = $siteUrl + $module 30 | 31 | # Request 32 | # Use Invoke-WebRequest instead to see more info about the request/response 33 | Invoke-RestMethod -Method Post -Uri $uri -Body $body 34 | 35 | -------------------------------------------------------------------------------- /tickets/read.ps1: -------------------------------------------------------------------------------- 1 | # ITFlow API - PowerShell examples 2 | # https://itflow.org 3 | 4 | # Read tickets 5 | 6 | # API Key 7 | $apiKey = "a1wEoh1F3omPhea6" 8 | 9 | # Base site URL 10 | $siteUrl = "https://demo.itflow.org" 11 | 12 | # Module / Endpoint 13 | $module = "/api/v1/tickets/read.php" 14 | 15 | # Build URI from defined data 16 | # Will return all tickets by default (single client/all clients depends on API key scope) 17 | $uri = $siteUrl + $module + "?api_key=" + $apiKey 18 | 19 | # Other URL examples 20 | 21 | # Specific ticket ID 22 | # $uri = $siteUrl + $module + "?api_key=" + $apiKey + "&ticket_id=22" 23 | 24 | # Request 25 | # Use Invoke-WebMethod instead to see more info about the request/response 26 | Invoke-RestMethod -Method GET -Uri $uri 27 | --------------------------------------------------------------------------------