diff --git a/CHANGELOG.md b/CHANGELOG.md index b7600d5..c80746d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [3.7.0]() - 2023- +## [3.7.0]() - 2023-10-27 ### Added - Get-OMEProfile - Remove-OMEProfile @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - Update-OMEConfiguration added -UpdateSchedule parameter with the option to "StageForNextReboot" or "RebootNow" +- Invoke-OMEProfileUnassign added -ForceReclaim parameter ## [3.6.2]() - 2023-09-08 ### Fixed diff --git a/DellOpenManage/DellOpenManage.psd1 b/DellOpenManage/DellOpenManage.psd1 index be2113c..43a7b73 100644 --- a/DellOpenManage/DellOpenManage.psd1 +++ b/DellOpenManage/DellOpenManage.psd1 @@ -3,7 +3,7 @@ # # Generated by: Trevor Squillario # -# Generated on: 9/8/2023 +# Generated on: 10/27/2023 # @{ @@ -12,7 +12,7 @@ RootModule = 'DellOpenManage.psm1' # Version number of this module. -ModuleVersion = '3.6.2' +ModuleVersion = '3.7.0' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/DellOpenManage/Private/New-ProfileFromJson.ps1 b/DellOpenManage/Private/New-ProfileFromJson.ps1 index 33ca58e..86335af 100755 --- a/DellOpenManage/Private/New-ProfileFromJson.ps1 +++ b/DellOpenManage/Private/New-ProfileFromJson.ps1 @@ -1,38 +1,38 @@ using module ..\Classes\Profile.psm1 function New-ProfileFromJson { Param( - [PSCustomObject]$Profile + [PSCustomObject]$ServerProfile ) $LastDeployDate = $null - if ($Profile.LastDeployDate -eq "") { + if ($ServerProfile.LastDeployDate -eq "") { $LastDeployDate = $null } else { - $LastDeployDate = $Profile.LastDeployDate + $LastDeployDate = $ServerProfile.LastDeployDate } $ProfileObj = [Profile]@{ - Id = $Profile.Id - ProfileName = $Profile.ProfileName - ProfileDescription = $Profile.ProfileDescription - TemplateId = $Profile.TemplateId - TemplateName = $Profile.TemplateName - DataSchemaId = $Profile.DataSchemaId - TargetId = $Profile.TargetId - TargetName = $Profile.TargetName - TargetTypeId = $Profile.TargetTypeId - DeviceIdInSlot = $Profile.DeviceIdInSlot - ChassisId = $Profile.ChassisId - ChassisName = $Profile.ChassisName - GroupId = $Profile.GroupId - GroupName = $Profile.GroupName - NetworkBootToIso = $Profile.NetworkBootToIso - ProfileState = $Profile.ProfileState - DeploymentTaskId = $Profile.DeploymentTaskId - LastRunStatus = $Profile.LastRunStatus - ProfileModified = $Profile.ProfileModified - CreatedBy = $Profile.CreatedBy - EditedBy = $Profile.EditedBy - CreatedDate = $Profile.CreatedDate - LastEditDate = $Profile.LastEditDate + Id = $ServerProfile.Id + ProfileName = $ServerProfile.ProfileName + ProfileDescription = $ServerProfile.ProfileDescription + TemplateId = $ServerProfile.TemplateId + TemplateName = $ServerProfile.TemplateName + DataSchemaId = $ServerProfile.DataSchemaId + TargetId = $ServerProfile.TargetId + TargetName = $ServerProfile.TargetName + TargetTypeId = $ServerProfile.TargetTypeId + DeviceIdInSlot = $ServerProfile.DeviceIdInSlot + ChassisId = $ServerProfile.ChassisId + ChassisName = $ServerProfile.ChassisName + GroupId = $ServerProfile.GroupId + GroupName = $ServerProfile.GroupName + NetworkBootToIso = $ServerProfile.NetworkBootToIso + ProfileState = $ServerProfile.ProfileState + DeploymentTaskId = $ServerProfile.DeploymentTaskId + LastRunStatus = $ServerProfile.LastRunStatus + ProfileModified = $ServerProfile.ProfileModified + CreatedBy = $ServerProfile.CreatedBy + EditedBy = $ServerProfile.EditedBy + CreatedDate = $ServerProfile.CreatedDate + LastEditDate = $ServerProfile.LastEditDate LastDeployDate = $LastDeployDate } return $ProfileObj diff --git a/DellOpenManage/Public/OME/Get-OMEProfile.ps1 b/DellOpenManage/Public/OME/Get-OMEProfile.ps1 index 6a42938..fdc45e1 100755 --- a/DellOpenManage/Public/OME/Get-OMEProfile.ps1 +++ b/DellOpenManage/Public/OME/Get-OMEProfile.ps1 @@ -92,8 +92,8 @@ Process { if ($ProfileResponse.StatusCode -eq 200) { $ProfileCountData = $ProfileResponse.Content | ConvertFrom-Json - foreach ($Profile in $ProfileCountData.'value') { - $ProfileData += New-ProfileFromJson -Profile $Profile + foreach ($ServerProfile in $ProfileCountData.'value') { + $ProfileData += New-ProfileFromJson -ServerProfile $ServerProfile } if($ProfileCountData.'@odata.nextLink') { @@ -106,8 +106,8 @@ Process { if($NextLinkResponse.StatusCode -eq 200) { $NextLinkData = $NextLinkResponse.Content | ConvertFrom-Json - foreach ($Profile in $NextLinkData.'value') { - $ProfileData += New-ProfileFromJson -Profile $Profile + foreach ($ServerProfile in $NextLinkData.'value') { + $ProfileData += New-ProfileFromJson -ServerProfile $ServerProfile } if($NextLinkData.'@odata.nextLink') { diff --git a/DellOpenManage/Public/OME/Invoke-OMEDeviceReseat.ps1 b/DellOpenManage/Public/OME/Invoke-OMEDeviceReseat.ps1 index bfec1ff..c6b0775 100755 --- a/DellOpenManage/Public/OME/Invoke-OMEDeviceReseat.ps1 +++ b/DellOpenManage/Public/OME/Invoke-OMEDeviceReseat.ps1 @@ -64,17 +64,15 @@ limitations under the License. .DESCRIPTION This will submit a job to do a virtual reseat on a Compute device in an MX Chassis .PARAMETER Name - Name of the inventory refresh job + Name of the job .PARAMETER Devices Array of type Device returned from Get-OMEDevice function. .INPUTS Device .EXAMPLE - "PowerEdge R640" | Get-OMEDevice -FilterBy "Model" | Invoke-OMEInventoryRefresh -Verbose - Create separate inventory refresh job for each device in list -.EXAMPLE - ,$("PowerEdge R640" | Get-OMEDevice -FilterBy "Model") | Invoke-OMEInventoryRefresh -Verbose - Create one inventory refresh job for all devices in list. Notice the preceeding comma before the device list. + "933NCZZ" | Get-OMEDevice | Invoke-OMEDeviceReseat -Verbose -Wait + + Trigger virtual system reseat #> [CmdletBinding()] diff --git a/DellOpenManage/Public/OME/Invoke-OMEProfileAssign.ps1 b/DellOpenManage/Public/OME/Invoke-OMEProfileAssign.ps1 index 2953eac..f65b60d 100755 --- a/DellOpenManage/Public/OME/Invoke-OMEProfileAssign.ps1 +++ b/DellOpenManage/Public/OME/Invoke-OMEProfileAssign.ps1 @@ -19,49 +19,52 @@ limitations under the License. <# .SYNOPSIS - Unassign profile from device in OpenManage Enterprise + Assign profile to device in OpenManage Enterprise .DESCRIPTION - This action will unassign the profile(s) from all selected targets, disassociating the profile(s) from target(s). - The server will be forcefully rebooted in order to remove any deployed identities from applicable devices. - As of OME 3.4 only one template can be associated to a device. However, you can deploy a template to multiple devices. -.PARAMETER Template - Object of type Template returned from Get-OMETemplate function -.PARAMETER Device - Array of type Device returned from Get-OMEDevice function -.PARAMETER ProfileName - Name of Profile to detach. Uses contains style operator and supports partial string matching. + This action will assign the profile to a chassis slot or directly to a device. +.PARAMETER ServerProfile + Object of type Profile returned from Get-OMEProfile function +.PARAMETER TargetId + Integer representing the SlotId for Slot based deployment or DeviceId for device based deployment. +.PARAMETER AttachAndApply + Immediately Apply To Compute Sleds. Only applies to Slot based assignments. ***This will force a reseat of the sled*** +.PARAMETER NetworkBootShareType + Share type ("NFS", "CIFS") +.PARAMETER NetworkBootShareIpAddress + IP Address of the share server +.PARAMETER NetworkBootIsoPath + Full path to the ISO +.PARAMETER NetworkBootIsoTimeout + Lifecycle Controller timeout setting (Default=1) Hour +.PARAMETER NetworkBootShareName + Share name (CIFS Only) +.PARAMETER NetworkBootShareUser + Share user (CIFS Only) +.PARAMETER NetworkBootShareWorkGroup + Share workgroup (CIFS Only) +.PARAMETER NetworkBootSharePassword + Share password (CIFS Only) .PARAMETER Wait Wait for job to complete .PARAMETER WaitTime Time, in seconds, to wait for the job to complete .INPUTS - Device + [Profile] $ServerProfile .EXAMPLE - Invoke-OMEProfileUnassign -Device $("37KP0ZZ" | Get-OMEDevice) -Wait -Verbose - - Unassign profile by device -.EXAMPLE - $("37KP0ZZ", "37KT0ZZ" | Get-OMEDevice) | Invoke-OMEProfileUnassign -Wait -Verbose - - Unassign profile on multiple device -.EXAMPLE - Invoke-OMEProfileUnassign -Template $("TestTemplate01" | Get-OMETemplate) -Wait -Verbose - - Unassign profile by template -.EXAMPLE - Invoke-OMEProfileUnassign -ProfileName "Profile from template 'TestTemplate01' 00001" -Wait -Verbose - - Unassign profile by profile name + See README for examples #> [CmdletBinding()] param( [Parameter(Mandatory, ValueFromPipeline)] - [Profile] $Profile, + [Profile] $ServerProfile, [Parameter(Mandatory)] [Int] $TargetId, + [Parameter(Mandatory=$false)] + [Switch]$AttachAndApply, + [Parameter(Mandatory=$false)] [ValidateSet("CIFS", "NFS")] [String]$NetworkBootShareType, @@ -110,6 +113,7 @@ Process { $ProfileAssignPayload = '{ "Id": 10079, "TargetId": 10087, + "AttachAndApply": false, "NetworkBootToIso": { "BootToNetwork": false, "ShareType": "CIFS", @@ -135,8 +139,12 @@ Process { } }' | ConvertFrom-Json - $ProfileAssignPayload.Id = $Profile.Id + $ProfileAssignPayload.Id = $ServerProfile.Id $ProfileAssignPayload.TargetId = $TargetId + + if ($AttachAndApply) { + $ProfileAssignPayload.AttachAndApply = $true + } if ($TargetId -eq 0) { throw [System.ArgumentNullException] "TargetId" } if ($NetworkBootShareType -ne "") { diff --git a/DellOpenManage/Public/OME/Invoke-OMEProfileRename.ps1 b/DellOpenManage/Public/OME/Invoke-OMEProfileRename.ps1 index bc0f2bd..37221f1 100755 --- a/DellOpenManage/Public/OME/Invoke-OMEProfileRename.ps1 +++ b/DellOpenManage/Public/OME/Invoke-OMEProfileRename.ps1 @@ -22,7 +22,7 @@ limitations under the License. Rename profile .DESCRIPTION Rename existing profile -.PARAMETER Profile +.PARAMETER ServerProfile Object of type Profile returned from Get-OMEProfile .INPUTS [Profile] Profile @@ -39,7 +39,7 @@ limitations under the License. [CmdletBinding()] param( [Parameter(Mandatory, ValueFromPipeline)] - [Profile]$Profile, + [Profile]$ServerProfile, [Parameter(Mandatory)] [String]$Name @@ -62,7 +62,7 @@ Process { "Name": "Edit_Profile_Name" }' | ConvertFrom-Json - $Payload.ProfileId = $Profile.Id + $Payload.ProfileId = $ServerProfile.Id $Payload.Name = $Name $ProfileRenameURL = $BaseUri + "/api/ProfileService/Actions/ProfileService.Rename" diff --git a/DellOpenManage/Public/OME/Invoke-OMEProfileUnassign.ps1 b/DellOpenManage/Public/OME/Invoke-OMEProfileUnassign.ps1 index ec5344c..13df77e 100644 --- a/DellOpenManage/Public/OME/Invoke-OMEProfileUnassign.ps1 +++ b/DellOpenManage/Public/OME/Invoke-OMEProfileUnassign.ps1 @@ -31,6 +31,8 @@ limitations under the License. Array of type Device returned from Get-OMEDevice function .PARAMETER ProfileName Name of Profile to detach. Uses contains style operator and supports partial string matching. +.PARAMETER ForceReclaim + Force Reclaim Identities. This action will reclaim the identities from this device and the server will be forcefully rebooted. All VLANs configured on the server will be removed. .PARAMETER Wait Wait for job to complete .PARAMETER WaitTime @@ -66,6 +68,9 @@ param( [Parameter(Mandatory=$false)] [String]$ProfileName, + [Parameter(Mandatory=$false)] + [Switch]$ForceReclaim, + [Parameter(Mandatory=$false)] [Switch]$Wait, @@ -88,7 +93,8 @@ Process { $ProfileUnassignUrl = $BaseUri + "/api/ProfileService/Actions/ProfileService.UnassignProfiles" $ProfileUnassignPayload = '{ "SelectAll":true, - "Filters":"=contains()" + "Filters":"=contains()", + "ForceReclaim":false }' | ConvertFrom-Json if ($Device) { @@ -100,6 +106,11 @@ Process { } else { throw [System.Exception] "You must specify one of the following parameters: -Device -Template -ProfileName" } + + if ($ForceReclaim) { + $ProfileUnassignPayload.ForceReclaim = $true + } + $ProfileUnassignPayload = $ProfileUnassignPayload |ConvertTo-Json -Depth 6 Write-Verbose $ProfileUnassignPayload Try { # Workaround to capture 400 (Bad Request) error when trying to unassign profile without target device found diff --git a/DellOpenManage/Public/OME/New-OMEProfile.ps1 b/DellOpenManage/Public/OME/New-OMEProfile.ps1 index 0f264dc..14aff4e 100755 --- a/DellOpenManage/Public/OME/New-OMEProfile.ps1 +++ b/DellOpenManage/Public/OME/New-OMEProfile.ps1 @@ -47,9 +47,13 @@ limitations under the License. .INPUTS [Template] Template .EXAMPLE - New-OMEProfile -Name "Test Profile 01" + "Test Template 01" | Get-OMETemplate | New-OMEProfile -NamePrefix "Test Profile" -NumberOfProfilesToCreate 3 - Create a new static Profile + Create a new Profile from a Template +.EXAMPLE + "Test Template 01" | Get-OMETemplate | New-OMEProfile -NamePrefix "Test Profile" -NumberOfProfilesToCreate 3 -NetworkBootShareType "NFS" -NetworkBootShareIpAddress "192.168.1.100" -NetworkBootIsoPath "/mnt/data/iso/OS.iso" -Verbose + + Create a new Profile from a Template and mount ISO from NFS share to Virtual Media #> [CmdletBinding()] diff --git a/DellOpenManage/Public/OME/Remove-OMEProfile.ps1 b/DellOpenManage/Public/OME/Remove-OMEProfile.ps1 index 44f0bbf..84c434f 100755 --- a/DellOpenManage/Public/OME/Remove-OMEProfile.ps1 +++ b/DellOpenManage/Public/OME/Remove-OMEProfile.ps1 @@ -22,7 +22,7 @@ limitations under the License. Remove Profile .DESCRIPTION Remove Profile -.PARAMETER Profile +.PARAMETER ServerProfile Object of type Profile returned from Get-OMEProfile .INPUTS None @@ -35,7 +35,7 @@ limitations under the License. [CmdletBinding()] param( [Parameter(Mandatory, ValueFromPipeline)] - [Profile] $Profile + [Profile] $ServerProfile ) Begin {} @@ -46,7 +46,7 @@ Process { Try { if ($SessionAuth.IgnoreCertificateWarning) { Set-CertPolicy } $BaseUri = "https://$($SessionAuth.Host)" - $RemoveUrl = $BaseUri + "/api/ProfileService/Profiles($($Profile.Id))" + $RemoveUrl = $BaseUri + "/api/ProfileService/Profiles($($ServerProfile.Id))" $Type = "application/json" $Headers = @{} $Headers."X-Auth-Token" = $SessionAuth.Token diff --git a/Documentation/CommandReference.md b/Documentation/CommandReference.md index 3d911f4..f78ba10 100644 --- a/Documentation/CommandReference.md +++ b/Documentation/CommandReference.md @@ -34,6 +34,7 @@ - [Get-OMEJob](Functions/Get-OMEJob.md) - [Get-OMEMXDomain](Functions/Get-OMEMXDomain.md) - [Get-OMENetwork](Functions/Get-OMENetwork.md) +- [Get-OMEProfile](Functions/Get-OMEProfile.md) - [Get-OMEReport](Functions/Get-OMEReport.md) - [Get-OMERole](Functions/Get-OMERole.md) - [Get-OMESupportAssistCase](Functions/Get-OMESupportAssistCase.md) @@ -44,6 +45,7 @@ - [Get-OMEWarranty](Functions/Get-OMEWarranty.md) - [Invoke-OMEApplianceBackup](Functions/Invoke-OMEApplianceBackup.md) - [Invoke-OMEConfigurationBaselineRefresh](Functions/Invoke-OMEConfigurationBaselineRefresh.md) +- [Invoke-OMEDeviceReseat](Functions/Invoke-OMEDeviceReseat.md) - [Invoke-OMEDirectoryServiceImportGroup](Functions/Invoke-OMEDirectoryServiceImportGroup.md) - [Invoke-OMEFirmwareBaselineRefresh](Functions/Invoke-OMEFirmwareBaselineRefresh.md) - [Invoke-OMEInventoryRefresh](Functions/Invoke-OMEInventoryRefresh.md) @@ -52,6 +54,8 @@ - [Invoke-OMEMcmGroupAssignBackupLead](Functions/Invoke-OMEMcmGroupAssignBackupLead.md) - [Invoke-OMEMcmGroupRetireLead](Functions/Invoke-OMEMcmGroupRetireLead.md) - [Invoke-OMEOnboarding](Functions/Invoke-OMEOnboarding.md) +- [Invoke-OMEProfileAssign](Functions/Invoke-OMEProfileAssign.md) +- [Invoke-OMEProfileRename](Functions/Invoke-OMEProfileRename.md) - [Invoke-OMEProfileUnassign](Functions/Invoke-OMEProfileUnassign.md) - [Invoke-OMEQuickDeploy](Functions/Invoke-OMEQuickDeploy.md) - [Invoke-OMEReport](Functions/Invoke-OMEReport.md) @@ -69,6 +73,7 @@ - [New-OMEIdentityPool](Functions/New-OMEIdentityPool.md) - [New-OMEMcmGroup](Functions/New-OMEMcmGroup.md) - [New-OMENetwork](Functions/New-OMENetwork.md) +- [New-OMEProfile](Functions/New-OMEProfile.md) - [New-OMESupportAssistGroup](Functions/New-OMESupportAssistGroup.md) - [New-OMETemplateFromDevice](Functions/New-OMETemplateFromDevice.md) - [New-OMETemplateFromFile](Functions/New-OMETemplateFromFile.md) @@ -80,6 +85,7 @@ - [Remove-OMEFirmwareBaseline](Functions/Remove-OMEFirmwareBaseline.md) - [Remove-OMEGroup](Functions/Remove-OMEGroup.md) - [Remove-OMENetwork](Functions/Remove-OMENetwork.md) +- [Remove-OMEProfile](Functions/Remove-OMEProfile.md) - [Remove-OMESupportAssistGroup](Functions/Remove-OMESupportAssistGroup.md) - [Remove-OMETemplate](Functions/Remove-OMETemplate.md) - [Remove-OMEUser](Functions/Remove-OMEUser.md) @@ -369,6 +375,31 @@ - VirtualFipMacAddress (string VirtualFipMacAddress {get;set;}) - VirtualIscsiMacAddress (string VirtualIscsiMacAddress {get;set;}) - VirtualMacAddress (string VirtualMacAddress {get;set;}) +## Profile +- ChassisId (int ChassisId {get;set;}) +- ChassisName (string ChassisName {get;set;}) +- CreatedBy (string CreatedBy {get;set;}) +- CreatedDate (datetime CreatedDate {get;set;}) +- DataSchemaId (int DataSchemaId {get;set;}) +- DeploymentTaskId (int DeploymentTaskId {get;set;}) +- DeviceIdInSlot (int DeviceIdInSlot {get;set;}) +- EditedBy (string EditedBy {get;set;}) +- GroupId (int GroupId {get;set;}) +- GroupName (string GroupName {get;set;}) +- Id (int Id {get;set;}) +- LastDeployDate (System.Nullable[datetime] LastDeployDate {get;set;}) +- LastEditDate (datetime LastEditDate {get;set;}) +- LastRunStatus (int LastRunStatus {get;set;}) +- NetworkBootToIso (psobject NetworkBootToIso {get;set;}) +- ProfileDescription (string ProfileDescription {get;set;}) +- ProfileModified (int ProfileModified {get;set;}) +- ProfileName (string ProfileName {get;set;}) +- ProfileState (int ProfileState {get;set;}) +- TargetId (int TargetId {get;set;}) +- TargetName (string TargetName {get;set;}) +- TargetTypeId (int TargetTypeId {get;set;}) +- TemplateId (int TemplateId {get;set;}) +- TemplateName (string TemplateName {get;set;}) ## Repository - CheckCertificate (bool CheckCertificate {get;set;}) - Description (string Description {get;set;}) diff --git a/Documentation/Functions/Get-OMEProfile.md b/Documentation/Functions/Get-OMEProfile.md new file mode 100755 index 0000000..9518848 --- /dev/null +++ b/Documentation/Functions/Get-OMEProfile.md @@ -0,0 +1,90 @@ +--- +external help file: DellOpenManage-help.xml +Module Name: DellOpenManage +online version: +schema: 2.0.0 +--- + +# Get-OMEProfile + +## SYNOPSIS +Get Profiles managed by OpenManage Enterprise + +## SYNTAX + +``` +Get-OMEProfile [[-Value] ] [[-FilterBy] ] [] +``` + +## DESCRIPTION +Get Profiles. +Returns all Profiles if no input received. + +## EXAMPLES + +### EXAMPLE 1 +``` +"ProfileName" | Get-OMEProfile +``` + +Get Profile by ProfileName + +### EXAMPLE 2 +``` +Get-OMEProfile | Where-Object { $_.ProfileName -eq "Profile from template 'Test Template 01' 00001" } +``` + +Get Profile by ProfileName where ProfileName includes single quotes. +Use for Profiles deployed from Templates on the MX platform + +### EXAMPLE 3 +``` +"TemplateName" | Get-OMEProfile -FilterBy TemplateName +``` + +Get Profile by TemplateName + +## PARAMETERS + +### -Value +String containing search value. +Use with -FilterBy parameter + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FilterBy +Filter the results by (Default="ServiceTag", "Name", "Id", "Model", "Type") + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: Name +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### String[] +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/Documentation/Functions/Invoke-OMEDeviceReseat.md b/Documentation/Functions/Invoke-OMEDeviceReseat.md new file mode 100755 index 0000000..4be72f3 --- /dev/null +++ b/Documentation/Functions/Invoke-OMEDeviceReseat.md @@ -0,0 +1,104 @@ +--- +external help file: DellOpenManage-help.xml +Module Name: DellOpenManage +online version: +schema: 2.0.0 +--- + +# Invoke-OMEDeviceReseat + +## SYNOPSIS +Virtual reseat device in OpenManage Enterprise + +## SYNTAX + +``` +Invoke-OMEDeviceReseat [[-Name] ] [[-Devices] ] [-Wait] [[-WaitTime] ] + [] +``` + +## DESCRIPTION +This will submit a job to do a virtual reseat on a Compute device in an MX Chassis + +## EXAMPLES + +### EXAMPLE 1 +``` +"933NCZZ" | Get-OMEDevice | Invoke-OMEDeviceReseat -Verbose -Wait +``` + +Trigger virtual system reseat + +## PARAMETERS + +### -Name +Name of the job + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: "Virtual Reseat $((Get-Date).ToString('yyyyMMddHHmmss'))" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Devices +Array of type Device returned from Get-OMEDevice function. + +```yaml +Type: Device[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Wait +{{ Fill Wait Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitTime +{{ Fill WaitTime Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 3600 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Device +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/Documentation/Functions/Invoke-OMEProfileAssign.md b/Documentation/Functions/Invoke-OMEProfileAssign.md new file mode 100755 index 0000000..d1462ca --- /dev/null +++ b/Documentation/Functions/Invoke-OMEProfileAssign.md @@ -0,0 +1,242 @@ +--- +external help file: DellOpenManage-help.xml +Module Name: DellOpenManage +online version: +schema: 2.0.0 +--- + +# Invoke-OMEProfileAssign + +## SYNOPSIS +Assign profile to device in OpenManage Enterprise + +## SYNTAX + +``` +Invoke-OMEProfileAssign [-ServerProfile] [-TargetId] [-AttachAndApply] + [[-NetworkBootShareType] ] [[-NetworkBootShareIpAddress] ] [[-NetworkBootIsoPath] ] + [[-NetworkBootIsoTimeout] ] [[-NetworkBootShareName] ] [[-NetworkBootShareUser] ] + [[-NetworkBootShareWorkGroup] ] [[-NetworkBootSharePassword] ] [-Wait] + [[-WaitTime] ] [] +``` + +## DESCRIPTION +This action will assign the profile to a chassis slot or directly to a device. + +## EXAMPLES + +### EXAMPLE 1 +``` +See README for examples +``` + +## PARAMETERS + +### -ServerProfile +Object of type Profile returned from Get-OMEProfile function + +```yaml +Type: Profile +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TargetId +Integer representing the SlotId for Slot based deployment or DeviceId for device based deployment. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachAndApply +Immediately Apply To Compute Sleds. +Only applies to Slot based assignments. +***This will force a reseat of the sled*** + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootShareType +Share type ("NFS", "CIFS") + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootShareIpAddress +IP Address of the share server + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootIsoPath +Full path to the ISO + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootIsoTimeout +Lifecycle Controller timeout setting (Default=1) Hour + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootShareName +Share name (CIFS Only) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootShareUser +Share user (CIFS Only) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootShareWorkGroup +Share workgroup (CIFS Only) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBootSharePassword +Share password (CIFS Only) + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for job to complete + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitTime +Time, in seconds, to wait for the job to complete + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: 3600 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [Profile] $ServerProfile +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/Documentation/Functions/Invoke-OMEProfileRename.md b/Documentation/Functions/Invoke-OMEProfileRename.md new file mode 100755 index 0000000..c470a2c --- /dev/null +++ b/Documentation/Functions/Invoke-OMEProfileRename.md @@ -0,0 +1,80 @@ +--- +external help file: DellOpenManage-help.xml +Module Name: DellOpenManage +online version: +schema: 2.0.0 +--- + +# Invoke-OMEProfileRename + +## SYNOPSIS +Rename profile + +## SYNTAX + +``` +Invoke-OMEProfileRename [-ServerProfile] [-Name] [] +``` + +## DESCRIPTION +Rename existing profile + +## EXAMPLES + +### EXAMPLE 1 +``` +"Profile 00005" | Get-OMEProfile | Invoke-OMEProfileRename -Name "Test Profile 00005" +``` + +Rename Profile + +### EXAMPLE 2 +``` +Get-OMEProfile | Where-Object { $_.ProfileName -eq "Profile from template 'Test Template 01' 00001" } | Invoke-OMEProfileRename -Name "Test Profile 01 - 00001" +``` + +Rename Profile deployed from Template on MX platform + +## PARAMETERS + +### -ServerProfile +Object of type Profile returned from Get-OMEProfile + +```yaml +Type: Profile +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [Profile] Profile +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/Documentation/Functions/Invoke-OMEProfileUnassign.md b/Documentation/Functions/Invoke-OMEProfileUnassign.md index 8784cff..04cf183 100644 --- a/Documentation/Functions/Invoke-OMEProfileUnassign.md +++ b/Documentation/Functions/Invoke-OMEProfileUnassign.md @@ -13,8 +13,8 @@ Unassign profile from device in OpenManage Enterprise ## SYNTAX ``` -Invoke-OMEProfileUnassign [[-Device] ] [[-Template]