Dynamic/New-AtwsInstalledProduct.ps1
|
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 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 |
#Requires -Version 4.0 #Version 1.6.5 <# .COPYRIGHT Copyright (c) ECIT Solutions AS. All rights reserved. Licensed under the MIT license. See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. #> Function New-AtwsInstalledProduct { <# .SYNOPSIS This function creates a new InstalledProduct through the Autotask Web Services API. All required properties are marked as required parameters to assist you on the command line. .DESCRIPTION The function supports all properties of an [Autotask.InstalledProduct] that can be updated through the Web Services API. The function uses PowerShell parameter validation and supports IntelliSense for selecting picklist values. Any required paramterer is marked as Mandatory in the PowerShell function to assist you on the command line. If you need very complicated queries you can write a filter directly and pass it using the -Filter parameter. To get the InstalledProduct with Id number 0 you could write 'New-AtwsInstalledProduct -Id 0' or you could write 'New-AtwsInstalledProduct -Filter {Id -eq 0}. 'New-AtwsInstalledProduct -Id 0,4' could be written as 'New-AtwsInstalledProduct -Filter {id -eq 0 -or id -eq 4}'. For simple queries you can see that using parameters is much easier than the -Filter option. But the -Filter option supports an arbitrary sequence of most operators (-eq, -ne, -gt, -ge, -lt, -le, -and, -or, -beginswith, -endswith, -contains, -like, -notlike, -soundslike, -isnotnull, -isnull, -isthisday). As you can group them using parenthesis '()' you can write arbitrarily complex queries with -Filter. To create a new InstalledProduct you need the following required fields: -AccountID -Active -InstallDate -ProductID Entities that have fields that refer to the base entity of this CmdLet: BillingItem InstalledProduct InstalledProductBillingProductAssociation InstalledProductNote Subscription Ticket TicketAdditionalInstalledProduct .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.InstalledProduct]. This function outputs the Autotask.InstalledProduct that was created by the API. .EXAMPLE $result = New-AtwsInstalledProduct -AccountID [Value] -Active [Value] -InstallDate [Value] -ProductID [Value] Creates a new [Autotask.InstalledProduct] through the Web Services API and returns the new object. .EXAMPLE $result = Get-AtwsInstalledProduct -Id 124 | New-AtwsInstalledProduct Copies [Autotask.InstalledProduct] by Id 124 to a new object through the Web Services API and returns the new object. .EXAMPLE Get-AtwsInstalledProduct -Id 124 | New-AtwsInstalledProduct | Set-AtwsInstalledProduct -ParameterName <Parameter Value> Copies [Autotask.InstalledProduct] by Id 124 to a new object through the Web Services API, passes the new object to the Set-AtwsInstalledProduct to modify the object. .EXAMPLE $result = Get-AtwsInstalledProduct -Id 124 | New-AtwsInstalledProduct | Set-AtwsInstalledProduct -ParameterName <Parameter Value> -Passthru Copies [Autotask.InstalledProduct] by Id 124 to a new object through the Web Services API, passes the new object to the Set-AtwsInstalledProduct to modify the object and returns the new object. .LINK Get-AtwsInstalledProduct .LINK Set-AtwsInstalledProduct #> [CmdLetBinding(SupportsShouldProcess = $true, DefaultParameterSetName='By_parameters', ConfirmImpact='Low')] Param ( # An array of objects to create [Parameter( ParametersetName = 'Input_Object', ValueFromPipeline = $true )] [ValidateNotNullOrEmpty()] [Autotask.InstalledProduct[]] $InputObject, # User defined fields already setup i Autotask [Parameter( ParametersetName = 'By_parameters' )] [Alias('UDF')] [ValidateNotNullOrEmpty()] [Autotask.UserDefinedField[]] $UserDefinedFields, [Parameter( ParametersetName = 'By_parameters' )] [datetime] $CreateDate, # Client [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $AccountID, # Product Active [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [boolean] $Active, # Configuration Item Daily Cost [Parameter( ParametersetName = 'By_parameters' )] [double] $DailyCost, # Configuration Item Hourly Cost [Parameter( ParametersetName = 'By_parameters' )] [double] $HourlyCost, # Install Date [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [datetime] $InstallDate, # Configuration Item Monthly Cost [Parameter( ParametersetName = 'By_parameters' )] [double] $MonthlyCost, # Configuration Item Notes [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,5000)] [string] $Notes, # Configuration Item Number of Users [Parameter( ParametersetName = 'By_parameters' )] [double] $NumberOfUsers, # Configuration Item Per Use Cost [Parameter( ParametersetName = 'By_parameters' )] [double] $PerUseCost, # Product ID [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $ProductID, # Reference Number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string] $ReferenceNumber, # Reference Title [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,200)] [string] $ReferenceTitle, # Serial Number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string] $SerialNumber, # Configuration Item Setup Fee [Parameter( ParametersetName = 'By_parameters' )] [double] $SetupFee, # Warranty Expiration Date [Parameter( ParametersetName = 'By_parameters' )] [datetime] $WarrantyExpirationDate, # Contract ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $ContractID, # Service ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $ServiceID, # Service Bundle ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $ServiceBundleID, # Configuration Item Type [Parameter( ParametersetName = 'By_parameters' )] [string] $Type, # Location [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string] $Location, # Contact Name [Parameter( ParametersetName = 'By_parameters' )] [Int] $ContactID, # Vendor Name [Parameter( ParametersetName = 'By_parameters' )] [Int] $VendorID, # Installed By Resource ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $InstalledByID, # Installed By Contact ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $InstalledByContactID, # Parent Configuration Item [Parameter( ParametersetName = 'By_parameters' )] [Int] $ParentInstalledProductID, # Last Modified Time [Parameter( ParametersetName = 'By_parameters' )] [datetime] $LastModifiedTime, # Contract Service Id [Parameter( ParametersetName = 'By_parameters' )] [Int] $ContractServiceID, # Contract Service Bundle Id [Parameter( ParametersetName = 'By_parameters' )] [Int] $ContractServiceBundleID, # Service Level Agreement [Parameter( ParametersetName = 'By_parameters' )] [string] $ServiceLevelAgreementID, # Account Physical Location [Parameter( ParametersetName = 'By_parameters' )] [Int] $AccountPhysicalLocationID, # RMM Device ID [Parameter( ParametersetName = 'By_parameters' )] [long] $RMMDeviceID, # RMM Device UID [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceUID, # RMM Device Audit Architecture ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditArchitectureID, # RMM Device Audit Display Adaptor ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditDisplayAdaptorID, # RMM Device Audit Domain ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditDomainID, # RMM Device Audit External IP Address [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditExternalIPAddress, # RMM Device Audit Hostname [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditHostname, # RMM Device Audit IP Address [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditIPAddress, # RMM Device Audit Mac Address [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditMacAddress, # RMM Device Audit Manufacturer ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditManufacturerID, # RMM Device Audit Memory Bytes [Parameter( ParametersetName = 'By_parameters' )] [long] $RMMDeviceAuditMemoryBytes, # RMM Device Audit Model ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditModelID, # RMM Device Audit Motherboard ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditMotherboardID, # RMM Device Audit Operating System [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditOperatingSystem, # RMM Device Audit Processor ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditProcessorID, # RMM Device Audit Service Pack ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditServicePackID, # RMM Device Audit Storage Bytes [Parameter( ParametersetName = 'By_parameters' )] [long] $RMMDeviceAuditStorageBytes, # RMM Device Audit Device Type ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditDeviceTypeID, # RMM Device Audit SNMP Location [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditSNMPLocation, # RMM Device Audit SNMP Name [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditSNMPName, # RMM Device Audit SNMP Contact [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditSNMPContact, # RMM Device Audit Mobile Network Operator ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditMobileNetworkOperatorID, # RMM Device Audit Mobile Number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditMobileNumber, # RMM Device Audit Description [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $RMMDeviceAuditDescription, # RMM Open Alert Count [Parameter( ParametersetName = 'By_parameters' )] [Int] $RMMOpenAlertCount, # RMM Device Audit Last User [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string] $RMMDeviceAuditLastUser, # RMM Device Audit Missing Patch Count [Parameter( ParametersetName = 'By_parameters' )] [Int] $RMMDeviceAuditMissingPatchCount, # Datto Serial Number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string] $DattoSerialNumber, # Datto Internal IP [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $DattoInternalIP, # Datto Remote IP [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $DattoRemoteIP, # Datto Hostname [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,255)] [string] $DattoHostname, # Datto Protected Kilobytes [Parameter( ParametersetName = 'By_parameters' )] [long] $DattoProtectedKilobytes, # Datto Used Kilobytes [Parameter( ParametersetName = 'By_parameters' )] [long] $DattoUsedKilobytes, # Datto Available Kilobytes [Parameter( ParametersetName = 'By_parameters' )] [long] $DattoAvailableKilobytes, # Datto Percentage Used [Parameter( ParametersetName = 'By_parameters' )] [double] $DattoPercentageUsed, # Datto Offsite Used Bytes [Parameter( ParametersetName = 'By_parameters' )] [long] $DattoOffsiteUsedBytes, # Datto OS Version ID [Parameter( ParametersetName = 'By_parameters' )] [string] $DattoOSVersionID, # Datto ZFS Version ID [Parameter( ParametersetName = 'By_parameters' )] [string] $DattoZFSVersionID, # Datto Kernel Version ID [Parameter( ParametersetName = 'By_parameters' )] [string] $DattoKernelVersionID, # Datto NIC Speed Kilobits Per Second [Parameter( ParametersetName = 'By_parameters' )] [Int] $DattoNICSpeedKilobitsPerSecond, # Datto Device Memory Megabytes [Parameter( ParametersetName = 'By_parameters' )] [Int] $DattoDeviceMemoryMegabytes, # Datto Uptime Seconds [Parameter( ParametersetName = 'By_parameters' )] [Int] $DattoUptimeSeconds, # Datto Number Of Agents [Parameter( ParametersetName = 'By_parameters' )] [Int] $DattoNumberOfAgents, # Datto Number Of Drives [Parameter( ParametersetName = 'By_parameters' )] [Int] $DattoNumberOfDrives, # Datto Drives Errors [Parameter( ParametersetName = 'By_parameters' )] [boolean] $DattoDrivesErrors, # Datto Number Of Volumes [Parameter( ParametersetName = 'By_parameters' )] [Int] $DattoNumberOfVolumes, # Datto Last Check In Date Time [Parameter( ParametersetName = 'By_parameters' )] [datetime] $DattoLastCheckInDateTime, # RMM Device Audit Antivirus Status ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditAntivirusStatusID, # RMM Device Audit Backup Status ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditBackupStatusID, # RMM Device Audit Patch Status ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditPatchStatusID, # RMM Device Audit Software Status ID [Parameter( ParametersetName = 'By_parameters' )] [string] $RMMDeviceAuditSoftwareStatusID, # Last Activity Person ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $LastActivityPersonID, # Last Activity Person Type [Parameter( ParametersetName = 'By_parameters' )] [string] $LastActivityPersonType, # Created By Person ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $CreatedByPersonID, # API Vendor ID [Parameter( ParametersetName = 'By_parameters' )] [string] $ApiVendorID, # Device Networking ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string] $DeviceNetworkingID ) begin { $entityName = 'InstalledProduct' # Enable modern -Debug behavior if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } else { # Respect configured preference $DebugPreference = $Script:Atws.Configuration.DebugPref } Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) if (!($PSCmdlet.MyInvocation.BoundParameters['Verbose'].IsPresent)) { # No local override of central preference. Load central preference $VerbosePreference = $Script:Atws.Configuration.VerbosePref } $processObject = @() } process { if ($InputObject) { Write-Verbose -Message ('{0}: Copy Object mode: Setting ID property to zero' -F $MyInvocation.MyCommand.Name) $fields = Get-AtwsFieldInfo -Entity $entityName $CopyNo = 1 foreach ($object in $InputObject) { # Create a new object and copy properties $newObject = New-Object -TypeName Autotask.$entityName # Copy every non readonly property $fieldNames = $fields.Where( { $_.Name -ne 'id' }).Name if ($PSBoundParameters.ContainsKey('UserDefinedFields')) { $fieldNames += 'UserDefinedFields' } foreach ($field in $fieldNames) { $newObject.$field = $object.$field } if ($newObject -is [Autotask.Ticket]) { Write-Verbose -Message ('{0}: Copy Object mode: Object is a Ticket. Title must be modified to avoid duplicate detection.' -F $MyInvocation.MyCommand.Name) $title = '{0} (Copy {1})' -F $newObject.Title, $CopyNo $copyNo++ $newObject.Title = $title } $processObject += $newObject } } else { Write-Debug -Message ('{0}: Creating empty [Autotask.{1}]' -F $MyInvocation.MyCommand.Name, $entityName) $processObject += New-Object -TypeName Autotask.$entityName } # Prepare shouldProcess comments $caption = $MyInvocation.MyCommand.Name $verboseDescription = '{0}: About to create {1} {2}(s). This action cannot be undone.' -F $caption, $processObject.Count, $entityName $verboseWarning = '{0}: About to create {1} {2}(s). This action may not be undoable. Do you want to continue?' -F $caption, $processObject.Count, $entityName # Lets don't and say we did! if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { # Process parameters and update objects with their values $processObject = $processObject | Update-AtwsObjectsWithParameters -BoundParameters $PSBoundParameters -EntityName $EntityName $result = Set-AtwsData -Entity $processObject -Create } } end { Write-Debug -Message ('{0}: End of function, returning {1} {2}(s)' -F $MyInvocation.MyCommand.Name, $result.count, $entityName) Return $result } } |