PSCUCM.psm1
|
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 804 805 806 807 808 809 810 811 812 813 |
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\PSCUCM.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName PSCUCM.Import.DoDotSource -Fallback $false if ($PSCUCM_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName PSCUCM.Import.IndividualFiles -Fallback $false if ($PSCUCM_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) if ($doDotSource) { . (Resolve-Path $Path) } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText((Resolve-Path $Path)))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\preimport.ps1" # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\postimport.ps1" # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code function Get-PhoneNameFromDN { <# .SYNOPSIS Get Phone Name based off of DN .DESCRIPTION Get Phone Name based off of DN .PARAMETER DN Directory Number to get phone for .PARAMETER AXLVersion Version of AXL .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .EXAMPLE Get-PhoneNameFromDN -DN 123 -Server 'CUCM-PUB.example.com' -Credential (Get-Credential) Get the Phone Name for Directory Number 123 #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $DN, [Parameter(Mandatory = $true)] [string] $server, [string] $AXLVersion = '11.5', [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $CucmAxlSplat = @{ SqlQuery = @' SELECT device.name FROM device, numplan, devicenumplanmap WHERE devicenumplanmap.fkdevice = device.pkid AND devicenumplanmap.fknumplan = numplan.pkid AND numplan.dnorpattern = "{0}" '@ -f $DN server = $server Credential = $Credential AXLVersion = $AXLVersion EnableException = $EnableException OutputXml = $OutputXml } Invoke-CucmSql @CucmAxlSplat } function Add-Phone { <# .SYNOPSIS Add a Phone to CUCM Environment .DESCRIPTION Add a Phone to CUCM Environment .PARAMETER MacAddress MacAddress for the phone .PARAMETER Product Product .PARAMETER protocolSide Protocol Side (User?) .PARAMETER devicePoolName Name of DevicePool to put phone in. .PARAMETER commonPhoneConfigName Parameter description .PARAMETER phoneTemplateName Parameter description .PARAMETER Protocol Parameter description .PARAMETER AXLVersion Version of AXL .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .PARAMETER WhatIf What If? .PARAMETER Confirm Confirm... .EXAMPLE An example with more here... .NOTES General notes #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Low')] param ( [Parameter(Mandatory = $true)] [string] $MacAddress, [Parameter(Mandatory = $true)] [string] $Product, [Parameter(Mandatory = $true)] [string] $protocolSide, [Parameter(Mandatory = $true)] [string] $devicePoolName, [Parameter(Mandatory = $true)] [string] $commonPhoneConfigName, [Parameter(Mandatory = $true)] [string] $phoneTemplateName, [Parameter(Mandatory = $true)] [string] $Protocol, [string] $AXLVersion = '11.5', [Parameter(Mandatory = $true)] [string] $server, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $class = 'Phone' $locationName = 'Hub_None' $useTrustedRelayPoint = 'Default' $primaryPhoneName = '' $deviceMobilityMode = 'Default' $certificateOperation = 'No Pending Operation' $packetCaptureMode = 'None' $builtInBridgeStatus = 'Default' $CucmAxlSplat = @{ entity = 'addPhone' # parameters = @{ # phone = $phonexml # } parameters = @{ phone = @{ name = $MacAddress product = $Product class = $class protocol = $Protocol protocolSide = $protocolSide devicePoolName = $devicePoolName commonPhoneConfigName = $commonPhoneConfigName locationName = $locationName useTrustedRelayPoint = $useTrustedRelayPoint phoneTemplateName = $phoneTemplateName primaryPhoneName = $primaryPhoneName deviceMobilityMode = $deviceMobilityMode certificateOperation = $certificateOperation packetCaptureMode = $packetCaptureMode builtInBridgeStatus = $builtInBridgeStatus } } server = $server AXLVersion = $AXLVersion Credential = $Credential EnableException = $EnableException OutputXml = $OutputXml } Invoke-CucmAxl @CucmAxlSplat } function Get-PhoneByDN { <# .SYNOPSIS Get the phone(s) based upon the DN .DESCRIPTION Get the phone(s) based upon the DN .PARAMETER DN Directory Number to lookup .PARAMETER AXLVersion Version of AXL .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .EXAMPLE Get-PhoneByDN -DN 123 -server 'Cucm-Pub.example.com' -Credential (Get-Credential) Get Phone with DN 123 #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $DN, [Parameter(Mandatory = $true)] [string] $server, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $phoneNameByDNSplat = @{ DN = $DN server = $server Credential = $Credential EnableException = $EnableException OutputXml = $OutputXml } $phoneName = Get-PhoneNameFromDN @phoneNameByDNSplat | Select-Xml -XPath '//name' | Select-Object -ExpandProperty node | Select-Object -ExpandProperty '#text' $CucmAxlSplat = @{ 'server' = $server 'entity' = 'getPhone' 'parameters' = @{ 'name' = $phoneName } 'Credential' = $Credential } Invoke-CucmAxl @CucmAxlSplat | Select-Xml -XPath '//phone' | Select-Object -ExpandProperty node } function Get-PhoneServicesByDN { <# .SYNOPSIS Get the services assigned to the phone based on the DN. .DESCRIPTION Get the services assigned to the phone based on the DN. .PARAMETER DN Directory Number to lookup .PARAMETER AXLVersion Version of AXL .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .EXAMPLE Get-PhoneServicesByDN -DN 123 -server 'Cucm-Pub.example.com' -Credential (Get-Credential) Get the Phone Services of phone with DN 123 #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $DN, [Parameter(Mandatory = $true)] [string] $server, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $PhoneByDNSplat = @{ DN = $DN server = $server Credential = $Credential EnableException = $EnableException OutputXml = $OutputXml } Get-PhoneByDN @PhoneByDNSplat | Select-Xml -XPath '//service' | Select-Object -ExpandProperty node } function Get-TranslationPattern { <# .SYNOPSIS Get Translation Patten .DESCRIPTION Get Translation Pattern .PARAMETER TranslationPattern Translation Pattern to get .PARAMETER RoutePartitionName Route Partition that the Translation Pattern is a part of. .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .EXAMPLE An example System Up Time: 0d, 0h, 13m #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $TranslationPattern, [string] $RoutePartitionName, [Parameter(Mandatory = $true)] [string] $server, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $invokeCucmAxlSplat = @{ entity = 'getTransPattern' parameters = @{ pattern = $TranslationPattern routePartitionName = $RoutePartitionName } server = $server Credential = $Credential EnableException = $EnableException OutputXml = $OutputXml } Invoke-CucmAxl @invokeCucmAxlSplat } function Invoke-CucmAxl { <# .SYNOPSIS Invoke AXL request against a CUCM server .DESCRIPTION Invoke AXL request against a CUCM server. .PARAMETER entity AXL entity to request .PARAMETER parameters Parameters for the AXL request .PARAMETER AXLVersion Version of AXL .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .EXAMPLE Invoke-CucmAxl -entity 'getPhone' -parameters @{ name = 'SEP000000000000' } -server 'Cucm-Pub.example.com' -Credential (Get-Credential) Invoke getPhone Entity with parameters... #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $entity, [Parameter(Mandatory = $true)] [hashtable] $parameters, [string] $AXLVersion = '11.5', [Parameter(Mandatory = $true)] [string] $server, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $params = '' foreach ($paramKey in $parameters.Keys) { $inner = '' if ($parameters[$paramKey].GetType() -eq [System.Collections.Hashtable]) { $innerHash = $parameters[$paramKey] foreach ($innerKey in $innerHash.Keys) { $inner += '<{0}>{1}</{0}>' -f $innerKey, $innerHash[$innerKey] } } else { $inner = $parameters[$paramKey] } $params += '<{0}>{1}</{0}>' -f $paramKey, $inner } $body = @' <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/{0}"> <soapenv:Header/> <soapenv:Body> <ns:{1}> {2} </ns:{1}> </soapenv:Body> </soapenv:Envelope> '@ -f $AXLVersion, $entity, $params if (-not $OutputXml) { if($PSCmdlet.ShouldProcess($server, "Execute AXL query $entity")) { $CUCMURL = "https://$server/axl/" $headers = @{ 'Content-Type' = 'text/xml; charset=utf-8' } $IRMParams = @{ Headers = $headers Body = $body Uri = $CUCMURL Method = 'Post' Credential = $Credential } if ($PSVersionTable.PSVersion.Major -ge 6) { $IRMParams.SkipCertificateCheck = $true } else { [System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true} } try { Invoke-WebRequest @IRMParams | Select-XML -XPath '//return' | Select-Object -ExpandProperty Node } catch { $ErrorMessage = $_.ErrorDetails.message $PSFMessage = "Failed to execute AXL entity $entity." if (($null -ne $ErrorMessage) -and ($_.Exception.Response.StatusCode -eq 'InternalServerError')) { $axlcode = ($ErrorMessage | select-xml -XPath '//axlcode' | Select-Object -ExpandProperty Node).'#text' $axlMessage = ($ErrorMessage | select-xml -XPath '//axlmessage' | Select-Object -ExpandProperty Node).'#text' $PSFMessage += " AXL Error: $axlMessage ($axlcode)" } Stop-PSFFunction -Message $PSFMessage -ErrorRecord $_ -EnableException $EnableException return } } } else { $body } } function Invoke-CucmSql { <# .SYNOPSIS Invoke a SQL Query against CUCM server using the AXL API .DESCRIPTION Invoke a SQL Query against CUCM server using the AXL API .PARAMETER SqlQuery SQL Query to be run .PARAMETER AXLVersion Version of AXL .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .EXAMPLE Invoke-CucmSql -SqlQuery 'select name from devices where name = "SEP000000000000"' -server 'Cucm-Pub.example.com' -Credential (Get-Credential) Invoke SQL Query against server... #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $SqlQuery, [string] $AXLVersion = '11.5', [Parameter(Mandatory = $true)] [string] $server, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $CucmAxlSplat = @{ server = $server entity = 'executeSQLQuery' parameters = @{ sql = $SqlQuery } AXLVersion = $AXLVersion Credential = $Credential EnableException = $EnableException OutputXml = $OutputXml } Invoke-CucmAxl @CucmAxlSplat } function Set-TranslationPattern { <# .SYNOPSIS Set Translation Patten .DESCRIPTION Set Translation Pattern .PARAMETER TranslationPattern Translation Pattern to set .PARAMETER RoutePartitionName Route Partition that the Translation Pattern is a part of. .PARAMETER calledPartyTransformationMask Transformation Mask .PARAMETER server Server to query .PARAMETER Credential Credential to use for API access .PARAMETER EnableException Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER OutputXml Enable the output of the XML instead of the processing of the entity. .PARAMETER WhatIf What If? .PARAMETER Confirm Confirm... .EXAMPLE An example System Up Time: 0d, 0h, 13m #> [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Low')] param ( [Parameter(Mandatory = $true)] [string] $TranslationPattern, [string] $RoutePartitionName, [string] $calledPartyTransformationMask, [Parameter(Mandatory = $true)] [string] $server, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $EnableException, [switch] $OutputXml ) $invokeCucmAxlSplat = @{ entity = 'updateTransPattern' parameters = @{ pattern = $TranslationPattern } server = $server Credential = $Credential EnableException = $EnableException OutputXml = $OutputXml } if($null -ne $RoutePartitionName) { $invokeCucmAxlSplat.parameters.routePartitionName = $RoutePartitionName } if($null -ne $calledPartyTransformationMask) { $invokeCucmAxlSplat.parameters.calledPartyTransformationMask = $calledPartyTransformationMask } if($PSCmdlet.ShouldProcess($server, "Set Translation Pattern $TranslationPattern")) { Invoke-CucmAxl @invokeCucmAxlSplat } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'PSCUCM' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'PSCUCM' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'PSCUCM' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." <# # Example: Register-PSFTeppScriptblock -Name "PSCUCM.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name PSCUCM.alcohol #> New-PSFLicense -Product 'PSCUCM' -Manufacturer 'corbob' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2018-12-30") -Text @" Copyright (c) 2018 corbob Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "@ #endregion Load compiled code |