diff --git a/CHANGELOG.md b/CHANGELOG.md index c27e661..d8054b6 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.4.0]() - 2023-02-01 +## [3.4.0]() - 2023-02-02 ### Added - Get-OMEFabric - Get-OMEFabricUplink @@ -15,9 +15,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Set-OMETemplateIdentityPool - Set-OMETemplateNetwork - Remove-OMEDevice +- Remove-OMEDirectoryService +- Remove-OMEUser +- Improved Pester test coverage +- Tested against OME 3.10 and OME-M 2.00.00 ### Changed -- New-OMEMcmGroup to create VIP +- New-OMEMcmGroup to allow for VIP creation ## [3.3.3]() - 2023-01-23 ### Fixed diff --git a/DellOpenManage/DellOpenManage.psd1 b/DellOpenManage/DellOpenManage.psd1 index 911a928..da52a98 100644 --- a/DellOpenManage/DellOpenManage.psd1 +++ b/DellOpenManage/DellOpenManage.psd1 @@ -1,132 +1,132 @@ -# -# Module manifest for module 'DellOpenManage' -# -# Generated by: Trevor Squillario -# -# Generated on: 1/23/2023 -# - -@{ - -# Script module or binary module file associated with this manifest. -RootModule = 'DellOpenManage.psm1' - -# Version number of this module. -ModuleVersion = '3.3.3' - -# Supported PSEditions -# CompatiblePSEditions = @() - -# ID used to uniquely identify this module -GUID = '44c6339a-1c7e-4892-9d9c-9806818853c9' - -# Author of this module -Author = 'Trevor Squillario ' - -# Company or vendor of this module -CompanyName = 'Dell EMC' - -# Copyright statement for this module -Copyright = '(c) 2021 Dell EMC. All rights reserved.' - -# Description of the functionality provided by this module -Description = 'Dell OpenManage Enterprise PowerShell Module' - -# Minimum version of the PowerShell engine required by this module -# PowerShellVersion = '' - -# Name of the PowerShell host required by this module -# PowerShellHostName = '' - -# Minimum version of the PowerShell host required by this module -# PowerShellHostVersion = '' - -# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. -# DotNetFrameworkVersion = '' - -# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. -# ClrVersion = '' - -# Processor architecture (None, X86, Amd64) required by this module -# ProcessorArchitecture = '' - -# Modules that must be imported into the global environment prior to importing this module -# RequiredModules = @() - -# Assemblies that must be loaded prior to importing this module -# RequiredAssemblies = @() - -# Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() - -# Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() - -# Format files (.ps1xml) to be loaded when importing this module -# FormatsToProcess = @() - -# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess -# NestedModules = @() - -# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = '*' - -# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. -CmdletsToExport = '*' - -# Variables to export from this module -VariablesToExport = '*' - -# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. -AliasesToExport = '*' - -# DSC resources to export from this module -# DscResourcesToExport = @() - -# List of all modules packaged with this module -# ModuleList = @() - -# List of all files packaged with this module -# FileList = @() - -# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. -PrivateData = @{ - - PSData = @{ - - # Tags applied to this module. These help with module discovery in online galleries. - # Tags = @() - - # A URL to the license for this module. - # LicenseUri = '' - - # A URL to the main website for this project. - ProjectUri = 'https://github.com/dell/OpenManage-PowerShell-Modules' - - # A URL to an icon representing this module. - # IconUri = '' - - # ReleaseNotes of this module - # ReleaseNotes = '' - - # Prerelease string of this module - # Prerelease = '' - - # Flag to indicate whether the module requires explicit user acceptance for install/update/save - # RequireLicenseAcceptance = $false - - # External dependent modules of this module - # ExternalModuleDependencies = @() - - } # End of PSData hashtable - - } # End of PrivateData hashtable - -# HelpInfo URI of this module -# HelpInfoURI = '' - -# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. -# DefaultCommandPrefix = '' - -} - +# +# Module manifest for module 'DellOpenManage' +# +# Generated by: Trevor Squillario +# +# Generated on: 2/2/2023 +# + +@{ + +# Script module or binary module file associated with this manifest. +RootModule = 'DellOpenManage.psm1' + +# Version number of this module. +ModuleVersion = '3.4.0' + +# Supported PSEditions +# CompatiblePSEditions = @() + +# ID used to uniquely identify this module +GUID = '44c6339a-1c7e-4892-9d9c-9806818853c9' + +# Author of this module +Author = 'Trevor Squillario ' + +# Company or vendor of this module +CompanyName = 'Dell EMC' + +# Copyright statement for this module +Copyright = '(c) 2021 Dell EMC. All rights reserved.' + +# Description of the functionality provided by this module +Description = 'Dell OpenManage Enterprise PowerShell Module' + +# Minimum version of the PowerShell engine required by this module +# PowerShellVersion = '' + +# Name of the PowerShell host required by this module +# PowerShellHostName = '' + +# Minimum version of the PowerShell host required by this module +# PowerShellHostVersion = '' + +# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# DotNetFrameworkVersion = '' + +# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# ClrVersion = '' + +# Processor architecture (None, X86, Amd64) required by this module +# ProcessorArchitecture = '' + +# Modules that must be imported into the global environment prior to importing this module +# RequiredModules = @() + +# Assemblies that must be loaded prior to importing this module +# RequiredAssemblies = @() + +# Script files (.ps1) that are run in the caller's environment prior to importing this module. +# ScriptsToProcess = @() + +# Type files (.ps1xml) to be loaded when importing this module +# TypesToProcess = @() + +# Format files (.ps1xml) to be loaded when importing this module +# FormatsToProcess = @() + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +# NestedModules = @() + +# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. +FunctionsToExport = '*' + +# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. +CmdletsToExport = '*' + +# Variables to export from this module +VariablesToExport = '*' + +# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. +AliasesToExport = '*' + +# DSC resources to export from this module +# DscResourcesToExport = @() + +# List of all modules packaged with this module +# ModuleList = @() + +# List of all files packaged with this module +# FileList = @() + +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + # Tags = @() + + # A URL to the license for this module. + # LicenseUri = '' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/dell/OpenManage-PowerShell-Modules' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + # Prerelease string of this module + # Prerelease = '' + + # Flag to indicate whether the module requires explicit user acceptance for install/update/save + # RequireLicenseAcceptance = $false + + # External dependent modules of this module + # ExternalModuleDependencies = @() + + } # End of PSData hashtable + + } # End of PrivateData hashtable + +# HelpInfo URI of this module +# HelpInfoURI = '' + +# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. +# DefaultCommandPrefix = '' + +} + diff --git a/DellOpenManage/Public/OME/Edit-OMEFabricUplink.ps1 b/DellOpenManage/Public/OME/Edit-OMEFabricUplink.ps1 index 299f7f4..1f09a08 100644 --- a/DellOpenManage/Public/OME/Edit-OMEFabricUplink.ps1 +++ b/DellOpenManage/Public/OME/Edit-OMEFabricUplink.ps1 @@ -57,7 +57,7 @@ function Get-FabricUplinkEditPayload($Name, $Description, $MediaType, $Ports, $N # Split $Ports into array by comma and trim whitespace $PortSplit = @() if ($Ports) { - $PortSplit = $($Ports.Split(",") | % { $_.Trim() }) + $PortSplit = $($Ports.Split(",") | ForEach-Object { $_.Trim() }) } $NetworkList = [System.Collections.ArrayList]@() if ($Mode -eq "Append") { diff --git a/DellOpenManage/Public/OME/New-OMEFabric.ps1 b/DellOpenManage/Public/OME/New-OMEFabric.ps1 index 99bf568..a159c71 100644 --- a/DellOpenManage/Public/OME/New-OMEFabric.ps1 +++ b/DellOpenManage/Public/OME/New-OMEFabric.ps1 @@ -34,7 +34,7 @@ function Get-FabricPayload($Name, $Description, $DesignType, $SwitchAServiceTag, return $Payload } -function Invoke-CheckOMEFabricApplicableNodes ($BaseUri, $Headers, $ContentType, $DesignType, $SwitchAServiceTag, $SwitchBServiceTag) { +function Invoke-CheckOMEFabricApplicableNode ($BaseUri, $Headers, $ContentType, $DesignType, $SwitchAServiceTag, $SwitchBServiceTag) { $ApplicableNodesURL = $BaseUri + "/api/NetworkService/FabricDesigns('$($DesignType)')/NetworkService.GetApplicableNodes" Write-Verbose "Get fabric applicable nodes" Write-Verbose $ApplicableNodesURL @@ -145,7 +145,7 @@ Try { $Headers."X-Auth-Token" = $SessionAuth.Token $ContentType = "application/json" - $CheckApplicableNodes = Invoke-CheckOMEFabricApplicableNodes -BaseUri $BaseUri -Headers $Headers -ContentType $ContentType -DesignType $DesignType -SwitchAServiceTag $SwitchAServiceTag -SwitchBServiceTag $SwitchBServiceTag + $CheckApplicableNodes = Invoke-CheckOMEFabricApplicableNode -BaseUri $BaseUri -Headers $Headers -ContentType $ContentType -DesignType $DesignType -SwitchAServiceTag $SwitchAServiceTag -SwitchBServiceTag $SwitchBServiceTag if (!$CheckApplicableNodes) { throw [System.Exception]::new("FabricException", "Fabric applicable nodes check failed. Check your chassis and IOM service tags.") } diff --git a/DellOpenManage/Public/OME/New-OMEFabricUplink.ps1 b/DellOpenManage/Public/OME/New-OMEFabricUplink.ps1 index 3d55170..6678c2f 100644 --- a/DellOpenManage/Public/OME/New-OMEFabricUplink.ps1 +++ b/DellOpenManage/Public/OME/New-OMEFabricUplink.ps1 @@ -39,7 +39,7 @@ function Get-FabricUplinkPayload($Name, $Description, $MediaType, $Ports, $Netwo $PortPayloads = @() $PortSplit = @() if ($null -ne $Ports) { - $PortSplit = $($Ports.Split(",") | % { $_.Trim() }) + $PortSplit = $($Ports.Split(",") | ForEach-Object { $_.Trim() }) } foreach ($Port in $PortSplit) { if ($Port -ne "") { diff --git a/DellOpenManage/Public/OME/Remove-OMEDirectoryService.ps1 b/DellOpenManage/Public/OME/Remove-OMEDirectoryService.ps1 new file mode 100755 index 0000000..097a812 --- /dev/null +++ b/DellOpenManage/Public/OME/Remove-OMEDirectoryService.ps1 @@ -0,0 +1,80 @@ +using module ..\..\Classes\AccountProvider.psm1 + +function Remove-OMEDirectoryService { +<# +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 + Remove network +.DESCRIPTION + Remove network +.PARAMETER AccountProvider + Object of type AccountProvider returned from Get-OMEDirectoryService +.INPUTS + None +.EXAMPLE + "LAB.LOCAL" | Get-OMEDirectoryService | Remove-OMEDirectoryService + + Remove directory service +#> + +[CmdletBinding()] +param( + [Parameter(Mandatory, ValueFromPipeline)] + [AccountProvider] $AccountProvider +) + +Begin {} +Process { + if (!$(Confirm-IsAuthenticated)){ + Return + } + Try { + if ($SessionAuth.IgnoreCertificateWarning) { Set-CertPolicy } + $BaseUri = "https://$($SessionAuth.Host)" + $RemoveUrl = $BaseUri + "/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DeleteExternalAccountProvider" + $Type = "application/json" + $Headers = @{} + $Headers."X-Auth-Token" = $SessionAuth.Token + + $Payload ='{ + "AccountProviderIds": [] + }' | ConvertFrom-Json + + $Payload.AccountProviderIds = @($AccountProvider.Id) + $Payload = $Payload | ConvertTo-Json -Depth 6 + Write-Verbose $Payload + + Write-Verbose $RemoveUrl + $GroupResponse = Invoke-WebRequest -Uri $RemoveUrl -UseBasicParsing -Headers $Headers -ContentType $Type -Method POST -Body $Payload + Write-Verbose "Removing directory service..." + if ($GroupResponse.StatusCode -eq 204) { + Write-Verbose "Remove directory service successful..." + } + else { + Write-Error "Remove directory service failed..." + } + } + Catch { + Resolve-Error $_ + } +} + +End {} + +} + diff --git a/DellOpenManage/Public/OME/Remove-OMEUser.ps1 b/DellOpenManage/Public/OME/Remove-OMEUser.ps1 new file mode 100755 index 0000000..b7b9b7b --- /dev/null +++ b/DellOpenManage/Public/OME/Remove-OMEUser.ps1 @@ -0,0 +1,72 @@ +using module ..\..\Classes\Account.psm1 + +function Remove-OMEUser { +<# +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 + Remove user +.DESCRIPTION + Remove user +.PARAMETER Account + Object of type Account returned from Get-OMEUser +.INPUTS + None +.EXAMPLE + "TestUser" | Get-OMEUser | Remove-OMEUser + + Remove user +#> + +[CmdletBinding()] +param( + [Parameter(Mandatory, ValueFromPipeline)] + [Account] $User +) + +Begin {} +Process { + if (!$(Confirm-IsAuthenticated)){ + Return + } + Try { + if ($SessionAuth.IgnoreCertificateWarning) { Set-CertPolicy } + $BaseUri = "https://$($SessionAuth.Host)" + $RemoveUrl = $BaseUri + "/api/AccountService/Accounts('$($User.Id)')" + $Type = "application/json" + $Headers = @{} + $Headers."X-Auth-Token" = $SessionAuth.Token + + Write-Verbose $RemoveUrl + $GroupResponse = Invoke-WebRequest -Uri $RemoveUrl -UseBasicParsing -Headers $Headers -ContentType $Type -Method DELETE + Write-Verbose "Removing user..." + if ($GroupResponse.StatusCode -eq 204) { + Write-Verbose "Remove user successful..." + } + else { + Write-Error "Remove user failed..." + } + } + Catch { + Resolve-Error $_ + } +} + +End {} + +} + diff --git a/Documentation/CommandReference.md b/Documentation/CommandReference.md index 9c1492b..d58a392 100644 --- a/Documentation/CommandReference.md +++ b/Documentation/CommandReference.md @@ -1,400 +1,437 @@ -# Functions -- [Connect-OMEServer](Functions/Connect-OMEServer.md) -- [Copy-OMETemplate](Functions/Copy-OMETemplate.md) -- [Disconnect-OMEServer](Functions/Disconnect-OMEServer.md) -- [Edit-OMEDiscovery](Functions/Edit-OMEDiscovery.md) -- [Edit-OMEGroup](Functions/Edit-OMEGroup.md) -- [Edit-OMESecurityBanner](Functions/Edit-OMESecurityBanner.md) -- [Edit-OMESupportAssistGroup](Functions/Edit-OMESupportAssistGroup.md) -- [Get-OMEAlert](Functions/Get-OMEAlert.md) -- [Get-OMEAlertDefinition](Functions/Get-OMEAlertDefinition.md) -- [Get-OMEApplianceInfo](Functions/Get-OMEApplianceInfo.md) -- [Get-OMEAuditLog](Functions/Get-OMEAuditLog.md) -- [Get-OMECatalog](Functions/Get-OMECatalog.md) -- [Get-OMEConfigurationBaseline](Functions/Get-OMEConfigurationBaseline.md) -- [Get-OMEConfigurationCompliance](Functions/Get-OMEConfigurationCompliance.md) -- [Get-OMEDevice](Functions/Get-OMEDevice.md) -- [Get-OMEDeviceDetail](Functions/Get-OMEDeviceDetail.md) -- [Get-OMEDeviceNetworkDetail](Functions/Get-OMEDeviceNetworkDetail.md) -- [Get-OMEDirectoryService](Functions/Get-OMEDirectoryService.md) -- [Get-OMEDirectoryServiceSearch](Functions/Get-OMEDirectoryServiceSearch.md) -- [Get-OMEDiscovery](Functions/Get-OMEDiscovery.md) -- [Get-OMEFirmwareBaseline](Functions/Get-OMEFirmwareBaseline.md) -- [Get-OMEFirmwareCompliance](Functions/Get-OMEFirmwareCompliance.md) -- [Get-OMEGroup](Functions/Get-OMEGroup.md) -- [Get-OMEIdentityPool](Functions/Get-OMEIdentityPool.md) -- [Get-OMEIdentityPoolUsage](Functions/Get-OMEIdentityPoolUsage.md) -- [Get-OMEJob](Functions/Get-OMEJob.md) -- [Get-OMEMXDomain](Functions/Get-OMEMXDomain.md) -- [Get-OMENetwork](Functions/Get-OMENetwork.md) -- [Get-OMEReport](Functions/Get-OMEReport.md) -- [Get-OMERole](Functions/Get-OMERole.md) -- [Get-OMESupportAssistCase](Functions/Get-OMESupportAssistCase.md) -- [Get-OMESupportAssistGroup](Functions/Get-OMESupportAssistGroup.md) -- [Get-OMETemplate](Functions/Get-OMETemplate.md) -- [Get-OMEUser](Functions/Get-OMEUser.md) -- [Get-OMEWarranty](Functions/Get-OMEWarranty.md) -- [Invoke-OMEApplianceBackup](Functions/Invoke-OMEApplianceBackup.md) -- [Invoke-OMEConfigurationBaselineRefresh](Functions/Invoke-OMEConfigurationBaselineRefresh.md) -- [Invoke-OMEDirectoryServiceImportGroup](Functions/Invoke-OMEDirectoryServiceImportGroup.md) -- [Invoke-OMEFirmwareBaselineRefresh](Functions/Invoke-OMEFirmwareBaselineRefresh.md) -- [Invoke-OMEInventoryRefresh](Functions/Invoke-OMEInventoryRefresh.md) -- [Invoke-OMEJobRun](Functions/Invoke-OMEJobRun.md) -- [Invoke-OMEMcmGroupAddMember](Functions/Invoke-OMEMcmGroupAddMember.md) -- [Invoke-OMEMcmGroupAssignBackupLead](Functions/Invoke-OMEMcmGroupAssignBackupLead.md) -- [Invoke-OMEMcmGroupRetireLead](Functions/Invoke-OMEMcmGroupRetireLead.md) -- [Invoke-OMEOnboarding](Functions/Invoke-OMEOnboarding.md) -- [Invoke-OMEProfileUnassign](Functions/Invoke-OMEProfileUnassign.md) -- [Invoke-OMEReport](Functions/Invoke-OMEReport.md) -- [Invoke-OMEResetApplication](Functions/Invoke-OMEResetApplication.md) -- [Invoke-OMETemplateDeploy](Functions/Invoke-OMETemplateDeploy.md) -- [New-OMECatalog](Functions/New-OMECatalog.md) -- [New-OMEConfigurationBaseline](Functions/New-OMEConfigurationBaseline.md) -- [New-OMEDirectoryService](Functions/New-OMEDirectoryService.md) -- [New-OMEDiscovery](Functions/New-OMEDiscovery.md) -- [New-OMEFirmwareBaseline](Functions/New-OMEFirmwareBaseline.md) -- [New-OMEGroup](Functions/New-OMEGroup.md) -- [New-OMEIdentityPool](Functions/New-OMEIdentityPool.md) -- [New-OMEMcmGroup](Functions/New-OMEMcmGroup.md) -- [New-OMENetwork](Functions/New-OMENetwork.md) -- [New-OMESupportAssistGroup](Functions/New-OMESupportAssistGroup.md) -- [New-OMETemplateFromDevice](Functions/New-OMETemplateFromDevice.md) -- [New-OMETemplateFromFile](Functions/New-OMETemplateFromFile.md) -- [New-OMEUser](Functions/New-OMEUser.md) -- [Remove-OMECatalog](Functions/Remove-OMECatalog.md) -- [Remove-OMEFirmwareBaseline](Functions/Remove-OMEFirmwareBaseline.md) -- [Remove-OMEGroup](Functions/Remove-OMEGroup.md) -- [Remove-OMESupportAssistGroup](Functions/Remove-OMESupportAssistGroup.md) -- [Remove-OMETemplate](Functions/Remove-OMETemplate.md) -- [Set-OMEPowerState](Functions/Set-OMEPowerState.md) -- [Update-OMEConfiguration](Functions/Update-OMEConfiguration.md) -- [Update-OMEFirmware](Functions/Update-OMEFirmware.md) -- [Update-OMEFirmwareDUP](Functions/Update-OMEFirmwareDUP.md) -# Custom Types -## Account -- Description (string Description {get;set;}) -- DirectoryServiceId (int DirectoryServiceId {get;set;}) -- Enabled (bool Enabled {get;set;}) -- Id (int Id {get;set;}) -- IsBuiltin (bool IsBuiltin {get;set;}) -- IsVisible (bool IsVisible {get;set;}) -- Locked (bool Locked {get;set;}) -- Name (string Name {get;set;}) -- RoleId (int RoleId {get;set;}) -- UserName (string UserName {get;set;}) -- UserTypeId (int UserTypeId {get;set;}) -## AccountProvider -- AttributeGroupMembership (string AttributeGroupMembership {get;set;}) -- AttributeUserLogin (string AttributeUserLogin {get;set;}) -- BaseDistinguishedName (string BaseDistinguishedName {get;set;}) -- BindDN (string BindDN {get;set;}) -- CertificateValidation (bool CertificateValidation {get;set;}) -- DnsServer (string[] DnsServer {get;set;}) -- GroupDomain (string GroupDomain {get;set;}) -- Id (int Id {get;set;}) -- Name (string Name {get;set;}) -- NetworkTimeOut (int NetworkTimeOut {get;set;}) -- SearchFilter (string SearchFilter {get;set;}) -- SearchTimeOut (int SearchTimeOut {get;set;}) -- ServerName (string[] ServerName {get;set;}) -- ServerPort (int ServerPort {get;set;}) -- ServerType (string ServerType {get;set;}) -## ApplianceInfo -- Branding (string Branding {get;set;}) -- BuildDate (string BuildDate {get;set;}) -- BuildNumber (string BuildNumber {get;set;}) -- Description (string Description {get;set;}) -- Guid (string Guid {get;set;}) -- Name (string Name {get;set;}) -- OperationStatus (string OperationStatus {get;set;}) -- Vendor (string Vendor {get;set;}) -- Version (version Version {get;set;}) -## Catalog -- BaseLocation (string BaseLocation {get;set;}) -- Filename (string Filename {get;set;}) -- Id (int Id {get;set;}) -- LastUpdated (System.Nullable[datetime] LastUpdated {get;set;}) -- ManifestVersion (string ManifestVersion {get;set;}) -- NextUpdate (System.Nullable[datetime] NextUpdate {get;set;}) -- ReleaseDate (System.Nullable[datetime] ReleaseDate {get;set;}) -- Repository (Repository Repository {get;set;}) -- Schedule (Schedule Schedule {get;set;}) -- SourcePath (string SourcePath {get;set;}) -- Status (string Status {get;set;}) -## ComponentCompliance -- ComplianceStatus (string ComplianceStatus {get;set;}) -- ComponentType (string ComponentType {get;set;}) -- Criticality (string Criticality {get;set;}) -- CurrentVersion (string CurrentVersion {get;set;}) -- DeviceId (int DeviceId {get;set;}) -- DeviceModel (string DeviceModel {get;set;}) -- DeviceName (string DeviceName {get;set;}) -- Id (int Id {get;set;}) -- ImpactAssessment (string ImpactAssessment {get;set;}) -- Name (string Name {get;set;}) -- Path (string Path {get;set;}) -- PrerequisiteInfo (string PrerequisiteInfo {get;set;}) -- RebootRequired (bool RebootRequired {get;set;}) -- ServiceTag (string ServiceTag {get;set;}) -- SourceName (string SourceName {get;set;}) -- TargetIdentifier (string TargetIdentifier {get;set;}) -- UniqueIdentifier (string UniqueIdentifier {get;set;}) -- UpdateAction (string UpdateAction {get;set;}) -- Uri (string Uri {get;set;}) -- Version (string Version {get;set;}) -## ConfigurationBaseline -- BaselineTargets (psobject BaselineTargets {get;set;}) -- Description (string Description {get;set;}) -- Id (int Id {get;set;}) -- LastRun (System.Nullable[datetime] LastRun {get;set;}) -- Name (string Name {get;set;}) -- Targets (int[] Targets {get;set;}) -- TemplateId (int TemplateId {get;set;}) -- TemplateName (string TemplateName {get;set;}) -- TemplateType (int TemplateType {get;set;}) -## ConfigurationCompliance -- ComplianceStatus (string ComplianceStatus {get;set;}) -- DeviceModel (string DeviceModel {get;set;}) -- DeviceName (string DeviceName {get;set;}) -- Id (int Id {get;set;}) -- InventoryTime (string InventoryTime {get;set;}) -- ServiceTag (string ServiceTag {get;set;}) -## Device -- AssetTag (string AssetTag {get;set;}) -- ChassisServiceTag (string ChassisServiceTag {get;set;}) -- ConnectionState (bool ConnectionState {get;set;}) -- DeviceCapabilities (int[] DeviceCapabilities {get;set;}) -- DeviceName (string DeviceName {get;set;}) -- DeviceServiceTag (string DeviceServiceTag {get;set;}) -- DnsName (string DnsName {get;set;}) -- Id (int Id {get;set;}) -- Identifier (string Identifier {get;set;}) -- LastInventoryTime (System.Nullable[datetime] LastInventoryTime {get;set;}) -- LastStatusTime (System.Nullable[datetime] LastStatusTime {get;set;}) -- MacAddress (string MacAddress {get;set;}) -- ManagedState (int ManagedState {get;set;}) -- Model (string Model {get;set;}) -- NetworkAddress (string NetworkAddress {get;set;}) -- PowerState (int PowerState {get;set;}) -- Status (int Status {get;set;}) -- Type (int Type {get;set;}) -## DirectoryGroup -- CommonName (string CommonName {get;set;}) -- DistinguishedName (string DistinguishedName {get;set;}) -- DomainComponent (string[] DomainComponent {get;set;}) -- GroupType (string GroupType {get;set;}) -- ObjectGuid (string ObjectGuid {get;set;}) -- ObjectSid (string ObjectSid {get;set;}) -## Discovery -- CommunityString (bool CommunityString {get;set;}) -- ConnectionProfile (psobject ConnectionProfile {get;set;}) -- CreateGroup (bool CreateGroup {get;set;}) -- DeviceType (int[] DeviceType {get;set;}) -- EmailRecipient (string EmailRecipient {get;set;}) -- Hosts (DiscoveryTarget[] Hosts {get;set;}) -- Id (int Id {get;set;}) -- Name (string Name {get;set;}) -- Schedule (Schedule Schedule {get;set;}) -- TrapDestination (bool TrapDestination {get;set;}) -- UseAllProfiles (bool UseAllProfiles {get;set;}) -## DiscoveryTarget -- AddressType (int AddressType {get;set;}) -- Disabled (bool Disabled {get;set;}) -- Exclude (bool Exclude {get;set;}) -- NetworkAddressDetail (string NetworkAddressDetail {get;set;}) -- SubnetMask (string SubnetMask {get;set;}) -## Domain -- BackupLead (bool BackupLead {get;set;}) -- BackupLeadHealth (int BackupLeadHealth {get;set;}) -- Capabilities (string[] Capabilities {get;set;}) -- Description (string Description {get;set;}) -- DeviceId (int DeviceId {get;set;}) -- DomainRoleTypeId (int DomainRoleTypeId {get;set;}) -- DomainRoleTypeValue (string DomainRoleTypeValue {get;set;}) -- DomainTypeId (int DomainTypeId {get;set;}) -- DomainTypeValue (string DomainTypeValue {get;set;}) -- GroupId (string GroupId {get;set;}) -- GroupName (string GroupName {get;set;}) -- Id (int Id {get;set;}) -- Identifier (string Identifier {get;set;}) -- Local (bool Local {get;set;}) -- Name (string Name {get;set;}) -- PublicAddress (string[] PublicAddress {get;set;}) -- Version (version Version {get;set;}) -## FirmwareBaseline -- CatalogId (int CatalogId {get;set;}) -- Description (string Description {get;set;}) -- DowngradeEnabled (bool DowngradeEnabled {get;set;}) -- Id (int Id {get;set;}) -- LastRun (System.Nullable[datetime] LastRun {get;set;}) -- Name (string Name {get;set;}) -- RepositoryId (int RepositoryId {get;set;}) -- RepositoryName (string RepositoryName {get;set;}) -- RepositoryType (string RepositoryType {get;set;}) -- Targets (int[] Targets {get;set;}) -- TaskId (int TaskId {get;set;}) -- TaskStatusId (int TaskStatusId {get;set;}) -## Group -- CreatedBy (string CreatedBy {get;set;}) -- CreationTime (System.Nullable[datetime] CreationTime {get;set;}) -- DefinitionDescription (string DefinitionDescription {get;set;}) -- DefinitionId (int DefinitionId {get;set;}) -- Description (string Description {get;set;}) -- HasAttributes (bool HasAttributes {get;set;}) -- Id (int Id {get;set;}) -- MembershipTypeId (int MembershipTypeId {get;set;}) -- Name (string Name {get;set;}) -- ParentId (int ParentId {get;set;}) -- TypeId (int TypeId {get;set;}) -- UpdatedBy (string UpdatedBy {get;set;}) -- UpdatedTime (System.Nullable[datetime] UpdatedTime {get;set;}) -- Visible (bool Visible {get;set;}) -## IdentityPool -- CreatedBy (string CreatedBy {get;set;}) -- CreationTime (System.Nullable[datetime] CreationTime {get;set;}) -- Description (string Description {get;set;}) -- EthernetSettings (psobject EthernetSettings {get;set;}) -- FcoeSettings (psobject FcoeSettings {get;set;}) -- FcSettings (psobject FcSettings {get;set;}) -- Id (int Id {get;set;}) -- IscsiSettings (psobject IscsiSettings {get;set;}) -- LastUpdatedBy (string LastUpdatedBy {get;set;}) -- LastUpdateTime (System.Nullable[datetime] LastUpdateTime {get;set;}) -- Name (string Name {get;set;}) -## InventoryDetail -- DeviceId (string DeviceId {get;set;}) -- DeviceName (string DeviceName {get;set;}) -- DeviceServiceTag (string DeviceServiceTag {get;set;}) -- InventoryInfo (psobject InventoryInfo {get;set;}) -- InventoryType (string InventoryType {get;set;}) -## Job -- Builtin (bool Builtin {get;set;}) -- CreatedBy (string CreatedBy {get;set;}) -- Editable (bool Editable {get;set;}) -- EndTime (System.Nullable[datetime] EndTime {get;set;}) -- Id (int Id {get;set;}) -- JobDescription (string JobDescription {get;set;}) -- JobDetail (JobDetail[] JobDetail {get;set;}) -- JobName (string JobName {get;set;}) -- LastRun (System.Nullable[datetime] LastRun {get;set;}) -- LastRunStatus (string LastRunStatus {get;set;}) -- LastRunStatusId (int LastRunStatusId {get;set;}) -- NextRun (System.Nullable[datetime] NextRun {get;set;}) -- Schedule (string Schedule {get;set;}) -- StartTime (System.Nullable[datetime] StartTime {get;set;}) -- State (string State {get;set;}) -- Targets (psobject[] Targets {get;set;}) -- UpdatedBy (string UpdatedBy {get;set;}) -- UserGenerated (bool UserGenerated {get;set;}) -- Visible (bool Visible {get;set;}) -## JobDetail -- ElapsedTime (string ElapsedTime {get;set;}) -- EndTime (System.Nullable[datetime] EndTime {get;set;}) -- Id (int Id {get;set;}) -- Key (string Key {get;set;}) -- Output (string Output {get;set;}) -- Progress (string Progress {get;set;}) -- StartTime (System.Nullable[datetime] StartTime {get;set;}) -- Status (string Status {get;set;}) -- StatusId (string StatusId {get;set;}) -## Network -- Description (string Description {get;set;}) -- Id (int Id {get;set;}) -- Name (string Name {get;set;}) -- Type (int Type {get;set;}) -- VlanMaximum (int VlanMaximum {get;set;}) -- VlanMinimum (int VlanMinimum {get;set;}) -## NetworkPartition -- CurrentMacAddress (string CurrentMacAddress {get;set;}) -- DeviceId (string DeviceId {get;set;}) -- DeviceName (string DeviceName {get;set;}) -- DeviceServiceTag (string DeviceServiceTag {get;set;}) -- FcoeMode (string FcoeMode {get;set;}) -- Fqdd (string Fqdd {get;set;}) -- IscsiMode (string IscsiMode {get;set;}) -- LinkSpeed (int LinkSpeed {get;set;}) -- LinkStatus (string LinkStatus {get;set;}) -- ManagementIpAddress (string ManagementIpAddress {get;set;}) -- ManagementMacAddress (string ManagementMacAddress {get;set;}) -- MaxBandwidth (int MaxBandwidth {get;set;}) -- MinBandwidth (int MinBandwidth {get;set;}) -- Model (string Model {get;set;}) -- NicId (string NicId {get;set;}) -- NicMode (string NicMode {get;set;}) -- PermanentFcoeMacAddress (string PermanentFcoeMacAddress {get;set;}) -- PermanentMacAddress (string PermanentMacAddress {get;set;}) -- PortId (string PortId {get;set;}) -- VendorName (string VendorName {get;set;}) -- VirtualFipMacAddress (string VirtualFipMacAddress {get;set;}) -- VirtualIscsiMacAddress (string VirtualIscsiMacAddress {get;set;}) -- VirtualMacAddress (string VirtualMacAddress {get;set;}) -## Repository -- CheckCertificate (bool CheckCertificate {get;set;}) -- Description (string Description {get;set;}) -- DomainName (string DomainName {get;set;}) -- Id (int Id {get;set;}) -- Name (string Name {get;set;}) -- Password (string Password {get;set;}) -- RepositoryType (string RepositoryType {get;set;}) -- Source (string Source {get;set;}) -- Username (string Username {get;set;}) -## Role -- AssignedPrivileges (string[] AssignedPrivileges {get;set;}) -- Description (string Description {get;set;}) -- Id (string Id {get;set;}) -- IsPredefined (bool IsPredefined {get;set;}) -- IsScopeSupported (bool IsScopeSupported {get;set;}) -- Name (string Name {get;set;}) -- OemPrivileges (string[] OemPrivileges {get;set;}) -## Schedule -- Cron (string Cron {get;set;}) -- EndTime (System.Nullable[datetime] EndTime {get;set;}) -- RunLater (bool RunLater {get;set;}) -- RunNow (bool RunNow {get;set;}) -- StartTime (System.Nullable[datetime] StartTime {get;set;}) -## SessionAuth -- Host (string Host {get;set;}) -- 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;}) -- Description (string Description {get;set;}) -- DispatchOptIn (bool DispatchOptIn {get;set;}) -- Id (int Id {get;set;}) -- MyAccountId (string MyAccountId {get;set;}) -- Name (string Name {get;set;}) -## Template -- Content (string Content {get;set;}) -- CreatedBy (string CreatedBy {get;set;}) -- CreationTime (string CreationTime {get;set;}) -- Description (string Description {get;set;}) -- HasIdentityAttributes (bool HasIdentityAttributes {get;set;}) -- Id (int Id {get;set;}) -- IdentityPoolId (int IdentityPoolId {get;set;}) -- IsBuiltIn (bool IsBuiltIn {get;set;}) -- IsPersistencePolicyValid (bool IsPersistencePolicyValid {get;set;}) -- IsStatelessAvailable (bool IsStatelessAvailable {get;set;}) -- LastUpdatedBy (string LastUpdatedBy {get;set;}) -- LastUpdatedTime (System.Nullable[datetime] LastUpdatedTime {get;set;}) -- Name (string Name {get;set;}) -- SourceDeviceId (int SourceDeviceId {get;set;}) -- Status (int Status {get;set;}) -- TaskId (int TaskId {get;set;}) -- TypeId (int TypeId {get;set;}) -- Views (string Views {get;set;}) -- ViewTypeId (int ViewTypeId {get;set;}) -## TemplateAttribute -- AttributeEditInfoId (int AttributeEditInfoId {get;set;}) -- AttributeId (int AttributeId {get;set;}) -- CustomId (int CustomId {get;set;}) -- Description (string Description {get;set;}) -- DisplayName (string DisplayName {get;set;}) -- IsIgnored (bool IsIgnored {get;set;}) -- IsLinkedToSecure (bool IsLinkedToSecure {get;set;}) -- IsReadOnly (bool IsReadOnly {get;set;}) -- IsSecure (bool IsSecure {get;set;}) -- TargetSpecificTypeId (int TargetSpecificTypeId {get;set;}) -- Value (string Value {get;set;}) +# Functions +- [Connect-OMEServer](Functions/Connect-OMEServer.md) +- [Copy-OMETemplate](Functions/Copy-OMETemplate.md) +- [Disconnect-OMEServer](Functions/Disconnect-OMEServer.md) +- [Edit-OMEDiscovery](Functions/Edit-OMEDiscovery.md) +- [Edit-OMEFabricUplink](Functions/Edit-OMEFabricUplink.md) +- [Edit-OMEGroup](Functions/Edit-OMEGroup.md) +- [Edit-OMESecurityBanner](Functions/Edit-OMESecurityBanner.md) +- [Edit-OMESupportAssistGroup](Functions/Edit-OMESupportAssistGroup.md) +- [Get-OMEAlert](Functions/Get-OMEAlert.md) +- [Get-OMEAlertDefinition](Functions/Get-OMEAlertDefinition.md) +- [Get-OMEApplianceInfo](Functions/Get-OMEApplianceInfo.md) +- [Get-OMEAuditLog](Functions/Get-OMEAuditLog.md) +- [Get-OMECatalog](Functions/Get-OMECatalog.md) +- [Get-OMEConfigurationBaseline](Functions/Get-OMEConfigurationBaseline.md) +- [Get-OMEConfigurationCompliance](Functions/Get-OMEConfigurationCompliance.md) +- [Get-OMEDevice](Functions/Get-OMEDevice.md) +- [Get-OMEDeviceDetail](Functions/Get-OMEDeviceDetail.md) +- [Get-OMEDeviceNetworkDetail](Functions/Get-OMEDeviceNetworkDetail.md) +- [Get-OMEDirectoryService](Functions/Get-OMEDirectoryService.md) +- [Get-OMEDirectoryServiceSearch](Functions/Get-OMEDirectoryServiceSearch.md) +- [Get-OMEDiscovery](Functions/Get-OMEDiscovery.md) +- [Get-OMEFabric](Functions/Get-OMEFabric.md) +- [Get-OMEFabricUplink](Functions/Get-OMEFabricUplink.md) +- [Get-OMEFirmwareBaseline](Functions/Get-OMEFirmwareBaseline.md) +- [Get-OMEFirmwareCompliance](Functions/Get-OMEFirmwareCompliance.md) +- [Get-OMEGroup](Functions/Get-OMEGroup.md) +- [Get-OMEIdentityPool](Functions/Get-OMEIdentityPool.md) +- [Get-OMEIdentityPoolUsage](Functions/Get-OMEIdentityPoolUsage.md) +- [Get-OMEJob](Functions/Get-OMEJob.md) +- [Get-OMEMXDomain](Functions/Get-OMEMXDomain.md) +- [Get-OMENetwork](Functions/Get-OMENetwork.md) +- [Get-OMEReport](Functions/Get-OMEReport.md) +- [Get-OMERole](Functions/Get-OMERole.md) +- [Get-OMESupportAssistCase](Functions/Get-OMESupportAssistCase.md) +- [Get-OMESupportAssistGroup](Functions/Get-OMESupportAssistGroup.md) +- [Get-OMETemplate](Functions/Get-OMETemplate.md) +- [Get-OMETemplateNetwork](Functions/Get-OMETemplateNetwork.md) +- [Get-OMEUser](Functions/Get-OMEUser.md) +- [Get-OMEWarranty](Functions/Get-OMEWarranty.md) +- [Invoke-OMEApplianceBackup](Functions/Invoke-OMEApplianceBackup.md) +- [Invoke-OMEConfigurationBaselineRefresh](Functions/Invoke-OMEConfigurationBaselineRefresh.md) +- [Invoke-OMEDirectoryServiceImportGroup](Functions/Invoke-OMEDirectoryServiceImportGroup.md) +- [Invoke-OMEFirmwareBaselineRefresh](Functions/Invoke-OMEFirmwareBaselineRefresh.md) +- [Invoke-OMEInventoryRefresh](Functions/Invoke-OMEInventoryRefresh.md) +- [Invoke-OMEJobRun](Functions/Invoke-OMEJobRun.md) +- [Invoke-OMEMcmGroupAddMember](Functions/Invoke-OMEMcmGroupAddMember.md) +- [Invoke-OMEMcmGroupAssignBackupLead](Functions/Invoke-OMEMcmGroupAssignBackupLead.md) +- [Invoke-OMEMcmGroupRetireLead](Functions/Invoke-OMEMcmGroupRetireLead.md) +- [Invoke-OMEOnboarding](Functions/Invoke-OMEOnboarding.md) +- [Invoke-OMEProfileUnassign](Functions/Invoke-OMEProfileUnassign.md) +- [Invoke-OMEReport](Functions/Invoke-OMEReport.md) +- [Invoke-OMEResetApplication](Functions/Invoke-OMEResetApplication.md) +- [Invoke-OMETemplateDeploy](Functions/Invoke-OMETemplateDeploy.md) +- [New-OMECatalog](Functions/New-OMECatalog.md) +- [New-OMEConfigurationBaseline](Functions/New-OMEConfigurationBaseline.md) +- [New-OMEDirectoryService](Functions/New-OMEDirectoryService.md) +- [New-OMEDiscovery](Functions/New-OMEDiscovery.md) +- [New-OMEFabric](Functions/New-OMEFabric.md) +- [New-OMEFabricUplink](Functions/New-OMEFabricUplink.md) +- [New-OMEFirmwareBaseline](Functions/New-OMEFirmwareBaseline.md) +- [New-OMEGroup](Functions/New-OMEGroup.md) +- [New-OMEIdentityPool](Functions/New-OMEIdentityPool.md) +- [New-OMEMcmGroup](Functions/New-OMEMcmGroup.md) +- [New-OMENetwork](Functions/New-OMENetwork.md) +- [New-OMESupportAssistGroup](Functions/New-OMESupportAssistGroup.md) +- [New-OMETemplateFromDevice](Functions/New-OMETemplateFromDevice.md) +- [New-OMETemplateFromFile](Functions/New-OMETemplateFromFile.md) +- [New-OMEUser](Functions/New-OMEUser.md) +- [Remove-OMECatalog](Functions/Remove-OMECatalog.md) +- [Remove-OMEDevice](Functions/Remove-OMEDevice.md) +- [Remove-OMEDirectoryService](Functions/Remove-OMEDirectoryService.md) +- [Remove-OMEFabricUplink](Functions/Remove-OMEFabricUplink.md) +- [Remove-OMEFirmwareBaseline](Functions/Remove-OMEFirmwareBaseline.md) +- [Remove-OMEGroup](Functions/Remove-OMEGroup.md) +- [Remove-OMENetwork](Functions/Remove-OMENetwork.md) +- [Remove-OMESupportAssistGroup](Functions/Remove-OMESupportAssistGroup.md) +- [Remove-OMETemplate](Functions/Remove-OMETemplate.md) +- [Remove-OMEUser](Functions/Remove-OMEUser.md) +- [Set-OMEIOMPortBreakout](Functions/Set-OMEIOMPortBreakout.md) +- [Set-OMEPowerState](Functions/Set-OMEPowerState.md) +- [Set-OMETemplateIdentityPool](Functions/Set-OMETemplateIdentityPool.md) +- [Set-OMETemplateNetwork](Functions/Set-OMETemplateNetwork.md) +- [Update-OMEConfiguration](Functions/Update-OMEConfiguration.md) +- [Update-OMEFirmware](Functions/Update-OMEFirmware.md) +- [Update-OMEFirmwareDUP](Functions/Update-OMEFirmwareDUP.md) +# Custom Types +## Account +- Description (string Description {get;set;}) +- DirectoryServiceId (int DirectoryServiceId {get;set;}) +- Enabled (bool Enabled {get;set;}) +- Id (int Id {get;set;}) +- IsBuiltin (bool IsBuiltin {get;set;}) +- IsVisible (bool IsVisible {get;set;}) +- Locked (bool Locked {get;set;}) +- Name (string Name {get;set;}) +- RoleId (int RoleId {get;set;}) +- UserName (string UserName {get;set;}) +- UserTypeId (int UserTypeId {get;set;}) +## AccountProvider +- AttributeGroupMembership (string AttributeGroupMembership {get;set;}) +- AttributeUserLogin (string AttributeUserLogin {get;set;}) +- BaseDistinguishedName (string BaseDistinguishedName {get;set;}) +- BindDN (string BindDN {get;set;}) +- CertificateValidation (bool CertificateValidation {get;set;}) +- DnsServer (string[] DnsServer {get;set;}) +- GroupDomain (string GroupDomain {get;set;}) +- Id (int Id {get;set;}) +- Name (string Name {get;set;}) +- NetworkTimeOut (int NetworkTimeOut {get;set;}) +- SearchFilter (string SearchFilter {get;set;}) +- SearchTimeOut (int SearchTimeOut {get;set;}) +- ServerName (string[] ServerName {get;set;}) +- ServerPort (int ServerPort {get;set;}) +- ServerType (string ServerType {get;set;}) +## ApplianceInfo +- Branding (string Branding {get;set;}) +- BuildDate (string BuildDate {get;set;}) +- BuildNumber (string BuildNumber {get;set;}) +- Description (string Description {get;set;}) +- Guid (string Guid {get;set;}) +- Name (string Name {get;set;}) +- OperationStatus (string OperationStatus {get;set;}) +- Vendor (string Vendor {get;set;}) +- Version (version Version {get;set;}) +## Catalog +- BaseLocation (string BaseLocation {get;set;}) +- Filename (string Filename {get;set;}) +- Id (int Id {get;set;}) +- LastUpdated (System.Nullable[datetime] LastUpdated {get;set;}) +- ManifestVersion (string ManifestVersion {get;set;}) +- NextUpdate (System.Nullable[datetime] NextUpdate {get;set;}) +- ReleaseDate (System.Nullable[datetime] ReleaseDate {get;set;}) +- Repository (Repository Repository {get;set;}) +- Schedule (Schedule Schedule {get;set;}) +- SourcePath (string SourcePath {get;set;}) +- Status (string Status {get;set;}) +## ComponentCompliance +- ComplianceStatus (string ComplianceStatus {get;set;}) +- ComponentType (string ComponentType {get;set;}) +- Criticality (string Criticality {get;set;}) +- CurrentVersion (string CurrentVersion {get;set;}) +- DeviceId (int DeviceId {get;set;}) +- DeviceModel (string DeviceModel {get;set;}) +- DeviceName (string DeviceName {get;set;}) +- Id (int Id {get;set;}) +- ImpactAssessment (string ImpactAssessment {get;set;}) +- Name (string Name {get;set;}) +- Path (string Path {get;set;}) +- PrerequisiteInfo (string PrerequisiteInfo {get;set;}) +- RebootRequired (bool RebootRequired {get;set;}) +- ServiceTag (string ServiceTag {get;set;}) +- SourceName (string SourceName {get;set;}) +- TargetIdentifier (string TargetIdentifier {get;set;}) +- UniqueIdentifier (string UniqueIdentifier {get;set;}) +- UpdateAction (string UpdateAction {get;set;}) +- Uri (string Uri {get;set;}) +- Version (string Version {get;set;}) +## ConfigurationBaseline +- BaselineTargets (psobject BaselineTargets {get;set;}) +- Description (string Description {get;set;}) +- Id (int Id {get;set;}) +- LastRun (System.Nullable[datetime] LastRun {get;set;}) +- Name (string Name {get;set;}) +- Targets (int[] Targets {get;set;}) +- TemplateId (int TemplateId {get;set;}) +- TemplateName (string TemplateName {get;set;}) +- TemplateType (int TemplateType {get;set;}) +## ConfigurationCompliance +- ComplianceStatus (string ComplianceStatus {get;set;}) +- DeviceModel (string DeviceModel {get;set;}) +- DeviceName (string DeviceName {get;set;}) +- Id (int Id {get;set;}) +- InventoryTime (string InventoryTime {get;set;}) +- ServiceTag (string ServiceTag {get;set;}) +## Device +- AssetTag (string AssetTag {get;set;}) +- ChassisServiceTag (string ChassisServiceTag {get;set;}) +- ConnectionState (bool ConnectionState {get;set;}) +- DeviceCapabilities (int[] DeviceCapabilities {get;set;}) +- DeviceName (string DeviceName {get;set;}) +- DeviceServiceTag (string DeviceServiceTag {get;set;}) +- DnsName (string DnsName {get;set;}) +- Id (int Id {get;set;}) +- Identifier (string Identifier {get;set;}) +- LastInventoryTime (System.Nullable[datetime] LastInventoryTime {get;set;}) +- LastStatusTime (System.Nullable[datetime] LastStatusTime {get;set;}) +- MacAddress (string MacAddress {get;set;}) +- ManagedState (int ManagedState {get;set;}) +- Model (string Model {get;set;}) +- NetworkAddress (string NetworkAddress {get;set;}) +- PowerState (int PowerState {get;set;}) +- Status (int Status {get;set;}) +- Type (int Type {get;set;}) +## DirectoryGroup +- CommonName (string CommonName {get;set;}) +- DistinguishedName (string DistinguishedName {get;set;}) +- DomainComponent (string[] DomainComponent {get;set;}) +- GroupType (string GroupType {get;set;}) +- ObjectGuid (string ObjectGuid {get;set;}) +- ObjectSid (string ObjectSid {get;set;}) +## Discovery +- CommunityString (bool CommunityString {get;set;}) +- ConnectionProfile (psobject ConnectionProfile {get;set;}) +- CreateGroup (bool CreateGroup {get;set;}) +- DeviceType (int[] DeviceType {get;set;}) +- EmailRecipient (string EmailRecipient {get;set;}) +- Hosts (DiscoveryTarget[] Hosts {get;set;}) +- Id (int Id {get;set;}) +- Name (string Name {get;set;}) +- Schedule (Schedule Schedule {get;set;}) +- TrapDestination (bool TrapDestination {get;set;}) +- UseAllProfiles (bool UseAllProfiles {get;set;}) +## DiscoveryTarget +- AddressType (int AddressType {get;set;}) +- Disabled (bool Disabled {get;set;}) +- Exclude (bool Exclude {get;set;}) +- NetworkAddressDetail (string NetworkAddressDetail {get;set;}) +- SubnetMask (string SubnetMask {get;set;}) +## Domain +- BackupLead (bool BackupLead {get;set;}) +- BackupLeadHealth (int BackupLeadHealth {get;set;}) +- Capabilities (string[] Capabilities {get;set;}) +- Description (string Description {get;set;}) +- DeviceId (int DeviceId {get;set;}) +- DomainRoleTypeId (int DomainRoleTypeId {get;set;}) +- DomainRoleTypeValue (string DomainRoleTypeValue {get;set;}) +- DomainTypeId (int DomainTypeId {get;set;}) +- DomainTypeValue (string DomainTypeValue {get;set;}) +- GroupId (string GroupId {get;set;}) +- GroupName (string GroupName {get;set;}) +- Id (int Id {get;set;}) +- Identifier (string Identifier {get;set;}) +- Local (bool Local {get;set;}) +- Name (string Name {get;set;}) +- PublicAddress (string[] PublicAddress {get;set;}) +- Version (version Version {get;set;}) +## Fabric +- Description (string Description {get;set;}) +- Id (string Id {get;set;}) +- Name (string Name {get;set;}) +- OverrideLLDPConfiguration (string OverrideLLDPConfiguration {get;set;}) +- ScaleVLANProfile (string ScaleVLANProfile {get;set;}) +## FirmwareBaseline +- CatalogId (int CatalogId {get;set;}) +- Description (string Description {get;set;}) +- DowngradeEnabled (bool DowngradeEnabled {get;set;}) +- Id (int Id {get;set;}) +- LastRun (System.Nullable[datetime] LastRun {get;set;}) +- Name (string Name {get;set;}) +- RepositoryId (int RepositoryId {get;set;}) +- RepositoryName (string RepositoryName {get;set;}) +- RepositoryType (string RepositoryType {get;set;}) +- Targets (int[] Targets {get;set;}) +- TaskId (int TaskId {get;set;}) +- TaskStatusId (int TaskStatusId {get;set;}) +## Group +- CreatedBy (string CreatedBy {get;set;}) +- CreationTime (System.Nullable[datetime] CreationTime {get;set;}) +- DefinitionDescription (string DefinitionDescription {get;set;}) +- DefinitionId (int DefinitionId {get;set;}) +- Description (string Description {get;set;}) +- HasAttributes (bool HasAttributes {get;set;}) +- Id (int Id {get;set;}) +- MembershipTypeId (int MembershipTypeId {get;set;}) +- Name (string Name {get;set;}) +- ParentId (int ParentId {get;set;}) +- TypeId (int TypeId {get;set;}) +- UpdatedBy (string UpdatedBy {get;set;}) +- UpdatedTime (System.Nullable[datetime] UpdatedTime {get;set;}) +- Visible (bool Visible {get;set;}) +## IdentityPool +- CreatedBy (string CreatedBy {get;set;}) +- CreationTime (System.Nullable[datetime] CreationTime {get;set;}) +- Description (string Description {get;set;}) +- EthernetSettings (psobject EthernetSettings {get;set;}) +- FcoeSettings (psobject FcoeSettings {get;set;}) +- FcSettings (psobject FcSettings {get;set;}) +- Id (int Id {get;set;}) +- IscsiSettings (psobject IscsiSettings {get;set;}) +- LastUpdatedBy (string LastUpdatedBy {get;set;}) +- LastUpdateTime (System.Nullable[datetime] LastUpdateTime {get;set;}) +- Name (string Name {get;set;}) +## InventoryDetail +- DeviceId (string DeviceId {get;set;}) +- DeviceName (string DeviceName {get;set;}) +- DeviceServiceTag (string DeviceServiceTag {get;set;}) +- InventoryInfo (psobject InventoryInfo {get;set;}) +- InventoryType (string InventoryType {get;set;}) +## Job +- Builtin (bool Builtin {get;set;}) +- CreatedBy (string CreatedBy {get;set;}) +- Editable (bool Editable {get;set;}) +- EndTime (System.Nullable[datetime] EndTime {get;set;}) +- Id (int Id {get;set;}) +- JobDescription (string JobDescription {get;set;}) +- JobDetail (JobDetail[] JobDetail {get;set;}) +- JobName (string JobName {get;set;}) +- LastRun (System.Nullable[datetime] LastRun {get;set;}) +- LastRunStatus (string LastRunStatus {get;set;}) +- LastRunStatusId (int LastRunStatusId {get;set;}) +- NextRun (System.Nullable[datetime] NextRun {get;set;}) +- Schedule (string Schedule {get;set;}) +- StartTime (System.Nullable[datetime] StartTime {get;set;}) +- State (string State {get;set;}) +- Targets (psobject[] Targets {get;set;}) +- UpdatedBy (string UpdatedBy {get;set;}) +- UserGenerated (bool UserGenerated {get;set;}) +- Visible (bool Visible {get;set;}) +## JobDetail +- ElapsedTime (string ElapsedTime {get;set;}) +- EndTime (System.Nullable[datetime] EndTime {get;set;}) +- Id (int Id {get;set;}) +- Key (string Key {get;set;}) +- Output (string Output {get;set;}) +- Progress (string Progress {get;set;}) +- StartTime (System.Nullable[datetime] StartTime {get;set;}) +- Status (string Status {get;set;}) +- StatusId (string StatusId {get;set;}) +## Network +- Description (string Description {get;set;}) +- Id (int Id {get;set;}) +- Name (string Name {get;set;}) +- Type (int Type {get;set;}) +- VlanMaximum (int VlanMaximum {get;set;}) +- VlanMinimum (int VlanMinimum {get;set;}) +## NetworkPartition +- CurrentMacAddress (string CurrentMacAddress {get;set;}) +- DeviceId (string DeviceId {get;set;}) +- DeviceName (string DeviceName {get;set;}) +- DeviceServiceTag (string DeviceServiceTag {get;set;}) +- FcoeMode (string FcoeMode {get;set;}) +- Fqdd (string Fqdd {get;set;}) +- IscsiMode (string IscsiMode {get;set;}) +- LinkSpeed (int LinkSpeed {get;set;}) +- LinkStatus (string LinkStatus {get;set;}) +- ManagementIpAddress (string ManagementIpAddress {get;set;}) +- ManagementMacAddress (string ManagementMacAddress {get;set;}) +- MaxBandwidth (int MaxBandwidth {get;set;}) +- MinBandwidth (int MinBandwidth {get;set;}) +- Model (string Model {get;set;}) +- NicId (string NicId {get;set;}) +- NicMode (string NicMode {get;set;}) +- PermanentFcoeMacAddress (string PermanentFcoeMacAddress {get;set;}) +- PermanentMacAddress (string PermanentMacAddress {get;set;}) +- PortId (string PortId {get;set;}) +- VendorName (string VendorName {get;set;}) +- VirtualFipMacAddress (string VirtualFipMacAddress {get;set;}) +- VirtualIscsiMacAddress (string VirtualIscsiMacAddress {get;set;}) +- VirtualMacAddress (string VirtualMacAddress {get;set;}) +## Repository +- CheckCertificate (bool CheckCertificate {get;set;}) +- Description (string Description {get;set;}) +- DomainName (string DomainName {get;set;}) +- Id (int Id {get;set;}) +- Name (string Name {get;set;}) +- Password (string Password {get;set;}) +- RepositoryType (string RepositoryType {get;set;}) +- Source (string Source {get;set;}) +- Username (string Username {get;set;}) +## Role +- AssignedPrivileges (string[] AssignedPrivileges {get;set;}) +- Description (string Description {get;set;}) +- Id (string Id {get;set;}) +- IsPredefined (bool IsPredefined {get;set;}) +- IsScopeSupported (bool IsScopeSupported {get;set;}) +- Name (string Name {get;set;}) +- OemPrivileges (string[] OemPrivileges {get;set;}) +## Schedule +- Cron (string Cron {get;set;}) +- EndTime (System.Nullable[datetime] EndTime {get;set;}) +- RunLater (bool RunLater {get;set;}) +- RunNow (bool RunNow {get;set;}) +- StartTime (System.Nullable[datetime] StartTime {get;set;}) +## SessionAuth +- Host (string Host {get;set;}) +- 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;}) +- Description (string Description {get;set;}) +- DispatchOptIn (bool DispatchOptIn {get;set;}) +- Id (int Id {get;set;}) +- MyAccountId (string MyAccountId {get;set;}) +- Name (string Name {get;set;}) +## Template +- Content (string Content {get;set;}) +- CreatedBy (string CreatedBy {get;set;}) +- CreationTime (string CreationTime {get;set;}) +- Description (string Description {get;set;}) +- HasIdentityAttributes (bool HasIdentityAttributes {get;set;}) +- Id (int Id {get;set;}) +- IdentityPoolId (int IdentityPoolId {get;set;}) +- IsBuiltIn (bool IsBuiltIn {get;set;}) +- IsPersistencePolicyValid (bool IsPersistencePolicyValid {get;set;}) +- IsStatelessAvailable (bool IsStatelessAvailable {get;set;}) +- LastUpdatedBy (string LastUpdatedBy {get;set;}) +- LastUpdatedTime (System.Nullable[datetime] LastUpdatedTime {get;set;}) +- Name (string Name {get;set;}) +- SourceDeviceId (int SourceDeviceId {get;set;}) +- Status (int Status {get;set;}) +- TaskId (int TaskId {get;set;}) +- TypeId (int TypeId {get;set;}) +- Views (string Views {get;set;}) +- ViewTypeId (int ViewTypeId {get;set;}) +## TemplateAttribute +- AttributeEditInfoId (int AttributeEditInfoId {get;set;}) +- AttributeId (int AttributeId {get;set;}) +- CustomId (int CustomId {get;set;}) +- Description (string Description {get;set;}) +- DisplayName (string DisplayName {get;set;}) +- IsIgnored (bool IsIgnored {get;set;}) +- IsLinkedToSecure (bool IsLinkedToSecure {get;set;}) +- IsReadOnly (bool IsReadOnly {get;set;}) +- IsSecure (bool IsSecure {get;set;}) +- TargetSpecificTypeId (int TargetSpecificTypeId {get;set;}) +- Value (string Value {get;set;}) +## TemplateNetwork +- CustomId (int CustomId {get;set;}) +- NICIdentifier (string NICIdentifier {get;set;}) +- Port (int Port {get;set;}) +- VlanTagged (int[] VlanTagged {get;set;}) +- VlanUnTagged (int VlanUnTagged {get;set;}) +## Uplink +- Description (string Description {get;set;}) +- Id (string Id {get;set;}) +- MediaType (string MediaType {get;set;}) +- Name (string Name {get;set;}) +- NativeVLAN (int NativeVLAN {get;set;}) +- NetworkCount (int NetworkCount {get;set;}) +- Networks (int[] Networks {get;set;}) +- PortCount (int PortCount {get;set;}) +- Ports (string[] Ports {get;set;}) +- UfdEnable (string UfdEnable {get;set;}) diff --git a/Documentation/Functions/Connect-OMEServer.md b/Documentation/Functions/Connect-OMEServer.md index 9d67f4f..857f354 100644 --- a/Documentation/Functions/Connect-OMEServer.md +++ b/Documentation/Functions/Connect-OMEServer.md @@ -1,109 +1,109 @@ ---- -external help file: DellOpenManage-help.xml -Module Name: DellOpenManage -online version: -schema: 2.0.0 ---- - -# Connect-OMEServer - -## SYNOPSIS -Connect to OpenManage Enterprise Server using REST API - -## SYNTAX - -``` -Connect-OMEServer [[-Name] ] [[-Credentials] ] [-IgnoreCertificateWarning] - [] -``` - -## DESCRIPTION -Connect to OpenManage Enterprise Server using REST API. -For authentication session-based X-Auth -Token is used. - -Note that the credentials entered are not stored to disk. - -## EXAMPLES - -### EXAMPLE 1 -``` -Connect-OMEServer -Name "ome.example.com" -Credentials $(New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList "admin", $(ConvertTo-SecureString -Force -AsPlainText "password")) -IgnoreCertificateWarning -``` - -### EXAMPLE 2 -``` -Connect-OMEServer -Name "ome.example.com" -Credentials $(Get-Credential) -IgnoreCertificateWarning -``` - -Prompt for credentials - -### EXAMPLE 3 -``` -$env:OMEHost = '192.168.1.100'; $env:OMEUserName = 'admin'; $env:OMEPassword = 'calvin'; Connect-OMEServer -IgnoreCertificateWarning -``` - -Credentials can be stored in Environment Variables - -## PARAMETERS - -### -Name -OpenManage Enterprise Server Hostname or IP Address. -If not specified will attempt to use Environment Variable OMEHost - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials -PSCredential object containing username and password to authenticate. -If not specified will attempt to use Environment Variables OMEUserName and OMEPassword. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreCertificateWarning -Ignore certificate warnings from server. -Used for the default self-signed certificate. -(Default=False) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 - -### None -## OUTPUTS - -## NOTES - -## RELATED LINKS +--- +external help file: DellOpenManage-help.xml +Module Name: DellOpenManage +online version: +schema: 2.0.0 +--- + +# Connect-OMEServer + +## SYNOPSIS +Connect to OpenManage Enterprise Server using REST API + +## SYNTAX + +``` +Connect-OMEServer [[-Name] ] [[-Credentials] ] [-IgnoreCertificateWarning] + [] +``` + +## DESCRIPTION +Connect to OpenManage Enterprise Server using REST API. +For authentication session-based X-Auth +Token is used. + +Note that the credentials entered are not stored to disk. + +## EXAMPLES + +### EXAMPLE 1 +``` +Connect-OMEServer -Name "ome.example.com" -Credentials $(New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList "admin", $(ConvertTo-SecureString -Force -AsPlainText "password")) -IgnoreCertificateWarning +``` + +### EXAMPLE 2 +``` +Connect-OMEServer -Name "ome.example.com" -Credentials $(Get-Credential) -IgnoreCertificateWarning +``` + +Prompt for credentials + +### EXAMPLE 3 +``` +$env:OMEHost = '192.168.1.100'; $env:OMEUserName = 'admin'; $env:OMEPassword = 'calvin'; Connect-OMEServer -IgnoreCertificateWarning +``` + +Credentials can be stored in Environment Variables + +## PARAMETERS + +### -Name +OpenManage Enterprise Server Hostname or IP Address. +If not specified will attempt to use Environment Variable OMEHost + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials +PSCredential object containing username and password to authenticate. +If not specified will attempt to use Environment Variables OMEUserName and OMEPassword. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreCertificateWarning +Ignore certificate warnings from server. +Used for the default self-signed certificate. +(Default=False) + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 + +### None +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/Documentation/Functions/Copy-OMETemplate.md b/Documentation/Functions/Copy-OMETemplate.md index a243fe5..dd1aad6 100644 --- a/Documentation/Functions/Copy-OMETemplate.md +++ b/Documentation/Functions/Copy-OMETemplate.md @@ -1,112 +1,112 @@ ---- -external help file: DellOpenManage-help.xml -Module Name: DellOpenManage -online version: -schema: 2.0.0 ---- - -# Copy-OMETemplate - -## SYNOPSIS -Clone template in OpenManage Enterprise. -***Only supports Deployment templates - -## SYNTAX - -``` -Copy-OMETemplate [-Template]