lib/Tags.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 |
function Get-TMTag { <# .SYNOPSIS Gets a Tag from TransitionManager .DESCRIPTION This function will retrieve one or more Tags from TransitionManager by name or Id .PARAMETER TMSession The name of the TM Session to use when retrieving a Tag .PARAMETER Server The URI of the TransitionManager instance .PARAMETER AllowInsecureSSL Switch indicating that insecure SSL may be used .PARAMETER ResetIDs Switch indicating that the Tag(s) should be returned without Id's .PARAMETER Name The name of the Tag to be retrieved .PARAMETER Id The Id of the Tag to be retrieved .EXAMPLE Get-TMTag -TMSession 'TMDDEV' -Name 'TestTag' .EXAMPLE $AllTags = Get-TMTag -TMSession 'TMDDEV' .EXAMPLE Get-TMTag -TMSession 'TMDDEV' -Id @(123, 546, 23) .OUTPUTS TMTag object representing the Tag in TransitionManager #> [CmdletBinding(DefaultParameterSetName = 'ByName')] param ( [Parameter(Mandatory = $false)] [String]$TMSession = "Default", [Parameter(Mandatory = $false)] [String]$Server = $global:TMSessions[$TMSession].TMServer, [Parameter(Mandatory = $false)] $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL, [Parameter(Mandatory = $false)] [Switch]$ResetIDs, [Parameter(Mandatory = $false, Position = 0, ValueFromPipeline = $true, ParameterSetName = 'ByName')] [String[]]$Name, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ById')] [Int[]]$Id ) begin { Write-Verbose "ParameterSet = $($PSCmdlet.ParameterSetName)" ## Get Session Configuration $TMSessionConfig = $global:TMSessions[$TMSession] if (-not $TMSessionConfig) { Write-Host 'TMSession: [' -NoNewline Write-Host $TMSession -ForegroundColor Cyan Write-Host '] was not Found. Please use the New-TMSession command.' Throw "TM Session Not Found. Use New-TMSession command before using features." } # Format the request parameters $Instance = $Server.Replace('/tdstm', '').Replace('https://', '').Replace('http://', '') $Uri = "https://$Instance/tdstm/ws/tag" Set-TMHeaderAccept -TMSession $TMSession -Accept 'JSON' $WebRequestSplat = @{ Method = 'GET' Uri = $Uri WebSession = $TMSessionConfig.TMWebSession SkipCertificateCheck = $AllowInsecureSSL } # Make the request try { Write-Verbose "Web Request Parameters:" Write-Verbose ($WebRequestSplat | ConvertTo-Json -Depth 10) Write-Verbose "Invoking web request" $Response = Invoke-WebRequest @WebRequestSplat Write-Verbose "Response status code: $($Response.StatusCode)" Write-Verbose "Response Content: $($Response.Content)" } catch { throw $_ } if ($Response.StatusCode -eq 200) { $Result = ($Response.Content | ConvertFrom-Json -Depth 10).data } else { throw "Couldn't get tag(s)" } } process { ## Sort the tags $Result = $Result | Sort-Object -Property 'name' # Filter the results by the Name(s) passed in if ($Name) { $Result = $Result | Where-Object name -in $Name } # Filter the results by the ID(s) passed in if ($Id) { $Result = $Result | Where-Object id -in $Id } # Remove thew IDs if the ResetIDs switch was passed if ($ResetIDs) { for ($i = 0; $i -lt $Result.Count; $i++) { $Result[$i].id = $null } } $Result | ForEach-Object { [TMTag]::new($_.id, $_.name, $_.description, $_.color) } } } function New-TMTag { <# .SYNOPSIS Creates a new Tag in TransitionManager .DESCRIPTION This function will create a new Tag in TransitionManager .PARAMETER TMSession The name of the TM Session to use when creating a Tag .PARAMETER Server The URI of the TransitionManager instance .PARAMETER AllowInsecureSSL Switch indicating that insecure SSL may be used .PARAMETER Name The name of the Tag to be created .PARAMETER Description The new Tag's description .PARAMETER Color The color of the Tag to be created .PARAMETER InputObject A TMTag object representing the Tag to be created .PARAMETER Passthru Switch indicating that the new Tag should be returned after creation .EXAMPLE $NewTagSplat = @{ Name = 'VM' Description = "This asset is a virtual machine" Color = 'Blue' TMSession = 'TMDDEV' Passthru = $true } New-TMTag @NewTagSplat .EXAMPLE New-TMSession -Credential $Credential -Server 'tmddev.transitionmanager.net' -AllowInsecureSSL $true -SessionName 'TMDDEV' New-TMSession -Credential $Credential -Server 'tmddev2.transitionmanager.net' -AllowInsecureSSL $true -SessionName 'TMDDEV2' Get-TMTag -TMSession TMDDEV2 | New-TMTag -TMSession TMDDEV -Passthru .OUTPUTS If Passthru switch is used, a TMTag object representing the created Tag. Otherwise, none #> [CmdletBinding(DefaultParameterSetName = 'ByProperty')] param ( [Parameter(Mandatory = $false)] [String]$TMSession = "Default", [Parameter(Mandatory = $false)] [String]$Server = $global:TMSessions[$TMSession].TMServer, [Parameter(Mandatory = $false)] $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL, [Parameter(Mandatory = $false, Position = 0, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')] [String]$Name, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')] [String]$Description = "", [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')] [ArgumentCompleter({ [TMTag]::ValidColors })] [ValidateScript( { $_ -in [TMTag]::ValidColors } )] [String]$Color = "Grey", [Parameter(Mandatory = $true, ParameterSetName = 'ByObject')] [TMTag]$InputObject, [Parameter(Mandatory = $false)] [Switch]$Passthru ) begin { Write-Verbose "ParameterSet = $($PSCmdlet.ParameterSetName)" ## Get Session Configuration $TMSessionConfig = $global:TMSessions[$TMSession] if (-not $TMSessionConfig) { Write-Host 'TMSession: [' -NoNewline Write-Host $TMSession -ForegroundColor Cyan Write-Host '] was not Found. Please use the New-TMSession command.' Throw "TM Session Not Found. Use New-TMSession command before using features." } # Format the request parameters $Instance = $Server.Replace('/tdstm', '').Replace('https://', '').Replace('http://', '') $Uri = "https://$Instance/tdstm/ws/tag" Set-TMHeaderAccept -TMSession $TMSession -Accept 'Any' Set-TMHeaderContentType -TMSession $TMSession -ContentType 'JSON' $WebRequestSplat = @{ Method = 'POST' Uri = $Uri WebSession = $TMSessionConfig.TMWebSession SkipCertificateCheck = $AllowInsecureSSL Body = "" } } process { $TagsToAdd = [System.Collections.ArrayList]::new() # Format the object to be sent to TM switch ($PSCmdlet.ParameterSetName) { 'ByObject' { foreach ($Object in $InputObject) { if ([String]::IsNullOrWhiteSpace($Object.Name)) { Write-Error "InputObject does not have a 'Name' property" return } [void]$TagsToAdd.Add([TMTag]::new($Object.Name, $Object.Description, $Object.Color)) } } 'ByProperty' { [void]$TagsToAdd.Add([TMTag]::new($Name, $Description, $Color)) } } # Process each of the tags to add foreach ($Tag in $TagsToAdd) { # Make sure the tag doesn't already exist $TagCheck = Get-TMTag -TMSession $TMSession -Name $Tag.Name if ($TagCheck) { if ($Passthru) { $TagCheck } return } # Make sure the color is valid if ($Tag.Color -notin [TMTag]::ValidColors) { Write-Verbose "Tag '$($Tag.Name)' did not have a valid color, so it has been set to Grey" $Tag.Color = 'Grey' } # Format the body of the request $WebRequestSplat.Body = ($Tag | ConvertTo-Json -Compress) # Make the request try { Write-Verbose "Web Request Parameters:" Write-Verbose ($WebRequestSplat | ConvertTo-Json -Depth 10) Write-Verbose "Invoking web request" $Response = Invoke-WebRequest @WebRequestSplat Write-Verbose "Response status code: $($Response.StatusCode)" Write-Verbose "Response Content: $($Response.Content)" } catch { throw $_ } if ($Response.StatusCode -eq 200) { if ($Passthru) { try { New-Object TMTag -Property ($Response.Content | ConvertFrom-Json).data } catch { Get-TMTag -TMSession $TMSession -Name $Name } } } elseif ($Response.StatusCode -eq 204) { if ($Passthru) { Get-TMTag -TMSession $TMSession -Name $Name } } else { Write-Error "Tag '$Name' could not be created" } } } } function Remove-TMTag { <# .SYNOPSIS Removes a Tag from TransitionManager .DESCRIPTION This function will remove a Tag in TransitionManager by Name or Id .PARAMETER TMSession The TransitionManager session to be used when deleting a Tag .PARAMETER Server The URI of the TransitionManager instance .PARAMETER AllowInsecureSSL Switch indicating that insecure SSL may be used .PARAMETER Name The name of the Tag to be removed .PARAMETER Id The Id of the Tag to be removed .EXAMPLE Get-TMTag -TMSession TMDDEV | Remove-TMTag -TMSession TMDDEV .EXAMPLE Remove-TMTag -Name 'Tag1', 'Tag2' .EXAMPLE Remove-TMTag -Id 489 .OUTPUTS None #> [CmdletBinding(DefaultParameterSetName = 'ByName')] param ( [Parameter(Mandatory = $false)] [String]$TMSession = "Default", [Parameter(Mandatory = $false)] [String]$Server = $global:TMSessions[$TMSession].TMServer, [Parameter(Mandatory = $false)] $AllowInsecureSSL = $global:TMSessions[$TMSession].AllowInsecureSSL, [Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'ByName')] [String[]]$Name, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ById')] [Int[]]$Id ) begin { Write-Verbose "ParameterSet = $($PSCmdlet.ParameterSetName)" ## Get Session Configuration $TMSessionConfig = $global:TMSessions[$TMSession] if (-not $TMSessionConfig) { Write-Host 'TMSession: [' -NoNewline Write-Host $TMSession -ForegroundColor Cyan Write-Host '] was not Found. Please use the New-TMSession command.' Throw "TM Session Not Found. Use New-TMSession command before using features." } # Format the request parameters $Instance = $Server.Replace('/tdstm', '').Replace('https://', '').Replace('http://', '') Set-TMHeaderAccept -TMSession $TMSession -Accept 'Any' } process { $IDsToRemove = [System.Collections.ArrayList]::new() switch ($PSCmdlet.ParameterSetName) { 'ByName' { (Get-TMTag -TMSession $TMSession -Name $Name).id | ForEach-Object { [void]$IDsToRemove.Add($_) } } 'ById' { $Id | ForEach-Object { [void]$IDsToRemove.Add($_) } } } foreach ($TagId in $IDsToRemove) { $WebRequestSplat = @{ Method = 'DELETE' Uri = "https://$Instance/tdstm/ws/tag/$TagId" WebSession = $TMSessionConfig.TMWebSession SkipCertificateCheck = $AllowInsecureSSL } # Make the request try { Write-Verbose "Web Request Parameters:" Write-Verbose ($WebRequestSplat | ConvertTo-Json -Depth 10) Write-Verbose "Invoking web request" $Response = Invoke-WebRequest @WebRequestSplat Write-Verbose "Response status code: $($Response.StatusCode)" Write-Verbose "Response Content: $($Response.Content)" } catch { throw $_ } if ($Response.StatusCode -notin 200, 204) { Write-Error "Tag with Id $TagId could not be removed" } } } } |