DellOpenManage

3.8.0

Public/OME/Set-OMEChassisSlotName.ps1

using module ..\..\Classes\Device.psm1

function Get-ChassisSlotNamePayload($Slot, $Name, $SlotType, $TargetPayload) {
    $Payload = '{
        "JobName": "Update slot name",
        "JobDescription": "Update slot name",
        "Schedule": "startnow",
        "State": "Enabled",
        "Targets": [
            {
                "Id": 25016,
                "Data": "",
                "TargetType": {
                    "Id": 1000,
                    "Name": "DEVICE"
                }
            }
        ],
        "Params": [
            {
                "Key": "operationName",
                "Value": "UPDATE_SLOT_DATA"
            }
        ],
        "JobType": {
            "Id": 3,
            "Name": "DeviceAction_Task"
        }
    }
    ' | ConvertFrom-Json

    $Payload.Targets = $TargetPayload
    # Add Slot params
    [int]$SlotTypeInt = 1000
    if ($null -eq $SlotType) { $SlotTypeInt = 1000 }
    if ($SlotType -eq "IOM") { $SlotTypeInt = 4000 }
    if ($SlotType -eq "SLED") { $SlotTypeInt = 1000 }
    if ($SlotType -eq "STORAGESLED") { $SlotTypeInt = 2100 }
    $SlotParam = @{
        "Key"   = "slotConfig"
        "Value" = "${Slot}|${SlotTypeInt}|${Name}"
    }
    $Payload.Params += $SlotParam

    return $Payload

}

function Set-OMEChassisSlotName {
    <#
Copyright (c) 2023 Dell EMC Corporation
 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
#>

    <#
.SYNOPSIS
    Set Chassis slot names
.DESCRIPTION
.PARAMETER Chassis
    Object of type Device returned from Get-OMEDevice function. Must be a Chassis device type.
.PARAMETER Slot
    Int to represent the slot number
.PARAMETER Name
    String to represent the slot name
.PARAMETER SlotType
    String to represent the slot type (Default="SLED", "STORAGESLED", "IOM")
.PARAMETER Wait
    Wait for job to complete
.PARAMETER WaitTime
    Time, in seconds, to wait for the job to complete
.INPUTS
    Device
.EXAMPLE
    Set-OMEChassisSlotName -Chassis $("C38V9ZZ" | Get-OMEDevice) -Slot 1 -Name "MX840c-C39N9ZZ" -Wait -Verbose
    Set chassis sled slot name
.EXAMPLE
    Set-OMEChassisSlotName -Chassis $("C38V9ZZ" | Get-OMEDevice) -Slot 4 -Name "MX5016s-C39R9ZZ" -SlotType "STORAGESLED" -Wait -Verbose
    Set chassis storage sled slot name
.EXAMPLE
    Set-OMEChassisSlotName -Chassis $("C38V9ZZ" | Get-OMEDevice) -Slot 1 -Name "MX5108-C38T9ZZ" -SlotType "IOM" -Wait -Verbose
    Set chassis IOM slot name
#>

    [CmdletBinding()]
    param(
        [Parameter(Mandatory, ValueFromPipeline)]
        [Device]$Chassis,

        [Parameter(Mandatory)]
        [int]$Slot,

        [Parameter(Mandatory)]
        [String]$Name,

        [Parameter(Mandatory = $false)]
        [ValidateSet("SLED", "STORAGESLED", "IOM")]
        [String]$SlotType = "SLED",
    
        [Parameter(Mandatory = $false)]
        [Switch]$Wait,

        [Parameter(Mandatory = $false)]
        [int]$WaitTime = 3600
    )

    Begin {}
    Process {
        if (!$(Confirm-IsAuthenticated)) {
            Return
        }
        Try {
            if ($SessionAuth.IgnoreCertificateWarning) { Set-CertPolicy }
            $BaseUri = "https://$($SessionAuth.Host)"
            $JobUrl = $BaseUri + "/api/JobService/Jobs"
            $Type = "application/json"
            $Headers = @{}
            $Headers."X-Auth-Token" = $SessionAuth.Token

            $DeviceIds = @()
            $DeviceIds += $Chassis.Id
            if ($Chassis.Type -eq 2000) {
                $TargetPayload = Get-JobTargetPayload $DeviceIds

                $ChassisSlotNamePayload = Get-ChassisSlotNamePayload -TargetPayload $TargetPayload -Slot $Slot -Name $Name -SlotType $SlotType
                $ChassisSlotNamePayload = $ChassisSlotNamePayload | ConvertTo-Json -Depth 6
                Write-Verbose $ChassisSlotNamePayload
                $JobResponse = Invoke-WebRequest -Uri $JobUrl -UseBasicParsing -Method Post -Body $ChassisSlotNamePayload -ContentType $Type -Headers $Headers
                if ($JobResponse.StatusCode -eq 201) {
                    $JobInfo = $JobResponse.Content | ConvertFrom-Json
                    $JobId = $JobInfo.Id
                    Write-Verbose "Created job $($JobId) to set slot names..."
                    if ($Wait) {
                        $JobStatus = $($JobId | Wait-OnJob -WaitTime $WaitTime)
                        return $JobStatus
                    }
                    else {
                        return $JobId
                    }
                }
                else {
                    Write-Error "Unable to $($State) device..."
                    Write-Error $JobResponse
                    return "Failed"
                }
            } 
            else {
                throw [System.Exception]::new("DeviceException", "Device must be of type Chassis")
            }
        } 
        Catch {
            Resolve-Error $_
        }
    }

    End {}

}