Functions/Public/catalog-service/Set-vRAService.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 |
function Set-vRAService { <# .SYNOPSIS Set a vRA Service .DESCRIPTION Set a vRA Service Currently unsupported interactive actions: * HoursStartTime * HoursEndTime * ChangeWindowDayOfWeek * ChangeWindowStartTime * ChangeWindowEndTime .PARAMETER Id The id of the service .PARAMETER Name The name of the service .PARAMETER Description A description of the service .PARAMETER Status The status of the service .PARAMETER Owner The owner of the service .PARAMETER SupportTeam The support team of the service .PARAMETER IconId The Icon Id of the service. This must already exist in the Service Catalog. Typically it would have already been created via Import-vRAServiceIcon .INPUTS System.String .OUTPUTS System.Management.Automation.PSObject .EXAMPLE Get-vRAService -Name "Default" | Set-vRAService -Owner user@vsphere.local .EXAMPLE Set-vRAService -Id 25c0f3db-5906-4d42-8633-7b05f695432c -Name "Default 1" .EXAMPLE Set-vRAService -Id 25c0f3db-5906-4d42-8633-7b05f695432c -Name "Default 1" -Description "updated from posh" .EXAMPLE Set-vRAService -Id 25c0f3db-5906-4d42-8633-7b05f695432c -Name "Default 1" -Description "updated from posh" -Owner "user@vsphere.local" .EXAMPLE Set-vRAService -Id 25c0f3db-5906-4d42-8633-7b05f695432c -Name "Default 1" -Description "updated from posh" -Owner "user@vsphere.local" -SupportTeam "support@vsphere.local" .EXAMPLE Set-vRAService -Id 25c0f3db-5906-4d42-8633-7b05f695432c -Name "Default 1" -Description "updated from posh" -Owner "user@vsphere.local" -SupportTeam "support@vsphere.local" -Status INACTIVE .EXAMPLE Set-vRAService -Id 25c0f3db-5906-4d42-8633-7b05f695432c -Name "Default 1" -Description "updated from posh" -Owner "user@vsphere.local" -SupportTeam "support@vsphere.local" -Status INACTIVE -IconId "cafe_icon_Service01" #> [CmdletBinding(SupportsShouldProcess,ConfirmImpact="High")][OutputType('System.Management.Automation.PSObject')] Param ( [Parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)] [ValidateNotNullOrEmpty()] [String]$Id, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Name, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Description, [Parameter(Mandatory=$false)] [ValidateSet("ACTIVE","RETIRED")] [String]$Status, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Owner, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$SupportTeam, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$IconId ) Begin { } Process { # --- Check for existing service try { Write-Verbose -Message "Testing for existing service" $URI = "/catalog-service/api/services/$($Id)" $Service = Invoke-vRARestMethod -Method GET -URI $URI } catch [Exception] { throw } if ($PSBoundParameters.ContainsKey("Name")){ Write-Verbose -Message "Updating Name: $($Service.name) >> $($Name)" $Service.name = $Name } if ($PSBoundParameters.ContainsKey("Description")){ Write-Verbose -Message "Updating Description: $($Service.description) >> $($Description)" $Service.description = $Description } if ($PSBoundParameters.ContainsKey("Status")){ Write-Verbose -Message "Updating Status: $($Service.status) >> $($Status)" $Service.status = $Status } if ($PSBoundParameters.ContainsKey("Owner")){ # --- if the service does not have an owner, add one if(-not($Service.owner)) { Write-Verbose -Message "Adding owner principal: $($Owner)" $CatalogPrincipal = Get-vRACatalogPrincipal -Id $Owner $Service | Add-Member -MemberType NoteProperty -Name "owner" -Value $catalogPrincipal } else { Write-Verbose -Message "Updating Owner: $($Service.owner.ref) >> $($Owner)" $Service.owner.ref = $Owner } } if ($PSBoundParameters.ContainsKey("SupportTeam")){ # --- if the service does not have an support team, add one if(-not($Service.supportTeam)) { Write-Verbose -Message "Adding support team principal: $($SupportTeam)" $CatalogPrincipal = Get-vRACatalogPrincipal -Id $SupportTeam $Service | Add-Member -MemberType NoteProperty -Name "supportTeam" -Value $catalogPrincipal } else { Write-Verbose -Message "Updating Support Team: $($Service.supportTeam.ref) >> $($SupportTeam)" $Service.supportTeam.ref = $SupportTeam } } if ($PSBoundParameters.ContainsKey("IconId")){ Write-Verbose -Message "Updating IconId: $($Service.iconId) >> $($IconId)" $Service.iconId = $IconId } # --- Update the existing service try { if ($PSCmdlet.ShouldProcess($Service.Name)){ # --- Build the URI string for the service $URI = "/catalog-service/api/services/$($Id)" Invoke-vRARestMethod -Method PUT -URI $URI -Body ($Service | ConvertTo-Json -Compress) -Verbose:$VerbosePreference | Out-Null Get-vRAService -Id $Id } } catch [Exception] { throw } } End { } } |