en-US/NinjaRmmApi-help.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 |
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NinjaRmmAlerts</command:name> <command:verb>Get</command:verb> <command:noun>NinjaRmmAlerts</command:noun> <maml:description> <maml:para>Get alerts from NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will retrieve one or more alerts from NinjaRMM. With no parameters specified, all alerts will be returned. You may use -AlertId to return only a single alert, or -Since to get all alerts that have occurred after the one with that specific ID.</maml:para> <maml:para>In this version of the NinjaRMM API, alerts contain both device and customer information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NinjaRmmAlerts</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Retrieve a specific alert. This parameter is undocumented and not part of official API specification. Thus, using it in a production environment may not be a wise idea.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NinjaRmmAlerts</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Since</maml:name> <maml:Description> <maml:para>Retrieve all alerts since this last known alert ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Retrieve a specific alert. This parameter is undocumented and not part of official API specification. Thus, using it in a production environment may not be a wise idea.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Since</maml:name> <maml:Description> <maml:para>Retrieve all alerts since this last known alert ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object[]</maml:name> </dev:type> <maml:description> <maml:para>Upon success, this cmdlet will return zero or more Objects containing alert data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmAlerts</dev:code> <dev:remarks> <maml:para>Retrieve all alerts.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmAlerts -Since 1234567</dev:code> <dev:remarks> <maml:para>Retrieve all alerts that have happened since alert ID 1234567 was logged.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmAlerts | Where {$_.Role -eq 'WINDOWS_WORKSTATION'} | Format-List</dev:code> <dev:remarks> <maml:para>Retrieve all alerts that have happened on a Windows workstation. This module converts the API results into native PowerShell objects that can be parsed, filtered, and manipulated with other cmdlets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Get-NinjaRmmAlerts.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-NinjaRmmAlert</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NinjaRmmCustomers</command:name> <command:verb>Get</command:verb> <command:noun>NinjaRmmCustomers</command:noun> <maml:description> <maml:para>Get customers from NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will retrieve data about one or more customers from NinjaRMM. With no parameters specified, all available customers will be returned. You may use -CustomerId to return only a single customer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NinjaRmmCustomers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CustomerId</maml:name> <maml:Description> <maml:para>If specified, this will retrieve data about only this one particular customer.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CustomerId</maml:name> <maml:Description> <maml:para>If specified, this will retrieve data about only this one particular customer.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object[]</maml:name> </dev:type> <maml:description> <maml:para>Upon success, this cmdlet will return zero or more objects containing customer data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmCustomers</dev:code> <dev:remarks> <maml:para>Retrieve all customers' data.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmCustomer -CustomerId 42</dev:code> <dev:remarks> <maml:para>Retrieve data about the customer with the ID number of 42. To find ID numbers, look in your NinjaRMM dashboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmCustomer | Where {$_.Name -Like '*Consulting'} | Format-List</dev:code> <dev:remarks> <maml:para>Retrieve all customers whose name ends with "Consulting." This module converts the API results into native PowerShell objects that can be parsed, filtered, and manipulated with other cmdlets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Get-NinjaRmmCustomers.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NinjaRmmDevices</command:name> <command:verb>Get</command:verb> <command:noun>NinjaRmmDevices</command:noun> <maml:description> <maml:para>Gets device information from NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will retrieve one or more available devices and their information from NinjaRMM. With no parameters specified, all devices will be returned. You may use -DeviceId to return only a single device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NinjaRmmDevices</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceId</maml:name> <maml:Description> <maml:para>Specify this parameter to retrieve data about one particular device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceId</maml:name> <maml:Description> <maml:para>Specify this parameter to retrieve data about one particular device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object[]</maml:name> </dev:type> <maml:description> <maml:para>Upon success, this cmdlet will return zero or more Objects containing device data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmDevices</dev:code> <dev:remarks> <maml:para>Retrieve a list of all available devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmDevices -DeviceId 528</dev:code> <dev:remarks> <maml:para>Retrieve all information about device number 528.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmDevices | Where {$_.System.Manufacturer -eq 'Hewlett-Packard'} | Out-GridView</dev:code> <dev:remarks> <maml:para>Retrieve all devices that report their manufacturer as Hewlett-Packard. This module converts the API results into native PowerShell objects that can be parsed, filtered, and manipulated with other cmdlets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Get-NinjaRmmDevices.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-NinjaRmmAlert</command:name> <command:verb>Reset</command:verb> <command:noun>NinjaRmmAlert</command:noun> <maml:description> <maml:para>Reset one alert in NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will acknowledge and reset an alert in NinjaRMM. Note that an alert may only be reset if it has the can_reset property.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-NinjaRmmAlert</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Specify the alert to reset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Specify the alert to reset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Reset-NinjaRmmAlert -AlertId 1234567</dev:code> <dev:remarks> <maml:para>Reset the alert with ID 1234567. If successful, there will be no output.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Reset-NinjaRmmAlert.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NinjaRmmAlerts</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-NinjaRmmSecrets</command:name> <command:verb>Reset</command:verb> <command:noun>NinjaRmmSecrets</command:noun> <maml:description> <maml:para>Removes your NinjaRMM API keys from memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will remove the NinjaRMM access key ID and secret access key from memory. After running this cmdlet, no other NinjaRmm cmdlets will work; you will need to run Set-NinjaRmmSecrets again.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-NinjaRmmSecrets</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>After you use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Reset-NinjaRmmSecrets</dev:code> <dev:remarks> <maml:para>Forgets the NinjaRMM secrets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Reset-NinjaRmmSecrets.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NinjaRmmSecrets</command:name> <command:verb>Set</command:verb> <command:noun>NinjaRmmSecrets</command:noun> <maml:description> <maml:para>Sets your NinjaRMM API keys.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet stores your NinjaRMM API access key ID and secret access key in memory. This cmdlet must be run before you can use any of the Get- or Reset- cmdlets in this module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NinjaRmmSecrets</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AccessKeyId</maml:name> <maml:Description> <maml:para>Your NinjaRMM API access key identifier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SecretAccessKey</maml:name> <maml:Description> <maml:para>Your NinjaRMM API secret access key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AccessKeyId</maml:name> <maml:Description> <maml:para>Your NinjaRMM API access key identifier.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SecretAccessKey</maml:name> <maml:Description> <maml:para>Your NinjaRMM API secret access key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Your NinjaRMM API information is stored in the system's environment. It is possible for another process on your computer to see this information. If this is a concern, you may wish to run Reset-NinjaRmmSecrets when you are finished.</maml:para> <maml:para>Your NinjaRMM secrets are only stored for the current PowerShell session. For long-term storage, consider using a password manager, saving them to your profile, or storing them with the SecretManagement module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-NinjaRmmSecrets -AccessKeyID "TF4STGMDR4H7AEXAMPLE" -SecretAccessKey "eh14c4ngchhu6283he03j6o7ar2fcuca0example"</dev:code> <dev:remarks> <maml:para>This prepares the module to access the NinjaRMM API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Reset-NinjaRmmSecrets.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-NinjaRmmSecrets</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>SecretManagement</maml:linkText> <maml:uri>https://github.com/PowerShell/SecretManagement</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NinjaRmmServerLocation</command:name> <command:verb>Set</command:verb> <command:noun>NinjaRmmServerLocation</command:noun> <maml:description> <maml:para>Selects a NinjaRMM API server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet allows you to select a NinjaRMM API server to use. NinjaRMM has API servers located in the United States and in the European Union. By default, the US server is used, but EU residents may prefer to use a closer server for better performance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NinjaRmmServerLocation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>Specify a region code. At this time, there are only two hostnames available, the US server (api.ninjarmm.com) and the EU server (eu-api.ninjarmm.com).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">US</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EU</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>Specify a region code. At this time, there are only two hostnames available, the US server (api.ninjarmm.com) and the EU server (eu-api.ninjarmm.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>It is not clear if there are any functional differences between the two hostnames. By default, this module will use the servers located in the United States.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-NinjaRmmServerLocation -Location 'EU'</dev:code> <dev:remarks> <maml:para>Switches this module to use the API servers located in the European Union.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |