Public/Set-UnityHost.ps1
|
Function Set-UnityHost { <# .SYNOPSIS Modify a host configuration. .DESCRIPTION Modify a host configuration. You need to have an active session with the array. .NOTES Written by Erwan Quelin under MIT licence - https://github.com/equelin/Unity-Powershell/blob/master/LICENSE .LINK https://github.com/equelin/Unity-Powershell .PARAMETER Session Specify an UnitySession Object. .PARAMETER Confirm If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for Host confirmation. .PARAMETER WhatIf Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified. .PARAMETER ID Host ID or Object. .EXAMPLE Set-UnityHost -ID 'Host_21' -Name HOST01 Change the name of the host with ID 'Host_21' .EXAMPLE Get-UnityHost -ID 'Host_21' | Set-UnityHost -Name HOST01 Change the name of the host with ID 'Host_21'. The Host's information are provided by the Get-UnityHost through the pipeline. #> [CmdletBinding(SupportsShouldProcess = $True,ConfirmImpact = 'High')] Param ( [Parameter(Mandatory = $false,HelpMessage = 'EMC Unity Session')] $session = ($global:DefaultUnitySession | where-object {$_.IsConnected -eq $true}), [Parameter(Mandatory = $true,Position = 0,ValueFromPipeline=$True,ValueFromPipelinebyPropertyName=$True,HelpMessage = 'Host ID or Object')] [Object[]]$ID, #Host Name. (Applies to manually-created hosts only.) [Parameter(Mandatory = $false,Position = 1,ValueFromPipeline=$True,ValueFromPipelinebyPropertyName=$True,HelpMessage = 'Host Name. (Applies to manually-created hosts only.)')] [String]$Name, #Host Description [Parameter(Mandatory = $false,HelpMessage = 'Host Description')] [String]$Description, #Operating system running on the host. (Applies to manually-created hosts only.) [Parameter(Mandatory = $false,HelpMessage = 'Operating system running on the host. (Applies to manually-created hosts only.)')] [string]$osType ) Begin { Write-Debug -Message "[$($MyInvocation.MyCommand)] Executing function" # Variables $URI = '/api/instances/host/<id>/action/modify' $Type = 'Host' $TypeName = 'UnityHost' $StatusCode = 204 } Process { Foreach ($sess in $session) { Write-Debug -Message "Processing Session: $($sess.Server) with SessionId: $($sess.SessionId)" If ($Sess.TestConnection()) { Foreach ($i in $ID) { # Determine input and convert to object if necessary $Object,$ObjectID,$ObjectName = Get-UnityObject -Data $i -Typename $Typename -Session $Sess If ($ObjectID) { #### REQUEST BODY # Creation of the body hash $body = @{} # Name parameter If ($PSBoundParameters.ContainsKey('name')) { $body["name"] = $name } If ($PSBoundParameters.ContainsKey('description')) { $body["description"] = $description } If ($PSBoundParameters.ContainsKey('osType')) { $body["osType"] = $osType } ####### END BODY - Do not edit beyond this line #Show $body in verbose message $Json = $body | ConvertTo-Json -Depth 10 Write-Verbose $Json #Building the URL $FinalURI = $URI -replace '<id>',$ObjectID $URL = 'https://'+$sess.Server+$FinalURI Write-Verbose "URL: $URL" #Sending the request If ($pscmdlet.ShouldProcess($Sess.Name,"Modify $Type $ObjectName")) { $request = Send-UnityRequest -uri $URL -Session $Sess -Method 'POST' -Body $Body } If ($request.StatusCode -eq $StatusCode) { Write-Verbose "$Type with ID $ObjectID has been modified" Get-UnityHost -Session $Sess -id $ObjectID } # End If ($request.StatusCode -eq $StatusCode) } else { Write-Warning -Message "$Type with ID $i does not exist on the array $($sess.Name)" } # End If ($ObjectID) } # End Foreach ($i in $ID) } # End If ($Sess.TestConnection()) } # End Foreach ($sess in $session) } # End Process } # End Function |