update documentation

dell · Sep 15, 2021 · ea137bd · ea137bd
1 parent 138aa5e
commit ea137bd
Show file tree

Hide file tree

Showing 16 changed files with 632 additions and 73 deletions.
diff --git a/DellOpenManage/Public/OME/Edit-OMESupportAssistGroup.ps1 b/DellOpenManage/Public/OME/Edit-OMESupportAssistGroup.ps1
@@ -50,15 +50,15 @@ limitations under the License.
 
     Edit Support Assist group from json stored in variable
 .EXAMPLE
-    Get-OMEGroup "Test Group 01" | Edit-OMEGroup -EditGroup $(Get-Content "C:\Temp\Group.json" -Raw)
+    Get-OMEGroup "Test Group 01" | Edit-OMESupportAssistGroup -EditGroup $(Get-Content "C:\Temp\Group.json" -Raw)
 
     Edit Support Assist group from json stored in file
 .EXAMPLE
-    Get-OMEGroup "Test Group 01" | Edit-OMEGroup -Devices $("PowerEdge R640" | Get-OMEDevice -FilterBy "Model")
+    Get-OMEGroup "Test Group 01" | Edit-OMESupportAssistGroup -Devices $("PowerEdge R640" | Get-OMEDevice -FilterBy "Model")
 
     Add devices to group
 .EXAMPLE
-    Get-OMEGroup "Test Group 01" | Edit-OMEGroup -Mode "Remove" -Devices $("PowerEdge R640" | Get-OMEDevice -FilterBy "Model")
+    Get-OMEGroup "Test Group 01" | Edit-OMESupportAssistGroup -Mode "Remove" -Devices $("PowerEdge R640" | Get-OMEDevice -FilterBy "Model")
     
     Remove devices from group
 #>

diff --git a/DellOpenManage/Public/OME/Get-OMEAlertDefinition.ps1 b/DellOpenManage/Public/OME/Get-OMEAlertDefinition.ps1
@@ -32,9 +32,7 @@ limitations under the License.
     Group[]
     String[]
 .EXAMPLE
-    Get-OMEDevice -Value 12016
-    
-    Get device by Id
+    Get-OMEAlertDefinition
 #>
 
 [CmdletBinding()]

diff --git a/DellOpenManage/Public/OME/Get-OMEWarranty.ps1 b/DellOpenManage/Public/OME/Get-OMEWarranty.ps1
@@ -28,13 +28,9 @@ function Get-OMEWarranty {
     .INPUTS
         String[]
     .EXAMPLE
-        Get-OMEUser | Format-Table
+        Get-OMEWarranty | Format-Table
 
-        List all users
-    .EXAMPLE
-        "admin" | Get-OMEUser
-        
-        Get user by name
+        List all warranty details
     #>
 
     [CmdletBinding()]

diff --git a/DellOpenManage/Public/OME/Invoke-OMEMcmGroupAddMember.ps1 b/DellOpenManage/Public/OME/Invoke-OMEMcmGroupAddMember.ps1
@@ -23,7 +23,7 @@ function Invoke-OMEMcmGroupAddMember {
        Add all possible members to MCM Group
     
      .DESCRIPTION
-       This script uses the OME REST API to create mcm group, find memebers and add the members to the group.
+       This script uses the OME REST API to add all available chassis to the MCM Group
     
      .PARAMETER GroupName
        The Name of the MCM Group.

diff --git a/DellOpenManage/Public/OME/Invoke-OMEMcmGroupAssignBackupLead.ps1 b/DellOpenManage/Public/OME/Invoke-OMEMcmGroupAssignBackupLead.ps1
@@ -23,14 +23,20 @@ function Invoke-OMEMcmGroupAssignBackupLead {
        Assign backup lead chassis to MCM Group
     
      .DESCRIPTION
-       This script uses the OME REST API to create mcm group, find memebers and add the members to the group.
+       This script uses the OME REST API to add a backup lead chassis
     
      .PARAMETER ServiceTag
        Service Tag of chassis to assign as backup lead
     
      .EXAMPLE
        Invoke-OMEMcmGroupAssignBackupLead -Wait
+
+       Assign backup lead to random chassis
     
+     .EXAMPLE
+       Invoke-OMEMcmGroupAssignBackupLead -ServiceTag "XYZ1234" -Wait
+
+       Assign backup lead to specific chassis
     #>
     [CmdletBinding()]
     param(

diff --git a/DellOpenManage/Public/OME/Invoke-OMEMcmGroupRetireLead.ps1 b/DellOpenManage/Public/OME/Invoke-OMEMcmGroupRetireLead.ps1
@@ -66,10 +66,10 @@ function Invoke-OMEMcmGroupRetireLead {
 
     <#
      .SYNOPSIS
-       Assign backup lead chassis to MCM Group
+       Retire lead chassis in MCM Group
     
      .DESCRIPTION
-       This script uses the OME REST API to create mcm group, find memebers and add the members to the group.
+       This script uses the OME REST API to reture lead chassis
     
      .PARAMETER Force
        Not implemented

diff --git a/Documentation/CommandReference.md b/Documentation/CommandReference.md
@@ -5,8 +5,8 @@
 - [Edit-OMEGroup](Functions/Edit-OMEGroup.md)
 - [Edit-OMESecurityBanner](Functions/Edit-OMESecurityBanner.md)
 - [Edit-OMESupportAssistGroup](Functions/Edit-OMESupportAssistGroup.md)
-- [Get-OMEAlertDefinition](Functions/Get-OMEAlertDefinition.md)
 - [Get-OMEAlert](Functions/Get-OMEAlert.md)
+- [Get-OMEAlertDefinition](Functions/Get-OMEAlertDefinition.md)
 - [Get-OMEAuditLog](Functions/Get-OMEAuditLog.md)
 - [Get-OMECatalog](Functions/Get-OMECatalog.md)
 - [Get-OMEConfigurationBaseline](Functions/Get-OMEConfigurationBaseline.md)
@@ -285,6 +285,7 @@
 - Id (string Id {get;set;})
 - IgnoreCertificateWarning (bool IgnoreCertificateWarning {get;set;})
 - Token (string Token {get;set;})
+- Version (version Version {get;set;})
 ## SupportAssistGroup
 - ContactOptIn (bool ContactOptIn {get;set;})
 - CustomerDetails (psobject CustomerDetails {get;set;})