Posh Hponeview 4.20

Documentation
TABLE OF CONTENTS
Wiki Table of Contents

▸ Home
· Introduction
· Sample Scripts
· Additional Resources
· Command Reference
· about_HPOneView.420
· about_Appliance_Connections
· about_Appliance_Connection_Permissions
· about_Two_Factor_Authentication
· Add-HPOVApplianceTrustedCertificate
· Add-HPOVBaseline
· Add-HPOVClusterNodeToCluster
· Add-HPOVEnclosure
· Add-HPOVFabricManager
· Add-HPOVHypervisorManager
· Add-HPOVLdapServer
· Add-HPOVPowerDevice
· Add-HPOVRackManager
· Add-HPOVRackToDataCenter
· Add-HPOVRemoteFrame
· Add-HPOVResourceToLabel
· Add-HPOVResourceToRack
· Add-HPOVResourceToScope
· Add-HPOVSanManager
· Add-HPOVServer
· Add-HPOVSmtpAlertEmailFilter
· Add-HPOVStoragePool
· Add-HPOVStorageSystem
· Add-HPOVStorageVolume
· Clear-HPOVAlert
· Connect-HPOVMgmt
· Convert-HPOVServerProfile
· Convert-HPOVServerProfileTemplate
· ConvertTo-HPOVImageStreamerConfiguration
· ConvertTo-HPOVPowerShellScript
· ConvertTo-HPOVServerProfileTemplate
· ConvertTo-HPOVStorageVolume
· Copy-HPOVServerProfile
· Disable-HPOVApplianceComplexPasswords
· Disable-HPOVApplianceServiceConsoleAccess
· Disable-HPOVApplianceSshAccess
· Disable-HPOVApplianceTwoFactorAuthentication
· Disable-HPOVCertificateValidation
· Disable-HPOVDebug
· Disable-HPOVDebug
· Disable-HPOVDeviceUid
· Disable-HPOVLdapLocalLogin
· Disable-HPOVLogicalInterconnectPortMonitoring
· Disable-HPOVMSDSC
· Disable-HPOVRemoteSupport
· Disable-HPOVRemoteSyslog
· Disconnect-HPOVMgmt
· Enable-HPOVApplianceComplexPasswords
· Enable-HPOVApplianceServiceConsoleAccess
· Enable-HPOVApplianceSshAccess
· Enable-HPOVCertificateValidation
· Enable-HPOVComposerHANode
· Enable-HPOVDebug
· Enable-HPOVDeviceUid
· Enable-HPOVLdapLocalLogin
· Enable-HPOVLogicalInterconnectPortMonitoring
· Enable-HPOVMSDSC
· Enable-HPOVRemoteSupport
· Enable-HPOVRemoteSyslog
· Get-HPOVAddressPool
· Get-HPOVAddressPoolRange
· Get-HPOVAddressPoolSubnet
· Get-HPOVAlert
· Get-HPOVApplianceAvailableSecurityMode
· Get-HPOVApplianceCertificateStatus
· Get-HPOVApplianceCurrentSecurityMode
· Get-HPOVApplianceDateTime
· Get-HPOVApplianceGlobalSetting
· Get-HPOVApplianceNetworkConfig
· Get-HPOVApplianceProxy
· Get-HPOVApplianceSecurityProtocol
· Get-HPOVApplianceSnmpV3EngineId
· Get-HPOVApplianceTrapDestination
· Get-HPOVApplianceTrustedCertificate
· Get-HPOVApplianceTwoFactorAuthentication
· Get-HPOVAuditLog
· Get-HPOVAuditLogArchive
· Get-HPOVAutomaticBackupConfig
· Get-HPOVAvailableDriveType
· Get-HPOVBackup
· Get-HPOVBaseline
· Get-HPOVBaselineRepository
· Get-HPOVClusterNode
· Get-HPOVClusterProfile
· Get-HPOVCommandTrace
· Get-HPOVComposerNode
· Get-HPOVDataCenter
· Get-HPOVDriveEnclosure
· Get-HPOVEnclosure
· Get-HPOVEnclosureGroup
· Get-HPOVEulaStatus
· Get-HPOVFabricManager
· Get-HPOVHealthStatus
· Get-HPOVHypervisorManager
· Get-HPOVIloSso
· Get-HPOVImageStreamerAppliance
· Get-HPOVInterconnect
· Get-HPOVInterconnectType
· Get-HPOVLabel
· Get-HPOVLdap
· Get-HPOVLdapDirectory
· Get-HPOVLdapGroup
· Get-HPOVLicense
· Get-HPOVLogicalEnclosure
· Get-HPOVLogicalInterconnect
· Get-HPOVLogicalInterconnectGroup
· Get-HPOVLogicalInterconnectPortMonitoring
· Get-HPOVLogicalSwitch
· Get-HPOVLogicalSwitchGroup
· Get-HPOVLoginMessage
· Get-HPOVManagedSan
· Get-HPOVNetwork
· Get-HPOVNetworkSet
· Get-HPOVOSDeploymentPlan
· Get-HPOVOSDeploymentPlanAttribute
· Get-HPOVOSDeploymentServer
· Get-HPOVPendingUpdate
· Get-HPOVPowerDevice
· Get-HPOVPowerPotentialDeviceConnection
· Get-HPOVRack
· Get-HPOVRackManager
· Get-HPOVRackMember
· Get-HPOVRemoteSupport
· Get-HPOVRemoteSupportContact
· Get-HPOVRemoteSupportDataCollectionSchedule
· Get-HPOVRemoteSupportDefaultSite
· Get-HPOVRemoteSupportEntitlementStatus
· Get-HPOVRemoteSupportPartner
· Get-HPOVRemoteSupportSetting
· Get-HPOVRemoteSyslog
· Get-HPOVReservedVlanRange
· Get-HPOVRole
· Get-HPOVSanManager
· Get-HPOVSanZone
· Get-HPOVSasInterconnectType
· Get-HPOVSasLogicalInterconnect
· Get-HPOVScmbCertificates
· Get-HPOVScope
· Get-HPOVServer
· Get-HPOVServerHardwareType
· Get-HPOVServerProfile
· Get-HPOVServerProfileConnectionList
· Get-HPOVServerProfileMessage
· Get-HPOVServerProfileTemplate
· Get-HPOVServiceAlert
· Get-HPOVSMTPConfig
· Get-HPOVSnmpReadCommunity
· Get-HPOVSnmpV3User
· Get-HPOVStoragePool
· Get-HPOVStoragePool
· Get-HPOVStorageSystem
· Get-HPOVStorageVolume
· Get-HPOVStorageVolumeSnapShot
· Get-HPOVStorageVolumeTemplate
· Get-HPOVStorageVolumeTemplatePolicy
· Get-HPOVSwitch
· Get-HPOVSwitchType
· Get-HPOVTask
· Get-HPOVUnmanagedDevice
· Get-HPOVUplinkSet
· Get-HPOVUser
· Get-HPOVVersion
· Get-HPOVXApiVersion
· Import-HPOVSslCertificate
· Install-HPOVApplianceCertificate
· Install-HPOVLogicalInterconnectFirmware
· Install-HPOVUpdate
· Invoke-HPOVVcmMigration
· Invoke-HPOVWebBrowser
· Join-HPOVServerProfileToTemplate
· New-HPOVAddressPoolRange
· New-HPOVAddressPoolSubnet
· New-HPOVApplianceCsr
· New-HPOVApplianceSelfSignedCertificate
· New-HPOVApplianceTrapDestination
· New-HPOVBackup
· New-HPOVClusterProfile
· New-HPOVCustomBaseline
· New-HPOVDataCenter
· New-HPOVEnclosureGroup
· New-HPOVExternalRepository
· New-HPOVLdapDirectory
· New-HPOVLdapGroup
· New-HPOVLdapServer
· New-HPOVLicense
· New-HPOVLogicalEnclosure
· New-HPOVLogicalInterconnectGroup
· New-HPOVLogicalSwitch
· New-HPOVLogicalSwitchGroup
· New-HPOVNetwork
· New-HPOVNetworkSet
· New-HPOVOSDeploymentServer
· New-HPOVQosConfig
· New-HPOVQosTrafficClass
· New-HPOVRack
· New-HPOVRemoteSupportContact
· New-HPOVRemoteSupportPartner
· New-HPOVResource
· New-HPOVRestore
· New-HPOVScope
· New-HPOVServerProfile
· New-HPOVServerProfileAssign
· New-HPOVServerProfileAttachVolume
· New-HPOVServerProfileConnection
· New-HPOVServerProfileLogicalDisk
· New-HPOVServerProfileLogicalDiskController
· New-HPOVServerProfileTemplate
· New-HPOVSnmpConfiguration
· New-HPOVSnmpTrapDestination
· New-HPOVSnmpV3User
· New-HPOVStorageVolume
· New-HPOVStorageVolumeSnapshot
· New-HPOVStorageVolumeTemplate
· New-HPOVSupportDump
· New-HPOVUnmanagedDevice
· New-HPOVUplinkSet
· New-HPOVUser
· Ping-HPOVAddress
· Pop-HPOVAppliancePermission
· Push-HPOVAppliancePermission
· Remove-HPOVAddressPoolRange
· Remove-HPOVAddressPoolSubnet
· Remove-HPOVAlert
· Remove-HPOVApplianceProxy
· Remove-HPOVApplianceTrapDestination
· Remove-HPOVApplianceTrustedCertificate
· Remove-HPOVBaseline
· Remove-HPOVDataCenter
· Remove-HPOVEnclosure
· Remove-HPOVEnclosureGroup
· Remove-HPOVExternalRepository
· Remove-HPOVFabricManager
· Remove-HPOVHypervisorManager
· Remove-HPOVLdapDirectory
· Remove-HPOVLdapGroup
· Remove-HPOVLdapServer
· Remove-HPOVLicense
· Remove-HPOVLogicalEnclosure
· Remove-HPOVLogicalInterconnectGroup
· Remove-HPOVLogicalSwitch
· Remove-HPOVLogicalSwitchGroup
· Remove-HPOVNetwork
· Remove-HPOVNetworkSet
· Remove-HPOVOSDeploymentServer
· Remove-HPOVPendingUpdate
· Remove-HPOVPowerDevice
· Remove-HPOVRack
· Remove-HPOVRackManager
· Remove-HPOVRackMember
· Remove-HPOVRemoteSupportContact
· Remove-HPOVRemoteSupportPartner
· Remove-HPOVResource
· Remove-HPOVResourceFromLabel
· Remove-HPOVResourceFromScope
· Remove-HPOVSanManager
· Remove-HPOVScmbCertificate
· Remove-HPOVScope
· Remove-HPOVServer
· Remove-HPOVServerProfile
· Remove-HPOVServerProfile
· Remove-HPOVServerProfileTemplate
· Remove-HPOVSnmpV3User
· Remove-HPOVStandbyComposerNode
· Remove-HPOVStoragePool
· Remove-HPOVStorageSystem
· Remove-HPOVStorageVolume
· Remove-HPOVStorageVolumeSnapshot
· Remove-HPOVStorageVolumeTemplate
· Remove-HPOVUnmanagedDevice
· Remove-HPOVUser
· Reset-HPOVEnclosureDevice
· Restart-HPOVAppliance
· Restart-HPOVServer
· Restore-HPOVCustomBaseline
· Save-HPOVBackup
· Save-HPOVServerProfile
· Save-HPOVServerProfileTemplate
· Search-HPOVAssociations
· Search-HPOVIndex
· Send-HPOVRequest
· Set-HPOVAddressPoolSubnet
· Set-HPOVAlert
· Set-HPOVApplianceCurrentSecurityMode
· Set-HPOVApplianceDateTime
· Set-HPOVApplianceDefaultConnection
· Set-HPOVApplianceGlobalSetting
· Set-HPOVApplianceNetworkConfig
· Set-HPOVApplianceProxy
· Set-HPOVApplianceSecurityProtocol
· Set-HPOVApplianceTwoFactorAuthentication
· Set-HPOVAutomaticBackupConfig
· Set-HPOVDataCenter
· Set-HPOVDataCenterRemoteSupport
· Set-HPOVEnclosure
· Set-HPOVEnclosureActiveFLM
· Set-HPOVEnclosureGroup
· Set-HPOVEulaStatus
· Set-HPOVExternalRepository
· Set-HPOVHypervisorManager
· Set-HPOVInitialPassword
· Set-HPOVLdapDefaultDirectory
· Set-HPOVLdapGroupRole
· Set-HPOVLogicalEnclosure
· Set-HPOVLoginMessage
· Set-HPOVManagedSan
· Set-HPOVNetwork
· Set-HPOVNetworkSet
· Set-HPOVRackMemberLocation
· Set-HPOVRemoteSupport
· Set-HPOVRemoteSupportDataCollectionSchedule
· Set-HPOVRemoteSupportDefaultSite
· Set-HPOVRemoteSupportSetting
· Set-HPOVRemoteSyslog
· Set-HPOVReservedVlanRange
· Set-HPOVResource
· Set-HPOVSanManager
· Set-HPOVServerHardwareType
· Set-HPOVServerPower
· Set-HPOVServerProfile
· Set-HPOVServerProfileTemplate
· Set-HPOVSmtpConfig
· Set-HPOVSnmpReadCommunity
· Set-HPOVStoragePool
· Set-HPOVStorageVolume
· Set-HPOVStorageVolumeTemplate
· Set-HPOVStorageVolumeTemplatePolicy
· Set-HPOVUser
· Set-HPOVUserPassword
· Set-HPOVUserRole
· Show-HPOVActiveUser
· Show-HPOVApplianceSecurityModeCompatibilityReport
· Show-HPOVFirmwareReport
· Show-HPOVHypervisorCluster
· Show-HPOVLdapGroups
· Show-HPOVLogicalInterconnectMacTable
· Show-HPOVPortStatistics
· Show-HPOVSanEndpoint
· Show-HPOVUserSession
· Start-HPOVLibraryTrace
· Start-HPOVRemoteSupportCollection
· Start-HPOVServer
· Stop-HPOVAppliance
· Stop-HPOVLibraryTrace
· Stop-HPOVServer
· Test-HPOVEmailAlert
· Update-HPOVApplianceTrustedAuthorityCrl
· Update-HPOVEnclosure
· Update-HPOVExternalRepository
· Update-HPOVLogicalEnclosure
· Update-HPOVLogicalEnclosureFirmware
· Update-HPOVLogicalInterconnect
· Update-HPOVLogicalSwitch
· Update-HPOVRackManager
· Update-HPOVRemoteSupportEntitlement
· Update-HPOVSanManager
· Update-HPOVServer
· Update-HPOVServerHardwareLicenseIntent
· Update-HPOVServerProfile
· Update-HPOVStorageSystem
· Wait-HPOVApplianceStart
· Wait-HPOVTaskComplete
about_HPOneView.420
· Wait-HPOVTaskStart
TOPIC
about_HPOneView.420
COPYRIGHT
(C) Copyright 2013-2019 Hewlett Packard Enterprise Development LP
LICENSE
Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
SHORT DESCRIPTION
PowerShell library for HP OneView 4.10
WHAT'S NEW
Release 4.20.1971.1960
-- Initial 4.20 release.
LONG DESCRIPTION
This library provides HP OneView management capabilities for Windows PowerShell.

The library can be used as either a CLI or using the core cmdlets to call from
wrapper scripts. The core cmdlets are:
-- Connect-HPOVmgmt
-- Send-HPOVRequest
-- New-HPOVResource
-- Set-HPOVResource
-- Remove-HPOVResource
A set of sample scripts are also provided, that show how to fully configure an
HP OneView appliance from the ground up.
For information regarding this project, to request features or report

issues, please see: https://github.com/HewlettPackard/POSH-HPOneView/issues
SEE ALSO
https://github.com/HewlettPackard/POSH-HPOneView
http://hpe.com/info/oneviewcommunity
Update-Help HPOneView.420
Get-Help about_Appliance_Connections
Get-Help about_Appliance_Connection_Permissions
Get-Help about_Two_Factor_Authentication
Get-Help Connect-HPOVmgmt
Get-Help Send-HPOVRequest
[install_dir]\Samples
about_HPOneView.410
TOPIC
about_HPOneView.410
COPYRIGHT
LICENSE

THE SOFTWARE.
SHORT DESCRIPTION
WHAT'S NEW
Release 4.10.1718.2245
-- Initial 4.10 release.
LONG DESCRIPTION

-- Connect-HPOVmgmt
-- Send-HPOVRequest
-- New-HPOVResource
-- Set-HPOVResource
-- Remove-HPOVResource

SEE ALSO
Update-Help HPOneView.410
about_HPOneView.400
TOPIC
about_HPOneView.400
COPYRIGHT
LICENSE

THE SOFTWARE.
SHORT DESCRIPTION
WHAT'S NEW
Release 4.00.1554.2229
-- First release of HPE OneView 4.00 PowerShell library.

-- Added SmartCard/CAC support to Connect-HPOVMgmt.
-- Refactored SSL/TLS certificate validation to support SmartCard/CAC authentication.
-- Deprecated SslChecked property in HPOneView.Appliance.Connection object.
-- Added ActivePermissions (List<HPOneView.Appliance.ConnectionPermission>) property
to HPOneView.Appliance.Connection objects, which contains the SBAC permission(s) of
the logged in user.
-- Updated New-HPOVLdapServer to support trusting the leaf certificate by adding a new
parameter called -TrustLeafCertificate. This parameter would be required if the
issuing certificate authority certificate has not been added to the appliance.
-- Changed Class Object type for $PSLibraryVersion.'ApplianceNode' to HPOneView.Appliance.NodeInfo.
-- Added SNMPv1 and SNMPv3 appliance trap destination support.
-- Added SNMPv3 User appliance support.
-- Added the ability to get the appliance proxy settings.
-- Added support for Active Diretory SRV record support to New-HPOVLdapServer.
-- Updated New-HPOVServerProfile and New-HPOVServerProfileAssign to support confirmation
when hardware health state is not OK. Use -Confirm switch parameter to override.
LONG DESCRIPTION

• Connect-HPOVmgmt
• Send-HPOVRequest
• New-HPOVResource
• Set-HPOVResource
• Remove-HPOVResource

SEE ALSO
Update-Help HPOneview.400
about_Appliance_Connections
TOPIC
about_Appliance_Connections
SHORT DESCRIPTION
Explains how Multiple Appliance Connections are handled with the

HPE OneView 2.00 and newer PowerShell Library.
LONG DESCRIPTION
In the HPE OneView 2.0 or newer PowerShell library is the ability to

initiate multiple appliance connections to script or automate operations.
To support this capability, the library utilizes three features:
-- When using Connect-HPOVMgmt, an [HPOneView.Appliance.Connection] object

is returned to the caller.
-- The [HPOneView.Appliance.Connection] object is stored in a global variable

accessible by any caller: $ConnectedSessions
-- Within the [HPOneView.Appliance.Connection] object is a property called

Default. This boolean value is what controls which appliance
to execute against if the caller does not specify which appliance
connection to use.
GLBOAL CONNECTION TRACKING OBJECT
Contained in the $ConnectedSessions Global varilable, will be each

successful appliance connection object, HPOneView.Appliance.Connection.
The object contains the following properties:
-- ConnectID - Unique per PowerShell library session

-- Name - Hostname of the appliance connection, specified by the
'Hostname' parameter in Connect-HPOVMgmt.
-- SessionID - Appliance API Auth session ID
-- UserName - Username that was authenticated with to the appliance
-- AuthLoginDomain - Authentication Directory resource name used to
authenticate user.
-- Default - Boolean value that tracks which connection is the default.
Use the Set-HPOVApplianceDefaultConnection Cmdlet to control the value
Use the Set-HPOVApplianceDefaultConnection Cmdlet to control the value
-- SSLChecked - library specific property to handle SSL certificate
verification. (DEPRECATED and no longer valid)
-- ApplianceType - Indicates connected appliance type. Used for cetain
Cmdlet validation.
-- AuthType - Credential or Certificate/Two-Factor authentication.
-- ActivePermissions - A collection of HPOnewView.Appliance.ConnectionPermission
objects that contain the Scope and Role available to the authenticated
user.
-- ApplianceSecurityRoles - The allowed roles by the connected appliance.
Property value is used to validate roles when assigning to Directory
groups or local user accounts.
-- Default - used to define which connection is the 'default' for Cmdlet
processing. Use the Set-HPOVApplianceDefaultConnection Cmdlet to modify
this value.
After successfully authenticating to an appliance, the

HPOneView.Appliance.Connection object is added to the global session
tracker, $ConnectedSessions.
HOW TO USE CONNECTION IN CMDLETS
The PowerShell user can store the returned HPOneView.Appliance.Connection

object in their own local, script-runspace variable, and pass it as the
ApplianceConnection parameter value in supported CMDLETs.
Some CMDLETs will default to using all connections within $ConnectedSessions,

and can be overridden by referencing the specific connection Name or
object.
For instance, Get-HPOVNetwork will default to processing all appliance

connections, as the -ApplianceConnection parameter default value is
$ConnectedSessions. To override its default value, you can either specify
the object, or the appliance connection Name property value.
This example shows how to use the connection 'object':
PS C:\> $Connection1 = Connect-HPOVMgmt hpov1.domain.com administrator MyPassw0rd

PS C:\> $ConnectedSessions
ConnectionID Name UserName AuthLoginDomain Default

------------ ---- -------- --------------- -------
1 hpov1.domain.com Administrator LOCAL True
2 hpov2.domain.com Administrator LOCAL False
PS C:\> Get-HPOVNetwork -ApplianceConnection $Connection1

...
This example shows how to use the connection 'name':


------------ ---- -------- --------------- -------
PS C:\> Get-HPOVNetwork -ApplianceConnection hpov1.domain.com

...
SETTING DEFAULT APPLIANCE CONNECTION
When authenticating to your first appliance, the 'Default' property is automatically

set to True. Additional Appliance Connections are candidates to set as your new
default appliance connection. To do this, use the Set-HPOVApplianceDefaultConnection
Cmdlet. You will specify either an HPOneView.Appliance.Connection object (either from
${Global:ConnectedSessions} or the saved object returned from Connect-HPOVMgmt) or
connection Name.
connection Name.
This example shows how to modify your default appliance connection after successfully
authenticating to them:


------------ ---- -------- --------------- -------
PS C:\> $Connection2 | Set-HPOVApplianceDefaultConnection

------------ ---- -------- --------------- -------
APPLIANCECONNECTION PROPERTY VALUE IN OBJECTS
When using the various CMDLETs, the returned resource object(s) will contain a
property called ApplianceConnection [HPOneView.Library.ApplianceConnection]:
-----------------------
| ApplianceConnection |
-----------------------
|
| ----------------------
|---| [int] ConnectionID |
| ----------------------
| -----------------
|---| [string] Name |
| -----------------
The 'ConnectionID' and 'Name' sub-properties reference the Appliance Connection

contained within ${Global:ConnectedSessions}. These are used to identify resources
that originate from the correct appliance, as each object is unique per appliance.
To use these properties with Send-HPOVRequest, they can be referenced with their dot
name reference (e.g. $ServerProfile.ApplianceConnection.Name).
SEE ALSO
http://hp.com/go/oneviewcommunity
Get-Help about_HPOneView.400
about_Appliance_Connection_Permissions
TOPIC
about_Appliance_Connection_Permissions
SHORT DESCRIPTION
Explains how HPE OneView 4.00 and newer session permissions can be changed.
LONG DESCRIPTION
Permissions are used to control a user's access to the appliance and the resources
managed by the appliance. Permissions consist of a role and an optional scope. The
permission role grants the user access to resource categories. For example, the "Server
administrator" role grants read, create, delete, update and use rights to the "server
hardware" category. Specifying a permission scope further restricts the rights granted
by the role to a subset of instances within a resource category. For example, a scope
called "Test" can be created by the Infrastructure Administrator or Scope Administrator,
and be used to restrict the server hardware rights granted by the "Server administrator"
role to only the servers in the Test scope.
role to only the servers in the Test scope.
A user or group may be assigned multiple permissions. Use the Set-HPOVUser or

Set-HPOVLdapGroupRole to manage the roles and permissions assigned to a user or group.
You create a login session when you log in to the appliance using Connect-HPOVMgmt. Upon
successful login, the session grants the user all permissions assigned by the
Infrastructure Administrator or Scope Administrator. These permissions are called
[HPOneView.Appliance.ConnectionPermission]. Each permission provided by the appliance are
stored within the [HPOneView.Appliance.Connection] AcivePermissions property. The Active
property indicates if the permission is active.
A user granted multiple permissions can disable certain permissions. When operating with
reduced permissions, the user is only allowed to perform actions authorized for the selected
permission.
Allowing a user to operate in a least privilege mode is a security best practice. It

allows the user to reduce the risk of making an unintended change.
CHANGING ACTIVE PERMISSIONS
Upon successful login, the caller can change their active permissions, and operate in
a less priviledge mode at anytime. The Push-HPOVAppliancePermission Cmdlet will accept a
single or collection of [HPOneView.Appliance.ConnectionPermission] objects. A new SessionID
token will be stored within the ApplianceConnection, and the ConnectionPermissions within
the ActivePermissions property that were not provided will have the Active property set to
"false".
For example, to change the active permissions to the assigned "Network administrator" role:
PS C:\> # Show current SessionID

PS C:\> $ConnectedSessions[0].SessionID
MzA3MzkzNDY4Mjc3tG-DBtvzHwq51sBGY1zk-7Uw1eT17BbJ
PS C:\> Connect-HPOVMgmt hpov1.domain.com administrator MyPassw0rd
PS C:\> $ConnectedSessions[0].ActivePermissions
RoleName ScopeName Active

-------- --------- ------
Network administrator Site A Admins True
Server administrator AllResources True
PS C:\> $NewPermissions = $ConnectedSessions[0].ActivePermissions | ? RoleName -match 'Network'

PS C:\> Push-HPOVAppliancePermission -SetActivePermissions $NewPermissions

-------- --------- ------
Server administrator AllResources False
PS C:\> # Show updated SessionID

OTA0Mjg2Nzc5Nzk1FVcdSabKJ5wqD-ScZKYOHsJk8WqWDRYX
...
For example, to change the active permissions to the assigned "Site A Admins" scope:
PS C:\> # Show current SessionID

NzI2MTMxNzEzMjQztb0Rj0hqWwiLa3qFWgKvo13Qn5vs4k1r
PS C:\> $ConnectedSessions[0].ActivePermissions

-------- --------- ------
PS C:\> $NewPermissions = $ConnectedSessions[0].ActivePermissions | ? ScopeName -match 'Site A Admins'

PS C:\> Push-HPOVAppliancePermission -SetActivePermissions $NewPermissions

-------- --------- ------
PS C:\> # Show updated SessionID

ATh0MjQ5MjM1ODE0fFqfxUPWWGo4Y-QsPWRpZDsYxmy8Xejb
...
If the caller would like to reset their active permissions back to the original state, use
the Pop-HPOVAppliancePermission Cmdlet.
SEE ALSO
Get-Help Push-HPOVAppliancePermission
Get-Help Pop-HPOVAppliancePermission
about_Two_Factor_Authentication
TOPIC
about_Two_Factor_Authentication
SHORT DESCRIPTION
How to utilize two factor authentication with the HPE Oneview PowerShell
library.
LONG DESCRIPTION
Passwords, no matter how complex, provide insufficient security for many

applications. For additional security, use two-factor authentication. With
two-factor authentication, two factors are required for HPE OneView authentication.
The two factors are something the user possesses (a smart card), and something the
user knows (a personal identification number).
HPE OneView user/password authentication

----------------------------------------
Users can be configured in HPE OneView as local users, or remotely in an

enterprise directory.
The traditional user name and password login sequence is as follows:
1. The user types their user name and password.

2. HPE OneView authenticates the user name and password.
* If the user name is that of a local user configured in HPE OneView, HPE
OneView validates a manually specified user name and password using the HPE
OneView database.
* If your environment is configured to use an enterprise directory, HPE OneView
immediately forwards the user name and password to a configured directory
server for authentication.
3. Once authentication is successful, HPE OneView determines the authorization

permissions for the user.
* If it is a local user login, authorization permissions are decided based

on the roles associated with the user.
* If it is an enterprise directory login, HPE OneView sends a request to the
directory server to retrieve the group name associated with the user. It uses
the group name to determine the authorization permission for the user configured
in HPE OneView.
HPE OneView two-factor authentication

-------------------------------------
Enabling two-factor authentication allows you to use smart cards — for example,
Common Access Cards (CAC), or Personal Identity Verification (PIV) cards — to
authenticate within HPE OneView. The client certificate embedded in the smart
card is presented to HPE OneView by the library. The client certificate must be
signed by a root or intermediate Certificate Authority (CA) that has been
previously imported into HPE OneView. The appliance authenticates the client
certificate to validate that the user name specified in the certificate is that
of a valid user recognized by the directory server configuration in HPE OneView.
When two-factor authentication is enabled, HPE OneView uses a Microsoft Active

Directory service account set up and owned by the user to access an Active Directory
entry for the user, rather than using an account associated with the user name
received during first time login.
The certificates stored on CAC/PIV cards are X.509 security certificates. They
contain fields of information used to identify the certificate owner, the
certificate issuer, and other certificate identification elements. When you
enable two-factor authentication, you can specify which certificate fields HPE
OneView must use to validate a user.
An Infrastructure administrator also has the flexibility to customize the rules

HPE OneView applies during client certificate authentication. The Infrastructure
administrator can configure the locations within the certificate from which HPE
OneView retrieves the user name, domain name and the OIDs that must be present
for the certificate to be valid. See Set-HPOVApplianceTwoFactorAuthentication
help.
AUTHENTICATING USING A SMARTCARD
The users smart card or digital badge must be present on the PC. Using PowrShell's
native Certificate provider, the smart card can be accessed using the following:
PS C:\> $MyCertificate = gci Cert:\CurrentUser\my | ? { $_.EnhancedKeyUsageList.FriendlyName -match 'Sm

art Card Logon' }
Then, the $MyCertificate object can be passed into the Connect-HPOVMgmt

Cmdlet:
PS C:\> Connect-HPOVMgmt -Hostname Myappliance.domain.com -Certificate $MyCertificate
GLBOAL CONNECTION TRACKING OBJECT AND 2FA PROPERTIES
Contained in the $ConnectedSessions Global varilable, will be each

successful appliance connection object, HPOneView.Appliance.Connection.
When authenticating with a smart card, the AuthType property of the
HPOneView.Appliance.Connection object will be set to "Certificate".
The "Authentication" property will be set to the Active Directory
authentication directory that authenticated the request. The
"ActivePermissions" property will contain the available Scopes and
Roles.
To examine which Roles and Scopes are available for the logged in
account, examine the [HPOneView.Appliance.Connect].ActivePermissions
property. This property is a collection of HPOneView.Appliance.ActivePermissions
objects. The [String]ScopeName, [String]RoleName, and [Bool]Active
properties
The SessionID within HPOneView.Appliance.Connection object contains

the current users active permission set. To modify the active permission
set, use either the Pop-HPOVAppliancePermission or Push-HPOVAppliancePermission
Cmdlets.
HOW TO USE SCOPES IN CMDLETS
Scopes by default are managed by Infrastructure administrators, unless

the HPOneView.Appliance.ScopeCollection resource has been scoped to a
local user or directory user with Scope administrator role. Once a
scope has been created, it can be used to filter for supported resource
objets:
* Enclosures
* Server Hardware
* Networks (Ethernet, FC, and FCoE)
* Network Sets
* Interconnects, excluding SAS resources
* Logical Interconnects, excluding SAS resources
* Logical Interconnect Groups, excluding SAS resources
* Switches
* Logical Switches
* Logical Switch Groups
The supporting Cmdlets for the above resources include a -Scope parameter
that allowed the caller to supply one or more HPOneView.Appliance.ScopeCollection
resources to filter. By default, the appliance will return all available
resources that are part of the users Active Permissions Set.
For instance, Get-HPOVNetwork -Scope $MyScopeObject will return only the

network objects that are a member of the scope within the $MyScopeObject
variable:
PS C:\> $MyScopeObject = Get-HPOVScope -Name MyScope -ErrorAction Stop

PS C:\> Get-HPOVNetwork -Scope $MyScopeObject
Type: Ethernet
Name Status Purpose Type VlanID IPv4Subnet Smartlink PrivateNetwork PreferredBandwidth MaxBand
width
---- ------ ------- ---- ------ ---------- --------- -------------- ------------------ -------
-----
Dev VLAN 101-A OK General Tagged 101 None True False 2500 20000
Dev VLAN 101-B OK General Tagged 101 None True False 2500 20000
Type: Fibre Channel
Name Status Type TypicalBandwidth MaxBandwidth AutoLoginRedistribution LinkStabilityInterval Ma

nagedSAN
---- ------ ---- ---------------- ------------ ----------------------- --------------------- --
--------
Fabric A OK FabricAttach 4000 20000 True 30 SA
Fabric B OK FabricAttach 4000 20000 True 30 SA
...
SEE ALSO
Add-HPOVApplianceTrustedCertificate
Library Version 4.20

HPE OneView 4.10 Library

Add X.509 SSL certificates to appliance trusted store.
SYNTAX
Add-HPOVApplianceTrustedCertificate [-Path] <System.IO.FileInfo> [-CertObject] <Object>[ [-ComputerName] <String
>][ [-Port] <Int>][ [-AliasName] <String>][ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-Applianc
eConnection] <Object>] [<CommonParameters>]
Detailed Description
This Cmdlet will allow the Infrastructure Administrator to add X.509 compliant SSL certificates to the appliance trusted store.
Parameters
-AliasName <String>
Specify an alias name of the certificate stored on the appliance. By default, the Subject name will be used.
Aliases None
Required? False
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? False
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection objects or Name property values.
Default Value: ${Global:ConnectedSessions} | ? Default
Aliases Appliance
Required? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
-Async <SwitchParameter>
Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.
Aliases None
Required? False
Position? named
Default value False

-CertObject <Object>
Specify the public Base64 X.509 certificate of the remote endpoint to add to the appliances internal trust store.
Aliases None
Required? True
Position? named
Default value
Accept pipeline input? true (ByValue)
-ComputerName <String>
The remote endpoint Computer Name or IP Address. This should match either the X.509 Subject or Subject Alternative Name
fields with in the cert object. If omitting the -CertObject parameter, the Cmdlet will initiate a TCP connection in order to retrieve
the certificate. Use the -Port parameter to specify the correct TCP port the SSL/TLS service is listening on.
Aliases None
Required? False
Position? named
Default value
-Force <SwitchParameter>
Use to force add an untrusted (self-signed or a certificate authority certificate has not been added to the appliance) certificate
into the appliances trust store.
Aliases None
Required? False
Position? named
Default value
-Path <System.IO.FileInfo>
The filesystem object of the X.509 public SSL certificate to add.
Aliases None
Required? true
Position? named
Default value
-Port <Int>
Specify the TCP port where the TLS/SSL service is bound and listening on. Use with the -ComputerName parameter.
Aliases None
Required? False
Position? named
Default value
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters
(http://go.microsoft.com/fwlink/?LinkID=113216)
Input Types
System.IO.FileInfo
Return Values
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Asyncronous task resource to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-ChildItem C:\Path\srv1-pub.cer | Add-HPOVApplianceTrustedCertificate
Add the provided offline certificate to the appliance trust store.

-------------------------- EXAMPLE 2 --------------------------
Add-HPOVApplianceTrustedCertificate -ComputerName $RemoteBackupHostname -Port 443 -AliasName backupserver -Async

-Outvariable Task
Use the Cmdlet to add the remote certificate to the appliance trust store without waiting for the task to complete.
-------------------------- EXAMPLE 3 --------------------------
Add-HPOVApplianceTrustedCertificate -ComputerName server1-ilo.domain.com -AliasName server1iLo -force
Use the Cmdlet to add the self-signed iLO certificate to the appliance. ### Related Links * [Get-
HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceTrustedCertificate) * [Remove-HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVApplianceTrustedCertificate) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVApplianceTrustedCertificate
Add X.509 SSL certificates to appliance trusted store. ### SYNTAX
Add-HPOVApplianceTrustedCertificate [-Path] <System.IO.FileInfo> [-CertObject] <Object>[ [-ComputerName] <String

>][ [-Port] <Int>][ [-AliasName] <String>][ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-Applianc
eConnection] <Object>] [<CommonParameters>]
This Cmdlet will allow the Infrastructure Administrator to add X.509 compliant SSL certificates to the appliance trusted store.
Parameters
-AliasName <String>
Specify an alias name of the certificate stored on the appliance. By default, the Subject name will be used.
Aliases None
Required? False
Position? named
Default value
Aliases Appliance
Required? false
Position? named
Aliases None
Required? False
Position? named
Default value False
-CertObject <Object>
Specify the public Base64 X.509 certificate of the remote endpoint to add to the appliances internal trust store.
Aliases None
Required? True
Position? named
Default value
The remote endpoint Computer Name or IP Address. This should match either the X.509 Subject or Subject Alternative Name
fields with in the cert object. If omitting the -CertObject parameter, the Cmdlet will initiate a TCP connection in order to retrieve
the certificate. Use the -Port parameter to specify the correct TCP port the SSL/TLS service is listening on.
Aliases None
Required? False
Position? named
Default value
Use to force add an untrusted (self-signed or a certificate authority certificate has not been added to the appliance) certificate
into the appliances trust store.
Aliases None
Required? False
Position? named
Default value
-Path <System.IO.FileInfo>
Aliases None
Required? true
Position? named
Default value
-Port <Int>
Specify the TCP port where the TLS/SSL service is bound and listening on. Use with the -ComputerName parameter.
Aliases None
Required? False
Position? named
Default value
<CommonParameters>
Input Types
System.IO.FileInfo
Return Values
Asyncronous task resource to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-ChildItem C:\Path\srv1-pub.cer | Add-HPOVApplianceTrustedCertificate
Add the provided offline certificate to the appliance trust store.
-------------------------- EXAMPLE 2 --------------------------
Add-HPOVApplianceTrustedCertificate -ComputerName $RemoteBackupHostname -Port 443 -AliasName backupserver -Async

-Outvariable Task
Use the Cmdlet to add the remote certificate to the appliance trust store without waiting for the task to complete.
-------------------------- EXAMPLE 3 --------------------------
Add-HPOVApplianceTrustedCertificate -ComputerName server1-ilo.domain.com -AliasName server1iLo -force
Use the Cmdlet to add the self-signed iLO certificate to the appliance.
Related Links
Get-HPOVApplianceTrustedCertificate
Remove-HPOVApplianceTrustedCertificate
Top
Add-HPOVBaseline

Add-HPOVBaseline
Upload new SPP Baseline to appliance firmware repository.
SYNTAX
Add-HPOVBaseline [-File] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection] <Arra
y>][ [-Async] <SwitchParameter>] [<CommonParameters>]
This Cmdlet provides the ability to upload a new SPP Baseline into the appliance. It will return after the upload has completed
but before the SPP file has been imported into the firmware repository.
After upload the baseline ISO, any . (period character) within the filename will be chaned to the _ (underscore character) by the
appliance. So, if a baseline ISo file name is "bp.2016.04.custom.ISo", the appliance will change the filename to
"bp_2016_04_custom.iso".
Parameters
-ApplianceConnection <Array>
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).
Aliases Appliance
Required? false
Position? 2
Aliases None
Required? false
Position? named
Default value False
-File <String>
Aliases [-sppFile]
The full path and file name of the SPP file. The function returns an error if the file path cannot be validated.
Aliases sppFile
Required? true
Position? 0
Default value
-Scope <HPOneView.Appliance.ScopeCollection>
Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to
scope using the Add-HPOVResourceToScope Cmdlet.
Aliases None
Required? False
Position? 1
Default value False
<CommonParameters>
Input Types
System.IO.FileSystemInfo
File System bject from Get-ChildItem
Return Values
System.Management.Automation.PSCustomObject
The progress of uploading the file to the appliance, and in-progress or completion result.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVBaseline "C:\Users\me\Documents\SPP2012060B.2012.0525.1.iso"
Upload SPP ISO to all connected appliances. ### Related Links * [Get-HPOVBaseline](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVBaseline) * [Get-HPOVBaselineRepository](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVBaselineRepository) * [Remove-HPOVBaseline](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVBaseline) * [Show-HPOVBaselineRepositorySize](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Show-HPOVBaselineRepositorySize) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVBaseline
Upload new SPP Baseline to appliance firmware repository. ### SYNTAX
Add-HPOVBaseline [-File] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection] <Arra

y>][ [-Async] <SwitchParameter>] [<CommonParameters>]
This Cmdlet provides the ability to upload a new SPP Baseline into the appliance. It will return after the upload has completed
but before the SPP file has been imported into the firmware repository.
After upload the baseline ISO, any . (period character) within the filename will be chaned to the _ (underscore character) by the
appliance. So, if a baseline ISo file name is 'bp.2016.04.custom.ISo', the appliance will change the filename to
'bp_2016_04_custom.iso'.
Parameters
Aliases Appliance
Required? false
Position? 2
Aliases None
Required? false
Position? named
Default value False
-File <String>
Aliases [-sppFile]
The full path and file name of the SPP file. The function returns an error if the file path cannot be validated.
Aliases sppFile
Required? true
Position? 0
Default value
Aliases None
Required? False
Position? 1
Default value False
<CommonParameters>
Input Types
File System bject from Get-ChildItem
Return Values
The progress of uploading the file to the appliance, and in-progress or completion result.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVBaseline "C:\Users\me\Documents\SPP2012060B.2012.0525.1.iso"
Upload SPP ISO to all connected appliances.
Related Links
Get-HPOVBaseline
Get-HPOVBaselineRepository
Remove-HPOVBaseline
Show-HPOVBaselineRepositorySize
Top
Add-HPOVClusterNodeToCluster

Default content
SYNTAX
Add-HPOVClusterNodeToCluster [<CommonParameters>]
Default content
Parameters
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example
Related Links
Top
Add-HPOVEnclosure

Add-HPOVEnclosure
Import an enclosure.
SYNTAX
Add-HPOVEnclosure [-Hostname] <String> [-EnclosureGroup] <Object> [-Username] <String> [-Password] <Object> [-Li
censingIntent] <String> [-Baseline] <Object>[ [-ForceInstallFirmware] <SwitchParameter>][ [-Scope] <Array>][ [-A
sync] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonP
arameters>]
Add-HPOVEnclosure [-Hostname] <String> [-EnclosureGroup] <Object>[ [-Credential] <PSCredential>] [-LicensingInte

nt] <String> [-Baseline] <Object>[ [-ForceInstallFirmware] <SwitchParameter>][ [-Scope] <Array>][ [-Async] <Swit
chParameter>][ [-ApplianceConnection] <Object>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Add-HPOVEnclosure [-Hostname] <String>[ [-Credential] <PSCredential>][ [-Monitored] <SwitchParameter>][ [-Scope]
<Array>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf] <>[ [-Confirm] <SwitchParamete
r>] [<CommonParameters>]
Add-HPOVEnclosure [-Hostname] <String> [-Username] <String> [-Password] <Object>[ [-Monitored] <SwitchParameter>

][ [-Scope] <Array>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf] <>[ [-Confirm] <Sw
itchParameter>] [<CommonParameters>]
This cmdlet will import an enclosure for HPE OneView management. The Onboard Administrator needs to have at least an IP
Address for each OA module, and a valid Administrator account. An Enclosure Group must also be created.
Add-HPOVEnclosure will attempt a connection to the XML Reply interface to examine if an existing VC Domain is present. If so,
you are prompted if you wish to continue and force import the enclosure. FORCE IMPORT OF AN ENCLOSURE WILL DELETE
ANY EXISTING VC DOMAIN CONFIGURATION, AND NOT PERFORM ANY VC DOMAIN CONFIGURATION MIGRATION. PLEASE
BACKUP YOUR VC DOMAIN IF YOU WISH TO RESTORE TO ITS ORIGINAL CONFIGURATION.
Parameters
Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the
ApplianceConnection property of the object will be used.
Aliases None
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
-Baseline <Object>
Aliases [-fwIso, -fwBaselineIsoFilename]
Baseline File Name, Name, URI or Object.
Examples:
$FileName = "bp-hp-service-pack-for-proliant-oneview-2014-11-30-05.iso" $Name = "HP Service Pack For ProLiant OneView

2014 11 13"
Aliases fwIso, fwBaselineIsoFilename
Required? true
Position? named
Default value
-Confirm <SwitchParameter>
When attempting to add a Server to the appliance, the appliance will validate the target Server is not already claimed. If it is, this
parameter is used when the server has been claimed by another appliance to bypass the confirmation prompt, and force add
the server resource.
Aliases cf
Required? false
Position? named
Default value
-Credential <PSCredential>
Use this parameter if you want to provide a PSCredential object instead.
Aliases None
Required? False
Position? named
Default value
-EnclosureGroup <Object>
Aliases [-eg, -enclGroupName]
Enclosure Group Name to associate with the enclosure to import.
Aliases eg, EnclGroupName
Required? true
Position? named
Default value
-ForceInstallFirmware <SwitchParameter>
Aliases [-forceFw, -forceInstall]
Force the installation of the provided Firmware Baseline.

Aliases forceFw, forceInstall
Required? false
Position? named
Default value False
-Hostname <String>
Aliases [-oa]
IP Address, Hostname or FQDN of the Primary C7000 Onboard Administrator (OA).
Aliases oa
Required? true
Position? named
Default value
-LicensingIntent <String>
Aliases [-license, -l]
Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being
imported.
Accepted values are
* OneView
* OneViewNoiLO
Aliases license, l
Required? true
Position? named
Default value OneView
-Monitored <SwitchParameter>
Add the specified enclosure for monitor only management. You can view hardware for inventory and status information only.
Omitting this parameter, you can apply configurations, deploy server profiles, monitor operation status, collect statistics, and
alert users to specific conditions.
Aliases None
Required? false
Position? named
Default value False

-Password <Object>
Aliases [-p, -pw]
Administrator Account password of the OA specified. Value can be [String] or [SecureString].
Aliases p, pw
Required? true
Position? named
Default value
-Scope <Array>
Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.
Aliases None
Required? false
Position? named
Default value
-Username <String>
Aliases [-u, -user]
Administrator account of the target OA. Can be either an OA Local Administrator or Active Directory (AD) account if the OA is
configured for AD authentication.
Aliases u, user
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.EnclosureGroup [System.Management.Automation.PSCustomObject]
Enclosure Group Resource that will be used to set the Enlosure policy.
Return Values
Async task Resource object for monitoring the enclosure import process.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVEnclosure -oa "192.168.1.1" -enclGroupName EG1 -user admin -pass hpinvent -license OneView
Add a new enclosure to the appliance, using the EG1 Enclosure Group.
-------------------------- EXAMPLE 2 --------------------------
Add-HPOVEnclosure -oa "192.168.1.1" -enclGroupName EG1 -user admin -pass hpinvent -license OneView -confirm:$fal
se
Add a new enclosure to the appliance, using the EG1 Enclosure Group, and force add the target enclosure.
THIS IS A DISTRUCTIVE PROCESS IF AN EXISTING VC DOMAIN EXISTS.

-------------------------- EXAMPLE 3 --------------------------
Add-HPOVEnclosure -oa "192.168.1.1" -user admin -pass hpinvent -monitored
Add a new enclosure to the appliance for monitoring only. ### Related Links * [Get-HPOVEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVEnclosure) * [Get-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVEnclosureGroup) * [New-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVEnclosureGroup) * [Remove-HPOVEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVEnclosure) * [Remove-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVEnclosureGroup) * [Reset-HPOVEnclosureDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Reset-HPOVEnclosureDevice) * [Set-HPOVEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVEnclosure) * [Set-HPOVEnclosureActiveFLM]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVEnclosureActiveFLM) * [Set-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVEnclosureGroup) * [Update-HPOVEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVEnclosure) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVEnclosure
Import an enclosure. ### SYNTAX

Add-HPOVEnclosure [-Hostname] <String> [-EnclosureGroup] <Object> [-Username] <String> [-Password] <Object> [-Li
censingIntent] <String> [-Baseline] <Object>[ [-ForceInstallFirmware] <SwitchParameter>][ [-Scope] <Array>][ [-A
sync] <SwitchParameter>][ [-ApplianceConnection] <Object>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchPara
meter>] [<CommonParameters>]
Add-HPOVEnclosure [-Hostname] <String> [-EnclosureGroup] <Object>[ [-Credential] <PSCredential>] [-LicensingInte

nt] <String> [-Baseline] <Object>[ [-ForceInstallFirmware] <SwitchParameter>][ [-Scope] <Array>][ [-Async] <Swit
chParameter>][ [-ApplianceConnection] <Object>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<C
ommonParameters>]
Add-HPOVEnclosure [-Hostname] <String> [-EnclosureGroup] <Object>[ [-Credential] <PSCredential>][ [-Monitored] <

SwitchParameter>][ [-Scope] <Array>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>][ [-WhatIf] <
SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Add-HPOVEnclosure [-Hostname] <String> [-Username] <String> [-Password] <Object>[ [-Monitored] <SwitchParameter>

][ [-Scope] <Array>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>][ [-WhatIf] <SwitchParameter>
][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This cmdlet will import an enclosure for HPE OneView management. The Onboard Administrator needs to have at least an IP
Address for each OA module, and a valid Administrator account. An Enclosure Group must also be created.
Add-HPOVEnclosure will attempt a connection to the XML Reply interface to examine if an existing VC Domain is present. If so,
you are prompted if you wish to continue and force import the enclosure. FORCE IMPORT OF AN ENCLOSURE WILL DELETE
ANY EXISTING VC DOMAIN CONFIGURATION, AND NOT PERFORM ANY VC DOMAIN CONFIGURATION MIGRATION. PLEASE
BACKUP YOUR VC DOMAIN IF YOU WISH TO RESTORE TO ITS ORIGINAL CONFIGURATION.
Parameters
Aliases None
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False

-Baseline <Object>
Aliases [-fwIso, -fwBaselineIsoFilename]
Baseline File Name, Name, URI or Object.
Examples:
$FileName = "bp-hp-service-pack-for-proliant-oneview-2014-11-30-05.iso" $Name = "HP Service Pack For ProLiant OneView

2014 11 13"
Aliases fwIso, fwBaselineIsoFilename
Required? true
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
Aliases [-eg, -enclGroupName]
Enclosure Group Name to associate with the enclosure to import.
Aliases eg, EnclGroupName
Required? true
Position? named
Default value
Aliases [-forceFw, -forceInstall]
Force the installation of the provided Firmware Baseline.
Aliases forceFw, forceInstall
Required? false
Position? named
Default value False
-Hostname <String>
Aliases [-oa]
IP Address, Hostname or FQDN of the Primary C7000 Onboard Administrator (OA).
Aliases oa
Required? true
Position? named
Default value
Aliases [-license, -l]
Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being
imported.
Accepted values are
* OneView
* OneViewNoiLO
Aliases license, l
Required? true
Position? named
Add the specified enclosure for monitor only management. You can view hardware for inventory and status information only.
Aliases None
Required? false
Position? named
Default value False
-Password <Object>
Aliases [-p, -pw]
Administrator Account password of the OA specified. Value can be [String] or [SecureString].
Aliases p, pw
Required? true
Position? named
Default value
-Scope <Array>
Aliases None
Required? false
Position? named
Default value
-Username <String>
Aliases [-u, -user]
Administrator account of the target OA. Can be either an OA Local Administrator or Active Directory (AD) account if the OA is
configured for AD authentication.
Aliases u, user
Required? true
Position? named
Default value

-WhatIf <SwitchParameter>
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Enclosure Group Resource that will be used to set the Enlosure policy.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVEnclosure -oa "192.168.1.1" -enclGroupName EG1 -user admin -pass hpinvent -license OneView
Add a new enclosure to the appliance, using the EG1 Enclosure Group.
-------------------------- EXAMPLE 2 --------------------------
Add-HPOVEnclosure -oa "192.168.1.1" -enclGroupName EG1 -user admin -pass hpinvent -license OneView -confirm:$fal
se
Add a new enclosure to the appliance, using the EG1 Enclosure Group, and force add the target enclosure.
THIS IS A DISTRUCTIVE PROCESS IF AN EXISTING VC DOMAIN EXISTS.
-------------------------- EXAMPLE 3 --------------------------
Add-HPOVEnclosure -oa "192.168.1.1" -user admin -pass hpinvent -monitored
Add a new enclosure to the appliance for monitoring only.
Related Links
Get-HPOVEnclosure
Get-HPOVEnclosureGroup
New-HPOVEnclosureGroup
Remove-HPOVEnclosure
Remove-HPOVEnclosureGroup
Reset-HPOVEnclosureDevice
Set-HPOVEnclosure
Set-HPOVEnclosureActiveFLM
Set-HPOVEnclosureGroup
Update-HPOVEnclosure
Top
Add-HPOVFabricManager

Add an external fabric manager.
SYNTAX
Add-HPOVFabricManager [-ManagementAddress] <String> [-Name] <String>[ [-Credential] <PSCredential>][ [-Secondary
ManagementAddress] <String>][ [-TertiearyManagementAddress] <String>][ [-TrustLeafCertificate] <SwitchParameter>
][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Fabric Managers is a resource manager in HPE OneView that enables integration of a Cisco ACI fabric (an external entity) with
HPE Synergy. A fabric manager aligns HPE OneView resources as defined by Cisco Application Policy Infrastructure Controller
(APIC) policies. It represents a remote Cisco APIC or an APIC cluster that manages a Cisco ACI fabric.
You can operate a fabric manager after adding it in HPE OneView and configure a list of tenants to cover policies necessary for
HPE Synergy and Cisco APIC integration.
Remediation of networks, network sets, and logical interconnects Remediation is a process to convert a noncompliant health
state of an HPE OneView resource to a compliant health state with respect to APIC policy definitions.
The following conditions cause the fabric manager to be unable to synchronize with network policies:
* One or more networks connected across uplink sets in a logical interconnect within HPE Synergy have the same
VLAN tag
* The two networks are shared across tenants
When a fabric manager is non compliant with APIC network policies, a software remediation enables a fabric manager to
synchronize with network policies. A compliance report is generated immediately after adding a fabric manager and is updated
again after remediation. The compliance report details actions that you can perform to remediate inconsistencies. There are
indicators for compliant, noncompliant, and compliance-check progress for each resource. Every tenant has a list of consistent
and inconsistent reports based on the compliance records generated for a tenant. An inconsistency appears in the form of an
alert, which contains an action choice: auto-remediate or manual. If you choose to auto-remediate, an automatic update of the
selected HPE OneView resource will initiate.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? False
Position? named
Default value False
-ManagementAddress <String>
The fabric managers primary IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
-Name <String>
The fabric managers resource name to use.

Aliases None
Required? true
Position? named
Default value
-SecondaryManagementAddress <String>
The fabric managers secondary IP Address or FQDN.
Aliases None
Required? false
Position? named
Default value
-TertiearyManagementAddress <String>
The fabric managers tertieary IP Address or FQDN.
Aliases None
Required? false
Position? named
Default value
-TrustLeafCertificate <SwitchParameter>
If the resource SSL certificate is not trusted, use this parameter to add the certificate to the appliance trust store.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
None. You cannot pipe objects to this cmdlet.
Return Values
Async Task resource to monitor progress.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVFabricManager -Name ProdFabricManager -ManagementAddress fabricmgr1-vip.domain.local -SecondaryManagemen

tAddress fabricmgr1-vip2.domain.local
Add the specified farbic manager with a redundant address.
Related Links
Get-HPOVFabricManager
Remove-HPOVFabricManager
Top
Add-HPOVHypervisorManager

Add new hypervisor manager.
SYNTAX
Add-HPOVHypervisorManager [-Hostname] <String>[ [-Credential] <PSCredential>][ [-DisplayName] <String>][ [-Port]
<int>][ [-TrustLeafCertificate] <SwitchParameter>][ [-Scope] <Object>][ [-Async] <SwitchParameter>][ [-Appliance
Connection] <Array>] [<CommonParameters>]
You can register a new hypervisor manager with HPE OneView by providing the hostname and credentials. The registered
hypervisor manager contains preferences, which are used as default hypervisor or cluster settings during hypervisor cluster
profile creation. You can modify the hypervisor manager preferences using the edit operation. You can override these values in
a hypervisor cluster profile.
A valid hypervisor manager certificate must be added to HPE OneView trust store to be able to successfully communicate with a
hypervisor manager.
The user must have an infrastructure administrator privilege to register or update the hypervisor manager resource in HPE
OneView. You can assign scopes to the hypervisor manager resource in HPE OneView.
Parameters

Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Use this parameter if you want to provide a PSCredential object.
Aliases None
Required? False
Position? named
Default value
-DisplayName <String>
Override display name of the hypervisor manager. By default Hostname will be used.
Aliases None
Required? false
Position? named
Default value
-Hostname <String>
IP or FQDN address of the hypervisor manager.
Aliases Name, ComputerName

Required? true
Position? named
Default value
-Port <int>
HTTPS port of the target hypervisor manager. Default is 443.
Aliases None
Required? false
Position? named
Default value 443
-Scope <Object>
Aliases None
Required? False
Position? named
Default value AllResourcesInScope
If the resource SSL certificate is not trusted, use this parameter to add the certificate to the appliance trust store.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.TaskResource [Other]
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVHypervisorManager -Hostname vcenter.domain.local -Credential (Get-Credential -Username administrator@vsp

here.local -Message Password)
Add hypervisor manager by providing prompted PSCredential.
Related Links
Get-HPOVHypervisorManager
Remove-HPOVHypervisorManager
Set-HPOVHypervisorManager
Top
Add-HPOVLdapServer

Add-HPOVLdapServer
Add a new LDAP Directory Server.
SYNTAX
Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String> [-Username] <String>[ [-SSLPort] <Int32>][ [-Cer
tificate] <Object>][ [-Password] <Object>][ [-TrustLeafCertificate] <SwitchParameter>] [<CommonParameters>]
Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String>[ [-Credential] <PSCredential>][ [-SSLPort] <Int3

2>][ [-Certificate] <Object>][ [-TrustLeafCertificate] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Co
mmonParameters>]
Add-HPOVLdapServer[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will add a new LDAP Directory Server to an existing authentication directory.
Parameters
Specify one HPOneView.Appliance.Connection object or Name property value.

Aliases Appliance
Required? false
Position? named
Accept pipeline input? true (ByPropertyName)
-Certificate <Object>
Aliases [-cert] Directory Server SSL Certificate, either location to Base64 Cert or multi-line string value. If omitted, the CMDLET
will attempt to retrieve the Directory Servers Secure LDAP Certiciate.
Aliases cert
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Hostname <String>
Aliases [-Name] Directory server name or IP Address to add.
Aliases Name
Required? true
Position? named
Default value
-InputObject <Object>
The LDAP Directory Object from Get-HPOVLdapDirectory.
Aliases None
Required? true
Position? named
Default value
-Password <Object>
Aliases [-p] Directory User account password in order to validate LDAP configuration. Can be System.String or SecureString
object.
Aliases p, pass
Required? false
Position? named
Default value
-SSLPort <Int32>
Aliases [-port] Directory Server"s LDAP SSL Port.
Aliases port
Required? false
Position? named
Default value 636
When adding a new LDAP directory server, the certificate may not be trusted. Use this switch to force trust the certificate. Or,
use the Add-HPOVApplianceTrustedCertificate to add the enterprise issuing certificate authority"s certificate.
Aliases None
Required? False
Position? named
Default value
-Username <String>
Aliases [-u] Directory Username to authenticate with in order to validate LDAP configuration.
Aliases u, user
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject]
Authentication Directory object that will have the LDAP Server added to.
Return Values
Updated Authentication Directory.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdapDirectory -Name MyDirectory | Add-HPOVLdapServer -Name servera.domain.com -Username MyAdminName -Pas

sword (ConvertTo-SecureString "MyPAssword" -AsPlanText -Force)
Add a new LDAP Directory server. ### Related Links * [New-HPOVLdapServer](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/New-HPOVLdapServer) * [Remove-HPOVLdapServer](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVLdapServer) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVLdapServer
Add a new LDAP Directory Server. ### SYNTAX
Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String> [-Username] <String>[ [-SSLPort] <Int32>][ [-Cer
tificate] <Object>][ [-Password] <Object>][ [-TrustLeafCertificate] <SwitchParameter>] [<CommonParameters>]
Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String>[ [-Credential] <PSCredential>][ [-SSLPort] <Int3

2>][ [-Certificate] <Object>][ [-TrustLeafCertificate] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Co
mmonParameters>]
Add-HPOVLdapServer[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will add a new LDAP Directory Server to an existing authentication directory.
Parameters

Aliases Appliance
Required? false
Position? named
Aliases cert
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Hostname <String>
Aliases Name
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-Password <Object>
object.
Aliases p, pass
Required? false
Position? named
Default value
-SSLPort <Int32>
Aliases [-port] Directory Server's LDAP SSL Port.
Aliases port
Required? false
Position? named
Default value 636
When adding a new LDAP directory server, the certificate may not be trusted. Use this switch to force trust the certificate. Or,
use the Add-HPOVApplianceTrustedCertificate to add the enterprise issuing certificate authority's certificate.
Aliases None
Required? False
Position? named
Default value
-Username <String>
Aliases u, user
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdapDirectory -Name MyDirectory | Add-HPOVLdapServer -Name servera.domain.com -Username MyAdminName -Pas

sword (ConvertTo-SecureString 'MyPAssword' -AsPlanText -Force)
Add a new LDAP Directory server.
Related Links
New-HPOVLdapServer
Remove-HPOVLdapServer
Top
Add-HPOVPowerDevice

Add-HPOVPowerDevice
Import a power device.
SYNTAX
Add-HPOVPowerDevice [-Hostname] <String>[ [-Username] <String>][ [-Password] <String>][ [-Credential] <PSCredent
ial>][ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>][ [-TrustLeafCertificate] <SwitchParameter>]
[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Import a power device (iPDU) to be managed by an HPE OneView appliance.
Parameters
Aliases Appliance
Required? false
Position? 4
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? false
Position? 3
Default value
Force the import of the iPDU when currently managed by another HPE OneView appliance.
Aliases None
Required? false
Position? named
Default value False
-Hostname <String>
Hostname of the iPDU, either IP Address or FQDN.
Aliases None
Required? true
Position? 0
Default value
-Password <String>
Warning: This parameter is being deprecated. Please transition to the -Credential parameter.
Account password of the iPDU specified.
Aliases None
Required? false
Position? 2
Default value
If the iPDU SSL certificate is not trusted, use this Cmdlet to add the certificate to the appliance trust store.
Aliases None
Required? false
Position? named
Default value False

-Username <String>
Administrator account of the target iPDU.
Aliases None
Required? false
Position? 1
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVPowerDevice ipdu24.example.com admin password
Add the iPDU to the appliance. ### Related Links * [Add-HPOVPowerDeviceConnection]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVPowerDeviceConnection) * [Get-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVPowerDevice) * [New-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVPowerDevice) * [Remove-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVPowerDevice) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVPowerDevice
Import a power device. ### SYNTAX

Add-HPOVPowerDevice [-Hostname] <String>[ [-Username] <String>][ [-Password] <String>][ [-Credential] <PSCredent
ial>][ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>][ [-TrustLeafCertificate] <SwitchParameter>]
[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Import a power device (iPDU) to be managed by an HPE OneView appliance.
Parameters
Aliases Appliance
Required? false
Position? 4
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? false
Position? 3
Default value
Force the import of the iPDU when currently managed by another HPE OneView appliance.
Aliases None
Required? false
Position? named
Default value False
-Hostname <String>
Hostname of the iPDU, either IP Address or FQDN.
Aliases None
Required? true
Position? 0
Default value
-Password <String>
Account password of the iPDU specified.
Aliases None
Required? false
Position? 2
Default value
If the iPDU SSL certificate is not trusted, use this Cmdlet to add the certificate to the appliance trust store.
Aliases None
Required? false
Position? named
Default value False
-Username <String>
Administrator account of the target iPDU.
Aliases None
Required? false
Position? 1
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVPowerDevice ipdu24.example.com admin password
Add the iPDU to the appliance.
Related Links
Add-HPOVPowerDeviceConnection
Get-HPOVPowerDevice
New-HPOVPowerDevice
Remove-HPOVPowerDevice
Top
Add-HPOVRackManager

Add-HPOVRackManager
Add support Rack Manager (HPE Superdome Flex) resource
SYNTAX
Add-HPOVRackManager [-ComputerName] <String>[ [-Credential] <PSCredential>][ [-Scope] <Object>][ [-Async] <Switc
hParameter>][ [-Force] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
A rack manager platform is a multinode system. The nodes are housed within a rack or across racks, and are centrally managed
by a management controller. The Rack Managers screen enables you to manage and visualize the physical location of rack
manager platforms within a rack. A rack manager platform consists of the following:
* One or more chassis - The chassis are individual nodes that are used to build logical components such as sys
tems or partitions. Each chassis is a physical container for system components like the compute, storage, or ne
twork nodes.
In an HPE Superdome Flex Server, the chassis are 5U nodes that represent the compute nodes with CPU, memory,
I/O, power supplies, and fans.
* One or more systems or partitions - The system is a logical entity that functions as a server, and runs a si
ngle instance of an operating system to host services. In HPE OneView, the partition is modeled as a server har
dware resource.
In an HPE Superdome Flex Server, the systems are also called partitions. A partition consists of one or more
compute chassis that are interconnected through an ultra-fast fabric. Each partition starts with a base chassis
and can be extended using expansion chassis to form a large system.
* One or more managers - The manager component manages the rack manager platform, and hosts the management con
troller function. HPE OneView communicates with the rack manager through this management controller enabling sy
stem administration, control, and platform management of the rack manager platform. Some platforms have multipl
e manager components to support redundancy.
In an HPE Superdome Flex Server, the manager component is called the Rack Management Controller (RMC). The RM
C hosts the DMTF Redfish APIs.
* One or more racks - The racks physically contain all the rack manager platform components.
When you add a rack manager, HPE OneView automatically applies the HPE OneView Standard license to the rack manager.
HPE OneView discovers and monitors the hardware subcomponents of the rack manager. Minimum required privileges:
Infrastructure administrator or Server administrator.
Parameters

Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
The IP/Address of the supported rack manager
Aliases Name
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
Force add the resource.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Async task Resource object for configuring port monitoring on the requested logical intercinnect.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Credential = Get-Credential -Username Administrator -Message "RackManager Password" Add-HPOVRackManager -Comput

erName rackmanger1.domain.com -Credential $Credential
Add the specified rack manager.
Related Links
Get-HPOVRackManager
Remove-HPOVRackManager
Update-HPOVRackManager
Top
Add-HPOVRackToDataCenter

Add rack resource to DataCenter.
SYNTAX
Add-HPOVRackToDataCenter [-InputObject] <Object> [-DataCenter] <Object>[ [-X] <Int32>][ [-Y] <Int32>][ [-Millime
ters] <SwitchParameter>][ [-Rotate] <Int>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Add a rack resource to a defined DataCenter object.
Parameters
Aliases Appliance
Required? false
Position? named
-DataCenter <Object>
The DataCenter object from Get-HPOVDataCenter.
Aliases None
Required? true
Position? named
Default value
The Rack object from Get-HPOVRack.
Aliases None
Required? true
Position? named
Default value
-Millimeters <SwitchParameter>
If X and/or Y are in Millimeters, you must include this parameter.
Aliases None
Required? False
Position? named
Default value False
-Rotate <Int>
Specify the degree rotation of the rack. Allowed range 0 to 360
Aliases None
Required? False
Position? named
Default value 0
-X <Int32>
The X coordinate in the DC. Value can be in US Feet or Millimeters. If specying Millimeters, you need to include the -Millimeters
switch parameter. Feet will be converted to Millimeters.
Aliases None
Required? False
Position? named
Default value 0
-Y <Int32>
The Y coordinate in the DC. Value can be in US Feet or Millimeters. If specying Millimeters, you need to include the -Millimeters
Aliases None
Required? False
Position? named
Default value 0

<CommonParameters>
Input Types
HPOneView.Facilities.Rack [System.Management.Automation.PSCustomObject]
Rack resource object from Get-HPOVRack.
Return Values
HPOneView.Facilities.DataCenter [System.Management.Automation.PSCustomObject]
Updated DataCenter object with the newly added Rack resource in the contents property.
Examples
-------------------------- EXAMPLE 1 --------------------------
$DC = Get-HPOVDataCenter -Name Houston_DC1 -ErrorAction Stop

$X = 10
$Y = 12
Get-HPOVRack -Name MyRack -ErrorAction Stop | Add-HPOVRackToDataCenter -DataCenter $DC -X $X -Y $Y
Add "MyRack" to "Houston_DC1" datacenter object, located at 10",12". ### Related Links ***
Top
### HPE OneView 4.00 Library ## Add-HPOVRackToDataCenter
Add rack resource to DataCenter. ### SYNTAX
Add-HPOVRackToDataCenter [-InputObject] <Object> [-DataCenter] <Object>[ [-X] <Int32>][ [-Y] <Int32>][ [-Millime
ters] <SwitchParameter>][ [-Rotate] <Int>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Add a rack resource to a defined DataCenter object.
Parameters
Aliases Appliance
Required? false
Position? named
-DataCenter <Object>
The DataCenter object from Get-HPOVDataCenter.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
If X and/or Y are in Millimeters, you must include this parameter.
Aliases None
Required? False
Position? named
Default value False
-Rotate <Int>
Specify the degree rotation of the rack. Allowed range 0 to 360
Aliases None
Required? False
Position? named
Default value 0
-X <Int32>
The X coordinate in the DC. Value can be in US Feet or Millimeters. If specying Millimeters, you need to include the -Millimeters
Aliases None
Required? False
Position? named
Default value 0
-Y <Int32>
The Y coordinate in the DC. Value can be in US Feet or Millimeters. If specying Millimeters, you need to include the -Millimeters
Aliases None
Required? False
Position? named
Default value 0
<CommonParameters>
Input Types
Return Values
HPOneView.Facilities.DataCenter [System.Management.Automation.PSCustomObject]
Examples
-------------------------- EXAMPLE 1 --------------------------
$DC = Get-HPOVDataCenter -Name Houston_DC1 -ErrorAction Stop

$X = 10
$Y = 12
Get-HPOVRack -Name MyRack -ErrorAction Stop | Add-HPOVRackToDataCenter -DataCenter $DC -X $X -Y $Y
Add 'MyRack' to 'Houston_DC1' datacenter object, located at 10',12'.
Related Links
Top
Add-HPOVRemoteFrame
Add-HPOVRemoteFrame
Add remote HPE Synergy Frame to Composer.
SYNTAX
Add-HPOVRemoteFrame [-Hostname] <String>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Common
Parameters>]
HPE Synergy Frames are automatically discovered after the initital Hardware Setup task has been completed. Remote frames
outside of the HPE Synergy management ring must be added manually. Use this Cmdlet to specify the IPv6 Link Local address
of the remote frame to add.
Parameters
Aliases None
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Hostname <String>
The name of the Label associated with the resource.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async task Resource object for monitoring.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVRemoteFrame -Hostname fe80::c8f:fbcb:aa8a:97c8
Add the specified remote HPE Synergy Frame. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Add-HPOVRemoteFrame
Add remote HPE Synergy Frame to Composer. ### SYNTAX
Add-HPOVRemoteFrame [-Hostname] <String>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Common

Parameters>]
HPE Synergy Frames are automatically discovered after the initital Hardware Setup task has been completed. Remote frames
outside of the HPE Synergy management ring must be added manually. Use this Cmdlet to specify the IPv6 Link Local address
of the remote frame to add.
Parameters
Aliases None
Required? false
Position? named

Aliases None
Required? false
Position? named
Default value
-Hostname <String>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVRemoteFrame -Hostname fe80::c8f:fbcb:aa8a:97c8
Add the specified remote HPE Synergy Frame.
Related Links
Top
Add-HPOVResourceToLabel

Associate resource with new or existing Label.
SYNTAX
Add-HPOVResourceToLabel [-Name] <String> [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParam
eters>]
Labels identify resources so you can organize them into groups. For example, you might want to identify the servers that are
used primarily by the Finance team, or identify the storage systems assigned to the Asia/Pacific division.
This Cmdlet will allow you to add resources to a new label. If the Label does not exist, a new one will be created.
Parameters
Aliases Appliance
Required? false
Position? 2
The collection of resources to associate the label with.
Aliases None
Required? true
Position? 1
Default value
-Name <String>
The name of the Label to associate resources to. If Label does not exist, a new one will be created.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
System.Array
Collection of resources to associate with the label.
Return Values
The created or modified Label resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Resources = Get-HPOVNetwork -Name Finance* -ErrorAction Stop

$Resources += Get-HPOVServerHardware -Name Finance*
Add-HPOVResourceToLabel -Name Finance -InputObject $Resources
Collect various resources for Finance, creating a new label called "Finance". ### Related Links ***
Top
### HPE OneView 4.00 Library ## Add-HPOVResourceToLabel
Associate resource with new or existing Label. ### SYNTAX
Add-HPOVResourceToLabel [-Name] <String> [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParam

eters>]
This Cmdlet will allow you to add resources to a new label. If the Label does not exist, a new one will be created.
Parameters

Aliases Appliance
Required? false
Position? 2
The collection of resources to associate the label with.
Aliases None
Required? true
Position? 1
Default value
-Name <String>
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
System.Array
Collection of resources to associate with the label.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Resources = Get-HPOVNetwork -Name Finance -ErrorAction Stop

$Resources += Get-HPOVServerHardware -Name Finance
Add-HPOVResourceToLabel -Name Finance -InputObject $Resources
Collect various resources for Finance, creating a new label called 'Finance'.
Related Links
Top
Add-HPOVResourceToRack

Add supported resource to rack.
SYNTAX
Add-HPOVResourceToRack [-InputObject] <Object> [-Rack] <Object> [-ULocation] <Int32>[ [-ApplianceConnection] <Ob
ject>] [<CommonParameters>]
Add a supported resource to a rack resource object.
Parameters
Aliases Appliance
Required? false
Position? named
The suppported resource object from. Supported resource objects are: Enclosures Servers *Unmanaged Devices
Aliases None
Required? true
Position? named
Default value
-Rack <Object>
Aliases None
Required? true
Position? named
Default value
-ULocation <Int32>
The rack unit location where the resource is located.
Aliases None
Required? True
Position? named
Default value 0
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Rack = Get-HPOVRack -Name MyRack221 -ErrorAction Stop

$Servers = Get-HPOVServers -Name Prod221* -ErrorAction Stop
$_U = 1
ForEach ($Server in $Servers) {
Add-HPOVResourceToRack -InputObject $Server -Rack $Rack -ULocation $_U
$_U += $Server.formFactor.Replace("U",$null)
}
Add "Prod221" (DL) servers to "MyRack221" rack object, starting at Rack U 1, and increasing the location based on the form
factor of the DL servers.
-------------------------- EXAMPLE 2 --------------------------

$Enclosures = Get-HPOVEnclosures -Name Encl-Prod* -ErrorAction Stop | ? rackName -eq $Rack.name
$_U = 1
ForEach ($Enclosure in $Enclosures) {
Add-HPOVResourceToRack -InputObject $Enclosure -Rack $Rack -ULocation $_U
$_U += 10
}
Add Enclosures which the Onboard Administrators report are in "MyRack222", and add them to "MyRack222" rack object,
starting at Rack U 1, and increasing the location by 10U. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Add-HPOVResourceToRack
Add supported resource to rack. ### SYNTAX
Add-HPOVResourceToRack [-InputObject] <Object> [-Rack] <Object> [-ULocation] <Int32>[ [-ApplianceConnection] <Ob

ject>] [<CommonParameters>]
Add a supported resource to a rack resource object.
Parameters
Aliases Appliance
Required? false
Position? named
The suppported resource object from. Supported resource objects are: Enclosures Servers *Unmanaged Devices
Aliases None
Required? true
Position? named
Default value
-Rack <Object>
Aliases None
Required? true
Position? named
Default value
-ULocation <Int32>
The rack unit location where the resource is located.
Aliases None
Required? True
Position? named
Default value 0
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

$Servers = Get-HPOVServers -Name Prod221* -ErrorAction Stop
$_U = 1
ForEach ($Server in $Servers) {
Add-HPOVResourceToRack -InputObject $Server -Rack $Rack -ULocation $_U
$_U += $Server.formFactor.Replace("U",$null)
}
Add 'Prod221' (DL) servers to 'MyRack221' rack object, starting at Rack U 1, and increasing the location based on the form
factor of the DL servers.
-------------------------- EXAMPLE 2 --------------------------

$Enclosures = Get-HPOVEnclosures -Name Encl-Prod* -ErrorAction Stop | ? rackName -eq $Rack.name
$_U = 1
ForEach ($Enclosure in $Enclosures) {
Add-HPOVResourceToRack -InputObject $Enclosure -Rack $Rack -ULocation $_U
$_U += 10
}
Add Enclosures which the Onboard Administrators report are in 'MyRack222', and add them to 'MyRack222' rack object, starting
at Rack U 1, and increasing the location by 10U.
Related Links
Top
Add-HPOVResourceToScope

Add supported resource to Scope.
SYNTAX
Add-HPOVResourceToScope [-Scope] <HPOneView.Appliance.ScopeCollection> [-InputObject] <Object>[ [-Async] <Switch
Parameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This Cmdlet will add supported resources to a specified Scope.. All the resources in these categories can be added to or
removed from a scope:
* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
NOTE: Resources in other categories are considered to be included in all scopes, and they cannot be removed.
Minimum required privileges: Infrastructure administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Specify to return asyncronous task after file upload has completed.
Aliases Resource
Required? true
Position? named
Default value

The Scope resource to add the resource(s) to.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Appliance.ScopeCollection
Scope resource object from Get-HPOVScope.
Return Values
Asyncronous task resource that updates the Scope and associated resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Resources += Get-HPOVNetwork -Name ProdVLan*

$Resources += Get-HPOVServer -Name Encl1*
Get-HPOVScope -Name MyScope | Add-HPOVResourceToScope -InputObject $Resources
Add the resources collected to the MyScope scope. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Add-HPOVResourceToScope
Add supported resource to Scope. ### SYNTAX
Add-HPOVResourceToScope [-Scope] <HPOneView.Appliance.ScopeCollection> [-InputObject] <Object>[ [-Async] <Switch

Parameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Specify to return asyncronous task after file upload has completed.
Aliases Resource
Required? true
Position? named
Default value

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Resources += Get-HPOVNetwork -Name ProdVLan

$Resources += Get-HPOVServer -Name Encl1
Add the resources collected to the MyScope scope.
Related Links
Top
Add-HPOVSanManager

Add-HPOVSanManager
Add a supported SAN Manager
SYNTAX
Add-HPOVSanManager [-Type] <String> [-Hostname] <String> [-Username] <String> [-Password] <Object>[ [-Port] <Int
32>][ [-UseSsl] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParamet
ers>]
Add-HPOVSanManager [-Type] <String> [-Hostname] <String> [-SnmpUserName] <String>[ [-Port] <Int32>] [-SnmpAuthLe
vel] <String> [-SnmpAuthProtocol] <String> [-SnmpAuthPassword] <Object> [-SnmpPrivProtocol] <String> [-SnmpPrivP
assword] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Add a new SAN Manager to the appliance. SAN Managers are hardware or software systems that manage SANs. The SAN
Managers resource enables you to bring SAN management systems and the SANs they manage under management of the
appliance. You can associate the managed SANs to Fibre Channel networks on the appliance when creating a (New-
HPOVNetwork) or updating an existing (Set-HPOVNetwork) Fibre Channel Network Resource. This enables the appliance to
automate zoning to make the SANs visible to server profiles. Zoning defines connections between Fibre Channel endpoints.
Zones are a group of endpoints that can communicate with each other. Open SANs allow communication between all endpoints.
Supported SAN Managers are:
* Brocade SAN Network Advisor

* HPE Networking 5900CP (FC or FCoE)
* HPE Networking 5900AF (FC-only)
* Cisco Nexus (FC or FCoE)
* Cisco MDS (FC-only)
Please see the HPE OneView Support Matrix for supported versions.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False

-Hostname <String>
FQDN or IP Address of the SAN Manager
Aliases None
Required? true
Position? named
Default value
-Password <Object>
Password used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager. Can be either
String or System.Security.SecureString type.
Aliases None
Required? true
Position? named
Default value
-Port <Int32>
TCP Port of the SAN Manager. The default port for Brocade Network Advisor is "5989". The default port for HPN 5900CP is
"161".
Aliases None
Required? false
Position? named
Default value 0
-SnmpAuthLevel <String>
The SNMPv3 Authentication Level. Allowed values are:
* None - No Security is required, only the SNMPv3 UserName is provided.

* AuthOnly - SNMPv3 Authentication Encryption Security Level only. Must also provide -SnmpAuthProtocol and -Snm
pAuthPassword parameters.
* AuthAndPriv - SNMPv3 Authentication Encryption Security and Privacy Levels. Must also provide -SnmpAuthProtoc
ol, -SnmpAuthPassword, -SnmpPrivProtocol and -SnmpPrivPassword parameters.
Aliases None
Required? true
Position? named
Default value None

-SnmpAuthPassword <Object>
SNMPv3 UserName Password. Can be either String or System.Security.SecureString type.
Aliases None
Required? true
Position? named
Default value
-SnmpAuthProtocol <String>
SNMPv3 Password Encryption Protocol. Allowed values are:
* SHA
* MD5
Aliases None
Required? true
Position? named
Default value
-SnmpPrivPassword <Object>
SNMPv3 Privacy Encryption Password. Can be either String or System.Security.SecureString type.
Aliases None
Required? true
Position? named
Default value
-SnmpPrivProtocol <String>
SNMPv3 Privacy Protocol. Allowed values are:
* AES
* DES
Aliases None
Required? true
Position? named
Default value
-SnmpUserName <String>
The SNMPv3 Community User Name.
Aliases None
Required? true
Position? named
Default value
-Type <String>
SAN Manager type to add. Accepted values are:
* bna or Brocade Network Advisor

* HP (HPN 5900CP or HPN 5900AF)
* Cisco
Aliases None
Required? true
Position? named
Default value
-UseSsl <SwitchParameter>
Use to enable SSL communication with the SAN Manager (specifically for the BNA SAN Manager type.)
Aliases None
Required? false
Position? named
Default value False
-Username <String>
Username used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async task.
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Add-HPOVSanManager -type BNA -hostname BNA.contoso.com -username Administrator -password password -usess
l
Wait-HPOVTaskComplete $task
Add a new Brocade Network Advisor SAN Manager. ### Related Links * [Get-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSanManager) * [Remove-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVSanManager) * [Set-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVSanManager) * [Update-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVSanManager) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVSanManager
Add a supported SAN Manager ### SYNTAX
Add-HPOVSanManager [-Type] <String> [-Hostname] <String> [-Username] <String> [-Password] <Object>[ [-Port] <Int
32>][ [-UseSsl] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParamet
ers>]
Add-HPOVSanManager [-Type] <String> [-Hostname] <String> [-SnmpUserName] <String>[ [-Port] <Int32>] [-SnmpAuthLe
vel] <String> [-SnmpAuthProtocol] <String> [-SnmpAuthPassword] <Object> [-SnmpPrivProtocol] <String> [-SnmpPrivP
assword] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Add a new SAN Manager to the appliance. SAN Managers are hardware or software systems that manage SANs. The SAN
Managers resource enables you to bring SAN management systems and the SANs they manage under management of the
appliance. You can associate the managed SANs to Fibre Channel networks on the appliance when creating a (New-
HPOVNetwork) or updating an existing (Set-HPOVNetwork) Fibre Channel Network Resource. This enables the appliance to
automate zoning to make the SANs visible to server profiles. Zoning defines connections between Fibre Channel endpoints.
Zones are a group of endpoints that can communicate with each other. Open SANs allow communication between all endpoints.
Supported SAN Managers are:

* Brocade SAN Network Advisor
* HPE Networking 5900CP (FC or FCoE)
* HPE Networking 5900AF (FC-only)
* Cisco Nexus (FC or FCoE)
* Cisco MDS (FC-only)
Please see the HPE OneView Support Matrix for supported versions.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
-Hostname <String>
FQDN or IP Address of the SAN Manager
Aliases None
Required? true
Position? named
Default value
-Password <Object>
Password used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager. Can be either
String or System.Security.SecureString type.
Aliases None
Required? true
Position? named
Default value
-Port <Int32>
TCP Port of the SAN Manager. The default port for Brocade Network Advisor is '5989'. The default port for HPN 5900CP is '161'.
Aliases None
Required? false
Position? named
Default value 0

Aliases None
Required? true
Position? named
Default value None
SNMPv3 UserName Password. Can be either String or System.Security.SecureString type.
Aliases None
Required? true
Position? named
Default value
* SHA
* MD5
Aliases None
Required? true
Position? named
Default value
SNMPv3 Privacy Encryption Password. Can be either String or System.Security.SecureString type.
Aliases None
Required? true
Position? named
Default value
* AES
* DES
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value

-Type <String>
SAN Manager type to add. Accepted values are:
* bna or Brocade Network Advisor

* HP (HPN 5900CP or HPN 5900AF)
* Cisco
Aliases None
Required? true
Position? named
Default value
-UseSsl <SwitchParameter>
Use to enable SSL communication with the SAN Manager (specifically for the BNA SAN Manager type.)
Aliases None
Required? false
Position? named
Default value False
-Username <String>
Username used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async task.
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Add-HPOVSanManager -type BNA -hostname BNA.contoso.com -username Administrator -password password -usess
l
Add a new Brocade Network Advisor SAN Manager.
Related Links
Get-HPOVSanManager
Remove-HPOVSanManager
Set-HPOVSanManager
Update-HPOVSanManager
Top
Add-HPOVServer

Add-HPOVServer
Import a physical server.
SYNTAX
Add-HPOVServer [-Hostname] <String> [-Username] <String> [-Password] <Object>[ [-Credential] <PSCredential>] [-L
icensingIntent] <String>[ [-Scope] <Array>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [-WhatI
f] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Add-HPOVServer [-Hostname] <String>[ [-Monitored] <SwitchParameter>] [-Username] <String> [-Password] <Object>[

[-Credential] <PSCredential>][ [-Scope] <Array>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [-
WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Import a physical server. This cmdlet is not used to add a Blade Server to the appliance, only supported DL Gen 8/9 servers. A
BL server will automatically be discovered once it inserted into an enclosure being managed by the appliance.
Parameters

Aliases None
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Hostname <String>
Hostname of the server"s iLO, either IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the server being imported. This is only
required when the -Monitored paraemter switch is not provided. If you include the -Monitored switch, LicenseIntent is not
required and should not be provided.
Accepted values are
* OneView
* OneViewNoiLO
Aliases None
Required? true
Position? named
Add the specified server for monitor only management. You can view hardware for inventory and status information only.
Aliases None
Required? false
Position? named
Default value False
-Password <Object>
Account password of the iLO specified. Can be String or SecureString.
Aliases None
Required? true
Position? named
Default value

-Scope <Array>
Aliases None
Required? false
Position? named
Default value
-Username <String>
Administrator account of the target iLO.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Returns an async task resource to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVServer -hostname serverilo.contoso.com -username Administrator -password password -licenseintent OneView

Add serverilo.contoso.com to the appliance, with the OneView license.
-------------------------- EXAMPLE 2 --------------------------
Add-HPOVServer serverilo2.contoso.com Administrator password -monitored
Add serverilo2.contoso.com to the appliance as a monitored only device. ### Related Links * [Convert-HPOVServerProfile]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfile) * [Convert-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfileTemplate) * [ConvertTo-
HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-
HPOVServerProfileTemplate) * [Copy-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Copy-
HPOVServerProfile) * [Get-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServer) * [Get-
HPOVServerHardwareType](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerHardwareType) * [Get-
HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfile) * [Get-
HPOVServerProfileConnectionList](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVServerProfileConnectionList) * [Get-HPOVServerProfileMessage](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVServerProfileMessage) * [Get-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileTemplate) * [Join-
HPOVServerProfileToTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Join-HPOVServerProfileToTemplate)
* [New-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfile) * [New-
HPOVServerProfileAssign](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileAssign) * [New-
HPOVServerProfileAttachVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVServerProfileAttachVolume) * [New-HPOVServerProfileConnection](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVServerProfileConnection) * [New-HPOVServerProfileLogicalDisk]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileLogicalDisk) * [New-
HPOVServerProfileLogicalDiskController](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVServerProfileLogicalDiskController) * [New-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVServerProfileTemplate) * [Remove-HPOVServer](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVServer) * [Remove-HPOVServerProfile](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVServerProfile) * [Remove-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProfileTemplate) * [Restart-HPOVServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Restart-HPOVServer) * [Save-HPOVServerProfile]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfile) * [Save-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfileTemplate) * [Set-
HPOVServerHardwareType](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerHardwareType) * [Set-
HPOVServerPower](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerPower) * [Set-
HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfile) * [Set-
HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfileTemplate) *
[Start-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Start-HPOVServer) * [Stop-HPOVServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Stop-HPOVServer) * [Update-HPOVServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServer) * [Update-HPOVServerHardwareLicenseIntent]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServerHardwareLicenseIntent) * [Update-
HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServerProfile) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVServer
Import a physical server. ### SYNTAX
Add-HPOVServer [-Hostname] <String> [-Username] <String> [-Password] <Object>[ [-Credential] <PSCredential>] [-L
icensingIntent] <String>[ [-Scope] <Array>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-What
If] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Add-HPOVServer [-Hostname] <String>[ [-Monitored] <SwitchParameter>] [-Username] <String> [-Password] <Object>[

[-Credential] <PSCredential>][ [-Scope] <Array>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [
-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Import a physical server. This cmdlet is not used to add a Blade Server to the appliance, only supported DL Gen 8/9 servers. A
BL server will automatically be discovered once it inserted into an enclosure being managed by the appliance.
Parameters
Aliases None
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Hostname <String>
Hostname of the server's iLO, either IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the server being imported. This is only
required when the -Monitored paraemter switch is not provided. If you include the -Monitored switch, LicenseIntent is not
required and should not be provided.
Accepted values are
* OneView
* OneViewNoiLO
Aliases None
Required? true
Position? named
Add the specified server for monitor only management. You can view hardware for inventory and status information only.
Aliases None
Required? false
Position? named
Default value False
-Password <Object>
Account password of the iLO specified. Can be String or SecureString.
Aliases None
Required? true
Position? named
Default value
-Scope <Array>
Aliases None
Required? false
Position? named
Default value
-Username <String>
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVServer -hostname serverilo.contoso.com -username Administrator -password password -licenseintent OneView
Add serverilo.contoso.com to the appliance, with the OneView license.
-------------------------- EXAMPLE 2 --------------------------
Add-HPOVServer serverilo2.contoso.com Administrator password -monitored
Add serverilo2.contoso.com to the appliance as a monitored only device.
Related Links
Convert-HPOVServerProfile
Convert-HPOVServerProfileTemplate
ConvertTo-HPOVServerProfileTemplate
Copy-HPOVServerProfile
Get-HPOVServer
Get-HPOVServerHardwareType
Get-HPOVServerProfile
Get-HPOVServerProfileConnectionList
Get-HPOVServerProfileMessage
Get-HPOVServerProfileTemplate
Join-HPOVServerProfileToTemplate
New-HPOVServerProfile
New-HPOVServerProfileAssign
New-HPOVServerProfileAttachVolume
New-HPOVServerProfileConnection
New-HPOVServerProfileLogicalDisk
New-HPOVServerProfileLogicalDiskController
New-HPOVServerProfileTemplate
Remove-HPOVServer
Remove-HPOVServerProfile
Remove-HPOVServerProfileTemplate
Restart-HPOVServer
Save-HPOVServerProfile
Save-HPOVServerProfileTemplate
Set-HPOVServerHardwareType
Set-HPOVServerPower
Set-HPOVServerProfile
Set-HPOVServerProfileTemplate
Start-HPOVServer
Stop-HPOVServer
Update-HPOVServer
Update-HPOVServerProfile
Top
Add-HPOVSmtpAlertEmailFilter

Add-HPOVSmtpAlertEmailFilter
Add SMPT Email Alert Filter
SYNTAX
Add-HPOVSmtpAlertEmailFilter [-Name] <String> [-Emails] <Array>[ [-Filter] <String>][ [-Scope] <Array>][ [-Scope
MatchPreference] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Add-HPOVSmtpAlertEmailFilter [-RemoteSupportFilter] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceC

onnection] <Object>] [<CommonParameters>]
SMTP Email Filters can be created using this CMDLET.
Parameters
Aliases Appliance
Required? false
Position? named

Aliases None
Required? false
Position? named
Default value
-Emails <Array>
Destination EMail address(es).
Aliases recipients
Required? true
Position? named
Default value
-Filter <String>
Aliases [-query]
REST API filter specifying the resource category, URI, name, and severity.
Example: CPU status:"warning" or status:"critical"
Aliases query
Required? false
Position? named
Default value
-Name <String>
Name of the Filter you are creating.
Aliases None
Required? true
Position? named
Default value
-RemoteSupportFilter <SwitchParameter>
Use to create the HPE OneView Remote Support email filter for service events.
Aliases None
Required? True
Position? named
Default value
-Scope <Array>
Scope(s) the Filter should apply to. Omitting parameter will apply filter to all defined scopes. Value is an Array of
<HPOneView.Appliance.ScopeResource> or <System.String> of 1 or more names of Scopes.
Aliases None
Required? false
Position? named
Default value
-ScopeMatchPreference <String>
If providing multiple Scope resources, specify AND or OR to indicate match preference.
Aliases None
Required? false
Position? named
Default value OR
<CommonParameters>
Input Types
System.Array <Net.Mail.MailAddress>
Array of email address recipient(s).
Return Values
HPOneView.Appliance.TaskResource {System.Management.Automation.PSCustomObject}
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVSmtpAlertEmailFilter -Name "Monitor CPU Error and Warning conditions" -query "CPU status:warning or stat
us:critical" -emails admin1@domain.com,admin2@domain.com
Set SMTP Alert to notify when system CPU status is either "warning" or "critical", and email 2 addresses.
-------------------------- EXAMPLE 1 --------------------------
$Script:NewAlertFilterResults = Add-HPOVSmtpAlertEmailFilter -Name "My Test Filter 3" -Filter "status:critical"

-Emails "user1@domain.com","user2@domain.com" -Scope "My new Scope","My new Scope2" -Async
Create a new email critical alert for the two scope names, and return the Async Task object without waiting. ### Related Links
***
Top
### HPE OneView 4.00 Library ## Add-HPOVSmtpAlertEmailFilter
Add SMPT Email Alert Filter ### SYNTAX
Add-HPOVSmtpAlertEmailFilter [-Name] <String> [-Emails] <Array>[ [-Filter] <String>][ [-Scope] <Array>][ [-Scope
MatchPreference] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
SMTP Email Filters can be created using this CMDLET.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Emails <Array>
Destination EMail address(es).
Aliases recipients
Required? true
Position? named
Default value
-Filter <String>
Aliases [-query]
REST API filter specifying the resource category, URI, name, and severity.
Example: CPU status:'warning' or status:'critical'
Aliases query
Required? false
Position? named
Default value
-Name <String>
Name of the Filter you are creating.
Aliases None
Required? true
Position? named
Default value
-Scope <Array>
Scope(s) the Filter should apply to. Omitting parameter will apply filter to all defined scopes. Value is an Array of
<HPOneView.Appliance.ScopeResource> or <System.String> of 1 or more names of Scopes.
Aliases None
Required? false
Position? named
Default value
-ScopeMatchPreference <String>
If providing multiple Scope resources, specify AND or OR to indicate match preference.
Aliases None
Required? false
Position? named
Default value OR
<CommonParameters>
Input Types
System.Array <Net.Mail.MailAddress>
Array of email address recipient(s).
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVSmtpAlertEmailFilter -Name 'Monitor CPU Error and Warning conditions' -query 'CPU status:warning or stat
us:critical' -emails admin1@domain.com,admin2@domain.com
Set SMTP Alert to notify when system CPU status is either 'warning' or 'critical', and email 2 addresses.
-------------------------- EXAMPLE 1 --------------------------
$Script:NewAlertFilterResults = Add-HPOVSmtpAlertEmailFilter -Name 'My Test Filter 3' -Filter 'status:critical'

-Emails 'user1@domain.com','user2@domain.com' -Scope 'My new Scope','My new Scope2' -Async
Create a new email critical alert for the two scope names, and return the Async Task object without waiting.
Related Links
Top
Add-HPOVStoragePool
Add-HPOVStoragePool
Add managed Storage Pools.
SYNTAX
Add-HPOVStoragePool [-StorageSystem] <Object> [-Pool] <Array> [-ApplianceConnection] <Object> [<CommonParameters
>]
Add new Storage Pools (i.e. HP 3PAR Common Provisioning Group [CPG]) for volumes to be provisioned from. The Storage
System must be imported prior to adding Storage Pools.
Parameters
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via
Pipeline, the ApplianceConnection property of the object will be used.
Aliases Appliance
Required? true
Position? 2
-Pool <Array>
Aliases: [PoolName, spName, CPG] An array containing the name(s) of the specific storage pool resource(s) to be added during
storage system import.
Example: $pools = "cpg1","cpg2"
Aliases PoolName, spName, cpg
Required? true
Position? 1
Default value
-StorageSystem <Object>
Aliases: [Hostname, Name] The Storage System object, or Name.

Aliases Hostname, name
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
HPOneView.Storage.System [System.Management.Automation.PSCustomObject]
Storage System resource object from Get-HPOVStorageSystem.
Return Values
Async task resource.
System.Collections.ArrayList <HPOneView.Appliance.TaskResource>
Multiple async task resources.
Async Task(s) to monitor storage pool import.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVStoragePool -StorageSystem "HP3PAR_1" -PoolName "HP_CPG1"
Add the "HP_CPG1" Stroage Pool that is mananaged in the HP3PAR_1 Storage System. PoolName parameter data type will be
converted from System.String to System.Collections.ArrayList .
-------------------------- EXAMPLE 2 --------------------------
$myPools = "cpg1","cpg2"
Add-HPOVStoragePool "HP3PAR_1" $myPools
Add the "HP_CPG1" Stroage Pool that is mananaged in the HP3PAR_1 Storage System. ### Related Links * [Get-
HPOVStoragePool](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStoragePool) * [Remove-
HPOVStoragePool](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStoragePool) * [Set-
HPOVStoragePool](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVStoragePool) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVStoragePool
Add managed Storage Pools. ### SYNTAX
Add-HPOVStoragePool [-StorageSystem] <Object> [-Pool] <Array> [-ApplianceConnection] <Object> [<CommonParameters

>]
Add new Storage Pools (i.e. HP 3PAR Common Provisioning Group [CPG]) for volumes to be provisioned from. The Storage
System must be imported prior to adding Storage Pools.
Parameters
Aliases Appliance
Required? true
Position? 2
-Pool <Array>
Aliases: [PoolName, spName, CPG] An array containing the name(s) of the specific storage pool resource(s) to be added during
storage system import.
Example: $pools = "cpg1","cpg2"
Aliases PoolName, spName, cpg
Required? true
Position? 1
Default value
Aliases: [Hostname, Name] The Storage System object, or Name.
Aliases Hostname, name
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Storage System resource object from Get-HPOVStorageSystem.
Return Values
Async task resource.
Multiple async task resources.
Async Task(s) to monitor storage pool import.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVStoragePool -StorageSystem "HP3PAR_1" -PoolName "HP_CPG1"
Add the "HP_CPG1" Stroage Pool that is mananaged in the HP3PAR_1 Storage System. PoolName parameter data type will be
converted from System.String to System.Collections.ArrayList .
-------------------------- EXAMPLE 2 --------------------------
$myPools = "cpg1","cpg2"
Add-HPOVStoragePool "HP3PAR_1" $myPools
Add the "HP_CPG1" Stroage Pool that is mananaged in the HP3PAR_1 Storage System.
Related Links
Get-HPOVStoragePool
Remove-HPOVStoragePool
Top
Add-HPOVStorageSystem

Import a supported Storage System
SYNTAX
Add-HPOVStorageSystem [-Hostname] <String> [-Credential] <PSCredential PSCredential>[ [-Username] <String>][ [-P
assword] <Object>][ [-Family] <String>][ [-Domain] <String>][ [-Ports] <PSObject>][ [-PortGroups] <Hashtable>][
[-ShowSystemDetails] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Add-HPOVStorageSystem [-Hostname] <String> [-VIPS] <Hashtable> [-Credential] <PSCredential PSCredential>[ [-User

name] <String>][ [-Password] <Object>][ [-Family] <String>][ [-ShowSystemDetails] <SwitchParameter>][ [-Applianc
eConnection] <Array>] [<CommonParameters>]
This cmdlet will assist with importing a supported Storage System. In order for the Storage Ports to be mapped to Expected
Networks, either a Supported SAN Manager will need to be configured, or 3PAR Direct Attach networks will have to exist.
When adding supported HP 3PAR storage systems, please make sure "startwsapi" has been executed from the HP 3PAR CLI,
which enables the HP 3PAR REST API that is required by HPE OneView.
Parameters
Aliases Appliance
Required? false
Position? named
-Credential <PSCredential PSCredential>
Use this parameter if you want to provide a PSCredential object instead. Use this parameter if you want to provide a
PSCredential object instead.
Aliases None
Required? false False
Position? named
Default value
-Domain <String>
Specify the HP 3PAR Virtual Domain name. Default is "NO DOMAIN". The value provided is CAsesEnSItive.
Aliases None
Required? false
Position? named
Default value NO DOMAIN

-Family <String>
Aliases [-Type]
Specify the type of Storage System to add: StorageVirtual or StoreServ.
Aliases None
Required? false
Position? named
Default value StoreServ
-Hostname <String>
IP Address of FQDN of the storage systems.
Aliases None
Required? true
Position? named
Default value
-Password <Object>
Password of administrator account password. Can either be String or System.Security.SecureString.
Aliases None
Required? false
Position? named
Default value
-PortGroups <Hashtable>
Specify the Host Ports to group together.
Example: @{"1:1:1" = "PG1"; "2:2:2" = "PG2"}
Aliases None
Required? false
Position? named
Default value
-Ports <PSObject>
Specify the Host Ports and Expected Network in an Array of PSCustomObject entries.
Example: @{"1:1:1"="Fabric A";"2:2:2"="Fabric B"}
Aliases None
Required? false
Position? named
Default value
-ShowSystemDetails <SwitchParameter>
By default, the Cmdlet will no longer display the details about the Storage System. Use this parameter to display information
about the storage system when adding to the appliance.
Aliases None
Required? False
Position? named
Default value
-Username <String>
Administrator account of the target storage system.
Aliases None
Required? false
Position? named
Default value
-VIPS <Hashtable>
Specify the StoreVirtual VIP(s) and associated Ethernet Network.
Example:
@{"10.158.11.42" = $EthernetNetwork}
or
@{"10.158.11.42" = $EthernetNetwork1; "10.158.12.42" = $EthernetNetwork2;}

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Add Storage System Async Task.
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Add-HPOVStorageSystem -hostname "3par-array.consoto.com" -username 3paradm -password 3pardata -Async

Add the Storage System using default settings, and let the appliance detect the connected Storage System Ports. (A supported
SAN Manager must first be added, and Managed SANs mapped to the specific FC Network resources.)
-------------------------- EXAMPLE 2 --------------------------
$StorageSystemPorts = @{"1:1:1" = "Fabric A"; "2:1:1" = "Fabric A"; "1:1:2" = "Fabric B"; "2:1:2" = "Fabric B"}
$StoragePortGroups = @{"1:1:1"= "PG1"; "2:1:1" = "PG1"; "1:1:2" = "PG2"; "2:1:2" = "PG2"}
Add-HPOVStorageSystem -hostname "3par-array.consoto.com" -username 3paradm -password 3pardata -Domain VirtaulDom
ain1 -Ports $StorageSystemPorts -PortGroups $StoragePortGroups | Wait-HPOVTaskComplete
Add the Storage System using default settings, and specify the Storage System Ports that will be assigned to the Expected
Networks.
-------------------------- EXAMPLE 3 --------------------------
$IscsiNetwork = Get-HPOVNetwork -Name "IscsiNetwork" -ErrorAction Stop

$StoreVirtualAddress = "storevirtual1.domain.com"
$StorageSystemPSCredential = Get-Credential -Username administrator
Add-HPOVStorageSystem -Family StoreVirtual -Hostname $StoreVirtualAddress -Credential $StorageSystemPSCredential
-VIPS @{ "192.168.191.22" = $IscsiNetwork }
Add a StoreVirtual storage system with PSCredential object. ### Related Links * [Get-HPOVStorageSystem]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageSystem) * [Remove-HPOVStorageSystem]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStorageSystem) * [Update-HPOVStorageSystem]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVStorageSystem) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVStorageSystem
Import a supported Storage System ### SYNTAX
Add-HPOVStorageSystem [-Hostname] <String> [-Credential] <PSCredential PSCredential>[ [-Username] <String>][ [-P

assword] <Object>][ [-Family] <String>][ [-Domain] <String>][ [-Ports] <PSObject>][ [-PortGroups] <Hashtable>][
[-ShowSystemDetails] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Add-HPOVStorageSystem [-Hostname] <String> [-VIPS] <Hashtable> [-Credential] <PSCredential PSCredential>[ [-User

name] <String>][ [-Password] <Object>][ [-Family] <String>][ [-ShowSystemDetails] <SwitchParameter>][ [-Applianc
eConnection] <Array>] [<CommonParameters>]
This cmdlet will assist with importing a supported Storage System. In order for the Storage Ports to be mapped to Expected
Networks, either a Supported SAN Manager will need to be configured, or 3PAR Direct Attach networks will have to exist.
When adding supported HP 3PAR storage systems, please make sure "startwsapi" has been executed from the HP 3PAR CLI,
which enables the HP 3PAR REST API that is required by HPE OneView.
Parameters
Aliases Appliance
Required? false
Position? named
-Credential <PSCredential PSCredential>
Use this parameter if you want to provide a PSCredential object instead. Use this parameter if you want to provide a
PSCredential object instead.
Aliases None
Required? false False
Position? named
Default value
-Domain <String>
Specify the HP 3PAR Virtual Domain name. Default is 'NO DOMAIN'. The value provided is CAsesEnSItive.
Aliases None
Required? false
Position? named
Default value NO DOMAIN
-Family <String>
Aliases [-Type]
Specify the type of Storage System to add: StorageVirtual or StoreServ.
Aliases None
Required? false
Position? named
Default value StoreServ
-Hostname <String>
IP Address of FQDN of the storage systems.
Aliases None
Required? true
Position? named
Default value
-Password <Object>
Password of administrator account password. Can either be String or System.Security.SecureString.
Aliases None
Required? false
Position? named
Default value
-PortGroups <Hashtable>
Specify the Host Ports to group together.
Example: @{"1:1:1" = "PG1"; "2:2:2" = "PG2"}
Aliases None
Required? false
Position? named
Default value
-Ports <PSObject>
Specify the Host Ports and Expected Network in an Array of PSCustomObject entries.
Example: @{"1:1:1"="Fabric A";"2:2:2"="Fabric B"}
Aliases None
Required? false
Position? named
Default value
-ShowSystemDetails <SwitchParameter>
By default, the Cmdlet will no longer display the details about the Storage System. Use this parameter to display information
about the storage system when adding to the appliance.
Aliases None
Required? False
Position? named
Default value
-Username <String>
Administrator account of the target storage system.
Aliases None
Required? false
Position? named
Default value
-VIPS <Hashtable>
Specify the StoreVirtual VIP(s) and associated Ethernet Network.
Example:
@{"10.158.11.42" = $EthernetNetwork}
or
@{"10.158.11.42" = $EthernetNetwork1; "10.158.12.42" = $EthernetNetwork2;}
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Add Storage System Async Task.
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Add-HPOVStorageSystem -hostname "3par-array.consoto.com" -username 3paradm -password 3pardata -Async

Add the Storage System using default settings, and let the appliance detect the connected Storage System Ports. (A supported
SAN Manager must first be added, and Managed SANs mapped to the specific FC Network resources.)
-------------------------- EXAMPLE 2 --------------------------
$StorageSystemPorts = @{"1:1:1" = "Fabric A"; "2:1:1" = "Fabric A"; "1:1:2" = "Fabric B"; "2:1:2" = "Fabric B"}
$StoragePortGroups = @{"1:1:1"= 'PG1'; "2:1:1" = "PG1"; "1:1:2" = "PG2"; "2:1:2" = "PG2"}
Add-HPOVStorageSystem -hostname "3par-array.consoto.com" -username 3paradm -password 3pardata -Domain VirtaulDom
ain1 -Ports $StorageSystemPorts -PortGroups $StoragePortGroups | Wait-HPOVTaskComplete
Add the Storage System using default settings, and specify the Storage System Ports that will be assigned to the Expected
Networks.
-------------------------- EXAMPLE 3 --------------------------
$IscsiNetwork = Get-HPOVNetwork -Name "IscsiNetwork" -ErrorAction Stop

$StoreVirtualAddress = "storevirtual1.domain.com"
$StorageSystemPSCredential = Get-Credential -Username administrator
Add-HPOVStorageSystem -Family StoreVirtual -Hostname $StoreVirtualAddress -Credential $StorageSystemPSCredential
-VIPS @{ "192.168.191.22" = $IscsiNetwork }
Add a StoreVirtual storage system with PSCredential object.

Related Links
Get-HPOVStorageSystem
Remove-HPOVStorageSystem
Update-HPOVStorageSystem
Top
Add-HPOVStorageVolume

Import an existing Storage Volume resource.
SYNTAX
Add-HPOVStorageVolume [-StorageSystem] <Object> [-StorageDeviceName] <String> [-VolumeName] <String> [-VolumeID]
<String> [-Description] <String>[ [-Shared] <SwitchParameter>][ [-Scope] <HPOneView.Appliance.ScopeCollection>]
[-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will help add an existing storage volume that was provisioned on the Storage System. The volume should not be
exported or assigned to a server or groups of servers. The Storage Volume also must reside in the Managed Domain of the
Stroage System that the appliance managed. The Storage Volume"s WWN will be needed.
Parameters
Aliases Appliance
Required? true
Position? named
-Description <String>
Provide a description for the volume.

Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
-Shared <SwitchParameter>
Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private
Aliases None
Required? false
Position? named
Default value False
-StorageDeviceName <String>
The Storage Systems" Device Name of the volume. This can be found in either the 3PAR IMC, CLI or HPE SSMC by looking at
the provisionined volume and copying the "Name" property.
Aliases None
Required? true
Position? named
Default value
The Storage System where the volume will be imported from. Volume to be imported must be provisioned to the same Managed
Domain as the Storage System.
Aliases None
Required? true
Position? named
Default value
-VolumeID <String>
Aliases [-volid, -id, -wwn] The 128bit WWN FC address of the volume to be imported. Address must be in the following format:
AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA
Aliases volid, id, wwn
Required? true
Position? named
Default value
-VolumeName <String>
Aliases [-name] Specify the Storage Volume Name.
Aliases Name
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Storage Pool resource object
Return Values
Async create task
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVStorageVolume -StorageSystem 3ParSys1 -VolumeID 50:00:2A:C0:03:1E:15:2C -VolumeName "MyStorageVol1"
Import the volume "50:00:2A:C0:03:1E:15:2C" from the "3ParSys1" Storage System.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageSystem 3ParSys1 | Add-HPOVStorageVolume -VolumeID 50:00:2A:C0:03:1E:15:2C -VolumeName "MyStorageV

ol1"
Import the volume "50:00:2A:C0:03:1E:15:2C" from the "3ParSys1" Storage System.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStorageSystem 3ParSys1 | Add-HPOVStorageVolume -StorageDeviceName "MyStorageVolName1" -VolumeName "MySto

rageVol1"
Import a volume using the storage device name "MyStorageVolName1" on the "3ParSys1" Storage System. ### Related Links *
[ConvertTo-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVStorageVolume) *
[Get-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolume) * [Get-
HPOVStorageVolumeSnapShot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeSnapShot)
* [Get-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVStorageVolumeTemplate) * [Get-HPOVStorageVolumeTemplatePolicy](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVStorageVolumeTemplatePolicy) * [New-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolume) * [New-HPOVStorageVolumeSnapshot]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolumeSnapshot) * [New-
HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolumeTemplate) *
[Remove-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStorageVolume) *
[Remove-HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVStorageVolumeSnapshot) * [Remove-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVStorageVolumeTemplate) * [Set-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVStorageVolume) * [Set-HPOVStorageVolumeTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVStorageVolumeTemplate) * [Set-
HPOVStorageVolumeTemplatePolicy](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVStorageVolumeTemplatePolicy) ***
Top
### HPE OneView 4.00 Library ## Add-HPOVStorageVolume
Import an existing Storage Volume resource. ### SYNTAX
Add-HPOVStorageVolume [-StorageSystem] <Object> [-StorageDeviceName] <String> [-VolumeName] <String> [-VolumeID]

<String> [-Description] <String>[ [-Shared] <SwitchParameter>][ [-Scope] <HPOneView.Appliance.ScopeCollection>]
This cmdlet will help add an existing storage volume that was provisioned on the Storage System. The volume should not be
exported or assigned to a server or groups of servers. The Storage Volume also must reside in the Managed Domain of the
Stroage System that the appliance managed. The Storage Volume's WWN will be needed.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value False
-StorageDeviceName <String>
The Storage Systems' Device Name of the volume. This can be found in either the 3PAR IMC, CLI or HPE SSMC by looking at
the provisionined volume and copying the 'Name' property.
Aliases None
Required? true
Position? named
Default value
The Storage System where the volume will be imported from. Volume to be imported must be provisioned to the same Managed
Domain as the Storage System.
Aliases None
Required? true
Position? named
Default value
-VolumeID <String>
Aliases [-volid, -id, -wwn] The 128bit WWN FC address of the volume to be imported. Address must be in the following format:
AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA
Aliases volid, id, wwn
Required? true
Position? named
Default value
-VolumeName <String>
Aliases [-name] Specify the Storage Volume Name.
Aliases Name
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async create task
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-HPOVStorageVolume -StorageSystem 3ParSys1 -VolumeID 50:00:2A:C0:03:1E:15:2C -VolumeName 'MyStorageVol1'
Import the volume '50:00:2A:C0:03:1E:15:2C' from the '3ParSys1' Storage System.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageSystem 3ParSys1 | Add-HPOVStorageVolume -VolumeID 50:00:2A:C0:03:1E:15:2C -VolumeName 'MyStorageV

ol1'
Import the volume '50:00:2A:C0:03:1E:15:2C' from the '3ParSys1' Storage System.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStorageSystem 3ParSys1 | Add-HPOVStorageVolume -StorageDeviceName "MyStorageVolName1" -VolumeName 'MySto

rageVol1'
Import a volume using the storage device name "MyStorageVolName1" on the '3ParSys1' Storage System.
Related Links
ConvertTo-HPOVStorageVolume
Get-HPOVStorageVolume
Get-HPOVStorageVolumeSnapShot
Get-HPOVStorageVolumeTemplate
Get-HPOVStorageVolumeTemplatePolicy
New-HPOVStorageVolume
New-HPOVStorageVolumeSnapshot
New-HPOVStorageVolumeTemplate
Remove-HPOVStorageVolume
Remove-HPOVStorageVolumeSnapshot
Remove-HPOVStorageVolumeTemplate
Set-HPOVStorageVolume
Set-HPOVStorageVolumeTemplate
Set-HPOVStorageVolumeTemplatePolicy
Top
Clear-HPOVAlert

Clear-HPOVAlert
[DEPRECATED] Clear an Alert status.
SYNTAX
Clear-HPOVAlert [<CommonParameters>]
DEPRECATED as of 2.0. Please use Set-HPOVAlert
Parameters
<CommonParameters>
Input Types
None.
Return Values
None
Examples
Related Links
Get-HPOVAlert
Remove-HPOVAlert
Set-HPOVAlert
Top
### HPE OneView 4.00 Library ## Clear-HPOVAlert
[DEPRECATED] Clear an Alert status. ### SYNTAX
Clear-HPOVAlert [<CommonParameters>]
### Detailed Description
DEPRECATED as of 2.0. Please use Set-HPOVAlert ### Parameters <CommonParameters> This cmdlet supports the common
parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and
OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
### Input Types None. ### Return Values None ### Examples ### Related Links Get-HPOVAlert Remove-HPOVAlert Set-
HPOVAlert **
Top
Connect-HPOVMgmt

Connect-HPOVMgmt
Initiate a connection to an HPE OneView appliance.
SYNTAX
Connect-HPOVMgmt [-Hostname] <String> [-UserName] <String> [-AuthLoginDomain] <String> [-Password] <Object>[ [-L
oginAcknowledge] <SwitchParameter>] [<CommonParameters>]
Connect-HPOVMgmt [-Hostname] <String>[ [-Certificate] <Object>][ [-LoginAcknowledge] <SwitchParameter>] [<Common

Parameters>]
Connect-HPOVMgmt [-Hostname] <String> [-Credential] <PSCredential> [-AuthLoginDomain] <String>[ [-LoginAcknowled

ge] <SwitchParameter>] [<CommonParameters>]
Establish a connection with the specified HPE OneView appliance. Logs the user into the appliance and establishes a session
for use with subsequent requests. Prompts will be displayed for any omitted values.
Appliance hostname or IP can include an alternate TCP port number. While the appliance does not allow the default TCP port
443 to be changed, the appliance could reside behind a firewall, which is redirecting an alternate TCP port number.
Parameters
-AuthLoginDomain <String>
Aliases [-AuthProvider]
The Directory Name for LDAP/Active Directory authentication, or LOCAL for appliance internal user accounts.
Default is determined by connecting to the requested appliance and retrieving the default login directory. If not LOCAL, and you
attempt to use an embedded user account, you must use -AuthLoginDomain parameter with the Local value..
Aliases authProvider
Required? true
Position? named
Default value LOCAL
Provide the X.509 certificate/SmartCard digital badge in order to authenticate to a supported appliance. Two-factor
authentication must be configured on the appliance in order to provide a X.509 certificate.
Aliases None
Required? False
Position? named
Default value
Aliases PSCredential
Required? true
Position? named
Default value
-Hostname <String>
Aliases [-Appliance, -Computername]
The hostname or IP address of the appliance.
Aliases Appliance, Computername
Required? true
Position? named
Default value
-LoginAcknowledge <SwitchParameter>
When a Login Message has been configured and acknowledgement is Required, use this parameter to acknowledge it during
the initial call. Otherwise, if omitted, and a Login Banner acknowledgement is required, the caller will be prompted. This prompt
does not support the -Confirm parameter.
Aliases None
Required? false
Position? named
Default value False
-Password <Object>
Aliases [-p]
Password to log into the appliance. Can be either System.String or SecureString value..
Aliases p
Required? true
Position? named
Default value
-UserName <String>
Aliases [-u, -user]
User name to authenticate.
Aliases u, user
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Connection
When a valid connection is established with an appliance, this object is then added to ${Global:ConnectedSessions} connection
tracker variable.
The object returned will contain the following public properties:

==============================================================================
| Name | Type | Value |
|-----------------------------------------------------------------------------
| AuthLoginDomain | String | Local |
------------------------------------------------------------------------------
| ConnectionId | Int | 1 |
------------------------------------------------------------------------------
| Name | String | Hostname value |
---------------------- -------------------------------------------------------
| SessionID | String | AUTH string returned from API |
------------------------------------------------------------------------------
| ApplianceType | String | Indicate connected appliance type. |
-------------------- ---------------------------------------------------------
| UserName | String | Username value |
------------------------------------------------------------------------------
| AuthType | String | Credential or Certificate/2FA |
------------------------------------------------------------------------------
| ActivePermissions | IList | Collection of Scopes and permissions |
------------------------------------------------------------------------------
| ApplianceSecurityRoles | IList | Collection of roles |
------------------------------------------------------------------------------
| Default | Boolean | Is connection default for library |
------------------------------------------------------------------------------
System.Management.Automation.ErrorRecord
On error, appliance response is returned as a terminating error.
Examples
-------------------------- EXAMPLE 1 --------------------------
Connect-HPOVMgmt -appliance myappliance.domain.com

ConnectionID Name UserName AuthLoginDomain
------------ ---- -------- ---------------
1 myappliance.domain.com Administrator LOCAL
Connect to a specific appliance FQDN. The user will be prompted for authentication provider, user name and password.
-------------------------- EXAMPLE 2 --------------------------
Connect-HPOVMgmt -appliance myappliance.domain.com:11223
Connect to a specific appliance, where the target TCP port isn"t the default. The user will be prompted for authentication
provider, user name and password.
-------------------------- EXAMPLE 3 --------------------------
$MySmartCard = gci Cert:\CurrentUser\my | ? { $_.EnhancedKeyUsageList.FriendlyName -match "Smart Card Logon" }

Connect-HPOVMgmt -appliance myappliance.domain.com -Certificate $MySmartCard
Connect to a specific appliance using a digital badge. ### Related Links * [Disconnect-HPOVMgmt]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disconnect-HPOVMgmt) ***
Top
### HPE OneView 4.00 Library ## Connect-HPOVMgmt
Initiate a connection to an HPE OneView appliance. ### SYNTAX
Connect-HPOVMgmt [-Hostname] <String> [-UserName] <String> [-AuthLoginDomain] <String> [-Password] <Object>[ [-L
oginAcknowledge] <SwitchParameter>] [<CommonParameters>]
Connect-HPOVMgmt [-Hostname] <String>[ [-Certificate] <Object>][ [-LoginAcknowledge] <SwitchParameter>] [<Common
Parameters>]
Connect-HPOVMgmt [-Hostname] <String> [-Credential] <PSCredential> [-AuthLoginDomain] <String>[ [-LoginAcknowled

ge] <SwitchParameter>] [<CommonParameters>]
Establish a connection with the specified HPE OneView appliance. Logs the user into the appliance and establishes a session
for use with subsequent requests. Prompts will be displayed for any omitted values.
Appliance hostname or IP can include an alternate TCP port number. While the appliance does not allow the default TCP port
443 to be changed, the appliance could reside behind a firewall, which is redirecting an alternate TCP port number.
Parameters
-AuthLoginDomain <String>
Aliases [-AuthProvider]
The Directory Name for LDAP/Active Directory authentication, or LOCAL for appliance internal user accounts.
Default is determined by connecting to the requested appliance and retrieving the default login directory. If not LOCAL, and you
attempt to use an embedded user account, you must use -AuthLoginDomain parameter with the Local value..
Aliases authProvider
Required? true
Position? named
Default value LOCAL
Provide the X.509 certificate/SmartCard digital badge in order to authenticate to a supported appliance. Two-factor
authentication must be configured on the appliance in order to provide a X.509 certificate.
Aliases None
Required? False
Position? named
Default value
Aliases PSCredential
Required? true
Position? named
Default value
-Hostname <String>
Aliases [-Appliance, -Computername]
The hostname or IP address of the appliance.
Aliases Appliance, Computername
Required? true
Position? named
Default value
-LoginAcknowledge <SwitchParameter>
When a Login Message has been configured and acknowledgement is Required, use this parameter to acknowledge it during
the initial call. Otherwise, if omitted, and a Login Banner acknowledgement is required, the caller will be prompted. This prompt
does not support the -Confirm parameter.
Aliases None
Required? false
Position? named
Default value False
-Password <Object>
Aliases [-p]
Password to log into the appliance. Can be either System.String or SecureString value..
Aliases p
Required? true
Position? named
Default value
-UserName <String>
Aliases [-u, -user]
User name to authenticate.
Aliases u, user
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
When a valid connection is established with an appliance, this object is then added to ${Global:ConnectedSessions} connection
tracker variable.
The object returned will contain the following public properties:
==============================================================================
| Name | Type | Value |
|-----------------------------------------------------------------------------
| AuthLoginDomain | String | Local |
------------------------------------------------------------------------------
| ConnectionId | Int | 1 |
------------------------------------------------------------------------------
| Name | String | Hostname value |
---------------------- -------------------------------------------------------
| SessionID | String | AUTH string returned from API |
------------------------------------------------------------------------------
| ApplianceType | String | Indicate connected appliance type. |
-------------------- ---------------------------------------------------------
| UserName | String | Username value |
------------------------------------------------------------------------------
| AuthType | String | Credential or Certificate/2FA |
------------------------------------------------------------------------------
| ActivePermissions | IList | Collection of Scopes and permissions |
------------------------------------------------------------------------------
| ApplianceSecurityRoles | IList | Collection of roles |
------------------------------------------------------------------------------
| Default | Boolean | Is connection default for library |
------------------------------------------------------------------------------
On error, appliance response is returned as a terminating error.
Examples
-------------------------- EXAMPLE 1 --------------------------
Connect-HPOVMgmt -appliance myappliance.domain.com

ConnectionID Name UserName AuthLoginDomain
1 myappliance.domain.com Administrator LOCAL
Connect to a specific appliance FQDN. The user will be prompted for authentication provider, user name and password.
-------------------------- EXAMPLE 2 --------------------------
Connect-HPOVMgmt -appliance myappliance.domain.com:11223
Connect to a specific appliance, where the target TCP port isn't the default. The user will be prompted for authentication
provider, user name and password.
-------------------------- EXAMPLE 3 --------------------------
$MySmartCard = gci Cert:\CurrentUser\my | ? { $_.EnhancedKeyUsageList.FriendlyName -match 'Smart Card Logon' }

Connect-HPOVMgmt -appliance myappliance.domain.com -Certificate $MySmartCard
Connect to a specific appliance using a digital badge.
Related Links
Disconnect-HPOVMgmt
Top

Migrate Server Profile.
SYNTAX
Convert-HPOVServerProfile [-InputObject] <Object>[ [-ServerHardwareType] <Object>][ [-EnclosureGroup] <Object>][
[-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<Commo
nParameters>]
Use this Cmdlet to change the Server Hardware Type and/or Enclosure Group set within the Server Profile. Changing to a
different server hardware type may change the capabilities available to the server profile. Changing the enclosure group may
change the connections which are available for the profile.
* The server hardware field will be set to "unassigned", requiring re-seletion of server hardware.
* It may also cause incompatibilities with the current configuration.
* All deployed connections will have their port assignment set to "Auto".
* Any incompatibilities will be flagged when the server profile is committed.
* If the new server hardware type does not support the local storage configuration, some storage may be lost.
* If the enclosure group is changed, mezzanine storage is lost and the disk drives are released.
* To prevent data loss, cancel this operation and backup data before applying the profile.
* Any change in the server hardware type will lead to the associated volume loss.
* If the server profile is associated with a server profile template, the server profile will become inconsiste
nt with the template. The server profile should be unassociated with the template before or after the migratio
n.
Required Permissions: Infrastructure administrator or Server administrator.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Override confirmation prompt.
Aliases cf
Required? false
Position? named
Default value
Specify the target HPOneView.EnclosureGroup resource object. By changing the Enclosure Group, assigned Networks with
Connections that do not exist on in the associated Logical Interconnect Group(s), the Connection may not be assigned to an
available FlexNIC.
Aliases None
Required? false
Position? named
Default value
The HPOneView.ServerProfile object from Get-HPOVServerProfile.
Aliases ServerProfile, Profile
Required? true
Position? named
Default value
-ServerHardwareType <Object>
Specify the HPOneView.ServerHardwareType object to transform to. BIOS Settings will be reset to defaults, and Connection
FlexNIC assignment will be reset back to Auto.
Aliases None
Required? false
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value

<CommonParameters>
Input Types
HPOneView.ServerProfile
The Server Profile resource object to transform.
Return Values
Async Task resource to monitor progress of the Server Profile transformation.
Examples
-------------------------- EXAMPLE 1 --------------------------
$ServerProfile = Get-HPOVServerProfile -Name "Prod Server 1" -ErrorAction Stop

$NewServerHardwareType = Get-HPOVServerHardwareType -Name "BL460 Gen9 3" -ErrorAction Stop
Convert-HPOVServerProfile -InputObject $ServerProfile -ServerHardwareType $NewServerHardwareType
Transform the specified server profile object to a different server hardware type resource.
-------------------------- EXAMPLE 2 --------------------------

$NewEnclosureGroup = Get-HPOVEnclosureGroup -Name "Dev EG 1" -ErrorAction Stop
Convert-HPOVServerProfile -InputObject $ServerProfile -EnclosureGroup $NewEnclosureGroup
Transform the specified server profile object to a different enclosure group resource.
-------------------------- EXAMPLE 3 --------------------------

Convert-HPOVServerProfile -InputObject $ServerProfile -EnclosureGroup $NewEnclosureGroup -ServerHardwareType $Ne
wServerHardwareType
Transform the specified server profile object to a different enclosure group and server hardware type resource. ### Related
Links * [Convert-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-
HPOVServerProfileTemplate) * [ConvertTo-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/ConvertTo-HPOVServerProfileTemplate) * [Copy-HPOVServerProfile](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Copy-HPOVServerProfile) * [Get-HPOVServerProfile](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVServerProfile) * [Get-HPOVServerProfileConnectionList](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVServerProfileConnectionList) * [Get-HPOVServerProfileMessage]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileMessage) * [Get-
HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileTemplate) *
[Join-HPOVServerProfileToTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Join-
HPOVServerProfileToTemplate) * [New-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVServerProfile) * [New-HPOVServerProfileAssign](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVServerProfileAssign) * [New-HPOVServerProfileAttachVolume](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVServerProfileAttachVolume) * [New-HPOVServerProfileConnection]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileConnection) * [New-
HPOVServerProfileLogicalDisk](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileLogicalDisk) *
[New-HPOVServerProfileLogicalDiskController](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOneView/wiki/New-HPOVServerProfileTemplate) * [Remove-HPOVServerProfile](https://github.com/HewlettPackard/POSH-
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProfileTemplate) * [Save-HPOVServerProfile]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfileTemplate) * [Set-HPOVServerProfile]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfile) * [Set-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfileTemplate) * [Update-HPOVServerProfile]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServerProfile) ***
Top
### HPE OneView 4.00 Library ## Convert-HPOVServerProfile
Migrate Server Profile. ### SYNTAX
Convert-HPOVServerProfile [-InputObject] <Object>[ [-ServerHardwareType] <Object>][ [-EnclosureGroup] <Object>][

[-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<Commo
nParameters>]
Use this Cmdlet to change the Server Hardware Type and/or Enclosure Group set within the Server Profile. Changing to a
different server hardware type may change the capabilities available to the server profile. Changing the enclosure group may
change the connections which are available for the profile.
* The server hardware field will be set to 'unassigned', requiring re-seletion of server hardware.
* All deployed connections will have their port assignment set to 'Auto'.
* If the enclosure group is changed, mezzanine storage is lost and the disk drives are released.
* If the server profile is associated with a server profile template, the server profile will become inconsiste
nt with the template. The server profile should be unassociated with the template before or after the migratio
n.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
available FlexNIC.
Aliases None
Required? false
Position? named
Default value
The HPOneView.ServerProfile object from Get-HPOVServerProfile.
Aliases ServerProfile, Profile
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
The Server Profile resource object to transform.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

Convert-HPOVServerProfile -InputObject $ServerProfile -ServerHardwareType $NewServerHardwareType
Transform the specified server profile object to a different server hardware type resource.
-------------------------- EXAMPLE 2 --------------------------

Convert-HPOVServerProfile -InputObject $ServerProfile -EnclosureGroup $NewEnclosureGroup
Transform the specified server profile object to a different enclosure group resource.
-------------------------- EXAMPLE 3 --------------------------

Convert-HPOVServerProfile -InputObject $ServerProfile -EnclosureGroup $NewEnclosureGroup -ServerHardwareType $Ne
wServerHardwareType
Transform the specified server profile object to a different enclosure group and server hardware type resource.
Related Links
Top

Migrate Server Profile Template.
SYNTAX
Convert-HPOVServerProfileTemplate [-InputObject] <Object>[ [-ServerHardwareType] <Object>][ [-EnclosureGroup] <O
bject>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm]
<SwitchParameter>] [<CommonParameters>]
Use this Cmdlet to change the Server Hardware Type and/or Enclosure Group set within the Server Profile Template. Changing
to a different server hardware type may change the capabilities available to the server profile. Changing the enclosure group
may change the connections which are available for the profile.
* The server hardware field will be set to "unassigned", requiring re-seletion of server hardware.
* All deployed connections will have their port assignment set to "Auto".
* If the enclosure group is changed, mezzanine storage for HPE Synergy is lost and the disk drives are released
.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False

Aliases cf
Required? false
Position? named
Default value
available FlexNIC.
Aliases None
Required? false
Position? named
Default value
The HPOneView.ServerProfileTemplate object from Get-HPOVServerProfileTemplate.
Aliases ServerProfileTemplate, SPT
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
default content
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.ServerProfileTemplate
The Server Profile Template resource object to transform.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$SPT = Get-HPOVServerProfileTemplate -Name "My Template Name" -ErrorAction Stop

$NewServerHardwareType = Get-HPOVServerHardwareType -Name "SY480 Gen10 2" -ErrorAction Stop
Convert-HPOVServerProfileTemplate -InputObject $SPT -ServerHardwareType $NewServerHardwareType
Transform the specified server profile template object to a different server hardware type resource.
-------------------------- EXAMPLE 2 --------------------------

Convert-HPOVServerProfileTemplate -InputObject $SPT -EnclosureGroup $NewEnclosureGroup
Transform the specified server profile template object to a different enclosure group resource.
-------------------------- EXAMPLE 3 --------------------------

Convert-HPOVServerProfileTemplate -InputObject $SPT -EnclosureGroup $NewEnclosureGroup -ServerHardwareType $NewS
erverHardwareType
Transform the specified server profile template object to a different enclosure group and server hardware type resource. ###
Related Links * [ConvertTo-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-
HPOVServerProfileTemplate) * [Get-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVServerProfileTemplate) * [New-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileTemplate) * [Remove-
HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProfileTemplate) *
[Save-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-
HPOVServerProfileTemplate) * [Set-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVServerProfileTemplate) ***
Top
### HPE OneView 4.00 Library ## Convert-HPOVServerProfileTemplate
Migrate Server Profile Template. ### SYNTAX
Convert-HPOVServerProfileTemplate [-InputObject] <Object>[ [-ServerHardwareType] <Object>][ [-EnclosureGroup] <O

bject>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm]
Use this Cmdlet to change the Server Hardware Type and/or Enclosure Group set within the Server Profile Template. Changing
to a different server hardware type may change the capabilities available to the server profile. Changing the enclosure group
may change the connections which are available for the profile.
* The server hardware field will be set to 'unassigned', requiring re-seletion of server hardware.
* All deployed connections will have their port assignment set to 'Auto'.
* If the enclosure group is changed, mezzanine storage for HPE Synergy is lost and the disk drives are released
.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
available FlexNIC.
Aliases None
Required? false
Position? named
Default value
The HPOneView.ServerProfileTemplate object from Get-HPOVServerProfileTemplate.
Aliases ServerProfileTemplate, SPT
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
default content
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
The Server Profile Template resource object to transform.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

$NewServerHardwareType = Get-HPOVServerHardwareType -Name "SY480 Gen10 2" -ErrorAction Stop
Convert-HPOVServerProfileTemplate -InputObject $SPT -ServerHardwareType $NewServerHardwareType
Transform the specified server profile template object to a different server hardware type resource.
-------------------------- EXAMPLE 2 --------------------------

Convert-HPOVServerProfileTemplate -InputObject $SPT -EnclosureGroup $NewEnclosureGroup
Transform the specified server profile template object to a different enclosure group resource.
-------------------------- EXAMPLE 3 --------------------------

Convert-HPOVServerProfileTemplate -InputObject $SPT -EnclosureGroup $NewEnclosureGroup -ServerHardwareType $NewS
erverHardwareType
Transform the specified server profile template object to a different enclosure group and server hardware type resource.
Related Links
Top
ConvertTo-HPOVImageStreamerConfiguration

ConvertTo-HPOVImageStreamerConfiguration
Convert Logical Enclosure to support HPE Image Streamer.
SYNTAX
ConvertTo-HPOVImageStreamerConfiguration [-InputObject] <Object> [-UplinkSetName] <Name> [-DeploymentNetwork] <O
bject>[ [-UplinkPorts] <Array>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>
]
Convert Logical Enclosure and associated Enclosure Group and Logical Interconnect Group to support Internal Image Streamer
configuration. HPE Synergy Virtual Connect Logical Interconnect Group must reside in Bays 3 and 6 in order to be reconfigured.
When using this Cmdlet, a service outage will ocurr, as the Logical Enclosure will need to be recreated. This means Server
Profiles will be unassigned, Logical Enclosure removed then recreated, and then Server Profiles reassigned to their original
location. If the Logical Enclousre contains HPE Synergy SAS Logical Interconnects, data loss may ocurr, as the Server Profiles
may not be assigned in the right order, which would cause disk selection to assign different physical disks. Please make sure all
data is backed up prior to migration. By Default, the Cmdlet will not migrate a Logical Enclosure if SAS Logical Interconnects are
found. To override, use the -IgnoreSasLogicalInterconnects switch, which again may cause loss of data.
Any associated Enclosure Groups with the Virtual Connect Ethernet Logical Interconnec Group will also be modified. If this is not
intended, you should first remove the Logical Interconnect Group from the Enclosure Group before executing this Cmdlet.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
-DeploymentNetwork <Object>
Provide the Deployment Network object. Must be associated with a valid IPv4 Subnet that is within the same subnet as the
Composer.
Aliases None
Required? true
Position? named
Default value
Provide the Logical Enclosure resource object or name that will be recreated.
Aliases EnclosureGroup, EG
Required? true
Position? named
Default value

-UplinkPorts <Array>
Specify 4 redundant Uplink Ports.
Aliases None
Required? False
Position? named
Default value @("Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.1","Enclosure2:Bay6:Q2.1")
Accept pipeline
false
input?
Accept wildcard
False
characters?
-UplinkSetName <Name>
The Uplink Set Name to be added.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.LogicalEnclosure [System.Management.Automation.PSCustomObject]
HPE Synergy Logical Enclosure to convert.
Return Values
If the Logical Enclosure cannot be removed or re-created, as PSCustomObject with original Server Profile location is provided.
Object properties are Name, ProfileUri, ServerSerialNumber.
The async task for each Server Profile that will be re-assigned for the caller to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
$LE = Get-HPOVLogicalEnclosure -Name MyLE1 -ErrorAction Stop

$UplinkPorts = @("Enclosure1:Bay3:Q3.1","Enclosure1:Bay3:Q4.1","Enclosure2:Bay6:Q3.1","Enclosure2:Bay6:Q4.1")
$UplinkSetName = "ImageStreamer UplinkSet"
$DeploymentNetwork = Get-HPOVNetwork -Name "ImageStreamer Deployment" -ErrorAction Stop
ConvertTo-HPOVImageStreamerConfiguration -InputObject $le -UplinkSetName $UplinkSetName -UplinkPorts $UplinkPort
s -DeploymentNetwork $DeploymentNetwork -IgnoreSasLogicalInterconnects
Convert the MyLE1 Logical Enclosure to support Image Streamer, specifying uplink ports, OS Deployment Network and to ignore
found SAS Logical Interconnects if found. ### Related Links ***
Top
### HPE OneView 4.00 Library ## ConvertTo-HPOVImageStreamerConfiguration
Convert Logical Enclosure to support HPE Image Streamer. ### SYNTAX
ConvertTo-HPOVImageStreamerConfiguration [-InputObject] <Object> [-UplinkSetName] <Name> [-DeploymentNetwork] <O

bject>[ [-UplinkPorts] <Array>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>
]
Convert Logical Enclosure and associated Enclosure Group and Logical Interconnect Group to support Internal Image Streamer
configuration. HPE Synergy Virtual Connect Logical Interconnect Group must reside in Bays 3 and 6 in order to be reconfigured.
When using this Cmdlet, a service outage will ocurr, as the Logical Enclosure will need to be recreated. This means Server
Profiles will be unassigned, Logical Enclosure removed then recreated, and then Server Profiles reassigned to their original
location. If the Logical Enclousre contains HPE Synergy SAS Logical Interconnects, data loss may ocurr, as the Server Profiles
may not be assigned in the right order, which would cause disk selection to assign different physical disks. Please make sure all
data is backed up prior to migration. By Default, the Cmdlet will not migrate a Logical Enclosure if SAS Logical Interconnects are
found. To override, use the -IgnoreSasLogicalInterconnects switch, which again may cause loss of data.
Any associated Enclosure Groups with the Virtual Connect Ethernet Logical Interconnec Group will also be modified. If this is not
intended, you should first remove the Logical Interconnect Group from the Enclosure Group before executing this Cmdlet.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Provide the Deployment Network object. Must be associated with a valid IPv4 Subnet that is within the same subnet as the
Composer.
Aliases None
Required? true
Position? named
Default value
Provide the Logical Enclosure resource object or name that will be recreated.
Aliases EnclosureGroup, EG
Required? true
Position? named
Default value
Specify 4 redundant Uplink Ports.
Aliases None
Required? False
Position? named
Default value @("Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.1","Enclosure2:Bay6:Q2.1")
Accept pipeline
false
input?
Accept wildcard
False
characters?
-UplinkSetName <Name>
The Uplink Set Name to be added.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
HPE Synergy Logical Enclosure to convert.
Return Values
If the Logical Enclosure cannot be removed or re-created, as PSCustomObject with original Server Profile location is provided.
Object properties are Name, ProfileUri, ServerSerialNumber.
The async task for each Server Profile that will be re-assigned for the caller to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
$LE = Get-HPOVLogicalEnclosure -Name MyLE1 -ErrorAction Stop

$UplinkPorts = @("Enclosure1:Bay3:Q3.1","Enclosure1:Bay3:Q4.1","Enclosure2:Bay6:Q3.1","Enclosure2:Bay6:Q4.1")
$UplinkSetName = 'ImageStreamer UplinkSet'
$DeploymentNetwork = Get-HPOVNetwork -Name 'ImageStreamer Deployment' -ErrorAction Stop
ConvertTo-HPOVImageStreamerConfiguration -InputObject $le -UplinkSetName $UplinkSetName -UplinkPorts $UplinkPort
s -DeploymentNetwork $DeploymentNetwork -IgnoreSasLogicalInterconnects
Convert the MyLE1 Logical Enclosure to support Image Streamer, specifying uplink ports, OS Deployment Network and to ignore
found SAS Logical Interconnects if found.
Related Links
Top
ConvertTo-HPOVPowerShellScript
ConvertTo-HPOVPowerShellScript
Create PowerShell script from resource.
SYNTAX
ConvertTo-HPOVPowerShellScript [-InputObject] <Object>[ [-Export] <System.IO.FileInfo>][ [-Append] <SwitchParame
ter>] [<CommonParameters>]
This Cmdlet will assist administrators or scripters to help generate script code from specific resources. The code generated is a
starting point to be used for repeating similar tasks performed by the UI, or to incorporate into scripts or workflows.
The following resources are supported by this Cmdlet:
* Baselines (Get-HPOVBaseline)
* Appliance Address Pool Ranges (Get-HPOVAddressPoolRange)
* Appliance Address Pool Subnets (Get-HPOVAddressPoolSubnet)
* Appliance Date Time and Locale (Get-HPOVApplianceDateTime)
* Appliance LDAP Directory (Get-HPOVLdapDirectory)
* Appliance LDAP Directory Group (Get-HPOVLdapGroup)
* Appliance SNMP configuration (Get-HPOVSnmpReadCommunity)
* Appliance SNMPv3 Users (Get-HPOVSnmpV3User)
* Appliance Email Notifications (Get-HPOVApplianceProxy)
* Appliance Proxy (Get-HPOVApplianceProxy)
* Appliance User (Get-HPOVUser)
* Scopes (Get-HPOVScope)
* Network (Get-HPOVNetwork)
* Network Set (Get-HPOVNetworkSet)
* SAN Manager (Get-HPOVSanNanager)
* Storage System (Get-HPOVStorageSystem)
* Storage Pool (Get-HPOVStoragePool)
* Storage Volume Template (Get-HPOVStorageVolumeTemplate)
* Storage Volume (Get-HPOVStorageVolume)
* Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup)
* Logical Enclosure Group (Get-HPOVLogicalEnclosureGroup)
* Logical Enclosure (Get-HPOVLogicalEnclosure)
* Server Profile Template (Get-HPOVServerProfileTemplate)
* Server Profile (Get-HPOVServerProfile)
Parameters
-Append <SwitchParameter>
Indicte if the export file should be appended. By default, a new file will be created with new content.
Aliases None
Required? False
Position? named
Default value
-Export <System.IO.FileInfo>
Location where to write UTF-8 file.
Aliases None
Required? False
Position? named
Default value
Resource object from supported Cmdlets.
Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
Various objects are supported.
Return Values
System.String
String output of generated code.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile | ConvertTo-HPOVPowerShellScript
Generate PowerShell script code for the returned server profile objects.
Related Links
Top

Create a Server Profile Template from Server Profile.
SYNTAX
ConvertTo-HPOVServerProfileTemplate [-InputObject] <Object> [-Name] <String> [-Description] <String> [-Appliance
Connection] <Object>[ [-Async] <SwitchParameter>] [<CommonParameters>]
This CMDLET will allow the user to "clone" or create a Server Profile Template from an existing Server Profile object. Not all
Server Profile features will be converted to a Server Profile Template. For instance, the following features are not supported with
a Server Profile Template:
* Import existing local Smart Array Logical Disk configuration

* Attach SAN Storage Volumes must be assigned a unique LUN ID
If the source Server Profile has the "Import existing logical drives" enabled, this setting will be disabled, and the Local Disk
Configuration policy will be set to "disabled".
If any SAN Storage Volume attachments contain an "Auto" LUN value, it will be set to "Manual", with the LUN ID set to a unique
value based on the Array Index value.
Parameters
Aliases Appliance
Required? true
Position? 3
Aliases None
Required? false
Position? named
Default value False

The Server Profile description.
Aliases None
Required? true
Position? 2
Default value
Aliases [-source, -name, -ServerProfile]
A source Server Profile Object or Resource Name.
Aliases source, ServerProfile
Required? true
Position? 0
Default value
-Name <String>
The Server Profile Template Name to assign. If omitted, then a new name of "Copy of - {Original_Name}" will be defined.
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]
A Server Profile resource object from Get-HPOVServerProfile.
System.Collections.ArrayList
Multiple HPOneView.ServerProfile [System.Management.Automation.PSCustomObject] objects.
Return Values
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject] objects.
Asyncronous task of the Server Profile Template creation request.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile MyProfile | ConvertTo-HPOVServerProfileTemplate -Name "Hypervisor Gold Template 1"
Use Get-HPOVServerProfile to retrieve the "MyProfile" object, and pipe it to ConvertTo-HPOVServerProfileTemplate, creating a
new Server Profile Template "Hyervisor Gold Template 1". ### Related Links * [Convert-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfileTemplate) * [Get-
[New-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileTemplate)
* [Remove-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVServerProfileTemplate) * [Save-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Save-HPOVServerProfileTemplate) * [Set-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfileTemplate) ***
Top
### HPE OneView 4.00 Library ## ConvertTo-HPOVServerProfileTemplate
Create a Server Profile Template from Server Profile. ### SYNTAX
ConvertTo-HPOVServerProfileTemplate [-InputObject] <Object> [-Name] <String> [-Description] <String> [-Appliance

Connection] <Object>[ [-Async] <SwitchParameter>] [<CommonParameters>]
This CMDLET will allow the user to 'clone' or create a Server Profile Template from an existing Server Profile object. Not all
Server Profile features will be converted to a Server Profile Template. For instance, the following features are not supported with
a Server Profile Template:
* Import existing local Smart Array Logical Disk configuration

* Attach SAN Storage Volumes must be assigned a unique LUN ID
If the source Server Profile has the 'Import existing logical drives' enabled, this setting will be disabled, and the Local Disk
Configuration policy will be set to 'disabled'.
If any SAN Storage Volume attachments contain an 'Auto' LUN value, it will be set to 'Manual', with the LUN ID set to a unique
value based on the Array Index value.
Parameters
Aliases Appliance
Required? true
Position? 3
Aliases None
Required? false
Position? named
Default value False
The Server Profile description.
Aliases None
Required? true
Position? 2
Default value
Aliases [-source, -name, -ServerProfile]
A source Server Profile Object or Resource Name.
Aliases source, ServerProfile
Required? true
Position? 0
Default value
-Name <String>
The Server Profile Template Name to assign. If omitted, then a new name of 'Copy of - {Original_Name}' will be defined.
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
A Server Profile resource object from Get-HPOVServerProfile.
Multiple HPOneView.ServerProfile [System.Management.Automation.PSCustomObject] objects.
Return Values
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject] objects.
Asyncronous task of the Server Profile Template creation request.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile MyProfile | ConvertTo-HPOVServerProfileTemplate -Name 'Hypervisor Gold Template 1'
Use Get-HPOVServerProfile to retrieve the 'MyProfile' object, and pipe it to ConvertTo-HPOVServerProfileTemplate, creating a
new Server Profile Template 'Hyervisor Gold Template 1'.
Related Links
Top


Convert an existing Storage Volume Snapshot to a Storage Volume.
SYNTAX
ConvertTo-HPOVStorageVolume [-InputObject] <Object> [-Name] <String> [-Description] <String> [-SharingMode] <Str
ing> [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>] [<CommonParameters>]
Storage Volume Snapshots can be converted to assignable and managed Storage Volume resources. When converting a
Snapshot to a Storag Volume, it will lose its parent/child relationship.
Parameters
Default Value: ${Global:ConnectSessions} | ? Default
Aliases Appliance
Required? true
Position? 4
Aliases None
Required? false
Position? named
Default value False
The description of the storage volume.
Aliases None
Required? true
Position? 2
Default value

Aliases [-Snapshot]
Provide the snapshot resource object to convert managed by the appliance.
Aliases Snapshot
Required? true
Position? 0
Default value
-Name <String>
The Storage Volume Name.
Aliases None
Required? true
Position? 1
Default value
-SharingMode <String>
Specify if the new storage volume should be Private or Shared.
Aliases None
Required? true
Position? 3
Default value
<CommonParameters>
Input Types
HPOneView.Storage.VolumeSnapshot [System.Management.Automation.PSCustomObject]
Storage Volume Snapshot resource object.
Return Values
Multiple resources
Create Storage Volume async task.
Examples
-------------------------- EXAMPLE 1 --------------------------
Return all storage volume resource objects.

-------------------------- EXAMPLE 2 --------------------------
$Snapshots = Get-HPOVStorageVolume "Volume 1" | Get-HPOVStorageVolumeSnapshot

$Snapshots | ? { ((Get-Date $_.created -Format d) -eq (Get-Date 02/23/2016 -format d)} | ConvertTo-HPOVStorageVo
lume -Name "Copy of Volume 1" | Wait-HPOVTaskComplete
Get all of the available storage volume snapshots for "Volume 1", then convert the snapshot created on the specified date to a
storage volume resource. ### Related Links * [Add-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Add-HPOVStorageVolume) * [Get-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVStorageVolume) * [Get-HPOVStorageVolumeSnapShot](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVStorageVolumeSnapShot) * [Get-HPOVStorageVolumeTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeTemplate) * [Get-
HPOVStorageVolumeTemplatePolicy](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVStorageVolumeTemplatePolicy) * [New-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVStorageVolume) * [New-HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVStorageVolumeSnapshot) * [New-HPOVStorageVolumeTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolumeTemplate) * [Remove-
HPOVStorageVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStorageVolume) * [Remove-
HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
Top
### HPE OneView 4.00 Library ## ConvertTo-HPOVStorageVolume
Convert an existing Storage Volume Snapshot to a Storage Volume. ### SYNTAX
ConvertTo-HPOVStorageVolume [-InputObject] <Object> [-Name] <String> [-Description] <String> [-SharingMode] <Str

ing> [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>] [<CommonParameters>]
Storage Volume Snapshots can be converted to assignable and managed Storage Volume resources. When converting a
Snapshot to a Storag Volume, it will lose its parent/child relationship.
Parameters
Aliases Appliance
Required? true
Position? 4
Aliases None
Required? false
Position? named
Default value False
The description of the storage volume.
Aliases None
Required? true
Position? 2
Default value
Aliases [-Snapshot]
Provide the snapshot resource object to convert managed by the appliance.
Aliases Snapshot
Required? true
Position? 0
Default value
-Name <String>
The Storage Volume Name.
Aliases None
Required? true
Position? 1
Default value
-SharingMode <String>
Specify if the new storage volume should be Private or Shared.
Aliases None
Required? true
Position? 3
Default value
<CommonParameters>
Input Types
Storage Volume Snapshot resource object.
Return Values
Multiple resources
Create Storage Volume async task.
Examples
-------------------------- EXAMPLE 1 --------------------------
-------------------------- EXAMPLE 2 --------------------------
$Snapshots = Get-HPOVStorageVolume 'Volume 1' | Get-HPOVStorageVolumeSnapshot

$Snapshots | ? { ((Get-Date $_.created -Format d) -eq (Get-Date 02/23/2016 -format d)} | ConvertTo-HPOVStorageVo
lume -Name 'Copy of Volume 1' | Wait-HPOVTaskComplete
Get all of the available storage volume snapshots for 'Volume 1', then convert the snapshot created on the specified date to a
storage volume resource.
Related Links
Top

Copy Server Profile
SYNTAX
Copy-HPOVServerProfile [-InputObject] <Object>[ [-DestinationName] <String>][ [-Assign] <Object>][ [-ApplianceCo
nnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This cmdlet will copy a source Server Profile to a new instance You can assign the copy to an existing Server Device, or specify
"unassigned".
Parameters

Aliases Appliance
Required? false
Position? 3
-Assign <Object>
The name, URI, or object of the target server to assign the new profile to. If omitted, profile will be "unassigned"
Aliases None
Required? false
Position? 2
Default value unassigned
-Confirm <>
Aliases cf
Required?
Position? named
Default value
-DestinationName <String>
Aliases [-dname] The name of the destination server profile that will be created. If omitted, the new name will have "Copy of "
prefixed to the source name.
Aliases dname, dst
Required? false
Position? 1
Default value
Aliases [-sname, -src, -SourceName] The Name or Resource Object of the source server profile to be copied.
Aliases sname, src, SourceName
Required? true
Position? 0
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Server Profile resource object
Return Values
Profile Create async task
Examples
-------------------------- EXAMPLE 1 --------------------------
Copy-HPOVServerProfile -SourceName "Profile 1"
Copy "Profile 1" to a new Server Profile that is unassigned and named "Copy of Profile 1".
-------------------------- EXAMPLE 2 --------------------------
Copy-HPOVServerProfile -SourceName "Profile 1" -DestinationName "Profile 2"
Copy "Profile 1" to a new Server Profile that is unassigned and named "Profile 2".
-------------------------- EXAMPLE 3 --------------------------
Copy-HPOVServerProfile -SourceName "Profile 1" -DestinationName "Profile 2" -assign "Encl1, Bay 9"
Copy "Profile 1" to a new Server Profile that is assigned to "Encl1, Bay 9" named "Profile 2".
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServerProfile -Name "Profile 1" | Copy-HPOVServerProfile
Use the Get-HPOVServerProfile CMDLET and pipe to Copy-HPOVServerProfile, where the copied profile name will be "Copy of
Profile 1" and unassigned.
-------------------------- EXAMPLE 5 --------------------------
11..16 | % { Copy-HPOVServerProfile -SourceName "Profile Template" -DestinationName "Profile $_" -Assign "Encl1,
bay $_" }
Copy 5 Server Profiles from "Profile Template" that will be assigned to bays 11 - 16 of Encl1. ### Related Links * [Convert-
HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfile) * [Convert-
HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfileTemplate) *
[ConvertTo-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-
HPOVServerProfileTemplate) * [Get-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVServerProfile) * [Get-HPOVServerProfileConnectionList](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
Top
### HPE OneView 4.00 Library ## Copy-HPOVServerProfile
Copy Server Profile ### SYNTAX
Copy-HPOVServerProfile [-InputObject] <Object>[ [-DestinationName] <String>][ [-assign] <Object>][ [-ApplianceCo

nnection] <Object>] [<CommonParameters>]
This cmdlet will copy a source Server Profile to a new instance You can assign the copy to an existing Server Device, or specify
'unassigned'.
Parameters
Aliases Appliance
Required? false
Position? 3
-DestinationName <String>
Aliases [-dname] The name of the destination server profile that will be created. If omitted, the new name will have "Copy of "
prefixed to the source name.
Aliases dname, dst
Required? false
Position? 1
Default value
Aliases [-sname, -src, -SourceName] The Name or Resource Object of the source server profile to be copied.
Aliases sname, src, SourceName
Required? true
Position? 0
Default value
-assign <Object>
The name, URI, or object of the target server to assign the new profile to. If omitted, profile will be 'unassigned'
Aliases None
Required? false
Position? 2
Default value unassigned
<CommonParameters>
Input Types
Server Profile resource object
Return Values
Profile Create async task
Examples
-------------------------- EXAMPLE 1 --------------------------
Copy-HPOVServerProfile -SourceName "Profile 1"
Copy "Profile 1" to a new Server Profile that is unassigned and named "Copy of Profile 1".
-------------------------- EXAMPLE 2 --------------------------
Copy-HPOVServerProfile -SourceName "Profile 1" -DestinationName "Profile 2"
Copy "Profile 1" to a new Server Profile that is unassigned and named "Profile 2".
-------------------------- EXAMPLE 3 --------------------------
Copy-HPOVServerProfile -SourceName "Profile 1" -DestinationName "Profile 2" -assign "Encl1, Bay 9"
Copy "Profile 1" to a new Server Profile that is assigned to "Encl1, Bay 9" named "Profile 2".
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServerProfile -Name "Profile 1" | Copy-HPOVServerProfile
Use the Get-HPOVServerProfile CMDLET and pipe to Copy-HPOVServerProfile, where the copied profile name will be "Copy of
Profile 1" and unassigned.
-------------------------- EXAMPLE 5 --------------------------
11..16 | % { Copy-HPOVServerProfile -SourceName "Profile Template" -DestinationName "Profile $" -Assign "Encl1,
bay $" }
Copy 5 Server Profiles from "Profile Template" that will be assigned to bays 11 - 16 of Encl1.
Related Links
Top
Disable-HPOVApplianceComplexPasswords

Disable appliance complex password policy.
SYNTAX
Disable-HPOVApplianceComplexPasswords[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm]
Disables whether users are required to have complex passwords. This option does not force existing users to change their
passwords, nor has any impact on directory accounts. By default, the appliance does not enforce complex passwords during
creating or modifying internal user account passwords. Use this Cmdlet to disable the policy.
Parameters
Aliases Appliance
Required? False
Position? named
Override the confirmation prompt.
Aliases cf
Required? false
Position? named
Default value
Perform a test to identify the beahvior before executing the Cmdlet. Will not modify resources.
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Appliance global security settings.
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable complex password policy on the appliance. ### Related Links * [Enable-HPOVApplianceComplexPasswords]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVApplianceComplexPasswords) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVApplianceComplexPasswords
Disable appliance complex password policy. ### SYNTAX
Disable-HPOVApplianceComplexPasswords[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm]

Disables whether users are required to have complex passwords. This option does not force existing users to change their
creating or modifying internal user account passwords. Use this Cmdlet to disable the policy.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
Perform a test to identify the beahvior before executing the Cmdlet. Will not modify resources.
Aliases wi
Required? false
Position? named
Default value

<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable complex password policy on the appliance.
Related Links
Enable-HPOVApplianceComplexPasswords
Top
Disable-HPOVApplianceServiceConsoleAccess

Disable appliance service console access.
SYNTAX
Disable-HPOVApplianceServiceConsoleAccess[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Conf
irm] <SwitchParameter>] [<CommonParameters>]
HPE OneView contains a technical feature that will allow an on-site Authorized technical support to access your system, through
the system console, to assess problems that you have reported. This access will be controlled by a password generated by HPE
that will only be provided to the Authorized technical support. You can enable or disable access at any time while the system is
running. Hewlett Packard Enterprise recommends that you enable service console access so that an Authorized technical
support can diagnose your system in the event of a a system failure.
Use this Cmdlet to disable service console access.
Required: Infrastructure administrator

Parameters
Aliases Appliance
Required? False
Position? named
Override prompt.
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Asyncronous task resource to monitor
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable service console access on the appliance. ### Related Links * [Enable-HPOVApplianceServiceConsoleAccess]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVApplianceServiceConsoleAccess) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVApplianceServiceConsoleAccess
Disable appliance service console access. ### SYNTAX
Disable-HPOVApplianceServiceConsoleAccess[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Conf

irm] <SwitchParameter>] [<CommonParameters>]
Use this Cmdlet to disable service console access.
Parameters
Aliases Appliance
Required? False
Position? named
Override prompt.
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable service console access on the appliance.
Related Links
Enable-HPOVApplianceServiceConsoleAccess
Top
Disable-HPOVApplianceSshAccess

Disable appliance SSH access.
SYNTAX
Disable-HPOVApplianceSshAccess[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchP
arameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
HPE OneView supports Secure Shell (SSH) to remotely access the appliance to perform maintenance and recovery operations.
Without SSH access, you must access the virtual machine system console. To avoid requiring a console access, SSH access is
enabled by default. However, remote access to maintenance and recovery operations is considered a security risk by some
users. Therefore, HPE OneView provides the option to disable remote access to the appliance via SSH.
Use this Cmdlet to disable appliance SSH access.
Privileges: Infrastructure administrator
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable appliance SSH access. ### Related Links * [Enable-HPOVApplianceSshAccess]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVApplianceSshAccess) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVApplianceSshAccess
Disable appliance SSH access. ### SYNTAX
Disable-HPOVApplianceSshAccess[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchP

Use this Cmdlet to disable appliance SSH access.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable appliance SSH access.
Related Links
Enable-HPOVApplianceSshAccess
Top
Disable-HPOVApplianceTwoFactorAuthentication

Disable appliance two-factor authentication settings.
SYNTAX
Disable-HPOVApplianceTwoFactorAuthentication[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-C
onfirm] <SwitchParameter>] [<CommonParameters>]
Use this Cmdlet to disable two-factor authentication on the appliance.
Enabling two-factor authentication allows you to use smart cards ï¿½ for example, Common Access Cards (CAC), or Personal
Identity Verification (PIV) cards ï¿½ to authenticate within HPE OneView. The client certificate embedded in the smart card is
presented to HPE OneView by the library. The client certificate must be signed by a root or intermediate Certificate Authority
(CA) that has been previously imported into the HPE OneView appliance. The appliance authenticates the client certificate to
validate that the user name specified in the certificate is that of a valid user recognized by the directory server configuration in
HPE OneView.
When two-factor authentication is enabled, HPE OneView uses a Microsoft Active Directory service account set up and owned
by the user to access an Active Directory entry for the user, rather than using an account associated with the user name
Use this Cmdlet to configure two factor authentication state of the connected appliance. An Active Directory authentication
directoyr must be configured, with a Service Account, and the root or issuing certificate authority Base64 certificate must be
uploaded to appliance.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable two-factor authentication on the connected appliance. ### Related Links * [Get-
HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceTwoFactorAuthentication) * [Set-HPOVApplianceTwoFactorAuthentication]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceTwoFactorAuthentication) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVApplianceTwoFactorAuthentication
Disable appliance two-factor authentication settings. ### SYNTAX
Disable-HPOVApplianceTwoFactorAuthentication[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-C

Use this Cmdlet to disable two-factor authentication on the appliance.
Enabling two-factor authentication allows you to use smart cards — for example, Common Access Cards (CAC), or Personal
Identity Verification (PIV) cards — to authenticate within HPE OneView. The client certificate embedded in the smart card is
HPE OneView.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable two-factor authentication on the connected appliance.
Related Links
Get-HPOVApplianceTwoFactorAuthentication
Set-HPOVApplianceTwoFactorAuthentication
Top
Disable-HPOVCertificateValidation

Disable appliance TLS/SSL certificate validation.
SYNTAX
Disable-HPOVCertificateValidation[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <Sw
HPE OneView performs certificate validation for all Transport Layer Security (TLS) communications between the appliance and
external servers or devices. These checks guarantee confidentiality, integrity, and authentication with the remote end-point.
In production environments, Hewlett Packard Enterprise strongly recommends that certificate validation be enabled. In
environments where security is not a concern, such as a testing environment, certificate validation can optionally be disabled.
If certificate validation is disabled, any sensitive data such as credentials are transmitted insecurely. Make sure to use only local
user accounts and not enterprise directory-based accounts to avoid transmitting enterprise login credentials over the network
when certificate validation is disabled.
NOTE: When upgrading from earlier releases, the certificates in use by the currently monitored or managed devices are
imported into the HPE OneView trust store and alerts are generated for issues such as expired certificates. These automatically
added certificates are either a device"s self-signed certificate or the leaf certificate for a certificate authority (CA) signed
certificate. Using CA-signed certificates can simplify the device trust process.
Certificate checking is enabled by default, but some of the stricter validation checks are relaxed to maintain communications with
all devices, even those with certificate issues. The relaxed checking includes:
* Not performing expiration checks for self-signed certificates

* For certificate authority (CA) signed certificates, relaxed certificate revocation list (CRL) checking.
The relaxed checking gives the administrator time to address any expired certificates, to upload trusted CA root and
intermediate certificates, and upload the appropriate CRLs.
Hewlett Packard Enterprise strongly recommends that you enable strict certificate validation checks after completing an update
as appropriate for your enterprise security policies. See Manage Certificates for additional information on certificate
management.
HPE OneView supports devices using self-signed certificates and devices using formal CA-signed certificates. CA-signed
certificates offer benefits such as revocation checking and overall simplified management.
HPE OneView enables users to import a CA CRL file and to perform the appropriate revocation checking on existing certificates
in the trust store and for certificates received during communication with a managed device or external server.
WARNING: Modifying the appliance setting will require the appliance to be rebooted.
WARNING: If 2-factor authentication is configured, this policy cannot be disabled.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable certificate validation on the appliance. ### Related Links * [Enable-HPOVCertificateValidation]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVCertificateValidation) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVCertificateValidation
Disable appliance TLS/SSL certificate validation. ### SYNTAX

Disable-HPOVCertificateValidation[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <Sw
added certificates are either a device's self-signed certificate or the leaf certificate for a certificate authority (CA) signed

management.
WARNING: If 2-factor authentication is configured, this policy cannot be disabled.
Parameters
Aliases Appliance
Required? False
Position? named

Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable certificate validation on the appliance.
Related Links
Enable-HPOVCertificateValidation
Top
Disable-HPOVDebug
Disable-HPOVDebug
Disable specific appliance-level component debug logging.
SYNTAX
Disable-HPOVDebug [-Scope] <String> [-LoggerName] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
FOR HP SUPPORT USE ONLY. This cmdlet will disable appliance level component debug logging for during issue triage, by
setting the Level to INFO. Do not use this cmdlet unless otherwise instructed by HP Support.
Parameters
Aliases None
Required? true
Position? named
-LoggerName <String>
The internal component name.
Aliases None
Required? true
Position? named
Default value
-Scope <String>
The Scope of the LoggerName.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPE OneView Appliance Connection object.
Return Values
Examples
Related Links
Enable-HPOVDebug
Top
### HPE OneView 4.00 Library ## Disable-HPOVDebug
Disable specific appliance-level component debug logging. ### SYNTAX
Disable-HPOVDebug [-Scope] <String> [-LoggerName] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
FOR HP SUPPORT USE ONLY. This cmdlet will disable appliance level component debug logging for during issue triage, by
setting the Level to INFO. Do not use this cmdlet unless otherwise instructed by HP Support. ### Parameters -
ApplianceConnection <Object>
Aliases [-Appliance] Specify one HPOneView.Appliance.Connection object or Name property value.
Aliases None
Required? true
Position? named
Aliases None
Required? true
Position? named
Default value
-Scope <String>
Aliases None
Required? true
Position? named
Default value
<CommonParameters> This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable,
WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
### Input Types HPOneView.Appliance.Connection HPE OneView Appliance Connection object. ### Return Values
System.Management.Automation.PSCustomObject ### Examples ### Related Links Enable-HPOVDebug **
Top
Disable-HPOVDeviceUid

Disable UID of a device.
SYNTAX
Disable-HPOVDeviceUid [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will disable the UID of a managed or monitored resource, and only supports objects. Use Get-HPOVServer or Get-
HPOVEnclosure to retrieve the required resource(s), which can be passed via the pipeline.
Parameters
Aliases Appliance
Required? true
Position? named
Resource object to turn off the UID. Supported resources are Server Hardware and Enclosures.
Aliases Server, Enclosure, Frame, Resource
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.ServerHardware [System.Management.Automation.PSCustomObject] or HPOneView.Enclosure
[System.Management.Automation.PSCustomObject]
Server Hardware or Enclosure resource.
Return Values
If successful, returns Appliance Async Task object to monitor.
Collection of Appliance Async Task objects to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "MyEncl, Bay 1" | Disable-HPOVDeviceUid | Wait-HPOVTaskComplete
Disable the UID for "MyEncl, Bay 1" server. ### Related Links * [Enable-HPOVDeviceUid]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVDeviceUid) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVDeviceUid
Disable UID of a device. ### SYNTAX

Disable-HPOVDeviceUid [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will disable the UID of a managed or monitored resource, and only supports objects. Use Get-HPOVServer or Get-
Parameters
Aliases Appliance
Required? true
Position? named
Resource object to turn off the UID. Supported resources are Server Hardware and Enclosures.
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values

Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer 'MyEncl, Bay 1' | Disable-HPOVDeviceUid | Wait-HPOVTaskComplete
Disable the UID for 'MyEncl, Bay 1' server.
Related Links
Enable-HPOVDeviceUid
Top
Disable-HPOVLdapLocalLogin

Disable local authentication logins.
SYNTAX
Disable-HPOVLdapLocalLogin [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchPara
Use this cmdlet to set disable appliance local logins. An existing authentication directory must be configured in order to use this
CMDLET.
Parameters
Aliases Appliance
Required? true
Position? 0

Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Appliance Authentication Directory setting.
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable local logins on the appliance. ### Related Links * [Enable-HPOVLdapLocalLogin]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVLdapLocalLogin) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVLdapLocalLogin
Disable local authentication logins. ### SYNTAX
Disable-HPOVLdapLocalLogin [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchPara

Use this cmdlet to set disable appliance local logins. An existing authentication directory must be configured in order to use this
CMDLET.
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable local logins on the appliance.
Related Links
Enable-HPOVLdapLocalLogin
Top
Disable-HPOVLogicalInterconnectPortMonitoring

Disable port monitoring for a logical interconnect.
SYNTAX
Disable-HPOVLogicalInterconnectPortMonitoring [-InputObject] <Object>[ [-ApplianceConnection] <Array>] [<CommonP
arameters>]
Port monitoring enables you to send a copy of every Ethernet or Fibre Channel frame coming in and going out of a downlink
(server-facing) port to another port. To evaluate network traffic between ports, you can connect debugging equipment, such as
a network analyzer. This capability is important in a server environment where there is limited physical access to the network
interfaces on the servers.
NOTE:
* You cannot use Virtual Connect to forward captured traffic to a server. For more information, see the HPE Vi
rtual Connect for c-Class BladeSystem User Guide in the Hewlett Packard Enterprise Information Library.
* You can configure one network analyzer port (the uplink port) for up to 16 downlink server ports within a lo
gical interconnect.
* The HPE Virtual Connect 16Gb 24-Port Fibre Channel Module monitors 1 downlink server port.
* HPE Virtual Connect 16Gb 24-Port Fibre Channel Module firmware must be 4.00 or later
Required Privileges: Network administrator
Parameters

Aliases Appliance
Required? False
Position? named
The HPOneView.Networking.LogicalInterconnect resource from Get-HPOVLogicalInterconnect.
Aliases uri, li, name, Resource
Required? True
Position? named
Default value
<CommonParameters>
Input Types
HPoneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]
Logical Interconnect resource object from Get-HPOVLogicalInterconnect
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnect -Name "Encl1" -ErrorAction Stop | Disable-HPOVLogicalInterconnectPortMonitoring
Disable port monitoring for the specified logical interconnect resource. ### Related Links * [Enable-
HPOVLogicalInterconnectPortMonitoring](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-
HPOVLogicalInterconnectPortMonitoring) * [Get-HPOVLogicalInterconnectPortMonitoring]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalInterconnectPortMonitoring) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVLogicalInterconnectPortMonitoring
Disable port monitoring for a logical interconnect. ### SYNTAX
Disable-HPOVLogicalInterconnectPortMonitoring [-InputObject] <Object>[ [-ApplianceConnection] <Array>] [<CommonP

arameters>]
NOTE:
gical interconnect.
Parameters
Aliases Appliance
Required? False
Position? named
The HPOneView.Networking.LogicalInterconnect resource from Get-HPOVLogicalInterconnect.
Required? True
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnect -Name "Encl1" -ErrorAction Stop | Disable-HPOVLogicalInterconnectPortMonitoring
Disable port monitoring for the specified logical interconnect resource.
Related Links
Enable-HPOVLogicalInterconnectPortMonitoring
Get-HPOVLogicalInterconnectPortMonitoring
Top
Disable-HPOVMSDSC

Disable-HPOVMSDSC
Disable Microsoft DSC Support
SYNTAX
Disable-HPOVMSDSC [<CommonParameters>]
Using this cmdlet will create and/or modify UseMSDSC (REG_DWORD) located at HKCU:\Software\Hewlett-Packard\HPOneView,
to 0 (False). By disabling support, the module will no longer overload Write-Host.
Use Enable-HPOVMsDSC to enable support.
Parameters
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable-HPOVMSDSC
Configures Registry value to no longer overload Write-Host. ### Related Links * [Enable-HPOVMSDSC]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVMSDSC) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVMSDSC
Disable Microsoft DSC Support ### SYNTAX
Disable-HPOVMSDSC [<CommonParameters>]
to 0 (False). By disabling support, the module will no longer overload Write-Host.
Use Enable-HPOVMsDSC to enable support.
Parameters
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable-HPOVMSDSC
Configures Registry value to no longer overload Write-Host.
Related Links
Enable-HPOVMSDSC
Top
Disable-HPOVRemoteSupport

Disable Remote Support for a supported resource.
SYNTAX
Disable-HPOVRemoteSupport [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [
<CommonParameters>]
This Cmdlet will disable Remote Support for a compute or enclosure resource. If Remote Support has been disabled globally on
the appliance, this Cmdlet is uncessary.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
The compute or enclosure resource to enable Remote Support for.
Aliases None
Required? true
Position? named
Default value

<CommonParameters>
Input Types
HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]
A Gen8 or newer generation server hardware resource object from Get-HPOVServer.
HPOneView.Enclosure [System.Management.Automation.PSCustomObject]
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Disable-HPOVRemoteSupport
Get the servers with their name matching "Prod" and disable Remote Support for those resources.
-------------------------- EXAMPLE 2 --------------------------
$Enclosure = Get-HPOVEnclousre -Name Enclosure-1A

Disable-HPOVRemoteSupport -InputObject $Enclusre
Get the specific enclosure reousrce and disable Remote Support. ### Related Links * [Enable-HPOVRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVRemoteSupport) * [Get-HPOVRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupport) * [Get-HPOVRemoteSupportContact]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportContact) * [Get-
HPOVRemoteSupportDataCollectionSchedule](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVRemoteSupportDataCollectionSchedule) * [Get-HPOVRemoteSupportDefaultSite]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportDefaultSite) * [Get-
HPOVRemoteSupportEntitlementStatus](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVRemoteSupportEntitlementStatus) * [Get-HPOVRemoteSupportPartner](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVRemoteSupportPartner) * [Get-HPOVRemoteSupportSetting]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportSetting) * [New-
HPOVRemoteSupportContact](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVRemoteSupportContact) *
[New-HPOVRemoteSupportPartner](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVRemoteSupportPartner) * [Remove-HPOVRemoteSupportContact](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVRemoteSupportContact) * [Remove-HPOVRemoteSupportPartner]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRemoteSupportPartner) * [Set-HPOVRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRemoteSupport) * [Set-
HPOVRemoteSupportDataCollectionSchedule](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVRemoteSupportDataCollectionSchedule) * [Set-HPOVRemoteSupportDefaultSite]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRemoteSupportDefaultSite) * [Set-
HPOVRemoteSupportSetting](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRemoteSupportSetting) *
[Start-HPOVRemoteSupportCollection](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Start-
HPOVRemoteSupportCollection) * [Update-HPOVRemoteSupportEntitlement](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Update-HPOVRemoteSupportEntitlement) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVRemoteSupport
Disable Remote Support for a supported resource. ### SYNTAX
Disable-HPOVRemoteSupport [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [

<CommonParameters>]
This Cmdlet will disable Remote Support for a compute or enclosure resource. If Remote Support has been disabled globally on
the appliance, this Cmdlet is uncessary.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Disable-HPOVRemoteSupport
Get the servers with their name matching 'Prod' and disable Remote Support for those resources.
-------------------------- EXAMPLE 2 --------------------------

Disable-HPOVRemoteSupport -InputObject $Enclusre
Get the specific enclosure reousrce and disable Remote Support.
Related Links
Enable-HPOVRemoteSupport
Get-HPOVRemoteSupport
Get-HPOVRemoteSupportContact
Get-HPOVRemoteSupportDataCollectionSchedule
Get-HPOVRemoteSupportDefaultSite
Get-HPOVRemoteSupportEntitlementStatus
Get-HPOVRemoteSupportPartner
Get-HPOVRemoteSupportSetting
New-HPOVRemoteSupportContact
New-HPOVRemoteSupportPartner
Remove-HPOVRemoteSupportContact
Remove-HPOVRemoteSupportPartner
Set-HPOVRemoteSupport
Set-HPOVRemoteSupportDataCollectionSchedule
Set-HPOVRemoteSupportDefaultSite
Set-HPOVRemoteSupportSetting
Start-HPOVRemoteSupportCollection
Update-HPOVRemoteSupportEntitlement
Top
Disable-HPOVRemoteSyslog

Disable remote syslog.
SYNTAX
Disable-HPOVRemoteSyslog[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
The remoteSyslog API provides the ability to configure remote logging on devices managed by OneView. This Cmdlet handles
disabling the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance
will deploy the SysLog settings to managed resources automatically.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value false
<CommonParameters>
Input Types
None. You cannot pipe objects to this Cmdlet.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable remote syslog configuration on all connected appliances.

-------------------------- EXAMPLE 2 --------------------------
Disable-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com -Async | Wait-HPOVTaskComplete
Disable remote syslog configuration on the specific connected appliance. ### Related Links * [Enable-HPOVRemoteSyslog]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVRemoteSyslog) * [Get-HPOVRemoteSyslog]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSyslog) * [Set-HPOVRemoteSyslog]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRemoteSyslog) ***
Top
### HPE OneView 4.00 Library ## Disable-HPOVRemoteSyslog
Disable remote syslog. ### SYNTAX
Disable-HPOVRemoteSyslog[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
disabling the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value false
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Disable remote syslog configuration on all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
Disable-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com -Async | Wait-HPOVTaskComplete
Disable remote syslog configuration on the specific connected appliance.

Related Links
Enable-HPOVRemoteSyslog
Get-HPOVRemoteSyslog
Set-HPOVRemoteSyslog
Top
Disconnect-HPOVMgmt

Disconnect-HPOVMgmt
Disconnect from the appliance.
SYNTAX
Disconnect-HPOVMgmt[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet disconnects the specified or all HPE OneView appliance session(s).
Parameters
Aliases Appliance, ApplianceSession, Hostname
Required? False
Position? 0
Default value $ConnectedSessions | Where-Object Default
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Connection1 = Connect-HPOVMgmt MyAppliance.domain.com

Disconnect-HPOVMgmt -Hostname $Connection1
Disconnect from the specific appliance session.

-------------------------- EXAMPLE 2 --------------------------
Disconnect-HPOVMgmt -Hostname 1
Disconnect ConnectionID 1 appliance session.

-------------------------- EXAMPLE 3 --------------------------
$ConnectedSessions | Disconnect-HPOVMgmt
Disconnect all appliance sessions. ### Related Links * [Connect-HPOVMgmt](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Connect-HPOVMgmt) ***
Top
### HPE OneView 4.00 Library ## Disconnect-HPOVMgmt
Disconnect from the appliance. ### SYNTAX
Disconnect-HPOVMgmt[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet disconnects the specified or all HPE OneView appliance session(s).
Parameters
Aliases Appliance, ApplianceSession, Hostname
Required? False
Position? 0
Default value $ConnectedSessions | Where-Object Default
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Connection1 = Connect-HPOVMgmt MyAppliance.domain.com

Disconnect-HPOVMgmt -Hostname $Connection1
Disconnect from the specific appliance session.
-------------------------- EXAMPLE 2 --------------------------
Disconnect-HPOVMgmt -Hostname 1
Disconnect ConnectionID 1 appliance session.
-------------------------- EXAMPLE 3 --------------------------
$ConnectedSessions | Disconnect-HPOVMgmt
Disconnect all appliance sessions.
Related Links
Connect-HPOVMgmt
Top

Enable appliance complex password policy.
SYNTAX
Enable-HPOVApplianceComplexPasswords[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Enables whether users are required to have complex passwords. This option does not force existing users to change their
creating or modifying internal user account passwords. Use this Cmdlet to enable the policy.
Complex passwords must contain the following:
* Minimum of 14 characters
* Minimum of one uppercase character
* Minimum of one lowercase character
* Minimum one number
* Minimum of one special character. For example: !@#$^*_-=+,.?
* No whitespace
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable appliance complex password policy. ### Related Links * [Disable-HPOVApplianceComplexPasswords]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVApplianceComplexPasswords) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVApplianceComplexPasswords
Enable appliance complex password policy. ### SYNTAX

Enable-HPOVApplianceComplexPasswords[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Enables whether users are required to have complex passwords. This option does not force existing users to change their
creating or modifying internal user account passwords. Use this Cmdlet to enable the policy.
Complex passwords must contain the following:
* Minimum of 14 characters
* Minimum of one uppercase character
* Minimum of one lowercase character
* Minimum one number
* Minimum of one special character. For example: !@#$^*_-=+,.?
* No whitespace
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable appliance complex password policy.
Related Links
Top

Enable appliance service console access.
SYNTAX
Enable-HPOVApplianceServiceConsoleAccess[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Use this Cmdlet to enable service console access.
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable appliance service console access. ### Related Links * [Disable-HPOVApplianceServiceConsoleAccess]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVApplianceServiceConsoleAccess) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVApplianceServiceConsoleAccess
Enable appliance service console access. ### SYNTAX
Enable-HPOVApplianceServiceConsoleAccess[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Use this Cmdlet to enable service console access.
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable appliance service console access.
Related Links
Top

Enable appliance SSH access.
SYNTAX
Enable-HPOVApplianceSshAccess[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Use this Cmdlet to enable appliance SSH access.
Parameters

Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable appliance SSH access. ### Related Links * [Disable-HPOVApplianceSshAccess]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVApplianceSshAccess) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVApplianceSshAccess
Enable appliance SSH access. ### SYNTAX
Enable-HPOVApplianceSshAccess[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Use this Cmdlet to enable appliance SSH access.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable appliance SSH access.

Related Links
Top

Enable appliance TLS/SSL certificate validation.
SYNTAX
Enable-HPOVCertificateValidation[ [-CheckForSelfSignedExpiry] <Bool>][ [-ApplianceConnection] <Array>][ [-WhatIf
] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
added certificates are either a device"s self-signed certificate or the leaf certificate for a certificate authority (CA) signed

management.
Parameters
Aliases Appliance
Required? False
Position? named
-CheckForSelfSignedExpiry <Bool>
Enable ($true) or Disable ($false) the option to check for expiration of self-signed certificates if you want to perform expiration
checks for self-signed certificates. By default, self-signed certiifcate expiry is not enabled.
Aliases None
Required? false
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable certificate validation setting on the appliance. ### Related Links * [Disable-HPOVCertificateValidation]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVCertificateValidation) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVCertificateValidation
Enable appliance TLS/SSL certificate validation. ### SYNTAX
Enable-HPOVCertificateValidation[ [-CheckForSelfSignedExpiry] <Bool>][ [-ApplianceConnection] <Array>][ [-WhatIf

added certificates are either a device's self-signed certificate or the leaf certificate for a certificate authority (CA) signed

management.
Parameters
Aliases Appliance
Required? False
Position? named
-CheckForSelfSignedExpiry <Bool>
Enable ($true) or Disable ($false) the option to check for expiration of self-signed certificates if you want to perform expiration
checks for self-signed certificates. By default, self-signed certiifcate expiry is not enabled.
Aliases None
Required? false
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable certificate validation setting on the appliance.
Related Links
Top
Enable-HPOVComposerHANode

Promote Standby Composer node to Active.
SYNTAX
Enable-HPOVComposerHANode [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParamet
er>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will help transition the Standby Composer node to the Active Role. Use this Cmdlet in order to perform maintenance
on the Active node, or to remove the Active node from the Synergy management ring.
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The Async task resource of the role transition request
Multiple Async task resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Transition the Standby Composer node in the default Appliance Connection.

-------------------------- EXAMPLE 2 --------------------------
Transition the Standby Composer node in the specific Appliance Connection. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVComposerHANode
Promote Standby Composer node to Active. ### SYNTAX
Enable-HPOVComposerHANode [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParamet

This Cmdlet will help transition the Standby Composer node to the Active Role. Use this Cmdlet in order to perform maintenance
on the Active node, or to remove the Active node from the Synergy management ring.
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The Async task resource of the role transition request

Examples
-------------------------- EXAMPLE 1 --------------------------
Transition the Standby Composer node in the default Appliance Connection.
-------------------------- EXAMPLE 2 --------------------------
Transition the Standby Composer node in the specific Appliance Connection.
Related Links
Top
Enable-HPOVDebug

Enable-HPOVDebug
Enable specific appliance-level component debug logging.
SYNTAX
Enable-HPOVDebug [-Scope] <String> [-LoggerName] <String> [-Level] <String> [-ApplianceConnection] <Object> [<Co
mmonParameters>]
FOR HP SUPPORT USE ONLY. This cmdlet will enable appliance level component debug logging for during issue triage. Do not
use this cmdlet unless otherwise instructed by HP Support.
Parameters
Aliases Appliance
Required? true
Position? named
-Level <String>
The verbose level to enable. Allowed values are:
* ERROR
* WARN
* DEBUG
* TRACE
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-Scope <String>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPE OneView Appliance Connection object.
Return Values
Examples
Related Links
Disable-HPOVDebug
Top
### HPE OneView 4.00 Library ## Enable-HPOVDebug
Enable specific appliance-level component debug logging. ### SYNTAX
Enable-HPOVDebug [-Scope] <String> [-LoggerName] <String> [-Level] <String> [-ApplianceConnection] <Object> [<Co
mmonParameters>]
FOR HP SUPPORT USE ONLY. This cmdlet will enable appliance level component debug logging for during issue triage. Do not
use this cmdlet unless otherwise instructed by HP Support. ### Parameters -ApplianceConnection <Object>
Aliases [-Appliance] Specify one HPOneView.Appliance.Connection object or Name property value. Default Value:
${Global:ConnectedSessions} | ? Default
Aliases Appliance
Required? true
Position? named
-Level <String>
The verbose level to enable. Allowed values are: ERROR WARN DEBUG TRACE
Aliases None
Required? true
Position? named
Default value

Aliases None
Required? true
Position? named
Default value
-Scope <String>
Aliases None
Required? true
Position? named
Default value
### Input Types HPOneView.Appliance.Connection HPE OneView Appliance Connection object. ### Return Values
System.Management.Automation.PSCustomObject ### Examples ### Related Links Disable-HPOVDebug **
Top

Enable UID of a device.
SYNTAX
Enable-HPOVDeviceUid [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will enable the UID of a managed or monitored resource, and only supports objects. Use Get-HPOVServer or Get-
Parameters
Aliases Appliance
Required? true
Position? named
Aliases [-Server, -Enclosure, -Frame] Resource object to turn on the UID. Supported resources are Server Hardware and
Enclosures.
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "MyEncl, Bay 1" | Enable-HPOVDeviceUid | Wait-HPOVTaskComplete
Enable the UID for "MyEncl, Bay 1" server. ### Related Links * [Disable-HPOVDeviceUid]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVDeviceUid) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVDeviceUid
Enable UID of a device. ### SYNTAX
Enable-HPOVDeviceUid [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will enable the UID of a managed or monitored resource, and only supports objects. Use Get-HPOVServer or Get-
Parameters
Aliases Appliance
Required? true
Position? named
Aliases [-Server, -Enclosure, -Frame] Resource object to turn on the UID. Supported resources are Server Hardware and
Enclosures.
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer 'MyEncl, Bay 1' | Enable-HPOVDeviceUid | Wait-HPOVTaskComplete
Enable the UID for 'MyEncl, Bay 1' server.
Related Links
Top

Enable local authentication logins.
SYNTAX
Enable-HPOVLdapLocalLogin [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParam
eter>] [<CommonParameters>]
Use this cmdlet to set enable appliance local logins. An existing authentication directory must be configured in order to use this
CMDLET.
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable local logins on the appliance. ### Related Links * [Disable-HPOVLdapLocalLogin]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVLdapLocalLogin) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVLdapLocalLogin
Enable local authentication logins. ### SYNTAX
Enable-HPOVLdapLocalLogin [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParam

Use this cmdlet to set enable appliance local logins. An existing authentication directory must be configured in order to use this
CMDLET.
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable local logins on the appliance.
Related Links
Top

Enable port monitoring for a logical interconnect.
SYNTAX
Enable-HPOVLogicalInterconnectPortMonitoring [-InputObject] <Object> [-AnalyzerPort] <Object> [-MonitoredPorts]
<Hashtable>[ [-ApplianceConnection] <Array>] [<CommonParameters>]
NOTE:
gical interconnect.
Parameters
-AnalyzerPort <Object>
Specifies the network analyzer port (the mirrored-to uplink port) for the downlink server ports within a single enclosure. There is
a single ï¿½mirrored-to portï¿½ per logical interconnect.
Allowed string value: "Bay1:X6" or "Enclosure1:Bay6:Q1.1"
Aliases None
Required? true
Position? named
Default value
Aliases Appliance
Required? False
Position? named
HPOneView.Networking.LogicalInterconnect from Get-HPOVLogicalInterconnect.
Required? true
Position? named
Default value
-MonitoredPorts <Hashtable>
An Array of Hashtable or PSCustomObject with the following format:
@{Port = "Bay1:D2"; Direction = "toserver"}
The "Port" property format must be "BayID:ServerDownlinkPortID". For HPE Synergy, the "Port" property must be
"EnclosureID:BayID:ServerDownlinkPortID".
The "Direction" property value must be one of the following:
* ToServer
* FromServer
* Both
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnect -Name "Encl1-Default VC FF LIG" | Enable-HPOVLogicalInterconnectPortMonitoring -Anal

yzerPort "Bay1:Q1.1" -MonitoredPorts @{Port = "Bay1:d2"; Direction = "toserver"}, @{Port = "Bay1:D3"; Direction
= "MonitoredFromServer"}, @{Port = "Bay2:D7"; Direction = "Both"}
Enable port monitoring for the specific logical interconnect.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnect -Name "LE1-Default VC LIG" | Enable-HPOVLogicalInterconnectPortMonitoring -AnalyzerP

ort "Enclosure1:Bay3:Q1.1" -MonitoredPorts @{Port = "Enclosure1:Bay3:d1"; Direction = "Both"}, @{Port = "Enclosu
re1:Bay6:d1"; Direction = "Both"}
Enable port monitoring for the specific logical interconnect. ### Related Links * [Disable-
HPOVLogicalInterconnectPortMonitoring](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVLogicalInterconnectPortMonitoring) * [Get-HPOVLogicalInterconnectPortMonitoring]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalInterconnectPortMonitoring) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVLogicalInterconnectPortMonitoring
Enable port monitoring for a logical interconnect. ### SYNTAX
Enable-HPOVLogicalInterconnectPortMonitoring [-InputObject] <Object> [-AnalyzerPort] <Object> [-MonitoredPorts]

<Hashtable>[ [-ApplianceConnection] <Array>] [<CommonParameters>]
NOTE:
gical interconnect.
Parameters
-AnalyzerPort <Object>
Specifies the network analyzer port (the mirrored-to uplink port) for the downlink server ports within a single enclosure. There is
a single “mirrored-to port” per logical interconnect.
Allowed string value: "Bay1:X6" or "Enclosure1:Bay6:Q1.1"
Aliases None
Required? true
Position? named
Default value
Aliases Appliance
Required? False
Position? named
Required? true
Position? named
Default value
-MonitoredPorts <Hashtable>
An Array of Hashtable or PSCustomObject with the following format:
@{Port = "Bay1:D2"; Direction = "toserver"}
The "Port" property format must be "BayID:ServerDownlinkPortID". For HPE Synergy, the "Port" property must be
"EnclosureID:BayID:ServerDownlinkPortID".
The "Direction" property value must be one of the following:
* ToServer
* FromServer
* Both
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnect -Name "Encl1-Default VC FF LIG" | Enable-HPOVLogicalInterconnectPortMonitoring -Anal

yzerPort 'Bay1:Q1.1' -MonitoredPorts @{Port = "Bay1:d2"; Direction = "toserver"}, @{Port = "Bay1:D3"; Direction
= "MonitoredFromServer"}, @{Port = "Bay2:D7"; Direction = "Both"}
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnect -Name "LE1-Default VC LIG" | Enable-HPOVLogicalInterconnectPortMonitoring -AnalyzerP

ort 'Enclosure1:Bay3:Q1.1' -MonitoredPorts @{Port = "Enclosure1:Bay3:d1"; Direction = "Both"}, @{Port = "Enclosu
re1:Bay6:d1"; Direction = "Both"}
Related Links
Top
Enable-HPOVMSDSC

Enable-HPOVMSDSC
Enable Microsoft DSC Support
SYNTAX
Enable-HPOVMSDSC [<CommonParameters>]
to 1 (True). By enabling support, the module will overload Write-Host, and instead issue Write-Verbose commands.
Use Disable-HPOVMsDSC to disable support.
Parameters
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable-HPOVMSDSC
Configures Registry value to overload Write-Host, which then uses Write-Verbose. ### Related Links * [Disable-HPOVMSDSC]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVMSDSC) ***
Top
### HPE OneView 4.00 Library ## Enable-HPOVMSDSC
Enable Microsoft DSC Support ### SYNTAX
Enable-HPOVMSDSC [<CommonParameters>]
to 1 (True). By enabling support, the module will overload Write-Host, and instead issue Write-Verbose commands.
Use Disable-HPOVMsDSC to disable support.
Parameters
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable-HPOVMSDSC
Configures Registry value to overload Write-Host, which then uses Write-Verbose.
Related Links
Disable-HPOVMSDSC
Top

Enable Remote Support for a supported resource.
SYNTAX
Enable-HPOVRemoteSupport [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<
CommonParameters>]
This Cmdlet will enable Remote Support for a compute or enclosure resource. If remote support has not been globally enabled
and configured on the appliance, this Cmdlet will fail.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types

Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Enable-HPOVRemoteSupport
Get the servers with their name matching "Prod" and enable Remote Support for those resources.
-------------------------- EXAMPLE 2 --------------------------

Enable-HPOVRemoteSupport -InputObject $Enclusre
Get the specific enclosure reousrce and enable Remote Support. ### Related Links * [Disable-HPOVRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVRemoteSupport) * [Get-HPOVRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupport) * [Get-HPOVRemoteSupportContact]
Top
### HPE OneView 4.00 Library ## Enable-HPOVRemoteSupport
Enable Remote Support for a supported resource. ### SYNTAX
Enable-HPOVRemoteSupport [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<

CommonParameters>]
This Cmdlet will enable Remote Support for a compute or enclosure resource. If remote support has not been globally enabled
and configured on the appliance, this Cmdlet will fail.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values

Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Enable-HPOVRemoteSupport
Get the servers with their name matching 'Prod' and enable Remote Support for those resources.
-------------------------- EXAMPLE 2 --------------------------

Enable-HPOVRemoteSupport -InputObject $Enclusre
Get the specific enclosure reousrce and enable Remote Support.
Related Links
Top

Enable remote syslog.
SYNTAX
Enable-HPOVRemoteSyslog[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
enabling the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value false
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable remote syslog configuration on all connected appliances.

-------------------------- EXAMPLE 2 --------------------------
Enable-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com -Async | Wait-HPOVTaskComplete
Enable remote syslog configuration on the specific connected appliance. ### Related Links * [Disable-HPOVRemoteSyslog]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVRemoteSyslog) * [Get-HPOVRemoteSyslog]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSyslog) * [Set-HPOVRemoteSyslog]
Top
### HPE OneView 4.00 Library ## Enable-HPOVRemoteSyslog
Enable remote syslog. ### SYNTAX
Enable-HPOVRemoteSyslog[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
enabling the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value false
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Enable remote syslog configuration on all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
Enable-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com -Async | Wait-HPOVTaskComplete
Enable remote syslog configuration on the specific connected appliance.
Related Links
Top
Get-HPOVAddressPool

Get-HPOVAddressPool
Retrieve Address Pool information.
SYNTAX
Get-HPOVAddressPool [-Type] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will get the avilable and configured Address Pools, and their associated Ranges from the appliance. Currently, the
appliance supports the following Address Pools:
* VMAC
* VWWN
* VSN
* IPv4
You can specify one, some or all of the Pool types. A Range switch is provided to include the associated Range objects. A
report switch is provided to display a report of each Address Pool type.
Parameters
Aliases Appliance
Required? true
Position? named
-Type <Array>
The Address Pool type. Accepted values are VMAC, VWWN, VSN, IPv4, or All.
Aliases None
Required? true
Position? named
Default value all
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AddressPool [System.Management.Automation.PSCustomObject]
Single Address Pool and its contents.
System.Collections.ArrayList <HPOneView.Appliance.AddressPool>
Collection of Address Pools and their contents.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAddressPool
Get the address pools.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPool -type vmac
Get the vmac address pool. ### Related Links * [Get-HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Get-HPOVAddressPoolRange) * [Get-HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVAddressPoolSubnet) * [New-HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVAddressPoolRange) * [New-HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVAddressPoolSubnet) * [Remove-HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVAddressPoolRange) * [Remove-HPOVAddressPoolSubnet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVAddressPoolSubnet) * [Set-HPOVAddressPoolSubnet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVAddressPoolSubnet) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAddressPool
Retrieve Address Pool information. ### SYNTAX
Get-HPOVAddressPool [-Type] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will get the avilable and configured Address Pools, and their associated Ranges from the appliance. Currently, the
appliance supports the following Address Pools:
* VMAC
* VWWN
* VSN
* IPv4
You can specify one, some or all of the Pool types. A Range switch is provided to include the associated Range objects. A
report switch is provided to display a report of each Address Pool type.
Parameters
Aliases Appliance
Required? true
Position? named
-Type <Array>
The Address Pool type. Accepted values are VMAC, VWWN, VSN, IPv4, or All.
Aliases None
Required? true
Position? named
Default value all
<CommonParameters>
Input Types
Return Values
Single Address Pool and its contents.
System.Collections.ArrayList <HPOneView.Appliance.AddressPool>
Collection of Address Pools and their contents.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAddressPool
Get the address pools.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPool -type vmac
Get the vmac address pool.
Related Links
Get-HPOVAddressPoolRange
Get-HPOVAddressPoolSubnet
New-HPOVAddressPoolRange
New-HPOVAddressPoolSubnet
Remove-HPOVAddressPoolRange
Remove-HPOVAddressPoolSubnet
Set-HPOVAddressPoolSubnet
Top

Retrieve Address Pool Range information.
SYNTAX
Get-HPOVAddressPoolRange [-Type] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVAddressPoolRange [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
THis Cmdlet will display configured Address Pool Ranges defined on an HPE OneView appliance.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases [-Pool]
Specify the type of Address Range Pool, or the Address Pool object fro Get-HPOVAddressPool. Allowed values are:
* IPv4
* VMAC
* VWWN
* VSN
* All
Default: All
Aliases None
Required? true
Position? named
Default value all
-Type <Object>
Aliases [-Pool]
* IPv4
* VMAC
* VWWN
* VSN
* All
Default: All
Aliases Pool
Required? true
Position? named
Default value all
<CommonParameters>
Input Types
Address Pool resource object.
Return Values
HPOneView.Appliance.AddressPoolRange [System.Management.Automation.PSCustomObject]
Single Address Pool Range object.
System.Collections.ArrayList <HPOneView.Appliance.AddressPoolRange>
Collection of Address Pool Range(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
[PS] C:\> Get-HPOVAddressPoolRange

Name Enabled Category Total Allocated Available Reserved Start End
---- ------- -------- ----- --------- --------- -------- ----- ---
VMAC True Generated 1048576 2 1048574 0 62:79:84:50:00:00 62:79:84:5F:FF:FF
VWWN True Generated 1048576 0 1048576 0 10:00:92:5a:1f:b0:00:00 10:00:92:5a:1f:bf:ff:ff
VSN True Generated 46656 1 46655 0 VCGBWAB000 VCGBWABZZZ
VMAC True Generated 1048576 0 1048576 0 F6:38:E6:90:00:00 F6:38:E6:9F:FF:FF
VWWN True Generated 1048576 0 1048576 0 10:00:ce:58:fa:50:00:00 10:00:ce:58:fa:5f:ff:ff
VSN True Generated 46656 0 46656 0 VCGA290000 VCGA290ZZZ
Get all configured Address Pool Ranges from all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
[PS] C:\> Get-HPOVAddressPoolRange vmac

---- ------- -------- ----- --------- --------- -------- ----- ---
Get a specific Address Pool Range type (VMAC) from all connected appliances. ### Related Links * [New-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVAddressPoolRange) * [Remove-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVAddressPoolRange) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAddressPoolRange
Retrieve Address Pool Range information. ### SYNTAX
Get-HPOVAddressPoolRange [-Type] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVAddressPoolRange [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
THis Cmdlet will display configured Address Pool Ranges defined on an HPE OneView appliance.
Parameters

Aliases Appliance
Required? false
Position? named
Aliases [-Pool]
* IPv4
* VMAC
* VWWN
* VSN
* All
Default: All
Aliases None
Required? true
Position? named
Default value all
-Type <Object>
Aliases [-Pool]
* IPv4
* VMAC
* VWWN
* VSN
* All
Default: All
Aliases Pool
Required? true
Position? named
Default value all
<CommonParameters>
Input Types
Address Pool resource object.
Return Values
Single Address Pool Range object.
System.Collections.ArrayList <HPOneView.Appliance.AddressPoolRange>
Collection of Address Pool Range(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
[PS] C:> Get-HPOVAddressPoolRange


VWWN True Generated 1048576 0 1048576 0 10:00:92:5a:1f:b0:00:00 10:00:92:5a:1f:bf:ff:ff
VSN True Generated 46656 1 46655 0 VCGBWAB000 VCGBWABZZZ
VWWN True Generated 1048576 0 1048576 0 10:00:ce:58:fa:50:00:00 10:00:ce:58:fa:5f:ff:ff
VSN True Generated 46656 0 46656 0 VCGA290000 VCGA290ZZZ
Get all configured Address Pool Ranges from all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
[PS] C:> Get-HPOVAddressPoolRange vmac


Get a specific Address Pool Range type (VMAC) from all connected appliances.
Related Links
Top

Retrieve Address Subnet Pool information.
SYNTAX
Get-HPOVAddressPoolSubnet [-NetworkId] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Using this Cmdlet will display the configured IPv4 Subnet Address Pool(s) configured on an HPE OneView appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-NetworkId <String>
Specify the Network ID of the subnet in order to filter the results.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
None. This Cmdlet does not support pipeline operations.
Return Values
HPOneView.Appliance.IPv4AddressSubnet [System.Management.Automation.PSCustomObject]
Single IPv4 Subnet Address Pool Range.
System.Collections.ArrayList <HPOneView.Appliance.IPv4AddressSubnet>
Collection of IPv4 Subnet Address Pool Range(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Network ID Subnet Mask Gateway DNS Server Domain Name Ra
nges
--------- ---------- ----------- ------- ---------- ----------- --
----
hpov-tot1.domain.com 172.20.0.0 255.255.0.0 172.20.0.1 {10.250.33.12, 10.250.34.80} domain.com Pr
od1
hpov-tot1.domain.com 192.168.20.0 255.255.255.0 192.168.20.254 {10.250.33.12, 10.250.34.80} vlan20.domain.lab VL
AN20Prod
hpov-tot1.domain.com 192.168.10.0 255.255.255.0 192.168.10.254 {10.250.33.12, 10.250.34.80} domain.lab VL
AN10 Prod
Get the configured IPv4 Address Pools from all appliances.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPoolSubnet -NetworkId 192.168.20.0

nges
--------- ---------- ----------- ------- ---------- ----------- --
----
AN20Prod
Get the specified IPv4 Address Pool from all appliances. ### Related Links * [New-HPOVAddressPoolSubnet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVAddressPoolSubnet) * [Remove-
HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVAddressPoolSubnet) * [Set-
HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVAddressPoolSubnet) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAddressPoolSubnet
Retrieve Address Subnet Pool information. ### SYNTAX
Get-HPOVAddressPoolSubnet [-NetworkId] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Using this Cmdlet will display the configured IPv4 Subnet Address Pool(s) configured on an HPE OneView appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-NetworkId <String>
Specify the Network ID of the subnet in order to filter the results.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
None. This Cmdlet does not support pipeline operations.
Return Values
Single IPv4 Subnet Address Pool Range.
System.Collections.ArrayList <HPOneView.Appliance.IPv4AddressSubnet>
Collection of IPv4 Subnet Address Pool Range(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
nges
hpov-tot1.domain.com 172.20.0.0 255.255.0.0 172.20.0.1 {10.250.33.12, 10.250.34.80} domain.com Pr

od1
AN20Prod
hpov-tot1.domain.com 192.168.10.0 255.255.255.0 192.168.10.254 {10.250.33.12, 10.250.34.80} domain.lab VL
AN10 Prod
Get the configured IPv4 Address Pools from all appliances.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPoolSubnet -NetworkId 192.168.20.0

nges

AN20Prod
Get the specified IPv4 Address Pool from all appliances.
Related Links
Top
Get-HPOVAlert

Get-HPOVAlert
List alerts logged.
SYNTAX
Get-HPOVAlert[ [-InputObject] <Object>][ [-Severity] <String>][ [-HealthCategory] <String>][ [-AssignedToUser] <
String>][ [-AlertState] <String>][ [-Count] <String>][ [-TimeSpan] <Timespan>][ [-Start] <DateTime>][ [-End] <Da
teTime>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain all the alerts for the specified resource and/or with the specified severity.
Parameters
-AlertState <String>
Alerts with given alert state will be returned. State values include Active and Cleared
Aliases State
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-AssignedToUser <String>
Alerts assigned to the given user will be returned.
Aliases None
Required? false
Position? named
Default value
-Count <String>
Return only the number of alerts from the appliance. Can be combined with other parameters to return a pruned list of alerts.
Aliases None
Required? false
Position? named
Default value
-End <DateTime>
Return alerts that were created on the specified date. Hour, Min and Seconds will not be used, only Month, Day and Year of the
DateTime value.
Aliases None
Required? false
Position? named
Default value
-HealthCategory <String>
Alerts with given health category will be returned. Allowed health category values are:
* Appliance
* DeviceBay
* Enclosure
* Fan
* Firmware
* Host
* Instance
* InterconnectBay
* LogicalSwitch
* Logs
* ManagementProcessor
* Memory
* Network
* Operational
* Power
* Processor
* RemoteSupport
* Storage
* Thermal
* Unknown
Aliases None
Required? false
Position? named
Default value
Aliases [-resourceUri] Alerts for the specified resource will be returned.
Aliases resourceUri, Resource
Required? false
Position? named
Default value
-Severity <String>
Alerts with given severity will be returned. Allowed severity values are:
* Unknown
* Ok
* Disabled
* Warning
* Critical
Aliases None
Required? false
Position? named
Default value
-Start <DateTime>
Return alerts that were created starting from the specified date. Hour, Min and Seconds will not be used, only Month, Day and
Year of the DateTime value.
Aliases None
Required? false
Position? named
Default value
-TimeSpan <Timespan>
Return the number of alerts created from today to the defined number of days.
Aliases None
Required? false
Position? named
Default value

<CommonParameters>
Input Types
System.String
Resource URI.
Resource object (i.e. Get-HPOVServer).
Return Values
HPOneView.Alert [System.Management.Automation.PSCustomObject]
Singel HPE OneView Alert.
Collection of HPE OneView Alerts.
Examples
-------------------------- EXAMPLE 1 --------------------------
$alerts = Get-HPOVAlert -severity CRITICAL
Return all the critical alerts.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer "Encl1, Bay 2" | Get-HPOVAlert -severity CRITICAL
Return all the critical alerts for server "Encl1, Bay 2".
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServerProfile "Profile 1" | Get-HPOVAlert
Return all the alerts for server profile "Profile 1".

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVInterconnect "Encl1, interconnect 2" | Get-HPOVAlert
Get all alerts for "Encl1, interconnect 2" interconnect module.

-------------------------- EXAMPLE 5 --------------------------
Get-HPOVInterconnect "Encl1, interconnect 2" | Get-HPOVAlert -severity Critical
Get "critical" severity alerts for "Encl1, interconnect 2" interconnect module.
-------------------------- EXAMPLE 6 --------------------------
Get-HPOVAlert -severity Critical -Count 5
Return the first 5 "critical" severity alerts.

-------------------------- EXAMPLE 7 --------------------------
Get-HPOVAlert -severity Critical -Timespan (New-TimeSpan -Days 8)
Return "critical" severity alerts for the past 8 days.

-------------------------- EXAMPLE 8 --------------------------
Get-HPOVAlert -severity Critical -Start "2016-12-01"
Return "critical" severity alerts Starting at 2016-12-01 to now.

-------------------------- EXAMPLE 9 --------------------------
Get-HPOVAlert -Start "2016-12-01" -End "2016-12-09
Return all alerts Starting at 2016-12-01 to 2016-12-09. ### Related Links * [Clear-HPOVAlert]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Clear-HPOVAlert) * [Remove-HPOVAlert]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVAlert) * [Set-HPOVAlert]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVAlert) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAlert
List alerts logged. ### SYNTAX
Get-HPOVAlert[ [-InputObject] <Object>][ [-Severity] <String>][ [-HealthCategory] <String>][ [-AssignedToUser] <

String>][ [-AlertState] <String>][ [-Count] <String>][ [-TimeSpan] <Timespan>][ [-Start] <DateTime>][ [-End] <Da
teTime>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain all the alerts for the specified resource and/or with the specified severity.
Parameters
-AlertState <String>
Alerts with given alert state will be returned. State values include Active and Cleared
Aliases State
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-AssignedToUser <String>
Alerts assigned to the given user will be returned.
Aliases None
Required? false
Position? named
Default value
-Count <String>
Return only the number of alerts from the appliance. Can be combined with other parameters to return a pruned list of alerts.
Aliases None
Required? false
Position? named
Default value
-End <DateTime>
Return alerts that were created on the specified date. Hour, Min and Seconds will not be used, only Month, Day and Year of the
DateTime value.
Aliases None
Required? false
Position? named
Default value
-HealthCategory <String>
Alerts with given health category will be returned. Allowed health category values are:
* Appliance
* DeviceBay
* Enclosure
* Fan
* Firmware
* Host
* Instance
* InterconnectBay
* LogicalSwitch
* Logs
* ManagementProcessor
* Memory
* Network
* Operational
* Power
* Processor
* RemoteSupport
* Storage
* Thermal
* Unknown
Aliases None
Required? false
Position? named
Default value
Aliases [-resourceUri] Alerts for the specified resource will be returned.
Aliases resourceUri, Resource
Required? false
Position? named
Default value
-Severity <String>
Alerts with given severity will be returned. Allowed severity values are:
* Unknown
* Ok
* Disabled
* Warning
* Critical
Aliases None
Required? false
Position? named
Default value
-Start <DateTime>
Return alerts that were created starting from the specified date. Hour, Min and Seconds will not be used, only Month, Day and
Year of the DateTime value.
Aliases None
Required? false
Position? named
Default value
Return the number of alerts created from today to the defined number of days.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
System.String
Resource URI.
Resource object (i.e. Get-HPOVServer).
Return Values
Singel HPE OneView Alert.
Collection of HPE OneView Alerts.
Examples
-------------------------- EXAMPLE 1 --------------------------
$alerts = Get-HPOVAlert -severity CRITICAL
Return all the critical alerts.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer 'Encl1, Bay 2' | Get-HPOVAlert -severity CRITICAL
Return all the critical alerts for server 'Encl1, Bay 2'.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServerProfile 'Profile 1' | Get-HPOVAlert
Return all the alerts for server profile 'Profile 1'.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVInterconnect "Encl1, interconnect 2" | Get-HPOVAlert
Get all alerts for 'Encl1, interconnect 2' interconnect module.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVInterconnect "Encl1, interconnect 2" | Get-HPOVAlert -severity Critical
Get 'critical' severity alerts for 'Encl1, interconnect 2' interconnect module.
-------------------------- EXAMPLE 6 --------------------------
Get-HPOVAlert -severity Critical -Count 5
Return the first 5 'critical' severity alerts.
-------------------------- EXAMPLE 7 --------------------------
Get-HPOVAlert -severity Critical -Timespan (New-TimeSpan -Days 8)
Return 'critical' severity alerts for the past 8 days.
-------------------------- EXAMPLE 8 --------------------------
Get-HPOVAlert -severity Critical -Start '2016-12-01'
Return 'critical' severity alerts Starting at 2016-12-01 to now.

-------------------------- EXAMPLE 9 --------------------------
Get-HPOVAlert -Start '2016-12-01' -End '2016-12-09
Return all alerts Starting at 2016-12-01 to 2016-12-09.
Related Links
Clear-HPOVAlert
Remove-HPOVAlert
Set-HPOVAlert
Top
Get-HPOVApplianceAvailableSecurityMode

Get appliance available security modes.
SYNTAX
Get-HPOVApplianceAvailableSecurityMode[ [-ModeName] <String[]>][ [-ApplianceConnection] <Array>] [<CommonParamet
ers>]
Use this Cmdlet to get the appliances available security modes and the current mode. Security Modes adjust the allowed
security protocols (TLS) and their associated cyphers.
Parameters
Aliases Appliance
Required? False
Position? named
-ModeName <String[]>
The name of the mode to return. Allowed values:
* Legacy
* FIPS
* CNSA
Default: Return all available security modes.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.SecurityMode
The available appliance security mode, including which mode is set as the current value.
Examples
-------------------------- EXAMPLE 1 --------------------------
Return all available security modes on the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVApplianceAvailableSecurityMode -ModeName CNSA
Return the CNSA available security mode on the appliance.
Related Links
Top
Get-HPOVApplianceCertificateStatus

Get the appliance SSL certificate status.
SYNTAX
Get-HPOVApplianceCertificateStatus [-ApplianceConnection] <Object> [<CommonParameters>]
This CMDLET will retrieve the SSL Certificate details installed on the appliance. This does not check the validity of the SSL
certificate. Use the Get-HPOVApplianceCertificateStatus CMDLET to validate the certificate chain.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.ApplianceSslCertificateStatus [System.Management.Automation.PSCustomObject]
Formatted table display of the SSL Certificate object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Related Links
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceCertificateStatus
Get the appliance SSL certificate status. ### SYNTAX
Get-HPOVApplianceCertificateStatus [-ApplianceConnection] <Object> [<CommonParameters>]
This CMDLET will retrieve the SSL Certificate details installed on the appliance. This does not check the validity of the SSL
certificate. Use the Get-HPOVApplianceCertificateStatus CMDLET to validate the certificate chain. ### Parameters -
ApplianceConnection <Object>
Aliases [-Appliance] Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). Default Value:
${Global:ConnectedSessions} | ? Default
Aliases Appliance
Required? true
Position? 0
### Input Types None. You cannot pipe objects to this cmdlet. ### Return Values
HPOneView.Appliance.ApplianceSslCertificateStatus [System.Management.Automation.PSCustomObject] Formatted
table display of the SSL Certificate object. ### Examples
-------------------------- EXAMPLE 1 --------------------------
### Related Links ***

Top
Get-HPOVApplianceCurrentSecurityMode

Get the appliance current security mode.
SYNTAX
Get-HPOVApplianceCurrentSecurityMode[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Return the current security mode of the appliance.
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
The current appliance security mode.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the appliances current security mode.
Related Links
Set-HPOVApplianceCurrentSecurityMode
Top
Get-HPOVApplianceDateTime


Get Appliance Date/Time Configuration.
SYNTAX
Get-HPOVApplianceDateTime [-ApplianceConnection] <Object> [<CommonParameters>]
This CMDLET displays the appliance or connected appliancces Date and Time configuration. Part of this is the actual Date and
Time of the appliance, Time Zone, NTP Servers, NTP polling, and Locale.
When queriying a Virtual Machine Appliance and the NTPServers property or field is Null, the appliance will retrieve its Date and
Time from the Hypervisor Host.
When queriying a Synergy Composer appliance and the NTPServers property or field is Null, the appliance will retrieve its Date
and Time from the System ROM.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.ApplianceServerDateTime [System.Management.Automation.PSCustomObject]
Date/Time object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Time Time Zone NTP Servers NTP Polling
--------- ---- --------- ----------- -----------
hpov1.domain.com 2/11/2016 2:12:46 PM UTC {10.55.1.1,10.54.1.1}
hpov2.domain.com 2/11/2016 2:12:45 PM UTC {}
This example passes in updated values to set for the appliance networking configuration. ### Related Links * [Set-
HPOVApplianceDateTime](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceDateTime) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceDateTime
Get Appliance Date/Time Configuration. ### SYNTAX
Get-HPOVApplianceDateTime [-ApplianceConnection] <Object> [<CommonParameters>]
This CMDLET displays the appliance or connected appliancces Date and Time configuration. Part of this is the actual Date and
Time of the appliance, Time Zone, NTP Servers, NTP polling, and Locale.
When queriying a Virtual Machine Appliance and the NTPServers property or field is Null, the appliance will retrieve its Date and
Time from the Hypervisor Host.
When queriying a Synergy Composer appliance and the NTPServers property or field is Null, the appliance will retrieve its Date
and Time from the System ROM.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.ApplianceServerDateTime [System.Management.Automation.PSCustomObject]
Date/Time object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Time Time Zone NTP Servers NTP Polling
hpov1.domain.com 2/11/2016 2:12:46 PM UTC {10.55.1.1,10.54.1.1}

hpov2.domain.com 2/11/2016 2:12:45 PM UTC {}
This example passes in updated values to set for the appliance networking configuration.
Related Links
Set-HPOVApplianceDateTime
Top
Get-HPOVApplianceGlobalSetting

(Reserved for future use) Retrieve appliance global settings.
SYNTAX
Get-HPOVApplianceGlobalSetting [-name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
(Reserved for future use) Retrives the list of global settings or a specific global setting by name.
Parameters
Default Value: ${Global:ConnectSessions}
Aliases Appliance
Required? true
Position? 1
-name <String>
Name of the global setting to be retrieved.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Name, value, description, and uri for the global setting(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
Return appliance Global Settings and their values. ### Related Links * [Set-HPOVApplianceGlobalSetting]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceGlobalSetting) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceGlobalSetting
(Reserved for future use) Retrieve appliance global settings. ### SYNTAX
Get-HPOVApplianceGlobalSetting [-name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
(Reserved for future use) Retrives the list of global settings or a specific global setting by name.
Parameters
Aliases Appliance
Required? true
Position? 1
-name <String>
Name of the global setting to be retrieved.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Name, value, description, and uri for the global setting(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
Return appliance Global Settings and their values.
Related Links
Set-HPOVApplianceGlobalSetting
Top
Get-HPOVApplianceNetworkConfig

Retrieves the configuration of the primary NIC of the appliance
SYNTAX
Get-HPOVApplianceNetworkConfig[ [-Location] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieves the configuration parameters of the primary network interface on the appliance, which can be captured into a
customer object for further operation, or captured to a text file in json format.
Parameters
Aliases Appliance
Required? false
Position? 1
-Location <String>
Aliases [-ExportFile] Directory to where the applinace network configuration will be exported to. Exported file name will be "
{$ApplianceConnection.Name}_ApplianceNetConf.json".
Aliases x, export, exportFile
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.ApplianceServerConfiguration [System.Management.Automation.PSCustomObject]
A collection object containing the properties and values of the primary network interface of the appliance.
HPOneView.Appliance.ApplianceServerConfiguration.ApplianceNetworks
The applianceNetworks property will display the appliance Networking in either a Format-Table (default) or Format-List view.
If exporting the appliance network configuration, the file object created will be returned.
Examples
-------------------------- EXAMPLE 1 --------------------------
Hostname IPv4Type IPv4Address IPv4DNS IPv6Type IPv6Address IPv6DNS
-------- -------- ----------- ------- -------- ----------- -------
hpov1.domain.com STATIC 172.20.51.4\24 {172.20.10.41, 172.20.10.42} UNCONFIGURE {}
Outputs the configuration of the primary network interface to standard output.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com | fl

Hostname : hpov1.domain.com
IPv4Type : STATIC
IPv4Address : 172.20.51.4
IPv4Mask : 255.255.255.0
IPv4Gateway : 172.20.51.1
IPv4DNS : {172.20.10.41, 172.20.10.42}
IPv6Type : UNCONFIGURE
IPv6Address :
IPv6Mask :
IPv6Gateway :
IPv6DNS : {}
Outputs the configuration of the primary network interface and pipe to Format-List for more information about the network
configuration.
-------------------------- EXAMPLE 3 --------------------------
$myAppNetConfig = Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com
Outputs the configuration of the primary network interface of the appliance to the object variable $myAppNetConfig
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVApplianceNetworkConfig -Location .
Outputs the configuration of the primary network interface of the appliance to the current directory. ### Related Links * [Set-
HPOVApplianceNetworkConfig](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceNetworkConfig) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceNetworkConfig
Retrieves the configuration of the primary NIC of the appliance ### SYNTAX
Get-HPOVApplianceNetworkConfig[ [-Location] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieves the configuration parameters of the primary network interface on the appliance, which can be captured into a
customer object for further operation, or captured to a text file in json format.
Parameters
Aliases Appliance
Required? false
Position? 1
-Location <String>
Aliases [-ExportFile] Directory to where the applinace network configuration will be exported to. Exported file name will be "
{$ApplianceConnection.Name}_ApplianceNetConf.json".
Aliases x, export, exportFile
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.ApplianceServerConfiguration [System.Management.Automation.PSCustomObject]
A collection object containing the properties and values of the primary network interface of the appliance.
HPOneView.Appliance.ApplianceServerConfiguration.ApplianceNetworks
The applianceNetworks property will display the appliance Networking in either a Format-Table (default) or Format-List view.
If exporting the appliance network configuration, the file object created will be returned.
Examples
-------------------------- EXAMPLE 1 --------------------------
Hostname IPv4Type IPv4Address IPv4DNS IPv6Type IPv6Address IPv6DNS

Outputs the configuration of the primary network interface to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com | fl

Hostname : hpov1.domain.com
IPv4Type : STATIC
IPv4Address : 172.20.51.4
IPv4Mask : 255.255.255.0
IPv4Gateway : 172.20.51.1
IPv4DNS : {172.20.10.41, 172.20.10.42}
IPv6Type : UNCONFIGURE
IPv6Address :
IPv6Mask :
IPv6Gateway :
IPv6DNS : {}
Outputs the configuration of the primary network interface and pipe to Format-List for more information about the network
configuration.
-------------------------- EXAMPLE 3 --------------------------
$myAppNetConfig = Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com
Outputs the configuration of the primary network interface of the appliance to the object variable $myAppNetConfig
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVApplianceNetworkConfig -Location .
Outputs the configuration of the primary network interface of the appliance to the current directory.
Related Links
Set-HPOVApplianceNetworkConfig
Top
Get-HPOVApplianceProxy

Get appliance configured HTTP proxy.
SYNTAX
Get-HPOVApplianceProxy[ [-ApplianceConnection] <Array>] [<CommonParameters>]
The setting an appliance proxy allows you to set the HTTP/HTTPS proxy, port number for client connections, and whether
authentication requires a username and a password.
Required permissions: Infrastructure administrator
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.ProxyServer
Appliance proxy server settings.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the appliance configured HTTP/HTTPS proxy configuration. ### Related Links * [Remove-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVApplianceProxy) * [Set-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceProxy) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceProxy
Get appliance configured HTTP proxy. ### SYNTAX
Get-HPOVApplianceProxy[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the appliance configured HTTP/HTTPS proxy configuration.
Related Links
Remove-HPOVApplianceProxy
Set-HPOVApplianceProxy
Top
Get-HPOVApplianceSecurityProtocol

Get appliance supported security protocols and cyphers.
SYNTAX
Get-HPOVApplianceSecurityProtocol[ [-TlsVersion] <String[]>][ [-SecurityMode] <String[]>][ [-ApplianceConnection
] <Array>] [<CommonParameters>]
Get the appliance available security protocols, and their active state. By default the appliance current security mode will return
the available security protocols and their configuration state. Use the -SecurityMode parameter to specify one or more modes.
Use the -TlsVersion to specifify one or more security protocols to return.
Parameters
Aliases Appliance
Required? False
Position? named

-SecurityMode <String[]>
Specify the Security Mode to return supported security protocols and encryption cyphers. By default, will return the current
appliance security mode. Allowed values:
* Legacy
* FIPS
*CNSA
Aliases None
Required? false
Position? named
Default value
-TlsVersion <String[]>
Filter for specific TLS version(s). By default, will return all TLS Versions. Allowed values:
* TLSv1
TLSv1.1
TLSv1.2
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.SecurityProtocol
Available appliance security protocol, mode enabled and associated encryption cyphers.n
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the appliance FIPS security mode and associated security protocols.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVApplianceSecurityProtocol -SecurityMode FIPS, CNSA -TlsVersion TLSv1.1, TLSv1.2
Get the appliance FIPS security mode and TLSv1.1 and TLSv1.2 security protocols.
Related Links
Set-HPOVApplianceSecurityProtocol
Top
Get-HPOVApplianceSnmpV3EngineId

Get appliance SNMPv3 Engine ID.
SYNTAX
Get-HPOVApplianceSnmpV3EngineId[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Use this Cmdlet to get the appliance SNMPv3 Engine ID.
Parameters
Aliases Appliance
Required? False
Position? 0

<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.SnmpV3EngineId
Appliance SNMPv3 Engine ID.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the SNMPv3 Engine ID of the connected appliance. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceSnmpV3EngineId
Get appliance SNMPv3 Engine ID. ### SYNTAX
Get-HPOVApplianceSnmpV3EngineId[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Use this Cmdlet to get the appliance SNMPv3 Engine ID.
Parameters
Aliases Appliance
Required? False
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.SnmpV3EngineId
Appliance SNMPv3 Engine ID.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the SNMPv3 Engine ID of the connected appliance.
Related Links
Top
Get-HPOVApplianceTrapDestination

Get configured appliance SNMP trap destinations.
SYNTAX
Get-HPOVApplianceTrapDestination[ [-Destination] <String>][ [-Type] <Array>][ [-ApplianceConnection] <Array>] [<
CommonParameters>]
Use this Cmdlet to retrieve configured SNMPv1 and/or SNMPv3 trap destinations.
Parameters
Aliases Appliance
Required? False
Position? 2
-Destination <String>
Filter trap destinations by the destination value. Supports wildcard.
Aliases None
Required? false
Position? 0
Default value
-Type <Array>
Filter based on SNMP version. Supported values:
* SNMPv1
*SNMPv3
Aliases None
Required? false
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.SnmpV1TrapDestination
Appliance SNMPv1 trap destination, including trap community and target.
Appliance SNMPv3 trap destination, including type, SNMPv3 user and target.
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example ### Related Links * [New-HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/New-HPOVApplianceTrapDestination) * [Remove-HPOVApplianceTrapDestination]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVApplianceTrapDestination) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceTrapDestination
Get configured appliance SNMP trap destinations. ### SYNTAX
Get-HPOVApplianceTrapDestination[ [-Destination] <String>][ [-Type] <Array>][ [-ApplianceConnection] <Array>] [<

CommonParameters>]
Use this Cmdlet to retrieve configured SNMPv1 and/or SNMPv3 trap destinations.
Parameters
Aliases Appliance
Required? False
Position? 2
Filter trap destinations by the destination value. Supports wildcard.
Aliases None
Required? false
Position? 0
Default value
-Type <Array>
Filter based on SNMP version. Supported values:
* SNMPv1
*SNMPv3
Aliases None
Required? false
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Appliance SNMPv1 trap destination, including trap community and target.
Appliance SNMPv3 trap destination, including type, SNMPv3 user and target.
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example
Related Links
New-HPOVApplianceTrapDestination
Remove-HPOVApplianceTrapDestination
Top

Get X.509 SSL certificates from the appliace trusted store.
SYNTAX
Get-HPOVApplianceTrustedCertificate[ [-Name] <String>][ [-CertificateAuthoritiesOnly] <SwitchParameter>][ [-Appl
ianceConnection] <Object>] [<CommonParameters>]
Get-HPOVApplianceTrustedCertificate[ [-InputObject] <Object>][ [-ApplianceConnection] <Object>] [<CommonParamete

rs>]
This Cmdlet will allow the Infrastructure Administrator to retrieve X.509 compliant SSL certificates on the appliance within its
trusted store.
Parameters
Aliases Appliance
Required? false
Position? named
-CertificateAuthoritiesOnly <SwitchParameter>
This parameter will filter for trusted certificate authorities only.
Aliases CASOnly
Required? false
Position? named
Default value
Provide an HPOneView.ServerHardware or HPOneView.Enclosure resource to return associated appliance trusted certificate(s).
Aliases None
Required? false
Position? named
Default value
-Name <String>
The Alias Name of the certificate. Please know that wildcard is not supported.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.ServerHardware
Server hardware resource from Get-HPOVServer.
HPOneView.Enclosure
Enclosure resource from Get-HPOVEnclosure.
Return Values
HPOneView.Appliance.TrustedCertificate
Appliance trusted certificate object.
HPOneView.Appliance.TrustedCertificateAuthority
Appliance trusted certificate authority object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Return all trusted certificates from the appliance trusted store.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer -Name MyServer.domain.com -ErrorAction SilentlyContinue | Get-HPOVApplianceTrustedCertificate
Return the trusted certificate of the provided server hardware resource in the appliance trusted store. ### Related Links * [Add-
HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-
HPOVApplianceTrustedCertificate) * [Remove-HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVApplianceTrustedCertificate) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceTrustedCertificate
Get X.509 SSL certificates from the appliace trusted store. ### SYNTAX
Get-HPOVApplianceTrustedCertificate[ [-Name] <String>][ [-CertificateAuthoritiesOnly] <SwitchParameter>][ [-Appl

ianceConnection] <Object>] [<CommonParameters>]
Get-HPOVApplianceTrustedCertificate[ [-InputObject] <Object>][ [-ApplianceConnection] <Object>] [<CommonParamete
rs>]
This Cmdlet will allow the Infrastructure Administrator to retrieve X.509 compliant SSL certificates on the appliance within its
trusted store.
Parameters
Aliases Appliance
Required? false
Position? named
-CertificateAuthoritiesOnly <SwitchParameter>
This parameter will filter for trusted certificate authorities only.
Aliases CASOnly
Required? false
Position? named
Default value
Provide an HPOneView.ServerHardware or HPOneView.Enclosure resource to return associated appliance trusted certificate(s).
Aliases None
Required? false
Position? named
Default value
-Name <String>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Server hardware resource from Get-HPOVServer.
HPOneView.Enclosure
Enclosure resource from Get-HPOVEnclosure.
Return Values
Appliance trusted certificate object.
Appliance trusted certificate authority object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Return all trusted certificates from the appliance trusted store.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer -Name MyServer.domain.com -ErrorAction SilentlyContinue | Get-HPOVApplianceTrustedCertificate
Return the trusted certificate of the provided server hardware resource in the appliance trusted store.
Related Links
Top
Get appliance two-factor configuration.
SYNTAX
Get-HPOVApplianceTwoFactorAuthentication[ [-ApplianceConnection] <Array>] [<CommonParameters>]
HPE OneView.
Use this Cmdlet to get two factor authentication state of the connected appliance. Infrastructure administrator role is required.
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Security.TwoFactorAuthConfiguration
Appliance two-factor security settings.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the appliance two-factor authentication configuration. ### Related Links * [Disable-
HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVApplianceTwoFactorAuthentication) * [Set-HPOVApplianceTwoFactorAuthentication]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceTwoFactorAuthentication) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVApplianceTwoFactorAuthentication
Get appliance two-factor configuration. ### SYNTAX
Get-HPOVApplianceTwoFactorAuthentication[ [-ApplianceConnection] <Array>] [<CommonParameters>]
HPE OneView.
Use this Cmdlet to get two factor authentication state of the connected appliance. Infrastructure administrator role is required.
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Security.TwoFactorAuthConfiguration
Appliance two-factor security settings.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the appliance two-factor authentication configuration.
Related Links
Top
Get-HPOVAuditLog

Get-HPOVAuditLog
Get appliance audit log entries.
SYNTAX
Get-HPOVAuditLog [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVAuditLog[ [-Count] <Int>][ [-TimeSpan] <Timespan>][ [-Start] <DateTime>][ [-End] <Object>] [<CommonParam
eters>]
Using this CMDLET will retrive the appliance Audit Log enteries and display them to the console.
Parameters
Aliases Appliance
Required? true
Position? named
-Count <Int>
Specify the number of audit log entries to return.
Aliases None
Required? false
Position? named
Default value
-End <Object>
Specify the End datetime object to begin the serach. Should be combined with Start parameter.
Aliases None
Required? false
Position? named
Default value [DateTime]::Now
-Start <DateTime>
Specify the Start datetime object to begin the serach. Can be combined with End parameter.
Aliases None
Required? false
Position? named
Default value
Specify the time span of to filter results on. Cannot be combined with Start or End.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuditLogEntry [System.Management.Automation.PSCustomObject]
Single Appliance Audit Log Entry
Multiple Appliance Audit Log Entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAuditLog
Appliance : hpov.mydomain.com
Date : 2015-10-05 18:14:17.679 UTC
Source : AUTHENTICATION
Action : LOGIN
Result : SUCCESS
Severity : INFO
Details : Login Message Acknowledgment is "false".
Source IP : 172.20.253.1
Appliance :
hpov.mydomain.com
Date :
2015-10-05 18:14:17.761 UTC
Source :
AUTHENTICATION
Action :
LOGIN
Result :
SUCCESS
Severity :
INFO
Details :
Authentication SUCCESS. User "Administrator" logged in successfully from client "172.20.253.1" and
directory "LOCAL" on server "". [logID:LTY4ODgyMTcyMTMz]
Source IP : 172.20.253.1
Date : 2015-10-05 20:51:45.754 UTC
Source : firmware-drivers
Action : ADD
Result : SUCCESS
Severity : INFO
Details : Add firmware bundle /rest/firmware-drivers/CP026527
Return the audit logs from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAuditLog -Start ([DateTime]::Now).AddDays("-5")
Return the audit logs from the appliance from 5 days ago from today. ### Related Links * [Get-HPOVAuditLogArchive]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAuditLogArchive) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAuditLog
Get appliance audit log entries. ### SYNTAX
Get-HPOVAuditLog [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVAuditLog[ [-Count] <Int>][ [-TimeSpan] <Timespan>][ [-Start] <DateTime>][ [-End] <Object>] [<CommonParam
eters>]
Using this CMDLET will retrive the appliance Audit Log enteries and display them to the console.
Parameters
Aliases Appliance
Required? true
Position? named
-Count <Int>
Specify the number of audit log entries to return.
Aliases None
Required? false
Position? named
Default value
-End <Object>
Specify the End datetime object to begin the serach. Should be combined with Start parameter.
Aliases None
Required? false
Position? named
Default value [DateTime]::Now
-Start <DateTime>
Specify the Start datetime object to begin the serach. Can be combined with End parameter.
Aliases None
Required? false
Position? named
Default value
Specify the time span of to filter results on. Cannot be combined with Start or End.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuditLogEntry [System.Management.Automation.PSCustomObject]
Single Appliance Audit Log Entry
Multiple Appliance Audit Log Entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAuditLog
Date : 2015-10-05 18:14:17.679 UTC
Source : AUTHENTICATION
Action : LOGIN
Result : SUCCESS
Severity : INFO
Details : Login Message Acknowledgment is "false".
Source IP : 172.20.253.1
Appliance :
hpov.mydomain.com
Date :
2015-10-05 18:14:17.761 UTC
Source :
AUTHENTICATION
Action :
LOGIN
Result :
SUCCESS
Severity :
INFO
Details :
Authentication SUCCESS. User "Administrator" logged in successfully from client "172.20.253.1" and
directory "LOCAL" on server "". [logID:LTY4ODgyMTcyMTMz]
Source IP : 172.20.253.1
Date : 2015-10-05 20:51:45.754 UTC
Source : firmware-drivers
Action : ADD
Result : SUCCESS
Severity : INFO
Details : Add firmware bundle /rest/firmware-drivers/CP026527
Return the audit logs from the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAuditLog -Start ([DateTime]::Now).AddDays("-5")
Return the audit logs from the appliance from 5 days ago from today.
Related Links
Get-HPOVAuditLogArchive
Top

Download appliance audit log.
SYNTAX
Get-HPOVAuditLogArchive [-Location] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Use this Cmdlet to download the on appliance audit log.
Parameters
One or more Appliance Connection Objects, Connection ID, or Connection Name. If omitted, all connected appliances will be
processed.
Aliases Appliance
Required? true
Position? named
-Location <String>
The full path to where the audit log will be saved to. If omitted, current directory location will be used.
Aliases save
Required? true
Position? named
Default value (get-location).Path
<CommonParameters>
Input Types
Return Values
The generated audit log File
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAuditLogArchive c: emp
Save the Appliance audit log archive to C: emp ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAuditLogArchive
Download appliance audit log. ### SYNTAX
Get-HPOVAuditLogArchive [-Location] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Use this Cmdlet to download the on appliance audit log.
Parameters
One or more Appliance Connection Objects, Connection ID, or Connection Name. If omitted, all connected appliances will be
processed.
Aliases Appliance
Required? true
Position? named
-Location <String>
The full path to where the audit log will be saved to. If omitted, current directory location will be used.
Aliases save
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
The generated audit log File
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAuditLogArchive c:\temp
Save the Appliance audit log archive to C:\Temp

Related Links
Top
Get-HPOVAutomaticBackupConfig

Retrieve automatic appliance backup configuration.
SYNTAX
Get-HPOVAutomaticBackupConfig [-ApplianceConnection] <Array> [<CommonParameters>]
HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to
use that backup to restore a corrupted appliance in the event of a catastrophic failure.
The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure
(off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the
backup file.
This Cmdlet will get the automatic backup configuration from the connected appliance(s). Use Set-HPOVAutomaticBackupConfig
to set a new automatic backup policy for the appliance(s).
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AutomaticBackupConfig [System.Management.Automation.PSCustomObject]
Appliance automatic backup configuration object.
System.Collections.Arraylist <HPOneView.Appliance.AutomaticBackupConfig>
Multiple appliance automatic backup configuration objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Enabled Server Protocol Directory Interval Days Time
--------- ------- ------ -------- --------- -------- ---- ----
Appliance True scphost.domain.com SCP WEEKLY {MO, WE, FR} 18:00
Get the configured automatic backup setting of the appliance. ### Related Links * [Set-HPOVAutomaticBackupConfig]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVAutomaticBackupConfig) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAutomaticBackupConfig
Retrieve automatic appliance backup configuration. ### SYNTAX
Get-HPOVAutomaticBackupConfig [-ApplianceConnection] <Array> [<CommonParameters>]
backup file.
This Cmdlet will get the automatic backup configuration from the connected appliance(s). Use Set-HPOVAutomaticBackupConfig
to set a new automatic backup policy for the appliance(s).
Parameters
Aliases Appliance
Required? true
Position? 0

<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AutomaticBackupConfig [System.Management.Automation.PSCustomObject]
Appliance automatic backup configuration object.
System.Collections.Arraylist <HPOneView.Appliance.AutomaticBackupConfig>
Multiple appliance automatic backup configuration objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Enabled Server Protocol Directory Interval Days Time
Appliance True scphost.domain.com SCP WEEKLY {MO, WE, FR} 18:00
Get the configured automatic backup setting of the appliance.
Related Links
Set-HPOVAutomaticBackupConfig
Top
Get-HPOVAvailableDriveType

Get-HPOVAvailableDriveType
Return a collection of available D3940 disks.
SYNTAX
Get-HPOVAvailableDriveType [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This helper CMDLET will return a collection of available disk drives from a specified SAS Logical Interconnect or Drive
Enclosure. The object can then be used to define the drive selection criteria for New-HPOVServerProfileLogicalDisk using the -
AvailableDriveType parameter.
Parameters
Aliases [-appliance] The name of the appliance or list of appliances to execute the command against.
Aliases Appliance
Required? false
Position? named
A SAS Logical Interconnect or D3940 Drive Enclosure resource. If providing a SAS Logical Interconnect, the Cmdlet will
automatically locate the available drive enclosures.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Storage.SASLogicalInterconnect
A SAS Logical Interconnect resource from Get-HPOVSasLogicalInterconnect Cmdlet.
HPOneView.Storage.DiskEnclosure
A D3940 Drive Enclosure from Get-HPOVSasLogicalInterconnect Cmdlet.
Return Values
HPOneView.Storage.AvailableDriveType
A disk type object that defines available quantity of drives based on interface, media type and capacity, organized by SAS
Logical Interconnect.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSasLogicalInterconnect | Get-HPOVAvailableDriveType
Return all available disk drives from all SAS Logical Interconnects.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSasLogicalInterconnect -Name "LE1-Default SAS Synergy LIG-3" -ErrorAction Stop | Get-HPOVAvailableDriveT

ype
Return all available disk drives from the specific SAS Logical Interconnect.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVDriveEnclosure -Name "EnclosureName, Bay 1" -ErrorAction Stop | Get-HPOVAvailableDriveType
Return all available disk drives from the specific D3940 Drive Enclosure. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVAvailableDriveType
Return a collection of available D3940 disks. ### SYNTAX
Get-HPOVAvailableDriveType [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This helper CMDLET will return a collection of available disk drives from a specified SAS Logical Interconnect or Drive
Enclosure. The object can then be used to define the drive selection criteria for New-HPOVServerProfileLogicalDisk using the -
AvailableDriveType parameter.
Parameters
Aliases Appliance
Required? false
Position? named
A SAS Logical Interconnect or D3940 Drive Enclosure resource. If providing a SAS Logical Interconnect, the Cmdlet will
automatically locate the available drive enclosures.
Aliases None
Required? true
Position? named
Default value

<CommonParameters>
Input Types
HPOneView.Storage.SASLogicalInterconnect
A SAS Logical Interconnect resource from Get-HPOVSasLogicalInterconnect Cmdlet.
HPOneView.Storage.DiskEnclosure
A D3940 Drive Enclosure from Get-HPOVSasLogicalInterconnect Cmdlet.
Return Values
A disk type object that defines available quantity of drives based on interface, media type and capacity, organized by SAS
Logical Interconnect.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSasLogicalInterconnect | Get-HPOVAvailableDriveType
Return all available disk drives from all SAS Logical Interconnects.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSasLogicalInterconnect -Name 'LE1-Default SAS Synergy LIG-3' -ErrorAction Stop | Get-HPOVAvailableDriveT

ype
Return all available disk drives from the specific SAS Logical Interconnect.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVDriveEnclosure -Name 'EnclosureName, Bay 1' -ErrorAction Stop | Get-HPOVAvailableDriveType
Return all available disk drives from the specific D3940 Drive Enclosure.
Related Links
Top
Get-HPOVBackup

Get-HPOVBackup
List appliance backups.
SYNTAX
Get-HPOVBackup[ [-Before] <DateTime>][ [-After] <DateTime>] [-ApplianceConnection] <Array> [<CommonParameters>]
backup file.
Use this cmdlet to return any existing backups that have not been downloaded or offloaded on the appliance.
Parameters
-After <DateTime>
Specify the DateTime object of when to locate backups created after.
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? true
Position? named
-Before <DateTime>
Specify the DateTime object of when to locate backups created before.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The generated backup File if appliance is not setup for remote storage or the Force parameter is used.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBackup
This command will return any appliance backs present on the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVBackup -Before [datetime]"2017/01/01"
This command will return applinace backups that were created before 2017/01/01. ### Related Links * [New-HPOVBackup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVBackup) * [Save-HPOVBackup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVBackup) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVBackup
List appliance backups. ### SYNTAX
Get-HPOVBackup[ [-Before] <DateTime>][ [-After] <DateTime>] [-ApplianceConnection] <Array> [<CommonParameters>]
backup file.
Use this cmdlet to return any existing backups that have not been downloaded or offloaded on the appliance.
Parameters
-After <DateTime>
Specify the DateTime object of when to locate backups created after.
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? true
Position? named
-Before <DateTime>
Specify the DateTime object of when to locate backups created before.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBackup
This command will return any appliance backs present on the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVBackup -Before [datetime]'2017/01/01'
This command will return applinace backups that were created before 2017/01/01.
Related Links
New-HPOVBackup
Save-HPOVBackup
Top
Get-HPOVBaseline

Get-HPOVBaseline
Retrieve available SPP Baseline information.
SYNTAX
Get-HPOVBaseline[ [-File] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVBaseline[ [-SppName] <String>][ [-Version] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>

] [<CommonParameters>]
Get-HPOVBaseline[ [-HotfixesOnly] <SwitchParameter>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>] [<Comm

onParameters>]
Retrieves the list of SPPs that have been uploaded to the appliance, and their detail. You can examine the included components
and their versions reported by the baseline.
Please note that any file name that contains the . (period, CHAR46) character will be replaced with _ (underscore, CHAR95).
Example: My.Spp.To.Upload.201605.iso will become My_Spp_To_Upload_201605.iso.
Parameters
Aliases Appliance
Required? false
Position? named
-File <String>
Aliases [-isoFileName, -FileName]
The ISO file name of an SPP.
Aliases isoFileName, FileName
Required? false
Position? named
Default value
-HotfixesOnly <SwitchParameter>
Display only the available Hotfixes present with in the repository.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be
displayed. Allowed values:
* AllResources
* AllResourcesInScope
* HPOneView.Appliance.ScopeCollection
* HPOneView.Appliance.ConnectionPermission
Aliases None
Required? False
Position? named
-SppName <String>
The SPP/Baseline Name.
Aliases name
Required? false
Position? named
Default value
-Version <String>
If multiple SPP/Baselines with the same name exist, use the Version parameter to filter to the specific SPP/Baseline version.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Baseline [System.Management.Automation.PSCustomObject]
Single SPP resource object
System.Collections.ArrayList (HPOneView.Appliance.Baseline)
Multiple SPP resource objects
The firmware-baseline object or collection of firmware-baseline objects if no sppFile is provided in the command.
Examples
-------------------------- EXAMPLE 1 --------------------------
$sppCollection = Get-HPOVBaseline
Retrieves all SPP objects from the appliance and stores them in the sppCollection object
-------------------------- EXAMPLE 2 --------------------------
$sppObject = Get-HPOVBaseline -Filename SPP2012060B.2012_0525.1.iso
Retrieves an SPP object with the filename SPP2012060B.2012_0525.1.iso

-------------------------- EXAMPLE 3 --------------------------
$sppObject = Get-HPOVBaseline -SppName "HP Service Pack for ProLiant"
Retrieves an SPP object with the SPP Name "HP Service Pack for ProLiant" ### Related Links * [Add-HPOVBaseline]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVBaseline) * [Get-HPOVBaselineRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVBaselineRepository) * [Remove-HPOVBaseline]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVBaseline) * [Show-HPOVBaselineRepositorySize]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVBaselineRepositorySize) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVBaseline
Retrieve available SPP Baseline information. ### SYNTAX
Get-HPOVBaseline[ [-File] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVBaseline[ [-SppName] <String>][ [-Version] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>

Get-HPOVBaseline[ [-HotfixesOnly] <SwitchParameter>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>] [<Comm

onParameters>]
Retrieves the list of SPPs that have been uploaded to the appliance, and their detail. You can examine the included components
and their versions reported by the baseline.
Please note that any file name that contains the . (period, CHAR46) character will be replaced with _ (underscore, CHAR95).
Example: My.Spp.To.Upload.201605.iso will become My_Spp_To_Upload_201605.iso.
Parameters
Aliases Appliance
Required? false
Position? named
-File <String>
Aliases [-isoFileName, -FileName]
The ISO file name of an SPP.
Aliases isoFileName, FileName
Required? false
Position? named
Default value
-HotfixesOnly <SwitchParameter>
Display only the available Hotfixes present with in the repository.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-SppName <String>
The SPP/Baseline Name.
Aliases name
Required? false
Position? named
Default value
-Version <String>
If multiple SPP/Baselines with the same name exist, use the Version parameter to filter to the specific SPP/Baseline version.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single SPP resource object
System.Collections.ArrayList (HPOneView.Appliance.Baseline)
Multiple SPP resource objects
The firmware-baseline object or collection of firmware-baseline objects if no sppFile is provided in the command.
Examples
-------------------------- EXAMPLE 1 --------------------------
$sppCollection = Get-HPOVBaseline
Retrieves all SPP objects from the appliance and stores them in the sppCollection object
-------------------------- EXAMPLE 2 --------------------------
$sppObject = Get-HPOVBaseline -Filename SPP2012060B.2012_0525.1.iso
Retrieves an SPP object with the filename SPP2012060B.2012_0525.1.iso
-------------------------- EXAMPLE 3 --------------------------
$sppObject = Get-HPOVBaseline -SppName "HP Service Pack for ProLiant"
Retrieves an SPP object with the SPP Name 'HP Service Pack for ProLiant'
Related Links
Add-HPOVBaseline
Remove-HPOVBaseline
Top

Retrieve available baseline repository information.
SYNTAX
Get-HPOVBaselineRepository[ [-Name] <String>][ [-Type] <String>][ [-ApplianceConnection] <Array>] [<CommonParame
ters>]
This Cmdlet will return all configured baseline repositoryies by default. Only a single External Repository can be defined per
appliance.
Parameters
Aliases Appliance
Required? false
Position? 2
-Name <String>
Return the repository with the name or matching name.
Aliases None
Required? false
Position? 0
Default value
-Type <String>
Specify "Internal" or "External" to filter the repository type.
Aliases None
Required? false
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.BaselineRepository [System.Management.Automation.PSCustomObject]
Either and Internal or External repository object
System.Collections.ArrayList <HPOneView.Appliance.BaselineRepository>
Multiple resource objects
The configured baseline repositories are returned if no parameters are provided.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Repositories = Get-HPOVBaselineRepository
Retrieves all repository objects from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVBaselineRepository -Type External
Retrieves only the configured external repository on the appliance. ### Related Links * [Show-HPOVBaselineRepositorySize]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVBaselineRepositorySize) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVBaselineRepository
Retrieve available baseline repository information. ### SYNTAX
Get-HPOVBaselineRepository[ [-Name] <String>][ [-Type] <String>][ [-ApplianceConnection] <Array>] [<CommonParame

ters>]
This Cmdlet will return all configured baseline repositoryies by default. Only a single External Repository can be defined per
appliance.
Parameters
Aliases Appliance
Required? false
Position? 2
-Name <String>
Return the repository with the name or matching name.
Aliases None
Required? false
Position? 0
Default value
-Type <String>
Specify 'Internal' or 'External' to filter the repository type.
Aliases None
Required? false
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Either and Internal or External repository object
System.Collections.ArrayList <HPOneView.Appliance.BaselineRepository>
Multiple resource objects
The configured baseline repositories are returned if no parameters are provided.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Repositories = Get-HPOVBaselineRepository
Retrieves all repository objects from the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVBaselineRepository -Type External
Retrieves only the configured external repository on the appliance.
Related Links
Top
Get-HPOVClusterNode

Get-HPOVClusterNode
Default content
SYNTAX
Get-HPOVClusterNode [-Name] <string>[ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [
<CommonParameters>]
Default content
Parameters
Aliases Appliance
Required? False
Position? named
-Label <String>
Specify the label associated with resources.
Aliases None
Required? False
Position? named
Default value
-Name <string>
Aliases None
Required? True
Position? named
Default value
-Scope <Object>
displayed. Allowed values:\r\n\r\n\t AllResources\r\n\tAllResourcesInScope\r\n\t HPOneView.Appliance.ScopeCollection\r\n\t
HPOneView.Appliance.ConnectionPermission
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVClusterNode
Default example
Related Links
Top
Get-HPOVClusterProfile

Default content
SYNTAX
Get-HPOVClusterProfile [-Name] <string>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Default content
Parameters
Aliases Appliance
Required? False
Position? named
-Name <string>
Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example
Related Links
New-HPOVClusterProfile
Top
Get-HPOVCommandTrace

Get-HPOVCommandTrace
Start an HPOV Library Verbose Trace.
SYNTAX
Get-HPOVCommandTrace [-ScriptBlock] <ScriptBlock> [-Location] <String> [<CommonParameters>]
This Cmdlet will assist the user in setting up the PowerShell environment to generate and capture Verbose output from HPOV
Library Cmdlets. Once this Cmdlet has been executed, the prior HPOV Cmdlets can be executed, without the need of using the
-Cerbose switch.
Cmdlet output will be captured using the built-in Microsoft PowerShell Start-Transcript provider. A transcript trace file will be
saved in either the current working directory, or specified using the -Location parameter.
Please know that this Cmdlet is currently not supported in the Windows PowerShell ISE, unless using PowerShell v5 or newer.
Parameters
-Location <String>
Specify the directory where the output file will be created. A file with the following format will be created:
"{Date}_HPOV_transcript.log", where date is derived from `Get-Date -UFormat %y%m%d%H%M`
Default Value: (PWD).Path
Aliases None
Required? true
Position? 1
Default value (pwd).path
-ScriptBlock <ScriptBlock>
The command within a ScriptBlock to execute. The Cmdlet will add the -Verbose switch end of the command.
Aliases Command
Required? True
Position? 0
Default value
<CommonParameters>
Input Types
System.Management.Automation.ScriptBlock
ScriptBlock of the command or commands to generate verbose output for.
Return Values
System.IO.FileInfo
FileInfo object where the "{Date}_HPOV_transcript.log" file is generated.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVCommandTrace C: emp
Start a new library trace, which will create a file in the `C: emp` directory. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVCommandTrace
Start an HPOV Library Verbose Trace. ### SYNTAX

Get-HPOVCommandTrace [-ScriptBlock] <ScriptBlock> [-Location] <String> [<CommonParameters>]
This Cmdlet will assist the user in setting up the PowerShell environment to generate and capture Verbose output from HPOV
Library Cmdlets. Once this Cmdlet has been executed, the prior HPOV Cmdlets can be executed, without the need of using the
-Cerbose switch.
Cmdlet output will be captured using the built-in Microsoft PowerShell Start-Transcript provider. A transcript trace file will be
saved in either the current working directory, or specified using the -Location parameter.
Please know that this Cmdlet is currently not supported in the Windows PowerShell ISE, unless using PowerShell v5 or newer.
Parameters
-Location <String>
Specify the directory where the output file will be created. A file with the following format will be created:
'{Date}_HPOV_transcript.log', where date is derived from `Get-Date -UFormat %y%m%d%H%M`
Default Value: (PWD).Path
Aliases None
Required? true
Position? 1
Default value (pwd).path
-ScriptBlock <ScriptBlock>
The command within a ScriptBlock to execute. The Cmdlet will add the -Verbose switch end of the command.
Aliases Command
Required? True
Position? 0
Default value
<CommonParameters>
Input Types
System.Management.Automation.ScriptBlock
ScriptBlock of the command or commands to generate verbose output for.
Return Values
System.IO.FileInfo
FileInfo object where the '{Date}_HPOV_transcript.log' file is generated.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVCommandTrace C:\Temp
Start a new library trace, which will create a file in the C:\Temp directory.
Related Links
Top
Get-HPOVComposerNode

Retrieve Synergy Composer node information.
SYNTAX
Get-HPOVComposerNode[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain a collection of Synergy Composer node resources. This includes status, state, model, firmware version, and role.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.ComposerNode [System.Management.Automation.PSCustomObject]
Single Synergy Compose node.
System.Collections.ArrayList <HPOneView.ComposerNode>
Multiple Synergy Compose nodes.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Name State Status Model Version
Role
--------- ---- ----- ------ ----- -------
----
zpo-s18r18s3-ov.vse.rdlabs.hpecorp.net CN75160607 appliance bay 1 OK OK Synergy Composer 3.00.00-0251673
Active
zpo-s18r18s3-ov.vse.rdlabs.hpecorp.net CN75140CPW appliance bay 1 OK OK Synergy Composer 3.00.00-0251673
Standby
Return all Synergy Composer nodes ### Related Links ***

Top
### HPE OneView 4.00 Library ## Get-HPOVComposerNode
Retrieve Synergy Composer node information. ### SYNTAX
Get-HPOVComposerNode[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain a collection of Synergy Composer node resources. This includes status, state, model, firmware version, and role.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.ComposerNode [System.Management.Automation.PSCustomObject]
Single Synergy Compose node.
System.Collections.ArrayList <HPOneView.ComposerNode>
Multiple Synergy Compose nodes.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Name State Status Model Version
Role
zpo-s18r18s3-ov.vse.rdlabs.hpecorp.net CN75160607 appliance bay 1 OK OK Synergy Composer 3.00.00-0251673

Active
zpo-s18r18s3-ov.vse.rdlabs.hpecorp.net CN75140CPW appliance bay 1 OK OK Synergy Composer 3.00.00-0251673
Standby
Return all Synergy Composer nodes
Related Links
Top
Get-HPOVDataCenter

Get-HPOVDataCenter
Retreive a defined DataCenter.
SYNTAX
Get-HPOVDataCenter[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
A data center represents a physically contiguous area in which racks containing IT equipment are located. For example, you
have IT equipment in two rooms or on separate floors. You could create a data center for each of these areas. Each server,
enclosure, or power distribution device in your data center can report its power requirements, but it can be difficult to
understand the power and cooling requirements for your data center as a whole. The appliance enables you to bring power and
cooling management of your servers, enclosures, and power delivery devices together in a single management system. When
you initialize the appliance for the first time, it creates a data center named Datacenter 1. The appliance provides this data
center as a place to visualize your racks. You can rename or edit this data center to match the values and layout of your data
center, you can use it as the basis for a planned data center model, or you can delete this data center without adverse effects.
This Cmdlet will retrieve all or a specific DataCenter resource object. If Remote Support has been enabled on the appliance, the
DataCenter object will contain a RemoteSupportLocation property that contains the site location (if different from the Default
DataCenter), and both the Primary and Secondary contacts.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
DataCenter name. Supports wildcard (*) character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Facilities.DataCenter
A DataCenter resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVDataCenter
Retrieve all defined DataCenters on the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVDataCenter -Name DC*
Locate all DataCenter objects that begin with "DC".

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVDataCenter | Select -ExpandProperty RemoteSupportLocation
Retrieve the Remote Support Location property from the found DataCenter resource objects. ### Related Links * [New-
HPOVDataCenter](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVDataCenter) * [Remove-
HPOVDataCenter](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVDataCenter) * [Set-
HPOVDataCenter](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVDataCenter) * [Set-
HPOVDataCenterRemoteSupport](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVDataCenterRemoteSupport) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVDataCenter
Retreive a defined DataCenter. ### SYNTAX
Get-HPOVDataCenter[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will retrieve all or a specific DataCenter resource object. If Remote Support has been enabled on the appliance, the
DataCenter object will contain a RemoteSupportLocation property that contains the site location (if different from the Default
DataCenter), and both the Primary and Secondary contacts.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
DataCenter name. Supports wildcard (*) character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
A DataCenter resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVDataCenter
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVDataCenter -Name DC*
Locate all DataCenter objects that begin with 'DC'.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVDataCenter | Select -ExpandProperty RemoteSupportLocation
Retrieve the Remote Support Location property from the found DataCenter resource objects.
Related Links
New-HPOVDataCenter
Remove-HPOVDataCenter
Set-HPOVDataCenter
Set-HPOVDataCenterRemoteSupport
Top
Get-HPOVDriveEnclosure

List Synergy DAS Enclosures.
SYNTAX
Get-HPOVDriveEnclosure[ [-Name] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This Cmdlet will help display the avialable Synergy DAS Enclosures, and their associated inventory data.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
The name of the Synergy DAS enclosure. Omitt to return all devices.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Storage.DriveEnclosure [System.Management.Automation.PSCustomObject]
Single resource object.
System.Collections.ArrayList <HPOneView.Storage.DriveEnclosure>
Multiple resource objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Name State Status Serial Number Drive Bays I/O Adapters
--------- ---- ----- ------ ------------- ---------- ------------
appliance 0000A66101, bay 1 On Monitored SN123100 40/40 2
Get all available Synergy Drive Enclosures. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVDriveEnclosure
List Synergy DAS Enclosures. ### SYNTAX
Get-HPOVDriveEnclosure[ [-Name] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This Cmdlet will help display the avialable Synergy DAS Enclosures, and their associated inventory data.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
The name of the Synergy DAS enclosure. Omitt to return all devices.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Storage.DriveEnclosure [System.Management.Automation.PSCustomObject]
Single resource object.
System.Collections.ArrayList <HPOneView.Storage.DriveEnclosure>
Multiple resource objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Name State Status Serial Number Drive Bays I/O Adapters

Get all available Synergy Drive Enclosures.
Related Links
Top
Get-HPOVEnclosure

Get-HPOVEnclosure
Retrieve Enclosure resource(s).
SYNTAX
Get-HPOVEnclosure [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Array>] [<Co
mmonParameters>]
Get-HPOVEnclosure [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Array>][ [-R
eport] <SwitchParameter>] [<CommonParameters>]
Get-HPOVEnclosure [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Array>] [-ex
portFile] <String> [<CommonParameters>]
Obtain a collection of enclosure hardware resources which have the specified name.
Parameters
Aliases Appliance
Required? false
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False

-Name <String>
The name of the enclosure hardware resource to be returned. All enclosure hardware resources will be returned if omitted.
Aliases None
Required? true
Position? named
Default value
-Report <SwitchParameter>
Generate report of enclosure, including device bays, interconnect bays, and reported firmware for components.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
* AllResources
Aliases None
Required? false
Position? named
-exportFile <String>
Aliases [-x, -export] Full path and file name to save the output of Get-HPOVEnclosure.
Aliases x, export
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Object
Enclosure Report
The matching enclosure hardware resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
$enclosures = Get-HPOVEnclosure
Return all the enclosure hardware managed by this appliance.

-------------------------- EXAMPLE 2 --------------------------
$enclosure = Get-HPOVEnclosure -Name "A"
Return the enclosure hardware resource with name "A".

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVEnclosure
Enclosure Name Serial Number Enclosure Model Rack Name State EG Populated Bays
-------------- ------------- --------------- --------- ----- -- --------------
Encl1 SGH100X6J1 BladeSystem c7000 Enclosure G2 Rack-173 Monitored Default EG1 16/16
Display a brief list of the enclosures managed or monitored by the appliance.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVEnclosure -Name Encl1 -report

Enclosure Name Serial Number Enclosure Model Rack Name FW Managed Baseline Name
-------------- ------------- --------------- --------- ---------- -------------
Encl1 SGH100X6J1 BladeSystem c7000 Enclosure G2 Rack-173 False
Licensing
---------
OneView
OA Bay Role IP Address Firmware Version

------ ---- ---------- ----------------
1 Active 172.18.1.11 4.01 April 01 2013
2 Standby 172.18.1.12 4.01 April 01 2013
Server Name Serial Number Model System ROM iLO Firmware Version Server Profile Licensing
----------- ------------- ----- ---------- -------------------- -------------- ---------
Encl1, bay 1 SGH100X5RN BL660c Gen8 I32 05/30/2012 iLO4 1.30 Jul 02 2013 No Profile OneView
Encl1, bay 11 SGH106X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 Profile 11 OneView
Encl1, bay 3 SGH100X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 test 2 OneView
Interconnect Name Module Serial Number Firmware Version

----------------- ------ ------------- ----------------
Encl1, interconnect 1 HP VC FlexFabric 10Gb/24-Port Module WECFSED100 4.10
Interconnect Name Logical Interconnect State Status Consistency state

----- ----------------- -------------------- ----- ------ -----------------
Encl1, interconnect 1 Encl1-LI Configured OK Consistent
Generate a report of Encl1. ### Related Links * [Add-HPOVEnclosure](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Add-HPOVEnclosure) * [Get-HPOVEnclosureGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVEnclosureGroup) * [New-HPOVEnclosureGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVEnclosureGroup) * [Remove-HPOVEnclosure](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVEnclosure) * [Remove-HPOVEnclosureGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVEnclosureGroup) * [Reset-HPOVEnclosureDevice](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Reset-HPOVEnclosureDevice) * [Set-HPOVEnclosure](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVEnclosure) * [Set-HPOVEnclosureActiveFLM](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVEnclosureActiveFLM) * [Set-HPOVEnclosureGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVEnclosureGroup) * [Update-HPOVEnclosure](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Update-HPOVEnclosure) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVEnclosure
Retrieve Enclosure resource(s). ### SYNTAX
Get-HPOVEnclosure [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Array>] [<Co
mmonParameters>]
Get-HPOVEnclosure [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Array>][ [-R
eport] <SwitchParameter>] [<CommonParameters>]
Get-HPOVEnclosure [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Array>] [-ex
Parameters
Aliases Appliance
Required? false
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the enclosure hardware resource to be returned. All enclosure hardware resources will be returned if omitted.
Aliases None
Required? true
Position? named
Default value
Generate report of enclosure, including device bays, interconnect bays, and reported firmware for components.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
* AllResources
Aliases None
Required? false
Position? named
Aliases [-x, -export] Full path and file name to save the output of Get-HPOVEnclosure.
Aliases x, export
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Object
Enclosure Report
The matching enclosure hardware resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
$enclosures = Get-HPOVEnclosure
-------------------------- EXAMPLE 2 --------------------------
$enclosure = Get-HPOVEnclosure -Name "A"
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVEnclosure
Enclosure Name Serial Number Enclosure Model Rack Name State EG Populated Bays
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVEnclosure -Name Encl1 -report

Enclosure Name Serial Number Enclosure Model Rack Name FW Managed Baseline Name
Encl1 SGH100X6J1 BladeSystem c7000 Enclosure G2 Rack-173 False
Licensing
OneView
OA Bay Role IP Address Firmware Version
1 Active 172.18.1.11 4.01 April 01 2013

2 Standby 172.18.1.12 4.01 April 01 2013
2 Standby 172.18.1.12 4.01 April 01 2013
Server Name Serial Number Model System ROM iLO Firmware Version Server Profile Licensing
Encl1, bay 3 SGH100X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 test 2 OneView
Interconnect Name Module Serial Number Firmware Version

Interconnect Name Logical Interconnect State Status Consistency state

Generate a report of Encl1.
Related Links
Add-HPOVEnclosure
Set-HPOVEnclosure
Top

Retrieve Enclosure Group resource(s).
SYNTAX
Get-HPOVEnclosureGroup[ [-Name] <String>][ [-ApplianceConnection] <Array>][ [-exportFile] <String>] [<CommonPara
meters>]
Obtain a collection of Enclosure Group resources, or a single Enclosure Group with the specified name.
Parameters
Aliases Appliance
Required? false
Position? 1
Default value ${Global:ConnectedSessions}
-Name <String>
The name of the Enclosure Group resource to be returned. All enclosure group resources will be returned if omitted.
Aliases None
Required? false
Position? 0
Default value

Aliases [-x, -export] Full path and file name to save the output of Get-HPOVEnclosureGroup
Aliases x, export
Required? false
Position? 2
Default value
<CommonParameters>
Input Types
Return Values
Single Enclosure Group
The matching enclosure group resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
$enclosures = Get-HPOVEnclosureGroup
Return all the enclosure groups managed by this appliance.

-------------------------- EXAMPLE 2 --------------------------
$enclosure = Get-HPOVEnclosureGroup "A"
Return the enclosure group resource with name "A". ### Related Links * [New-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVEnclosureGroup) * [Remove-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVEnclosureGroup) * [Set-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVEnclosureGroup) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVEnclosureGroup
Retrieve Enclosure Group resource(s). ### SYNTAX
Get-HPOVEnclosureGroup[ [-Name] <String>][ [-ApplianceConnection] <Array>][ [-exportFile] <String>] [<CommonPara

meters>]
Obtain a collection of Enclosure Group resources, or a single Enclosure Group with the specified name.
Parameters
Aliases Appliance
Required? false
Position? 1
-Name <String>
The name of the Enclosure Group resource to be returned. All enclosure group resources will be returned if omitted.
Aliases None
Required? false
Position? 0
Default value
Aliases [-x, -export] Full path and file name to save the output of Get-HPOVEnclosureGroup
Aliases x, export
Required? false
Position? 2
Default value
<CommonParameters>
Input Types
Return Values

The matching enclosure group resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
$enclosures = Get-HPOVEnclosureGroup
Return all the enclosure groups managed by this appliance.
-------------------------- EXAMPLE 2 --------------------------
$enclosure = Get-HPOVEnclosureGroup "A"
Return the enclosure group resource with name "A".
Related Links
Top
Get-HPOVEulaStatus

Get-HPOVEulaStatus
Retrieve EULA status.
SYNTAX
Get-HPOVEulaStatus [-Appliance] <Object> [<CommonParameters>]
Determine if the EULA for the specified appliance needs to be accepted. This is typically called during First Time Setup of the
appliance.
This Cmdlet supports an unauthenticated request. If attempting to get the EULA status of an appliance not yet configured,
provide the IP Address or FQDN of the appliance. A temporary ApplianceConnection will be created then removed in the
${Global:ConnectedSessions} tracker.
Parameters
-Appliance <Object>
The FQDN, IP Address or HPOneView.Appliance.Connection of an HPE OneView appliance must be provided.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.EulaStatus
Object that returns the Appliance Name and if the EULA has been accepted with a boolean "Accepted" property.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEulaStatus -Appliance myappliance.domain.com
Appliance Accepted
--------- --------
myappliance.domain.com False
Get the EULA status from myappliance.domain.com

-------------------------- EXAMPLE 2 --------------------------
$Connection = Connect-HPOVMgmt -Appliance myappliance.domain.com -Username Administrator -Password MyPassw0rd

Get-HPOVEulaStatus -Appliance $Connection
Appliance Accepted
--------- --------
COnnecto to an appliance, then get the EULA status from myappliance.domain.com ### Related Links * [Set-HPOVEulaStatus]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVEulaStatus) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVEulaStatus
Retrieve EULA status. ### SYNTAX
Get-HPOVEulaStatus [-Appliance] <Object> [<CommonParameters>]
Determine if the EULA for the specified appliance needs to be accepted. This is typically called during First Time Setup of the
appliance.
This Cmdlet supports an unauthenticated request. If attempting to get the EULA status of an appliance not yet configured,
provide the IP Address or FQDN of the appliance. A temporary ApplianceConnection will be created then removed in the
${Global:ConnectedSessions} tracker.
Parameters
-Appliance <Object>
The FQDN, IP Address or HPOneView.Appliance.Connection of an HPE OneView appliance must be provided.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.EulaStatus
Object that returns the Appliance Name and if the EULA has been accepted with a boolean 'Accepted' property.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEulaStatus -Appliance myappliance.domain.com
Appliance Accepted
Get the EULA status from myappliance.domain.com

-------------------------- EXAMPLE 2 --------------------------
$Connection = Connect-HPOVMgmt -Appliance myappliance.domain.com -Username Administrator -Password MyPassw0rd

Get-HPOVEulaStatus -Appliance $Connection
Appliance Accepted
COnnecto to an appliance, then get the EULA status from myappliance.domain.com
Related Links
Set-HPOVEulaStatus
Top

Get configured fabric manager(s).
SYNTAX
Get-HPOVFabricManager[ [-Name] <String>][ [-Label] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters
>]
(APIC) policies. It represents a remote Cisco APIC or an APIC cluster that manages a Cisco ACI fabric.
You can operate a fabric manager after adding it in HPE OneView and configure a list of tenants to cover policies necessary for
HPE Synergy and Cisco APIC integration.
Remediation of networks, network sets, and logical interconnects Remediation is a process to convert a noncompliant health
state of an HPE OneView resource to a compliant health state with respect to APIC policy definitions.
The following conditions cause the fabric manager to be unable to synchronize with network policies:
* One or more networks connected across uplink sets in a logical interconnect within HPE Synergy have the same
VLAN tag
* The two networks are shared across tenants
When a fabric manager is non compliant with APIC network policies, a software remediation enables a fabric manager to
synchronize with network policies. A compliance report is generated immediately after adding a fabric manager and is updated
again after remediation. The compliance report details actions that you can perform to remediate inconsistencies. There are
indicators for compliant, noncompliant, and compliance-check progress for each resource. Every tenant has a list of consistent
and inconsistent reports based on the compliance records generated for a tenant. An inconsistency appears in the form of an
alert, which contains an action choice: auto-remediate or manual. If you choose to auto-remediate, an automatic update of the
selected HPE OneView resource will initiate.
Parameters
Aliases Appliance
Required? False
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value
-Name <String>
Specify the fabric manager name to filter for.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.FabricManager
Configured fabric manager resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all defined fabric managers.
Related Links
Top
Get-HPOVHealthStatus

Display appliance health.
SYNTAX
Get-HPOVHealthStatus[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Display the HPE OneView appliance health status. This includes CPU, Memory and Disk Space.
Parameters
Aliases appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.HealthStatus [System.Management.Automation.PSCustomObject]
Appliance health report in table format.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the HPE OneView appliance health. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVHealthStatus
Display appliance health. ### SYNTAX
Get-HPOVHealthStatus[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Display the HPE OneView appliance health status. This includes CPU, Memory and Disk Space.
Parameters
Aliases appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.HealthStatus [System.Management.Automation.PSCustomObject]
Appliance health report in table format.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the HPE OneView appliance health.
Related Links
Top

Get configured hypervisor managers.
SYNTAX
Get-HPOVHypervisorManager[ [-Name] <String>][ [-Version] <String>][ [-Label] <String>][ [-Scope] <Object>][ [-Ap
plianceConnection] <Array>] [<CommonParameters>]
You can register a hypervisor manager with HPE OneView by providing hostname and credentials in the Hypervisor Managers
user interface. The registered hypervisor manager contains preferences, which are used as default hypervisor or cluster
settings during hypervisor cluster profile creation. You can modify the hypervisor manager preferences using the edit operation.
You can override these values in a hypervisor cluster profile.
hypervisor manager.
OneView. You can assign scopes to the hypervisor manager resource in HPE OneView.
Parameters
Aliases Appliance
Required? False
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value
-Name <String>
Filter for vCenter name.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
*AllResourcesInScope
Aliases None
Required? False
Position? named

-Version <String>
Filter for specific vCenter version.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Cluster.HypervisorManager
The configured hypervisor cluster manager and its properties
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVHypervisorManager -Name vcenter.domain.com
Get the specified hypervisor manager by resource name.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVHypervisorManager -Version 5.5.0
Get all of the configured hypervisor managers that are vSphere 5.5.0.
Related Links
Top
Get-HPOVIloSso
Get-HPOVIloSso
Generate iLO SSO Token.
SYNTAX
Get-HPOVIloSso [-InputObject] <Object>[ [-RemoteConsoleOnly] <SwitchParameter>][ [-IloRestSession] <SwitchParame
ter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVIloSso [-InputObject] <Object>[ [-IloRestSession] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<

CommonParameters>]
Obtain an iLO SSO Token URL to authenticate to an iLO. If the server hardware is unsupported, the resulting URL will not use
SSO and the iLO web interface will prompt for credentials. Note, this is not supported on G7 or earlier servers.
Parameters
Aliases Appliance
Required? false
Position? named
-IloRestSession <SwitchParameter>
Generate an HPRESTCmdlets compliant IloSession object.
Aliases None
Required? false
Position? named
Default value False
The Server Hardware or Server Profile resource object from Get-HPOVServer or Get-HPOVServerProfile.
Aliases Server
Required? true
Position? named
Default value
-RemoteConsoleOnly <SwitchParameter>
Generate an SSO URL Token for accessing the Remote Console.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Server Hardware resource object.
Server Profile resource object.
Return Values
SSO Url Object
System.Array
Multiple SSO URL objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
$SSOObjects = Get-HPOVServer | Get-HPOVIloSso
Generate iLO SSO Objects for all managed server resources.

-------------------------- EXAMPLE 2 --------------------------
$SSOObject = Get-HPOVServer -Name "Enc1, bay 1" | Get-HPOVIloSso

Generate iLO SSO Object for the specified managed server resource.
-------------------------- EXAMPLE 3 --------------------------
$SSOObject = Get-HPOVServerProfile -Name "My Server Profile" | Get-HPOVIloSso
-------------------------- EXAMPLE 4 --------------------------
$IloSession = Get-HPOVServer -Name "Enc1, bay 1" | Get-HPOVIloSso -IloRestSession
Generate iLO SSO Object that can then be used with the HPRESTCmdlets. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVIloSso
Generate iLO SSO Token. ### SYNTAX
Get-HPOVIloSso [-InputObject] <Object>[ [-RemoteConsoleOnly] <SwitchParameter>][ [-IloRestSession] <SwitchParame

ter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVIloSso [-InputObject] <Object>[ [-IloRestSession] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<

CommonParameters>]
Obtain an iLO SSO Token URL to authenticate to an iLO. If the server hardware is unsupported, the resulting URL will not use
SSO and the iLO web interface will prompt for credentials. Note, this is not supported on G7 or earlier servers.
Parameters
Aliases Appliance
Required? false
Position? named
-IloRestSession <SwitchParameter>
Generate an HPRESTCmdlets compliant IloSession object.
Aliases None
Required? false
Position? named
Default value False

The Server Hardware or Server Profile resource object from Get-HPOVServer or Get-HPOVServerProfile.
Aliases Server
Required? true
Position? named
Default value
-RemoteConsoleOnly <SwitchParameter>
Generate an SSO URL Token for accessing the Remote Console.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Server Hardware resource object.
Return Values
SSO Url Object
System.Array
Multiple SSO URL objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
$SSOObjects = Get-HPOVServer | Get-HPOVIloSso

Generate iLO SSO Objects for all managed server resources.
-------------------------- EXAMPLE 2 --------------------------
$SSOObject = Get-HPOVServer -Name 'Enc1, bay 1' | Get-HPOVIloSso
-------------------------- EXAMPLE 3 --------------------------
$SSOObject = Get-HPOVServerProfile -Name 'My Server Profile' | Get-HPOVIloSso
-------------------------- EXAMPLE 4 --------------------------
$IloSession = Get-HPOVServer -Name 'Enc1, bay 1' | Get-HPOVIloSso -IloRestSession
Generate iLO SSO Object that can then be used with the HPRESTCmdlets.
Related Links
Top
Get-HPOVImageStreamerAppliance

Retrieve HPE Synergy Image Streamer appliances.
SYNTAX
Get-HPOVImageStreamerAppliance[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieve populated and discovered HPE Synergy Image Streamer appliances within the Synergy Management fabric. Image
Streamer appliances can be in either a Claimed or Unclaimed state. Appliances will only belong in a single redundant H/A Pair,
and all H/A pairs will participate within the same HPE Synergy OS Deployment Server. Redundant H/A pairs will automatically be
created during the Create Logical Enclosure task.
Parameters

Aliases Appliance
Required? false
Position? named
-Name <String>
Image Streamer resource name. Supported the * (asterisk) wildcard character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Management.Automation.PSCustomObject [HPOneView.Appliance.ImageStreamerAppliance]
An HPE Synergy Image Streamer appliance object.
System.Collections.ArrayList<HPOneView.Appliance.ImageStreamerAppliance>
A collection of HPE Synergy Image Streamer appliance objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
List all HPE Synergy Image Streamer appliances.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVImageStreamerAppliance -Name "0000A66102, appliance 2"
Retrieve the Image Streamer Appliance "0000A66102, appliance 2". ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVImageStreamerAppliance
Retrieve HPE Synergy Image Streamer appliances. ### SYNTAX
Get-HPOVImageStreamerAppliance[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieve populated and discovered HPE Synergy Image Streamer appliances within the Synergy Management fabric. Image
Streamer appliances can be in either a Claimed or Unclaimed state. Appliances will only belong in a single redundant H/A Pair,
and all H/A pairs will participate within the same HPE Synergy OS Deployment Server. Redundant H/A pairs will automatically be
created during the Create Logical Enclosure task.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Collections.ArrayList<HPOneView.Appliance.ImageStreamerAppliance>

Examples
-------------------------- EXAMPLE 1 --------------------------
List all HPE Synergy Image Streamer appliances.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVImageStreamerAppliance -Name "0000A66102, appliance 2"
Retrieve the Image Streamer Appliance "0000A66102, appliance 2".
Related Links
Top
Get-HPOVInterconnect

Retrieve Interconnect resource(s).
SYNTAX
Get-HPOVInterconnect[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object>
][ [-Export] <String>] [<CommonParameters>]
Retrieves a list of all Interconnects (Ethernet, FC, Converged Network, and/or SAS) or just specific ones via a query if the name
parameter is provided. The output can be sent to a file using the Export parameter.
Parameters
Aliases Appliance
Required? false
Position? 3
-Export <String>
Aliases [-x, -exportFile] The full path and file name to export the contents retrieved from the call to Get-HPOVInterconnect.
Aliases x, exportFile
Required? false
Position? 4
Default value
-Label <String>
Aliases None
Required? false
Position? 2
Default value False
-Name <String>
The name of the interconnect to retrieve.
Aliases None
Required? false
Position? 0
Default value
-Scope <Object>
* AllResources
Aliases None
Required? false
Position? 1
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.Interconnect [System.Management.Automation.PSCustomObject]
Single Interconnect object.
HPOneView.Networking.SasInterconnect [System.Management.Automation.PSCustomObject]
Single SAS Interconnect object.
Multiple Interconnect objects.
An Interconnect or collection of Interconnects
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Interconnects managed by all connected appliances to standard output.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVInterconnect "Encl1, Interconnect 1"
Returns just the Encl1, Interconnect 1 Interconnect object to standard output.

-------------------------- EXAMPLE 3 --------------------------
$myICs = Get-HPOVInterconnect
Returns the Get-HPOVInterconnect query and stores it in the object $myICs

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVInterconnect -exportFile "c:\myApplianceConfig\ICs.json"
Returns the Get-HPOVInterconnect query results to the file c:\myApplianceConfig\ICs.json ### Related Links * [Get-
HPOVInterconnectType](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVInterconnectType) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVInterconnect
Retrieve Interconnect resource(s). ### SYNTAX
Get-HPOVInterconnect[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object>

][ [-Export] <String>] [<CommonParameters>]
Retrieves a list of all Interconnects (Ethernet, FC, Converged Network, and/or SAS) or just specific ones via a query if the name
parameter is provided. The output can be sent to a file using the Export parameter.
Parameters
Aliases Appliance
Required? false
Position? 3
-Export <String>
Aliases [-x, -exportFile] The full path and file name to export the contents retrieved from the call to Get-HPOVInterconnect.
Aliases x, exportFile
Required? false
Position? 4
Default value
-Label <String>
Aliases None
Required? false
Position? 2
Default value False
-Name <String>
The name of the interconnect to retrieve.
Aliases None
Required? false
Position? 0
Default value
-Scope <Object>
* AllResources
Aliases None
Required? false
Position? 1
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.Interconnect [System.Management.Automation.PSCustomObject]
Single Interconnect object.
HPOneView.Networking.SasInterconnect [System.Management.Automation.PSCustomObject]
Single SAS Interconnect object.
Multiple Interconnect objects.
An Interconnect or collection of Interconnects
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Interconnects managed by all connected appliances to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVInterconnect "Encl1, Interconnect 1"
Returns just the Encl1, Interconnect 1 Interconnect object to standard output.
-------------------------- EXAMPLE 3 --------------------------
$myICs = Get-HPOVInterconnect
Returns the Get-HPOVInterconnect query and stores it in the object $myICs
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVInterconnect -exportFile "c:\myApplianceConfig\ICs.json"
Returns the Get-HPOVInterconnect query results to the file c:\myApplianceConfig\ICs.json
Related Links
Get-HPOVInterconnectType
Top

Retrieve Interconnect Type resource(s).
SYNTAX
Get-HPOVInterconnectType[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVInterconnectType[ [-PartNumber] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieves a list of all Interconnect Types or just specific ones via a query if the name or partnumber parameters are provided.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
The name of the interconnect type model name to retrieve.
Aliases None
Required? false
Position? named
Default value
-PartNumber <String>
The Part Number of an Interconnect Type to search for.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.InterconnectType [System.Management.Automation.PSCustomObject]
Single Interconnect Type resource.
System.Collections.ArrayList <HPOneView.Networking.InterconnectType>
Multiple Interconnect Type resources or formatted table dispalying basic Interconnect Type information.
An Interconnect Type or collection of Interconnect Types.
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Interconnect Types available from all connected appliances to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVInterconnect -name "HP VC FlexFabric 10Gb/24-Port Module"
Returns just the "HP VC FlexFabric 10Gb/24-Port Module" Interconnect Type object to standard output.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVInterconnect -name "571956-B21"
Returns just the partnumber "571956-B21" Interconnect Type object to standard output. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVInterconnectType
Retrieve Interconnect Type resource(s). ### SYNTAX
Get-HPOVInterconnectType[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVInterconnectType[ [-PartNumber] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>

Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.InterconnectType [System.Management.Automation.PSCustomObject]
Single Interconnect Type resource.
System.Collections.ArrayList <HPOneView.Networking.InterconnectType>
Multiple Interconnect Type resources or formatted table dispalying basic Interconnect Type information.
An Interconnect Type or collection of Interconnect Types.
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Interconnect Types available from all connected appliances to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVInterconnect -name "HP VC FlexFabric 10Gb/24-Port Module"
Returns just the 'HP VC FlexFabric 10Gb/24-Port Module' Interconnect Type object to standard output.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVInterconnect -name "571956-B21"
Returns just the partnumber '571956-B21' Interconnect Type object to standard output.
Related Links
Top
Get-HPOVLabel

Get-HPOVLabel
Return created label resources.
SYNTAX
Get-HPOVLabel[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will return all of the created labels on the specifed appliance.
Parameters
Aliases Appliance
Required? false
Position? 1
-Name <String>
Aliases None
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Label
Label resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLabel
Return all labels from the appliance. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLabel
Return created label resources. ### SYNTAX
Get-HPOVLabel[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will return all of the created labels on the specifed appliance.
Parameters
Aliases Appliance
Required? false
Position? 1
-Name <String>
Aliases None
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Label
Label resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLabel
Return all labels from the appliance.
Related Links
Top
Get-HPOVLdap

Get-HPOVLdap
List Global Authentication Directory settings.
SYNTAX
Get-HPOVLdap[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVLdap[ [-Export] <SwitchParameter>] [-Save] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters

>]
This cmdlet will display the global authentication directory settings configured on the appliance. It will show if local logins are
enabled, default authentication directory name, and configured authentication directory names.
Parameters
Aliases Appliance
Required? false
Position? named
-Export <SwitchParameter>
Aliases [-x] Export the configured directories to individual files.
Aliases x
Required? false
Position? named
Default value False
-Save <String>
Aliases [-location] Directory where the exported configured directories will be saved to. A filename of "
{appliance_name}_globalSettings.json" will be created.
Aliases location
Required? true
Position? named
Default value

<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuthGlobalDirectoryConfiguration [System.Management.Automation.PSCustomObject]
Global Authentication Settings object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdap
Allow Local Login Default Directory Configured Directories
----------------- ----------------- ----------------------
True domain1 {domain1, domain2}
View the Global Authentication Directory configuration for all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLdap -export -save c:\directory
Export the Global Authentication Directory configuration settings. ### Related Links * [Add-HPOVLdapServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVLdapServer) * [Disable-HPOVLdapLocalLogin]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVLdapLocalLogin) * [Enable-HPOVLdapLocalLogin]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVLdapLocalLogin) * [Get-HPOVLdapDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLdapDirectory) * [Get-HPOVLdapGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLdapGroup) * [New-HPOVLdapDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapDirectory) * [New-HPOVLdapGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapGroup) * [New-HPOVLdapServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapServer) * [Remove-HPOVLdapDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLdapDirectory) * [Remove-HPOVLdapGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLdapGroup) * [Remove-HPOVLdapServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLdapServer) * [Set-HPOVLdapDefaultDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVLdapDefaultDirectory) * [Set-HPOVLdapGroupRole]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVLdapGroupRole) * [Show-HPOVLdapGroups]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVLdapGroups) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLdap
List Global Authentication Directory settings. ### SYNTAX
Get-HPOVLdap[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVLdap[ [-Export] <SwitchParameter>] [-Save] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters

>]
This cmdlet will display the global authentication directory settings configured on the appliance. It will show if local logins are
enabled, default authentication directory name, and configured authentication directory names.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases x
Required? false
Position? named
Default value False
-Save <String>
Aliases [-location] Directory where the exported configured directories will be saved to. A filename of
'{appliance_name}_globalSettings.json' will be created.
Aliases location
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuthGlobalDirectoryConfiguration [System.Management.Automation.PSCustomObject]
Global Authentication Settings object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdap
Allow Local Login Default Directory Configured Directories

View the Global Authentication Directory configuration for all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
Export the Global Authentication Directory configuration settings.
Related Links
Add-HPOVLdapServer
Get-HPOVLdapDirectory
Get-HPOVLdapGroup
New-HPOVLdapDirectory
New-HPOVLdapGroup
New-HPOVLdapServer
Remove-HPOVLdapDirectory
Remove-HPOVLdapGroup
Set-HPOVLdapDefaultDirectory
Set-HPOVLdapGroupRole
Show-HPOVLdapGroups
Top
Get configured Authentication Directories
SYNTAX
Get-HPOVLdapDirectory[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVLdapDirectory[ [-Export] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will retrieve the configured authentication directory(ies) configured on the appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-Export <String>
Aliases x
Required? false
Position? named
Default value
-Name <String>
The specific authentication directory name.

Aliases directory, domain
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Authentication Directory settings object
Multiple Authentication Directory settings objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Name Type Root Search Context Directory Servers
--------- ---- ---- ---- -------------- -----------------
MyAppliance1 domain1 AD dc=domain1,dc=com ou=Admins,ou=domain1... {dc1.domain1.com:636, dc2.domain1.com:636}
MyAppliance1 domain2 AD dc=domain2,dc=com ou=Admins,ou=domain2... {dc1.domain2.com:636, 10.1.2.1:636}
View the configured authentication directories, for all connected appliances.

-------------------------- EXAMPLE 2 --------------------------
Export the Global Directory Configuration settings. ### Related Links * [New-HPOVLdapDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapDirectory) * [Remove-HPOVLdapDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLdapDirectory) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLdapDirectory
Get configured Authentication Directories ### SYNTAX
Get-HPOVLdapDirectory[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVLdapDirectory[ [-Export] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

This cmdlet will retrieve the configured authentication directory(ies) configured on the appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-Export <String>
Aliases x
Required? false
Position? named
Default value
-Name <String>
The specific authentication directory name.
Aliases directory, domain
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Authentication Directory settings object
Multiple Authentication Directory settings objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Name Type Root Search Context Directory Servers

View the configured authentication directories, for all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
Export the Global Directory Configuration settings.
Related Links
Top
Get-HPOVLdapGroup

Get-HPOVLdapGroup
List Directory Group role assignment.
SYNTAX
Get-HPOVLdapGroup [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVLdapGroup [-Export] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will display the configured directory groups on the appliance, and display their assigned role(s). The default display
will include the URI of each configured group. Use the Report switch to display only the Directory Group Name, Login Domain
and assigned role(s).
Parameters
Aliases Appliance
Required? true
Position? named
-Export <String>
Export JSON content to file
Aliases x
Required? true
Position? named
Default value
-Name <String>
Aliases [-group, -GroupName] Configured Directory Group Name. If omitted, all configured Directory Groups will be displayed.
Aliases group, GroupName
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuthDirectoryGroupRoleMapping [System.Management.Automation.PSCustomObject]
Configured Directory Group role mapping
Multiple configured Directory Group role mappings
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdapGroup
Name Directory Roles
---- --------- -----
My Directory Group1 domain1 {Storage administrator}
My Directory Group2 domain1 {Network administrator}
Get list of configured Directory Groups.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLdapGroup -Group "My Directory Group1"

---- --------- -----
Display My Directroy Group1 and the assigned roles

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVLdapGroup -export C:\dir\directorygroups.json
Export configured Directory Groups to c:\dir\directorygroups.json ### Related Links * [New-HPOVLdapGroup]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapGroup) * [Remove-HPOVLdapGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLdapGroup) * [Set-HPOVLdapGroupRole]
Top
### HPE OneView 4.00 Library ## Get-HPOVLdapGroup
List Directory Group role assignment. ### SYNTAX
Get-HPOVLdapGroup [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVLdapGroup [-Export] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will display the configured directory groups on the appliance, and display their assigned role(s). The default display
will include the URI of each configured group. Use the Report switch to display only the Directory Group Name, Login Domain
and assigned role(s).
Parameters
Aliases Appliance
Required? true
Position? named
-Export <String>
Export JSON content to file
Aliases x
Required? true
Position? named
Default value
-Name <String>
Aliases [-group, -GroupName] Configured Directory Group Name. If omitted, all configured Directory Groups will be displayed.
Aliases group, GroupName
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuthDirectoryGroupRoleMapping [System.Management.Automation.PSCustomObject]
Configured Directory Group role mapping
Multiple configured Directory Group role mappings
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdapGroup

My Directory Group2 domain1 {Network administrator}
Get list of configured Directory Groups.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLdapGroup -Group "My Directory Group1"

Display My Directroy Group1 and the assigned roles
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVLdapGroup -export C:\dir\directorygroups.json
Export configured Directory Groups to c:\dir\directorygroups.json
Related Links
New-HPOVLdapGroup
Show-HPOVLdapGroups
Top
Get-HPOVLicense

Get-HPOVLicense
Gets the installed licenses on the appliance.
SYNTAX
Get-HPOVLicense [-Type] <String> [-State] <String>[ [-Summary] <SwitchParameter>][ [-Report] <SwitchParameter>]
This Cmdlet will retrieve licenses installed on the appliance. You can use this to get an inventory of what"s installed and what
licenses are consumed.
Parameters
Aliases Appliance
Required? true
Position? named
PARAMETER IS BEING DEPRECATED.
Generate a report of installed or required licenses, their type and assigned Nodes.
Aliases None
Required? false
Position? named
Default value False
-State <String>
Specify the license state to retrieve. Valid options are "Unlicensed" or "Permanent".
Aliases None
Required? true
Position? named
Default value
-Summary <SwitchParameter>
Display a condensed summary view of the installed or required licenses. This does not return a License object that can be used
with Remove-HPOVLicense.
Aliases None
Required? false
Position? named
Default value False
-Type <String>
Specify the type of License to retrieve. Valid options are "HP_ONE_VIEW" or "HP_ONE_VIEW_WO_ILO".
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.License
HPE OneView License
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLicense
Product : HPE OneView Advanced

Type : Permanent
Capacity : 64
Allocated : 30
Available : 34
Nodes : {Encl2, bay 7, Encl2, bay 4, Encl2, bay 13, Encl1, bay 8...}
Retrieve all installed license objects on the connected appliance(s). ### Related Links * [New-HPOVLicense]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLicense) * [Remove-HPOVLicense]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLicense) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLicense
Gets the installed licenses on the appliance. ### SYNTAX
Get-HPOVLicense [-Type] <String> [-State] <String>[ [-Summary] <SwitchParameter>][ [-Report] <SwitchParameter>]

This Cmdlet will retrieve licenses installed on the appliance. You can use this to get an inventory of what's installed and what
licenses are consumed.
Parameters
Aliases Appliance
Required? true
Position? named
PARAMETER IS BEING DEPRECATED.
Generate a report of installed or required licenses, their type and assigned Nodes.
Aliases None
Required? false
Position? named
Default value False

-State <String>
Specify the license state to retrieve. Valid options are "Unlicensed" or "Permanent".
Aliases None
Required? true
Position? named
Default value
-Summary <SwitchParameter>
Display a condensed summary view of the installed or required licenses. This does not return a License object that can be used
with Remove-HPOVLicense.
Aliases None
Required? false
Position? named
Default value False
-Type <String>
Specify the type of License to retrieve. Valid options are "HP_ONE_VIEW" or "HP_ONE_VIEW_WO_ILO".
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPE OneView License
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLicense
Product : HPE OneView Advanced

Type : Permanent
Capacity : 64
Allocated : 30
Available : 34
Nodes : {Encl2, bay 7, Encl2, bay 4, Encl2, bay 13, Encl1, bay 8...}
Retrieve all installed license objects on the connected appliance(s).
Related Links
New-HPOVLicense
Remove-HPOVLicense
Top
Get-HPOVLogicalEnclosure

Retrieve Logical Enclosure resource(s).
SYNTAX
Get-HPOVLogicalEnclosure [-Name] <String>[ [-EnclosureGroup] <Object>][ [-NonCompliant] <SwitchParameter>][ [-Sc
ope] <Object>] [-ApplianceConnection] <Array> [<CommonParameters>]
Obtain a collection of Logical Enclosure resources, or a single Logical Enclosure with the specified name.
Parameters
Aliases Appliance
Required? true
Position? named
Filter resources based on provided EnclosureGroup association.
Aliases None
Required? False
Position? named
Default value
-Name <String>
The name of the Logical Enclosure resource to be returned. All Logical Enclosure resources will be returned if omitted.
Aliases None
Required? true
Position? named
Default value
-NonCompliant <SwitchParameter>
Filter resources based on their non-compliant state.
Aliases None
Required? False
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Multiple Enclosure Groups
Examples
-------------------------- EXAMPLE 1 --------------------------
Return all the Logical Enclosure resources managed by all appliances.

-------------------------- EXAMPLE 2 --------------------------
$LogicalEnclosures = Get-HPOVLogicalEnclosure
Return all found Logical Enclosure resources on MyAppliance.domain.com appliance. ### Related Links * [New-
HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalEnclosure) * [Remove-
HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalEnclosure) * [Set-
HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVLogicalEnclosure) * [Update-
HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVLogicalEnclosure) * [Update-
HPOVLogicalEnclosureFirmware](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-
HPOVLogicalEnclosureFirmware) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLogicalEnclosure
Retrieve Logical Enclosure resource(s). ### SYNTAX
Get-HPOVLogicalEnclosure [-Name] <String>[ [-Scope] <Object>] [-ApplianceConnection] <Array> [<CommonParameters>

]
Obtain a collection of Logical Enclosure resources, or a single Logical Enclosure with the specified name.
Parameters
Aliases Appliance
Required? true
Position? named
-Name <String>
The name of the Logical Enclosure resource to be returned. All Logical Enclosure resources will be returned if omitted.
Aliases None
Required? true
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Multiple Enclosure Groups
Examples
-------------------------- EXAMPLE 1 --------------------------
Return all the Logical Enclosure resources managed by all appliances.
-------------------------- EXAMPLE 2 --------------------------
$LogicalEnclosures = Get-HPOVLogicalEnclosure
Return all found Logical Enclosure resources on MyAppliance.domain.com appliance.
Related Links
New-HPOVLogicalEnclosure
Remove-HPOVLogicalEnclosure
Set-HPOVLogicalEnclosure
Update-HPOVLogicalEnclosure
Top
Get-HPOVLogicalInterconnect

Retrieve Logical Interconnect resource(s).
SYNTAX
Get-HPOVLogicalInterconnect [-Name] <String>[ [-NonCompliant] <SwitchParameter>][ [-Scope] <Object>][ [-Label] <
String>] [-ApplianceConnection] <Object> [-Export] <String> [<CommonParameters>]
Retrieves a list of all Logical Interconnect or just specific ones via a query if the name parameter is provided. The output can be
sent to a file using the exportFile parameter.
Parameters
Aliases Appliance
Required? true
Position? named
-Export <String>
Aliases [-x, -export] The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnect.
Aliases x, ExportFile
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the Logical Interconnect to retrieve.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
System.Collections.ArrayList <HPoneView.Networking.LogicalInterconnect>
Multiple Logical Interconnects
A Logical Interconnect or collection of Logical Interconnects
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Logical Interconnect defined on the appliance to standard output.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnect "Production"
Returns just the Production Logical Interconnect object to standard output.

-------------------------- EXAMPLE 3 --------------------------
$myLogicalICs = Get-HPOVLogicalInterconnect
Returns the Get-HPOVLogicalInterconnect query and stores it in the object $myLogicalICs

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalInterconnect -Export "c:\myApplianceConfig\LogicaICs.json"
Returns the Get-HPOVLogicalInterconnect query results to the file c:\myApplianceConfig\LogicaICs.json ### Related Links *
[Disable-HPOVLogicalInterconnectPortMonitoring](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVLogicalInterconnectPortMonitoring) * [Enable-HPOVLogicalInterconnectPortMonitoring]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVLogicalInterconnectPortMonitoring) * [Get-
HPOVLogicalInterconnectGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVLogicalInterconnectGroup) * [Get-HPOVLogicalInterconnectPortMonitoring](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVLogicalInterconnectPortMonitoring) * [Install-HPOVLogicalInterconnectFirmware]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Install-HPOVLogicalInterconnectFirmware) * [New-
HPOVLogicalInterconnectGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVLogicalInterconnectGroup) * [Remove-HPOVLogicalInterconnectGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVLogicalInterconnectGroup) * [Show-HPOVLogicalInterconnectMacTable]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVLogicalInterconnectMacTable) * [Update-
HPOVLogicalInterconnect](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVLogicalInterconnect) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLogicalInterconnect
Retrieve Logical Interconnect resource(s). ### SYNTAX
Get-HPOVLogicalInterconnect [-Name] <String>[ [-NonCompliant] <SwitchParameter>][ [-Scope] <Object>][ [-Label] <

String>] [-ApplianceConnection] <Object> [-Export] <String> [<CommonParameters>]
Retrieves a list of all Logical Interconnect or just specific ones via a query if the name parameter is provided. The output can be
sent to a file using the exportFile parameter.
Parameters
Aliases Appliance
Required? true
Position? named
-Export <String>
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the Logical Interconnect to retrieve.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
System.Collections.ArrayList <HPoneView.Networking.LogicalInterconnect>
A Logical Interconnect or collection of Logical Interconnects
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Logical Interconnect defined on the appliance to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnect "Production"
Returns just the Production Logical Interconnect object to standard output.

-------------------------- EXAMPLE 3 --------------------------
$myLogicalICs = Get-HPOVLogicalInterconnect
Returns the Get-HPOVLogicalInterconnect query and stores it in the object $myLogicalICs
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalInterconnect -Export "c:\myApplianceConfig\LogicaICs.json"
Returns the Get-HPOVLogicalInterconnect query results to the file c:\myApplianceConfig\LogicaICs.json
Related Links
Get-HPOVLogicalInterconnectGroup
Install-HPOVLogicalInterconnectFirmware
New-HPOVLogicalInterconnectGroup
Remove-HPOVLogicalInterconnectGroup
Show-HPOVLogicalInterconnectMacTable
Update-HPOVLogicalInterconnect
Top

Retrieve Logical Interconnect Group resource(s).
SYNTAX
Get-HPOVLogicalInterconnectGroup[ [-Name] <String>] [-Type] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-
ApplianceConnection] <Object>] [-exportFile] <String> [<CommonParameters>]
Get-HPOVLogicalInterconnectGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieves a list of all Logical Interconnect Groups or just specific ones via a query if the name parameter is provided. The output
can be sent to a file using the exportFile parameter.
Parameters
Aliases Appliance
Required? false
Position? named
Pipeline input resource generated from Wait-HPOVTaskComplete, or successfully completed Async Task resource object.
Aliases Resource
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the Logical Interconnect Group to retrieve.
Aliases None
Required? false
Position? named
Default value

-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-Type <String>
Provide the type of Logical Interconnect Group to return. Omit to return all Logical Interconnect Group resources.
Aliases None
Required? true
Position? named
Default value
Aliases [-x, -export] The full path and file name to export the contents retrieved from the call to Get-
HPOVLogicalInterconnectGroup.
Aliases x, export
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Successfully Completed Async task resource from Wait-HPOVTaskComplete or other supported method
Return Values
A Logical Interconnect Group or collection of Logical Interconnect Groups
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Logical Interconnect Groups defined on the appliance to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnectGroup -Name "Production"
Returns just the Production Logical Interconnect Group object to standard output.
-------------------------- EXAMPLE 3 --------------------------
$myLigs = Get-HPOVLogicalInterconnectGroup
Returns the Get-HPOVLogicalInterconnectGroup query and stores it in the object $myLigs

-------------------------- EXAMPLE 4 --------------------------
$LigName = "VC FF Virt Prod"

$CreatedLig = New-HPOVLogicalInterconnectGroup -Name $LigName -bays @{1 = "FlexFabric";2 = "FlexFabric"} -Enable
IgmpSnooping $True -InternalNetworks "VMMigration Network" | Wait-HPOVTaskComplete | Get-HPOVLogicalInterconnect
Group
$CreatedLig
Name Enclosure Groups

---- ----------------
VC FF Virt Prod
Create a new Logical Interconnect Group resource, wait for the task to complete, then retrieve the created resource.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVLogicalInterconnectGroup -exportFile "c:\myApplianceConfig\LogicaICGs.json"
Returns the Get-HPOVLogicalInterconnectGroup query results to the file c:\myApplianceConfig\LogicaICGs.json ### Related
Links * [New-HPOVLogicalInterconnectGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOneView/wiki/Remove-HPOVLogicalInterconnectGroup) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLogicalInterconnectGroup
Retrieve Logical Interconnect Group resource(s). ### SYNTAX
Get-HPOVLogicalInterconnectGroup[ [-Name] <String>] [-Type] <String>[ [-Scope] <Object>][ [-Label] <String>][ [-

ApplianceConnection] <Object>] [-exportFile] <String> [<CommonParameters>]
Get-HPOVLogicalInterconnectGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Retrieves a list of all Logical Interconnect Groups or just specific ones via a query if the name parameter is provided. The output
Parameters
Aliases Appliance
Required? false
Position? named
Pipeline input resource generated from Wait-HPOVTaskComplete, or successfully completed Async Task resource object.
Aliases Resource
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the Logical Interconnect Group to retrieve.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-Type <String>
Provide the type of Logical Interconnect Group to return. Omit to return all Logical Interconnect Group resources.
Aliases None
Required? true
Position? named
Default value
Aliases [-x, -export] The full path and file name to export the contents retrieved from the call to Get-
HPOVLogicalInterconnectGroup.
Aliases x, export
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Successfully Completed Async task resource from Wait-HPOVTaskComplete or other supported method
Return Values
A Logical Interconnect Group or collection of Logical Interconnect Groups
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all Logical Interconnect Groups defined on the appliance to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnectGroup -Name "Production"
Returns just the Production Logical Interconnect Group object to standard output.
-------------------------- EXAMPLE 3 --------------------------
$myLigs = Get-HPOVLogicalInterconnectGroup
Returns the Get-HPOVLogicalInterconnectGroup query and stores it in the object $myLigs
-------------------------- EXAMPLE 4 --------------------------
$LigName = 'VC FF Virt Prod'

$CreatedLig = New-HPOVLogicalInterconnectGroup -Name $LigName -bays @{1 = "FlexFabric";2 = "FlexFabric"} -Enable
IgmpSnooping $True -InternalNetworks 'VMMigration Network' | Wait-HPOVTaskComplete | Get-HPOVLogicalInterconnect
Group
$CreatedLig
Name Enclosure Groups
VC FF Virt Prod
Create a new Logical Interconnect Group resource, wait for the task to complete, then retrieve the created resource.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVLogicalInterconnectGroup -exportFile "c:\myApplianceConfig\LogicaICGs.json"

Returns the Get-HPOVLogicalInterconnectGroup query results to the file c:\myApplianceConfig\LogicaICGs.json
Related Links
Top

Get port monitoring configuration from provided logical interconnect.
SYNTAX
Get-HPOVLogicalInterconnectPortMonitoring [-InputObject] <Object>[ [-ApplianceConnection] <Array>] [<CommonParam
eters>]
This Cmdlet will return the port monitoring configuration for the provided logical interconnect.
Parameters
Aliases Appliance
Required? False
Position? named
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.LogicalInterconnect+PortMonitoringConfig
The current port monitor configuration of the provided logical interconnect(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnect -Name "Encl1-Default VC FF LIG" -ErrorAction Stop | Get-HPOVLogicalInterconnectPortM

onitoring
Get the port monitoring configuration from the specified Logical Interconnect. ### Related Links * [Disable-
HPOVLogicalInterconnectPortMonitoring](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVLogicalInterconnectPortMonitoring) * [Enable-HPOVLogicalInterconnectPortMonitoring]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVLogicalInterconnectPortMonitoring) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLogicalInterconnectPortMonitoring
Get port monitoring configuration from provided logical interconnect. ### SYNTAX
Get-HPOVLogicalInterconnectPortMonitoring [-InputObject] <Object>[ [-ApplianceConnection] <Array>] [<CommonParam

eters>]
This Cmdlet will return the port monitoring configuration for the provided logical interconnect.
Parameters
Aliases Appliance
Required? False
Position? named
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.LogicalInterconnect+PortMonitoringConfig
The current port monitor configuration of the provided logical interconnect(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnect -Name "Encl1-Default VC FF LIG" -ErrorAction Stop | Get-HPOVLogicalInterconnectPortM

onitoring
Get the port monitoring configuration from the specified Logical Interconnect.
Related Links
Top
Get-HPOVLogicalSwitch

Retrieve Logical Switch resources.
SYNTAX
Get-HPOVLogicalSwitch[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object
>][ [-exportFile] <String>] [<CommonParameters>]
Get-HPOVLogicalSwitch [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will retrieve one or more Logical Switch resources configured on the appliance.
Parameters
Aliases Appliance
Required? false
Position? named
Provide an HPOneView.Appliance.TaskResource object and the Cmdlet will return the associated Logical Switch resource
created from the New-HPOVLogicalSwitch Cmdlet..
Aliases None
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Name of the Logical Switch resource. Supports wildcard * character.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
Save the Logical Switch resource(s) to the specified JSON file.
Aliases x, export
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Async Task resource object, from New-HPOVLogicalSwitch.
Return Values
HPOneView.Networking.LogicalSwitch [System.Management.Automation.PSCustomObject]
Single Logical Switch resource.
System.Collections.ArrayList <HPOneView.Networking.LogicalSwitch>
Collection of Logical Switch resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve all Logical Switch resources from the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitch -Name MyLogicalSwitch1
Retrieve the specified MyLogicalSwitch1 resource from the default appliance connection. ### Related Links * [Get-
HPOVLogicalSwitchGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalSwitchGroup) * [New-
HPOVLogicalSwitch](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitch) * [New-
HPOVLogicalSwitchGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitchGroup) *
[Remove-HPOVLogicalSwitch](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitch) *
[Remove-HPOVLogicalSwitchGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVLogicalSwitchGroup) * [Update-HPOVLogicalSwitch](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-
HPOVLogicalSwitch) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLogicalSwitch
Retrieve Logical Switch resources. ### SYNTAX
Get-HPOVLogicalSwitch[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object

>][ [-exportFile] <String>] [<CommonParameters>]
Get-HPOVLogicalSwitch [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will retrieve one or more Logical Switch resources configured on the appliance.
Parameters
Aliases Appliance
Required? false
Position? named
Provide an HPOneView.Appliance.TaskResource object and the Cmdlet will return the associated Logical Switch resource
created from the New-HPOVLogicalSwitch Cmdlet..
Aliases None
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
Save the Logical Switch resource(s) to the specified JSON file.
Aliases x, export
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Async Task resource object, from New-HPOVLogicalSwitch.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve all Logical Switch resources from the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitch -Name MyLogicalSwitch1
Retrieve the specified MyLogicalSwitch1 resource from the default appliance connection.
Related Links
Get-HPOVLogicalSwitchGroup
New-HPOVLogicalSwitch
New-HPOVLogicalSwitchGroup
Remove-HPOVLogicalSwitch
Remove-HPOVLogicalSwitchGroup
Update-HPOVLogicalSwitch
Top

Retrieve Logical Switch Group resources.
SYNTAX
Get-HPOVLogicalSwitchGroup[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <O
bject>][ [-exportFile] <SwitchParameter>] [<CommonParameters>]
Get-HPOVLogicalSwitchGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
The logical switch group is a template for creating logical switches. Logical switches are an aggregation of up to two physical
top-of-rack switches. Once constructed from a logical switch group, a logical switch continues to be associated with its logical
switch group. Any change in consistency between the logical switch group and its associated logical switches is monitored and
made visible on the associated logical switch screen in HPE OneView. This Cmdlet will retrieve the specified or all Logical Switch
Group resources.
Parameters
Aliases Appliance
Required? false
Position? named
The Async task object after a Logical Switch Group resource is created, the Cmdlet will return the associated object.
Aliases None
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The Logical Switch Group resource Name. Supports the * wildcard character.
Aliases None
Required? false
Position? named
Default value

-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-exportFile <SwitchParameter>
Export the Logical Switch Group resource(s) to the specified JSON file.
Aliases x, export
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Async task resource after a Logical Switch Group has been created.
Return Values
HPOneView.Networking.LogicalSwitchGroup [System.Management.Automation.PSCustomObject]
The async task resource object to monitor (if -Async was used) or results.
System.Collections.ArrayList <HPOneView.Networking.LogicalSwitchGroup>
Collection of Logical Switch Group resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all logical switch group resources found on the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1"
Get the "My Logical Switch Group Policy 1" resource. ### Related Links * [New-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitchGroup) * [Remove-
HPOVLogicalSwitchGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitchGroup) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLogicalSwitchGroup
Retrieve Logical Switch Group resources. ### SYNTAX
Get-HPOVLogicalSwitchGroup[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <O

bject>][ [-exportFile] <SwitchParameter>] [<CommonParameters>]
Get-HPOVLogicalSwitchGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
made visible on the associated logical switch screen in HPE OneView. This Cmdlet will retrieve the specified or all Logical Switch
Group resources.
Parameters
Aliases Appliance
Required? false
Position? named
The Async task object after a Logical Switch Group resource is created, the Cmdlet will return the associated object.
Aliases None
Required? true
Position? named
Default value

-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The Logical Switch Group resource Name. Supports the * wildcard character.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-exportFile <SwitchParameter>
Export the Logical Switch Group resource(s) to the specified JSON file.
Aliases x, export
Required? false
Position? named
Default value

<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1"
Get the "My Logical Switch Group Policy 1" resource.
Related Links
Top
Get-HPOVLoginMessage

Get appliancce Login Message.
SYNTAX
Get-HPOVLoginMessage [-ApplianceConnection] <Object> [<CommonParameters>]
Retreive the current Login Message for the connected appliance(s).
Parameters
Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.LoginMessage
If successful, returns a resource
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance : hpov1.domain.com
Message : ************************************
***** WARNING ********
************************************
This management appliance is a company owned asset and provided for the exclusive use of authorize
d personnel. Unauthorized use or
abuse of this system may lead to corrective action including termination, civil and/or criminal pe
nalties.
Acknowledge : True
Message : ************************************
***** WARNING ********
************************************
nalties.
Acknowledge : False
Get the Login Message from all connected appliances. ### Related Links * [Set-HPOVLoginMessage]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVLoginMessage) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVLoginMessage
Get appliancce Login Message. ### SYNTAX
Get-HPOVLoginMessage [-ApplianceConnection] <Object> [<CommonParameters>]
Retreive the current Login Message for the connected appliance(s).
Parameters
Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Message : **
* WARNING **
**
nalties.
Acknowledge : True
Message : **
* WARNING **
**
nalties.
Acknowledge : False
Get the Login Message from all connected appliances.
Related Links
Set-HPOVLoginMessage
Top
Get-HPOVManagedSan

Get-HPOVManagedSan
Retrieve Managed SAN resource(s).
SYNTAX
Get-HPOVManagedSan [-Name] <String>[ [-Label] <String>] [-ApplianceConnection] <Array> [<CommonParameters>]
This cmdlet is used to display or list the available Managed SAN resources in the appliance.
Parameters
Aliases Appliance
Required? true
Position? 2
-Label <String>
Aliases None
Required? false
Position? 1
Default value False
-Name <String>
Aliases [-Fabric] Managed SAN Name to retrieve.
Aliases Fabric
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Storage.ManagedSan [System.Management.Automation.PSCustomObject]
Single Resource
Multiple Resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVManagedSan
Name State Status Network Zoned Automated Zoning
---- ----- ------ ------- ----- ----------------
Fabric A Ready OK BNA Managed Fabric A Zoned True
Return all managed SAN resources.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVManagedSan "Fabric A"
Show the "Fabric A" Managed SAN resource object. ### Related Links * [Set-HPOVManagedSan]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVManagedSan) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVManagedSan
Retrieve Managed SAN resource(s). ### SYNTAX
Get-HPOVManagedSan [-Name] <String>[ [-Label] <String>] [-ApplianceConnection] <Array> [<CommonParameters>]
This cmdlet is used to display or list the available Managed SAN resources in the appliance.
Parameters
Aliases Appliance
Required? true
Position? 2
-Label <String>

Aliases None
Required? false
Position? 1
Default value False
-Name <String>
Aliases [-Fabric] Managed SAN Name to retrieve.
Aliases Fabric
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Single Resource
Multiple Resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVManagedSan
Name State Status Network Zoned Automated Zoning
Fabric A Ready OK BNA Managed Fabric A Zoned True
Return all managed SAN resources.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVManagedSan "Fabric A"
Show the 'Fabric A' Managed SAN resource object.
Related Links
Set-HPOVManagedSan
Top
Get-HPOVNetwork

Get-HPOVNetwork
Retrieve Network resource(s).
SYNTAX
Get-HPOVNetwork [-Name] <String> [-Type] <String>[ [-Purpose] <String>][ [-Scope] <Object>] [-Label] <String> [-
ApplianceConnection] <Object> [-exportFile] <String> [<CommonParameters>]
Obtain a collection of network resources which have the specified type and/or name. The default connection information is
included in the returned network resources.
Parameters
Aliases Appliance
Required? true
Position? named
-Label <String>
Specify the label name the network resource is associated with. Cannot be combined with Name.
Aliases None
Required? true
Position? named
Default value
-Name <String>
The name of the network resource to be returned. All network resources will be returned if omitted. Supports "*" wildcard
character.
Aliases None
Required? true
Position? named
Default value
-Purpose <String>
Specify the Ethernet Purpose value to filter on.
Supported Values:
* General
* Management
* VMMigration
* FaultTolerance
* ISCSI
Note: When using this parameter, only Ethernet networks will be returned.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-Type <String>
The type of the network resource to be returned. Valid types are "Ethernet" for Ethernet networks, "FC" or "FibreChannel" for
Fibre Channel networks. All network resources will be returned if omitted.
Aliases None
Required? true
Position? named
Default value
Aliases [-x, -export] The full path and file name to export the JSON formatted definition of the networks to a file. The directory for
the file is validated prior to execution and the function returns an error is the directory does not exist.
Aliases x, export
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Network Resource Name(s)
Return Values
HPOneView.Networking.EthernetNetwork
Single Ethernet Network resource
HPOneView.Networking.FibreChannelNetwork
Single Fibre Channel Network resource
HPOneView.Networking.FCoENetwork
Single FCoE Network resource
Multiple Network Object resources
Examples
-------------------------- EXAMPLE 1 --------------------------
$net41 = Get-HPOVNetwork -name "Net-41"
Return the network resource with the name "Net-41"

-------------------------- EXAMPLE 2 --------------------------
$ethNets = Get-HPOVNetwork -type Ethernet
Return all the Ethernet network resources

-------------------------- EXAMPLE 3 --------------------------
$ethNets = Get-HPOVNetwork -Name VLAN_19*
Return all Ethernet Networks that match "VLAN_19*".

-------------------------- EXAMPLE 4 --------------------------
$ethNets = "Net1","Net2","Net3" | Get-HPOVNetwork -Type Ethernet
Return Net1, Net2, and Net3 Ethernet Networks from the specified appliance connection.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVNetwork -exportFile "c:\myApplianceConfig\myNets.json"
Exports all networks to the file myNets.json in JSON format.

-------------------------- EXAMPLE 6 --------------------------
Get-HPOVNetwork -x "c:\myApplianceConfig\myNets.json" -type Ethernet
Exports only the ethernet networks to the file myNets.json.

-------------------------- EXAMPLE 7 --------------------------
Get-HPOVNetwork
Type: Ethernet
Name Type VLAN ID Purpose Smartlink Private Network Status Preferred Bandwidth Max Bandwidth
---- ---- ------- ------- --------- --------------- ------ ------------------- -------------
VLAN 1-A Tagged 1 Management True False OK 2500 10000
VLAN 1-B Tagged 1 Management True False OK 2500 10000
VLAN 10-A Tagged 10 VMMigration True False OK 2500 10000
VLAN 10-B Tagged 10 VMMigration True False OK 2500 10000
VLAN 101-A Tagged 101 General True False OK 2500 10000
VLAN 101-B Tagged 101 General True False OK 2500 10000
Type: Fibre Channel
Name Status Type Typical Bandwidth Max Bandwidth Auto Login Redistribution Link Stability I
nterval
---- ------ ---- ----------------- ------------- ------------------------- ----------------
-------
3PAR SAN DA A OK DirectAttach 4000 8000 False 0
3PAR SAN DA B OK DirectAttach 4000 8000 False 0
3PAR SAN Fabric A OK FabricAttach 4000 8000 True 30
3PAR SAN Fabric B OK FabricAttach 4000 8000 True 30
Type: FCoE
Name Status vlanId Typical Bandwidth Max Bandwidth Associated SAN

---- ------ ------ ----------------- ------------- --------------
fcoe1 OK 134 2500 20000
FCOE3 OK 11 2500 10000
FCOE2 OK 10 2500 10000
FCOE12 OK 12 2500 10000
Get all available networks. ### Related Links * [Get-HPOVNetworkSet](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Get-HPOVNetworkSet) * [New-HPOVNetwork](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVNetwork) * [New-HPOVNetworkSet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetworkSet) *
[Remove-HPOVNetwork](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetwork) * [Remove-
HPOVNetworkSet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetworkSet) * [Set-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVNetwork) * [Set-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVNetworkSet) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVNetwork
Retrieve Network resource(s). ### SYNTAX
Get-HPOVNetwork [-Name] <String> [-Type] <String>[ [-Purpose] <String>][ [-Scope] <Object>] [-Label] <String> [-
ApplianceConnection] <Object> [-exportFile] <String> [<CommonParameters>]
Obtain a collection of network resources which have the specified type and/or name. The default connection information is
included in the returned network resources.
Parameters
Aliases Appliance
Required? true
Position? named
-Label <String>
Specify the label name the network resource is associated with. Cannot be combined with Name.
Aliases None
Required? true
Position? named
Default value
-Name <String>
The name of the network resource to be returned. All network resources will be returned if omitted. Supports '*' wildcard
character.
Aliases None
Required? true
Position? named
Default value

-Purpose <String>
Specify the Ethernet Purpose value to filter on.
Supported Values:
* General
* Management
* VMMigration
* FaultTolerance
* ISCSI
Note: When using this parameter, only Ethernet networks will be returned.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-Type <String>
The type of the network resource to be returned. Valid types are "Ethernet" for Ethernet networks, "FC" or "FibreChannel" for
Fibre Channel networks. All network resources will be returned if omitted.
Aliases None
Required? true
Position? named
Default value

Aliases [-x, -export] The full path and file name to export the JSON formatted definition of the networks to a file. The directory for
the file is validated prior to execution and the function returns an error is the directory does not exist.
Aliases x, export
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Network Resource Name(s)
Return Values
HPOneView.Networking.EthernetNetwork
Single Ethernet Network resource
HPOneView.Networking.FibreChannelNetwork
Single Fibre Channel Network resource
HPOneView.Networking.FCoENetwork
Single FCoE Network resource
Multiple Network Object resources
Examples
-------------------------- EXAMPLE 1 --------------------------
$net41 = Get-HPOVNetwork -name "Net-41"
Return the network resource with the name "Net-41"
-------------------------- EXAMPLE 2 --------------------------
$ethNets = Get-HPOVNetwork -type Ethernet
Return all the Ethernet network resources

-------------------------- EXAMPLE 3 --------------------------
$ethNets = Get-HPOVNetwork -Name VLAN_19
Return all Ethernet Networks that match 'VLAN_19'.
-------------------------- EXAMPLE 4 --------------------------
$ethNets = 'Net1','Net2','Net3' | Get-HPOVNetwork -Type Ethernet
Return Net1, Net2, and Net3 Ethernet Networks from the specified appliance connection.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVNetwork -exportFile "c:\myApplianceConfig\myNets.json"
Exports all networks to the file myNets.json in JSON format.
-------------------------- EXAMPLE 6 --------------------------
Get-HPOVNetwork -x "c:\myApplianceConfig\myNets.json" -type Ethernet
Exports only the ethernet networks to the file myNets.json.
-------------------------- EXAMPLE 7 --------------------------
Get-HPOVNetwork
Type: Ethernet
Name Type VLAN ID Purpose Smartlink Private Network Status Preferred Bandwidth Max Bandwidth
VLAN 1-A Tagged 1 Management True False OK 2500 10000

VLAN 1-B Tagged 1 Management True False OK 2500 10000
VLAN 10-A Tagged 10 VMMigration True False OK 2500 10000
VLAN 10-B Tagged 10 VMMigration True False OK 2500 10000
Type: Fibre Channel
Name Status Type Typical Bandwidth Max Bandwidth Auto Login Redistribution Link Stability I
nterval
3PAR SAN DA A OK DirectAttach 4000 8000 False 0

3PAR SAN DA B OK DirectAttach 4000 8000 False 0
3PAR SAN Fabric A OK FabricAttach 4000 8000 True 30
3PAR SAN Fabric B OK FabricAttach 4000 8000 True 30
Type: FCoE
Name Status vlanId Typical Bandwidth Max Bandwidth Associated SAN
fcoe1 OK 134 2500 20000

FCOE3 OK 11 2500 10000
FCOE2 OK 10 2500 10000
FCOE12 OK 12 2500 10000
Get all available networks.
Related Links
Get-HPOVNetworkSet
New-HPOVNetwork
New-HPOVNetworkSet
Remove-HPOVNetwork
Remove-HPOVNetworkSet
Set-HPOVNetwork
Set-HPOVNetworkSet
Top
Get-HPOVNetworkSet
Get-HPOVNetworkSet
Retrieve Network Set resource(s).
SYNTAX
Get-HPOVNetworkSet [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>] [-ApplianceConnection] <Object> [<Co
mmonParameters>]
Get-HPOVNetworkSet [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>] [-ApplianceConnection] <Object> [-Ex
Retrieves a list of all Network Sets or just specific Networks Sets via a query if the name parameter is provided. The Network Set
output can be sent to a file using the exportFile parameter.
Parameters
Aliases Appliance
Required? true
Position? named
-ExportFile <String>
Aliases [-x, -export]
The full path and file name to export the contents retrieved from the call to Get-HPOVNetworkSet.
Aliases x, export
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the Network Set to retrieve.
Aliases None
Required? true
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.NetworkSet [System.Management.Automation.PSCustomObject]
Single Network Set

System.Collections.ArrayList <HPOneView.Networking.NetworkSet>
Multiple Network Sets
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVNetworkSet
Returns all Network Sets defined on the appliance to standard output.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVNetworkSet -Name "Production"
Returns just the Production Network Set object to standard output.

-------------------------- EXAMPLE 3 --------------------------
$myNetSets = Get-HPOVNetworkSet
Returns the Get-HPOVNetworkSet query and stores it in the object $myNetSets

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVNetworkSet -exportFile "c:\myApplianceConfig\Network-Sets.json"
Returns the Get-HPOVNetworkSet query results to the file c:\myApplianceConfig\Network-Sets.json ### Related Links * [New-
HPOVNetworkSet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetworkSet) * [Remove-
HPOVNetworkSet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetworkSet) * [Set-
HPOVNetworkSet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVNetworkSet) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVNetworkSet
Retrieve Network Set resource(s). ### SYNTAX
Get-HPOVNetworkSet [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>] [-ApplianceConnection] <Object> [<Co
mmonParameters>]
Get-HPOVNetworkSet [-Name] <String>[ [-Scope] <Object>][ [-Label] <String>] [-ApplianceConnection] <Object> [-Ex
Retrieves a list of all Network Sets or just specific Networks Sets via a query if the name parameter is provided. The Network Set
output can be sent to a file using the exportFile parameter.
Parameters
Aliases Appliance
Required? true
Position? named
The full path and file name to export the contents retrieved from the call to Get-HPOVNetworkSet.
Aliases x, export
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the Network Set to retrieve.
Aliases None
Required? true
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Single Network Set
System.Collections.ArrayList <HPOneView.Networking.NetworkSet>
Multiple Network Sets
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVNetworkSet
Returns all Network Sets defined on the appliance to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVNetworkSet -Name "Production"
Returns just the Production Network Set object to standard output.
-------------------------- EXAMPLE 3 --------------------------
$myNetSets = Get-HPOVNetworkSet
Returns the Get-HPOVNetworkSet query and stores it in the object $myNetSets
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVNetworkSet -exportFile "c:\myApplianceConfig\Network-Sets.json"
Returns the Get-HPOVNetworkSet query results to the file c:\myApplianceConfig\Network-Sets.json
Related Links
New-HPOVNetworkSet
Set-HPOVNetworkSet
Top
Get-HPOVOSDeploymentPlan

Retreive an HPE Synergy Image Streamer OS Deployment Plan.
SYNTAX
Get-HPOVOSDeploymentPlan[ [-Name] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParame
ters>]
Use this Cmdlet to return defined OS Deployment Plans on an HPE Synergy Image Streamer appliance. The OS Deployment
Plan will define the delivery of the stateless OS. The resource object will also provide the custom attributes allowed. Use the
Get-HPOVOSDeploymentAttribute to return the collection object of attributes.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
OS Deployment Plan name. Supports wildcard (*) character.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.OSDeploymentPlan
An HPE Synergy Image Streamer OS Deployment plan object.
System.Collections.ArrayList<HPOneView.Appliance.OSDeploymentPlan>
A collection or HPE Synergy Image Streamer OS Deployment plan objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve all defined OS Deployment Plans found on the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVOSDeploymentPlan -Name "My OS Deployment Plan"
Retrieve the specified OS Deployment Plan on the appliance. ### Related Links * [Get-HPOVOSDeploymentPlanAttribute]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVOSDeploymentPlanAttribute) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVOSDeploymentPlan
Retreive an HPE Synergy Image Streamer OS Deployment Plan. ### SYNTAX
Get-HPOVOSDeploymentPlan[ [-Name] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParame

ters>]
Use this Cmdlet to return defined OS Deployment Plans on an HPE Synergy Image Streamer appliance. The OS Deployment
Plan will define the delivery of the stateless OS. The resource object will also provide the custom attributes allowed. Use the
Get-HPOVOSDeploymentAttribute to return the collection object of attributes.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
OS Deployment Plan name. Supports wildcard (*) character.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named

<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.OSDeploymentPlan
An HPE Synergy Image Streamer OS Deployment plan object.
System.Collections.ArrayList<HPOneView.Appliance.OSDeploymentPlan>
A collection or HPE Synergy Image Streamer OS Deployment plan objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve all defined OS Deployment Plans found on the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVOSDeploymentPlan -Name "My OS Deployment Plan"
Retrieve the specified OS Deployment Plan on the appliance.
Related Links
Get-HPOVOSDeploymentPlanAttribute
Top

Get HPE Synergy Image Streamer deployment plan parameters.
SYNTAX
Get-HPOVOSDeploymentPlanAttribute [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
HPE Synergy Image Streamer allows administrators to rapidly provision stateless operating systems along with bare metal
provisioning. An OS Deployment Plan dicates the characteristics of the OS, including vendor, version, boot disk size, and OS
personalization parameters. This Cmdlet will return OS Deployment Plan available and editable parameters.
Parameters
Aliases Appliance
Required? false
Position? named
The OS Deployment Plan from Get-HPOVOSDeploymentPlan.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Appliance.OSDeploymentPlan [System.Management.Automation.PSCustomObject]
Return Values
HPOneView.ServerProfile.OSDeployment.OSDeploymentParameter
The object containined the Name of the parameter, and its default Value.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVOSDeploymentPlan -Name "RHEL 7.2 OS" -ErrorAction Stop | Get-HPOVOSDeploymentPlanAttribute
Return OS Deployment Plan parameters from the "RHEL 7.2 OS" deployment plan.
-------------------------- EXAMPLE 2 --------------------------
$OSDeploymentAttributes = Get-HPOVOSDeploymentPlanAttributes -InputObject $MyDeploymentPlan

$OSDeploymentAttributes = $OSDeploymentAttributes | Where-Object name -NotMatch 'dns|gateway|ipaddress|netmask'
($OSDeploymentAttributes | Where-Object name -eq "NIC1.connectionid").value = 3
($OSDeploymentAttributes | Where-Object name -eq "NIC1.networkuri").value = $I3SCon3.networkUri
($OSDeploymentAttributes | Where-Object name -eq "NIC1.constraint").value = 'dhcp'
($OSDeploymentAttributes | Where-Object name -eq "NIC1.dhcp").value = $true
($OSDeploymentAttributes | Where-Object name -eq "NIC2.connectionid").value = 4
($OSDeploymentAttributes | Where-Object name -eq "NIC2.networkuri").value = $I3SCon4.networkUri
($OSDeploymentAttributes | Where-Object name -eq "NIC2.constraint").value = 'dhcp'
($OSDeploymentAttributes | Where-Object name -eq "NIC2.dhcp").value = $true
Get OS deployment plan attributes, and set DHCP for the two network connections. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVOSDeploymentPlanAttribute
Get HPE Synergy Image Streamer deployment plan parameters. ### SYNTAX
Get-HPOVOSDeploymentPlanAttribute [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVOSDeploymentPlan -Name 'RHEL 7.2 OS' -ErrorAction Stop | Get-HPOVOSDeploymentPlanAttribute
Return OS Deployment Plan parameters from the 'RHEL 7.2 OS' deployment plan.
Related Links
Top
Get-HPOVOSDeploymentServer

Retrieve HPE Synergy OS Deployment Server.
SYNTAX
Get-HPOVOSDeploymentServer[ [-Name] <String>][ [-Label] <String>][ [-ApplianceConnection] <Object>] [<CommonPara
meters>]
Retrieve the created HPE Synergy OS Deployment Server. An OS deployment server is a resource that enables you to deploy
(install and configure) operating systems for use by servers. HPE OneView connects to an OS deployment server and
configures it for deploying operating systems. HPE OneView manages the OS deployment server after it is configured and
displays the list of attributes, management settings, the OS deployment plans, and the server profiles that reference the
available OS deployment plans.
Parameters
Aliases Appliance
Required? false
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.OSDeploymentServer
System.Collections.ArrayList<HPOneView.Appliance.OSDeploymentServer>
Examples
-------------------------- EXAMPLE 1 --------------------------
List all HPE Synergy OS Deployment servers. ### Related Links * [New-HPOVOSDeploymentServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVOSDeploymentServer) * [Remove-
HPOVOSDeploymentServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVOSDeploymentServer) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVOSDeploymentServer
Retrieve HPE Synergy OS Deployment Server. ### SYNTAX
Get-HPOVOSDeploymentServer[ [-Name] <String>][ [-Label] <String>][ [-ApplianceConnection] <Object>] [<CommonPara

meters>]
Retrieve the created HPE Synergy OS Deployment Server. An OS deployment server is a resource that enables you to deploy
(install and configure) operating systems for use by servers. HPE OneView connects to an OS deployment server and
configures it for deploying operating systems. HPE OneView manages the OS deployment server after it is configured and
displays the list of attributes, management settings, the OS deployment plans, and the server profiles that reference the
available OS deployment plans.
Parameters
Aliases Appliance
Required? false
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Collections.ArrayList<HPOneView.Appliance.OSDeploymentServer>
Examples
-------------------------- EXAMPLE 1 --------------------------
List all HPE Synergy OS Deployment servers.
Related Links
New-HPOVOSDeploymentServer
Remove-HPOVOSDeploymentServer
Top
Get-HPOVPendingUpdate

Verify pending appliance update has been staged.
SYNTAX
Get-HPOVPendingUpdate [-ApplianceConnection] <Object> [<CommonParameters>]
Use this cmdlet to validate a pending update has been staged on an appliance. If one is present, the update details will be
returned to the caller.
Parameters
Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Update.Pending [System.Management.Automation.PSCustomObject]
Pending appliance update
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve pending update from all connected appliance sessions. ### Related Links * [Remove-HPOVPendingUpdate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVPendingUpdate) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVPendingUpdate
Verify pending appliance update has been staged. ### SYNTAX
Get-HPOVPendingUpdate [-ApplianceConnection] <Object> [<CommonParameters>]
Use this cmdlet to validate a pending update has been staged on an appliance. If one is present, the update details will be
returned to the caller.
Parameters
Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Update.Pending [System.Management.Automation.PSCustomObject]
Pending appliance update
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve pending update from all connected appliance sessions.
Related Links
Remove-HPOVPendingUpdate
Top
Get-HPOVPowerDevice

Get-HPOVPowerDevice
Retrieve Power Device (iPDU) resource(s).
SYNTAX
Get-HPOVPowerDevice[ [-Name] <String>][ [-Type] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain a collection of power device resources which have the specified name, and display the information about the power
device.
Parameters
Aliases Appliance
Required? false
Position? 2
-Name <String>
The name of the power device resource to be returned. All power device resources will be returned if omitted.
Aliases None
Required? false
Position? 0
Default value
-Type <String>
Filter the Power Delivery Device type. Allowed values:

* HPIpduCore
* HPIpduAcModule
* LoadSegment
* HPIpduOutletBar
* HPIpduOutlet.
Aliases None
Required? false
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.PowerDeliveryDevice [System.Management.Automation.PSCustomObject]
The matching power device resources
System.Collections.ArrayList <HPOneView.PowerDeliveryDevice>
Examples
-------------------------- EXAMPLE 1 --------------------------
$powerDevices = Get-HPOVPowerDevice
Return all the power devices managed by this appliance.

-------------------------- EXAMPLE 2 --------------------------
$powerDeviceA = Get-HPOVPowerDevice "iPDU_A"
Return the power device resource with name "iPDU_A". ### Related Links * [Add-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVPowerDevice) * [Add-HPOVPowerDeviceConnection]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVPowerDeviceConnection) * [New-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVPowerDevice) * [Remove-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVPowerDevice) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVPowerDevice
Retrieve Power Device (iPDU) resource(s). ### SYNTAX
Get-HPOVPowerDevice[ [-Name] <String>][ [-Type] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain a collection of power device resources which have the specified name, and display the information about the power
device.
Parameters
Aliases Appliance
Required? false
Position? 2
-Name <String>
The name of the power device resource to be returned. All power device resources will be returned if omitted.
Aliases None
Required? false
Position? 0
Default value
-Type <String>
Filter the Power Delivery Device type. Allowed values:
* HPIpduCore
* HPIpduAcModule
* LoadSegment
* HPIpduOutletBar
* HPIpduOutlet.
Aliases None
Required? false
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
System.Collections.ArrayList <HPOneView.PowerDeliveryDevice>
Examples
-------------------------- EXAMPLE 1 --------------------------
$powerDevices = Get-HPOVPowerDevice
Return all the power devices managed by this appliance.
-------------------------- EXAMPLE 2 --------------------------
$powerDeviceA = Get-HPOVPowerDevice "iPDU_A"
Return the power device resource with name "iPDU_A".
Related Links
Add-HPOVPowerDevice
New-HPOVPowerDevice
Top
Get-HPOVPowerPotentialDeviceConnection

Get-HPOVPowerPotentialDeviceConnection
Retrieve Power Device (mPDU/Rack PDU) Potentail Connections
SYNTAX
Get-HPOVPowerPotentialDeviceConnection [-PowerDevice] <Object> [-ApplianceConnection] <Object> [<CommonParameter
s>]
Obtain a collection of potential managed and unmanaged device power connections for the provided power device resoruce.
The returned value(s) will include the potential power connections that can be manually associated when not using iPDU
devices.
Parameters
Aliases Appliance
Required? true
Position? named
-PowerDevice <Object>
Aliases [-uri, -name] The name of the power device resource. Can provide Name, URI or Object.
Aliases uri, name
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Potential managed/unmanaged device Power Delivery Device connection object
Return Values
Collection of matching potential power device connection objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVPowerDevice "iPDU_A" | Get-HPOVPowerPotentialDeviceConnection
Return the potential power device connections for the "iPDU_A" power delivery device.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVPowerPotentialDeviceConnection "iPDU_A"
Return the potential power device connections for the "iPDU_A" power delivery device. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVPowerPotentialDeviceConnection
Retrieve Power Device (mPDU/Rack PDU) Potentail Connections ### SYNTAX
Get-HPOVPowerPotentialDeviceConnection [-PowerDevice] <Object> [-ApplianceConnection] <Object> [<CommonParameter

s>]
Obtain a collection of potential managed and unmanaged device power connections for the provided power device resoruce.
The returned value(s) will include the potential power connections that can be manually associated when not using iPDU
devices.
Parameters
Aliases Appliance
Required? true
Position? named
-PowerDevice <Object>
Aliases [-uri, -name] The name of the power device resource. Can provide Name, URI or Object.
Aliases uri, name
Required? true
Position? named
Default value

<CommonParameters>
Input Types
Potential managed/unmanaged device Power Delivery Device connection object
Return Values
Collection of matching potential power device connection objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVPowerDevice "iPDU_A" | Get-HPOVPowerPotentialDeviceConnection
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVPowerPotentialDeviceConnection "iPDU_A"
Related Links
Top
Get-HPOVRack

Get-HPOVRack
Retreive a defined Rack.
SYNTAX
Get-HPOVRack[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices, and unmanaged
devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the
appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks
managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers
statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance,
it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by
management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an
enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately
depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots.
You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the
physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in
the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side.
You can also describe how the devices in the rack are connected to those PDUs.
The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services
and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures.
This Cmdlet will retrieve all or a specific Rack resource object.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Rack name. Supports wildcard (*) character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Facilities.Rack
A Rack resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRack

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRack -Name Rack22*
Locate all racks objects that begin with "Rack22". ### Related Links * [Add-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVRackManager) * [Add-HPOVRackToDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVRackToDataCenter) * [Get-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRackManager) * [Get-HPOVRackMember]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRackMember) * [New-HPOVRack]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVRack) * [Remove-HPOVRack]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRack) * [Remove-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRackManager) * [Remove-HPOVRackMember]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRackMember) * [Set-HPOVRackMemberLocation]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRackMemberLocation) * [Update-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVRackManager) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVRack
Retreive a defined Rack. ### SYNTAX
Get-HPOVRack[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Rack name. Supports wildcard (*) character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
A Rack resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRack
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRack -Name Rack22*
Locate all racks objects that begin with 'Rack22'.
Related Links
Get-HPOVRackMember
New-HPOVRack
Remove-HPOVRack
Remove-HPOVRackMember
Set-HPOVRackMemberLocation
Top
Get-HPOVRackManager

Get-HPOVRackManager
Get claimed rack manage resource.
SYNTAX
Get-HPOVRackManager[ [-Name] <String>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>]
[<CommonParameters>]
manager platforms within a rack. A rack manager platform consists of the following:
* One or more chassis - The chassis are individual nodes that are used to build logical components such as sys
tems or partitions. Each chassis is a physical container for system components like the compute, storage, or ne
twork nodes.
In an HPE Superdome Flex Server, the chassis are 5U nodes that represent the compute nodes with CPU, memory,
I/O, power supplies, and fans.
* One or more systems or partitions - The system is a logical entity that functions as a server, and runs a si
ngle instance of an operating system to host services. In HPE OneView, the partition is modeled as a server har
dware resource.
In an HPE Superdome Flex Server, the systems are also called partitions. A partition consists of one or more
compute chassis that are interconnected through an ultra-fast fabric. Each partition starts with a base chassis
and can be extended using expansion chassis to form a large system.
* One or more managers - The manager component manages the rack manager platform, and hosts the management con
troller function. HPE OneView communicates with the rack manager through this management controller enabling sy
stem administration, control, and platform management of the rack manager platform. Some platforms have multipl
e manager components to support redundancy.
In an HPE Superdome Flex Server, the manager component is called the Rack Management Controller (RMC). The RM
C hosts the DMTF Redfish APIs.
* One or more racks - The racks physically contain all the rack manager platform components.
Minimum required privileges: Infrastructure administrator or Server administrator.
Parameters
Aliases Appliance
Required? False
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value
-Name <String>
Specify a resource name to filter for.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
*AllResourcesInScope
Aliases None
Required? False
Position? named

<CommonParameters>
Input Types
Return Values
HPOneView.Servers.RackManager
Rack manager resource object, with associated sub components like managers, chassis and rack.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRackManager
Get all added rack manager resources.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRackManager -Name manager1.domain.com -ErrorAction Stop
Get the specified rack manager resource.
Related Links
Add-HPOVRackManager
Top
Get-HPOVRackMember

Get-HPOVRackMember
Get a member device from a defined Rack.
SYNTAX
Get-HPOVRackMember [-InputObject] <String>[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParamete
rs>]
Parameters
Aliases Appliance
Required? false
Position? named
-InputObject <String>
Rack resource from Get-HPOVRack.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Name of a member within the Rack. Supports (*) wildcard character.

Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Facilities.RackMember
The individual rack member resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRack -Name Rack-221 | Get-HPOVRackMember
Retrieve all rack members from the specified rack.

-------------------------- EXAMPLE 2 --------------------------
$Rack = Get-HPOVRack -Name Rack-221

Get-HPOVRackMember -InputObject $Rack -Name ProdDL380*
Retrieve rack members that begin with "ProdDL380" within the "Rack-221" rack resource. ### Related Links * [Remove-
HPOVRackMember](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRackMember) * [Set-
HPOVRackMemberLocation](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRackMemberLocation) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVRackMember
Get a member device from a defined Rack. ### SYNTAX
Get-HPOVRackMember [-InputObject] <String>[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParamete

rs>]
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? true
Position? named
Default value
-Name <String>
Name of a member within the Rack. Supports (*) wildcard character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The individual rack member resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRack -Name Rack-221 | Get-HPOVRackMember
Retrieve all rack members from the specified rack.
-------------------------- EXAMPLE 2 --------------------------
$Rack = Get-HPOVRack -Name Rack-221

Get-HPOVRackMember -InputObject $Rack -Name ProdDL380*
Retrieve rack members that begin with 'ProdDL380' within the 'Rack-221' rack resource.
Related Links
Top

Retrieve appliance Remote Support configuration.
SYNTAX
Get-HPOVRemoteSupport [-ApplianceConnection] <Array> [<CommonParameters>]
Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and
to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote
support.
Eligible devices are Gen8 and newer blades and enclosures. NOTE: Servers must be at iLO 2.1 firmware level or above to be
enabled for remote support
Hewlett Packard Enterprise will contact you to ship a replacement part or send an engineer for devices that are under warranty
or support contract.
Remote support enables Proactive Care services including Proactive Scan reports and Firmware/Software Analysis reports with
recommendations that are based on collected configuration data.
Remote support is secure. No business data is collected, only device-specific configuration and fault data. All communications
are outbound only and use industry standard TLS encryption ensuring confidentiality and integrity of the information.
Once the appliance is configured, it cannot be unauthorized or disabled. Use this Cmdlet to get the appliance"s current Remote
Support configuration. This Cmdlet does not return device collection data or schedules.
Parameters
Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
The setting object with updated parameters.
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Enabled Company AutoEnableDevices MarketingOptIn InsightOnlineEnabled
--------- ------- ------- ----------------- -------------- --------------------
myappliance.domain.com True MyCompany False False False
Returns the existing Remote Support configuration of the appliance. ### Related Links * [Disable-HPOVRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVRemoteSupport) * [Enable-HPOVRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVRemoteSupport) * [Get-HPOVRemoteSupportContact]
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSupport
Retrieve appliance Remote Support configuration. ### SYNTAX
Get-HPOVRemoteSupport [-ApplianceConnection] <Array> [<CommonParameters>]
support.
Once the appliance is configured, it cannot be unauthorized or disabled. Use this Cmdlet to get the appliance's current Remote
Support configuration. This Cmdlet does not return device collection data or schedules.
Parameters
Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Enabled Company AutoEnableDevices MarketingOptIn InsightOnlineEnabled
myappliance.domain.com True MyCompany False False False
Returns the existing Remote Support configuration of the appliance.
Related Links
Top

Retrieve configured Remote Support contacts.
SYNTAX
Get-HPOVRemoteSupportContact[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to get the configured Remote Support contacts defined on the appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Full ("Bob Smith") or partial ("Bob") name of the contact. When using partial names, please include the (asterisk) wildcard
character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The configured Remote Support Contact.
Examples
-------------------------- EXAMPLE 1 --------------------------
List all configured Remote Support Contacts.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRemoteSupportContact -Name "Bob*"
List all contacts with the name Bob, using the * wildcard character. ### Related Links * [New-HPOVRemoteSupportContact]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVRemoteSupportContact) * [Remove-
HPOVRemoteSupportContact](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVRemoteSupportContact) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSupportContact
Retrieve configured Remote Support contacts. ### SYNTAX
Get-HPOVRemoteSupportContact[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to get the configured Remote Support contacts defined on the appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Full ("Bob Smith") or partial ("Bob") name of the contact. When using partial names, please include the (asterisk) wildcard
character.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The configured Remote Support Contact.
Examples
-------------------------- EXAMPLE 1 --------------------------
List all configured Remote Support Contacts.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRemoteSupportContact -Name "Bob"
List all contacts with the name Bob, using the wildcard character.
Related Links
Top

Retrieve Remote Support Schedule settings on an appliance.
SYNTAX
Get-HPOVRemoteSupportDataCollectionSchedule [<CommonParameters>]
Get-HPOVRemoteSupportDataCollectionSchedule[ [-Type] <String>][ [-ApplianceConnection] <Object>] [<CommonParamet

ers>]
Use this Cmdlet to retrieve configured schedules to collect Remote Support logs. There are two defined schedules: Active
Health scheduled on a weekly basis, and Server Basic Configuration scheduled on a monthly basis.
Parameters
Aliases Appliance
Required? false
Position? named
-Type <String>
Specify the schedule type to modify. Allowed value is:
* AHS
*Basic
If no value is provided, both schedules will be returned.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.RemtoeSupport.Schedule [System.Management.Automation.PSCustomObject]
The configured Remote Support data collection schedule.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRemoteSupportDataCollectionSchedule"
Get the Remote Support data collection schedules. ### Related Links * [Set-HPOVRemoteSupportDataCollectionSchedule]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRemoteSupportDataCollectionSchedule) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSupportDataCollectionSchedule
Retrieve Remote Support Schedule settings on an appliance. ### SYNTAX
Get-HPOVRemoteSupportDataCollectionSchedule [<CommonParameters>]
Get-HPOVRemoteSupportDataCollectionSchedule[ [-Type] <String>][ [-ApplianceConnection] <Object>] [<CommonParamet

ers>]
Use this Cmdlet to retrieve configured schedules to collect Remote Support logs. There are two defined schedules: Active
Health scheduled on a weekly basis, and Server Basic Configuration scheduled on a monthly basis.
Parameters
Aliases Appliance
Required? false
Position? named
-Type <String>
* AHS
*Basic
If no value is provided, both schedules will be returned.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.RemtoeSupport.Schedule [System.Management.Automation.PSCustomObject]
The configured Remote Support data collection schedule.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRemoteSupportDataCollectionSchedule"
Get the Remote Support data collection schedules.
Related Links
Top

Retrieve Remote Support Default Site.
SYNTAX
Get-HPOVRemoteSupportDefaultSite[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to retrieve the configured default site.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
Configured Remote Support default site.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the configured Remote Support default site. ### Related Links * [Set-HPOVRemoteSupportDefaultSite]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRemoteSupportDefaultSite) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSupportDefaultSite
Retrieve Remote Support Default Site. ### SYNTAX
Get-HPOVRemoteSupportDefaultSite[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the configured Remote Support default site.
Related Links
Top
Disable Remote Support for a supported resource.
SYNTAX
Get-HPOVRemoteSupportEntitlementStatus [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameter
s>]
This Cmdlet will return the Remote Support entitlement status for a compute or enclosure resource. If remote support has not
been globally enabled and configured on the appliance, this Cmdlet will fail.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.RemoteSupport.ContractAndWarrantyStatus
The object with the current contract and warranty status.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Get-HPOVRemoteSupportEntitlementStatus
Get the servers with their name matching "Prod" and get their Remote Support entitlement status.
-------------------------- EXAMPLE 2 --------------------------

Get-HPOVRemoteSupportEntitlementStatus -InputObject $Enclusre
Get the specific enclosure reousrce and get Remote Support entitlement status. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSupportEntitlementStatus
Disable Remote Support for a supported resource. ### SYNTAX
Get-HPOVRemoteSupportEntitlementStatus [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameter

s>]
This Cmdlet will return the Remote Support entitlement status for a compute or enclosure resource. If remote support has not
been globally enabled and configured on the appliance, this Cmdlet will fail.
Parameters
Aliases Appliance
Required? true
Position? named

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.RemoteSupport.ContractAndWarrantyStatus
The object with the current contract and warranty status.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Get-HPOVRemoteSupportEntitlementStatus
Get the servers with their name matching 'Prod' and get their Remote Support entitlement status.
-------------------------- EXAMPLE 2 --------------------------

Get-HPOVRemoteSupportEntitlementStatus -InputObject $Enclusre
Get the specific enclosure reousrce and get Remote Support entitlement status.
Related Links
Top

Retrieve defined Support and Reseller partners.
SYNTAX
Get-HPOVRemoteSupportPartner[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to retreive defined Remote Support partners that are authorized HPE Resellers and/or Support.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Name of the HPE Partner.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.RemoteSupport.Partner [System.Management.Automation.PSCustomObject]
Defined HPE authorized reseller and/or support partners.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all configured report support partners. ### Related Links * [New-HPOVRemoteSupportPartner]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVRemoteSupportPartner) * [Remove-
HPOVRemoteSupportPartner](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRemoteSupportPartner)
***
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSupportPartner
Retrieve defined Support and Reseller partners. ### SYNTAX
Get-HPOVRemoteSupportPartner[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to retreive defined Remote Support partners that are authorized HPE Resellers and/or Support.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Name of the HPE Partner.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Defined HPE authorized reseller and/or support partners.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all configured report support partners.
Related Links
Top

Get supported resource Remote Support settings.
SYNTAX
Get-HPOVRemoteSupportSetting [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to retrieve a supported resources Remote Support settings, defined Parimary and Secondary contact, and
authorized reseller or support partners.
Parameters

Aliases Appliance
Required? false
Position? named
Either a Server Hardware or Enclosure resource to get the configured Remote Support collection settings.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Server hardware resource object.
Enclosure resource object.
Return Values
HPOneView.Appliance.RemoteSupport.ResourceSetting [System.Management.Automation.PSCustomObject]
Remote Support Settings object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosure -Name Encl1 | Get-HPOVRemoteSupportSetting Appliance ResourceName SalesChannelPar

tner SupportChannelPartner PrimaryContact SecondaryContact --------- ------------ -----
-------------- --------------------- -------------- ---------------- MyAppliance.domain.com Encl1
Hewlett Packard Enterprise Hewlett Packard Enterprise Mark Jones
Get the configured Remote Support collection settings for "Encl1" Enclosure resource.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer -Name PROD* | Get-HPOVRemoteSupportSetting | ? supportEnabled -eq $false
Return all PROD servers, and return only those where remote support is not enabled. ### Related Links * [Set-
HPOVRemoteSupportSetting](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRemoteSupportSetting) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSupportSetting
Get supported resource Remote Support settings. ### SYNTAX
Get-HPOVRemoteSupportSetting [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to retrieve a supported resources Remote Support settings, defined Parimary and Secondary contact, and
authorized reseller or support partners.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types

Return Values
HPOneView.Appliance.RemoteSupport.ResourceSetting [System.Management.Automation.PSCustomObject]
Remote Support Settings object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosure -Name Encl1 | Get-HPOVRemoteSupportSetting
Appliance ResourceName SalesChannelPartner SupportChannelPartner PrimaryContact Seconda

ryContact
MyAppliance.domain.com Encl1 Hewlett Packard Enterprise Hewlett Packard Enterprise Mark Jones
Get the configured Remote Support collection settings for "Encl1" Enclosure resource.
Related Links
Top

Get the configured remote syslog settings.
SYNTAX
Get-HPOVRemoteSyslog [-ApplianceConnection] <Object> [<CommonParameters>]
retrieving the remote syslog configuration.
Parameters

Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.RemoteSyslog [System.Management.Automation.PSCustomObject]
If successful, returns Appliance Syslog settings
System.Collections.ArrayList <HPOneView.RemoteSyslog>
Collection of Appliance Syslog settings
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Destination Port Enabled
--------- ----------- ---- -------
appliance1.domain.com False
appliance2.domain.com 10.150.20.1 514 True
Get the current configuration from all connected appliances.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com

--------- ----------- ---- -------
Get the current configuration from specified connected appliance. ### Related Links * [Disable-HPOVRemoteSyslog]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVRemoteSyslog) * [Enable-HPOVRemoteSyslog]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVRemoteSyslog) * [Set-HPOVRemoteSyslog]
Top
### HPE OneView 4.00 Library ## Get-HPOVRemoteSyslog
Get the configured remote syslog settings. ### SYNTAX

Get-HPOVRemoteSyslog [-ApplianceConnection] <Object> [<CommonParameters>]
retrieving the remote syslog configuration.
Parameters
Aliases Appliance
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.RemoteSyslog [System.Management.Automation.PSCustomObject]
If successful, returns Appliance Syslog settings
System.Collections.ArrayList <HPOneView.RemoteSyslog>
Collection of Appliance Syslog settings
Examples
-------------------------- EXAMPLE 1 --------------------------
appliance2.domain.com 10.150.20.1 514 True
Get the current configuration from all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com

Get the current configuration from specified connected appliance.
Related Links
Top
Get-HPOVReservedVlanRange

Get the reserved VLAN range for HPE Synergy.
SYNTAX
Get-HPOVReservedVlanRange[ [-ApplianceConnection] <Object>] [<CommonParameters>]
By default, HPE Synergy reserves a sepcific VLAN range for Tunnel, untagged and FC networks for HPE Synergy Virtual
Connect. This default range is 3967-4095. The range can be modified using Set-HPOVReservedVlanRange if none of the
specified network resources have been created.
Parameters
Aliases Appliance
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.ReservedVlanRange
The reserved VLAN range object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the defined reserved VLAN range on the connected HPE Synergy appliance.
Related Links
Set-HPOVReservedVlanRange
Top
Get-HPOVRole

Get-HPOVRole
Get role of user.
SYNTAX
Get-HPOVRole [<CommonParameters>]
Deprecated cmdlet as of v2.0. Please use the Get-HPOVUser CMDLET to retrieve User Roles.
Parameters
<CommonParameters>
Input Types
None.
Return Values
None.
Examples
Related Links
Top
### HPE OneView 4.00 Library ## Get-HPOVRole
Get role of user. ### SYNTAX
Get-HPOVRole [<CommonParameters>]
Deprecated cmdlet as of v2.0. Please use the Get-HPOVUser CMDLET to retrieve User Roles. ### Parameters
### Input Types None. ### Return Values None. ### Examples ### Related Links ***
Top
Get-HPOVSanManager

Get-HPOVSanManager
Retrieve SAN Manager resource(s).
SYNTAX
Get-HPOVSanManager[ [-Name] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This cmdlet will return the configured SAN Manager(s).
Parameters
Aliases Appliance
Required? false
Position? 1
-Name <String>
Aliases [-SanManager] Provide the name of the SAN Manager to display.
Aliases SanManager
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Storage.SanManager [System.Management.Automation.PSCustomObject]
Single SAN Manager resource
System.Collections.ArrayList <HPOneView.Storage.SanManager>
Multiple SAN Manager resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSanManager
Name Status State Type Version Managed SANs
---- ------ ----- ---- ------- ------------
bna1.domain.com OK Managed Brocade Network Advisor 12.3.4.5 {Fabric_A, Fabric_B}
bna2.domain.com OK Managed Brocade Network Advisor 12.3.4.5 {Fabric_C, Fabric_D}
Display all SAN Managers. ### Related Links * [Add-HPOVSanManager](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Add-HPOVSanManager) * [Remove-HPOVSanManager](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVSanManager) * [Set-HPOVSanManager](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVSanManager) * [Update-HPOVSanManager](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Update-HPOVSanManager) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVSanManager
Retrieve SAN Manager resource(s). ### SYNTAX
Get-HPOVSanManager[ [-Name] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This cmdlet will return the configured SAN Manager(s).
Parameters
Aliases Appliance
Required? false
Position? 1
-Name <String>
Aliases [-SanManager] Provide the name of the SAN Manager to display.
Aliases SanManager
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Single SAN Manager resource
Multiple SAN Manager resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSanManager
Name Status State Type Version Managed SANs
bna1.domain.com OK Managed Brocade Network Advisor 12.3.4.5 {Fabric_A, Fabric_B}

bna2.domain.com OK Managed Brocade Network Advisor 12.3.4.5 {Fabric_C, Fabric_D}
Display all SAN Managers.
Related Links
Add-HPOVSanManager
Set-HPOVSanManager
Top
Get-HPOVSanZone

Get-HPOVSanZone
View Managed SAN Zones.
SYNTAX
Get-HPOVSanZone[ [-ManagedSan] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This Cmdlet will dispay the Managed SAN Zone details, which include Zone Name, state, status, Managed SAN and Alias
members with their WWN(s). By default, all SAN Zones will be returned. You can filter the results based on Managed SAN
resource.
Parameters
Aliases Appliance
Required? false
Position? named
-ManagedSan <Object>
The Managed SAN Resource Object.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneview.Storage.ManagedSan [System.Management.Automation.PSCustomObject]
Managed SAN resource from Get-HPOVManagedSan
Return Values
HPOneView.Storage.ManagedSan.Zone [System.Management.Automation.PSCustomObject]
Managed SAN Zone resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSanZone
Appliance SAN Name State Status Members
--------- --- ---- ----- ------ -------
appliance SAN1_1 dummy_zone Managed OK
appliance SAN1_1 Node_1_8 Managed OK {Target_ThreePAR72004506_0_2_2, Initiator_Node_1_8, Target_ThreePAR72
004506_1_2_2}
appliance SAN1_0 Node_1_7 Managed OK {Initiator_Node_1_7, Target_ThreePAR72004506_0_2_1, Target_ThreePAR72
004506_1_2_1}
Return all SAN Zones from the appliance(s).

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVManagedSan SAN1_0 | Get-HPOVSanZone

--------- --- ---- ----- ------ -------
004506_1_2_1}
Return the specific SAN Zone for the specified Managed SAN resource from the appliance.
-------------------------- EXAMPLE 3 --------------------------

$Zones = Get-HPOVManagedSan SAN1_0 | Get-HPOVSanZone
$Zones | ? Name -eq "Node_1_7"

--------- --- ---- ----- ------ -------
hpov-tot2 SAN1_0 Node_1_7 Managed OK {Initiator_Node_1_7, Target_ThreePAR72004506_0_2_1, Target_ThreePAR7200
4506_1_2_1}
($Zones | ? Name -eq "Node_1_7").members
Name WWN
---- ---
Initiator_Node_1_7 {10:00:F6:9F:5F:70:00:00}
Target_ThreePAR72004506_0_2_1 {20:00:00:02:AC:00:08:DE}
Target_ThreePAR72004506_1_2_1 {20:00:00:02:AC:00:08:E2}
Get the Zone information from the specific Managed SAN, then display the associated aliases including their WWNs. ###
Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVSanZone
View Managed SAN Zones. ### SYNTAX
Get-HPOVSanZone[ [-ManagedSan] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This Cmdlet will dispay the Managed SAN Zone details, which include Zone Name, state, status, Managed SAN and Alias
members with their WWN(s). By default, all SAN Zones will be returned. You can filter the results based on Managed SAN
resource.
Parameters
Aliases Appliance
Required? false
Position? named
The Managed SAN Resource Object.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneview.Storage.ManagedSan [System.Management.Automation.PSCustomObject]
Return Values
HPOneView.Storage.ManagedSan.Zone [System.Management.Automation.PSCustomObject]
Managed SAN Zone resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSanZone

appliance SAN1_1 Node_1_8 Managed OK {Target_ThreePAR72004506_0_2_2, Initiator_Node_1_8, Target_ThreePAR72
004506_1_2_2}
004506_1_2_1}
Return all SAN Zones from the appliance(s).
-------------------------- EXAMPLE 2 --------------------------


004506_1_2_1}
Return the specific SAN Zone for the specified Managed SAN resource from the appliance.
-------------------------- EXAMPLE 3 --------------------------

$Zones = Get-HPOVManagedSan SAN1_0 | Get-HPOVSanZone
$Zones | ? Name -eq 'Node_1_7'
hpov-tot2 SAN1_0 Node_1_7 Managed OK {Initiator_Node_1_7, Target_ThreePAR72004506_0_2_1, Target_ThreePAR7200

4506_1_2_1}
($Zones | ? Name -eq 'Node_1_7').members
Name WWN
Initiator_Node_1_7 {10:00:F6:9F:5F:70:00:00}
Target_ThreePAR72004506_0_2_1 {20:00:00:02:AC:00:08:DE}
Target_ThreePAR72004506_1_2_1 {20:00:00:02:AC:00:08:E2}
Get the Zone information from the specific Managed SAN, then display the associated aliases including their WWNs.
Related Links
Top
Get-HPOVSasInterconnectType

Retrieve SAS Interconnect Type resource(s).
SYNTAX
Get-HPOVSasInterconnectType [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVSasInterconnectType [-PartNumber] <String> [-ApplianceConnection] <Object> [<CommonParameters>]

Parameters
Aliases Appliance
Required? true
Position? named
-Name <String>
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.SasInterconnectType [System.Management.Automation.PSCustomObject]
Single SAS Interconnect Type resource
System.Collections.ArrayList <HPOneView.Networking.SasInterconnectType>
Multiple SAS Interconnect Type resources or formatted table dispalying basic Interconnect Type information
A SAS Interconnect Type or collection of SAS Interconnect Types.
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all SAS Interconnect Types available from all connected appliances to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSasInterconnectType -name "Synergy 12Gb SAS Connection Module"
Returns just the "Synergy 12Gb SAS Connection Module" SAS Interconnect Type object to standard output. ### Related Links
***
Top
### HPE OneView 4.00 Library ## Get-HPOVSasInterconnectType
Retrieve SAS Interconnect Type resource(s). ### SYNTAX
Get-HPOVSasInterconnectType [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVSasInterconnectType [-PartNumber] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Parameters
Aliases Appliance
Required? true
Position? named
-Name <String>
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.SasInterconnectType [System.Management.Automation.PSCustomObject]
Single SAS Interconnect Type resource
System.Collections.ArrayList <HPOneView.Networking.SasInterconnectType>
Multiple SAS Interconnect Type resources or formatted table dispalying basic Interconnect Type information
A SAS Interconnect Type or collection of SAS Interconnect Types.
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all SAS Interconnect Types available from all connected appliances to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSasInterconnectType -name "Synergy 12Gb SAS Connection Module"
Returns just the 'Synergy 12Gb SAS Connection Module' SAS Interconnect Type object to standard output.
Related Links
Top
Get-HPOVSasLogicalInterconnect

Retrieve SAS Logical Interconnect resource(s).
SYNTAX
Get-HPOVSasLogicalInterconnect[ [-Name] <String>][ [-Label] <String>] [-ApplianceConnection] <Object> [-Export]
<String> [<CommonParameters>]
Retrieves a list of all SAS Logical Interconnect or just specific ones via a query if the name parameter is provided. The output
Parameters
Aliases Appliance
Required? true
Position? named
-Export <String>
Required? true
Position? named
Default value

-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the SAS Logical Interconnect to retrieve.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPoneView.Storage.SasLogicalInterconnect [System.Management.Automation.PSCustomObject]
System.Collections.ArrayList <HPoneView.Storage.SasLogicalInterconnect>
A SAS Logical Interconnect or collection of SAS Logical Interconnects
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all SAS Logical Interconnect defined on the appliance to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSasLogicalInterconnect -Name "LE1-SasProduction" -ErrorAction Stop
Returns just the specific SAS Logical Interconnect object to standard output. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVSasLogicalInterconnect
Retrieve SAS Logical Interconnect resource(s). ### SYNTAX
Get-HPOVSasLogicalInterconnect[ [-Name] <String>][ [-Label] <String>] [-ApplianceConnection] <Object> [-Export]

<String> [<CommonParameters>]
Retrieves a list of all SAS Logical Interconnect or just specific ones via a query if the name parameter is provided. The output
Parameters
Aliases Appliance
Required? true
Position? named
-Export <String>
Required? true
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the SAS Logical Interconnect to retrieve.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPoneView.Storage.SasLogicalInterconnect [System.Management.Automation.PSCustomObject]
System.Collections.ArrayList <HPoneView.Storage.SasLogicalInterconnect>
A SAS Logical Interconnect or collection of SAS Logical Interconnects
Examples
-------------------------- EXAMPLE 1 --------------------------
Returns all SAS Logical Interconnect defined on the appliance to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSasLogicalInterconnect -Name "LE1-SasProduction" -ErrorAction Stop
Returns just the specific SAS Logical Interconnect object to standard output.
Related Links
Top
Get-HPOVScmbCertificates

Get State Change Message Bus certificates.
SYNTAX
Get-HPOVScmbCertificates [-Location] <String>[ [-InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnectio
n] <Array> [<CommonParameters>]
Get-HPOVScmbCertificates [-Password] <SecureString> [-Location] <String>[ [-ConvertToPFx] <SwitchParameter>][ [-

InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParameters>]
Retrieve and store the certificates necessary to register with the State Change Message Bus. The SCMB only supports a single
read-only "account".
Parameters
Aliases Appliance
Required? true
Position? named
-ConvertToPFx <SwitchParameter>
Aliases [-pfx]
Convert rabbitmq_readonly client certificate to PFX format for .Net consumption.
Aliases pfx
Required? false
Position? named
Default value False

-InstallApplianceRootCA <SwitchParameter>
hoose to install the appliance root certificate to the current users Trusted Root Authorities store.
Aliases None
Required? false
Position? named
Default value
-Location <String>
Aliases [-Save] Directory to store the SSL certificates. If the directory doesn"t exist, it will be created.
Aliases save
Required? true
Position? named
Default value ($pwd).path
-Password <SecureString>
Password that will be used to encrypt the PFX client certificate.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
SecureString
Password for PFX file
Return Values
3 files will be created:
{ApplianceConnection_Name}_ca.cer - Appliance internal Root Certificate Authority

{ApplianceConnection_Name}_cert.cer - Appliance managed rabbitmq_readonly user Public Key
{ApplianceConnection_Name}_privateKey.key - Appliance managed rabbitmq_readonly user Client Certificate
Pkcs12/PFX certificate file
If ConvertToPfX is used, the Pkcs12/PFX compliant certificate file is created, {ApplianceConnection_Name}_privateKey.pfx
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the HPE OneView appliance SCMB SSL certificates, and save them in the current directory.
-------------------------- EXAMPLE 2 --------------------------
read-host "Password" -AsSecureString | Get-HPOVScmbCertificates -Location C:\scmbcerts -ExportToPfx
Prompt for secure password input and pipe the value to Get-HPOVScmbCertificates to convert the cert.pem to PFX format with
the pipeline secure password. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVScmbCertificates
Get State Change Message Bus certificates. ### SYNTAX
Get-HPOVScmbCertificates [-Location] <String>[ [-InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnectio

n] <Array> [<CommonParameters>]
Get-HPOVScmbCertificates [-Password] <SecureString> [-Location] <String>[ [-ConvertToPFx] <SwitchParameter>][ [-

InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParameters>]
Retrieve and store the certificates necessary to register with the State Change Message Bus. The SCMB only supports a single
read-only "account".
Parameters
Aliases Appliance
Required? true
Position? named
-ConvertToPFx <SwitchParameter>
Aliases [-pfx]
Convert rabbitmq_readonly client certificate to PFX format for .Net consumption.
Aliases pfx
Required? false
Position? named
Default value False
-InstallApplianceRootCA <SwitchParameter>
hoose to install the appliance root certificate to the current users Trusted Root Authorities store.
Aliases None
Required? false
Position? named
Default value
-Location <String>
Aliases [-Save] Directory to store the SSL certificates. If the directory doesn't exist, it will be created.
Aliases save
Required? true
Position? named
Default value ($pwd).path
Password that will be used to encrypt the PFX client certificate.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
SecureString
Password for PFX file
Return Values
3 files will be created:
{ApplianceConnection_Name}_ca.cer - Appliance internal Root Certificate Authority
{ApplianceConnection_Name}_cert.cer - Appliance managed rabbitmq_readonly user Public Key
{ApplianceConnection_Name}_privateKey.key - Appliance managed rabbitmq_readonly user Client Certificate
Pkcs12/PFX certificate file
If ConvertToPfX is used, the Pkcs12/PFX compliant certificate file is created, {ApplianceConnection_Name}_privateKey.pfx
Examples
-------------------------- EXAMPLE 1 --------------------------
Get the HPE OneView appliance SCMB SSL certificates, and save them in the current directory.
-------------------------- EXAMPLE 2 --------------------------
read-host 'Password' -AsSecureString | Get-HPOVScmbCertificates -Location C:\scmbcerts -ExportToPfx
Prompt for secure password input and pipe the value to Get-HPOVScmbCertificates to convert the cert.pem to PFX format with
the pipeline secure password.
Related Links
Top
Get-HPOVScope

Get-HPOVScope
Get Scope resource(s)
SYNTAX
Get-HPOVScope[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
A scope is a grouping of resources that can be used to restrict the range of an operation or action. For example, you can create
scopes based on:
* Organizations (Marketing, Research and Development, Finance)
* Usage (Production, Development, Testing)
* Skills (Linux, Windows)
The resources are arranged by categories. All the resources in these categories can be added to or removed from a scope:
* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
When scopes are defined and resources assigned to them, you can:
* Restrict your view of the user interface (UI) to the resources in the scope.
* Filter email notifications for alerts based on the scope of the associated resources.
Returned Scope object(s) will contain a collection of associated resources.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Name of the scope to return.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Collection of Appliance Scope resource objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVScope
List all available scopes on the connected default appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVScope -Name MyFinanceScope
Return the "MyFinanceScope" scope resource from the conncted default appliance.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVScope -Name My* -ApplianceConnection $ConnectedSessions
Use wildcard search for a specific scope on all connected appliances. ### Related Links * [New-HPOVScope]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVScope) * [Remove-HPOVScope]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVScope) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVScope
Get Scope resource(s) ### SYNTAX
Get-HPOVScope[ [-Name] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
scopes based on:

* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
Returned Scope object(s) will contain a collection of associated resources.
Parameters
Aliases Appliance
Required? false
Position? named
-Name <String>
Name of the scope to return.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Collection of Appliance Scope resource objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVScope
List all available scopes on the connected default appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVScope -Name MyFinanceScope
Return the 'MyFinanceScope' scope resource from the conncted default appliance.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVScope -Name My* -ApplianceConnection $ConnectedSessions
Use wildcard search for a specific scope on all connected appliances.
Related Links
New-HPOVScope
Remove-HPOVScope
Top
Get-HPOVServer

Get-HPOVServer
Retrieve Server Hardware resource(s).
SYNTAX
Get-HPOVServer[ [-Name] <String>][ [-ServerName] <String>][ [-NoProfile] <SwitchParameter>][ [-InputObject] <Obj
ect>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain a collection of server hardware resources, a specific server with the specified name, or server hardware resources
without an assigned Server Profile. Returned resources will display:
* Device Name
* Serial Number
* Model
* System ROM
* iLO and its firmware
* Server Profile
* Status
* Licensing
Parameters
Aliases Appliance
Required? false
Position? named
Aliases [-ServerHardwareType, -ServerProfileTemplate] Provide the Server Hardware Type or Server Profile Template Object to
filter for available server hardware.
Aliases ServerHardwareType, ServerProfileTemplate
Required? false
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the server hardware resource to be returned. All server hardware resources will be returned if omitted. Supports *
wildcard character.
Aliases None
Required? false
Position? named
Default value
-NoProfile <SwitchParameter>
Optional parameter that can be used with the report parameter to display Servers without a Server Profile assigned.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-ServerName <String>
Specify the Server OS Name that is reported by the iLO.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.ServerHardwareType [System.Management.Automation.PSCustomObject]
Server Hardware Type resource object.
HPOneView.ServerProfileTemplate [System.Management.Automation.PSCustomObject]
Server Profile Template resource object.
Return Values
Single Server Hardware resource
Multiple Server Hardware resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer
Name Status Power Serial Number Model ROM iLO Server Profile License
---- ------ ----- ------------- ----- --- --- -------------- -------
172.18.6.15 Disabled Off MXQ1000207 DL360p Gen8 P71 02/10/2014 iLO4 2.03 No Profile OneViewNoiL
O
172.18.6.16 Unknown Unknown MXQ1000307 DL380p Gen8 No Profile OneViewNoiL
O
172.18.6.31 Disabled Off MXQ1000208 DL360 Gen9 P89 07/11/2014 iLO4 2.03 No Profile OneViewNoiL
O
O
Encl1, bay 1 OK Off SGH100X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 Server Profile 1 OneView
Encl1, bay 12 Disabled Off SGH101X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView
Encl1, bay 2 OK Off SGH101X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 My Profile OneView
Return all the server hardware managed by this appliance.
-------------------------- EXAMPLE 2 --------------------------
$bay1 = Get-HPOVServer -Name "Encl1, bay 1"
Return the server hardware resource with name "Encl1, bay 1".
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServer -NoProfile
---- ------ ----- ------------- ----- --- --- -------------- -------
172.18.6.15 Disabled Off MXQ1000207 DL360p Gen8 P71 02/10/2014 iLO4 2.03 No Profile OneViewNoiLO
172.18.6.16 Unknown Unknown MXQ1000307 DL380p Gen8 No Profile OneViewNoiLO
172.18.6.31 Disabled Off MXQ1000208 DL360 Gen9 P89 07/11/2014 iLO4 2.03 No Profile OneViewNoiLO
Display all server hardware resources without an assigned Server Profile.

-------------------------- EXAMPLE 4 --------------------------
$sht = Get-HPOVServerHardwareType -Name "BL460c Gen9 1"

$AvailableServer = Get-HPOVServer -NoProfile -ServerHardwareType $sht | Select -first 1
Return the first available server hardware of the Server Hardware Type requested.
-------------------------- EXAMPLE 5 --------------------------
$AvailableServer = Get-HPOVServerProfileTemplate -Name "My Template 1" | Get-HPOVServer -NoProfile | Select -fir
st 1
Return the first available server hardware designed for the specific Server Profile Template. ### Related Links * [Add-
HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVServer) * [Convert-HPOVServerProfile]
HPOVServerProfile) * [Get-HPOVServerHardwareType](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVServerHardwareType) * [Get-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
Top
### HPE OneView 4.00 Library ## Get-HPOVServer
Retrieve Server Hardware resource(s). ### SYNTAX
Get-HPOVServer[ [-Name] <String>][ [-ServerName] <String>][ [-NoProfile] <SwitchParameter>][ [-InputObject] <Obj

ect>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Obtain a collection of server hardware resources, a specific server with the specified name, or server hardware resources
without an assigned Server Profile. Returned resources will display:
* Device Name
* Serial Number
* Model
* System ROM
* iLO and its firmware
* Server Profile
* Status
* Licensing
Parameters
Aliases Appliance
Required? false
Position? named
Aliases [-ServerHardwareType, -ServerProfileTemplate] Provide the Server Hardware Type or Server Profile Template Object to
filter for available server hardware.
Aliases ServerHardwareType, ServerProfileTemplate
Required? false
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The name of the server hardware resource to be returned. All server hardware resources will be returned if omitted. Supports *
wildcard character.
Aliases None
Required? false
Position? named
Default value
-NoProfile <SwitchParameter>
Optional parameter that can be used with the report parameter to display Servers without a Server Profile assigned.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-ServerName <String>
Specify the Server OS Name that is reported by the iLO.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Server Hardware Type resource object.
Return Values
Single Server Hardware resource

Multiple Server Hardware resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer
172.18.6.15 Disabled Off MXQ1000207 DL360p Gen8 P71 02/10/2014 iLO4 2.03 No Profile OneViewNoiL
O
O
172.18.6.31 Disabled Off MXQ1000208 DL360 Gen9 P89 07/11/2014 iLO4 2.03 No Profile OneViewNoiL
O
O
Encl1, bay 2 OK Off SGH101X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 My Profile OneView
Return all the server hardware managed by this appliance.
-------------------------- EXAMPLE 2 --------------------------
$bay1 = Get-HPOVServer -Name "Encl1, bay 1"
Return the server hardware resource with name "Encl1, bay 1".
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServer -NoProfile
172.18.6.15 Disabled Off MXQ1000207 DL360p Gen8 P71 02/10/2014 iLO4 2.03 No Profile OneViewNoiLO
172.18.6.31 Disabled Off MXQ1000208 DL360 Gen9 P89 07/11/2014 iLO4 2.03 No Profile OneViewNoiLO
Display all server hardware resources without an assigned Server Profile.
-------------------------- EXAMPLE 4 --------------------------
$sht = Get-HPOVServerHardwareType -Name "BL460c Gen9 1"

$AvailableServer = Get-HPOVServer -NoProfile -ServerHardwareType $sht | Select -first 1
Return the first available server hardware of the Server Hardware Type requested.
-------------------------- EXAMPLE 5 --------------------------
$AvailableServer = Get-HPOVServerProfileTemplate -Name "My Template 1" | Get-HPOVServer -NoProfile | Select -fir
st 1
Return the first available server hardware designed for the specific Server Profile Template.
Related Links
Add-HPOVServer
Remove-HPOVServer
Restart-HPOVServer
Set-HPOVServerPower
Start-HPOVServer
Stop-HPOVServer
Update-HPOVServer
Top

Retrieve Server Hardware Type resource(s).
SYNTAX
Get-HPOVServerHardwareType[ [-Name] <String>][ [-Model] <String>][ [-ApplianceConnection] <Array>][ [-exportFile
] <String>] [<CommonParameters>]
Obtain a collection of server hardware types. This includes information about the type of server, adapter layout and features,
and possible server BIOS settings. This cmdlet is also used with the New-HPOVServerProfile cmdlet to retrieve the list of BIOS
settings and adapters to configure.
Parameters
Aliases Appliance
Required? false
Position? named
-Model <String>
Filter based on Model name. Supports wildcard search.
Aliases None
Required? false
Position? named
Default value
-Name <String>
The name of the server hardware type resource to be returned. All server hardware type resources will be returned if omitted.
Aliases None
Required? false
Position? named
Default value
The path where the resource will be exported to, in JSON text format.
Aliases x, export
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single Server Hardware type
Multiple Server Hardware types
Examples
-------------------------- EXAMPLE 1 --------------------------
$sht = Get-HPOVServerHardwareType
Return all the server hardware types on the appliance.

-------------------------- EXAMPLE 2 --------------------------
$shtBL460Gen81 = Get-HPOVServerHardwareType -name "BL460 Gen8 1"
Return the "BL460 Gen8 1" server hardware type on the appliance. ### Related Links * [Set-HPOVServerHardwareType]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerHardwareType) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVServerHardwareType
Retrieve Server Hardware Type resource(s). ### SYNTAX
Get-HPOVServerHardwareType[ [-Name] <String>][ [-Model] <String>][ [-ApplianceConnection] <Array>][ [-exportFile

] <String>] [<CommonParameters>]
Obtain a collection of server hardware types. This includes information about the type of server, adapter layout and features,
and possible server BIOS settings. This cmdlet is also used with the New-HPOVServerProfile cmdlet to retrieve the list of BIOS
settings and adapters to configure.
Parameters
Aliases Appliance
Required? false
Position? named
-Model <String>
Filter based on Model name. Supports wildcard search.
Aliases None
Required? false
Position? named
Default value
-Name <String>
The name of the server hardware type resource to be returned. All server hardware type resources will be returned if omitted.
Aliases None
Required? false
Position? named
Default value
The path where the resource will be exported to, in JSON text format.
Aliases x, export
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single Server Hardware type
Multiple Server Hardware types
Examples
-------------------------- EXAMPLE 1 --------------------------
$sht = Get-HPOVServerHardwareType
Return all the server hardware types on the appliance.
-------------------------- EXAMPLE 2 --------------------------
$shtBL460Gen81 = Get-HPOVServerHardwareType -name "BL460 Gen8 1"
Return the "BL460 Gen8 1" server hardware type on the appliance.
Related Links
Top


Retrieve Server Profile resource(s).
SYNTAX
Get-HPOVServerProfile [-Name] <String>[ [-NonCompliant] <SwitchParameter>][ [-Unassigned] <SwitchParameter>][ [-
InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameter
s>]
Get-HPOVServerProfile[ [-export] <SwitchParameter>] [-location] <String> [-Name] <String>[ [-Unassigned] <Switch

Parameter>][ [-InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<
CommonParameters>]
Get-HPOVServerProfile[ [-Detailed] <SwitchParameter>] [-Name] <String>[ [-Label] <String>][ [-Scope] <Object>] [

-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will obtain a collection of Server Profile resources, or a specific Server Profile the specified name. It returns all
aspects of the Server Profile.
This will also provide the ability to export Server Profile objects to their own JSON encoded file. All appliance unique properties
(minus the Server Hardware Type, Enclosure Group, and Connection Network assignment) are removed. Connection layout,
assigned addresses, networks, bandwidth, BIOS, Boot Order, Firmware settings will all be retained. Assigned Address types will
change from Virtual to UserDefined in order to retain their assignment.
Parameters
Aliases Appliance
Required? true
Position? named
-Detailed <SwitchParameter>
Display detailed report list of Server Profiles
Aliases None
Required? false
Position? named
Default value False
Profile a Server Hardware or Server Profile Template resource, and the associated Server Hardware will be returned.
Aliases None
Required? false
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases [-profile] The name of the server profile resource to be returned. All server profile resources will be returned if omitted.
Supports * wildcard character.
Aliases profile
Required? true
Position? named
Default value
Return collection of Server Profiles that are not compliant with their template. Will not return Server Profiles that have no
Template association.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-Unassigned <SwitchParameter>
Optional parameter that can be included with the List switch parameter to only display unassigned Server Profiles. Can also be
combined with the name parameter for Server Profile wildcard name search.
Aliases None
Required? false
Position? named
Default value False
-export <SwitchParameter>
Aliases [-x] Switch used to export Server Profile object to JSON encoded file.
Aliases x
Required? false
Position? named
Default value False
-location <String>
Aliases [-save] Location where to save the Server Profile
Aliases save
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Profile Name Managing BIOS Managing Firmware Assigned State
------------ ------------- ----------------- -------- -----
Copy of test 2 False False Unassigned Normal
Profile 11 True True Encl1, bay 11 Normal
Profile 12 False False Encl1, bay 12 Normal
Test 1 False False Unassigned Normal
test 2 False False Encl1, bay 3 Normal
test 3 False False Unassigned Normal
Generate a list of all server profiles.

-------------------------- EXAMPLE 2 --------------------------
$profile = Get-HPOVServerProfile -Name "SA"
Return the server profile resource with name "SA".

-------------------------- EXAMPLE 3 --------------------------
$profiles = Get-HPOVServerProfile -Name profile*
Return server profile resources that match "profile*".

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServerProfile -name "test 1" -list

------------ ------------- ----------------- -------- -----
Generate a report of a specific server profile.

-------------------------- EXAMPLE 5 --------------------------
Get-HPOVServerProfile -unassigned
------------ ------------- ----------------- -------- -----
Generate a list of all Unassigned server profiles.

-------------------------- EXAMPLE 6 --------------------------
Get-HPOVServerProfile -export -location c:\profiles
Save all Server Profile objects to their own backup file to C:\profiles.
-------------------------- EXAMPLE 7 --------------------------
Get-HPOVServerProfile -name Profile1 -export -location c:\profiles
Save Profile1 Server Profile object to its own backup file in C:\profiles. ### Related Links * [Convert-HPOVServerProfile]
Top
### HPE OneView 4.00 Library ## Get-HPOVServerProfile
Retrieve Server Profile resource(s). ### SYNTAX
Get-HPOVServerProfile [-Name] <String>[ [-NonCompliant] <SwitchParameter>][ [-Unassigned] <SwitchParameter>][ [-

InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<CommonParameter
s>]
Get-HPOVServerProfile[ [-export] <SwitchParameter>] [-location] <String> [-Name] <String>[ [-Unassigned] <Switch

Parameter>][ [-InputObject] <Object>][ [-Label] <String>][ [-Scope] <Object>] [-ApplianceConnection] <Object> [<
CommonParameters>]
Get-HPOVServerProfile[ [-Detailed] <SwitchParameter>] [-Name] <String>[ [-Label] <String>][ [-Scope] <Object>] [

-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will obtain a collection of Server Profile resources, or a specific Server Profile the specified name. It returns all
aspects of the Server Profile.
This will also provide the ability to export Server Profile objects to their own JSON encoded file. All appliance unique properties
(minus the Server Hardware Type, Enclosure Group, and Connection Network assignment) are removed. Connection layout,
assigned addresses, networks, bandwidth, BIOS, Boot Order, Firmware settings will all be retained. Assigned Address types will
change from Virtual to UserDefined in order to retain their assignment.
Parameters
Aliases Appliance
Required? true
Position? named
Display detailed report list of Server Profiles
Aliases None
Required? false
Position? named
Default value False
Profile a Server Hardware or Server Profile Template resource, and the associated Server Hardware will be returned.
Aliases None
Required? false
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False

-Name <String>
Aliases [-profile] The name of the server profile resource to be returned. All server profile resources will be returned if omitted.
Supports * wildcard character.
Aliases profile
Required? true
Position? named
Default value
Return collection of Server Profiles that are not compliant with their template. Will not return Server Profiles that have no
Template association.
Aliases None
Required? false
Position? named
Default value False
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
Optional parameter that can be included with the List switch parameter to only display unassigned Server Profiles. Can also be
combined with the name parameter for Server Profile wildcard name search.
Aliases None
Required? false
Position? named
Default value False
-export <SwitchParameter>
Aliases [-x] Switch used to export Server Profile object to JSON encoded file.
Aliases x
Required? false
Position? named
Default value False
-location <String>
Aliases [-save] Location where to save the Server Profile
Aliases save
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

Profile 11 True True Encl1, bay 11Normal
Profile 12 False False Encl1, bay 12Normal
test 2 False False Encl1, bay 3 Normal
-------------------------- EXAMPLE 2 --------------------------
$profile = Get-HPOVServerProfile -Name "SA"
Return the server profile resource with name "SA".
-------------------------- EXAMPLE 3 --------------------------
$profiles = Get-HPOVServerProfile -Name profile
Return server profile resources that match 'profile'.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServerProfile -name 'test 1' -list

Generate a report of a specific server profile.

-------------------------- EXAMPLE 5 --------------------------
Get-HPOVServerProfile -unassigned

Generate a list of all Unassigned server profiles.
-------------------------- EXAMPLE 6 --------------------------
Get-HPOVServerProfile -export -location c:\profiles
Save all Server Profile objects to their own backup file to C:\profiles.
-------------------------- EXAMPLE 7 --------------------------
Get-HPOVServerProfile -name Profile1 -export -location c:\profiles
Save Profile1 Server Profile object to its own backup file in C:\profiles.
Related Links
Top

Retrieve Server Profile Connections
SYNTAX
Get-HPOVServerProfileConnectionList [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Obtain a formatted list of server profile connection IDs, include hardware address, device mapping, and boot settings.
Parameters
Aliases Appliance
Required? true
Position? 1
-Name <String>
The name of the server profile resource to be returned. All server profile resources will be returned if name is omitted.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Formatted table of Server Profile Connections
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfileConnectionList "test"
serverProfile portId cid networkType macAddress wwpn boot arrayTarget lun
------------- -------- --- ----------- ---------- ---- ---- ----------- ---
test Flb 1:1-a 1 Ethernet 36:37:6B:90:00:08 1000378079e00011 Primary

test Flb 1:1-b 2 Ethernet 36:37:6B:90:00:06 1000378079e0000d Secondary
List Server Profile connections for Test. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVServerProfileConnectionList
Retrieve Server Profile Connections ### SYNTAX
Get-HPOVServerProfileConnectionList [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Obtain a formatted list of server profile connection IDs, include hardware address, device mapping, and boot settings.
Parameters
Aliases Appliance
Required? true
Position? 1

-Name <String>
The name of the server profile resource to be returned. All server profile resources will be returned if name is omitted.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Formatted table of Server Profile Connections
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfileConnectionList "test"
serverProfile portId cid networkType macAddress wwpn boot arrayTarget lun
test Flb 1:1-a 1 Ethernet 36:37:6B:90:00:08 1000378079e00011 Primary

test Flb 1:1-b 2 Ethernet 36:37:6B:90:00:06 1000378079e0000d Secondary
List Server Profile connections for Test.
Related Links
Top

Display Server Profile alert messages.
SYNTAX
Get-HPOVServerProfileMessage [-ServerProfile] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
Use this Cmdlet to display alert or other activity messages that are not tracked as Alerts or Tasks. For instance, failed
Connection will be reported as a Server Profile Message. Firmware update status (using HPSUT) wil be displayed as messages.
Parameters
Aliases Appliance
Required? true
Position? named
-ServerProfile <Object>
The Server Profile resource object.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Server Profile resource object from Get-HPOVServerProfile

Return Values
HPOneView.ServerProfileMessage [System.Management.Automation.PSCustomObject]
Server Profile message object.
System.Collections.ArrayList <HPOneView.ServerProfileMessage>
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile MyProfile | Get-HPOVServerProfileMessage
Display the Server Profile messages for the provided resource. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVServerProfileMessage
Display Server Profile alert messages. ### SYNTAX
Get-HPOVServerProfileMessage [-ServerProfile] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
Use this Cmdlet to display alert or other activity messages that are not tracked as Alerts or Tasks. For instance, failed
Connection will be reported as a Server Profile Message. Firmware update status (using HPSUT) wil be displayed as messages.
Parameters
Aliases Appliance
Required? true
Position? named
The Server Profile resource object.
Aliases None
Required? true
Position? named
Default value

<CommonParameters>
Input Types
Return Values
HPOneView.ServerProfileMessage [System.Management.Automation.PSCustomObject]
System.Collections.ArrayList <HPOneView.ServerProfileMessage>
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile MyProfile | Get-HPOVServerProfileMessage
Display the Server Profile messages for the provided resource.
Related Links
Top

Retrieve Server Profile Template resource(s).
SYNTAX
Get-HPOVServerProfileTemplate[ [-Name] <String>][ [-ServerHardwareType] <String>][ [-Label] <String>][ [-Scope]
<Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVServerProfileTemplate[ [-Export] <SwitchParameter>][ [-Location] <String>][ [-Name] <String>][ [-ServerH

ardwareType] <String>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParamet
ers>]
Get-HPOVServerProfileTemplate[ [-Detailed] <SwitchParameter>][ [-Name] <String>][ [-ServerHardwareType] <String>

][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will obtain a collection of Server Profile Template resources, or a specific Server Profile Template with the specified
name. It returns all aspects of the Server Profile Template.
This will also provide the ability to export Server Profile Template objects to their own JSON encoded file. All appliance unique
properties (minus the Server Hardware Type, Enclosure Group, and Connection Network assignment) are removed. Connection
layout, assigned addresses, networks, bandwidth, BIOS, Boot Order, Firmware settings will all be retained. Assigned Address
types will change from Virtual to UserDefined in order to retain their assignment.
Parameters
Aliases Appliance
Required? false
Position? named
Displays detailed information about the Server Profile Template in tabular format
Aliases None
Required? false
Position? named
Default value False
Aliases [-x] Switch used to export Server Profile Template object to JSON encoded file.
Aliases x
Required? false
Position? named
Default value False
-Label <String>

Aliases None
Required? false
Position? named
Default value False
-Location <String>
Aliases [-save] Location where to save the Server Profile Template file.
Aliases save
Required? false
Position? named
Default value
-Name <String>
The name of the specific Server Profile Template resource to retrieve
Aliases profile
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-ServerHardwareType <String>
Provide the Server Hardware Type resource object or name to return Server Profile Templates designed for it.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
None
Return Values
Server Profile template resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$templates = Get-HPOVServerProfileTemplate
Return all the server profile templates managed by the appliance.

-------------------------- EXAMPLE 2 --------------------------
$template = Get-HPOVServerProfileTemplate "SA"
Return the server profile template resource with name "SA".

-------------------------- EXAMPLE 3 --------------------------
$profiletemplates = Get-HPOVServerProfileTemplate profile*
Return server profile template resources that match "profile*".

-------------------------- EXAMPLE 4 --------------------------
------------ ------------- ----------------- -------- -----

-------------------------- EXAMPLE 5 --------------------------
Get-HPOVServerProfileTemplate -name "test 1"

------------ ------------- ----------------- -------- -----
Show a specific Server Profile Template, "test 1".

-------------------------- EXAMPLE 6 --------------------------
Get-HPOVServerProfileTemplate -export -location c:\profiles
Save all Server Profile Template objects to their own backup file to C:\profiles.
-------------------------- EXAMPLE 7 --------------------------
Get-HPOVServerProfileTemplate -name Profile1 -export -location c:\profiles
Save Profile1 Server Profile template object to its own backup file in C:\pro ### Related Links * [Convert-
HPOVServerProfileTemplate) * [New-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVServerProfileTemplate) * [Remove-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProfileTemplate) * [Save-
HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfileTemplate) *
[Set-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfileTemplate)
***
Top
### HPE OneView 4.00 Library ## Get-HPOVServerProfileTemplate
Retrieve Server Profile Template resource(s). ### SYNTAX
Get-HPOVServerProfileTemplate[ [-Name] <String>][ [-ServerHardwareType] <String>][ [-Label] <String>][ [-Scope]

<Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVServerProfileTemplate[ [-Export] <SwitchParameter>][ [-Location] <String>][ [-Name] <String>][ [-ServerH

ardwareType] <String>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParamet
ers>]
Get-HPOVServerProfileTemplate[ [-Detailed] <SwitchParameter>][ [-Name] <String>][ [-ServerHardwareType] <String>

][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will obtain a collection of Server Profile Template resources, or a specific Server Profile Template with the specified
name. It returns all aspects of the Server Profile Template.
This will also provide the ability to export Server Profile Template objects to their own JSON encoded file. All appliance unique
properties (minus the Server Hardware Type, Enclosure Group, and Connection Network assignment) are removed. Connection
layout, assigned addresses, networks, bandwidth, BIOS, Boot Order, Firmware settings will all be retained. Assigned Address
types will change from Virtual to UserDefined in order to retain their assignment.
Parameters

Aliases Appliance
Required? false
Position? named
Displays detailed information about the Server Profile Template in tabular format
Aliases None
Required? false
Position? named
Default value False
Aliases [-x] Switch used to export Server Profile Template object to JSON encoded file.
Aliases x
Required? false
Position? named
Default value False
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Location <String>
Aliases [-save] Location where to save the Server Profile Template file.
Aliases save
Required? false
Position? named
Default value
-Name <String>
The name of the specific Server Profile Template resource to retrieve
Aliases profile
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-ServerHardwareType <String>
Provide the Server Hardware Type resource object or name to return Server Profile Templates designed for it.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
None
Return Values
Server Profile template resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$templates = Get-HPOVServerProfileTemplate
Return all the server profile templates managed by the appliance.
-------------------------- EXAMPLE 2 --------------------------
$template = Get-HPOVServerProfileTemplate "SA"
Return the server profile template resource with name "SA".
-------------------------- EXAMPLE 3 --------------------------
$profiletemplates = Get-HPOVServerProfileTemplate profile
Return server profile template resources that match 'profile'.
-------------------------- EXAMPLE 4 --------------------------

-------------------------- EXAMPLE 5 --------------------------
Get-HPOVServerProfileTemplate -name 'test 1'

Show a specific Server Profile Template, 'test 1'.

-------------------------- EXAMPLE 6 --------------------------
Get-HPOVServerProfileTemplate -export -location c:\profiles
Save all Server Profile Template objects to their own backup file to C:\profiles.
-------------------------- EXAMPLE 7 --------------------------
Get-HPOVServerProfileTemplate -name Profile1 -export -location c:\profiles
Save Profile1 Server Profile template object to its own backup file in C:\pro
Related Links
Top
Get-HPOVServiceAlert

Generate report of HPE OneView Remote Support service events.
SYNTAX
Get-HPOVServiceAlert[ [-InputObject] <Object>][ [-State] <String>][ [-Count] <int>][ [-TimeSpan] <TimeSpan>][ [-
Start] <DateTime>][ [-End] <DateTime>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
HPE OneView automatically checks if your hardware has a valid entitlement to Hewlett Packard Enterprise support. A valid
entitlement is a Hewlett Packard Enterprise warranty or an active contract. If a valid entitlement to support is found, HPE
OneView Remote Support opens a support case for a hardware failure. This Cmdlet allows administrators to display and/or
export service events logged by the HPE OneView appliance.
Parameters
Aliases Appliance
Required? False
Position? named
-Count <int>
Specify the number of service alerts to return.
Aliases None
Required? false
Position? named
Default value
-End <DateTime>
DateTime object of the end date and time accompanied with the -Start parameter. If omitted, the current time of the PC is used.
Aliases None
Required? false
Position? named
Default value
Use to filter for the supported hardware resource object. Enclosures, Server Hardware and Server Profile objects are supported.
If an Enclosure resource is provided, only the Enclousre service events are queried. Associated Server Hardare within the
enclosure is not. If providing a Server Profile object, it must be assigned to a supported hardware platform. If the Server Profile
has moved between hardware resources, only the currently assigned server hardware resource object will be used to query for
service events.
Aliases None
Required? false
Position? named
Default value
-Start <DateTime>
DateTime object of the start date and time to being query.
Aliases None
Required? false
Position? named
Default value
-State <String>
Specify the state of the Service Alert. The state is not correlated to the associated Alert.
* Closed - The state of Service event when the service call is closed.
* Error - The Service request has some error None This is a default state.
* Open - The state of Service event when the service call is open.
* Pending - The state of Service event when the service call is pending.
* Received - The state of Service event when the service call is received.
* Submitted - The state of Service event when the service call is submitted.
Aliases None
Required? false
Position? named
Default value
-TimeSpan <TimeSpan>
Specify a TimeSpan object in number of days. Cannot be combined with -Start and -End parameters.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
A Server Hardware resource object from Get-HPOVServer.
A Server Profile resource object from Get-HPOVServerProfile. If the Server Profile is not associated with a server hardware
resource, an excpetion is thrown. If the Server Profile has moved from one server hardware resource to another, only the
currently assigned server hardware resource will be queried.
HPOneView.Enclosure
An Enclosure resource object from Get-HPOVEnclosure.
Return Values
HPOneView.Appliance.ServiceAlert
The Service Alert object that contains the CaseID, associated resource name, URI and serial number, and description of the
service event.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all Service Alerts from the connected appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServiceAlert -Count 10
Get the first 10 Service Alerts from the connected appliance.

-------------------------- EXAMPLE 3 --------------------------
$TimeSpan = New-TimeSpan -Days 30

Get-HPOVServiceAlert -Count 10 -TimeSpan $TimeSpan
Get the first 10 Service Alerts within the last 30 days from the connected appliance.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServiceAlert -Start ([DateTime]"2018-01-05") -End ([DateTime]"2018-01-30")
Get the Service Alerts within the specified date range from the connected appliance.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVServer -Name "Encl1, Bay 1" -ErrorAction Stop | Get-HPOVServiceAlert -Start ([DateTime]"2018-01-05") -En
d ([DateTime]"2018-01-30")
Get the Service Alerts within the specified date range for the specified server hardware resource from the connected appliance.
Top
### HPE OneView 4.00 Library ## Get-HPOVServiceAlert
Generate report of HPE OneView Remote Support service events. ### SYNTAX
Get-HPOVServiceAlert[ [-InputObject] <Object>][ [-State] <string>][ [-Count] <int>][ [-TimeSpan] <TimeSpan>][ [-

Start] <DateTime>][ [-End] <DateTime>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
HPE OneView automatically checks if your hardware has a valid entitlement to Hewlett Packard Enterprise support. A valid
entitlement is a Hewlett Packard Enterprise warranty or an active contract. If a valid entitlement to support is found, HPE
OneView Remote Support opens a support case for a hardware failure. This Cmdlet allows administrators to display and/or
export service events logged by the HPE OneView appliance.
Parameters
Aliases Appliance
Required? False
Position? named
-Count <int>
Specify the number of service alerts to return.
Aliases None
Required? false
Position? named
Default value
-End <DateTime>
DateTime object of the end date and time accompanied with the -Start parameter. If omitted, the current time of the PC is used.
Aliases None
Required? false
Position? named
Default value
Use to filter for the supported hardware resource object. Enclosures, Server Hardware and Server Profile objects are supported.
If an Enclosure resource is provided, only the Enclousre service events are queried. Associated Server Hardare within the
enclosure is not. If providing a Server Profile object, it must be assigned to a supported hardware platform. If the Server Profile
has moved between hardware resources, only the currently assigned server hardware resource object will be used to query for
service events.
Aliases None
Required? false
Position? named
Default value
-Start <DateTime>
DateTime object of the start date and time to being query.
Aliases None
Required? false
Position? named
Default value
-State <string>
Specify the state of the Service Alert. The state is not correlated to the associated Alert.
* Closed - The state of Service event when the service call is closed.
* Error - The Service request has some error None This is a default state.
* Open - The state of Service event when the service call is open.
* Pending - The state of Service event when the service call is pending.
* Received - The state of Service event when the service call is received.
* Submitted - The state of Service event when the service call is submitted.
Aliases None
Required? false
Position? named
Default value
-TimeSpan <TimeSpan>
Specify a TimeSpan object in number of days. Cannot be combined with -Start and -End parameters.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
A Server Hardware resource object from Get-HPOVServer.
A Server Profile resource object from Get-HPOVServerProfile. If the Server Profile is not associated with a server hardware
resource, an excpetion is thrown. If the Server Profile has moved from one server hardware resource to another, only the
currently assigned server hardware resource will be queried.
HPOneView.Enclosure
An Enclosure resource object from Get-HPOVEnclosure.
Return Values
HPOneView.Appliance.ServiceAlert
The Service Alert object that contains the CaseID, associated resource name, URI and serial number, and description of the
service event.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all Service Alerts from the connected appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServiceAlert -Count 10
Get the first 10 Service Alerts from the connected appliance.
-------------------------- EXAMPLE 3 --------------------------
$TimeSpan = New-TimeSpan -Days 30

Get-HPOVServiceAlert -Count 10 -TimeSpan $TimeSpan
Get the first 10 Service Alerts within the last 30 days from the connected appliance.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServiceAlert -Start ([DateTime]"2018-01-05") -End ([DateTime]"2018-01-30")
Get the Service Alerts within the specified date range from the connected appliance.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVServer -Name "Encl1, Bay 1" -ErrorAction Stop | Get-HPOVServiceAlert -Start ([DateTime]"2018-01-05") -En
d ([DateTime]"2018-01-30")
Get the Service Alerts within the specified date range for the specified server hardware resource from the connected appliance.
Related Links
Top
Get-HPOVSMTPConfig

Get-HPOVSMTPConfig
Configure appliance SMTP Reporting settings.
SYNTAX
Get-HPOVSMTPConfig[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will retrieve the SMTP settings for the appliance.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
Returns SMTP Email Configurtion object from the specified appliance(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSMTPConfig
Get SMTP Email Alert configuration from the default appliance connection. ### Related Links * [Set-HPOVSMTPConfig]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVSMTPConfig) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVSMTPConfig
Configure appliance SMTP Reporting settings. ### SYNTAX
Get-HPOVSMTPConfig[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will retrieve the SMTP settings for the appliance.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
Returns SMTP Email Configurtion object from the specified appliance(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSMTPConfig
Get SMTP Email Alert configuration from the default appliance connection.
Related Links
Set-HPOVSMTPConfig
Top
Get-HPOVSnmpReadCommunity

GRetrieve Appliance SNMP Read Community.
SYNTAX
Get-HPOVSnmpReadCommunity [-ApplianceConnection] <Object> [<CommonParameters>]
Get the configured appliance SNMP Read Community string.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
The SNMP Read Community
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve the SNMP Read Community string the appliance is configured to use from all connected sessions. ### Related Links *
[Set-HPOVSnmpReadCommunity](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVSnmpReadCommunity)
***
Top
### HPE OneView 4.00 Library ## Get-HPOVSnmpReadCommunity
GRetrieve Appliance SNMP Read Community. ### SYNTAX
Get-HPOVSnmpReadCommunity [-ApplianceConnection] <Object> [<CommonParameters>]
Get the configured appliance SNMP Read Community string.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
The SNMP Read Community
Examples
-------------------------- EXAMPLE 1 --------------------------
Retrieve the SNMP Read Community string the appliance is configured to use from all connected sessions.
Related Links
Set-HPOVSnmpReadCommunity
Top
Get-HPOVSnmpV3User

Get-HPOVSnmpV3User
Get defined SNMPv3 user from appliance.
SYNTAX
Get-HPOVSnmpV3User[ [-Name] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
HPE OneView can be used as a proxy to forward device traps from servers and enclosures (OA) to other SNMP-enabled
applications on the network. HPE OneView can forward traps, as SNMPv3 or SNMPv1 traps, to configured destinations.
Appliance SNMP settings allow you to add destinations to which the traps need to be forwarded. You can configure each
destination as an SNMPv1 or SNMPv3 destination, depending on whether the traps are sent in SNMPv1 or SNMPv3 formats.
Additionally, if you have Gen6 or Gen7 servers being monitored by HPE OneView in your environment, you can configure the
read community string that HPE OneView uses for monitoring these servers with SNMPv1.
NOTE: To configure SNMP trap forwarding for network devices (interconnects and switches), use the New-HPOVSnmpV3User
and include it within the New-HPOVSnmpSettings Cmdlet.
Parameters

Aliases Appliance
Required? False
Position? named
-Name <String>
Filter for the SNMPv3 user. Supports wildcard characters.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.SnmpV3User
Appliance SNMPv3 user object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSnmpV3User
Get the defined SNMPv3 users on the appliance. ### Related Links * [New-HPOVSnmpV3User]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVSnmpV3User) * [Remove-HPOVSnmpV3User]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVSnmpV3User) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVSnmpV3User
Get defined SNMPv3 user from appliance. ### SYNTAX
Get-HPOVSnmpV3User[ [-Name] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? False
Position? named
-Name <String>
Filter for the SNMPv3 user. Supports wildcard characters.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Appliance SNMPv3 user object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSnmpV3User
Get the defined SNMPv3 users on the appliance.
Related Links
New-HPOVSnmpV3User
Remove-HPOVSnmpV3User
Top
Get-HPOVStoragePool

Get-HPOVStoragePool
Retrieve Storage Pool resource(s).
SYNTAX
Get-HPOVStoragePool[ [-Name] <String>][ [-StorageSystem] <Object>][ [-Label] <Object>][ [-Scope] <Object>][ [-Ap
plianceConnection] <Array>][ [-Managed] <SwitchParameter>][ [-Unmanaged] <SwitchParameter>] [<CommonParameters>]
Obtain a collection of storage pools (i.e. CPG"s) from discovered and managed storage systems.
Parameters
Aliases Appliance
Required? false
Position? 4
-Label <Object>
Specify the Label to filter on.
Aliases None
Required? false
Position? 2
Default value
-Managed <SwitchParameter>
Only returned storage pools that are managed.
Aliases None
Required? false
Position? named
Default value
-Name <String>
Aliases [-PoolName, -Pool]
The name of the specific storage pool resource to be returned. All storage pool resources will be returned if omitted.
Aliases pool, PoolName
Required? false
Position? 0
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? 3

The name or Storage System object of the specific storage system to return storage pool resource from. Can be combined with
the PoolName parameter to single out a specific storage pool in a specific storage system.
Aliases systemName, system
Required? false
Position? 1
Default value
-Unmanaged <SwitchParameter>
Only returned storage pools that are unmanaged.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Storage.System
Managed Storage System from Get-HPOVStorageSystem.
Return Values
HPOneView.Storage.Pool [System.Management.Automation.PSCustomObject]
Single Storage Pool resource
Multiple Storage Pool resources
The matching storage pool resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStoragePool
Status Name Storage System Storage Domain Drive Type RAID Total Allocated Free
------ ---- -------------- -------------- ---------- ---- -------- ----------- -------
OK FC_NO_DN ThreePAR7200-5706 NoDomain FC RAID5 1,048,576.00GB 22.13GB 1,048,553.88GB
Get all available storage pools.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStoragePool | format-list
Name : FC_NO_DN
Status : OK
Storage System : ThreePAR7200-5706
Domain : NoDomain
Drive Type : FC
RAID : RAID5
Total : 1,048,576.00 GB
Allocated : 22.13 GB
Free : 1,048,553.88 GB
Volumes : 0
Volume Templates : 0
Name : FC_NO_DN
Status : OK
Domain : NoDomain
Drive Type : FC
RAID : RAID5
Total : 1,048,576.00 GB
Free : 1,048,553.88 GB
Volumes : 0
Get all available storage pools, display using Format-List to see extended information.
-------------------------- EXAMPLE 3 --------------------------
$myPool = Get-HPOVStoragePool -name "HP_CPG1"
Return the storage pool resource(s) with the name "HP_CPG1"

-------------------------- EXAMPLE 4 --------------------------
$myPools = Get-HPOVStoragePool
Return all the storage pool resources

-------------------------- EXAMPLE 5 --------------------------
Get-HPOVStoragePool -StorageSystem "HP_3PAR_1"
Returns all managed storage pool resources on the storage system "HP_3PAR_1"
-------------------------- EXAMPLE 6 --------------------------
Get-HPOVStoragePool -poolName "HP_CPG1" -systemName "HP_3PAR_1"
Returns the storage pool resource "HP_CPG1" on the storage system "HP_3PAR_1" ### Related Links * [Add-
HPOVStoragePool](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVStoragePool) * [Remove-
HPOVStoragePool](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStoragePool) * [Set-
HPOVStoragePool](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVStoragePool) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVStoragePool
Retrieve Storage Pool resource(s). ### SYNTAX
Get-HPOVStoragePool[ [-Name] <String>][ [-StorageSystem] <Object>][ [-Label] <Object>][ [-Scope] <Object>][ [-Ap
plianceConnection] <Array>][ [-Managed] <SwitchParameter>][ [-Unmanaged] <SwitchParameter>] [<CommonParameters>]
Obtain a collection of storage pools (i.e. CPG's) from discovered and managed storage systems.
Parameters
Aliases Appliance
Required? false
Position? 4
-Label <Object>
Specify the Label to filter on.
Aliases None
Required? false
Position? 2
Default value
Only returned storage pools that are managed.
Aliases None
Required? false
Position? named
Default value
-Name <String>
Aliases [-PoolName, -Pool]
The name of the specific storage pool resource to be returned. All storage pool resources will be returned if omitted.
Aliases pool, PoolName
Required? false
Position? 0
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? 3
The name or Storage System object of the specific storage system to return storage pool resource from. Can be combined with
the PoolName parameter to single out a specific storage pool in a specific storage system.
Aliases systemName, system
Required? false
Position? 1
Default value

-Unmanaged <SwitchParameter>
Only returned storage pools that are unmanaged.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Storage.System
Managed Storage System from Get-HPOVStorageSystem.
Return Values
Single Storage Pool resource
Multiple Storage Pool resources
The matching storage pool resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStoragePool
Status Name Storage System Storage Domain Drive Type RAID Total Allocated Free

Get all available storage pools.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStoragePool | format-list
Name : FC_NO_DN
Status : OK
Domain : NoDomain
Drive Type : FC
RAID : RAID5
Total : 1,048,576.00 GB
Free : 1,048,553.88 GB
Volumes : 0
Name : FC_NO_DN
Status : OK
Domain : NoDomain
Drive Type : FC
RAID : RAID5
Total : 1,048,576.00 GB
Free : 1,048,553.88 GB
Volumes : 0
Get all available storage pools, display using Format-List to see extended information.
-------------------------- EXAMPLE 3 --------------------------
$myPool = Get-HPOVStoragePool -name "HP_CPG1"
Return the storage pool resource(s) with the name "HP_CPG1"
-------------------------- EXAMPLE 4 --------------------------
$myPools = Get-HPOVStoragePool
Return all the storage pool resources
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVStoragePool -StorageSystem "HP_3PAR_1"
Returns all managed storage pool resources on the storage system "HP_3PAR_1"
-------------------------- EXAMPLE 6 --------------------------
Get-HPOVStoragePool -poolName "HP_CPG1" -systemName "HP_3PAR_1"
Returns the storage pool resource "HP_CPG1" on the storage system "HP_3PAR_1"
Related Links
Add-HPOVStoragePool
Top

Retrieve Storage System resource(s).
SYNTAX
Get-HPOVStorageSystem[ [-Name] <String>][ [-Hostname] <String>][ [-Family] <String>][ [-ApplianceConnection] <Ar
ray>][ [-List] <SwitchParameter>] [<CommonParameters>]
Get-HPOVStorageSystem[ [-SerialNumber] <String>][ [-Family] <String>][ [-ApplianceConnection] <Array>][ [-List]

This cmdlet will display all or a specific storage system configured on the HPE OneView appliance. A specific Storage System
can be searched for by using the System Name (not FQDN) or Serial Number. Use the List switch to display a report of the
requested storage system(s).
Parameters
Aliases Appliance
Required? false
Position? named
-Family <String>
Specify StoreVirtual or StoreServ to return storage systems based on family.
Aliases None
Required? false
Position? named
Default value
-Hostname <String>
Display the specific Storage System by its hostname (IP Address or FQDN).
Aliases None
Required? false
Position? named
Default value
-List <SwitchParameter>
Aliases [-Report] Generate a report of the specific or all storage systems.
Aliases Report
Required? false
Position? named
Default value False
-Name <String>
Aliases [-SystemName]
Display the specific Storage System by its system name.
Aliases SystemName
Required? false
Position? named
Default value
-SerialNumber <String>
Aliases [-SN]
Search for the Storage System based on the resource serial number instead of the name.
Aliases SN
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single Storage System
System.Collections.ArrayList <HPOneView.Storage.System>
Multiple Storage Systems
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all storage system resource objects managed by the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageSystem HP3Par_1
Status Name Serial Number Model Storage Domain WWN Firmware
------ ---- ------------- ----- -------------- --- --------
Ok HP3Par_1 TXQ1020307 HP_3PAR 7200 NoDomain 28:11:00:02:AC:00:08:7D 3.1.3
Get "HP3Par_1" storage system resource object managed by the appliance.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStorageSystem HP3Par_1 -report

------ ---- ------------- ----- -------------- --- --------
[Credentials] Username Address

------------- -------- -------
3paradm 172.18.11.13
[Capacity] Status Total Allocated Free

---------- ------ -------- ----------- -------
Ok 90.00TB 0.01TB 90.00TB
[Storage Pools] Status Name Drive Type RAID Total Allocated Free
--------------- ------ ------- ---------- ---- -------- ----------- -------
OK FC_NO_DN FC RAID5 1,048,576.00GB 22.13GB 1,048,553.88GB
[Host Ports] Status Port WWPN Expected Network Actual Network Port Group Name
------------ ------ ------- ----------------------- ---------------- -------------- ---------------
Ok 0:1:1 01:00:4A:2B:21:E1:00:11 Fabric A (DA) Fabric A (DA) Auto
Show a report of the managed storage system(s). ### Related Links * [Add-HPOVStorageSystem]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVStorageSystem) * [Remove-HPOVStorageSystem]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStorageSystem) * [Update-HPOVStorageSystem]
Top
### HPE OneView 4.00 Library ## Get-HPOVStorageSystem
Retrieve Storage System resource(s). ### SYNTAX
Get-HPOVStorageSystem[ [-Name] <String>][ [-Hostname] <String>][ [-Family] <String>][ [-ApplianceConnection] <Ar

ray>][ [-List] <SwitchParameter>] [<CommonParameters>]
Get-HPOVStorageSystem[ [-SerialNumber] <String>][ [-Family] <String>][ [-ApplianceConnection] <Array>][ [-List]

This cmdlet will display all or a specific storage system configured on the HPE OneView appliance. A specific Storage System
can be searched for by using the System Name (not FQDN) or Serial Number. Use the List switch to display a report of the
requested storage system(s).
Parameters
Aliases Appliance
Required? false
Position? named
-Family <String>
Specify StoreVirtual or StoreServ to return storage systems based on family.
Aliases None
Required? false
Position? named
Default value
-Hostname <String>
Display the specific Storage System by its hostname (IP Address or FQDN).
Aliases None
Required? false
Position? named
Default value
Aliases [-Report] Generate a report of the specific or all storage systems.
Aliases Report
Required? false
Position? named
Default value False
-Name <String>
Aliases [-SystemName]
Display the specific Storage System by its system name.
Aliases SystemName
Required? false
Position? named
Default value
Aliases [-SN]
Search for the Storage System based on the resource serial number instead of the name.
Aliases SN
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageSystem HP3Par_1
Get 'HP3Par_1' storage system resource object managed by the appliance.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStorageSystem HP3Par_1 -report

[Credentials] Username Address
3paradm 172.18.11.13
[Capacity] Status Total Allocated Free
Ok 90.00TB 0.01TB 90.00TB
[Storage Pools] Status Name Drive Type RAID Total Allocated Free
OK FC_NO_DN FC RAID5 1,048,576.00GB 22.13GB 1,048,553.88GB
[Host Ports] Status Port WWPN Expected Network Actual Network Port Group Name

Show a report of the managed storage system(s).
Related Links
Top

Retrieve Storage Volume resource(s).
SYNTAX
Get-HPOVStorageVolume[ [-Name] <String>][ [-StorageVolumeTemplate] <Object>][ [-Available] <SwitchParameter>][ [
-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVStorageVolume[ [-InputObject] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This cmdlet will display all or a specific storage volume(s) created on the HPE OneView appliance. A specific storage volume can
be searched for by using the Name. Use the List switch to display a report of the requested volume(s), including any
assignments to Server Profiles.
Parameters
Aliases Appliance
Required? false
Position? named
-Available <SwitchParameter>
Use to display Storage Volumes that are available for attachment.
Aliases None
Required? false
Position? named
Default value False

Provide a Server Profile object and all associated Storage Volumes will be returned.
Aliases ServerProfile, ServerProfileTemplate
Required? false
Position? named
Default value
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases [-VolumeName] Specify the name of the Storage Volume to display.
Aliases VolumeName
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named

-StorageVolumeTemplate <Object>
Return a list of provisioned Storage Volumes by their associated Storage Volume Template.
Aliases SVT
Required? False
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Collections.ArrayList <HPOneView.Storage.Volume>
Multiple storage volume resources
HPOneView.Storage.Volume [System.Management.Automation.PSCustomObject]
Formatted table view of storage volume resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Return all storage volume resource objects. ### Related Links * [Add-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVStorageVolume) * [ConvertTo-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVStorageVolume) * [Get-
HPOVStorageVolumeSnapShot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeSnapShot)
* [Get-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVStorageVolumeTemplate) * [Get-HPOVStorageVolumeTemplatePolicy](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVStorageVolumeTemplatePolicy) * [New-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolume) * [New-HPOVStorageVolumeSnapshot]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolumeSnapshot) * [New-
[Remove-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStorageVolume) *
[Remove-HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
Top
### HPE OneView 4.00 Library ## Get-HPOVStorageVolume
Retrieve Storage Volume resource(s). ### SYNTAX
Get-HPOVStorageVolume[ [-Name] <String>][ [-StorageVolumeTemplate] <Object>][ [-Available] <SwitchParameter>][ [

-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Get-HPOVStorageVolume[ [-InputObject] <Object>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
This cmdlet will display all or a specific storage volume(s) created on the HPE OneView appliance. A specific storage volume can
be searched for by using the Name. Use the List switch to display a report of the requested volume(s), including any
assignments to Server Profiles.
Parameters
Aliases Appliance
Required? false
Position? named
-Available <SwitchParameter>
Use to display Storage Volumes that are available for attachment.
Aliases None
Required? false
Position? named
Default value False
Provide a Server Profile object and all associated Storage Volumes will be returned.
Aliases ServerProfile, ServerProfileTemplate
Required? false
Position? named
Default value

-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases [-VolumeName] Specify the name of the Storage Volume to display.
Aliases VolumeName
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
-StorageVolumeTemplate <Object>
Return a list of provisioned Storage Volumes by their associated Storage Volume Template.
Aliases SVT
Required? False
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Collections.ArrayList <HPOneView.Storage.Volume>
Multiple storage volume resources
Formatted table view of storage volume resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Related Links
Top

Retrieve Storage Volume Snapshot resource(s).
SYNTAX
Get-HPOVStorageVolumeSnapShot [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will display all of the avialable snapshots for a given Storage Volume or multiple Storage Volumes.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases [-Volume]
Provide the Storage Volume resource object.
Aliases Name, Volume
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Storage Volume resource
Return Values
System.Collections.ArrayList <HPOneView.Storage.VolumeSnapshot>
Multiple storage volume snapshot resources
Formatted table view of storage volume snapshot resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolume | Get-HPOVStorageVolumeSnapShot
Appliance Name Parent Volume State Capacit
y
--------- ---- ------------- ----- -------
-
hpov.domain.com Vol1_20160211220746 Vol1 Configured (None) 10.00 G
B
B
B
hpov.domain.com Shared 1_20160224232717 Shared 1 Configured (None) 1,000.0
0 GB
0 GB
hpov.domain.com Shared 1 Snapshot Converted_20160225214317 Shared 1 Snapshot Converted Configured (None) 1,000.0
0 GB
Return all storage volume snapshot resource objects from all available storage volume resources.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolume "Volume 1" | Get-HPOVStorageVolumeSnapShot
Get available storage volume snapshots from a specific Storage Volume. ### Related Links * [New-
HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolumeSnapshot)
* [Remove-HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVStorageVolumeSnapshot) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVStorageVolumeSnapShot
Retrieve Storage Volume Snapshot resource(s). ### SYNTAX
Get-HPOVStorageVolumeSnapShot [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will display all of the avialable snapshots for a given Storage Volume or multiple Storage Volumes.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases [-Volume]
Provide the Storage Volume resource object.
Aliases Name, Volume
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Storage Volume resource
Return Values
System.Collections.ArrayList <HPOneView.Storage.VolumeSnapshot>
Multiple storage volume snapshot resources
Formatted table view of storage volume snapshot resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolume | Get-HPOVStorageVolumeSnapShot
Appliance Name Parent Volume State Capacit
y

B
B
B
0 GB
0 GB
hpov.domain.com Shared 1 Snapshot Converted_20160225214317 Shared 1 Snapshot Converted Configured (None) 1,000.0
0 GB
Return all storage volume snapshot resource objects from all available storage volume resources.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolume 'Volume 1' | Get-HPOVStorageVolumeSnapShot
Get available storage volume snapshots from a specific Storage Volume.
Related Links
Top

Retrieve Storage Volume Template (SVT) resource(s).
SYNTAX
Get-HPOVStorageVolumeTemplate[ [-Name] <String>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection]
<Object>] [<CommonParameters>]
Retrieve configured Storage Volume Template(s) from the appliance.
Parameters
Aliases Appliance
Required? false
Position? 3
-Label <String>
Aliases None
Required? false
Position? 1
Default value False
-Name <String>
Aliases [-templateName] The Storage Volume Template name.
Aliases TemplateName
Required? false
Position? 0
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? 2
<CommonParameters>
Input Types
Return Values
HPOneView.Storage.VolumeTemplate [System.Management.Automation.PSCustomObject]
Single Storage Volume Template
System.COllections.ArrayList <HPOneView.Storage.VolumeTemplate>
Multiple Storage Volume Template
The matching Storage Volume Template resource(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all available Storage Volume Templates.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolumeTemplate -templateName R5SVT-1
Get the "R5SVT-1" template. ### Related Links * [Get-HPOVStorageVolumeTemplatePolicy]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeTemplatePolicy) * [New-
[Remove-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVStorageVolumeTemplate) * [Set-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVStorageVolumeTemplate) * [Set-HPOVStorageVolumeTemplatePolicy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVStorageVolumeTemplatePolicy) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVStorageVolumeTemplate
Retrieve Storage Volume Template (SVT) resource(s). ### SYNTAX
Get-HPOVStorageVolumeTemplate[ [-Name] <String>][ [-Label] <String>][ [-Scope] <Object>][ [-ApplianceConnection]

Retrieve configured Storage Volume Template(s) from the appliance.
Parameters
Aliases Appliance
Required? false
Position? 3
-Label <String>
Aliases None
Required? false
Position? 1
Default value False
-Name <String>
Aliases [-templateName] The Storage Volume Template name.
Required? false
Position? 0
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? 2
<CommonParameters>
Input Types
Return Values
Single Storage Volume Template
System.COllections.ArrayList <HPOneView.Storage.VolumeTemplate>
Multiple Storage Volume Template
The matching Storage Volume Template resource(s).
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all available Storage Volume Templates.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolumeTemplate -templateName R5SVT-1
Get the 'R5SVT-1' template.
Related Links
Top
Retreive Storage Volume Template Global Policy.
SYNTAX
Get-HPOVStorageVolumeTemplatePolicy[ [-ApplianceConnection] <Array>] [<CommonParameters>]
By default, Storage Volumes can be created without reference to a Storage Volume Template. This cmdlet will display the global
policy setting. Use Set-HPOVStorageVolumeTemplatePolicy to modify the global policy setting.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.GlobalSetting [System.Management.Automation.PSCustomObject]
Object resource with the global setting value
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance Name Value
--------- ---- -----
MyAppliance.domain.com StorageVolumeTemplateRequired true
MyAppliance2.domain.com StorageVolumeTemplateRequired false
Get the Storage Volume Template Global Policy setting from all connected appliances. ### Related Links * [Set-
Top
### HPE OneView 4.00 Library ## Get-HPOVStorageVolumeTemplatePolicy
Retreive Storage Volume Template Global Policy. ### SYNTAX
Get-HPOVStorageVolumeTemplatePolicy[ [-ApplianceConnection] <Array>] [<CommonParameters>]
By default, Storage Volumes can be created without reference to a Storage Volume Template. This cmdlet will display the global
policy setting. Use Set-HPOVStorageVolumeTemplatePolicy to modify the global policy setting.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.GlobalSetting [System.Management.Automation.PSCustomObject]
Object resource with the global setting value
Examples
-------------------------- EXAMPLE 1 --------------------------

Get the Storage Volume Template Global Policy setting from all connected appliances.
Related Links
Top
Get-HPOVSwitch

Get-HPOVSwitch
Get a Switch resource.
SYNTAX
Get-HPOVSwitch[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object>] [<Co
mmonParameters>]
Get-HPOVSwitch[ [-Label] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieve a Switch that is managed by HPE OneView. Currently, HPE OneView can Manage or Monitor Cisco Nexus-family of
switches. This Cmdlet will retrieve the specified or all Logical Switch Group resources.
Parameters

Aliases Appliance
Required? false
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The Switch resource Name. Supports the * wildcard character.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSwitch
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSwitch -Name "10.1.1.1"
Get the "10.1.1.1" switch resource. ### Related Links * [Get-HPOVSwitchType](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Get-HPOVSwitchType) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVSwitch
Get a Switch resource. ### SYNTAX
Get-HPOVSwitch[ [-Name] <String>][ [-Scope] <Object>][ [-Label] <String>][ [-ApplianceConnection] <Object>] [<Co
mmonParameters>]
Get-HPOVSwitch[ [-Label] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Retrieve a Switch that is managed by HPE OneView. Currently, HPE OneView can Manage or Monitor Cisco Nexus-family of
switches. This Cmdlet will retrieve the specified or all Logical Switch Group resources.
Parameters
Aliases Appliance
Required? false
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False
-Name <String>
The Switch resource Name. Supports the * wildcard character.
Aliases None
Required? false
Position? named
Default value
-Scope <Object>
* AllResources
Aliases None
Required? False
Position? named
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSwitch
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSwitch -Name "10.1.1.1"
Get the "10.1.1.1" switch resource.
Related Links
Get-HPOVSwitchType
Top
Get-HPOVSwitchType

Get-HPOVSwitchType
Retrieve Switch Type resource(s).
SYNTAX
Get-HPOVSwitchType [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVSwitchType [-PartNumber] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Retrieves a list of all supported Switch Types or just specific ones via a query if the name or partnumber parameters are
provided. Curently, supported switch types are:
Cisco Nexus 50xx N5K-C50XX
Cisco Nexus 600x N6K-C600X
Parameters
Aliases Appliance
Required? true
Position? named
-Name <String>
The name of the switch type model name to retrieve.
Aliases None
Required? true
Position? named
Default value
The Part Number of an switch type to search for.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.SwitchType [System.Management.Automation.PSCustomObject]
Single Switch Type resource.
System.Collections.ArrayList <HPOneView.Networking.SwitchType>
Multiple Switch Type resources.
A Switch Type or collection of Switch Types.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSwitchType
Returns all Switch Types available from all connected appliances to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVInterconnect -Name "Cisco Nexus 55xx"
Returns just the "Cisco Nexus 55xx" Switch Type object to standard output.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVInterconnect -Name "N5K-C55XX"
Returns just the partnumber "N5K-C55XX" Switch Type object to standard output. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVSwitchType
Retrieve Switch Type resource(s). ### SYNTAX
Get-HPOVSwitchType [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get-HPOVSwitchType [-PartNumber] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Retrieves a list of all supported Switch Types or just specific ones via a query if the name or partnumber parameters are
provided. Curently, supported switch types are:
Cisco Nexus 600x N6K-C600X
Parameters
Aliases Appliance
Required? true
Position? named
-Name <String>
The name of the switch type model name to retrieve.
Aliases None
Required? true
Position? named
Default value
The Part Number of an switch type to search for.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single Switch Type resource.
System.Collections.ArrayList <HPOneView.Networking.SwitchType>
Multiple Switch Type resources.
A Switch Type or collection of Switch Types.

Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSwitchType
Returns all Switch Types available from all connected appliances to standard output.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVInterconnect -Name "Cisco Nexus 55xx"
Returns just the 'Cisco Nexus 55xx' Switch Type object to standard output.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVInterconnect -Name "N5K-C55XX"
Returns just the partnumber 'N5K-C55XX' Switch Type object to standard output.
Related Links
Top
Get-HPOVTask

Get-HPOVTask
Retrieve Task resource(s).
SYNTAX
Get-HPOVTask[ [-Name] <String>][ [-InputObject] <Object>][ [-State] <String>][ [-Count] <Int32>][ [-ApplianceCon
nection] <Object>] [<CommonParameters>]
Get-HPOVTask[ [-Name] <String>][ [-ResourceCategory] <String>][ [-State] <String>][ [-Count] <Int32>][ [-Applian
ceConnection] <Object>] [<CommonParameters>]
Obtain a collection of task resources which have the specified name and/or state. The returned data will include the task name,
owner, state and status.
Parameters
Aliases Appliance
Required? false
Position? named
-Count <Int32>
Specify the maximum amount of task objects to return. 0 will return all found task objects.
Aliases None
Required? false
Position? named
Default value 0
Related resource Name or Object to the task. To be used for filtering tasks specific to a resource object (i.e. Server Profile).
Aliases Resource
Required? false
Position? named
Default value
-Name <String>
Aliases [-TaskName] The name of the task resource to be returned. All names will match if omitted.
Aliases TaskName
Required? false
Position? named
Default value
-ResourceCategory <String>
Aliases [-Category] Specify the Resource Category to filter task results to. Cannot be combined with Resource parameter.
Some examples are:
* ethernet-networks
* fc-networks
* power-devices
* unmanaged-devices
* server-profiles
* server-hardware
* enclosures
* enclosure-groups
* interconnects
* logical-interconnects
* logical-interconnect-groups
* appliance
* firmware-drivers
Aliases Category
Required? false
Position? named
Default value
-State <String>
The state of the task resource a to be returned. May be one of the following strings:
* Unknown
* New
* Running
* Suspended
* Terminated
* Killed
* Completed
* Error
* Warning
All states will match if omitted. All tasks will be returned if both names and state are omitted.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject ]
Resource Object to retrieve task resources of

Return Values
Single Task resource
Multiple Task resources or formatted table list of tasks
The matching task resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
$tasks = Get-HPOVTask -state Error
Return all the tasks with a taskState="Error"

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile -Name "Server 1" | Get-HPOVTask -State Completed
Return completed (successful) tasks associated with the "Server 1" Server Profile.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVTask -count 10
Display the 10 most recent tasks from the specified appliance connection. ### Related Links * [Wait-HPOVTaskComplete]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskComplete) * [Wait-HPOVTaskStart]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskStart) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVTask
Retrieve Task resource(s). ### SYNTAX
Get-HPOVTask[ [-Name] <String>][ [-InputObject] <Object>][ [-State] <String>][ [-Count] <Int32>][ [-ApplianceCon
nection] <Object>] [<CommonParameters>]
Get-HPOVTask[ [-Name] <String>][ [-ResourceCategory] <String>][ [-State] <String>][ [-Count] <Int32>][ [-Applian
Obtain a collection of task resources which have the specified name and/or state. The returned data will include the task name,
owner, state and status.
Parameters
Aliases Appliance
Required? false
Position? named
-Count <Int32>
Specify the maximum amount of task objects to return. 0 will return all found task objects.
Aliases None
Required? false
Position? named
Default value 0
Related resource Name or Object to the task. To be used for filtering tasks specific to a resource object (i.e. Server Profile).
Aliases Resource
Required? false
Position? named
Default value
-Name <String>
Aliases [-TaskName] The name of the task resource to be returned. All names will match if omitted.
Aliases TaskName
Required? false
Position? named
Default value
-ResourceCategory <String>
Aliases [-Category] Specify the Resource Category to filter task results to. Cannot be combined with Resource parameter.
Some examples are:

* ethernet-networks
* fc-networks
* power-devices
* unmanaged-devices
* server-profiles
* server-hardware
* enclosures
* enclosure-groups
* interconnects
* appliance
* firmware-drivers
Aliases Category
Required? false
Position? named
Default value
-State <String>
The state of the task resource a to be returned. May be one of the following strings:
* Unknown
* New
* Running
* Suspended
* Terminated
* Killed
* Completed
* Error
* Warning
All states will match if omitted. All tasks will be returned if both names and state are omitted.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject ]
Resource Object to retrieve task resources of
Return Values
Single Task resource
Multiple Task resources or formatted table list of tasks
The matching task resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
$tasks = Get-HPOVTask -state Error
Return all the tasks with a taskState='Error'
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile -Name "Server 1" | Get-HPOVTask -State Completed
Return completed (successful) tasks associated with the 'Server 1' Server Profile.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVTask -count 10
Display the 10 most recent tasks from the specified appliance connection.
Related Links
Wait-HPOVTaskComplete
Wait-HPOVTaskStart
Top
Get-HPOVUnmanagedDevice

Get Unmanaged Devices.
SYNTAX
Get-HPOVUnmanagedDevice [-Name] <String>[ [-List] <SwitchParameter>][ [-Label] <String>] [-ApplianceConnection]
<Object> [<CommonParameters>]
HPE OneView provides administrators with the capability to define unmanaged devices to them place within Racks, in order to
provide a more realistic and complete data center layout. This cmdlet will retrieve all or a specified Unmanaged Device. A report
switch is provided to display the output in an easier to read format.
Parameters
Aliases Appliance
Required? true
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False
Deprecated parameter. CMDLET now defaults to Format-Table output.
Aliases report
Required? false
Position? named
Default value False
-Name <String>
The name of the Unmanaged Device.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.UnmanagedResource [System.Management.Automation.PSCustomObject]
Single Unmanaged Device resource object
Multiple Unmanaged Device resource objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all unmanaged devices. ### Related Links * [New-HPOVUnmanagedDevice](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/New-HPOVUnmanagedDevice) * [Remove-HPOVUnmanagedDevice](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVUnmanagedDevice) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVUnmanagedDevice
Get Unmanaged Devices. ### SYNTAX
Get-HPOVUnmanagedDevice [-Name] <String>[ [-List] <SwitchParameter>][ [-Label] <String>] [-ApplianceConnection]

provide a more realistic and complete data center layout. This cmdlet will retrieve all or a specified Unmanaged Device. A report
switch is provided to display the output in an easier to read format.
Parameters
Aliases Appliance
Required? true
Position? named
-Label <String>
Aliases None
Required? false
Position? named
Default value False
Deprecated parameter. CMDLET now defaults to Format-Table output.
Aliases report
Required? false
Position? named
Default value False
-Name <String>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single Unmanaged Device resource object
Multiple Unmanaged Device resource objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Get all unmanaged devices.
Related Links
New-HPOVUnmanagedDevice
Remove-HPOVUnmanagedDevice
Top
Get-HPOVUplinkSet

Get-HPOVUplinkSet
Retreive Uplink Set resource(s).
SYNTAX
Get-HPOVUplinkSet [-Name] <String> [-LogicalInterconnect] <Object>[ [-Report] <SwitchParameter>] [-ApplianceConn
ection] <Object> [-ExportFile] <String> [<CommonParameters>]
Get-HPOVUplinkSet [-LogicalInterconnect] <Object> [-Type] <String>[ [-Report] <SwitchParameter>] [-ApplianceConn

This cmdlet will retrieve the list of all Uplink Sets or specific by the name. The cmdlet will only display provisioned Uplink Sets that
are members of a Logical Interconnect resource. To view Uplink Sets of a Logical Interconnect Group, use the Get-
HPOVLogicalInterconnectGroup CMDLET.
Parameters
Aliases Appliance
Required? true
Position? named
Export the found Uplink Set resource objects to JSON files in the specified directory.
Aliases x, export
Required? true
Position? named
Default value
-LogicalInterconnect <Object>
Aliases [-LiName] Name of the Logical Interconnect to show associated Uplink Set.
Aliases liname
Required? true
Position? named
Default value
-Name <String>
Name of Uplink Set
Aliases None
Required? true
Position? named
Default value
Generate a report of the defined Uplink Sets. Includes Uplink Set type, networks, redundancy report, and assigned uplink ports.
Aliases None
Required? false
Position? named
Default value False
-Type <String>
Specify the Uplink Set Type to display. Will display all Uplink Sets of the type provided. Allowed values:
* Ethernet
* FibreChannel
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single Uplink Set
Multiple Uplink Sets
Collection of Uplink Sets
Examples
-------------------------- EXAMPLE 1 --------------------------
$UplinkSets = Get-HPOVUplinkSet
Get list of all Uplink Sets.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVUplinkSet -name "Production Networks"
Get the "Production Networks" Uplink Set(s).

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVUplinkSet -name "Production Networks" -report
Get the "Production Networks" Uplink Set(s), and generate a report.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVUplinkSet -name "Production Networks" -liname "Encl1-LI" -report
Get the "Production Networks" Uplink Set that is associated with "Encl1-LI" Logical Interconnect and generate a report. ###
Related Links * [New-HPOVUplinkSet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVUplinkSet) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVUplinkSet
Retreive Uplink Set resource(s). ### SYNTAX
Get-HPOVUplinkSet [-Name] <String> [-LogicalInterconnect] <Object>[ [-Report] <SwitchParameter>] [-ApplianceConn

Get-HPOVUplinkSet [-LogicalInterconnect] <Object> [-Type] <String>[ [-Report] <SwitchParameter>] [-ApplianceConn

This cmdlet will retrieve the list of all Uplink Sets or specific by the name. The cmdlet will only display provisioned Uplink Sets that
are members of a Logical Interconnect resource. To view Uplink Sets of a Logical Interconnect Group, use the Get-
HPOVLogicalInterconnectGroup CMDLET.
Parameters
Aliases Appliance
Required? true
Position? named
Export the found Uplink Set resource objects to JSON files in the specified directory.
Aliases x, export
Required? true
Position? named
Default value
Aliases [-LiName] Name of the Logical Interconnect to show associated Uplink Set.
Aliases liname
Required? true
Position? named
Default value
-Name <String>
Name of Uplink Set
Aliases None
Required? true
Position? named
Default value
Generate a report of the defined Uplink Sets. Includes Uplink Set type, networks, redundancy report, and assigned uplink ports.
Aliases None
Required? false
Position? named
Default value False
-Type <String>
Specify the Uplink Set Type to display. Will display all Uplink Sets of the type provided. Allowed values:
* Ethernet
* FibreChannel
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Single Uplink Set
Multiple Uplink Sets
Collection of Uplink Sets
Examples
-------------------------- EXAMPLE 1 --------------------------
$UplinkSets = Get-HPOVUplinkSet
Get list of all Uplink Sets.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVUplinkSet -name "Production Networks"
Get the 'Production Networks' Uplink Set(s).
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVUplinkSet -name "Production Networks" -report
Get the 'Production Networks' Uplink Set(s), and generate a report.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVUplinkSet -name "Production Networks" -liname "Encl1-LI" -report
Get the 'Production Networks' Uplink Set that is associated with 'Encl1-LI' Logical Interconnect and generate a report.
Related Links
New-HPOVUplinkSet
Top
Get-HPOVUser

Get-HPOVUser
Retrieve user account resource(s).
SYNTAX
Get-HPOVUser [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get a local user account on the management appliance, and display it"s properties. The account password will not be displayed.
Parameters
Aliases Appliance
Required? true
Position? 1
-Name <String>
The name of the new user account to display.
Aliases Username
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Single User resource
Multiple User resourses, or formatted table displaying a report of user accounts
User Account Information
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVUser
List all user accounts from all connected appliances.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVUser "Sally"
List Sally"s user account from MyAppliance.domain.com. ### Related Links * [New-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVUser) * [Remove-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVUser) * [Set-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVUser) * [Set-HPOVUserPassword]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVUserPassword) * [Set-HPOVUserRole]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVUserRole) * [Show-HPOVUserSession]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVUserSession) ***
Top
### HPE OneView 4.00 Library ## Get-HPOVUser
Retrieve user account resource(s). ### SYNTAX
Get-HPOVUser [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Get a local user account on the management appliance, and display it's properties. The account password will not be displayed.
Parameters
Aliases Appliance
Required? true
Position? 1
-Name <String>
The name of the new user account to display.
Aliases Username
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Single User resource
Multiple User resourses, or formatted table displaying a report of user accounts
User Account Information
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVUser
List all user accounts from all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVUser "Sally"
List Sally's user account from MyAppliance.domain.com.
Related Links
New-HPOVUser
Remove-HPOVUser
Set-HPOVUser
Set-HPOVUserPassword
Set-HPOVUserRole
Show-HPOVUserSession
Top
Get-HPOVVersion

Get-HPOVVersion
Display library component versions.
SYNTAX
Get-HPOVVersion[ [-ApplianceVer] <SwitchParameter>][ [-CheckOnline] <SwitchParameter>] [-ApplianceConnection] <A
rray> [<CommonParameters>]
Get-HPOVVersion[ [-CheckOnline] <SwitchParameter>] [<CommonParameters>]
Display either the HPE OneView PowerShell library or appliance version. Displaying the Appliance version will provide the Major,
Minor, full version, and X-API Version information.
Parameters
Aliases appliance
Required? true
Position? named
-ApplianceVer <SwitchParameter>
Include the appliance version.

Aliases None
Required? false
Position? named
Default value False
-CheckOnline <SwitchParameter>
Check the GitHub repository for an updated version of the library.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
The HPE OneView PowerShell Library or Appliance version information
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVVersion
Get the HPE OneView PowerShell library version

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVVersion -ApplianceVer
PowerShell Library Version : 1.20.208.0
Library Path : C:\Users\user\Documents\WindowsPowerShell\Modules\HPOneView.120
Appliance Major Version : 1
Appliance Minor Version : 20
Appliance Version Info : 1.20.05-0201918
Appliance X-API Version : 120
Get the HPE OneView PowerShell library, Appliance and X-API version information
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVVersion -CheckOnline
Library Path : C:\Users\user\Documents\WindowsPowerShell\Modules\hponeview.120
Please Confirm
You currently have v1.20.166.0 installed. The HPE OneView PowerShell Library v1.20.208.0 was found that is newe
r. Do
you want to download the current version of the HPE OneView POSH Library (will open your web browser for you to
download)?
[Y] Yes [N] No [?] Help (default is "Y"):
Display the installed library version, and check for availability of an updated version online. If an updated version is found, the
CMDLET will prompt if the user would like to download it now. If so, browser window will be opened to current version to
download. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVVersion
Display library component versions. ### SYNTAX
Get-HPOVVersion[ [-ApplianceVer] <SwitchParameter>][ [-CheckOnline] <SwitchParameter>] [-ApplianceConnection] <A

rray> [<CommonParameters>]
Get-HPOVVersion[ [-CheckOnline] <SwitchParameter>] [<CommonParameters>]
Display either the HPE OneView PowerShell library or appliance version. Displaying the Appliance version will provide the Major,
Minor, full version, and X-API Version information.
Parameters
Aliases appliance
Required? true
Position? named
-ApplianceVer <SwitchParameter>
Include the appliance version.
Aliases None
Required? false
Position? named
Default value False
-CheckOnline <SwitchParameter>
Check the GitHub repository for an updated version of the library.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
The HPE OneView PowerShell Library or Appliance version information
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVVersion
Get the HPE OneView PowerShell library version
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVVersion -ApplianceVer
Library Path : C:\Users\user\Documents\WindowsPowerShell\Modules\HPOneView.120
Appliance Major Version : 1
Appliance Minor Version : 20
Appliance Version Info : 1.20.05-0201918
Appliance X-API Version : 120
Get the HPE OneView PowerShell library, Appliance and X-API version information
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVVersion -CheckOnline
Library Path : C:\Users\user\Documents\WindowsPowerShell\Modules\hponeview.120
Please Confirm
You currently have v1.20.166.0 installed. The HPE OneView PowerShell Library v1.20.208.0 was found that is newe
r. Do
you want to download the current version of the HPE OneView POSH Library (will open your web browser for you to
download)?
[Y] Yes [N] No [?] Help (default is "Y"):
Display the installed library version, and check for availability of an updated version online. If an updated version is found, the
CMDLET will prompt if the user would like to download it now. If so, browser window will be opened to current version to
download.
Related Links
Top
Get-HPOVXApiVersion

Get-HPOVXApiVersion
Get appliance API version.
SYNTAX
Get-HPOVXApiVersion [-ApplianceConnection] <Object> [<CommonParameters>]
Returns the API versions supported by the appliance. You do not need to authenticate, or call Connect-HPOVMgmt, to an
appliance in order to retrieve the supported REST API Versions by the appliance.
Parameters
Aliases appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
The current and minimum supported API versions on the appliance
Examples
-------------------------- EXAMPLE 1 --------------------------
(Get-HPOVXApiVersion myAppliance.domain.com).minimumversion
This example retrieves the minimum XApi version supported by the appliance. An existing connection is not needed since the
appliance name is provided.
-------------------------- EXAMPLE 2 --------------------------
(Get-HPOVXApiVersion).minimumversion
This example retrieves the minimum XApi version supported by the appliance and requires that a connection has been
established by using Connect-HPOVMgmt. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Get-HPOVXApiVersion
Get appliance API version. ### SYNTAX
Get-HPOVXApiVersion [-ApplianceConnection] <Object> [<CommonParameters>]
Returns the API versions supported by the appliance. You do not need to authenticate, or call Connect-HPOVMgmt, to an
appliance in order to retrieve the supported REST API Versions by the appliance.
Parameters
Aliases appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
The current and minimum supported API versions on the appliance
Examples
-------------------------- EXAMPLE 1 --------------------------
(Get-HPOVXApiVersion myAppliance.domain.com).minimumversion
This example retrieves the minimum XApi version supported by the appliance. An existing connection is not needed since the
appliance name is provided.
-------------------------- EXAMPLE 2 --------------------------
(Get-HPOVXApiVersion).minimumversion
This example retrieves the minimum XApi version supported by the appliance and requires that a connection has been
established by using Connect-HPOVMgmt.
Related Links
Top
Import-HPOVSslCertificate

Import an appliance SSL Certificate.
SYNTAX
Import-HPOVSslCertificate [-ApplianceConnection] <Array> [<CommonParameters>]
By default, the HPE OneView appliance creates a self-signed SSL Certificate for its WebUI. There might be a desire to trust the
certificate, in case the SHA-1 hash becomes invalid (either due to a certificate change or man-in-the-middle attack) and the
caller would like to be notified. This cmdlet will assist in retrieving and storing the appliance self-generated SSL Certificate into
the current users Trusted Root Certification Authorities store.
Please note that the Subject Alternate Name (SAN) must match that of the Appliance hostname you use to connect to your
appliance. If it does not, an SSL conenction failure will ocurr. When creating a CSR on the appliance, make sure to include the
additional FQDN and IP address(es) in the Alternative Name field.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
HPE OneView Appliance Connection object
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Connection = Connect-HPOVMgmt Myappliance.domain.com Administrator MyP@ssword

Import the SSL certificate from the specific appliance.

-------------------------- EXAMPLE 2 --------------------------
Connect-HPOVMgmt Myappliance.domain.com Administrator MyP@ssword

Connect-HPOVMgmt Myappliance2.domain.com Administrator MyP@ssword
$ConnectedSessions | Import-HPOVSslCertificate
Import the SSL Certificate from all connected sessions. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Import-HPOVSslCertificate
Import an appliance SSL Certificate. ### SYNTAX
Import-HPOVSslCertificate [-ApplianceConnection] <Array> [<CommonParameters>]
By default, the HPE OneView appliance creates a self-signed SSL Certificate for its WebUI. There might be a desire to trust the
certificate, in case the SHA-1 hash becomes invalid (either due to a certificate change or man-in-the-middle attack) and the
caller would like to be notified. This cmdlet will assist in retrieving and storing the appliance self-generated SSL Certificate into
the current users Trusted Root Certification Authorities store.
Please note that the Subject Alternate Name (SAN) must match that of the Appliance hostname you use to connect to your
appliance. If it does not, an SSL conenction failure will ocurr. When creating a CSR on the appliance, make sure to include the
additional FQDN and IP address(es) in the Alternative Name field.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
HPE OneView Appliance Connection object
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Connection = Connect-HPOVMgmt Myappliance.domain.com Administrator MyP@ssword

Import the SSL certificate from the specific appliance.
-------------------------- EXAMPLE 2 --------------------------
Connect-HPOVMgmt Myappliance.domain.com Administrator MyP@ssword

Connect-HPOVMgmt Myappliance2.domain.com Administrator MyP@ssword
$ConnectedSessions | Import-HPOVSslCertificate
Import the SSL Certificate from all connected sessions.
Related Links
Top
Install-HPOVApplianceCertificate

Install signed private key.
SYNTAX
Install-HPOVApplianceCertificate [-Path] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>]
After using New-HPOVApplianceCSR to generate a Certificate Signing Request (CSR), this CMDLET will install the CA signed
and approved SSL private key to the appliance.
Parameters
Specify the HPOneView.Appliance.Connection object or Name property value.
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
-Path <Object>
Aliases [-PrivateKey, -Certificate] The private key certificate for the appliance. Use Get-Content (GC) to read the source CER
file and pass to the cmdlet via pipeline or this parameter.
Aliases PrivateKey, Certificate
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Certificate file read by Get-Content -Raw
System.IO.FileInfo
Certificate file path
Certificate file read by Get-Content
Return Values
Async task resource object to monitor committing certificate, and deploying HPE SSO certificate update to managed/monitored
devices
Examples
-------------------------- EXAMPLE 1 --------------------------
$Task = gc C:\dir\hpov.cer | Install-HPOVApplianceCertificate
Read the signed SSL certificate private key and install it on the appliance, and wait for the task to complete.
-------------------------- EXAMPLE 2 --------------------------
$cert = GC C:\dir\hpov.cer
$TaskToMonitor = Install-HPOVApplianceCertificate -Path $Cert -Async
C:\> $TaskToMonitor | Wait-HPOVTaskComplete
Read the signed SSL certificate private key and install it on the appliance, and wait for the task to complete. ### Related Links *
[Get-HPOVApplianceCertificateStatus](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceCertificateStatus) ***
Top
### HPE OneView 4.00 Library ## Install-HPOVApplianceCertificate
Install signed private key. ### SYNTAX
Install-HPOVApplianceCertificate [-Path] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>]

After using New-HPOVApplianceCSR to generate a Certificate Signing Request (CSR), this CMDLET will install the CA signed
and approved SSL private key to the appliance.
Parameters
Specify the HPOneView.Appliance.Connection object or Name property value.
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False

-Path <Object>
Aliases [-PrivateKey, -Certificate] The private key certificate for the appliance. Use Get-Content (GC) to read the source CER
file and pass to the cmdlet via pipeline or this parameter.
Aliases PrivateKey, Certificate
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Certificate file read by Get-Content -Raw
System.IO.FileInfo
Certificate file path
Certificate file read by Get-Content
Return Values
Async task resource object to monitor committing certificate, and deploying HPE SSO certificate update to managed/monitored
devices
Examples
-------------------------- EXAMPLE 1 --------------------------
$Task = gc C:\dir\hpov.cer | Install-HPOVApplianceCertificate
-------------------------- EXAMPLE 2 --------------------------
$cert = GC C:\dir\hpov.cer
$TaskToMonitor = Install-HPOVApplianceCertificate -Path $Cert -Async
C:> $TaskToMonitor | Wait-HPOVTaskComplete
Related Links
Top

Install Logical Interconnect Firmware.
SYNTAX
Install-HPOVLogicalInterconnectFirmware [-LogicalInterconnect] <Object> [-Baseline] <Object> [-Method] <String>
[-EthernetActivateOrder] <String> [-EthernetActivateDelay] <Int32> [-FCActivateOrder] <String> [-FCActivateDelay
] <Int32>[ [-Async] <SwitchParameter>][ [-Force] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <
Use this cmdlet to install/update the Logical Interconnect (i.e. Virtual Connect) firmware. You can provide the Logical
Interconnect Name, URI or Object and must specify a valid SPP Baseline present on the appliance.
This cmdlet will default to performing an Update (Stage + Activate), which will cause an outage. If you wish to avoid an outage,
first stage the update usind -method stage, then -method activate. Interconnect activation can be controlled with the -
ActivateOrder parameter, which defaults to Odd interconnects. Once the specified interconnect activation is complete, you must
then call the cmdlet again with the alternate ActivateOrder value (i.e. even.)
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Baseline <Object>
Firmware Baseline Name, URI or Object.
Aliases spp
Required? true
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value
-EthernetActivateDelay <Int32>
The amount of time in seconds to delay activating additional modules.
Default is 5 seconds.
Aliases None
Required? true
Position? named
Default value 5
-EthernetActivateOrder <String>
Aliases [-order, -ActivateOrder] Specify the Ethernet module firmware activation order. Accepted values are:
* OddEven (Default)
* Parallel
* Serial
Aliases Order, ActivateOrder
Required? true
Position? named
Default value OddEven
-FCActivateDelay <Int32>
Aliases None
Required? true
Position? named
Default value 5
-FCActivateOrder <String>
Specify the Fibre Channel module firmware activation order. Accepted values are:
* OddEven
* Parallel
* Serial (Default)
Aliases None
Required? true
Position? named
Default value Serial
Force the firmware update if the update version matches what is already installed.
Aliases None
Required? false
Position? named
Default value False
Aliases [-li, -uri, -name] The Logical Interconnect object(s), name(s) or uris(s) to be updated.
Aliases name, uri, li
Required? true
Position? named
Default value
-Method <String>
Upgrade method to perform. Accepted values are:
* UPDATE (Default)
* STAGE
* ACTIVATE
Aliases None
Required? true
Position? named
Default value Update
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]
Logical Interconnect Resource Object
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$li = Get-HPOVLogicalInterconnect Encl1-LI

$spp = Get-HPOVSppFile "HP Service Pack for ProLiant"
$task = Install-HPOVLogicalInterconnectFirmware Stage $li $spp
$task = Install-HPOVLogicalInterconnectFirmware Activate $li
Perform a firmware update of the Encl1-LI Logical Interconnect by first staging the firmware. Then Acitate the firmware using the
default OddEven Interconnect Bay order.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnect Encl1-LI | Install-HPOVLogicalInterconnectFirmware -method Update -baseline "HP Ser

vice Pack for ProLiant" -confirm:$false | Wait-HPOVTaskComplete
Perform a firmware update of the Encl1-LI Logical Interconnect, do not prompt for confirmation, then wait for the task to
complete. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Install-HPOVLogicalInterconnectFirmware
Install Logical Interconnect Firmware. ### SYNTAX
Install-HPOVLogicalInterconnectFirmware [-LogicalInterconnect] <Object> [-Baseline] <Object> [-Method] <String>

[-EthernetActivateOrder] <String> [-EthernetActivateDelay] <Int32> [-FCActivateOrder] <String> [-FCActivateDelay
] <Int32>[ [-Async] <SwitchParameter>][ [-Force] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <
Use this cmdlet to install/update the Logical Interconnect (i.e. Virtual Connect) firmware. You can provide the Logical
Interconnect Name, URI or Object and must specify a valid SPP Baseline present on the appliance.
This cmdlet will default to performing an Update (Stage + Activate), which will cause an outage. If you wish to avoid an outage,
first stage the update usind -method stage, then -method activate. Interconnect activation can be controlled with the -
ActivateOrder parameter, which defaults to Odd interconnects. Once the specified interconnect activation is complete, you must
then call the cmdlet again with the alternate ActivateOrder value (i.e. even.)
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Baseline <Object>
Firmware Baseline Name, URI or Object.
Aliases spp
Required? true
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value
-EthernetActivateDelay <Int32>
Aliases None
Required? true
Position? named
Default value 5
-EthernetActivateOrder <String>
Aliases [-order, -ActivateOrder] Specify the Ethernet module firmware activation order. Accepted values are:
* OddEven (Default)
* Parallel
* Serial
Aliases Order, ActivateOrder
Required? true
Position? named
Default value OddEven
-FCActivateDelay <Int32>
Aliases None
Required? true
Position? named
Default value 5
-FCActivateOrder <String>
Specify the Fibre Channel module firmware activation order. Accepted values are:
* OddEven
* Parallel
* Serial (Default)
Aliases None
Required? true
Position? named
Default value Serial
Force the firmware update if the update version matches what is already installed.
Aliases None
Required? false
Position? named
Default value False

Aliases name, uri, li
Required? true
Position? named
Default value
-Method <String>
Upgrade method to perform. Accepted values are:
* UPDATE (Default)
* STAGE
* ACTIVATE
Aliases None
Required? true
Position? named
Default value Update
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types

Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$li = Get-HPOVLogicalInterconnect Encl1-LI

$spp = Get-HPOVSppFile "HP Service Pack for ProLiant"
$task = Install-HPOVLogicalInterconnectFirmware Stage $li $spp
$task = Install-HPOVLogicalInterconnectFirmware Activate $li
Perform a firmware update of the Encl1-LI Logical Interconnect by first staging the firmware. Then Acitate the firmware using the
default OddEven Interconnect Bay order.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnect Encl1-LI | Install-HPOVLogicalInterconnectFirmware -method Update -baseline "HP Ser

vice Pack for ProLiant" -confirm:$false | Wait-HPOVTaskComplete
Perform a firmware update of the Encl1-LI Logical Interconnect, do not prompt for confirmation, then wait for the task to
complete.
Related Links
Top
Install-HPOVUpdate

Install-HPOVUpdate
Install or stage an appliance update.
SYNTAX
Install-HPOVUpdate [-File] <String> [-Eula] <String>[ [-DisplayReleaseNotes] <SwitchParameter>] [-ApplianceConne
ction] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Install-HPOVUpdate [-File] <String>[ [-Stage] <SwitchParameter>][ [-DisplayReleaseNotes] <SwitchParameter>] [-Ap

plianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Install-HPOVUpdate[ [-InstallNow] <SwitchParameter>] [-Eula] <String> [-ApplianceConnection] <Object>[ [-WhatIf]

<SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Install-HPOVUpdate[ [-ListPending] <SwitchParameter>][ [-DisplayReleaseNotes] <SwitchParameter>] [-ApplianceConn
ection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
The Install-HPOVUpdate installs an appliance update package to upgrade the platform to the specified version. Use the -Stage
switch to stage an update on the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
-DisplayReleaseNotes <SwitchParameter>
Display Release Notes of Update
Aliases None
Required? false
Position? named
Default value False
-Eula <String>
Will display EULA if no value is provided. Pass "accept" to accept and not display EULA.
Aliases None
Required? true
Position? named
Default value
-File <String>
Aliases [-f] Appliance Update file to install.
Aliases f
Required? true
Position? named
Default value
-InstallNow <SwitchParameter>
Install pending update that was previously staged.
Aliases None
Required? false
Position? named
Default value False
-ListPending <SwitchParameter>
Aliases [-list] List any pending updates on the appliance that might have been staged.
Aliases list
Required? false
Position? named
Default value False
-Stage <SwitchParameter>
Used to upload update to appliance and not apply update.
Aliases None
Required? false
Position? named
Default value False

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Write-Progress
Will display a progress bar indicating the Appliance Update status
System.Collections.ArrayList (System.Management.Automation.PSCustomObject)
When performing stage and install (no switch options provided), the return will include the uploaded patch information from the
appliance, and the completed upgrade message
Examples
-------------------------- EXAMPLE 1 --------------------------
Install-HPOVUpdate -file C:\Path\update.bin
Install the Update.bin package to the appliance. User will be prompted to accept the upgrade EULA, and if a reboot is required
also be prompted to confirm.
-------------------------- EXAMPLE 2 --------------------------
Install-HPOVUpdate -file C:\Path\update.bin -Stage -DisplayReleaseNotes
Stage the update on the appliance, and display the Release Notes to the PowerShell console.
-------------------------- EXAMPLE 3 --------------------------
Install-HPOVUpdate -file C:\Path\update.bin -Stage

Install-HPOVUpdate -EULA Accept -InstallNow
Stage the Update.bin package to the appliance. After update has been staged, install the update now on specified appliance.
-------------------------- EXAMPLE 4 --------------------------
Install-HPOVUpdate -ListPending -DisplayReleaseNotes
List a pending, staged updates on the appliance, then display the Release Notes to the PowerShell console. ### Related Links
***
Top
### HPE OneView 4.00 Library ## Install-HPOVUpdate
Install or stage an appliance update. ### SYNTAX
Install-HPOVUpdate [-File] <String> [-Eula] <String>[ [-DisplayReleaseNotes] <SwitchParameter>] [-ApplianceConne

ction] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Install-HPOVUpdate [-File] <String>[ [-Stage] <SwitchParameter>][ [-DisplayReleaseNotes] <SwitchParameter>] [-Ap

plianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Install-HPOVUpdate[ [-InstallNow] <SwitchParameter>] [-Eula] <String> [-ApplianceConnection] <Object>[ [-WhatIf]

Install-HPOVUpdate[ [-ListPending] <SwitchParameter>][ [-DisplayReleaseNotes] <SwitchParameter>] [-ApplianceConn

ection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
The Install-HPOVUpdate installs an appliance update package to upgrade the platform to the specified version. Use the -Stage
switch to stage an update on the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value

-DisplayReleaseNotes <SwitchParameter>
Display Release Notes of Update
Aliases None
Required? false
Position? named
Default value False
-Eula <String>
Will display EULA if no value is provided. Pass 'accept' to accept and not display EULA.
Aliases None
Required? true
Position? named
Default value
-File <String>
Aliases [-f] Appliance Update file to install.
Aliases f
Required? true
Position? named
Default value
-InstallNow <SwitchParameter>
Install pending update that was previously staged.
Aliases None
Required? false
Position? named
Default value False
-ListPending <SwitchParameter>
Aliases [-list] List any pending updates on the appliance that might have been staged.
Aliases list
Required? false
Position? named
Default value False
-Stage <SwitchParameter>
Used to upload update to appliance and not apply update.
Aliases None
Required? false
Position? named
Default value False
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Write-Progress
Will display a progress bar indicating the Appliance Update status
System.Collections.ArrayList (System.Management.Automation.PSCustomObject)
When performing stage and install (no switch options provided), the return will include the uploaded patch information from the
appliance, and the completed upgrade message
Examples
-------------------------- EXAMPLE 1 --------------------------
Install-HPOVUpdate -file C:\Path\update.bin

Install the Update.bin package to the appliance. User will be prompted to accept the upgrade EULA, and if a reboot is required
also be prompted to confirm.
-------------------------- EXAMPLE 2 --------------------------
Install-HPOVUpdate -file C:\Path\update.bin -Stage -DisplayReleaseNotes
Stage the update on the appliance, and display the Release Notes to the PowerShell console.
-------------------------- EXAMPLE 3 --------------------------
Install-HPOVUpdate -file C:\Path\update.bin -Stage

Install-HPOVUpdate -EULA Accept -InstallNow
Stage the Update.bin package to the appliance. After update has been staged, install the update now on specified appliance.
-------------------------- EXAMPLE 4 --------------------------
Install-HPOVUpdate -ListPending -DisplayReleaseNotes
List a pending, staged updates on the appliance, then display the Release Notes to the PowerShell console.
Related Links
Top
Invoke-HPOVVcmMigration

Invoke-HPOVVcmMigration
Migrate Virtual Connect Manager to HPE OneView.
SYNTAX
Invoke-HPOVVcmMigration [-OAIPAddress] <String> [-LicensingIntent] <String>[ [-OAUserName] <String>][ [-OAPasswo
rd] <String>][ [-OACredential] <PSCredential>][ [-VCMUserName] <String>][ [-VCMPassword] <String>][ [-VCMCredent
ial] <PSCredential>] [-EnclosureGroup] <Object> [-LogicalInterconnectGroup] <Object>[ [-Async] <SwitchParameter>
] [-ApplianceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Invoke-HPOVVcmMigration [-OAIPAddress] <String> [-LicensingIntent] <String> [-VCEMCMS] <String>[ [-OAUserName] <

String>][ [-OAPassword] <String>][ [-OACredential] <PSCredential>][ [-VCMUserName] <String>][ [-VCMPassword] <St
ring>][ [-VCMCredential] <PSCredential>] [-EnclosureGroup] <Object> [-LogicalInterconnectGroup] <Object>[ [-VCEM
User] <String>][ [-VCEMPassword] <String>][ [-VCEMCredential] <PSCredential>] [-ApplianceConnection] <Object> [-
WhatIf] <> [-Confirm] <> [<CommonParameters>]
Invoke-HPOVVcmMigration [-OAIPAddress] <String> [-LicensingIntent] <String>[ [-Report] <SwitchParameter>][ [-OAU
serName] <String>][ [-OAPassword] <String>][ [-OACredential] <PSCredential>][ [-VCMUserName] <String>][ [-VCMPas
sword] <String>][ [-VCMCredential] <PSCredential>] [-EnclosureGroup] <Object> [-LogicalInterconnectGroup] <Objec
t>[ [-Path] <String>] [-ApplianceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This function is used to migrate an existing Virtual Connect Manager configuration to HPE OneView. If an enclosure was added
to an HPE OneView appliance as Monitor-Only, then you must first remove the enclosure from the appliance, and then use this
cmdlet to migrate the enclosure.
Using the -VCEMCMS, -VCEMUser and -VCEMPassword parameters, the targeted Virtual Connect Domain can be removed
from a Virual Connect Enterprise Manager Domain Group first before initiating the VC Migration tool within the HPE OneView
appliance.
The required VCEM 7.3/7.4 Patch is available here: ftp://ftp.hp.com/pub/softlib2/software1/pubsw-

generic/p270829882/v106568.
VCEM 7.4.1 or greater users do not require the patch to be installed, as the API is built into 7.4.1 or greater.
It is important to also have a Virtual Connect Domain Backup prior to migration. You may also want to gather the output from the
"show config -includepoolinfo" VCM CLI command to review or verify resources were migrated successfully.
Please read "Chapter 9 Planning for enclosure migration from VCM into HPE OneView" in the HPE OneView 1.20 User Guide for
more information about migration and other planning resources.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases NoWait
Required? false
Position? named
Default value False
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases [-eg] OPTIONAL. The Name, URI or Object of an existing Enclosure Group. If the Enclosure Group Name does not exist,
a new resource with the String value provided will be created. If omitted, a new Enclosure Group will be created based on the
Serial Number of the Enclosure (Example: "EG_USE1234567A").
Aliases eg
Required? true
Position? named
Default value
Aliases [-license, -l] REQUIRED. Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the
servers in the enclosure being imported.
Accepted values are
* OneView
* OneViewNoiLO
Aliases license, l
Required? true
Position? named
Default value
-LogicalInterconnectGroup <Object>
Aliases [-lig] OPTIONAL. The Name, URI or Object of an existing Logical Interconnect Group. If the Logical Interconnect Group
Name does not exist, a new resource with the String value provided will be created. If omitted, a new Logical Interconnect Group
will be created based on the Serial Number of the Enclosure (Example: "LIG_USE1234567A").
Aliases lig
Required? true
Position? named
Default value
-OACredential <PSCredential>
PSCredential object containing the username and password details for the c-Class Onboard Administrator.
Aliases None
Required? false
Position? named
Default value
-OAIPAddress <String>
Aliases [-oaip] REQUIRED. IP address or FQDN of the Primary Onboard Administrator in the target enclosure.
Aliases oip
Required? true
Position? named
Default value
-OAPassword <String>
Aliases [-op] Parameter is being deprecated. Please transition to using -OACredential. Password for the Administrator account
of the target OA.
Aliases op
Required? false
Position? named
Default value
-OAUserName <String>
Aliases [-ou] Parameter is being deprecated. Please transition to using -OACredential. Administrator account of the target OA.
Aliases ou
Required? false
Position? named
Default value

-Path <String>
The directory path in which to save the report output to a file.
* Filename will be created in the format: [path]\{enclsoureName}_{date}.report
Aliases Export
Required? false
Position? named
Default value
OPTIONAL. Execute the migration report only. Do not execute the migration process.
Aliases None
Required? false
Position? named
Default value False
-VCEMCMS <String>
The IP Address or FQDN of the VCEM host.
Aliases None
Required? true
Position? named
Default value
-VCEMCredential <PSCredential>
PSCredential object containing the username and password details for the Virtual Connect Enterprise Manager associated with
the Virtual Connect Manager Domain.
Aliases None
Required? false
Position? named
Default value
-VCEMPassword <String>
Parameter is being deprecated. Please transition to using -VCEMCredential
Administrator level account password on the VCEM host.
Aliases None
Required? false
Position? named
Default value
-VCEMUser <String>
Parameter is being deprecated. Please transition to using -VCEMCredential
Administrator level account name available on the VCEM host.
Aliases None
Required? false
Position? named
Default value
-VCMCredential <PSCredential>
PSCredential object containing the username and password details for the c-Class Virtual Connect Manager.
Aliases None
Required? false
Position? named
Default value
-VCMPassword <String>
Aliases [-vp] Parameter is being deprecated. Please transition to using -VCMCredential. Password for the Administrator account
of Virtual Connect Manager.
Aliases vp
Required? false
Position? named
Default value
-VCMUserName <String>
Aliases [-vu] Parameter is being deprecated. Please transition to using -VCMCredential. Username for the administrator account
for Virtual Connect Manager.
Aliases vu
Required? false
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Valid Enclosure Group resource the appliance will migrate the source enclosure into
Return Values
Async task Resource object for monitoring the enclosure import process
Examples
-------------------------- EXAMPLE 1 --------------------------
$OACreds = Get-Credential -Username Administrator -Message "Password" $VCMCreds = Get-Credential -Username Admin
istrator -Message "Password" Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OACredential $OACreds -VCMCrede
ntial $VCMCreds -LicensingIntent OneView -Report
Generate Virtual Connect Manager configuration migration report for the specified enclosure.
-------------------------- EXAMPLE 2 --------------------------
istrator -Message "Password" Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OACredential $OACreds -VCMCrede
ntial $VCMCreds -LicensingIntent OneView
Migration will occur and create a new Enclosure Group and new Logical Interconnect Group based on the enclosure serial
number.
-------------------------- EXAMPLE 3 --------------------------
istrator -Message "Password" $EnclosureGroup = Get-HPOVEnclosureGroup -Name EnclosureGroup1 -ErrorAction Stop In
voke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OACredential $OACreds -VCMCredential $VCMCreds -LicensingInten
t OneView -EnclosureGroup $EnclosureGroup
Migration will occur and import the target enclosure into an existing Enclosure Group named "EnclosureGroup1".
-------------------------- EXAMPLE 4 --------------------------
Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OAUserName Administrator -OAPassword hpinvent -VCMUserName A

dministrator -VCMPassword hpinvent -licensingIntent OneView -Report -Path "c:\VCM-MigrationReports"
".
Migration will not be attempted. The migration report will be executed and the result saved to the file "c:\VCM-MigrationReports\
{enclosureName}_{date}.report".
-------------------------- EXAMPLE 5 --------------------------
istrator -Message "Password" $VCEMCreds = Get-Credential -Username Domain\Adminisrator -Message "Password" $Encl
osureGroup = Get-HPOVEnclosureGroup -Name EnclosureGroup1 -ErrorAction Stop Invoke-HPOVVcmMigration -OAIPAddress
192.168.19.40 -OACredential $OACreds -VCMCredential $VCMCreds -VCEMCMS vcemcms.domain.com -VCEMCredential $VCEM
Creds -LicensingIntent OneView
Perform a migration of a VCEM managed enclosure to HPE OneView. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Invoke-HPOVVcmMigration
Migrate Virtual Connect Manager to HP OneView. ### SYNTAX
Invoke-HPOVVcmMigration [-OAIPAddress] <String> [-OAUserName] <String> [-OAPassword] <String> [-VCMUserName] <St

ring> [-VCMPassword] <String> [-LicensingIntent] <String> [-EnclosureGroup] <Object> [-LogicalInterconnectGroup]
<Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm]

ring> [-VCMPassword] <String> [-LicensingIntent] <String> [-VCEMCMS] <String> [-VCEMUser] <String> [-VCEMPasswor
d] <String> [-EnclosureGroup] <Object> [-LogicalInterconnectGroup] <Object> [-ApplianceConnection] <Object>[ [-W
hatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

ring> [-VCMPassword] <String> [-LicensingIntent] <String>[ [-Report] <SwitchParameter>] [-EnclosureGroup] <Objec
t> [-LogicalInterconnectGroup] <Object> [-Export] <String> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchPar
ameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This function is used to migrate an existing Virtual Connect Manager configuration to HP OneView. If an enclosure was added to
an HP OneView appliance as Monitor-Only, then you must first remove the enclosure from the appliance, and then use this
cmdlet to migrate the enclosure.
Using the -VCEMCMS, -VCEMUser and -VCEMPassword parameters, the targeted Virtual Connect Domain can be removed
from a Virual Connect Enterprise Manager Domain Group first before initiating the VC Migration tool within the HP OneView
appliance.
The required VCEM 7.3/7.4 Patch is available here: ftp://ftp.hp.com/pub/softlib2/software1/pubsw-

generic/p270829882/v106568.
VCEM 7.4.1 or greater users do not require the patch to be installed, as the API is built into 7.4.1 or greater.
It is important to also have a Virtual Connect Domain Backup prior to migration. You may also want to gather the output from the
'show config -includepoolinfo' VCM CLI command to review or verify resources were migrated successfully.
Please read 'Chapter 9 Planning for enclosure migration from VCM into HP OneView' in the HP OneView 1.20 User Guide for
more information about migration and other planning resources.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases NoWait
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases [-eg] OPTIONAL. The Name, URI or Object of an existing Enclosure Group. If the Enclosure Group Name does not exist,
a new resource with the String value provided will be created. If omitted, a new Enclosure Group will be created based on the
Serial Number of the Enclosure (Example: 'EG_USE1234567A').
Aliases eg
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
-Export <String>
REQUIRED if the -report switch is provided. The directory path in which to save the report output to a file.
* Filename will be created in the format: [path]\{enclsoureName}_{date}.report
Aliases None
Required? true
Position? named
Default value
Aliases [-license, -l] REQUIRED. Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the
servers in the enclosure being imported.
Accepted values are
* OneView
* OneViewNoiLO
Aliases license, l
Required? true
Position? named
Default value
-LogicalInterconnectGroup <Object>
Aliases [-lig] OPTIONAL. The Name, URI or Object of an existing Logical Interconnect Group. If the Logical Interconnect Group
Name does not exist, a new resource with the String value provided will be created. If omitted, a new Logical Interconnect Group
will be created based on the Serial Number of the Enclosure (Example: 'LIG_USE1234567A').
Aliases lig
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)

-OAIPAddress <String>
Aliases [-oaip] REQUIRED. IP address or FQDN of the Primary Onboard Administrator in the target enclosure.
Aliases oip
Required? true
Position? named
Default value
-OAPassword <String>
Aliases [-op] REQUIRED. Password for the Administrator account of the target OA.
Aliases op
Required? true
Position? named
Default value
-OAUserName <String>
Aliases [-ou] REQUIRED. Administrator account of the target OA.
Aliases ou
Required? true
Position? named
Default value
OPTIONAL. Execute the migration report only. Do not execute the migration process.
Aliases None
Required? false
Position? named
Default value False
-VCEMCMS <String>
The IP Address or FQDN of the VCEM host.
Aliases None
Required? true
Position? named
Default value
-VCEMPassword <String>
Administrator level account password on the VCEM host.
Aliases None
Required? true
Position? named
Default value
-VCEMUser <String>
Administrator level account name available on the VCEM host.
Aliases None
Required? true
Position? named
Default value
-VCMPassword <String>
Aliases [-vp] REQUIRED. Password for the Administrator account of Virtual Connect Manager.
Aliases vp
Required? true
Position? named
Default value
-VCMUserName <String>
Aliases [-vu]
Aliases vu
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Valid Enclosure Group resource the appliance will migrate the source enclosure into
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVServerProfile -profile "Profile6"

Wait-HPOVTaskComplete $task.uri
Remove the profile specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$profile = Get-HPOVServerProfile -name "Profile2"

Remove-HPOVServerProfile $profile -confirm:$false
Remove the profile specifed by $profile. Disable confirmation prompt.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServerProfile | Remove-HPOVServerProfile
Search for all profiles and remove them from appliance.Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OAUse
rName Administrator -OAPassword hpinvent -VCMUserName Administrator -VCMPassword hpinvent -licensingIntent OneVi
ew
Migration will occur and create a new Enclosure Group and new Logical Interconnect Group based on the enclosure serial
number.
-------------------------- EXAMPLE 4 --------------------------

dministrator -VCMPassword hpinvent -eg "EnclosureGroup1" -licensingIntent OneView
Migration will occur and import the target enclosure into an existing Enclosure Group named "EnclosureGroup1"
-------------------------- EXAMPLE 5 --------------------------

dministrator -VCMPassword hpinvent -licensingIntent OneView -report -export "c:\VCM-MigrationReports"
The migration report will be executed and the result saved to the file "c:\VCM-MigrationReports{enclosureName}_{
date}.report".
Migration will not be attempted.
-------------------------- EXAMPLE 6 --------------------------

dministrator -VCMPassword hpinvent -licensingIntent OneView -VCEMCMS vcemcms.contoso.com -VCEMUser Domain\Admini
srator -VCEMPassword MyPassword
Perform a migration of a VCEM managed enclosure to HP OneView.
Related Links
Top
Invoke-HPOVWebBrowser

Start default web browser opened to appliance dashboard.
SYNTAX
Invoke-HPOVWebBrowser[ [-Resource] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will open the default web browser to the specified appliance, logged in with the same credentials as the PowerShell
library connection is authenticated with. To open multiple browser windows to each appliance connection, use the global
$ConnectedSessions variable to override the -ApplianceConnection parameter.
Parameters
Aliases Appliance
Required? false
Position? 1
-Resource <String>
Use to quickly jump to the specific UI section of the connected appliance. Allowed values:
* Dashboard
* Enclosures
* LogicaInterconnectGroups
* LogicalEnclosures
* LogicalInterconnects
* Networks
* RackManagers
* ServerHardware
* ServerProfiles
* ServerProfileTemplates
* Settings
* StoragePools
* StorageSystems
* StorageVolumes
By default, the Cmdlet will open your default web browser to the appliance dashboard.
Aliases None
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
Connect-HPOVMgmt -Hostname MyAppliance.domain.com -Username MyAccount -Password $MySecurePassword

Connect to the appliance, then launch default web browser to the appliance dashboard. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Invoke-HPOVWebBrowser
Start default web browser opened to appliance dashboard. ### SYNTAX
Invoke-HPOVWebBrowser[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will open the default web browser to the specified appliance, logged in with the same credentials as the PowerShell
library connection is authenticated with. To open multiple browser windows to each appliance connection, use the global
$ConnectedSessions variable to override the -ApplianceConnection parameter.
Parameters
Aliases Appliance
Required? false
Position? 0
<CommonParameters>
Input Types
Return Values
None.
Examples
-------------------------- EXAMPLE 1 --------------------------
Connect-HPOVMgmt -Hostname MyAppliance.domain.com -Username MyAccount -Password $MySecurePassword

Connect to the appliance, then launch default web browser to the appliance dashboard.
Related Links
Top

Attach an existing server profile to a server profile template
SYNTAX
Join-HPOVServerProfileToTemplate [-Template] <Object> [-ServerProfile] <Object> [-ApplianceConnection] <Object>
Binds a server profile resource to the provided server profile template
Parameters
Aliases Appliance
Required? true
Position? 2
Default value $Global:ConnectedSessions
Aliases [-Profile, -p] A server profile name, URI, or resource object
Aliases p, Profile
Required? true
Position? 1
Default value

-Template <Object>
A server profile template name, URI, or resource object
Aliases t
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
A PSCustom object representing a server profile template resource retrieved from the HPE OneView appliance
Return Values
System.Collections.ArrayList<HPOneView.Appliance.TaskResource>
Collection of task resource objects
An HPE OneView task resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Join-HPOVServerProfileToTemplate -template "MyTemplate" -profile "MyProfile" -appliance hpOneView.contoso.com
Attaches the server profile template named MyTemplate to the server profile name MyProfile on the OneView appliance
hpOneView.contoso.com
-------------------------- EXAMPLE 2 --------------------------
$p = Get-HPOVServerProfile "myProfile"
Get-HPOVServerProfileTemplate "myTemplate" | Join-HPOVServerProfileToTemplate -profile $p -appliance hpOneView.c
ontoso.com
hpOneView.contoso.com ### Related Links ***
Top
### HPE OneView 4.00 Library ## Join-HPOVServerProfileToTemplate
Attach an existing server profile to a server profile template ### SYNTAX

Join-HPOVServerProfileToTemplate [-Template] <Object> [-ServerProfile] <Object> [-ApplianceConnection] <Object>
Binds a server profile resource to the provided server profile template
Parameters
Aliases Appliance
Required? true
Position? 2
Default value $Global:ConnectedSessions
Aliases [-Profile, -p] A server profile name, URI, or resource object
Aliases p, Profile
Required? true
Position? 1
Default value
-Template <Object>
A server profile template name, URI, or resource object
Aliases t
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
A PSCustom object representing a server profile template resource retrieved from the HPE OneView appliance
Return Values
System.Collections.ArrayList<HPOneView.Appliance.TaskResource>
Collection of task resource objects
An HPE OneView task resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Join-HPOVServerProfileToTemplate -template "MyTemplate" -profile "MyProfile" -appliance hpOneView.contoso.com
-------------------------- EXAMPLE 2 --------------------------
$p = Get-HPOVServerProfile "myProfile"
Get-HPOVServerProfileTemplate "myTemplate" | Join-HPOVServerProfileToTemplate -profile $p -appliance hpOneView.c
ontoso.com
Related Links
Top

Create an Address Range.
SYNTAX
New-HPOVAddressPoolRange [-PoolType] <String> [-RangeType] <String> [-ApplianceConnection] <Object> [<CommonPara
meters>]
New-HPOVAddressPoolRange [-IPv4Subnet] <Object> [-Name] <String> [-Start] <String> [-End] <String> [-ApplianceCo
nnection] <Object> [<CommonParameters>]
New-HPOVAddressPoolRange [-PoolType] <String> [-RangeType] <String> [-Start] <String> [-End] <String> [-Applianc
eConnection] <Object> [<CommonParameters>]
This cmdlet will assist with creating a new Address Pool Range. The support Address Pool Types are MAC Addresses (VMAC),
Fibre Channel/FCoE World Wide Name (VWWN), Server Serial Number (VSN), and IPv4 Address Pools (IPv4).
When creating new Address Pool Ranges, the Generated Range Type will allocate 1,048,576 MAC or WWN addresses,
whereas it will allocate 46,656 Serial Numbers.
If you specify a Custom Range Type, you must specify a range of addresses no smaller than 128, and no more than 1,048,576
per range.
Custom Address Ranges must adhere to the following format rules:
* The MAC Address must be IEEE Compliant, and the format must be XH:XX:XX:XX:XX:XX, where H must be 0, 2, 4, 6,
8, A, C or E.
Example: 12:22:33:44:55:00
* The WWN Address must be IEEE compliant, and the format must be 10:00:XH:XX:XX:XX:XX:XX, where H must be 0, 2,
4, 6, 8, A, C or E.
Example: 10:00:6C:9F:06:B0:00:00
* The Serial Number addresses must start with VCU, and cannot contain more than 10 characters total.
Example: VCU1234567
IPv4 Address Subnets do not support Auto Generated, as the RangeType parameter is not required. When creating a new IPv4
Address Subnet, you must provide a unique Name, Subnet Mask (CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]),
Start and End IPv4 Address, Gateway and Domain Name. DNS Servers are optional. To add more Address Ranges to a Subnet
after creating it, please use the Add-HPOVAddressRange CMDLET.
Parameters
When attempting to create a new IPv4 Address Pool/Subnet, only a single HPOneView.Appliance.Connection object or Name
property value is allowed. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be
used.
Aliases Appliance
Required? true
Position? named
-End <String>
The ending address in the range. Cannot overlap with other address ranges, and should be unique within the
datacenter/infrastructure.
Aliases None
Required? true
Position? named
Default value
-IPv4Subnet <Object>
The IPv4 Subnet that the new IPv4 Range will be assigned to. Start and End values must be within the Network ID and Subnet
value of the IPv4 Address Subnet Pool.
Aliases Subnet
Required? true
Position? named
Default value
-Name <String>
Provide the IPv4Address Pool Range Name.
Aliases None
Required? true
Position? named
Default value
-PoolType <String>
Specify the Pool Type the new Range will be assinged to. Accepted values are:
* VMAC
* VWWN
* VSN
Aliases None
Required? true
Position? named
Default value

-RangeType <String>
The type of Address Range to create (not applicable for IPv4 Address Pools/Subnets). Accepted values are:
* Generated
* Custom
Aliases None
Required? true
Position? named
Default value Generated
-Start <String>
The starting address in the range. Cannot overlap with other address ranges, and should be unique within the
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
IPv4 Address Subnet resource object from Get-HPOVAddressPoolSubnet
Return Values
Newly created and assigned Address Pool Range resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
PS C:> New-HPOVAddressPoolRange -PoolType vmac -RangeType Generated
Create a new Appliance generated VMAC Pool Range.

-------------------------- EXAMPLE 2 --------------------------
PS C:> New-HPOVAddressPoolRange -PoolType vwwn -RangeType Custom -Start 10:00:6C:9F:06:B0:00:00 -End 10:00:6C:9F
:06:BF:FF:FF
Create a new VWWN Address Pool Range with the custom addresses, for the MyAppliance1.domain.com appliance connection.
-------------------------- EXAMPLE 3 --------------------------
PS C:> Get-HPOVAddressPoolSubnet -NetworkId 192.168.20.0 | New-HPOVAddressPoolRange -Name "VLAN20 Mgmt" -Start 1

92.168.20.100 -end 192.168.20.200
Create a new IPv4 Address Pool Range, for the MyAppliance1.domain.com appliance connection. ### Related Links * [Get-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAddressPoolRange) * [Remove-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVAddressPoolRange) ***
Top
### HPE OneView 4.00 Library ## New-HPOVAddressPoolRange
Create an Address Range. ### SYNTAX
New-HPOVAddressPoolRange [-PoolType] <String> [-RangeType] <String> [-ApplianceConnection] <Object> [<CommonPara

meters>]
New-HPOVAddressPoolRange [-IPv4Subnet] <Object> [-Name] <String> [-Start] <String> [-End] <String> [-ApplianceCo
New-HPOVAddressPoolRange [-PoolType] <String> [-RangeType] <String> [-Start] <String> [-End] <String> [-Applianc
eConnection] <Object> [<CommonParameters>]
This cmdlet will assist with creating a new Address Pool Range. The support Address Pool Types are MAC Addresses (VMAC),
Fibre Channel/FCoE World Wide Name (VWWN), Server Serial Number (VSN), and IPv4 Address Pools (IPv4).
When creating new Address Pool Ranges, the Generated Range Type will allocate 1,048,576 MAC or WWN addresses,
whereas it will allocate 46,656 Serial Numbers.
If you specify a Custom Range Type, you must specify a range of addresses no smaller than 128, and no more than 1,048,576
per range.
Custom Address Ranges must adhere to the following format rules:
* The MAC Address must be IEEE Compliant, and the format must be XH:XX:XX:XX:XX:XX, where H must be 0, 2, 4, 6,
8, A, C or E.
Example: 12:22:33:44:55:00
* The WWN Address must be IEEE compliant, and the format must be 10:00:XH:XX:XX:XX:XX:XX, where H must be 0, 2,
4, 6, 8, A, C or E.
Example: 10:00:6C:9F:06:B0:00:00
* The Serial Number addresses must start with VCU, and cannot contain more than 10 characters total.
Example: VCU1234567
IPv4 Address Subnets do not support Auto Generated, as the RangeType parameter is not required. When creating a new IPv4
Address Subnet, you must provide a unique Name, Subnet Mask (CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]),
Start and End IPv4 Address, Gateway and Domain Name. DNS Servers are optional. To add more Address Ranges to a Subnet
after creating it, please use the Add-HPOVAddressRange CMDLET.
Parameters
When attempting to create a new IPv4 Address Pool/Subnet, only a single HPOneView.Appliance.Connection object or Name
property value is allowed. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be
used.
Aliases Appliance
Required? true
Position? named
-End <String>
The ending address in the range. Cannot overlap with other address ranges, and should be unique within the
Aliases None
Required? true
Position? named
Default value
The IPv4 Subnet that the new IPv4 Range will be assigned to. Start and End values must be within the Network ID and Subnet
value of the IPv4 Address Subnet Pool.
Aliases Subnet
Required? true
Position? named
Default value
-Name <String>
Provide the IPv4Address Pool Range Name.
Aliases None
Required? true
Position? named
Default value
-PoolType <String>
Specify the Pool Type the new Range will be assinged to. Accepted values are:
* VMAC
* VWWN
* VSN
Aliases None
Required? true
Position? named
Default value
-RangeType <String>
The type of Address Range to create (not applicable for IPv4 Address Pools/Subnets). Accepted values are:
* Generated
* Custom
Aliases None
Required? true
Position? named
Default value Generated
-Start <String>
The starting address in the range. Cannot overlap with other address ranges, and should be unique within the
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
IPv4 Address Subnet resource object from Get-HPOVAddressPoolSubnet
Return Values
Newly created and assigned Address Pool Range resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
PS C:> New-HPOVAddressPoolRange -PoolType vmac -RangeType Generated
Create a new Appliance generated VMAC Pool Range.
-------------------------- EXAMPLE 2 --------------------------
PS C:> New-HPOVAddressPoolRange -PoolType vwwn -RangeType Custom -Start 10:00:6C:9F:06:B0:00:00 -End 10:00:6C:9F
:06:BF:FF:FF
Create a new VWWN Address Pool Range with the custom addresses, for the MyAppliance1.domain.com appliance connection.
-------------------------- EXAMPLE 3 --------------------------
PS C:> Get-HPOVAddressPoolSubnet -NetworkId 192.168.20.0 | New-HPOVAddressPoolRange -Name 'VLAN20 Mgmt' -Start 1

92.168.20.100 -end 192.168.20.200
Create a new IPv4 Address Pool Range, for the MyAppliance1.domain.com appliance connection.
Related Links
Top

Create an IPv4 Subnet Pool.
SYNTAX
New-HPOVAddressPoolSubnet [-NetworkId] <IPAddress> [-SubnetMask] <String> [-Gateway] <IPAddress> [-Domain] <Stri
ng> [-DNSServers] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will assist with creating a new IPv4 Address Pool. When creating a new IPv4 Address Subnet, you must provide the
Network ID, Subnet Mask (CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]), Gateway and Domain Name. DNS
Servers are optional.
To add IPv4 Address Ranges to a Subnet after creating it, please use the New-HPOVAddressPoolRange CMDLET.
Parameters
Aliases Appliance
Required? true
Position? named
-DNSServers <Array>
An array of DNS Server IPv4 Addresses.
Aliases None
Required? true
Position? named
Default value
-Domain <String>
DNS Domain Name of the subnet.
Aliases None
Required? true
Position? named
Default value
-Gateway <IPAddress>
IPv4 Address of the default gateway for the subnet.
Aliases None
Required? true
Position? named
Default value
-NetworkId <IPAddress>
The IPv4 Network ID value of the subnet.
Aliases None
Required? true
Position? named
Default value
-SubnetMask <String>
CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Newly created IPv4 Address Subnet
Examples
-------------------------- EXAMPLE 1 --------------------------
PS C:> New-HPOVAddressPoolSubnet -NetworkID 192.168.10.0 -Subnetmask 24 -Gateway 192.168.10.254 -Domain vlan10.d

omain.com -DNSServers 10.250.33.12,10.250.34.80
Create a new IPv4 Address Pool with the specified values. ### Related Links * [Get-HPOVAddressPoolSubnet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAddressPoolSubnet) * [Remove-HPOVAddressPoolSubnet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVAddressPoolSubnet) * [Set-HPOVAddressPoolSubnet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVAddressPoolSubnet) ***
Top
### HPE OneView 4.00 Library ## New-HPOVAddressPoolSubnet
Create an IPv4 Subnet Pool. ### SYNTAX
New-HPOVAddressPoolSubnet [-NetworkId] <IPAddress> [-SubnetMask] <String> [-Gateway] <IPAddress> [-Domain] <Stri

ng> [-DNSServers] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will assist with creating a new IPv4 Address Pool. When creating a new IPv4 Address Subnet, you must provide the
Network ID, Subnet Mask (CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]), Gateway and Domain Name. DNS
Servers are optional.
To add IPv4 Address Ranges to a Subnet after creating it, please use the New-HPOVAddressPoolRange CMDLET.
Parameters
Aliases Appliance
Required? true
Position? named
-DNSServers <Array>
Aliases None
Required? true
Position? named
Default value
-Domain <String>
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-NetworkId <IPAddress>
The IPv4 Network ID value of the subnet.
Aliases None
Required? true
Position? named
Default value
-SubnetMask <String>
CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Newly created IPv4 Address Subnet
Examples
-------------------------- EXAMPLE 1 --------------------------
PS C:> New-HPOVAddressPoolSubnet -NetworkID 192.168.10.0 -Subnetmask 24 -Gateway 192.168.10.254 -Domain vlan10.d

omain.com -DNSServers 10.250.33.12,10.250.34.80
Create a new IPv4 Address Pool with the specified values.
Related Links
Top
New-HPOVApplianceCsr

Generate appliance CSR
SYNTAX
New-HPOVApplianceCsr [-Country] <String> [-State] <String> [-Organization] <String> [-CommonName] <String> [-Cit
y] <String> [-OrganizationalUnit] <String> [-AlternativeName] <String> [-ContactName] <String> [-Email] <String>
[-Surname] <String> [-GivenName] <String> [-Initials] <String> [-DNQualifier] <String> [-ChallengePassword] <Str
ing> [-UnstructuredName] <String>[ [-CnsaCompliantRequest] <bool>] [-ApplianceConnection] <Object> [<CommonParam
eters>]
This cmdlet will create the CSR for an given appliance, to then be submitted to a CA.
Parameters
-AlternativeName <String>
Aliases [-SAN] An optional entry containing additional names that apply to the owner of the certificate, possibly including
additional e-mail addresses, DNS names, IP addresses and other identifiers.
Example: "hpov.example.com,hpov,192.168.1.1"
Aliases SAN
Required? true
Position? named
Default value
Aliases Appliance
Required? true
Position? named
-ChallengePassword <String>
The challenge password is a required entry and must contain a minimum of 8 characters. If you wish to be prompted to supply
the password, use an asterisk (*) character.
Aliases None
Required? true
Position? named
Default value
-City <String>
Aliases [-L, -Locality] The city or locality is a required entry, can contain up to 128 characters.
Aliases L, Locality
Required? true
Position? named
Default value
-CnsaCompliantRequest <bool>
Specify to create a CNSA compliant certificate request. By default the certificate request will create a 2048bit key length, while
CNSA compliant will create a 3072bit key length.
Aliases None
Required? false
Position? named
Default value
-CommonName <String>
Aliases [-CN] The common name is a required entry, and can be FQDN/hostname or IPv4/IPv6 address.
Example: "hpov.example.com"
Aliases CN
Required? true
Position? named
Default value
-ContactName <String>
Aliases [-Contact] The name of the contact person, may not exceed 64 characters.
Aliases Contact
Required? true
Position? named
Default value
-Country <String>
Aliases [-C] The country code in either Full English or ISO3166-2 two-character format, is a required entry and must contain
only two letters.
Aliases C
Required? true
Position? named
Default value
-DNQualifier <String>
The distinguished name qualifier, which further identifies the certificate recipient, which may not exceed 128 characters.
Aliases None
Required? true
Position? named
Default value
-Email <String>
The contact person"s email address, which may not exceed 128 characters and is of the format name@domain.
Aliases None
Required? true
Position? named
Default value
-GivenName <String>
Aliases [-Giv] The contact person"s first name, which may not exceed 64 characters.
Aliases Giv
Required? true
Position? named
Default value
-Initials <String>
The contact person"s initials, which may not exceed 20 characters.
Aliases None
Required? true
Position? named
Default value
-Organization <String>
Aliases [-O] The organization name is a required entry, can contain up to 64 characters.
Aliases O
Required? true
Position? named
Default value
-OrganizationalUnit <String>
Aliases [-OU] The entry for the organizational unit name, may not exceed 64 characters.
Aliases OU
Required? true
Position? named
Default value
-State <String>
Aliases [-ST, -Province] The state or province is a required entry, can contain up to 128 characters.
Aliases ST, Province
Required? true
Position? named
Default value
-Surname <String>
Aliases [-Sur] The contact person"s family name, which may not exceed 64 characters.
Aliases Sur
Required? true
Position? named
Default value
-UnstructuredName <String>
Aliases [-UN] Defined by the certificate authority, and may contain up to 64 characters. Consult the certificate authority"s
administrator or documentation for more information.
Aliases UN
Required? true
Position? named
Default value

<CommonParameters>
Input Types
Return Values
Object that contains the base64data property, which can then be written to a file or submitted to CA
Examples
-------------------------- EXAMPLE 1 --------------------------
$CSR = @{
>> Country = "US";
>> State = "California";
>> City = "Palo Alto";
>> Organization = "Hewlett-Packard";
>> CommonName = "hpov.example.com";
>> AlternativeName = "hpov.example.com,192.168.1.1,hpov"
>> }
>>
$request = New-HPOVApplianceCsr @CSR -ApplianceConnection Appliance.domain.com
Set-Content -path C:\dir\hpov.csr -value $request.base64Data -Force
Create a CSR request to submit to CA. ### Related Links ***

Top
### HPE OneView 4.00 Library ## New-HPOVApplianceCsr
Generate appliance CSR ### SYNTAX
New-HPOVApplianceCsr [-Country] <String> [-State] <String> [-Organization] <String> [-CommonName] <String> [-Cit
y] <String> [-OrganizationalUnit] <String> [-AlternativeName] <String> [-ContactName] <String> [-Email] <String>
[-Surname] <String> [-GivenName] <String> [-Initials] <String> [-DNQualifier] <String> [-ChallengePassword] <Str
ing> [-UnstructuredName] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will create the CSR for an given appliance, to then be submitted to a CA.
Parameters
Aliases SAN
Required? true
Position? named
Default value
Aliases Appliance
Required? true
Position? named
-ChallengePassword <String>
The challenge password is a required entry and must contain a minimum of 8 characters. If you wish to be prompted to supply
the password, use an asterisk (*) character.
Aliases None
Required? true
Position? named
Default value
-City <String>
Aliases L, Locality
Required? true
Position? named
Default value
Aliases CN
Required? true
Position? named
Default value
Aliases Contact
Required? true
Position? named
Default value
-Country <String>
only two letters.
Aliases C
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-Email <String>
The contact person's email address, which may not exceed 128 characters and is of the format name@domain.
Aliases None
Required? true
Position? named
Default value
-GivenName <String>
Aliases [-Giv] The contact person's first name, which may not exceed 64 characters.
Aliases Giv
Required? true
Position? named
Default value
-Initials <String>
The contact person's initials, which may not exceed 20 characters.
Aliases None
Required? true
Position? named
Default value
Aliases O
Required? true
Position? named
Default value
Aliases OU
Required? true
Position? named
Default value

-State <String>
Required? true
Position? named
Default value
-Surname <String>
Aliases [-Sur] The contact person's family name, which may not exceed 64 characters.
Aliases Sur
Required? true
Position? named
Default value
-UnstructuredName <String>
Aliases [-UN] Defined by the certificate authority, and may contain up to 64 characters. Consult the certificate authority's
administrator or documentation for more information.
Aliases UN
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Object that contains the base64data property, which can then be written to a file or submitted to CA
Examples
-------------------------- EXAMPLE 1 --------------------------
$CSR = @{
Country = "US";
State = "California";
City = "Palo Alto";
Organization = "Hewlett-Packard";
CommonName = "hpov.example.com";
AlternativeName = "hpov.example.com,192.168.1.1,hpov"
}
$request = New-HPOVApplianceCsr @CSR -ApplianceConnection Appliance.domain.com

Set-Content -path C:\dir\hpov.csr -value $request.base64Data -Force
Create a CSR request to submit to CA.
Related Links
Top
New-HPOVApplianceSelfSignedCertificate

Create a new appliance Self-Signed Certificate.
SYNTAX
New-HPOVApplianceSelfSignedCertificate [-Country] <String> [-State] <String> [-Organization] <String> [-CommonNa
me] <String> [-City] <String> [-OrganizationalUnit] <String> [-AlternativeName] <String> [-ContactName] <String>
[-Email] <String> [-Surname] <String> [-GivenName] <String> [-Initials] <String> [-DNQualifier] <String> [-Appli
anceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Use thid CMDLET to create or recreate a Self-Signed Certificate for the appliance.
Parameters
Aliases SAN
Required? true
Position? named
Default value
Aliases Appliance
Required? true
Position? named
-City <String>
Aliases L, Locality
Required? true
Position? named
Default value
Aliases CN
Required? true
Position? named
Default value

-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases Contact
Required? true
Position? named
Default value
-Country <String>
only two letters.
Aliases C
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-Email <String>
The contact person"s email address, which may not exceed 128 characters and is of the format name@domain.
Aliases None
Required? true
Position? named
Default value
-GivenName <String>
Aliases [-Giv] The contact person"s first name, which may not exceed 64 characters.
Aliases Giv
Required? true
Position? named
Default value
-Initials <String>
The contact person"s initials, which may not exceed 20 characters.
Aliases None
Required? true
Position? named
Default value
Aliases O
Required? true
Position? named
Default value
Aliases OU
Required? true
Position? named
Default value
-State <String>
Required? true
Position? named
Default value
-Surname <String>
Aliases [-Sur] The contact person"s family name, which may not exceed 64 characters.
Aliases Sur
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Object that contains the "base64data" property of the certificate

Examples
-------------------------- EXAMPLE 1 --------------------------
$CSR = @{
>> Country = "US";
>> State = "California";
>> City = "Palo Alto";
>> Organization = "Hewlett-Packard";
>> CommonName = "hpov.example.com";
>> AlternativeName = "hpov.example.com,192.168.1.1,hpov"
>> }
>>
New-HPOVApplianceSelfSignedCertificate @CSR -ApplianceConnection Appliance.domain.com
Generate Self-Signed Certificate for the appliance. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVApplianceSelfSignedCertificate
Create a new appliance Self-Signed Certificate. ### SYNTAX
New-HPOVApplianceSelfSignedCertificate [-Country] <String> [-State] <String> [-Organization] <String> [-CommonNa

me] <String> [-City] <String> [-OrganizationalUnit] <String> [-AlternativeName] <String> [-ContactName] <String>
[-Email] <String> [-Surname] <String> [-GivenName] <String> [-Initials] <String> [-DNQualifier] <String> [-Appli
anceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Use thid CMDLET to create or recreate a Self-Signed Certificate for the appliance.
Parameters
Aliases SAN
Required? true
Position? named
Default value
Aliases Appliance
Required? true
Position? named
-City <String>
Aliases L, Locality
Required? true
Position? named
Default value
Aliases CN
Required? true
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases Contact
Required? true
Position? named
Default value

-Country <String>
only two letters.
Aliases C
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-Email <String>
The contact person's email address, which may not exceed 128 characters and is of the format name@domain.
Aliases None
Required? true
Position? named
Default value
-GivenName <String>
Aliases [-Giv] The contact person's first name, which may not exceed 64 characters.
Aliases Giv
Required? true
Position? named
Default value
-Initials <String>
The contact person's initials, which may not exceed 20 characters.
Aliases None
Required? true
Position? named
Default value
Aliases O
Required? true
Position? named
Default value
Aliases OU
Required? true
Position? named
Default value
-State <String>
Required? true
Position? named
Default value
-Surname <String>
Aliases [-Sur] The contact person's family name, which may not exceed 64 characters.
Aliases Sur
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Object that contains the 'base64data' property of the certificate
Examples
-------------------------- EXAMPLE 1 --------------------------
$CSR = @{
Country = "US";
State = "California";
City = "Palo Alto";
Organization = "Hewlett-Packard";
CommonName = "hpov.example.com";
AlternativeName = "hpov.example.com,192.168.1.1,hpov"
}
New-HPOVApplianceSelfSignedCertificate @CSR -ApplianceConnection Appliance.domain.com
Generate Self-Signed Certificate for the appliance.

Related Links
Top

Create a new appliance SNMP trap destiation.
SYNTAX
New-HPOVApplianceTrapDestination [-Destination] <String> [-CommunityString] <String>[ [-Port] <int>][ [-Type] <S
tring>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
New-HPOVApplianceTrapDestination [-Destination] <String> [-SnmpV3User] <HPOneView.Appliance.SnmpV3User>[ [-Port]

<int>][ [-Type] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? False
Position? named
-CommunityString <String>
SNMPv1 trap community string.
Aliases None
Required? true
Position? named
Default value
IP Address or Hostname of the target SNMP trap reciever.
Aliases None
Required? true
Position? named
Default value
-Port <int>
Specify the alternate SNMP destination port.
Aliases None
Required? false
Position? named
Default value 161
-SnmpV3User <HPOneView.Appliance.SnmpV3User>
The defined SNMPv3 user created on the appliance with Get-HPOVSnmpV3User.
Aliases None
Required? true
Position? named
Default value
-Type <String>
SNMP version type. Allowed values:
* SNMPv1
* SNMPv3
Aliases None
Required? false
Position? named
Default value SNMPv1
<CommonParameters>
Input Types
Return Values
The configured SNMPv1 Trap Destination on the appliance.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVApplianceTrapDestination -Destination $SnmpV1TrapDestinationAddress -Type SNMPv1 -Port $SnmpV1TrapDestin

ationPort -CommunityString $SnmpV1Community
Create a new SNMPv1 trap destination on the appliance.

-------------------------- EXAMPLE 2 --------------------------
$SnmpV3Password = ConvertTo-SecureString -String $CommonPassword -AsPlainText -Force

$Snmpv3User = New-HPOVSnmpV3User -ApplianceSnmpUser -Username Tr@pUser -SecurityLevel AuthAndPriv -AuthProtocol
SHA512 -AuthPassword $SnmpV3Password -PrivProtocol AES192 -PrivPassword $SnmpV3Password
New-HPOVApplianceTrapDestination -Type SnmpV3 -SnmpV3User $CreatedSnmpSnmpv3UserV3User -Destination monitor1.con
toso.com
Define a new SNMPv3 user, and associate it with the new SNMPv3 trap destination on the appliance. ### Related Links * [Get-
HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceTrapDestination) * [Remove-HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVApplianceTrapDestination) ***
Top
### HPE OneView 4.00 Library ## New-HPOVApplianceTrapDestination
Create a new appliance SNMP trap destiation. ### SYNTAX
New-HPOVApplianceTrapDestination [-Destination] <String> [-CommunityString] <String>[ [-Port] <int>][ [-Type] <S

tring>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
New-HPOVApplianceTrapDestination [-Destination] <String> [-SnmpV3User] <HPOneView.Appliance.SnmpV3User>[ [-Port]

<int>][ [-Type] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? False
Position? named
-CommunityString <String>
SNMPv1 trap community string.
Aliases None
Required? true
Position? named
Default value
IP Address or Hostname of the target SNMP trap reciever.
Aliases None
Required? true
Position? named
Default value
-Port <int>
Specify the alternate SNMP destination port.
Aliases None
Required? false
Position? named
Default value 161
The defined SNMPv3 user created on the appliance with Get-HPOVSnmpV3User.
Aliases None
Required? true
Position? named
Default value
-Type <String>
SNMP version type. Allowed values:
* SNMPv1
* SNMPv3
Aliases None
Required? false
Position? named
<CommonParameters>
Input Types
Return Values

Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVApplianceTrapDestination -Destination $SnmpV1TrapDestinationAddress -Type SNMPv1 -Port $SnmpV1TrapDestin

ationPort -CommunityString $SnmpV1Community
Create a new SNMPv1 trap destination on the appliance.
-------------------------- EXAMPLE 2 --------------------------
$SnmpV3Password = ConvertTo-SecureString -String $CommonPassword -AsPlainText -Force

$Snmpv3User = New-HPOVSnmpV3User -ApplianceSnmpUser -Username Tr@pUser -SecurityLevel AuthAndPriv -AuthProtocol
SHA512 -AuthPassword $SnmpV3Password -PrivProtocol AES192 -PrivPassword $SnmpV3Password
New-HPOVApplianceTrapDestination -Type SnmpV3 -SnmpV3User $CreatedSnmpSnmpv3UserV3User -Destination monitor1.con
toso.com
Define a new SNMPv3 user, and associate it with the new SNMPv3 trap destination on the appliance.
Related Links
Top
New-HPOVBackup

New-HPOVBackup
Generate and download or remote save appliance backup.
SYNTAX
New-HPOVBackup [-Location] <String>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceConnect
ion] <Array> [<CommonParameters>]
backup file.
Use this cmdlet to generate and download an appliance configuration backup file for backup purposes. The backup file does not
contain user account passwords. The backup file is not meant to restore to other appliance for quick provisioning, as it is an
encrypted TAR GZIP file.
If an automatic backup policy is configured on the appliance, the Cmdlet is instruct the appliance to offload the newly created
backup to the remote location. If you wish to download the backup, use the -Location and -Force parameters, which will initiate a
download to the value provided.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
The Cmdlet will validate if the appliance is configured to save backup files to a remote location. Use this option to force
download the backup file instead of copying to the remote location.
Aliases None
Required? false
Position? named
Default value False
-Location <String>
Aliases [-save]
The full path to where the Support Dump will be saved to. The downloaded file name will be generated by the appliance. If the
directory does not exist, it will be created. By default will use current directory.
Aliases save
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
Async task to create the backup file.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVBackup
This command will generate a new backup, and if a remote location is configured, will initiate the file transfer. If not configured,
then the Cmdlet will download the file to the current working directory.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVBackup "c: emp" -Force
This command will save the Appliance backup file to C: emp ### Related Links * [Get-HPOVBackup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVBackup) * [Save-HPOVBackup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVBackup) ***
Top
### HPE OneView 4.00 Library ## New-HPOVBackup
Generate and download or remote save appliance backup. ### SYNTAX
New-HPOVBackup [-Location] <String>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceConnect

ion] <Array> [<CommonParameters>]
backup file.
Use this cmdlet to generate and download an appliance configuration backup file for backup purposes. The backup file does not
contain user account passwords. The backup file is not meant to restore to other appliance for quick provisioning, as it is an
encrypted TAR GZIP file.
If an automatic backup policy is configured on the appliance, the Cmdlet is instruct the appliance to offload the newly created
backup to the remote location. If you wish to download the backup, use the -Location and -Force parameters, which will initiate a
download to the value provided.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
The Cmdlet will validate if the appliance is configured to save backup files to a remote location. Use this option to force
download the backup file instead of copying to the remote location.
Aliases None
Required? false
Position? named
Default value False
-Location <String>
Aliases [-save]
directory does not exist, it will be created. By default will use current directory.
Aliases save
Required? true
Position? named
<CommonParameters>
Input Types
Return Values
Async task to create the backup file.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVBackup
This command will generate a new backup, and if a remote location is configured, will initiate the file transfer. If not configured,
then the Cmdlet will download the file to the current working directory.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVBackup "c:\temp" -Force
This command will save the Appliance backup file to C:\Temp
Related Links
Get-HPOVBackup
Save-HPOVBackup
Top


Default content
SYNTAX
New-HPOVClusterProfile [-Name] <string> [-ClusterManager] <HypervisorManager> [-ClusterManagerLocation] <string>
[-ServerProfileTemplate] <Object> [-StorageVolume] <Object> [-Description] <string> [-ClusterPrefix] <string> [-
UnmanageVSwitch] <SwitchParameter>[ [-Scope] <Object>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Obj
ect>] [<CommonParameters>]
New-HPOVClusterProfile [-ClusterManager] <HypervisorManager> [-ClusterManagerLocation] <string> [-ServerProfileT

emplate] <Object> [-StorageVolume] <Object> [-Description] <string> [-ClusterPrefix] <string> [-UnmanageVSwitch]
<SwitchParameter> [-VirtualSwitchType] <string> [-DistributedSwitchUsage] <string> [-DistributedSwitchVersion] <
string> [-HAEnabled] <bool> [-DRSEnabled] <bool> [-MultiNicVMotionEnabled] <bool>[ [-Scope] <Object>][ [-Async]
<SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Default content
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
-ClusterManager <HypervisorManager>
Aliases None
Required? True
Position? named
Default value
-ClusterManagerLocation <string>
Aliases None
Required? True
Position? named
Default value
-ClusterPrefix <string>
Aliases None
Required? True
Position? named
Default value
-DRSEnabled <bool>
Aliases None
Required? True
Position? named
Default value
-Description <string>
Aliases None
Required? True
Position? named
Default value
-DistributedSwitchUsage <string>
Aliases None
Required? True
Position? named
Default value
-DistributedSwitchVersion <string>
Aliases None
Required? True
Position? named
Default value
-HAEnabled <bool>
Aliases None
Required? True
Position? named
Default value
-MultiNicVMotionEnabled <bool>
Aliases None
Required? True
Position? named
Default value
-Name <string>
Aliases None
Required? True
Position? named
Default value
-Scope <Object>
Aliases None
Required? False
Position? named
-ServerProfileTemplate <Object>
Aliases None
Required? True
Position? named
Default value
-StorageVolume <Object>
Aliases None
Required? True
Position? named
Default value
-UnmanageVSwitch <SwitchParameter>
Aliases None
Required? True
Position? named
Default value
-VirtualSwitchType <string>
Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example
Related Links
Top
New-HPOVCustomBaseline

Create Custom Baseline from Hotfixes and Source Baseline.
SYNTAX
New-HPOVCustomBaseline [-SourceBaseline] <Object> [-Hotfixes] <Array> [-BaselineName] <String>[ [-Scope] <HPOneV
iew.Appliance.ScopeCollection>][ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>] [<CommonParameter
s>]
HPE ProLiant Hotfixes are released out of the main SPP release cycle. Administrators can use HPSUM external to HPE OneView
to create a custom baseline, but then need to upload to the appliance. Hotfixes can be directly uploaded to an HPE OneView 2.0
Appliance, with the ability to create a Custom Baseline by using a source Baseline (which must exist in the Baseline Repository)
and specified Hotfix(s).
Parameters

Aliases Appliance
Required? false
Position? 4
Aliases None
Required? false
Position? named
Default value
-BaselineName <String>
The final custom Baseline name.
Example: custom_SPPGen9Snap3_2015_0327_82
Aliases None
Required? true
Position? 2
Default value
-Hotfixes <Array>
Array of Hotfix filenames, or Component name.
Example: @(cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe)
Aliases None
Required? true
Position? 1
Default value
Aliases None
Required? False
Position? 3
Default value False
-SourceBaseline <Object>
An existing Baseline within the HPE OneView Baseline Repository.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Source HPE OneView Baseline from Get-HPOVBaseline
Return Values
Asyncronous task object to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe | % { Add-HPOVBaseline $_ }
Get-HPOVBaseline -BaselineName "MyBaseline" | New-HPOVCustomBaseline -Hotfixes cp111111.exe,cp222222.scexe,cp333
333.exe,cp444444.scexe -BaselineName "MyNewBaseline_20160222"
Upload hotfixes to appliance, then create a new custom baseline from the "MyBaseline" baseline. ### Related Links * [Restore-
HPOVCustomBaseline](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Restore-HPOVCustomBaseline) ***
Top
### HPE OneView 4.00 Library ## New-HPOVCustomBaseline
Create Custom Baseline from Hotfixes and Source Baseline. ### SYNTAX
New-HPOVCustomBaseline [-SourceBaseline] <Object> [-Hotfixes] <Array> [-BaselineName] <String>[ [-Scope] <HPOneV

iew.Appliance.ScopeCollection>][ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>] [<CommonParameter
s>]
HPE ProLiant Hotfixes are released out of the main SPP release cycle. Administrators can use HPSUM external to HPE OneView
to create a custom baseline, but then need to upload to the appliance. Hotfixes can be directly uploaded to an HPE OneView 2.0
Appliance, with the ability to create a Custom Baseline by using a source Baseline (which must exist in the Baseline Repository)
and specified Hotfix(s).
Parameters
Aliases Appliance
Required? false
Position? 4
Aliases None
Required? false
Position? named
Default value
-BaselineName <String>
The final custom Baseline name.
Example: custom_SPPGen9Snap3_2015_0327_82
Aliases None
Required? true
Position? 2
Default value
-Hotfixes <Array>
Array of Hotfix filenames, or Component name.
Example: @(cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe)
Aliases None
Required? true
Position? 1
Default value
Aliases None
Required? False
Position? 3
Default value False
-SourceBaseline <Object>
An existing Baseline within the HPE OneView Baseline Repository.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Asyncronous task object to monitor.
Examples
-------------------------- EXAMPLE 1 --------------------------
cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe | % { Add-HPOVBaseline $_ }
Get-HPOVBaseline -BaselineName 'MyBaseline' | New-HPOVCustomBaseline -Hotfixes cp111111.exe,cp222222.scexe,cp333
333.exe,cp444444.scexe -BaselineName 'MyNewBaseline_20160222'
Upload hotfixes to appliance, then create a new custom baseline from the 'MyBaseline' baseline.
Related Links
Restore-HPOVCustomBaseline
Top
New-HPOVDataCenter

New-HPOVDataCenter
Get a member device from a defined Rack.
SYNTAX
New-HPOVDataCenter [-Name] <String> [-Width] <Float> [-Depth] <Float>[ [-Millimeters] <SwitchParameter>][ [-Elec
tricalDerating] <Int>][ [-ElectricalDeratingType] <String>][ [-DefaultVoltage] <Int>][ [-Currency] <String>][ [-
PowerCosts] <Float>][ [-CoolingCapacity] <Int>][ [-CoolingMultiplier] <Float>][ [-ApplianceConnection] <Object>]
PowerCosts] <Float>][ [-CoolingCapacity] <Int>][ [-CoolingMultiplier] <Float>] [-PrimaryContact] <Object> [-Seco
ndaryContact] <Object> [-Address1] <String>[ [-Address2] <String>] [-City] <String> [-State] <String> [-PostCode
] <String> [-Country] <String> [-TimeZone] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
This Cmdlet will create a new datacenter. You will need to specify the Name and dimensions. Optionally, you can override the
default Electrical Derating, default voltage, local currency (which will aid in power calculation costs) and power cooling capacity.
Remote Support settings can only be set when Remote Support has been enabled and configured on the appliance. If omitting
Remote Support location settings, then the datacenter will default to the default location set.
Parameters
-Address1 <String>
Address of datacenter.
Aliases None
Required? true
Position? named
Default value
-Address2 <String>
Optional address line.
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-City <String>
City of residence for the datacenter.
Aliases None
Required? true
Position? named
Default value
-CoolingCapacity <Int>
The maximum cooling capacity for the data center, in KW. The appliance analyzes heat generation using this value.
Aliases None
Required? false
Position? named
Default value
-CoolingMultiplier <Float>
The ratio of cooling cost to power cost for the data center.
This value represents the relative cost of cooling the system compared to the cost of powering the system. The default value of
1.5 indicates that it costs 1.5 times as much to cool the system as it does to power the system.
Default: 1.5
Aliases None
Required? false
Position? named
Default value 1.5
-Country <String>
Country of residence for the datacenter.
Aliases None
Required? true
Position? named
Default value
-Currency <String>
The currency unit for energy costs.
Aliases None
Required? false
Position? named
Default value USD
-DefaultVoltage <Int>
The default power line voltage for the data center.
Default: 220
Aliases None
Required? false
Position? named
Default value 220
-Depth <Float>
Depth of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -
Millimeters switch parameter.
Aliases None
Required? true
Position? named
Default value
-ElectricalDerating <Int>
If Custom ElectricalDetratingType is set to Custom, specify a value between 20-100%.
Default: 20%
Aliases None
Required? false
Position? named
Default value 20
-ElectricalDeratingType <String>
The percentage below the rated maximum power dissipation at which the devices are operated, accounting for case/body
temperature, ambient temperature, and type of cooling.
You can specify a derating percentage by choosing Custom, or you can choose not to apply derating to the rated maximum
power dissipation by specifying None.
Default: NA/Jp
Aliases None
Required? false
Position? named
Default value NA/Jp

If specifying millimeter value for Width and Depth, this parameter is required.
Aliases None
Required? false
Position? named
Default value
-Name <String>
A name to identify the data center. Must not exceed 255 characters; no leading spaces.
Aliases None
Required? true
Position? named
Default value
-PostCode <String>
Postal code for the datacenter.
Aliases None
Required? true
Position? named
Default value
-PowerCosts <Float>
The energy cost per kWh, specified by the Currency.
Aliases None
Required? false
Position? named
Default value

-PrimaryContact <Object>
Primary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance.
Aliases None
Required? true
Position? named
Default value
-SecondaryContact <Object>
Secondary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance. Must not be the
same value as the Primary Contact.
Aliases None
Required? true
Position? named
Default value
-State <String>
State/province of residence for the datacenter.
Aliases None
Required? true
Position? named
Default value
-TimeZone <String>
Time Zone of residence for the datacenter.
Aliases None
Required? true
Position? named
Default value
-Width <Float>
Width of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Newly created datacenter.
Examples
-------------------------- EXAMPLE 1 --------------------------
$DataCenter1Name = "LA DC 12"
$DataCenter1Width = 30
$DataCenter1Depth = 30
$DataCenter1Voltage = 220
$DataCenter1PowerCosts = 0.07
$DataCenter1CoolingCapacity = 250
New-HPOVDataCenter -Name $DataCenter1Name -Width $DataCenter1Width -Depth $DataCenter1Depth -DefaultVoltage $Dat

aCenter1Voltage -PowerCosts $DataCenter1PowerCosts -CoolingCapacity $DataCenter1CoolingCapacity
Create new "LA DC 12" datacenter.

-------------------------- EXAMPLE 2 --------------------------
$NewDCParams = @{
Name = "Houston DC1";

Width = 10668;
Depth = 13716;
Millimeters = $True;
DefaultVoltage = 240e;
PowerCosts = 0.10;
CoolingCapacity = 350;
Address1 = "123 Main Place";
Address2 = "Suite 400";
City = "Houston;
State = "TX";
Country = "US";
PostCode = "77002";
TimeZone = "US/Central";
PrimaryContact = (Get-HPOVRemoteSupportContact -Name "Joe Ellis" -EA Stop)
SecondaryContact = (Get-HPOVRemoteSupportContact -Name "Brandon Pear" -EA Stop)
}
New-HPOVDataCenter @NewDC2Params
Create a new datacenter with Remote Support settings. ### Related Links * [Get-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVDataCenter) * [Remove-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVDataCenter) * [Set-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVDataCenter) * [Set-HPOVDataCenterRemoteSupport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVDataCenterRemoteSupport) ***
Top
### HPE OneView 4.00 Library ## New-HPOVDataCenter
Get a member device from a defined Rack. ### SYNTAX
PowerCosts] <Float>][ [-CoolingCapacity] <Int>][ [-CoolingMultiplier] <Float>][ [-ApplianceConnection] <Object>]
PowerCosts] <Float>][ [-CoolingCapacity] <Int>][ [-CoolingMultiplier] <Float>] [-PrimaryContact] <Object> [-Seco
ndaryContact] <Object> [-Address1] <String>[ [-Address2] <String>] [-City] <String> [-State] <String> [-PostCode
] <String> [-Country] <String> [-TimeZone] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Parameters
-Address1 <String>
Aliases None
Required? true
Position? named
Default value
-Address2 <String>
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-City <String>
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Default: 1.5
Aliases None
Required? false
Position? named
Default value 1.5
-Country <String>
Aliases None
Required? true
Position? named
Default value
-Currency <String>
Aliases None
Required? false
Position? named
Default value USD

Default: 220
Aliases None
Required? false
Position? named
Default value 220
-Depth <Float>
Aliases None
Required? true
Position? named
Default value
Default: 20%
Aliases None
Required? false
Position? named
Default value 20
Default: NA/Jp
Aliases None
Required? false
Position? named
Default value NA/Jp

Aliases None
Required? false
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
-PostCode <String>
Aliases None
Required? true
Position? named
Default value
-PowerCosts <Float>
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-State <String>
Aliases None
Required? true
Position? named
Default value
-TimeZone <String>
Aliases None
Required? true
Position? named
Default value
-Width <Float>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$DataCenter1Name = 'LA DC 12'

Create new 'LA DC 12' datacenter.

-------------------------- EXAMPLE 2 --------------------------
$NewDCParams = @{
Name = 'Houston DC1';

Width = 10668;
Depth = 13716;
PowerCosts = 0.10;
Address1 = '123 Main Place';
Address2 = 'Suite 400';
City = 'Houston;
State = 'TX';
Country = 'US';
PostCode = '77002';
TimeZone = 'US/Central';
PrimaryContact = (Get-HPOVRemoteSupportContact -Name 'Joe Ellis' -EA Stop)
SecondaryContact = (Get-HPOVRemoteSupportContact -Name 'Brandon Pear' -EA Stop)
}
Create a new datacenter with Remote Support settings.
Related Links
Get-HPOVDataCenter
Set-HPOVDataCenter
Top

Create an Enclosure Group.
SYNTAX
New-HPOVEnclosureGroup [-Name] <String> [-LogicalInterconnectGroupMapping] <Object>[ [-PowerRedundantMode] <Stri
ng>][ [-ConfigurationScript] <String>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection]
New-HPOVEnclosureGroup [-Name] <String>[ [-DiscoverFromEnclosure] <SwitchParameter>] [-OAAddress] <String> [-Use
rname] <String> [-Password] <String>[ [-PowerRedundantMode] <String>][ [-ConfigurationScript] <String>] [-LigPre
fix] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection] <Object>] [<CommonParamet
ers>]
New-HPOVEnclosureGroup [-Name] <String> [-LogicalInterconnectGroupMapping] <Object> [-EnclosureCount] <Int32>[ [

-PowerRedundantMode] <String>][ [-IPv4AddressType] <String>] [-AddressPool] <Object>[ [-DeploymentNetworkType] <
String>][ [-DeploymentNetwork] <Object>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection
] <Object>] [<CommonParameters>]
New-HPOVEnclosureGroup [-ImportFile] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConne

ction] <Object>] [<CommonParameters>]
An enclosure group is a logical resource that defines a standard configuration for member logical enclosures. The network
connectivity for an enclosure group is defined by the logical interconnect groups associated with the enclosure group. When
configuring an HPE Synergy enclosure group, it may contain up to five enclosures. When configuring an HPE BladeSystem C-
Class enclosure group, it will only contain a single enclosure.
Enclosure groups and logical interconnect groups
* A logical interconnect group that is assigned to a bay within an enclosure group must have that bay populated
within the logical interconnect group.
* All populated bays in a logical interconnect group must be assigned to the enclosure group. For example, a lo
gical interconnect group that has bays 1 and 2 populated must be assigned to bays 1 and 2 of the enclosure grou
p in order for the enclosure group to be created.
* An enclosure group can contain logical interconnect groups that are highly available, redundant, A-side only,
or A-side and B-side. See About interconnect bay sets.
* Synergy multiple-enclosure logical interconnect groups must have the proper bays populated in all enclosures
in the interconnect link topology.
* Synergy single-enclosure logical interconnect groups, such as a Serial Attached SCSI (SAS) logical interconne
ct group, can be applied to individual bays in individual enclosures in the interconnect link topology.
Parameters
-AddressPool <Object>
The IPv4 Address Pool object from Get-HPOVAddressPoolRange.
Aliases None
Required? true
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-ConfigurationScript <String>
An Onboard Administrator CLI Script. Only applicable for HPE BladeSystem C-Class.
Aliases None
Required? false
Position? named
Default value
The Ethernet Network with the purpose property set to Management. Must also include DeploymentNetworkType parameter,
value must be "External", with the Ethernet Network associated with a non-ImageStreamer Uplink Set.
Aliases None
Required? false
Position? named
Default value
-DeploymentNetworkType <String>
Specify the Synergy Image Stream deployment network type. Allowed values:
* Internal - Deployment network is an internal, managed by the Frame links, which Logical Intercoonect Group mu
st have an ImageStreamer Uplink Set.
* External - Deployment network is connected to an External management switch.
* None - No deployment network will be configured.
Default: None
Aliases None
Required? false
Position? named
Default value None
-DiscoverFromEnclosure <SwitchParameter>
Use this parameter for the appliance to create an Enclosure Group and associated Logical Interconnect Group by "discovering"
the Enclosure and support interconnects. The target Enclosure must not already be claimed by another external manager (i.e.
HPE OneView), as the API will reject the request.
No Uplink Sets will be created. They will need to be added using the New-HPOVUplinkSet Cmdlet once the Logical Interconnect
Group resource has been created.
Aliases None
Required? false
Position? named
Default value False
-EnclosureCount <Int32>
Specify the number of Synergy Frames will participate within the Enclosure Group.
Aliases None
Required? true
Position? named
Default value 1
-IPv4AddressType <String>
Use to specify how the IPv4 Addresses will be assigned to Synergy resources management interface(s). Allowed values:
* External - The IPv4 address is managed externally, static assignment.

* DHCP - The IPv4 address is assigned using DHCP.
* AddressPool - The IPv4 address is assigned from a pool of IP addresses specified by the AddressPool parameter
, similar to HPE BladeSystem C-Class "Enclosure Bay IP Addressing" (aka EBIPA).
Default: DHCP
Aliases None
Required? false
Position? named
Default value DHCP
-ImportFile <String>
Provide the full path and file name of the JSON file.
Aliases i, import
Required? true
Position? named
Default value

-LigPrefix <String>
If specified, the Logical Interconnect Group that is created will be used in the "{LigPrefix} Logical Interconnect Group".
Aliases None
Required? true
Position? named
Default value
-LogicalInterconnectGroupMapping <Object>
Aliases [-logicalInterconnectGroupUri, -logicalInterConnectGroup]
An Enclosure Group can reference multiple Logical Interconnect Groups, once per Interconnect Bay. If a Single Logical
Interconnect Group object is provided (either via parameter variable or via Pipeline), the Logical Interconnect Group objects
Logical Interconnect Bay configuration will be used.
To specify a specific C-Class Logical Interconnect Group(s) for one or more Interconnect Bays, use a Hashtable, with the Bay ID
as the Key, and Logical Interconnect Group Name, URI or Object as the Value. Example:
$LogicalInterConnectGroupMapping = @{ 1 = "MyLIg1"; 2 = "MyLig1"; 5 = "OtherLIG"; 6 = "OtherLIG"}
$MyLig1 = Get-HPOVLogicalInterconnectGroup -Name MyLig1 $OtherLIG = Get-HPOVLogicalInterconnectGroup OtherLIG

$LogicalInterConnectGroupMapping = @{ 1 = $MyLig1; 2 = $MyLig1; 5 = $OtherLIG; 6 = $OtherLIG"
When attempting to define a Syenrgy-based Enclosure Group, either an Array or Hashtable is allowed. If an Array of Logical
Interconnect Groups are provided, the Cmdlet will determine the Interconnect placement automatically. Example:
$MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $LogicalInterConnectGroupMapping =

$MySynergyLig1
#or $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $MySynergyLig2 = Get-

HPOVLogicalInterconnectGroup -Name MySynergyLig2 $LogicalInterConnectGroupMapping =
$MySynergyLig1,$MySynergyLig2
Do know that SAS and VC FC LIGs are bound to a single frame, and will not reference other Frames if FrameCount is greater
than 1.
Use a Hashtable to bind specific LIGs to specific Frames. The Interconnect placement will be determined automatically based on
either the Hashtable Key name "Frame#" (where # is the numerical value of the Frame) or Enclosure Index value (depending if a
SAS or Synergy VC FC LIG). Example:
$3FrameVCLIG = Get-HPOVLogicalInterconnectGroup -Name "My MultiFrame Synergy LIG 1" $SasLIG = Get-
HPOVLogicalInterconnectGroup -Name "My Synergy Sas LIG 1" $LogicalInterconnectGroupMapping = @{Frame1 =
$3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG }
Aliases logicalInterconnectGroupUri, logicalInterconnectGroup
Required? true
Position? named
Default value

-Name <String>
A name for the new enclosure group.
Aliases None
Required? true
Position? named
Default value
-OAAddress <String>
Provide the Onboard Administrator IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
-Password <String>
Provide an Onboard Administrator administrator password.
Aliases None
Required? true
Position? named
Default value
-PowerRedundantMode <String>
The Power Redundancy Mode to set when an Enclosure is added to the appliance.
Allowed Values:
* RedundantPowerFeed - Provides N+N Power Redundancy Configuration

* RedundantPowerSupply - Provided N+1 Power Redundancy Configuration
Aliases None
Required? false
Position? named
Default value RedundantPowerFeed

Aliases None
Required? False
Position? named
Default value False
-Username <String>
Provide an Onboard Administrator administrator account.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Networking.LogicalInterconnectGroup [System.Management.Automation.PSCustomObject]
Single Logical Interconnect Group resource object
Return Values
The newly created enclosure group resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$mylig = Get-HPOVLogicalInterconnectGroup -name "myLogicalInterconnectGroup"

New-HPOVEnclosureGroup -name "MyGroup" -logicalInterConnectGroup $mylig
Get the "myLogicalInterconnectGroup" object and pass it to create the "MyGroup" Enclosure Group.
-------------------------- EXAMPLE 2 --------------------------
$Prodlig = Get-HPOVLogicalInterconnectGroup -name "Production LIG"

$DMZlig = Get-HPOVLogicalInterconnectGroup -name "DMZ LIG"
$ConfigurationScript = "#Configure Insight Remote Support CentralConnect
>> ENABLE REMOTE_SUPPORT IRS 80.80.1.14 7906"
New-HPOVEnclosureGroup -name "Production Enclosure Group 1" -LogicalInterconnectGroupMapping @{1 = $Prodlig; 2 =
$Prodlig; 5 = $DMZlig; 6 = $DMZlig} -ConfigurationScript $ConfigurationScript
Get two different Logical Interconnect Groups, define an OA Configuration Script, then assign the LIGs to the specific
Interconnect Bays for appliance "MyAppliance1.domain.com".
-------------------------- EXAMPLE 3 --------------------------
New-HPOVEnclosureGroup -name "MyGroup" -DiscoverFromEnclosure -OAAddress MyOAIP.domain.com -Username Administrat

or -Password MyPassword
Connect to the provided Onboard Administrator, detect the Interconnect Bay population to then create both a Logical
Interconnect Group and associate it with the Enclosure Group being requested.
-------------------------- EXAMPLE 4 --------------------------

or -Password MyPassword -LigPrefix "My LIG Policy"
Interconnect Group ("My LIG Policy") and associate it with the Enclosure Group being requested.
-------------------------- EXAMPLE 5 --------------------------
$MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1

New-HPOVEnclosureGroup -name "My Synergy Enclosure Group 1" -LogicalInterconnectGroupMapping $MySynergyLig1 -Enc
losureCount 3 -IPv4AddressType DHCP
Create a 3-Frame Synergy Enclosure Group using a single Logical Interconnect Group.
-------------------------- EXAMPLE 6 --------------------------

New-HPOVEnclosureGroup -name "My Synergy Enclosure Group 1" -LogicalInterconnectGroupMapping @{Frame1 = $3FrameV
CLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG } -EnclosureCount 3 -IPv4AddressType DHCP
Create a 3-Frame Synergy Enclosure Group using multiple Logical Interconnect Groups specific to each Frame.
-------------------------- EXAMPLE 7 --------------------------
$AddressPool = Get-HPOVAddressPoolSubnet -NetworkId "10.140.51.0" -ErrorAction Stop | Get-HPOVAddressPoolRange

CLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG } -EnclosureCount 3 -IPv4AddressType AddressP
ool -AddressPool $AddressPool -DeploymentNetworkType Internal
Create a 3-Frame Synergy Enclosure Group using multiple Logical Interconnect Groups specific to each Frame, with
ImageStreamer support using a LIG with an ImageStreamer Uplink Set (aka Internal)..
-------------------------- EXAMPLE 8 --------------------------
$AddressPool = Get-HPOVAddressPoolSubnet -NetworkId "10.140.51.0" -ErrorAction Stop | Get-HPOVAddressPoolRange

$DeploymentNetwork = Get-HPOVNetwork -Name "Deployment Network" -ErrorAction Stop
ool -AddressPool $AddressPool -DeploymentNetworkType External -DeploymentNetwork $DeploymentNetwork
ImageStreamer support using a LIG without an ImageStreamer Uplink Set and specifying which Ethernet Network object is the
deployment network (aka External). ### Related Links * [Get-HPOVEnclosureGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVEnclosureGroup) * [Remove-HPOVEnclosureGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVEnclosureGroup) * [Set-HPOVEnclosureGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVEnclosureGroup) ***
Top
### HPE OneView 4.00 Library ## New-HPOVEnclosureGroup
Create an Enclosure Group. ### SYNTAX
New-HPOVEnclosureGroup [-Name] <String> [-LogicalInterconnectGroupMapping] <Object>[ [-PowerRedundantMode] <Stri

ng>][ [-ConfigurationScript] <String>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection]
New-HPOVEnclosureGroup [-Name] <String>[ [-DiscoverFromEnclosure] <SwitchParameter>] [-OAAddress] <String> [-Use

rname] <String> [-Password] <String>[ [-PowerRedundantMode] <String>][ [-ConfigurationScript] <String>] [-LigPre
fix] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection] <Object>] [<CommonParamet
ers>]
New-HPOVEnclosureGroup [-Name] <String> [-LogicalInterconnectGroupMapping] <Object> [-EnclosureCount] <Int32>[ [

-PowerRedundantMode] <String>][ [-IPv4AddressType] <String>] [-AddressPool] <Object>[ [-DeploymentNetworkType] <
String>][ [-DeploymentNetwork] <Object>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection
] <Object>] [<CommonParameters>]
New-HPOVEnclosureGroup [-ImportFile] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConne

An enclosure group is a logical resource that defines a standard configuration for member logical enclosures. The network
connectivity for an enclosure group is defined by the logical interconnect groups associated with the enclosure group. When
configuring an HPE Synergy enclosure group, it may contain up to five enclosures. When configuring an HPE BladeSystem C-
Class enclosure group, it will only contain a single enclosure.
Enclosure groups and logical interconnect groups
* A logical interconnect group that is assigned to a bay within an enclosure group must have that bay populated
within the logical interconnect group.
* All populated bays in a logical interconnect group must be assigned to the enclosure group. For example, a lo
gical interconnect group that has bays 1 and 2 populated must be assigned to bays 1 and 2 of the enclosure grou
p in order for the enclosure group to be created.
* An enclosure group can contain logical interconnect groups that are highly available, redundant, A-side only,
or A-side and B-side. See About interconnect bay sets.
* Synergy multiple-enclosure logical interconnect groups must have the proper bays populated in all enclosures
in the interconnect link topology.
* Synergy single-enclosure logical interconnect groups, such as a Serial Attached SCSI (SAS) logical interconne
ct group, can be applied to individual bays in individual enclosures in the interconnect link topology.
Parameters
-AddressPool <Object>
The IPv4 Address Pool object from Get-HPOVAddressPoolRange.

Aliases None
Required? true
Position? named
Default value
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
The Ethernet Network with the purpose property set to Management. Must also include DeploymentNetworkType parameter,
value must be 'External', with the Ethernet Network associated with a non-ImageStreamer Uplink Set.
Aliases None
Required? false
Position? named
Default value
-DeploymentNetworkType <String>
Specify the Synergy Image Stream deployment network type. Allowed values:
* Internal - Deployment network is an internal, managed by the Frame links, which Logical Intercoonect Group mu
st have an ImageStreamer Uplink Set.
* External - Deployment network is connected to an External management switch.
* None - No deployment network will be configured.
Default: None
Aliases None
Required? false
Position? named
Default value None
-DiscoverFromEnclosure <SwitchParameter>
Use this parameter for the appliance to create an Enclosure Group and associated Logical Interconnect Group by 'discovering'
the Enclosure and support interconnects. The target Enclosure must not already be claimed by another external manager (i.e.
HPE OneView), as the API will reject the request.
No Uplink Sets will be created. They will need to be added using the New-HPOVUplinkSet Cmdlet once the Logical Interconnect
Group resource has been created.
Aliases None
Required? false
Position? named
Default value False
-EnclosureCount <Int32>
Specify the number of Synergy Frames will participate within the Enclosure Group.
Aliases None
Required? true
Position? named
Default value 1
-IPv4AddressType <String>
Use to specify how the IPv4 Addresses will be assigned to Synergy resources management interface(s). Allowed values:
* External - The IPv4 address is managed externally, static assignment.

* DHCP - The IPv4 address is assigned using DHCP.
* AddressPool - The IPv4 address is assigned from a pool of IP addresses specified by the AddressPool parameter
, similar to HPE BladeSystem C-Class 'Enclosure Bay IP Addressing' (aka EBIPA).
Default: DHCP
Aliases None
Required? false
Position? named
Default value DHCP
Provide the full path and file name of the JSON file.
Aliases i, import
Required? true
Position? named
Default value
-LigPrefix <String>
If specified, the Logical Interconnect Group that is created will be used in the '{LigPrefix} Logical Interconnect Group'.
Aliases None
Required? true
Position? named
Default value
-LogicalInterconnectGroupMapping <Object>
Aliases [-logicalInterconnectGroupUri, -logicalInterConnectGroup]
An Enclosure Group can reference multiple Logical Interconnect Groups, once per Interconnect Bay. If a Single Logical
Interconnect Group object is provided (either via parameter variable or via Pipeline), the Logical Interconnect Group objects
Logical Interconnect Bay configuration will be used.
To specify a specific C-Class Logical Interconnect Group(s) for one or more Interconnect Bays, use a Hashtable, with the Bay ID
as the Key, and Logical Interconnect Group Name, URI or Object as the Value. Example:
$LogicalInterConnectGroupMapping = @{ 1 = "MyLIg1"; 2 = "MyLig1"; 5 = "OtherLIG"; 6 = "OtherLIG"}
$MyLig1 = Get-HPOVLogicalInterconnectGroup -Name MyLig1 $OtherLIG = Get-HPOVLogicalInterconnectGroup OtherLIG

$LogicalInterConnectGroupMapping = @{ 1 = $MyLig1; 2 = $MyLig1; 5 = $OtherLIG; 6 = $OtherLIG"
When attempting to define a Syenrgy-based Enclosure Group, either an Array or Hashtable is allowed. If an Array of Logical
Interconnect Groups are provided, the Cmdlet will determine the Interconnect placement automatically. Example:
$MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $LogicalInterConnectGroupMapping =

$MySynergyLig1
#or $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $MySynergyLig2 = Get-

HPOVLogicalInterconnectGroup -Name MySynergyLig2 $LogicalInterConnectGroupMapping =
$MySynergyLig1,$MySynergyLig2
Do know that SAS and VC FC LIGs are bound to a single frame, and will not reference other Frames if FrameCount is greater
than 1.
Use a Hashtable to bind specific LIGs to specific Frames. The Interconnect placement will be determined automatically based on
either the Hashtable Key name "Frame#" (where # is the numerical value of the Frame) or Enclosure Index value (depending if a
SAS or Synergy VC FC LIG). Example:
$3FrameVCLIG = Get-HPOVLogicalInterconnectGroup -Name "My MultiFrame Synergy LIG 1" $SasLIG = Get-
HPOVLogicalInterconnectGroup -Name "My Synergy Sas LIG 1" $LogicalInterconnectGroupMapping = @{Frame1 =
$3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG }
Aliases logicalInterconnectGroupUri, logicalInterconnectGroup
Required? true
Position? named
Default value
-Name <String>
A name for the new enclosure group.
Aliases None
Required? true
Position? named
Default value
-OAAddress <String>
Provide the Onboard Administrator IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
-Password <String>
Provide an Onboard Administrator administrator password.
Aliases None
Required? true
Position? named
Default value
Allowed Values:

Aliases None
Required? false
Position? named
Default value RedundantPowerFeed
Aliases None
Required? False
Position? named
Default value False
-Username <String>
Provide an Onboard Administrator administrator account.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Single Logical Interconnect Group resource object
Return Values
The newly created enclosure group resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$mylig = Get-HPOVLogicalInterconnectGroup -name "myLogicalInterconnectGroup"

New-HPOVEnclosureGroup -name "MyGroup" -logicalInterConnectGroup $mylig
Get the "myLogicalInterconnectGroup" object and pass it to create the "MyGroup" Enclosure Group.
-------------------------- EXAMPLE 2 --------------------------
$Prodlig = Get-HPOVLogicalInterconnectGroup -name "Production LIG"

$DMZlig = Get-HPOVLogicalInterconnectGroup -name "DMZ LIG"
$ConfigurationScript = '#Configure Insight Remote Support CentralConnect
ENABLE REMOTE_SUPPORT IRS 80.80.1.14 7906'

New-HPOVEnclosureGroup -name "Production Enclosure Group 1" -LogicalInterconnectGroupMapp
ing @{1 = $Prodlig; 2 = $Prodlig; 5 = $DMZlig; 6 = $DMZlig} -ConfigurationScript $Configu
rationScript
Get two different Logical Interconnect Groups, define an OA Configuration Script, then assign the LIGs to the specific
Interconnect Bays for appliance 'MyAppliance1.domain.com'.
-------------------------- EXAMPLE 3 --------------------------

or -Password MyPassword
Interconnect Group and associate it with the Enclosure Group being requested.
-------------------------- EXAMPLE 4 --------------------------

or -Password MyPassword -LigPrefix 'My LIG Policy'
Interconnect Group ('My LIG Policy') and associate it with the Enclosure Group being requested.
-------------------------- EXAMPLE 5 --------------------------

New-HPOVEnclosureGroup -name "My Synergy Enclosure Group 1" -LogicalInterconnectGroupMapping $MySynergyLig1 -Enc
losureCount 3 -IPv4AddressType DHCP
Create a 3-Frame Synergy Enclosure Group using a single Logical Interconnect Group.
-------------------------- EXAMPLE 6 --------------------------

CLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG } -EnclosureCount 3 -IPv4AddressType DHCP
Create a 3-Frame Synergy Enclosure Group using multiple Logical Interconnect Groups specific to each Frame.
-------------------------- EXAMPLE 7 --------------------------
$AddressPool = Get-HPOVAddressPoolSubnet -NetworkId '10.140.51.0' -ErrorAction Stop | Get-HPOVAddressPoolRange

ool -AddressPool $AddressPool -DeploymentNetworkType Internal
ImageStreamer support using a LIG with an ImageStreamer Uplink Set (aka Internal)..
-------------------------- EXAMPLE 8 --------------------------
$AddressPool = Get-HPOVAddressPoolSubnet -NetworkId '10.140.51.0' -ErrorAction Stop | Get-HPOVAddressPoolRange

$DeploymentNetwork = Get-HPOVNetwork -Name 'Deployment Network' -ErrorAction Stop
ool -AddressPool $AddressPool -DeploymentNetworkType External -DeploymentNetwork $DeploymentNetwork
ImageStreamer support using a LIG without an ImageStreamer Uplink Set and specifying which Ethernet Network object is the
deployment network (aka External).
Related Links
Top
New-HPOVExternalRepository

Create a new external baseline repository.
SYNTAX
New-HPOVExternalRepository [-Name] <String> [-Hostname] <String> [-Directory] <String>[ [-Username] <String>][ [
-Password] <SecureString>][ [-Http] <SwitchParameter>][ [-Certificate] <String>][ [-Async] <SwitchParameter>][ [
-ApplianceConnection] <Array>] [<CommonParameters>]
New-HPOVExternalRepository [-Name] <String> [-Hostname] <String> [-Directory] <String> [-Credential] <String>[ [

-Http] <SwitchParameter>][ [-Certificate] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>
A firmware repository enables you to store firmware bundles and deploy them across your environment. An externally managed
HTTP/HTTPS web server can be added to the appliance as a repository. It is a user-maintained HTTP/HTTPS web server. You
can upload firmware bundles in a specific directory and then register the HTTP/HTTPS server with HPE OneView. This
functionality is supported for Linux and Windows systems.
The recommended types of external web servers to use with the repository follow:
* Apache
* Internet Information Services (IIS)
NOTE: Only one external repository can be added.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value

-Certificate <String>
The Base64 Certificate of the target web server. Must be specified if the -HTTP parameter is not used.
Aliases None
Required? false
Position? named
Default value
-Credential <String>
Provide a PSCredential object if the target web server requires authentication. By default, HTTPS will be used and basic
authentication is used to communicate with the target web server.
Aliases None
Required? true
Position? named
Default value
-Directory <String>
Specify the parent virtual directory where the baseline components will be kept. Baseline components can be nested within sub
directories.
Aliases None
Required? true
Position? named
Default value
-Hostname <String>
Specify IPv4 Address or FQDN of the target web server.
Aliases None
Required? true
Position? named
Default value

-Http <SwitchParameter>
Use to override the default HTTPS protocol used to communicate with the target web server. If this parameter is not used, you
must specify the Base64 Certificate of the target web server. If you use this parameter, all authentication requests will be sent as
clear text.
Aliases None
Required? false
Position? named
Default value
-Name <String>
Provide a name for the repository.
Aliases None
Required? true
Position? named
Default value
Provide the password of the username using a SecureString.
Aliases None
Required? false
Position? named
Default value
-Username <String>
Provide the username to authenticate to the target web server with if required.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The async task for the caller to monitor.
Multiple async task resource objects.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Params = @{
Name = "MyRepoName";
Hostname = "webserver.domain.local";
Directory = "OneViewRepo";
Credential = (Get-PSCredential -Username "DomainName\MyUser");
Certificate = (Get-Content -Path C:\Directory\Base64.cer -Raw)
}
New-HPOVExternalRepository @Params
Create an external repository using a PSCredential object.

-------------------------- EXAMPLE 2 --------------------------
New-HPOVExternalRepository -Name MyRepoName -Hostname webserver.domain.local -Directory OneViewRepo -Http
Configure an external repository using anonymous authentication, and HTTP protocol. ### Related Links * [Remove-
HPOVExternalRepository](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVExternalRepository) * [Set-
HPOVExternalRepository](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVExternalRepository) * [Update-
HPOVExternalRepository](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVExternalRepository) ***
Top
### HPE OneView 4.00 Library ## New-HPOVExternalRepository
Create a new external baseline repository. ### SYNTAX
New-HPOVExternalRepository [-Name] <String> [-Hostname] <String> [-Directory] <String>[ [-Username] <String>][ [

-Password] <SecureString>][ [-Http] <SwitchParameter>][ [-Certificate] <String>][ [-Async] <SwitchParameter>][ [
-ApplianceConnection] <Array>] [<CommonParameters>]
New-HPOVExternalRepository [-Name] <String> [-Hostname] <String> [-Directory] <String> [-Credential] <String>[ [

-Http] <SwitchParameter>][ [-Certificate] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>
* Apache
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-Directory <String>
Specify the parent virtual directory where the baseline components will be kept. Baseline components can be nested within sub
directories.
Aliases None
Required? true
Position? named
Default value
-Hostname <String>
Specify IPv4 Address or FQDN of the target web server.
Aliases None
Required? true
Position? named
Default value
-Http <SwitchParameter>
Use to override the default HTTPS protocol used to communicate with the target web server. If this parameter is not used, you
must specify the Base64 Certificate of the target web server. If you use this parameter, all authentication requests will be sent as
clear text.
Aliases None
Required? false
Position? named
Default value
-Name <String>
Provide a name for the repository.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Username <String>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Params = @{
Name = 'MyRepoName';
Hostname = 'webserver.domain.local';
Directory = 'OneViewRepo';
Credential = (Get-PSCredential -Username 'DomainName\MyUser');
Certificate = (Get-Content -Path C:\Directory\Base64.cer -Raw)
}
New-HPOVExternalRepository @Params
Create an external repository using a PSCredential object.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVExternalRepository -Name MyRepoName -Hostname webserver.domain.local -Directory OneViewRepo -Http
Configure an external repository using anonymous authentication, and HTTP protocol.
Related Links
Remove-HPOVExternalRepository
Set-HPOVExternalRepository
Update-HPOVExternalRepository
Top

Add a new Directory for Authentication
SYNTAX
New-HPOVLdapDirectory [-Name] <String>[ [-AD] <SwitchParameter>] [-BaseDN] <String> [-Servers] <Array> [-Usernam
e] <String> [-Password] <SecureString>[ [-Credential] <PSCredential>][ [-ServiceAccount] <SwitchParameter>] [-Ap
plianceConnection] <Object> [<CommonParameters>]
New-HPOVLdapDirectory [-Name] <String>[ [-OpenLDAP] <SwitchParameter>] [-BaseDN] <String> [-OrganizationalUnits]

<Array> [-Servers] <Array>[ [-UserNamingAttribute] <string>] [-Username] <String> [-Password] <SecureString>[ [-
Credential] <PSCredential>][ [-ServiceAccount] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParame
ters>]
This cmdlet will create a new Directory for appliance authentication. HPE OneView currently supports either Active Directory or
LDAP (e.g. OpenLDAP) for user authentication. The New-HPOVLdapServer cmdlet is used to assist defining directory servers
address, public SSL certificate and LDAP over SSL TCP port.
Parameters
-AD <SwitchParameter>
Using Active Directory, which sets the authProtocol to AD and userNameField to CN
Aliases None
Required? false
Position? named
Default value False
Aliases Appliance
Required? true
Position? named
-BaseDN <String>
Aliases [-Root, -RootDN]
Directory Base DN (E.g. dc=domian,dc=local)
Aliases root, rootdn
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Name <String>
Directory name to add. Does not need to match LDAP/AD Directory Name, but should.
Aliases None
Required? true
Position? named
Default value
-OpenLDAP <SwitchParameter>
Aliases [-LDAP]
Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID
Aliases LDAP
Required? false
Position? named
Default value False
-OrganizationalUnits <Array>
OpenLDAP OU"s to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso
Aliases None
Required? true
Position? named
Default value
Aliases [-p, -pass] Directory Username password.
Aliases p, pass
Required? true
Position? named
Default value
-Servers <Array>
Array of Directory Servers and their settings. Must include the following:
* Server Name (FQDN or IP)

* Public SSL Certificate
* SSL Port, if not default 636
Aliases None
Required? true
Position? named
Default value
-ServiceAccount <SwitchParameter>
Use to indicate the provided credential is a Service Account. Required for when configuring an Active Directory auth directory
for two-factor authentication.
Aliases None
Required? False
Position? named
Default value
-UserNamingAttribute <string>
Specify the naming attribute for OpenLDAP directories. Allowed values: CN UID Default Value: CN
Aliases None
Required? false
Position? named
Default value CN
-Username <String>
Aliases [-u, -user] Directory Username to authenticate with.
Aliases u, user
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.Security.SecureString
Account Password that will be used to validate the directory
Return Values
Configured Authentication Directory
Multiple configured Authentication Directories
Examples
-------------------------- EXAMPLE 1 --------------------------
$ServerA,$ServerB = servera.domain.com,serverb.domain.com | New-HPOVLdapServer

New-HPOVLdapDirectory -name Domain1 -AD -basedn "dc=domain,dc=com" -servers $ServerA,$ServerB -Username MyAdminA
ccount@domain.com
Add a new directory with two directory servers, and be prompted for your directory account password.
-------------------------- EXAMPLE 2 --------------------------
$ServerA = New-HPOVLdapServer -Name contoso.com

New-HPOVLdapDirectory -name Domain1 -AD -basedn "dc=domain,dc=com" -servers $ServerA -Username MyAdminAccount@do
main.com -ServiceAccount
Add a new Active Directory authentication directory, using SRV domain name, and specify to use the account as a service
account. ### Related Links * [Get-HPOVLdapDirectory](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVLdapDirectory) * [Remove-HPOVLdapDirectory](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVLdapDirectory) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLdapDirectory
Add a new Directory for Authentication ### SYNTAX
New-HPOVLdapDirectory [-Name] <String>[ [-AD] <SwitchParameter>] [-BaseDN] <String> [-Servers] <Array> [-Usernam
e] <String> [-Password] <SecureString>[ [-Credential] <PSCredential>][ [-ServiceAccount] <SwitchParameter>] [-Ap
plianceConnection] <Object> [<CommonParameters>]
New-HPOVLdapDirectory [-Name] <String>[ [-OpenLDAP] <SwitchParameter>] [-BaseDN] <String> [-OrganizationalUnits]

<Array> [-Servers] <Array> [-Username] <String> [-Password] <SecureString>[ [-Credential] <PSCredential>][ [-Ser
viceAccount] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will create a new Directory for appliance authentication. HPE OneView currently supports either Active Directory or
LDAP (e.g. OpenLDAP) for user authentication. The New-HPOVLdapServer cmdlet is used to assist defining directory servers
address, public SSL certificate and LDAP over SSL TCP port.
Parameters
-AD <SwitchParameter>
Using Active Directory, which sets the authProtocol to AD and userNameField to CN
Aliases None
Required? false
Position? named
Default value False
Aliases Appliance
Required? true
Position? named
-BaseDN <String>
Aliases [-Root, -RootDN]
Directory Base DN (E.g. dc=domian,dc=local)
Aliases root, rootdn
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Name <String>
Directory name to add. Does not need to match LDAP/AD Directory Name, but should.
Aliases None
Required? true
Position? named
Default value
-OpenLDAP <SwitchParameter>
Aliases [-LDAP]
Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID
Aliases LDAP
Required? false
Position? named
Default value False
-OrganizationalUnits <Array>
OpenLDAP OU's to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso
Aliases None
Required? true
Position? named
Default value
Aliases [-p, -pass] Directory Username password.
Aliases p, pass
Required? true
Position? named
Default value
-Servers <Array>
Array of Directory Servers and their settings. Must include the following:
* Server Name (FQDN or IP)

* Public SSL Certificate
* SSL Port, if not default 636
Aliases None
Required? true
Position? named
Default value
-ServiceAccount <SwitchParameter>
Use to indicate the provided credential is a Service Account. Required for when configuring an Active Directory auth directory
for two-factor authentication.
Aliases None
Required? False
Position? named
Default value
-Username <String>
Aliases [-u, -user] Directory Username to authenticate with.
Aliases u, user
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Account Password that will be used to validate the directory
Return Values
Configured Authentication Directory
Multiple configured Authentication Directories
Examples
-------------------------- EXAMPLE 1 --------------------------
$ServerA,$ServerB = servera.domain.com,serverb.domain.com | New-HPOVLdapServer

New-HPOVLdapDirectory -name Domain1 -AD -basedn 'dc=domain,dc=com' -servers $ServerA,$ServerB -Username MyAdminA
ccount@domain.com
Add a new directory with two directory servers, and be prompted for your directory account password.
-------------------------- EXAMPLE 2 --------------------------
$ServerA = New-HPOVLdapServer -Name contoso.com

New-HPOVLdapDirectory -name Domain1 -AD -basedn 'dc=domain,dc=com' -servers $ServerA -Username MyAdminAccount@do
main.com -ServiceAccount
Add a new Active Directory authentication directory, using SRV domain name, and specify to use the account as a service
account.
Related Links
Top
New-HPOVLdapGroup

New-HPOVLdapGroup
Add a new Directory Group to appliance.
SYNTAX
New-HPOVLdapGroup [-Directory] <Object> [-Group] <Object> [-Roles] <Array> [-Username] <String>[ [-Password] <Ob
ject>][ [-Credential] <PSCredential>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVLdapGroup [-Directory] <Object> [-Group] <Object>[ [-ScopePermissions] <Array>] [-Username] <String>[ [-

Password] <Object>][ [-Credential] <PSCredential>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet provides the ability to add a new Directory Group to the appliance. You can use the Show-HPOVLdapGroups to
retrieve a list of avialable Directory Groups from the specified Directory.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? False
Position? named
Default value
-Directory <Object>
Aliases [-d, -domain, -AuthProvider] LDAP/Active Directory Domain object.
Aliases d, domain, authProvider
Required? true
Position? named
Default value
-Group <Object>
Aliases [-g, -GroupName, -name] Directroy Group to add. Can either be a string value of a Cononical Name of directory group,
or object from Show-HPOVLdapGroups.
Aliases g, GroupName, name
Required? true
Position? named
Default value
-Password <Object>
Aliases [-p] Directory User account password. Can be System.String or SecureString object.
Aliases p
Required? false
Position? named
Default value
-Roles <Array>
Aliases [-r, -role] The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are
noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the
$Global:ConnectedSessions variable.
Example: $roles = "Server administrator","Network administrator"
Aliases r, role
Required? true
Position? named
Default value
-ScopePermissions <Array>
Array collection of Hashtable<Role; Scope>.
Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction
Stop) }
Aliases None
Required? False
Position? named
Default value

-Username <String>
Aliases [-u] Directory Username to authenticate with
Aliases u
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Appliance.DirectoryGroup [System.Management.Automation.PSCustomObject]
The external authentication directory object from -Get-HPOVLdapDirectory.
Return Values
New LDAP Group object with role assignment(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVLdapGroup -d Domain1 -GroupName "MY Directory Group1" -roles @("Server administrator") -u "Sarah Peterso
n"
Add "MY Directory Group1" from Domain1 with Server Administrator role and prompt for password for group validation.
-------------------------- EXAMPLE 2 --------------------------
# Get the defined directory group from the appliance. $Directory = Get-HPOVLdapDirectory -Name "Domain1" -ErrorA
ction Stop # Collect the users AD password. This does not require Domain Admins or an administrator level acco
unt. Only a standard user account that can query the directory. $Password = ConvertTo-SecureString -AsPlainText
"password123890" -force # Get the directory group object. $Group = Show-HPOVLdapDirectoryGroup -Name "Domain1"
-Directory $Directory -Username "Sarah.Peterson@domain1.com" -Password $Password -ErrorAction Stop # Specify t
he roles needed to be assigned to the directory group. $Roles = "Server administrator","Backup administrator" #
Create the directory group resource on the appliance, and associate with the SBAC permissions. New-HPOVLdapGrou
p -Directory $Directory -GroupName "MY Directory Group1" -Roles $Roles -Username "Sarah.Peterson@domain1.com" -P
assword $Password
Add "MY Directory Group1" from Domain1 with Server and Backup administrator roles, and specify password for group
validation.
-------------------------- EXAMPLE 3 --------------------------
# Get the defined directory group from the appliance. $Directory = Get-HPOVLdapDirectory -Name "Domain1" -ErrorA
ction Stop # Collect the scope needed to assign permissions. $VirtAdminsScope = Get-HPOVScope -Name CorpVirtAdm
ins -ErrorAction Stop # Create a hashtable of the roles to scopes (SBAC) which would then be assigned to the di
rectory group. $ScopeRoles = @{Role = "Server administrator"; Scope = $VirtAdminsScope},@{Role = "Storage admini
strator"; Scope = $VirtAdminsScope} # Collect the users AD credentials. This does not require Domain Admins or
an administrator level account. Only a standard user account that can query the directory. $MyAdCreds = Get-Cr
edential # Get the directory group object. $Group = Show-HPOVLdapDirectoryGroup -Name "CorpVirtAdmins" -Directo
ry $Directory -Credential $MyAdCreds -ErrorAction Stop # Create the directory group resource on the appliance,
and associate with the SBAC permissions. New-HPOVLdapGroup -Directory Directory -GroupName CorpVirtAdmins -Scope
Permissions $ScopeRoles -Credential $MyAdCreds
Add the new directory group with specific scope permissions, and using a PSCredential object for authentication directory
validation. ### Related Links * [Get-HPOVLdapGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVLdapGroup) * [Remove-HPOVLdapGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVLdapGroup) * [Set-HPOVLdapGroupRole](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVLdapGroupRole) * [Show-HPOVLdapGroups](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-
HPOVLdapGroups) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLdapGroup
Add a new Directory Group to appliance. ### SYNTAX
New-HPOVLdapGroup [-Directory] <Object> [-Group] <Object> [-Roles] <Array> [-Username] <String>[ [-Password] <Ob
ject>][ [-Credential] <PSCredential>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVLdapGroup [-Directory] <Object> [-Group] <Object>[ [-ScopePermissions] <Array>] [-Username] <String>[ [-

Password] <Object>][ [-Credential] <PSCredential>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet provides the ability to add a new Directory Group to the appliance. You can use the Show-HPOVLdapGroups to
retrieve a list of avialable Directory Groups from the specified Directory.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? False
Position? named
Default value
-Directory <Object>
Aliases [-d, -domain, -AuthProvider] LDAP/Active Directory Domain object.
Aliases d, domain, authProvider
Required? true
Position? named
Default value
-Group <Object>
Aliases [-g, -GroupName, -name] Directroy Group to add. Can either be a string value of a Cononical Name of directory group,
or object from Show-HPOVLdapGroups.
Aliases g, GroupName, name
Required? true
Position? named
Default value
-Password <Object>
Aliases [-p] Directory User account password. Can be System.String or SecureString object.
Aliases p
Required? false
Position? named
Default value
-Roles <Array>
Aliases r, role
Required? true
Position? named
Default value
Array collection of Hashtable<Role; Scope>.
Example: -ScopePermissions @{Role = 'Network administrator'; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction
Stop) }
Aliases None
Required? False
Position? named
Default value
-Username <String>
Aliases [-u] Directory Username to authenticate with
Aliases u
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.SecureString
Directory User Account password
Return Values
New LDAP Group object with role assignment(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVLdapGroup -d Domain1 -GroupName "MY Directory Group1" -roles @("Server administrator") -u "Sarah Peterso
n"
-------------------------- EXAMPLE 2 --------------------------
Get the defined directory group from the appliance.

$Directory = Get-HPOVLdapDirectory -Name "Domain1" -
ErrorAction Stop # Collect the users AD password.
This does not require Domain Admins or an administra
tor level account. Only a standard user account tha
t can query the directory. $Password = ConvertTo-Sec
ureString -AsPlainText "password123890" -force # Ge
t the directory group object. $Group = Show-HPOVLdap
DirectoryGroup -Name "Domain1" -Directory $Directory
-Username "Sarah.Peterson@domain1.com" -Password $P
assword -ErrorAction Stop # Specify the roles neede
d to be assigned to the directory group. $Roles = "S
erver administrator","Backup administrator" # Creat
e the directory group resource on the appliance, and
associate with the SBAC permissions. New-HPOVLdapGr
oup -Directory $Directory -GroupName "MY Directory G
roup1" -Roles $Roles -Username "Sarah.Peterson@domai
n1.com" -Password $Password
Add "MY Directory Group1" from Domain1 with Server and Backup administrator roles, and specify password for group
validation.
-------------------------- EXAMPLE 3 --------------------------
Get the defined directory group from the appliance.

$Directory = Get-HPOVLdapDirectory -Name "Domain1" -
ErrorAction Stop # Collect the scope needed to assi
gn permissions. $VirtAdminsScope = Get-HPOVScope -Na
me CorpVirtAdmins -ErrorAction Stop # Create a hash
table of the roles to scopes (SBAC) which would then
be assigned to the directory group. $ScopeRoles = @
{Role = "Server administrator"; Scope = $VirtAdminsS
cope},@{Role = "Storage administrator"; Scope = $Vir
tAdminsScope} # Collect the users AD credentials.
This does not require Domain Admins or an administra
tor level account. Only a standard user account tha
t can query the directory. $MyAdCreds = Get-Credenti
al # Get the directory group object. $Group = Show-
HPOVLdapDirectoryGroup -Name "CorpVirtAdmins" -Direc
tory $Directory -Credential $MyAdCreds -ErrorAction
Stop # Create the directory group resource on the a
ppliance, and associate with the SBAC permissions. N
ew-HPOVLdapGroup -Directory Directory -GroupName Cor
pVirtAdmins -ScopePermissions $ScopeRoles -Credentia
l $MyAdCreds
Add the new directory group with specific scope permissions, and using a PSCredential object for authentication directory
validation.
Related Links
Get-HPOVLdapGroup
Show-HPOVLdapGroups
Top
New-HPOVLdapServer

New-HPOVLdapServer
Define LDAP Directory Server object.
SYNTAX
New-HPOVLdapServer [-Hostname] <String> [-SSLPort] <Int32> [-Certificate] <Object>[ [-TrustLeafCertificate] <Swi
tchParameter>] [<CommonParameters>]
A helper cmdlet that will define an LDAP Directory Server object to be used with the New-HPOVLdapDirectory cmdlet.
Parameters
Aliases cert
Required? true
Position? named
Default value
-Hostname <String>
Aliases Name
Required? true
Position? named
Default value
-SSLPort <Int32>
Aliases [-port] Directory Server"s LDAP SSL Port.
Aliases port
Required? true
Position? named
Default value 636
Use to specify if the certificate should be explicitly trusted, like a self-signed certificate or where the root or issuing certificate
authority has not been added to the appliance trust store.
Aliases None
Required? False
Position? named
Default value
<CommonParameters>
Input Types
System.String
Directory Server Name or IP Address
Mutlple Directory Server Name or IP Address System.String values
Return Values
HPOneView.Appliance.AuthDirectoryServer [System.Management.Automation.PSCustomObject]
New LDAP Server Resource Object to be used with New-HPOVLdap CMDLET
Examples
-------------------------- EXAMPLE 1 --------------------------
$ServerA = New-HPOVLdapServer -Name servera.domain.com -Certificate C:\dir\servera.cer
Define a new Directory Server, ServerA, specifying the Base64 Public Certificate and using the default LDAP SSL port 636.
-------------------------- EXAMPLE 2 --------------------------
$ServerA = New-HPOVLdapServer -Name servera.domain.com -Port 2636 -Certificate C:\dir\servera.cer
Define a new Directory Server, ServerA, specifying the Base64 Public Certificate, using a custom LDAP SSL port.
-------------------------- EXAMPLE 3 --------------------------
$dc1,$dc2 = "dc1.mydomain.com","dc2.mydomain.com" | New-HPOVLdapServer
Create two new authentication directory servers, with the CMDLET retrieving the certificate directly from the auth servers. ###
Related Links * [Add-HPOVLdapServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVLdapServer) *
[Remove-HPOVLdapServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLdapServer) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLdapServer
Define LDAP Directory Server object. ### SYNTAX

New-HPOVLdapServer [-Hostname] <String> [-SSLPort] <Int32> [-Certificate] <Object>[ [-TrustLeafCertificate] <Swi
tchParameter>] [<CommonParameters>]
A helper cmdlet that will define an LDAP Directory Server object to be used with the New-HPOVLdapDirectory cmdlet.
Parameters
Aliases cert
Required? true
Position? named
Default value
-Hostname <String>
Aliases Name
Required? true
Position? named
Default value
-SSLPort <Int32>
Aliases [-port] Directory Server's LDAP SSL Port.
Aliases port
Required? true
Position? named
Default value 636
Use to specify if the certificate should be explicitly trusted, like a self-signed certificate or where the root or issuing certificate
authority has not been added to the appliance trust store.
Aliases None
Required? False
Position? named
Default value
<CommonParameters>
Input Types
System.String
Directory Server Name or IP Address
Mutlple Directory Server Name or IP Address System.String values
Return Values
HPOneView.Appliance.AuthDirectoryServer [System.Management.Automation.PSCustomObject]
New LDAP Server Resource Object to be used with New-HPOVLdap CMDLET
Examples
-------------------------- EXAMPLE 1 --------------------------
$ServerA = New-HPOVLdapServer -Name servera.domain.com -Certificate C:\dir\servera.cer
Define a new Directory Server, ServerA, specifying the Base64 Public Certificate and using the default LDAP SSL port 636.
-------------------------- EXAMPLE 2 --------------------------
$ServerA = New-HPOVLdapServer -Name servera.domain.com -Port 2636 -Certificate C:\dir\servera.cer
Define a new Directory Server, ServerA, specifying the Base64 Public Certificate, using a custom LDAP SSL port.
-------------------------- EXAMPLE 3 --------------------------
$dc1,$dc2 = 'dc1.mydomain.com','dc2.mydomain.com' | New-HPOVLdapServer
Create two new authentication directory servers, with the CMDLET retrieving the certificate directly from the auth servers.
Related Links
Add-HPOVLdapServer
Top
New-HPOVLicense
New-HPOVLicense
Install license on the appliance
SYNTAX
New-HPOVLicense [-LicenseKey] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
New-HPOVLicense [-File] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will install licenses on the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
-File <String>
A text file with each license key on a new line that will be installed on the appliance.
Aliases None
Required? true
Position? named
Default value
-LicenseKey <String>
Used for adding license keys one at a time, or if only a single license key needs to be added.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
License key in String Format, from Get-Content or an Array of String
Return Values
The License resource just added to the apliance
Examples
-------------------------- EXAMPLE 1 --------------------------
$license = "FC9E D9MA H9PA GTVZ C7B5 HWWB Y9JL KHPL B89H MZVU DXAU 9CSM GHTG L762 2F25 HJF9 KJVT D5TM EFVW TZNJ
FGTM NQ6G 2P2J 9G82 ZJKZ EWLR VW8A Y5A4 N2SK H1MQ XJJL LUQH ZUWD 9ATC NJ79 CEJC 5S86 FC4X EKSZ X4CP XZLU FSXS FK
S6 KKCE 4NMU FPN5 N82E Z2RX 3QTM EFQC 29JK 29MC "ORDER_101613 E1Y94A HP_OV_3yr_24x7_Supp_Phys_1_Svr_Lic EONEJTCD
T4FJ"_35HZP-CYMTH-W414S-2DGKZ-S6MPH"
New-HPOVlicense $license
Install license on the appliance connection.

-------------------------- EXAMPLE 2 --------------------------
New-HPOVlicense -file c:\licenses.txt

Install licenses from a file.
GC C:\licenses.txt | New-HPOVlicense
Install licenses read from a file by Get-Content. ### Related Links * [Get-HPOVLicense]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLicense) * [Remove-HPOVLicense]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLicense) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLicense
Install license on the appliance ### SYNTAX
New-HPOVLicense [-LicenseKey] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
New-HPOVLicense [-File] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will install licenses on the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
-File <String>
A text file with each license key on a new line that will be installed on the appliance.
Aliases None
Required? true
Position? named
Default value
-LicenseKey <String>
Used for adding license keys one at a time, or if only a single license key needs to be added.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
License key in String Format, from Get-Content or an Array of String
Return Values
The License resource just added to the apliance
Examples
-------------------------- EXAMPLE 1 --------------------------
$license = 'FC9E D9MA H9PA GTVZ C7B5 HWWB Y9JL KHPL B89H MZVU DXAU 9CSM GHTG L762 2F25 HJF9 KJVT D5TM EFVW TZNJ
FGTM NQ6G 2P2J 9G82 ZJKZ EWLR VW8A Y5A4 N2SK H1MQ XJJL LUQH ZUWD 9ATC NJ79 CEJC 5S86 FC4X EKSZ X4CP XZLU FSXS FK
S6 KKCE 4NMU FPN5 N82E Z2RX 3QTM EFQC 29JK 29MC "ORDER_101613 E1Y94A HP_OV_3yr_24x7_Supp_Phys_1_Svr_Lic EONEJTCD
T4FJ"_35HZP-CYMTH-W414S-2DGKZ-S6MPH'
New-HPOVlicense $license
Install license on the appliance connection.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVlicense -file c:\licenses.txt

Install licenses from a file.
GC C:\licenses.txt | New-HPOVlicense
Install licenses read from a file by Get-Content.
Related Links
Get-HPOVLicense
Remove-HPOVLicense
Top

Create a Logical Enclosure.
SYNTAX
New-HPOVLogicalEnclosure [-Name] <String> [-Enclosure] <Object> [-EnclosureGroup] <Object> [-FirmwareBaseline] <
String> [-ForceFirmwareBaseline] <Boolean>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchPar
ameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
A logical enclosure represents a logical view of a single enclosure with an enclosure group serving as a template. If the intended
configuration in the logical enclosure does not match the actual configuration on the enclosures, the logical enclosure becomes
inconsistent. Use the Logical Enclosures screen to manage firmware, configuration scripts, create a support dump, and to apply
updates made from the Enclosure Groups screen to the enclosures in the logical enclosure.
A logical enclosure is automatically created when a c7000 enclosure is added.
Use this Cmdlet to define a new Logical Enclosure that will include multiple Synergy Frames that share the same Virtual Connect
Fabric Domain.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Enclosure <Object>
One of the connected Frames. The Interlink Topology will be discovered to include the other Frame members.
Aliases None
Required? true
Position? named
Default value
The Enclosure Group resource to deploy the policy from.

Aliases eg
Required? true
Position? named
Default value
-FirmwareBaseline <String>
Provide the Firmware Baseline object to use with the Logical Enclosure is being created.
Aliases None
Required? true
Position? named
Default value
-ForceFirmwareBaseline <Boolean>
Specify to force the installation of firmware if the same version is found or if you wish to downgrade from a newer installed
version.
Aliases None
Required? true
Position? named
Default value False
-Name <String>
A name for the new Logical Enclosure.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
<CommonParameters>
Input Types
Single Enclosure (Synergy Frame) resource object
Return Values
The async task resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$EG = Get-HPOVEnclosureGroup -Name "Prod Synergy EG 1"

Get-HPOVEnclosure -Name 0000A66101 | New-HPOVLogicalEnclosure "My Synergy LE 1" -EnclosureGroup $EG
Create a new Logical Enclosure, "My Synergy LE 1", using the specified Enclosure Group and a specific Synergy Frame. ###
Related Links * [Get-HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVLogicalEnclosure) * [Remove-HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVLogicalEnclosure) * [Set-HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVLogicalEnclosure) * [Update-HPOVLogicalEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-
HPOVLogicalEnclosure) * [Update-HPOVLogicalEnclosureFirmware](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Update-HPOVLogicalEnclosureFirmware) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLogicalEnclosure
Create a Logical Enclosure. ### SYNTAX
New-HPOVLogicalEnclosure [-Name] <String> [-Enclosure] <Object> [-EnclosureGroup] <Object> [-FirmwareBaseline] <

String> [-ForceFirmwareBaseline] <Boolean>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchPar
Use this Cmdlet to define a new Logical Enclosure that will include multiple Synergy Frames that share the same Virtual Connect
Fabric Domain.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Enclosure <Object>
One of the connected Frames. The Interlink Topology will be discovered to include the other Frame members.
Aliases None
Required? true
Position? named
Default value
The Enclosure Group resource to deploy the policy from.
Aliases eg
Required? true
Position? named
Default value

-FirmwareBaseline <String>
Provide the Firmware Baseline object to use with the Logical Enclosure is being created.
Aliases None
Required? true
Position? named
Default value
-ForceFirmwareBaseline <Boolean>
Specify to force the installation of firmware if the same version is found or if you wish to downgrade from a newer installed
version.
Aliases None
Required? true
Position? named
Default value False
-Name <String>
A name for the new Logical Enclosure.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False

<CommonParameters>
Input Types
Single Enclosure (Synergy Frame) resource object
Return Values
The async task resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$EG = Get-HPOVEnclosureGroup -Name 'Prod Synergy EG 1'

Get-HPOVEnclosure -Name 0000A66101 | New-HPOVLogicalEnclosure 'My Synergy LE 1' -EnclosureGroup $EG
Create a new Logical Enclosure, 'My Synergy LE 1', using the specified Enclosure Group and a specific Synergy Frame.
Related Links
Top

Create new Logical Interconnect Group.
SYNTAX
New-HPOVLogicalInterconnectGroup [-Name] <String> [-Bays] <Hashtable> [-EnableIgmpSnooping] <Boolean> [-IgmpIdle
TimeoutInterval] <Int32> [-EnableFastMacCacheFailover] <Boolean> [-MacRefreshInterval] <Int32> [-EnableNetworkLo
opProtection] <Boolean> [-EnablePauseFloodProtection] <Boolean> [-EnableLLDPTagging] <Boolean> [-EnableEnhancedL
LDPTLV] <Boolean> [-LldpAddressingMode] <Boolean> [-SNMP] <Object>[ [-SnmpV1] <SwitchParameter>][ [-SnmpV3] <Swi
tchParameter>] [-SnmpV3User] <HPOneView.Appliance.SnmpV3User> [-InternalNetworks] <Array> [-QosConfiguration] <O
bject>[ [-Scope] <HPOneView.Appliance.ScopeCollection>] [-ApplianceConnection] <Object>[ [-Async] <SwitchParamet
er>] [<CommonParameters>]
New-HPOVLogicalInterconnectGroup [-Name] <String> [-FrameCount] <Int32> [-InterconnectBaySet] <Int32> [-FabricMo

duleType] <String> [-Bays] <Hashtable> [-FabricRedundancy] <String> [-EnableIgmpSnooping] <Boolean> [-IgmpIdleTi
meoutInterval] <Int32> [-EnableNetworkLoopProtection] <Boolean> [-EnableLLDPTagging] <Boolean> [-EnableEnhancedL
New-HPOVLogicalInterconnectGroup [-Import] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>] [-Appliance

Connection] <Object> [<CommonParameters>]
This cmdlet provides the ability to create a Logical Interconnect Group. Bays 1 and 2 are required, and need to be identical.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Bays <Hashtable>
HPE BladeSystem C7000 Support - A [System.Collections.Hashtable] object of each Interconnect Bay. Accepted values are:
* FlexFabric - HP VC FlexFabric 10Gb/24-Port Module
* Flex10 - HP VC Flex-10 Enet Module
* Flex1010D - HP VC Flex-10/10D Module
* Flex2040f8 - HP VC FlexFabric-20/40 F8 Module
* VCFC20 - HP VC 8Gb 20-Port FC Module
* FEX - Cisco Fabric Extender for HP BladeSystem
E.g. @{1 = "Flex10";2 = "Flex10";3 = "FlexFabric";4 = "Flexfabric";5 = "";6 = "";7 = "";8 = "";}
HPE Synergy Support - A [System.Collection.Hashtable] object, with Frame and Fabric Bay definitions. Accepted values are:
* SEVC40f8 - Virtual Connect SE 40Gb F8 Module for Synergy

* SEVC16GbFC - Virtual Connect SE 16Gb FC Module for Synergy
* SE20ILM - Synergy 20Gb Interconnect Link Module
* SE12SAS - Synergy 12Gb SAS Connection Module
$Bays = @{ Frame1 = @{Bay3 = "SEVC40f8"; Bay6 = "SE20ILM"}; Frame2 = @{Bay3 = "SE20ILM"; Bay6 = "SEVC40f8"} }
Note: When configuring Synergy SAS Connection Module, no other device bays can be specified, and only a Single Frame can
be configured.
Aliases None
Required? true
Position? named
Default value
-EnableEnhancedLLDPTLV <Boolean>
When enabled, the enclosure name and serial number are encapsulated in the Chassis ID TLV LLDPDU transmitted by
interconnect uplink ports.
This parameter is only available for 2.00.07 or newer appliances.
Aliases None
Required? true
Position? named
Default value False
-EnableFastMacCacheFailover <Boolean>
When an uplink that was in standby mode becomes active, it can take several minutes for external Ethernet interconnects to
recognize that the server blades can now be reached on this newly active connection. Enabling Fast MAC Cache Failover
causes Ethernet packets to be transmitted on the newly active connection, which enables the external Ethernet interconnects to
identify the new connection (and update their MAC caches). The transmission sequence is repeated a few times at the MAC
refresh interval and completes in about 1 minute.
Default value: Enabled
Aliases FastMAC
Required? true
Position? named
Default value True
-EnableIgmpSnooping <Boolean>
The IGMP snooping feature allows interconnects to monitor the IGMP IP multicast membership activities and configure hardware
Layer 2 switching behavior of multicast traffic to optimize network resource usage. Currently, only IGMP v1 and v2 (RFC 2236)
are supported.
Default value: Disabled
Aliases IGMPSnoop
Required? true
Position? named
Default value False
-EnableLLDPTagging <Boolean>
When enabled, tagged LLDP frames are transmitted over downlink ports to server hardware. The management IP address of
the interconnect in the lowest numbered bay location in the logical interconnect will be advertised as the LLDP management
address TLV.
Aliases None
Required? true
Position? named
Default value False
-EnableNetworkLoopProtection <Boolean>
Aliases [-LoopProtect] Enables or disables network loop protection.
Network loop protection:
The loop protection feature enables detection of loops on downlink ports, which can be Flex-10 logical ports or physical ports.
The feature applies when Device Control Channel (DCC) protocol is running on the Flex-10 port. If DCC is not available, the
feature applies to the physical downlink port.
Network loop protection uses two methods to detect loops:
1. It periodically injects a special probe frame into the VC domain and monitors downlink ports for the looped back probe
frame. If this special probe frame is detected on downlink ports, the port is considered to cause the loop condition.
2. It monitors and intercepts common loop detection frames used in other switches. In network environments where the
upstream switches send loop detection frames, the VC interconnects must ensure that any downlink loops do not cause
these frames to be sent back to the uplink ports. Even though the probe frames ensure loops are detected, there is a small
time window depending on the probe frame transmission interval in which the loop detection frames from the external switch
might loop through down link ports and reach uplink ports. By intercepting the external loop detection frames on downlinks,
the possibility of triggering loop protection on the upstream switch is eliminated. When network loop protection is enabled,
VC interconnects intercept loop detection frames from various switch vendors, such as Cisco and HP Networking.
When the network loop protection feature is enabled, any probe frame or other supported loop detection frame received on a
downlink port is considered to be causing the network loop, and the port is disabled immediately until an administrative action is
taken. The administrative action involves resolving the loop condition and clearing the loop protection error condition. The loop
detected status on a port can be cleared by un-assigning all networks from the profile connect corresponding to the port in the
loop detected state.
The SNMP agent supports trap generation when a loop condition is detected or cleared.
Aliases LoopProtect
Required? true
Position? named
Default value True
-EnablePauseFloodProtection <Boolean>
Aliases [-PauseProtect] Enables or disables pause flood protection.
Pause flood protection:
Ethernet switch interfaces use pause frame based flow control mechanisms to control data flow. When a pause frame is
received on a flow control enabled interface, the transmit operation is stopped for the pause duration specified in the pause
frame. All other frames destined for this interface are queued up. If another pause frame is received before the previous pause
timer expires, the pause timer is refreshed to the new pause duration value. If a steady stream of pause frames is received for
extended periods of time, the transmit queue for that interface continues to grow until all queuing resources are exhausted. This
condition severely impacts the switch operation on other interfaces. In addition, all protocol operations on the switch are
impacted because of the inability to transmit protocol frames. Both port pause and priority-based pause frames can cause the
same resource exhaustion condition.
VC interconnects provide the ability to monitor server downlink ports for pause flood conditions and take protective action by
disabling the port. The default polling interval is 10 seconds and is not customer configurable. The SNMP agent supports trap
generation when a pause flood condition is detected or cleared.
This feature operates at the physical port level. When a pause flood condition is detected on a Flex-10 physical port, all Flex-10
logical ports associated with physical ports are disabled. When the pause flood protection feature is enabled, this feature
detects pause flood conditions on server downlink ports and disables the port. The port remains disabled until an administrative
action is taken. The administrative action involves the following steps:
1. Resolve the issue with the NIC on the server causing the continuous pause generation. This might include updating the NIC
firmware and device drivers.
Rebooting the server might not clear the pause flood condition if the cause of the pause flood condition is in the NIC firmware. In
this case, the server must be completely disconnected from the power source to reset the NIC firmware.
2. Re-enable the disabled ports on the VC interconnect modules.
Aliases PauseProtect
Required? true
Position? named
Default value True
-FabricModuleType <String>
Specify the Synergy Fabric Module type the Logical Interconnect Group will be modeled for. Allowed value:
* SEVC40F8 - Virtual Connect SE 40Gb F8 Module for Synergy

* SEVCFC - Virtual Connect SE 16Gb FC Module for Synergy
* SAS - Synergy 12Gb SAS Connection Module
Aliases None
Required? true
Position? named
Default value
-FabricRedundancy <String>
Define the expected Synergy Fabric Interconnect Redundancy type. Allowed value:
* HighlyAvailable
* Redundant
* ASide
* BSide
Aliases None
Required? true
Position? named
Default value Redundant
-FrameCount <Int32>
The number of Synergy Frames to participate in the Logical Stack.
Aliases None
Required? true
Position? named
Default value 0
-IgmpIdleTimeoutInterval <Int32>
The Group Membership Interval value, as specified by the IGMP v2 specification (RFC 2236). For optimum network resource
usage, set the timeout interval to match your network"s multicast router settings.
Data type: Numeric; unit of measure is seconds Default value: 260 Required: Yes, if IGMP snooping is enabled
Aliases IGMPIdle
Required? true
Position? named
Default value 260
-Import <Object>
Specify JSON source file to create Logical Interconnect Group.
Aliases i
Required? true
Position? named
Default value
-InterconnectBaySet <Int32>
Which Synergy Interconnect Bay Set ID will the interconnects be populated in. Allowed value:
* 1 - Interconnect Bay set 1 & 4

Aliases None
Required? true
Position? named
Default value 0
-InternalNetworks <Array>
An Array collection of Networks that will be marked as Internal only.
Aliases None
Required? true
Position? named
Default value

-LldpAddressingMode <Boolean>
Specify the IP address format type to support. Allowed values:
* IPv4
* IPv6
* IPv4AndIPv6
Aliases None
Required? true
Position? named
Default value False
-MacRefreshInterval <Int32>
The time interval at which MAC caches are refreshed
Data type: Numeric; unit of measure is seconds Default value: 5
Aliases FastMACRefresh
Required? true
Position? named
Default value 5
-Name <String>
Aliases [-LIGName]
The Logical Interconnect Group Name
Aliases ligname
Required? true
Position? named
Default value
-QosConfiguration <Object>
Aliases [-qos, -QosConfig] A collection of QOS configurations that are created using the New-HPOVQosConfig helper CMDLET.
Aliases qos, QosConfig
Required? true
Position? named
Default value
-SNMP <Object>
SNMP Settings to define SNMP configruation. Use New-HPOVSnmpConfiguration and New-HPOVSnmpTrapDestination Cmdlets
to create the necessary SNMP Configuration object.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
-SnmpV1 <SwitchParameter>
Specify the SNMP version type is SNMPv1.
Aliases None
Required? False
Position? named
Default value
Aliases None
Required? False
Position? named
Default value

Provide the SNMPv3 user object from New-HPOVSnmpV3User.
Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
System.Collections.Hashtable
Hashtable containing Interconnect Bay layout and associated interconnect module
Return Values
Logical Interconnect Group creation async task
Examples
-------------------------- EXAMPLE 1 --------------------------
$Dest1 = New-HPOVSnmpTrapDestination -Destination mysnmpserver.domain.local -Community MyR3adcommun1ty -SnmpForm

at SNMPv1 -TrapSeverities critical,warning
$Dest2 = New-HPOVSnmpTrapDestination 10.44.120.9 MyR3adcommun1ty SNMPv1 critical,warning legacy "Other","PortSta
tus","PortThresholds" "Other","PortStatus"
$SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.
0/22" -TrapDestinations $Dest1,$Dest2
$Bays = @{1 = "FlexFabric";2 = "FlexFabric"}
New-HPOVLogicalInterconnectGroup "FlexFabric Production 1" -bays $Bays -snmp $SnmpConfig
Create a Logical Interconnect Group with VC FlexFabric modules in Bays 1 and 2, and SNMP Settings
-------------------------- EXAMPLE 2 --------------------------
$InternalNetworks = Get-HPOVNetwork -Name "My Internal VLANs*"

New-HPOVLogicalInterconnectGroup -Name "Synergy VC Prod" -FrameCount 3 -InterconnectBaySet 3 -FabricModuleType "
SEVC40F8" -Bays @{Frame1 = @{Bay3 = "SEVC40f8" ; Bay6 = "SE20ILM"};Frame2 = @{Bay3 = "SE20ILM"; Bay6 = "SEVC40f8
" };Frame3 = @{Bay3 = "SE20ILM"; Bay6 = "SE20ILM"}} -FabricRedundancy "HighlyAvailable" -InternalNetworks $Inter
nalNetworks
Create a Synergy Virtual Connect multi-Frame Logical Interconnect Group resource, using Bay Set 3 and Synergy 20Gb
Satellite modules.
-------------------------- EXAMPLE 3 --------------------------
New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1010D";2 = "
Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -enableIgmpSnooping $True -igmpIdleTimeoutInterval 300 -LoopProtec
t $True
Create a Logical Interconnect Group with VC Flex10/10D in Bays 1 and 2, FlexFabric modules in Bays 3 and 4, Enable IGMP
Snooping, IGMP Idle timeout and LoopProtect
-------------------------- EXAMPLE 4 --------------------------
New-HPOVLogicalInterconnectGroup -Name "Synergy SAS Prod" -FrameCount 1 -InterconnectBaySet 1 -FabricModuleType

"SAS" -Bays @{Frame1 = @{Bay1 = "SE12SAS" ; Bay4 = "SE12SAS"}}
Create a Synergy SAS Logical Interconnect Group resource.

-------------------------- EXAMPLE 5 --------------------------
New-HPOVLogicalInterconnectGroup -Name "Synergy VC FC Prod" -FrameCount 1 -InterconnectBaySet 2 -FabricModuleTyp

e "SEVCFC" -Bays @{Frame1 = @{Bay2 = "SEVC16GbFC" ; Bay5 = "SEVC16GbFC"}}
Create a Synergy Virtual Connect Fibre Channel Logical Interconnect Group resource.
-------------------------- EXAMPLE 6 --------------------------
New-HPOVLogicalInterconnectGroup -import c:\dir\mylig.json
Create a Logical Interconnect Group by using a JSON formatted input file. ### Related Links * [Get-
HPOneView/wiki/Remove-HPOVLogicalInterconnectGroup) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLogicalInterconnectGroup
Create new Logical Interconnect Group. ### SYNTAX
New-HPOVLogicalInterconnectGroup [-Name] <String> [-Bays] <Hashtable> [-EnableIgmpSnooping] <Boolean> [-IgmpIdle

TimeoutInterval] <Int32> [-EnableFastMacCacheFailover] <Boolean> [-MacRefreshInterval] <Int32> [-EnableNetworkLo
opProtection] <Boolean> [-EnablePauseFloodProtection] <Boolean> [-EnableLLDPTagging] <Boolean> [-EnableEnhancedL
New-HPOVLogicalInterconnectGroup [-Name] <String> [-FrameCount] <Int32> [-InterconnectBaySet] <Int32> [-FabricMo

duleType] <String> [-Bays] <Hashtable> [-FabricRedundancy] <String> [-EnableIgmpSnooping] <Boolean> [-IgmpIdleTi
meoutInterval] <Int32> [-EnableNetworkLoopProtection] <Boolean> [-EnableLLDPTagging] <Boolean> [-EnableEnhancedL
New-HPOVLogicalInterconnectGroup [-Import] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>] [-Appliance

Connection] <Object> [<CommonParameters>]
This cmdlet provides the ability to create a Logical Interconnect Group. Bays 1 and 2 are required, and need to be identical.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Bays <Hashtable>
HPE BladeSystem C7000 Support - A [System.Collections.Hashtable] object of each Interconnect Bay. Accepted values are:
* FlexFabric - HP VC FlexFabric 10Gb/24-Port Module

* Flex10 - HP VC Flex-10 Enet Module
* Flex1010D - HP VC Flex-10/10D Module
* Flex2040f8 - HP VC FlexFabric-20/40 F8 Module
* VC16GbFC24 - HP VC 16Gb 24-Port FC Module
* FEX - Cisco Fabric Extender for HP BladeSystem
E.g. @{1 = "Flex10";2 = "Flex10";3 = "FlexFabric";4 = "Flexfabric";5 = "";6 = "";7 = "";8 = "";}
HPE Synergy Support - A [System.Collection.Hashtable] object, with Frame and Fabric Bay definitions. Accepted values are:
* SEVC40f8 - Virtual Connect SE 40Gb F8 Module for Synergy

* SEVC16GbFC - Virtual Connect SE 16Gb FC Module for Synergy
* SE12SAS - Synergy 12Gb SAS Connection Module
$Bays = @{ Frame1 = @{Bay3 = 'SEVC40f8'; Bay6 = 'SE20ILM'}; Frame2 = @{Bay3 = 'SE20ILM'; Bay6 = 'SEVC40f8'} }
Note: When configuring Synergy SAS Connection Module, no other device bays can be specified, and only a Single Frame can
be configured.
Aliases None
Required? true
Position? named
Default value
-EnableEnhancedLLDPTLV <Boolean>
When enabled, the enclosure name and serial number are encapsulated in the Chassis ID TLV LLDPDU transmitted by
interconnect uplink ports.
Aliases None
Required? true
Position? named
Default value False
-EnableFastMacCacheFailover <Boolean>
When an uplink that was in standby mode becomes active, it can take several minutes for external Ethernet interconnects to
recognize that the server blades can now be reached on this newly active connection. Enabling Fast MAC Cache Failover
causes Ethernet packets to be transmitted on the newly active connection, which enables the external Ethernet interconnects to
identify the new connection (and update their MAC caches). The transmission sequence is repeated a few times at the MAC
refresh interval and completes in about 1 minute.
Aliases FastMAC
Required? true
Position? named
Default value True
-EnableIgmpSnooping <Boolean>
The IGMP snooping feature allows interconnects to monitor the IGMP IP multicast membership activities and configure hardware
Layer 2 switching behavior of multicast traffic to optimize network resource usage. Currently, only IGMP v1 and v2 (RFC 2236)
are supported.
Default value: Disabled
Aliases IGMPSnoop
Required? true
Position? named
Default value False

-EnableLLDPTagging <Boolean>
When enabled, tagged LLDP frames are transmitted over downlink ports to server hardware. The management IP address of
the interconnect in the lowest numbered bay location in the logical interconnect will be advertised as the LLDP management
address TLV.
Aliases None
Required? true
Position? named
Default value False
-EnableNetworkLoopProtection <Boolean>
Aliases [-LoopProtect] Enables or disables network loop protection.
Network loop protection:
The loop protection feature enables detection of loops on downlink ports, which can be Flex-10 logical ports or physical ports.
The feature applies when Device Control Channel (DCC) protocol is running on the Flex-10 port. If DCC is not available, the
feature applies to the physical downlink port.
Network loop protection uses two methods to detect loops:
1. It periodically injects a special probe frame into the VC domain and monitors downlink ports for the looped back probe
frame. If this special probe frame is detected on downlink ports, the port is considered to cause the loop condition.
2. It monitors and intercepts common loop detection frames used in other switches. In network environments where the
upstream switches send loop detection frames, the VC interconnects must ensure that any downlink loops do not cause
these frames to be sent back to the uplink ports. Even though the probe frames ensure loops are detected, there is a small
time window depending on the probe frame transmission interval in which the loop detection frames from the external switch
might loop through down link ports and reach uplink ports. By intercepting the external loop detection frames on downlinks,
the possibility of triggering loop protection on the upstream switch is eliminated. When network loop protection is enabled,
VC interconnects intercept loop detection frames from various switch vendors, such as Cisco and HP Networking.
When the network loop protection feature is enabled, any probe frame or other supported loop detection frame received on a
downlink port is considered to be causing the network loop, and the port is disabled immediately until an administrative action is
taken. The administrative action involves resolving the loop condition and clearing the loop protection error condition. The loop
detected status on a port can be cleared by un-assigning all networks from the profile connect corresponding to the port in the
loop detected state.
The SNMP agent supports trap generation when a loop condition is detected or cleared.
Aliases LoopProtect
Required? true
Position? named
Default value True
-EnablePauseFloodProtection <Boolean>
Aliases [-PauseProtect] Enables or disables pause flood protection.
Pause flood protection:
Ethernet switch interfaces use pause frame based flow control mechanisms to control data flow. When a pause frame is
received on a flow control enabled interface, the transmit operation is stopped for the pause duration specified in the pause
frame. All other frames destined for this interface are queued up. If another pause frame is received before the previous pause
timer expires, the pause timer is refreshed to the new pause duration value. If a steady stream of pause frames is received for
extended periods of time, the transmit queue for that interface continues to grow until all queuing resources are exhausted. This
condition severely impacts the switch operation on other interfaces. In addition, all protocol operations on the switch are
impacted because of the inability to transmit protocol frames. Both port pause and priority-based pause frames can cause the
same resource exhaustion condition.
VC interconnects provide the ability to monitor server downlink ports for pause flood conditions and take protective action by
disabling the port. The default polling interval is 10 seconds and is not customer configurable. The SNMP agent supports trap
generation when a pause flood condition is detected or cleared.
This feature operates at the physical port level. When a pause flood condition is detected on a Flex-10 physical port, all Flex-10
logical ports associated with physical ports are disabled. When the pause flood protection feature is enabled, this feature
detects pause flood conditions on server downlink ports and disables the port. The port remains disabled until an administrative
action is taken. The administrative action involves the following steps:
1. Resolve the issue with the NIC on the server causing the continuous pause generation. This might include updating the NIC
firmware and device drivers.
Rebooting the server might not clear the pause flood condition if the cause of the pause flood condition is in the NIC firmware. In
this case, the server must be completely disconnected from the power source to reset the NIC firmware.
2. Re-enable the disabled ports on the VC interconnect modules.
Aliases PauseProtect
Required? true
Position? named
Default value True
-FabricModuleType <String>
Specify the Synergy Fabric Module type the Logical Interconnect Group will be modeled for. Allowed value:
* SEVC40F8 - Virtual Connect SE 40Gb F8 Module for Synergy

* SEVCFC - Virtual Connect SE 16Gb FC Module for Synergy
* SAS - Synergy 12Gb SAS Connection Module
Aliases None
Required? true
Position? named
Default value
-FabricRedundancy <String>
Define the expected Synergy Fabric Interconnect Redundancy type. Allowed value:
* HighlyAvailable
* Redundant
* ASide
* BSide
Aliases None
Required? true
Position? named
Default value Redundant
-FrameCount <Int32>
The number of Synergy Frames to participate in the Logical Stack.
Aliases None
Required? true
Position? named
Default value 0
-IgmpIdleTimeoutInterval <Int32>
The Group Membership Interval value, as specified by the IGMP v2 specification (RFC 2236). For optimum network resource
usage, set the timeout interval to match your network's multicast router settings.
Data type: Numeric; unit of measure is seconds Default value: 260 Required: Yes, if IGMP snooping is enabled
Aliases IGMPIdle
Required? true
Position? named
Default value 260
-Import <Object>
Specify JSON source file to create Logical Interconnect Group.
Aliases i
Required? true
Position? named
Default value

-InterconnectBaySet <Int32>
Which Synergy Interconnect Bay Set ID will the interconnects be populated in. Allowed value:

Aliases None
Required? true
Position? named
Default value 0
-InternalNetworks <Array>
An Array collection of Networks that will be marked as Internal only.
Aliases None
Required? true
Position? named
Default value
-LldpAddressingMode <Boolean>
Specify the IP address format type to support. Allowed values:
* IPv4
* IPv6
* IPv4AndIPv6
Aliases None
Required? true
Position? named
Default value False
-MacRefreshInterval <Int32>
The time interval at which MAC caches are refreshed
Data type: Numeric; unit of measure is seconds Default value: 5
Aliases FastMACRefresh
Required? true
Position? named
Default value 5
-Name <String>
Aliases [-LIGName]
The Logical Interconnect Group Name
Aliases ligname
Required? true
Position? named
Default value
-QosConfiguration <Object>
Aliases [-qos, -QosConfig] A collection of QOS configurations that are created using the New-HPOVQosConfig helper CMDLET.
Aliases qos, QosConfig
Required? true
Position? named
Default value
-SNMP <Object>
SNMP Settings to define SNMP configruation. Use New-HPOVSnmpConfiguration and New-HPOVSnmpTrapDestination Cmdlets
to create the necessary SNMP Configuration object.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? False
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
Provide the SNMPv3 user object from New-HPOVSnmpV3User.
Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
Hashtable containing Interconnect Bay layout and associated interconnect module

Return Values
Logical Interconnect Group creation async task
Examples
-------------------------- EXAMPLE 1 --------------------------

$Dest2 = New-HPOVSnmpTrapDestination 10.44.120.9 MyR3adcommun1ty SNMPv1 critical,warning legacy 'Other','PortSta
tus','PortThresholds' 'Other','PortStatus'
$SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList '10.44.120.9/32','172.20.148.
0/22' -TrapDestinations $Dest1,$Dest2
$Bays = @{1 = "FlexFabric";2 = "FlexFabric"}
New-HPOVLogicalInterconnectGroup "FlexFabric Production 1" -bays $Bays -snmp $SnmpConfig
Create a Logical Interconnect Group with VC FlexFabric modules in Bays 1 and 2, and SNMP Settings
-------------------------- EXAMPLE 2 --------------------------
$InternalNetworks = Get-HPOVNetwork -Name "My Internal VLANs*"

New-HPOVLogicalInterconnectGroup -Name 'Synergy VC Prod' -FrameCount 3 -InterconnectBaySet 3 -FabricModuleType '
SEVC40F8' -Bays @{Frame1 = @{Bay3 = 'SEVC40f8' ; Bay6 = 'SE20ILM'};Frame2 = @{Bay3 = 'SE20ILM'; Bay6 = 'SEVC40f8
' };Frame3 = @{Bay3 = 'SE20ILM'; Bay6 = 'SE20ILM'}} -FabricRedundancy 'HighlyAvailable' -InternalNetworks $Inter
nalNetworks
Create a Synergy Virtual Connect multi-Frame Logical Interconnect Group resource, using Bay Set 3 and Synergy 20Gb
Satellite modules.
-------------------------- EXAMPLE 3 --------------------------
t $True
Create a Logical Interconnect Group with VC Flex10/10D in Bays 1 and 2, FlexFabric modules in Bays 3 and 4, Enable IGMP
Snooping, IGMP Idle timeout and LoopProtect
-------------------------- EXAMPLE 4 --------------------------
New-HPOVLogicalInterconnectGroup -Name 'Synergy SAS Prod' -FrameCount 1 -InterconnectBaySet 1 -FabricModuleType

'SAS' -Bays @{Frame1 = @{Bay1 = 'SE12SAS' ; Bay4 = 'SE12SAS'}}
Create a Synergy SAS Logical Interconnect Group resource.
-------------------------- EXAMPLE 5 --------------------------
New-HPOVLogicalInterconnectGroup -Name 'Synergy VC FC Prod' -FrameCount 1 -InterconnectBaySet 2 -FabricModuleTyp

e 'SEVCFC' -Bays @{Frame1 = @{Bay2 = 'SEVC16GbFC' ; Bay5 = 'SEVC16GbFC'}}
Create a Synergy Virtual Connect Fibre Channel Logical Interconnect Group resource.
-------------------------- EXAMPLE 6 --------------------------
New-HPOVLogicalInterconnectGroup -import c:\dir\mylig.json
Create a Logical Interconnect Group by using a JSON formatted input file.
Related Links
Top

Create a new Logical Switch resource.
SYNTAX
New-HPOVLogicalSwitch[ [-Name] <String>] [-LogicalSwitchGroup] <Object> [-Managed] <SwitchParameter> [-Switch1Ad
dress] <String> [-SshUserName] <String> [-SshPassword] <Object> [-SnmpCommunity] <String>[ [-Switch2Address] <St
ring>][ [-SnmpPort] <int>] [-SnmpV1] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Obj
New-HPOVLogicalSwitch[ [-Name] <String>] [-LogicalSwitchGroup] <Object> [-Monitored] <SwitchParameter> [-Switch1

Address] <String> [-SshUserName] <String> [-SshPassword] <Object>[ [-Switch2Address] <String>][ [-SnmpPort] <int
>] [-SnmpV3] <SwitchParameter> [-SnmpUserName] <String> [-SnmpAuthLevel] <String> [-SnmpAuthProtocol] <String> [
-SnmpAuthPassword] <Object> [-SnmpPrivProtocol] <String> [-SnmpPrivPassword] <Object>[ [-Async] <SwitchParameter
>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

dress] <String> [-SshUserName] <String> [-SshPassword] <Object>[ [-Switch2Address] <String>][ [-SnmpPort] <int>]
[-SnmpV3] <SwitchParameter> [-SnmpUserName] <String> [-SnmpAuthLevel] <String> [-SnmpAuthProtocol] <String> [-Sn
mpAuthPassword] <Object> [-SnmpPrivProtocol] <String> [-SnmpPrivPassword] <Object>[ [-Async] <SwitchParameter>][
[-ApplianceConnection] <Object>] [<CommonParameters>]

Address] <String> [-SshUserName] <String> [-SshPassword] <Object> [-SnmpCommunity] <String>[ [-Switch2Address] <
String>][ [-SnmpPort] <int>] [-SnmpV1] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <O
bject>] [<CommonParameters>]
A logical switch is added into HPE OneView as a managed or monitored logical switch. The logical switch can consist of a
maximum of two physical top-of-rack switches (external to the c7000 enclosure) configured in a single stacking domain. It is
based on a logical switch group configuration. If the logical switch transitions to an Inconsistent with group state (because of
changes in either the logical switch or the logical switch group), update the logical switch configuration based on the logical
switch group to return to a consistent state. You can create a logical switch with a maximum of two Cisco Nexus switches. When
there are two Cisco Nexus switches in a logical switch, they are expected to be in a virtual port channel (vPC) environment. vPC
must be configured on both switches, and they should belong to the same vPC domain. For information about supported
switches, see the Hewlett Packard Enterprise Information Library for supportability information. Before you add a logical switch
as managed, consider the following for Fabric Extender and Virtual Connect interconnects physically connected to the logical
switch:
When only IPv4 Ethernet networks are assigned to an uplink set at creation time, the uplink set can be physically
connected to any upstream switch in the logical switch.
When an FCoE network is assigned to an uplink set at creation time, the uplink set is limited to single-homed physical
connectivity and all uplink ports must connect to the same upstream switch in the logical switch. If a port is subsequently
added to the uplink set with an FCoE network or an existing port in the uplink set is connected to a second upstream switch,
that port is not available for configuration and an alert is generated. If a new port added to the uplink set is connected to
the same switch as the other ports, that port is available to carry traffic and an alert is not generated. To change an uplink
set from single-homed connectivity to multi-homed connectivity or vice-versa, the uplink set configuration must be deleted
and re-created with the appropriate network assignments and physical configuration.
Make sure that LLDP is enabled on the top-of-rack switch internal (downlink) ports where Virtual Connect interconnects
under HPE OneView management are connected. Adding a logical switch as monitored enables HPE OneView to monitor
the logical switch for operation status, collect statistics, and alert users to specific conditions and incompatibilities between
the switch and Fabric Extender or Virtual Connect interconnect. In the monitored mode, deployment of the server profile
connections is supported for HPE Virtual Connect interconnects but not for Fabric Extender (FEX) interconnects. Logical
switch configuration guidelines
When Virtual Connect interconnects are connected to a logical switch, an uplink set cannot span multiple interconnects.
This limitation is similar to FEX interconnects. However, multiple uplink sets are supported on a single Virtual Connect
interconnect.
When you enable or disable a top-of-rack switch internal port, the associated port on a FEX interconnect also displays the
updated port status.
When retrieving MAC addresses for FEX interconnects, only the entries that are associated with the managed FEX
interconnects are displayed.
If an FCoE network is assigned to an uplink set that is configured as dual-homed, (an invalid configuration), that FCoE
network is not provisioned on the switch. Deployment of any server profile connection with this FCoE network will fail.
When a logical switch is defined and configured with only a single physical switch, the uplink set associated with any FEX
module connected to this logical switch is considered single-homed. Therefore, you can add an FCoE network to the uplink
set even if the uplink set was initially created only with Ethernet networks. Deployment of any server profile connection with
this FCoE network will succeed.
For server profiles created for server ports connected to FEX interconnects, Ethernet networks are only supported on
physical function a, and FCoE networks are only supported on physical function b at the server port. When both physical
functions have connections defined, traffic is split evenly across both ports.
If HPE OneView cannot log in to the switch, a critical alert is generated. Prevent any event on the switch that might trigger
switch configuration; otherwise, the switch transitions to ConfigError state and you must reapply the configuration on the
associated logical interconnects to recover.
If HPE OneView is unable to claim a member switch of the logical switch when the operational mode of the logical switch is
Managed, the operating state of the switch will transition to Added with Error. In this case, the Message of the Day (MOTD)
banner on the switch will indicate that the switch is currently claimed by another HPE OneView appliance and the message
"This switch is being controlled by OneView Domain, Appliance ID: {}" displays. You should remove the logical switch from
that HPE OneView appliance, and then perform a refresh on the logical switch from the current HPE OneView appliance to
re-initiate the claim operation.
HPE OneView does not fully automate configuration of FCoE connectivity on the switch specified in the logical switch. For
each FCoE network specified in the uplink set, HPE OneView only provisions the VLAN for that network on the switch.
Network administrators must provision additional configuration for FCoE connectivity manually on the switch in addition to
what HPE OneView provisions.
To deploy server profile connections to a FEX interconnect, HPE OneView provisions the virtual Fibre Channel
interface (VFC), VFC binding to FEX downlink port, and VSAN interface assignment on the switch.
For the deployment of server profile connections for a Virtual Connect interconnect, the Network administrator must
configure the virtual Fibre Channel interface (vFC), VFC binding to server port, and VSAN interface assignment
binding manually.
When a Nexus switch expansion module is removed, a warning alert is generated unless the module is powered off.
HPE OneView can detect configuration changes that occur on the switches specified in the logical switch when it no longer
matches the configuration that HPE OneView provisions. Warning alerts are generated. Administrators can correct the
configuration manually or reapply the configuration on the associated logical interconnects to recover. Required privileges:
Infrastructure administrator or Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-LogicalSwitchGroup <Object>
Provide the Logical Switch Group policy object.
Aliases None
Required? true
Position? named
Default value
Specify if the Logical Switch will be a Managed resource.
Aliases None
Required? true
Position? named
Default value
Specify if the Logical Switch will be a Monintored resource.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases None
Required? false
Position? named
Default value
Defines the security levels supported by SNMPv3:
Auth - Communication with authorization and without privacy. Messages are authenticated but not encrypted.
AuthAndPrive - Communication with authorization as well as privacy. Messages are authenticated as well as encrypted.
Aliases None
Required? true
Position? named
Default value
SNMPv3 Authorization Password. Either [System.String] or [SecureString] values are supported.

Aliases None
Required? true
Position? named
Default value
The protocol used for Authentication are either MD5 (Message Digest 5) or SHA (Secure Hash Algorithm).
Aliases None
Required? true
Position? named
Default value
-SnmpCommunity <String>
Specify the SNMPv1 Community name. This parameter is not used if needing to configure SNMPv3.
Aliases None
Required? true
Position? named
Default value
-SnmpPort <int>
The UDP port SNMP is configured to listen on the target Switch resource.
Aliases None
Required? false
Position? named
Default value 161
SNMPv3 Privacy Password. Either [System.String] or [SecureString] values are supported.
Aliases None
Required? true
Position? named
Default value
The protocols used to encrypt the messages are Data Encryption Standard (DES56) or Advanced Encryption Standard
(AES128).
Aliases None
Required? true
Position? named
Default value
Specify the SNMPv3 Username.
Aliases None
Required? true
Position? named
Default value
Specify if SNMPv1 is available. Otherwise, use the -SNMPv3 switch parameter.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value

-SshPassword <Object>
Password of the SSH User. Either [System.String] or [SecureString] values are supported.
Aliases None
Required? true
Position? named
Default value
-SshUserName <String>
The SSH account name.
Aliases None
Required? true
Position? named
Default value
-Switch1Address <String>
IP Address or FQDN of first Switch resource.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Logical Switch Group resource.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$LogicalSwitchGroup = Get-HPOVLogicalSwitchGroup -Name "My Nexus 5500 Switch Group Policy"

$SshPassword = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force
New-HPOVLogicalSwitch -Name "My Logical Switch 1" -LogicalSwitchGroup $LogicalSwitchGroup -Monitored -Switch1Add
ress 10.1.1.1 -Switch2Address 10.1.1.2 -SshUserName admin -SshPassword $SshPassword -Snmpv1 -SnmpCommunity MyCom
munity
Create the "My Logical Switch 1" as a Monitored Logical Switch resource.
-------------------------- EXAMPLE 2 --------------------------

$Password = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force
$Results = New-HPOVLogicalSwitch -Name "My Logical Switch 2" -LogicalSwitchGroup $LogicalSwitchGroup -Managed -S
witch1Address 10.1.2.1 -Switch2Address 10.1.2.2 -SshUserName admin-SshPassword $Password -Snmpv3 -SnmpUserName S
nmpV3User -SnmpAuthLevel AuthAndPriv -SnmpAuthProtocol SHA -SnmpAuthPassword $Password -SnmpPrivProtocol aes128
-SnmpPrivPassword $Password -Async
Create the "My Logical Switch 2" as a Managed Logical Switch resource. ### Related Links * [Get-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalSwitch) * [Get-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalSwitchGroup) * [New-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitchGroup) * [Remove-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitch) * [Remove-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitchGroup) * [Update-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVLogicalSwitch) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLogicalSwitch
Create a new Logical Switch resource. ### SYNTAX

dress] <String> [-SshUserName] <String> [-SshPassword] <Object> [-SnmpCommunity] <String>[ [-Switch2Address] <St
ring>][ [-SnmpPort] <int>] [-SnmpV1] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Obj

Address] <String> [-SshUserName] <String> [-SshPassword] <Object>[ [-Switch2Address] <String>][ [-SnmpPort] <int
>] [-SnmpV3] <SwitchParameter> [-SnmpUserName] <String> [-SnmpAuthLevel] <String> [-SnmpAuthProtocol] <String> [
-SnmpAuthPassword] <Object> [-SnmpPrivProtocol] <String> [-SnmpPrivPassword] <Object>[ [-Async] <SwitchParameter
dress] <String> [-SshUserName] <String> [-SshPassword] <Object>[ [-Switch2Address] <String>][ [-SnmpPort] <int>]
[-SnmpV3] <SwitchParameter> [-SnmpUserName] <String> [-SnmpAuthLevel] <String> [-SnmpAuthProtocol] <String> [-Sn
mpAuthPassword] <Object> [-SnmpPrivProtocol] <String> [-SnmpPrivPassword] <Object>[ [-Async] <SwitchParameter>][

Address] <String> [-SshUserName] <String> [-SshPassword] <Object> [-SnmpCommunity] <String>[ [-Switch2Address] <
String>][ [-SnmpPort] <int>] [-SnmpV1] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <O
bject>] [<CommonParameters>]
A logical switch is added into HPE OneView as a managed or monitored logical switch. The logical switch can consist of a
maximum of two physical top-of-rack switches (external to the c7000 enclosure) configured in a single stacking domain. It is
based on a logical switch group configuration. If the logical switch transitions to an Inconsistent with group state (because of
changes in either the logical switch or the logical switch group), update the logical switch configuration based on the logical
switch group to return to a consistent state. You can create a logical switch with a maximum of two Cisco Nexus switches. When
there are two Cisco Nexus switches in a logical switch, they are expected to be in a virtual port channel (vPC) environment. vPC
must be configured on both switches, and they should belong to the same vPC domain. For information about supported
switches, see the Hewlett Packard Enterprise Information Library for supportability information. Before you add a logical switch
as managed, consider the following for Fabric Extender and Virtual Connect interconnects physically connected to the logical
switch:
When only IPv4 Ethernet networks are assigned to an uplink set at creation time, the uplink set can be physically
connected to any upstream switch in the logical switch.
When an FCoE network is assigned to an uplink set at creation time, the uplink set is limited to single-homed physical
connectivity and all uplink ports must connect to the same upstream switch in the logical switch. If a port is subsequently
added to the uplink set with an FCoE network or an existing port in the uplink set is connected to a second upstream switch,
that port is not available for configuration and an alert is generated. If a new port added to the uplink set is connected to
the same switch as the other ports, that port is available to carry traffic and an alert is not generated. To change an uplink
set from single-homed connectivity to multi-homed connectivity or vice-versa, the uplink set configuration must be deleted
and re-created with the appropriate network assignments and physical configuration.
Make sure that LLDP is enabled on the top-of-rack switch internal (downlink) ports where Virtual Connect interconnects
under HPE OneView management are connected. Adding a logical switch as monitored enables HPE OneView to monitor
the logical switch for operation status, collect statistics, and alert users to specific conditions and incompatibilities between
the switch and Fabric Extender or Virtual Connect interconnect. In the monitored mode, deployment of the server profile
connections is supported for HPE Virtual Connect interconnects but not for Fabric Extender (FEX) interconnects. Logical
switch configuration guidelines
When Virtual Connect interconnects are connected to a logical switch, an uplink set cannot span multiple interconnects.
This limitation is similar to FEX interconnects. However, multiple uplink sets are supported on a single Virtual Connect
interconnect.
When you enable or disable a top-of-rack switch internal port, the associated port on a FEX interconnect also displays the
updated port status.
When retrieving MAC addresses for FEX interconnects, only the entries that are associated with the managed FEX
interconnects are displayed.
If an FCoE network is assigned to an uplink set that is configured as dual-homed, (an invalid configuration), that FCoE
network is not provisioned on the switch. Deployment of any server profile connection with this FCoE network will fail.
When a logical switch is defined and configured with only a single physical switch, the uplink set associated with any FEX
module connected to this logical switch is considered single-homed. Therefore, you can add an FCoE network to the uplink
set even if the uplink set was initially created only with Ethernet networks. Deployment of any server profile connection with
this FCoE network will succeed.
For server profiles created for server ports connected to FEX interconnects, Ethernet networks are only supported on
physical function a, and FCoE networks are only supported on physical function b at the server port. When both physical
functions have connections defined, traffic is split evenly across both ports.
If HPE OneView cannot log in to the switch, a critical alert is generated. Prevent any event on the switch that might trigger
switch configuration; otherwise, the switch transitions to ConfigError state and you must reapply the configuration on the
associated logical interconnects to recover.
If HPE OneView is unable to claim a member switch of the logical switch when the operational mode of the logical switch is
Managed, the operating state of the switch will transition to Added with Error. In this case, the Message of the Day (MOTD)
banner on the switch will indicate that the switch is currently claimed by another HPE OneView appliance and the message
"This switch is being controlled by OneView Domain, Appliance ID: {}" displays. You should remove the logical switch from
that HPE OneView appliance, and then perform a refresh on the logical switch from the current HPE OneView appliance to
re-initiate the claim operation.
HPE OneView does not fully automate configuration of FCoE connectivity on the switch specified in the logical switch. For
each FCoE network specified in the uplink set, HPE OneView only provisions the VLAN for that network on the switch.
Network administrators must provision additional configuration for FCoE connectivity manually on the switch in addition to
what HPE OneView provisions.
To deploy server profile connections to a FEX interconnect, HPE OneView provisions the virtual Fibre Channel
interface (VFC), VFC binding to FEX downlink port, and VSAN interface assignment on the switch.
For the deployment of server profile connections for a Virtual Connect interconnect, the Network administrator must
configure the virtual Fibre Channel interface (vFC), VFC binding to server port, and VSAN interface assignment
binding manually.
When a Nexus switch expansion module is removed, a warning alert is generated unless the module is powered off.
HPE OneView can detect configuration changes that occur on the switches specified in the logical switch when it no longer
matches the configuration that HPE OneView provisions. Warning alerts are generated. Administrators can correct the
configuration manually or reapply the configuration on the associated logical interconnects to recover. Required privileges:
Infrastructure administrator or Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value

-LogicalSwitchGroup <Object>
Provide the Logical Switch Group policy object.
Aliases None
Required? true
Position? named
Default value
Specify if the Logical Switch will be a Managed resource.
Aliases None
Required? true
Position? named
Default value
Specify if the Logical Switch will be a Monintored resource.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases None
Required? false
Position? named
Default value
Defines the security levels supported by SNMPv3:

Auth - Communication with authorization and without privacy. Messages are authenticated but not encrypted.
AuthAndPrive - Communication with authorization as well as privacy. Messages are authenticated as well as encrypted.
Aliases None
Required? true
Position? named
Default value
SNMPv3 Authorization Password. Either [System.String] or [SecureString] values are supported.
Aliases None
Required? true
Position? named
Default value
The protocol used for Authentication are either MD5 (Message Digest 5) or SHA (Secure Hash Algorithm).
Aliases None
Required? true
Position? named
Default value
-SnmpCommunity <String>
Specify the SNMPv1 Community name. This parameter is not used if needing to configure SNMPv3.
Aliases None
Required? true
Position? named
Default value
-SnmpPort <int>
The UDP port SNMP is configured to listen on the target Switch resource.
Aliases None
Required? false
Position? named
Default value 161
SNMPv3 Privacy Password. Either [System.String] or [SecureString] values are supported.
Aliases None
Required? true
Position? named
Default value
The protocols used to encrypt the messages are Data Encryption Standard (DES56) or Advanced Encryption Standard
(AES128).
Aliases None
Required? true
Position? named
Default value
Specify the SNMPv3 Username.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-SshPassword <Object>
Password of the SSH User. Either [System.String] or [SecureString] values are supported.
Aliases None
Required? true
Position? named
Default value
-SshUserName <String>
The SSH account name.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

$SshPassword = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force
New-HPOVLogicalSwitch -Name "My Logical Switch 1" -LogicalSwitchGroup $LogicalSwitchGroup -Monitored -Switch1Add
ress 10.1.1.1 -Switch2Address 10.1.1.2 -SshUserName admin -SshPassword $SshPassword -Snmpv1 -SnmpCommunity MyCom
munity
Create the "My Logical Switch 1" as a Monitored Logical Switch resource.
-------------------------- EXAMPLE 2 --------------------------

$Password = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force
$Results = New-HPOVLogicalSwitch -Name "My Logical Switch 2" -LogicalSwitchGroup $LogicalSwitchGroup -Managed -S
witch1Address 10.1.2.1 -Switch2Address 10.1.2.2 -SshUserName admin-SshPassword $Password -Snmpv3 -SnmpUserName S
nmpV3User -SnmpAuthLevel AuthAndPriv -SnmpAuthProtocol SHA -SnmpAuthPassword $Password -SnmpPrivProtocol aes128
-SnmpPrivPassword $Password -Async
Create the "My Logical Switch 2" as a Managed Logical Switch resource.
Related Links
Top

Create a new Logical Switch Group resource.
SYNTAX
New-HPOVLogicalSwitchGroup [-Name] <String>[ [-SwitchType] <SwitchParameter>][ [-NumberOfSwitches] <Int>][ [-App
lianceConnection] <Object>][ [-Async] <SwitchParameter>] [<CommonParameters>]
made visible on the associated logical switch screen in HPE OneView. This Cmdlet will help create a Logical Switch Group
resources. Only the following switch model family"s are supported:
Cisco Nexus 5000
Cisco Nexus 5500
Cisco Nexus 5600
Cisco Nexus 6000 Please refer to either Get-HPOVSwitchType values, or the HPE OneView Support Matrix for which
specific models are supported. Required privileges: Infrastructure administrator or Network administrator
Parameters

Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Name <String>
The Logical Switch Group resource Name.
Aliases None
Required? true
Position? named
Default value
-NumberOfSwitches <Int>
The maximum number of switches supported in the Logical Switch Group. Only 1 or 2 are allowed.
Aliases None
Required? false
Position? named
Default value 1
-SwitchType <SwitchParameter>
The Switch Type resource from Get-HPOVSwitchType.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Switch Type resource from Get-HPOVSwitchType.
Return Values
Collection of remove Logical Switch async task resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSwitchType -Name "Cisco Nexus 56xx" | New-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1
" -NumberOfSwitches 2
Create a Logical Switch Group fro the "Cisco Nexus 5600" series, specifying 2 expected switches. ### Related Links * [Get-
HPOVLogicalSwitchGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalSwitchGroup) * [Remove-
HPOVLogicalSwitchGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitchGroup) ***
Top
### HPE OneView 4.00 Library ## New-HPOVLogicalSwitchGroup
Create a new Logical Switch Group resource. ### SYNTAX
New-HPOVLogicalSwitchGroup [-Name] <String>[ [-SwitchType] <SwitchParameter>][ [-NumberOfSwitches] <Int>][ [-App

lianceConnection] <Object>][ [-Async] <SwitchParameter>] [<CommonParameters>]
made visible on the associated logical switch screen in HPE OneView. This Cmdlet will help create a Logical Switch Group
resources. Only the following switch model family's are supported:
Cisco Nexus 5000
Cisco Nexus 5500
Cisco Nexus 5600
Cisco Nexus 6000 Please refer to either Get-HPOVSwitchType values, or the HPE OneView Support Matrix for which
specific models are supported. Required privileges: Infrastructure administrator or Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Name <String>
The Logical Switch Group resource Name.
Aliases None
Required? true
Position? named
Default value
-NumberOfSwitches <Int>
The maximum number of switches supported in the Logical Switch Group. Only 1 or 2 are allowed.
Aliases None
Required? false
Position? named
Default value 1

-SwitchType <SwitchParameter>
The Switch Type resource from Get-HPOVSwitchType.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Switch Type resource from Get-HPOVSwitchType.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSwitchType -Name "Cisco Nexus 56xx" | New-HPOVLogicalSwitchGroup -Name 'My Logical Switch Group Policy 1
' -NumberOfSwitches 2
Create a Logical Switch Group fro the "Cisco Nexus 5600" series, specifying 2 expected switches.
Related Links
Top
New-HPOVNetwork

New-HPOVNetwork
Creates one or more new Ethernet or Fibre-Channel networks on the appliance.
SYNTAX
New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32> [-Subnet] <Object> [-VLANType] <String> [-Pu
rpose] <String> [-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidt
h] <Int32>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection]
New-HPOVNetwork [-Name] <String> [-VlanRange] <String> [-Type] <String> [-VLANType] <String> [-Purpose] <String>
[-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32>[ [-Sc
ope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Com
monParameters>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32> [-TypicalBandwidth] <Int32> [-MaximumBandwid
th] <Int32> [-ManagedSan] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>]
[ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-Link
StabilityTime] <Int32> [-AutoLoginRedistribution] <Boolean> [-FabricType] <String> [-ManagedSan] <Object>[ [-Sco
pe] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Comm
onParameters>]
New-HPOVNetwork [-ImportFile] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParamet

er>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Create a new network resource, including its default connection type. Network definitions can be supplied as direct CmdLet
parameters or as input from a file containing the network definition in JSON format.
To create an Ethernet Network for Image Streamer, use the following paramters:
* Name
* VlanType = Untagged
* IPv4Subnet Object
* Purpose = Management
Parameters
Aliases Appliance
Required? false
Position? named

Aliases None
Required? false
Position? named
Default value
-AutoLoginRedistribution <Boolean>
Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that
was down becomes available).
True: Login redistribution is initiated automatically when the link stability time expires. False: Login redistribution must be
initiated manually.
This parameter is not applicable for Direct Attach Fabric Types.
Aliases None
Required? true
Position? named
Default value False
-FabricType <String>
Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach
Aliases None
Required? true
Position? named
Default value FabricAttach
Full path and file name of a JSON formatted input file containing network definitions.
Aliases i, import
Required? true
Position? named
Default value

-LinkStabilityTime <Int32>
The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This
interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly).
Aliases None
Required? true
Position? named
Default value 30
Managed SAN Object or Name.
Aliases None
Required? true
Position? named
Default value
-MaximumBandwidth <Int32>
Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.
Aliases None
Required? true
Position? named
Default value 20000
-Name <String>
Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will
become the Nework Name Prefix (i.e. "VLAN" will become "VLAN-[vlanid]".)
Aliases None
Required? true
Position? named
Default value
-PrivateNetwork <Boolean>
Default value is FALSE.

Aliases None
Required? true
Position? named
Default value False
-Purpose <String>
A description of the network"s role within the logical interconnect. Accepted values in string format are:
* General
* Management
* VMMigration
* FaultTolerance
* iSCSI
Aliases None
Required? true
Position? named
Default value General
Aliases None
Required? False
Position? named
Default value False
-SmartLink <Boolean>
Default value is TRUE.
Aliases None
Required? true
Position? named
Default value True
-Subnet <Object>
An IPv4 Subnet Object that will be associated with a specific Ethernet Network and VLAN.
Aliases None
Required? true
Position? named
Default value
-Type <String>
Required value that specifies the type of Network Resource to create. Allowed values are:
* Ethernet
* FC
* FibreChannel
* FCoE
Aliases None
Required? true
Position? named
Default value Ethernet
-TypicalBandwidth <Int32>
Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.
Aliases None
Required? true
Position? named
Default value 2500
-VLANType <String>
The type of VLAN configuration for the Ethernet Network. This setting is only applicable for the Uplink Set configuration, and not
the Network Set it could be assigned to. Accepted values are
* Tagged
* Tunnel
* Access
Default value is Tagged.
Aliases None
Required? true
Position? named
Default value Tagged
-VlanId <Int32>
The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique. The VLAN ID cannot be
changed once the network has been created.
When creating an Ethernet Network on an HPE Synergy Composer, Vlan ID 1 is not a valid ID. The allowed range is 2-4095.
Aliases None
Required? true
Position? named
Default value 0
-VlanRange <String>
VLAN Range of networks to create. Can be consecutive, non-consecutive or a combination of both.
e.g. -VLANRange "10-90,94,96,200-210"
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
ManagedSan resource object to be assigned to a FC or FCoE Network
Return Values
A custom status object or array of objects containing the following PsCustomObject keys:
Name - name of the network object attempted to be created * Status - status of the creation attempt (Failed for http error
return; Complete if a task object is returned)
Description - Task object or Error object * Exception - System.Management.Automation.ErrorRecord object of the error
generated
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500
Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, and specifies preferred bandwidth to 5Gb/s and
max to 7.5Gb/s. Network will be created on all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500 -Appli
ance MyAppliance
Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and
max to 7.5Gb/s to be created on "MyAppliance"
-------------------------- EXAMPLE 3 --------------------------
$Connection1 = Connect-HPOVMgmt MyAppliance1.domain.local Administrator MyPassword

ance $Connection1,$Connection2
max to 7.5Gb/s to be created on "MyAppliance1" and "MyAppliance2" using the connection objects.
-------------------------- EXAMPLE 4 --------------------------
10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_" -vlanid $_ }
Create multiple Ethernet Networks.

-------------------------- EXAMPLE 5 --------------------------
10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-A" -vlanid $_ }

10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-B" -vlanid $_ }
Create Ethernet Networks for an Active/Active configuration.

-------------------------- EXAMPLE 6 --------------------------
New-HPOVNetwork -name "VLAN A Side" -vlanRange "10,20,30,40,50,60"

New-HPOVNetwork -name "VLAN B Side" -VlanRange "10,20,30,40,50,60"
Create Ethernet Networks for an Active/Active configuration using the -VlanRange parameter.
-------------------------- EXAMPLE 7 --------------------------
New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000
Creates a new FC network type, called "Fabric A" and preferred bandwidth is 2Gb/s and max is 4Gb/s.
-------------------------- EXAMPLE 8 --------------------------
New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000 -fabricType FabricAttach
-managedSAN Fabric_A
Creates a new FC network type, called "Fabric A", preferred bandwidth is 2Gb/s and max is 4Gb/s, and is associated with a
Managed SAN Fabric.
-------------------------- EXAMPLE 9 --------------------------
New-HPOVNetwork -importFile "c:\OneViewInput\myNewNets.json"
Creates the network(s) defined in the input file myNewNets.json ### Related Links * [Get-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVNetwork) * [Get-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVNetworkSet) * [New-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetworkSet) * [Remove-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetwork) * [Remove-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetworkSet) * [Set-HPOVNetwork]
Top
### HPE OneView 4.00 Library ## New-HPOVNetwork
Creates one or more new Ethernet or Fibre-Channel networks on the appliance. ### SYNTAX
New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32> [-Subnet] <Object> [-VLANType] <String> [-Pu
rpose] <String> [-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidt
h] <Int32>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection]
New-HPOVNetwork [-Name] <String> [-VlanRange] <String> [-Type] <String> [-VLANType] <String> [-Purpose] <String>
[-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32>[ [-Sc
ope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Com
monParameters>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32> [-TypicalBandwidth] <Int32> [-MaximumBandwid
th] <Int32> [-ManagedSan] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-Link
StabilityTime] <Int32> [-AutoLoginRedistribution] <Boolean> [-FabricType] <String> [-ManagedSan] <Object>[ [-Sco
pe] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Comm
onParameters>]
New-HPOVNetwork [-ImportFile] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParamet

er>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Create a new network resource, including its default connection type. Network definitions can be supplied as direct CmdLet
parameters or as input from a file containing the network definition in JSON format.
To create an Ethernet Network for Image Streamer, use the following paramters:
* Name
* VlanType = Untagged
* IPv4Subnet Object
* Purpose = Management
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that
was down becomes available).
initiated manually.
This parameter is not applicable for Direct Attach Fabric Types.
Aliases None
Required? true
Position? named
Default value False
-FabricType <String>
Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach
Aliases None
Required? true
Position? named
Default value FabricAttach
Full path and file name of a JSON formatted input file containing network definitions.
Aliases i, import
Required? true
Position? named
Default value
The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This
interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly).
Aliases None
Required? true
Position? named
Default value 30
Managed SAN Object or Name.
Aliases None
Required? true
Position? named
Default value
Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.
Aliases None
Required? true
Position? named
Default value 20000
-Name <String>
Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will
become the Nework Name Prefix (i.e. 'VLAN' will become 'VLAN-[vlanid]'.)
Aliases None
Required? true
Position? named
Default value
Default value is FALSE.
Aliases None
Required? true
Position? named
Default value False
-Purpose <String>
A description of the network's role within the logical interconnect. Accepted values in string format are:
* General
* Management
* VMMigration
* FaultTolerance
* iSCSI
Aliases None
Required? true
Position? named
Default value General
Aliases None
Required? False
Position? named
Default value False
-SmartLink <Boolean>
Default value is TRUE.
Aliases None
Required? true
Position? named
Default value True
-Subnet <Object>
An IPv4 Subnet Object that will be associated with a specific Ethernet Network and VLAN.
Aliases None
Required? true
Position? named
Default value
-Type <String>
Required value that specifies the type of Network Resource to create. Allowed values are:
* Ethernet
* FC
* FibreChannel
* FCoE
Aliases None
Required? true
Position? named
Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.
Aliases None
Required? true
Position? named
Default value 2500
-VLANType <String>
The type of VLAN configuration for the Ethernet Network. This setting is only applicable for the Uplink Set configuration, and not
the Network Set it could be assigned to. Accepted values are
* Tagged
* Tunnel
* Access
Default value is Tagged.
Aliases None
Required? true
Position? named
Default value Tagged
-VlanId <Int32>
The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique. The VLAN ID cannot be
changed once the network has been created.
When creating an Ethernet Network on an HPE Synergy Composer, Vlan ID 1 is not a valid ID. The allowed range is 2-4095.
Aliases None
Required? true
Position? named
Default value 0
-VlanRange <String>
VLAN Range of networks to create. Can be consecutive, non-consecutive or a combination of both.
e.g. -VLANRange "10-90,94,96,200-210"
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
ManagedSan resource object to be assigned to a FC or FCoE Network
Return Values
A custom status object or array of objects containing the following PsCustomObject keys:
Name - name of the network object attempted to be created * Status - status of the creation attempt (Failed for http error
return; Complete if a task object is returned)
Description - Task object or Error object * Exception - System.Management.Automation.ErrorRecord object of the error
generated
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500
Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, and specifies preferred bandwidth to 5Gb/s and
max to 7.5Gb/s. Network will be created on all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
ance MyAppliance
max to 7.5Gb/s to be created on 'MyAppliance'
-------------------------- EXAMPLE 3 --------------------------

ance $Connection1,$Connection2
Creates new Ethernet Network type, with 'MyNetwork1' name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and max
to 7.5Gb/s to be created on 'MyAppliance1' and 'MyAppliance2' using the connection objects.
-------------------------- EXAMPLE 4 --------------------------
10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $" -vlanid $ }
Create multiple Ethernet Networks.
-------------------------- EXAMPLE 5 --------------------------
10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $-A" -vlanid $ }

10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $-B" -vlanid $ }
Create Ethernet Networks for an Active/Active configuration.

-------------------------- EXAMPLE 6 --------------------------
New-HPOVNetwork -name "VLAN A Side" -vlanRange "10,20,30,40,50,60"

New-HPOVNetwork -name "VLAN B Side" -VlanRange "10,20,30,40,50,60"
Create Ethernet Networks for an Active/Active configuration using the -VlanRange parameter.
-------------------------- EXAMPLE 7 --------------------------
New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000
Creates a new FC network type, called 'Fabric A' and preferred bandwidth is 2Gb/s and max is 4Gb/s.
-------------------------- EXAMPLE 8 --------------------------
New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000 -fabricType FabricAttach
-managedSAN Fabric_A
Creates a new FC network type, called 'Fabric A', preferred bandwidth is 2Gb/s and max is 4Gb/s, and is associated with a
Managed SAN Fabric.
-------------------------- EXAMPLE 9 --------------------------
New-HPOVNetwork -importFile "c:\OneViewInput\myNewNets.json"
Creates the network(s) defined in the input file myNewNets.json
Related Links
Get-HPOVNetwork
Get-HPOVNetworkSet
New-HPOVNetworkSet
Remove-HPOVNetwork
Set-HPOVNetwork
Set-HPOVNetworkSet
Top
New-HPOVNetworkSet


New-HPOVNetworkSet
Create a new Network Set.
SYNTAX
New-HPOVNetworkSet [-Name] <String> [-Networks] <Object> [-UntaggedNetwork] <Object> [-TypicalBandwidth] <Int32>
[-MaximumBandwidth] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]
Create a new Network Set and connection type resource.
Parameters
Aliases Appliance
Required? true
Position? 5
Optional maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.
Aliases None
Required? true
Position? 4
Default value 10000
-Name <String>
The name of the new Network Set resource to be created.
Aliases None
Required? true
Position? 0
Default value
-Networks <Object>
Aliases [-networkUris] Ethernet Network Name(s), URI(")s or Resource Object(s).
Aliases networkUris
Required? true
Position? 1
Default value
Optional preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.
Aliases None
Required? true
Position? 3
Default value 2500
-UntaggedNetwork <Object>
Aliases [-untagged, -native, -untaggedNetworkUri] Network (from the above list) to be considered the "native" network in this set.
Traffic on this network will leave the Virtual Connect downlink port untagged. When untagged traffic is received on this port, it
will be mapped to this network.
Aliases untagged, native, untaggedNetworkUri
Required? true
Position? 2
Default value
<CommonParameters>
Input Types
Return Values
If bandwidth settings are specified, the newly created Network Set resource is returned
If no bandwidth settings specified, an async task object is returned

Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVNetworkSet -name "Production Networks" -untaggedNetwork yellow -networks blue, green, yellow
Create a new Network Set called "Production Networks", adding Ethernet Networks "blue", "green", and "yellow", on all
connected appliances.
-------------------------- EXAMPLE 2 --------------------------
$networks = "blue","green","yellow" | % { Get-HPOVNetwork $_ -type Ethernet }

New-HPOVNetworkSet -name "Production Networks" -Networks $networks -UntaggedNetwork $networks[1]
Get Ethernet Networks "blue", "green", and "yellow", then create a new Network Set, with "Green" as the UntaggedNetowrk for
the specified appliance connection.
-------------------------- EXAMPLE 3 --------------------------
New-HPOVNetworkSet -name "Production Networks" -untaggedNetwork yellow -networks blue, green, yellow -TypicalBan
dwidth 1000 -MaximumBandwidth 5000
Create a new Network Set called "Production Networks", adding Ethernet Networks "blue", "green", and "yellow", setting the
Typical and Maximum Bandwidth. ### Related Links * [Get-HPOVNetworkSet](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVNetworkSet) * [Remove-HPOVNetworkSet](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVNetworkSet) * [Set-HPOVNetworkSet](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVNetworkSet) ***
Top
### HPE OneView 4.00 Library ## New-HPOVNetworkSet
Create a new Network Set. ### SYNTAX
New-HPOVNetworkSet [-Name] <String> [-Networks] <Object> [-UntaggedNetwork] <Object> [-TypicalBandwidth] <Int32>

[-MaximumBandwidth] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]
Create a new Network Set and connection type resource.
Parameters
Aliases Appliance
Required? true
Position? 5
Optional maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.
Aliases None
Required? true
Position? 4
Default value 10000
-Name <String>
The name of the new Network Set resource to be created.
Aliases None
Required? true
Position? 0
Default value
-Networks <Object>
Aliases [-networkUris] Ethernet Network Name(s), URI(')s or Resource Object(s).
Aliases networkUris
Required? true
Position? 1
Default value
Optional preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.
Aliases None
Required? true
Position? 3
Default value 2500
Aliases [-untagged, -native, -untaggedNetworkUri] Network (from the above list) to be considered the "native" network in this set.
Traffic on this network will leave the Virtual Connect downlink port untagged. When untagged traffic is received on this port, it
will be mapped to this network.
Required? true
Position? 2
Default value
<CommonParameters>
Input Types
Return Values
If bandwidth settings are specified, the newly created Network Set resource is returned
If no bandwidth settings specified, an async task object is returned
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVNetworkSet -name "Production Networks" -untaggedNetwork yellow -networks blue, green, yellow
Create a new Network Set called "Production Networks", adding Ethernet Networks 'blue', 'green', and 'yellow', on all connected
appliances.
-------------------------- EXAMPLE 2 --------------------------
$networks = 'blue','green','yellow' | % { Get-HPOVNetwork $_ -type Ethernet }

New-HPOVNetworkSet -name "Production Networks" -Networks $networks -UntaggedNetwork $networks[1]
Get Ethernet Networks 'blue', 'green', and 'yellow', then create a new Network Set, with 'Green' as the UntaggedNetowrk for the
specified appliance connection.
-------------------------- EXAMPLE 3 --------------------------
New-HPOVNetworkSet -name "Production Networks" -untaggedNetwork yellow -networks blue, green, yellow -TypicalBan
dwidth 1000 -MaximumBandwidth 5000
Create a new Network Set called "Production Networks", adding Ethernet Networks 'blue', 'green', and 'yellow', setting the
Typical and Maximum Bandwidth.
Related Links
Get-HPOVNetworkSet
Set-HPOVNetworkSet
Top

Create a new HPE Synergy OS Deployment Server.
SYNTAX
New-HPOVOSDeploymentServer [-Name] <String> [-InputObject] <Object> [-ManagementNetwork] <Object>[ [-Description
] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
An OS deployment server is a resource that enables you to deploy (install and configure) operating systems for use by servers.
HPE OneView connects to an OS deployment server and configures it for deploying operating systems. HPE OneView manages
the OS deployment server after it is configured and displays the list of attributes, management settings, the OS deployment
plans, and the server profiles that reference the available OS deployment plans.
To create an OS Deployment Server, HPE Synergy Image Streamer appliances must be installed into managed or monitored
Synergy Frames, a Management Network created with an association to an IPv4 Address Pool Subnet, and available IP
Addresses within the pool.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
Description of the OS Deployment Server resource.
Aliases None
Required? false
Position? named
Default value
HPE Synergy Image Streamer appliance. Can be any Image Streamer resource object from Get-HPOVImageStreamerAppliance.
Aliases ImageStreamer, I3S
Required? true
Position? named
Default value
-ManagementNetwork <Object>
Either a Tagged or Untagged Ethernet Network associated with an IPv4 Address Pool Subnet. Subnet must be in the same IPv4
Address Network ID as the HPE Synergy Composer IPv4 Address(es).
Aliases None
Required? true
Position? named
Default value
-Name <String>
OS Deployment resource name.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPE Synergy Image Streamer Appliance object from Get-HPOVImageStreamerAppliance.
Return Values
Async task Resource object for modifying the Remote Support Collection schedules.
Examples
-------------------------- EXAMPLE 1 --------------------------
$ManagementNetwork = Get-HPOVNetwork -Type Ethernet -Name "Deployment Network"

Get-HPOVImageStreamerAppliance | Select -First 1 | New-HPOVOSDeploymentServer -Name "MY OS Deployment Server" -M
anagementNetwork $ManagementNetwork
Get the Ethernet network resource object, then pass via the pipeline the first HPE Synergy Image Streamer object, and create a
new OS Deployment Server. ### Related Links * [Get-HPOVOSDeploymentServer](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVOSDeploymentServer) * [Remove-HPOVOSDeploymentServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVOSDeploymentServer) ***
Top
### HPE OneView 4.00 Library ## New-HPOVOSDeploymentServer
Create a new HPE Synergy OS Deployment Server. ### SYNTAX
New-HPOVOSDeploymentServer [-Name] <String> [-InputObject] <Object> [-ManagementNetwork] <Object>[ [-Description

] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
An OS deployment server is a resource that enables you to deploy (install and configure) operating systems for use by servers.
HPE OneView connects to an OS deployment server and configures it for deploying operating systems. HPE OneView manages
the OS deployment server after it is configured and displays the list of attributes, management settings, the OS deployment
plans, and the server profiles that reference the available OS deployment plans.
To create an OS Deployment Server, HPE Synergy Image Streamer appliances must be installed into managed or monitored
Synergy Frames, a Management Network created with an association to an IPv4 Address Pool Subnet, and available IP
Addresses within the pool.
Parameters

Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
Description of the OS Deployment Server resource.
Aliases None
Required? false
Position? named
Default value
HPE Synergy Image Streamer appliance. Can be any Image Streamer resource object from Get-HPOVImageStreamerAppliance.
Aliases ImageStreamer, I3S
Required? true
Position? named
Default value
-ManagementNetwork <Object>
Either a Tagged or Untagged Ethernet Network associated with an IPv4 Address Pool Subnet. Subnet must be in the same IPv4
Address Network ID as the HPE Synergy Composer IPv4 Address(es).
Aliases None
Required? true
Position? named
Default value
-Name <String>
OS Deployment resource name.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPE Synergy Image Streamer Appliance object from Get-HPOVImageStreamerAppliance.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$ManagementNetwork = Get-HPOVNetwork -Type Ethernet -Name "Deployment Network"

Get-HPOVImageStreamerAppliance | Select -First 1 | New-HPOVOSDeploymentServer -Name "MY OS Deployment Server" -M
anagementNetwork $ManagementNetwork
Get the Ethernet network resource object, then pass via the pipeline the first HPE Synergy Image Streamer object, and create a
new OS Deployment Server.
Related Links
Top
New-HPOVQosConfig
New-HPOVQosConfig
Create QoS Configuration Object
SYNTAX
New-HPOVQosConfig [-ConfigType] <String> [<CommonParameters>]
New-HPOVQosConfig [-ConfigType] <String> [-UplinkClassificationType] <String> [-DownlinkClassificationType] <Str

ing> [-TrafficClassifiers] <ArrayList> [<CommonParameters>]
This helper CMDLET provides the capability to create a new Logical Interconnect Group or Logical Interconnect QoS
Configuration object. TrafficClassifiers are created using the New-HPOVQosTrafficClass helper CMDLET.
Parameters
-ConfigType <String>
The QOS Configuration Type. Allowed values are:
* Passthrough (Default) - All ingress packets are not classified at egress. FCoE packets having a separate PG (
Priority Group) are processed at ingress. There are no traffic classes, maps, or rules applied. Passthrough mod
e is equivalent to no QoS (QoS disabled).
* CustomNoFCoE - Enables QoS and allows a customized configuration without FCoE. The configuration def
ines one system class (Best Effort). You can configure up to seven additional classes for non-FCoE Ethernet tra
ffic.
* CustomWithFCoE - Enables QoS and allows a customized configuration that includes FCoE class. The confi
guration defines two default system classes, Best Effort and FCoE Lossless. FCoE Lossless class cannot be edite
d by the user and is pre-configured for 50% bandwidth of the port. You can also configure up to six additional
classes for non-FCoE Ethernet traffic.
Aliases None
Required? true
Position? named
Default value Passthrough
-DownlinkClassificationType <String>
Configure the Downlink QOS Marking classification type.
* DOT1P
* DSCP
* DOT1P_AND_DSCP (Default)
Aliases None
Required? true
Position? named
Default value DOT1P_AND_DSCP
-TrafficClassifiers <ArrayList>
A collection of traffic classes created using the New-HPOVQosTrafficClass.
Aliases None
Required? true
Position? named
Default value @()
-UplinkClassificationType <String>
Configure the Uplink QOS Marking classification type.
* DOT1P (Default)
* DSCP
* DOT1P_AND_DSCP
Aliases None
Required? true
Position? named
Default value DOT1P
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.QosConfiguration [System.Management.Automation.PSCustomObject]
QoS Configuration object
Examples
-------------------------- EXAMPLE 1 --------------------------
$QosConfig = New-HPOVQosConfig CustomWithFCoE DSCP DOT1P_AND_DSCP $TrafficClassifiers

t $True -QosConfig $QosConfig
Create a new QOS Configuration object,and use the created object to add to a new Logical Interconnect Group. ### Related
Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVQosConfig
Create QoS Configuration Object ### SYNTAX
New-HPOVQosConfig [-ConfigType] <String> [<CommonParameters>]
New-HPOVQosConfig [-ConfigType] <String> [-UplinkClassificationType] <String> [-DownlinkClassificationType] <Str

ing> [-TrafficClassifiers] <ArrayList> [<CommonParameters>]
This helper CMDLET provides the capability to create a new Logical Interconnect Group or Logical Interconnect QoS
Configuration object. TrafficClassifiers are created using the New-HPOVQosTrafficClass helper CMDLET.
Parameters
-ConfigType <String>
The QOS Configuration Type. Allowed values are:
* Passthrough (Default) - All ingress packets are not classified at egress. FCoE packets having a separate PG (
Priority Group) are processed at ingress. There are no traffic classes, maps, or rules applied. Passthrough mod
e is equivalent to no QoS (QoS disabled).
* CustomNoFCoE - Enables QoS and allows a customized configuration without FCoE. The configuration def
ines one system class (Best Effort). You can configure up to seven additional classes for non-FCoE Ethernet tra
ffic.
* CustomWithFCoE - Enables QoS and allows a customized configuration that includes FCoE class. The confi
guration defines two default system classes, Best Effort and FCoE Lossless. FCoE Lossless class cannot be edite
d by the user and is pre-configured for 50% bandwidth of the port. You can also configure up to six additional
classes for non-FCoE Ethernet traffic.
Aliases None
Required? true
Position? named
Default value Passthrough
-DownlinkClassificationType <String>
Configure the Downlink QOS Marking classification type.
* DOT1P
* DSCP
* DOT1P_AND_DSCP (Default)
Aliases None
Required? true
Position? named
Default value DOT1P_AND_DSCP
-TrafficClassifiers <ArrayList>
A collection of traffic classes created using the New-HPOVQosTrafficClass.
Aliases None
Required? true
Position? named
Default value @()
-UplinkClassificationType <String>
Configure the Uplink QOS Marking classification type.
* DOT1P (Default)
* DSCP
* DOT1P_AND_DSCP
Aliases None
Required? true
Position? named
Default value DOT1P
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.QosConfiguration [System.Management.Automation.PSCustomObject]
QoS Configuration object
Examples
-------------------------- EXAMPLE 1 --------------------------
$QosConfig = New-HPOVQosConfig CustomWithFCoE DSCP DOT1P_AND_DSCP $TrafficClassifiers

Create a new QOS Configuration object,and use the created object to add to a new Logical Interconnect Group.
Related Links
Top
New-HPOVQosTrafficClass

New-HPOVQosTrafficClass
Create QoS Traffic Classifier Object
SYNTAX
New-HPOVQosTrafficClass [-Name] <String> [-MaxBandwidth] <Int32> [-BandwidthShare] <String> [-EgressDot1pValue]
<Int32> [-IngressDot1pClassMapping] <Array> [-IngressDscpClassMapping] <Array>[ [-RealTime] <SwitchParameter>][
[-Enabled] <SwitchParameter>] [<CommonParameters>]
This helper CMDLET provides the capability to create a new QoS Traffic Classifier Object, which can then be added to either a
Logical Interconnect Group, or Logica Interconnect resource.
Only non-FCoE Traffic Classifiers are allowed to be created. When creating the "Best effort" Traffic Classifier, only the
MaxBandwidth parameter is allowed to be modified.
Parameters
-BandwidthShare <String>
Minimum guaranteed bandwidth for the traffic class. The % share and the max share for a real time class must be equal and not
exceed 50%.
Value between 1 and 100
Aliases None
Required? true
Position? named
Default value
-EgressDot1pValue <Int32>
Specifies the dot1p priority value to remark for the egressing packets. This provides flexibility to control priority treatment for
packets at the next hops based on the remarked dot1p value.
Aliases None
Required? true
Position? named
Default value 0
-Enabled <SwitchParameter>
Specify to Enable the traffic class. By default, the class is disabled, even though it is defined.
Aliases None
Required? false
Position? named
Default value False
-IngressDot1pClassMapping <Array>
Specify an array of ingress Dot1p values, and to which traffic class it is currently mapped. Allowed values:
* 0
* 1
* 2
* 3
* 4
* 5
* 5
* 6
* 7
Aliases None
Required? true
Position? named
Default value
-IngressDscpClassMapping <Array>
Specify an array of DSCP class mappings, per RFC 2475. Allowed values:
* DSCP 0, CS0
* DSCP 10, AF11
* DSCP 12, AF12
* DSCP 14, AF13
* DSCP 8, CS1
* DSCP 18, AF21
* DSCP 20, AF22
* DSCP 22, AF23
* DSCP 26, AF31
* DSCP 28, AF32
* DSCP 30, AF33
* DSCP 34, AF41
* DSCP 36, AF42
* DSCP 38, AF43
* DSCP 16, CS2
* DSCP 24, CS3
* DSCP 32, CS4
* DSCP 46, EF
* DSCP 40, CS5
* DSCP 48, CS6
* DSCP 56, CS7
Aliases None
Required? true
Position? named
Default value
-MaxBandwidth <Int32>
Maximum share the traffic class can use when other traffic classes are not using their guaranteed share. The max share and the
% share for a real time class must be equal and not exceed 50%. For other classes, the max share is greater than or equal to
the % share.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases [-ClassName] Name of the QoS Classifier. Value cannot be "FCoE lossless". If value is "Best effort", only the
MaxBandwidth Parameter is allowed to be modified.
Aliases ClassName
Required? true
Position? named
Default value

-RealTime <SwitchParameter>
Specifies whether the traffic class is real time. Only 1 traffic class can be real time. Enabling real time for this class removes the
real time flag for other classes.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.QosTrafficClassifier [System.Management.Automation.PSCustomObject]
QoS Traffic Classifier Object
@{ qosTrafficClass = [PSCustomObject]@{
maxBandwidth = 100;
bandwidthShare = "0";
egressDot1pValue = 0;
realTime = $false;
className = "Class";
enabled = $false;
};
qosClassificationMapping = [PSCustomObject]@{
dot1pClassMapping = @();
dscpClassMapping = @()
Examples
-------------------------- EXAMPLE 1 --------------------------
$Class1 = New-HPOVQosTrafficClass -Name Class1 -MaxBandwidth 50 -BandwidthShare 20 -ExgressDot1pValue 2 -Ingress

Dot1pClassMapping 5,6 -EgressDscpClassMapping "DSCP 0, CS0","DSCP 10, AF11","DSCP 12, AF12","DSCP 14, AF13" -En
abled
Dot1pClassMapping 1 -EgressDscpClassMapping "DSCP 30, AF33","SCP 32, CS4" -Enabled
$TrafficClasses = $Class1,$Class2
Create new traffic class objects "Class1" and "Class2", creating a new collection $TrafficClasses. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVQosTrafficClass
Create QoS Traffic Classifier Object ### SYNTAX
New-HPOVQosTrafficClass [-Name] <String> [-MaxBandwidth] <Int32> [-BandwidthShare] <String> [-EgressDot1pValue]

<Int32> [-IngressDot1pClassMapping] <Array> [-IngressDscpClassMapping] <Array>[ [-RealTime] <SwitchParameter>][
[-Enabled] <SwitchParameter>] [<CommonParameters>]
This helper CMDLET provides the capability to create a new QoS Traffic Classifier Object, which can then be added to either a
Logical Interconnect Group, or Logica Interconnect resource.
Only non-FCoE Traffic Classifiers are allowed to be created. When creating the "Best effort" Traffic Classifier, only the
MaxBandwidth parameter is allowed to be modified.
Parameters
-BandwidthShare <String>
Minimum guaranteed bandwidth for the traffic class. The % share and the max share for a real time class must be equal and not
exceed 50%.
Aliases None
Required? true
Position? named
Default value
-EgressDot1pValue <Int32>
Specifies the dot1p priority value to remark for the egressing packets. This provides flexibility to control priority treatment for
packets at the next hops based on the remarked dot1p value.
Aliases None
Required? true
Position? named
Default value 0

Specify to Enable the traffic class. By default, the class is disabled, even though it is defined.
Aliases None
Required? false
Position? named
Default value False
-IngressDot1pClassMapping <Array>
Specify an array of ingress Dot1p values, and to which traffic class it is currently mapped. Allowed values:
* 0
* 1
* 2
* 3
* 4
* 5
* 5
* 6
* 7
Aliases None
Required? true
Position? named
Default value
-IngressDscpClassMapping <Array>
Specify an array of DSCP class mappings, per RFC 2475. Allowed values:
* DSCP 0, CS0
* DSCP 10, AF11
* DSCP 12, AF12
* DSCP 14, AF13
* DSCP 8, CS1
* DSCP 18, AF21
* DSCP 20, AF22
* DSCP 22, AF23
* DSCP 26, AF31
* DSCP 28, AF32
* DSCP 30, AF33
* DSCP 34, AF41
* DSCP 36, AF42
* DSCP 38, AF43
* DSCP 16, CS2
* DSCP 24, CS3
* DSCP 32, CS4
* DSCP 46, EF
* DSCP 40, CS5
* DSCP 48, CS6
* DSCP 56, CS7
Aliases None
Required? true
Position? named
Default value
-MaxBandwidth <Int32>
Maximum share the traffic class can use when other traffic classes are not using their guaranteed share. The max share and the
% share for a real time class must be equal and not exceed 50%. For other classes, the max share is greater than or equal to
the % share.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases [-ClassName] Name of the QoS Classifier. Value cannot be 'FCoE lossless'. If value is 'Best effort', only the
MaxBandwidth Parameter is allowed to be modified.
Aliases ClassName
Required? true
Position? named
Default value
-RealTime <SwitchParameter>
Specifies whether the traffic class is real time. Only 1 traffic class can be real time. Enabling real time for this class removes the
real time flag for other classes.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.QosTrafficClassifier [System.Management.Automation.PSCustomObject]
QoS Traffic Classifier Object
@{ qosTrafficClass = [PSCustomObject]@{
maxBandwidth = 100;
bandwidthShare = "0";
egressDot1pValue = 0;
realTime = $false;
className = "Class";
enabled = $false;
};
qosClassificationMapping = [PSCustomObject]@{
dot1pClassMapping = @();
dscpClassMapping = @()
Examples
-------------------------- EXAMPLE 1 --------------------------

Dot1pClassMapping 5,6 -EgressDscpClassMapping 'DSCP 0, CS0','DSCP 10, AF11','DSCP 12, AF12','DSCP 14, AF13' -En
abled
Dot1pClassMapping 1 -EgressDscpClassMapping 'DSCP 30, AF33','SCP 32, CS4' -Enabled
$TrafficClasses = $Class1,$Class2
Create new traffic class objects 'Class1' and 'Class2', creating a new collection $TrafficClasses.
Related Links
Top
New-HPOVRack


New-HPOVRack
Create a new facilities Rack.
SYNTAX
New-HPOVRack [-Name] <String>[ [-ThermalLimit] <Int>][ [-SerialNumber] <String>][ [-PartNumber] <String>][ [-Mod
el] <>][ [-Depth] <Int>][ [-Height] <Int>][ [-UHeight] <Int>][ [-Width] <Int>][ [-ApplianceConnection] <Object>]
statistical data and monitors the power and temperature of the racks it manages.
When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance
places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places
them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are
automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack
to place the enclosure in the proper slots.
This Cmdlet will create a new Rack resource.
Parameters
Aliases Appliance
Required? false
Position? named
-Depth <Int>
Rack depth, in millimeters.
Default: 1000
Aliases None
Required? false
Position? named
Default value 1000
-Height <Int>
Height of rack, in millimeters.
Default: 2004
Aliases None
Required? false
Position? named
Default value 2004
-Model <>
Provide the model of the rack to add.
Aliases None
Required? False
Position? named
Default value
-Name <String>
Name of resource.
Aliases None
Required? true
Position? named
Default value
Part number of the rack resource.
Aliases None
Required? false
Position? named
Default value
Serial number of the rack resource.
Aliases None
Required? false
Position? named
Default value
-ThermalLimit <Int>
Thermal limit supported by the rack, in BTU"s.
Aliases None
Required? false
Position? named
Default value
-UHeight <Int>
The rack unit height of the rack.
Default: 40
Aliases None
Required? false
Position? named
Default value 220
-Width <Int>
Width of rack, in millimeters.
Default: 600
Aliases None
Required? false
Position? named
Default value 600
<CommonParameters>
Input Types
Return Values
Newly created rack.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Params = @{
Name = "Rack-230";
ThermalLimit = 10000;
SerialNumber = "AABB1122CCDD";
PartNumber = "AF046A";
Depth = 1075;
Height = 2032;
UHeight = 42;
Width = 600
}
New-HPOVRack @Params
Create new "Rack-230" rack resource. ### Related Links * [Add-HPOVRackManager](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Add-HPOVRackManager) * [Add-HPOVRackToDataCenter](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Add-HPOVRackToDataCenter) * [Get-HPOVRack](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVRack) * [Get-HPOVRackManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVRackManager) * [Get-HPOVRackMember](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVRackMember) * [Remove-HPOVRack](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRack) *
[Remove-HPOVRackManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRackManager) *
[Remove-HPOVRackMember](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRackMember) * [Set-
HPOVRackMemberLocation](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRackMemberLocation) *
[Update-HPOVRackManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVRackManager) ***
Top
### HPE OneView 4.00 Library ## New-HPOVRack
Create a new facilities Rack. ### SYNTAX
New-HPOVRack [-Name] <String>[ [-ThermalLimit] <Int>][ [-SerialNumber] <String>][ [-PartNumber] <String>][ [-Mod
el] <>][ [-Depth] <Int>][ [-Height] <Int>][ [-UHeight] <Int>][ [-Width] <Int>][ [-ApplianceConnection] <Object>]
statistical data and monitors the power and temperature of the racks it manages.
When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance
places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places
them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are
automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack
to place the enclosure in the proper slots.
This Cmdlet will create a new Rack resource.
Parameters
Aliases Appliance
Required? false
Position? named
-Depth <Int>
Rack depth, in millimeters.
Default: 1000
Aliases None
Required? false
Position? named
Default value 1000
-Height <Int>
Height of rack, in millimeters.
Default: 2004
Aliases None
Required? false
Position? named
Default value 2004
-Model <>
Provide the model of the rack to add.
Aliases None
Required? False
Position? named
Default value
-Name <String>
Name of resource.
Aliases None
Required? true
Position? named
Default value
Part number of the rack resource.
Aliases None
Required? false
Position? named
Default value
Serial number of the rack resource.
Aliases None
Required? false
Position? named
Default value
-ThermalLimit <Int>
Thermal limit supported by the rack, in BTU's.
Aliases None
Required? false
Position? named
Default value
-UHeight <Int>
The rack unit height of the rack.
Default: 40
Aliases None
Required? false
Position? named
Default value 220
-Width <Int>
Width of rack, in millimeters.
Default: 600
Aliases None
Required? false
Position? named
Default value 600
<CommonParameters>
Input Types
Return Values
Newly created rack.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Params = @{
Name = 'Rack-230';
ThermalLimit = 10000;
SerialNumber = 'AABB1122CCDD';
PartNumber = 'AF046A';
Depth = 1075;
Height = 2032;
UHeight = 42;
Width = 600
}
New-HPOVRack @Params
Create new 'Rack-230' rack resource.
Related Links
Get-HPOVRack
Get-HPOVRackMember
Remove-HPOVRack
Top

Configure new Remote Support contact.
SYNTAX
New-HPOVRemoteSupportContact [-Firstname] <String> [-Lastname] <String> [-Email] <String> [-PrimaryPhone] <Strin
g>[ [-AlternatePhone] <String>][ [-Language] <String>][ [-Notes] <String>][ [-Default] <SwitchParameter>][ [-App
lianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to create a new Remote Support Contact. The Remote Support Contact is used to identify authorized users HPE
Support can contact for service events. Only a single contact can be defined as the Default. The Default contact cannot be
removed, and at least 1 contact must be configured before attempting to register the appliance with HPE support using the Set-
HPOVRemoteSupport Cmdlet.
Parameters
-AlternatePhone <String>
The contacts alternate phone number.
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-Default <SwitchParameter>
Use to specify if this contact is the Default.
Aliases None
Required? false
Position? named
Default value
-Email <String>
The contacts email address.
Aliases None
Required? true
Position? named
Default value
-Firstname <String>
The contacts first or given name.
Aliases GivenName
Required? true
Position? named
Default value
-Language <String>
The contacts primary spoken language.
Aliases None
Required? false
Position? named
Default value en
-Lastname <String>
The contacts last or sur name.
Aliases Surname
Required? true
Position? named
Default value
-Notes <String>
The contacts special instructions.
Aliases None
Required? false
Position? named
Default value
-PrimaryPhone <String>
The contacts primary phone number.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.RemoteSupport.Contact [System.Management.Automation.PSCustomObject]
The created Remote Support Contact.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVRemoteSupportContact -Firstname Rebert -Lastname Jones -Email robert.jones@domain.local -PrimaryPhone 12

3-111-2222 -AlternatePhone 111-333-4444 -Language en -Default
Configure a new user who is the default contact. ### Related Links * [Get-HPOVRemoteSupportContact]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportContact) * [Remove-
HPOVRemoteSupportContact](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVRemoteSupportContact) ***
Top
### HPE OneView 4.00 Library ## New-HPOVRemoteSupportContact
Configure new Remote Support contact. ### SYNTAX
New-HPOVRemoteSupportContact [-Firstname] <String> [-Lastname] <String> [-Email] <String> [-PrimaryPhone] <Strin

g>[ [-AlternatePhone] <String>][ [-Language] <String>][ [-Notes] <String>][ [-Default] <SwitchParameter>][ [-App
lianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to create a new Remote Support Contact. The Remote Support Contact is used to identify authorized users HPE
Support can contact for service events. Only a single contact can be defined as the Default. The Default contact cannot be
removed, and at least 1 contact must be configured before attempting to register the appliance with HPE support using the Set-
HPOVRemoteSupport Cmdlet.
Parameters
-AlternatePhone <String>
The contacts alternate phone number.
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named
Use to specify if this contact is the Default.
Aliases None
Required? false
Position? named
Default value
-Email <String>
The contacts email address.
Aliases None
Required? true
Position? named
Default value
-Firstname <String>
The contacts first or given name.
Aliases GivenName
Required? true
Position? named
Default value
-Language <String>
The contacts primary spoken language.
Aliases None
Required? false
Position? named
Default value en
-Lastname <String>
The contacts last or sur name.
Aliases Surname
Required? true
Position? named
Default value
-Notes <String>
The contacts special instructions.
Aliases None
Required? false
Position? named
Default value
-PrimaryPhone <String>
The contacts primary phone number.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The created Remote Support Contact.
Examples
-------------------------- EXAMPLE 1 --------------------------

Configure a new user who is the default contact.
Related Links
Top

Retrieve Remote Support Default Site.
SYNTAX
New-HPOVRemoteSupportPartner [-Name] <String> [-Type] <String> [-PartnerId] <Int>[ [-Default] <SwitchParameter>]
Parameters
Aliases Appliance
Required? false
Position? named
Use to specify if the partner should be the default Support or Reseller partner. All supproted monitored resources by default will
inherit from the appliance.
Aliases None
Required? false
Position? named
Default value
-Name <String>
Supply the Partner Name.
Aliases None
Required? true
Position? named
Default value
-PartnerId <Int>
The HPE Authorized Support and/or Reseller Partner ID.
Aliases None
Required? true
Position? named
Default value
-Type <String>
Specify if the authorized partner is a Reseller or Support. If requiring a partner that is both Support and a Reseller, create it
twice.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Newly created Remote Support Partner.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVRemoteSupportPartner -Name "My Authorized Partner" -Type Reseller -PartnerId 123456
Define a new authorized HPE Reseller partner.

-------------------------- EXAMPLE 2 --------------------------
New-HPOVRemoteSupportPartner -Name "My Authorized Partner" -Type Support -PartnerId 123456 -Default
Define a new authorized HPE Support partner, and make it the default appliance Support partner. ### Related Links * [Get-
HPOVRemoteSupportPartner](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportPartner) *
[Remove-HPOVRemoteSupportPartner](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVRemoteSupportPartner) ***
Top
### HPE OneView 4.00 Library ## New-HPOVRemoteSupportPartner
Retrieve Remote Support Default Site. ### SYNTAX
New-HPOVRemoteSupportPartner [-Name] <String> [-Type] <String> [-PartnerId] <Int>[ [-Default] <SwitchParameter>]

Parameters
Aliases Appliance
Required? false
Position? named
Use to specify if the partner should be the default Support or Reseller partner. All supproted monitored resources by default will
inherit from the appliance.
Aliases None
Required? false
Position? named
Default value
-Name <String>
Supply the Partner Name.
Aliases None
Required? true
Position? named
Default value
-PartnerId <Int>
The HPE Authorized Support and/or Reseller Partner ID.
Aliases None
Required? true
Position? named
Default value
-Type <String>
Specify if the authorized partner is a Reseller or Support. If requiring a partner that is both Support and a Reseller, create it
twice.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Newly created Remote Support Partner.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVRemoteSupportPartner -Name 'My Authorized Partner' -Type Reseller -PartnerId 123456
Define a new authorized HPE Reseller partner.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVRemoteSupportPartner -Name 'My Authorized Partner' -Type Support -PartnerId 123456 -Default
Define a new authorized HPE Support partner, and make it the default appliance Support partner.
Related Links
Top
New-HPOVResource
New-HPOVResource
Create a new resource.
SYNTAX
New-HPOVResource [-Uri] <String> [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
Create a new resource by passing the URI and the resource details in the form of a PowerShell hashtable.
Parameters
Aliases Appliance
Required? true
Position? 2
The new resource that is to be created
Aliases Resource
Required? true
Position? 1
Default value
-Uri <String>
The location where the new object is to be created, using the HTTP POST method.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Resource object to create
Return Values
The newly created resource, or async task
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVResource /rest/ethernet-networks @{vlanId=2000; purpose="General"; name="VLAN 2000"; smartLink=$true; pr

ivateNetwork=$false; type="ethernet-networkV2"}
Create a new Ethernet Network, "VLAN 2000". ### Related Links * [Add-HPOVResourceToLabel]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVResourceToLabel) * [Add-HPOVResourceToRack]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVResourceToRack) * [Add-HPOVResourceToScope]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVResourceToScope) * [Remove-HPOVResource]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVResource) * [Remove-HPOVResourceFromLabel]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVResourceFromLabel) * [Remove-
HPOVResourceFromScope](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVResourceFromScope) *
[Set-HPOVResource](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVResource) ***
Top
### HPE OneView 4.00 Library ## New-HPOVResource
Create a new resource. ### SYNTAX
New-HPOVResource [-Uri] <String> [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
Create a new resource by passing the URI and the resource details in the form of a PowerShell hashtable.
Parameters

Aliases Appliance
Required? true
Position? 2
The new resource that is to be created
Aliases Resource
Required? true
Position? 1
Default value
-Uri <String>
The location where the new object is to be created, using the HTTP POST method.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Resource object to create
Return Values
The newly created resource, or async task
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVResource /rest/ethernet-networks @{vlanId=2000; purpose="General"; name="VLAN 2000"; smartLink=$true; pr

ivateNetwork=$false; type="ethernet-networkV2"}
Create a new Ethernet Network, "VLAN 2000".
Related Links
Remove-HPOVResource
Remove-HPOVResourceFromLabel
Remove-HPOVResourceFromScope
Set-HPOVResource
Top
New-HPOVRestore

New-HPOVRestore
Upload appliance backup file to restore its configuration.
SYNTAX
New-HPOVRestore [-FileName] <String> [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <S
witchParameter>] [<CommonParameters>]
Using this cmdlet will initiate a restore of the appliance to the backup file specified. Starts a restore operation from the backup
file already uploaded to the appliance. Only one restore operation can run at a time. There is no way to cancel a restore once it
has been started. The restore operation is destructive. Any configuration changes not included in the backup file will be lost.
The appliance will raise alerts for any inconsistencies detected after the restore. If an unrecoverable error is detected during the
restore, then the appliance will be set to the factory reset mode.
Restoring from a backup is a disruptive action:
* The appliance restarts and users cannot log in to the appliance during the restore process. All users are
logged out and their work is lost.
* To prevent duplicate identifiers on the network, server hardware configurations are cleared if an associated
server profile is not in the backup.
* Server profiles that have been modified since the backup was taken are flagged with this message: "Server
profile settings conflict with the server hardware configuration". To reapply the server profile configuration and restore network
connectivity, you must unassign all flagged server profiles and then individually reassign the server profiles to the server
hardware.
* To prevent unintentional assignment of duplicate addresses or identifiers, all address and identifier ranges
are disabled after the post-restore process completes. The appliance automatically re-creates replacement address and
identifier ranges.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
-FileName <String>
Aliases [-File]
The full path and file name of the appliance configuration backup file.
Aliases File
Required? true
Position? named
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The restore process object. This is not an Async Task
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVRestore "C:\Users\me\Documents\appliance_backup_2013-11-01_110203.bkp"
Upload a backup file to restore in the appliance. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVRestore
Upload appliance backup file to restore its configuration. ### SYNTAX
New-HPOVRestore [-FileName] <String> [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <S

Using this cmdlet will initiate a restore of the appliance to the backup file specified. Starts a restore operation from the backup
file already uploaded to the appliance. Only one restore operation can run at a time. There is no way to cancel a restore once it
has been started. The restore operation is destructive. Any configuration changes not included in the backup file will be lost.
The appliance will raise alerts for any inconsistencies detected after the restore. If an unrecoverable error is detected during the
restore, then the appliance will be set to the factory reset mode.
Restoring from a backup is a disruptive action:
* The appliance restarts and users cannot log in to the appliance during the restore process. All users are
logged out and their work is lost.
* To prevent duplicate identifiers on the network, server hardware configurations are cleared if an associated
server profile is not in the backup.

* Server profiles that have been modified since the backup was taken are flagged with this message: 'Server
profile settings conflict with the server hardware configuration'. To reapply the server profile configuration and restore network
connectivity, you must unassign all flagged server profiles and then individually reassign the server profiles to the server
hardware.
* To prevent unintentional assignment of duplicate addresses or identifiers, all address and identifier ranges
are disabled after the post-restore process completes. The appliance automatically re-creates replacement address and
identifier ranges.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
-FileName <String>
Aliases [-File]
The full path and file name of the appliance configuration backup file.
Aliases File
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The restore process object. This is not an Async Task
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVRestore "C:\Users\me\Documents\appliance_backup_2013-11-01_110203.bkp"
Upload a backup file to restore in the appliance.
Related Links
Top
New-HPOVScope

New-HPOVScope
Create new Scope.
SYNTAX
New-HPOVScope [-Name] <String>[ [-Description] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
scopes based on:

* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Name <String>
Name of the scope to create.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Scope [System.Management.Automation.PSCustomObject]
Appliance Scope resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVScope -Name MyFinanceScope
Create a "MyFinanceScope" for the default appliance connection.

-------------------------- EXAMPLE 2 --------------------------
New-HPOVScope -Name MyFinanceScope -Descrition "Finance Scope of resources"
Create a "MyFinanceScope" with a descrition for the default appliance connection.

-------------------------- EXAMPLE 3 --------------------------
New-HPOVScope -Name MyFinanceScope -Descrition "Finance Scope of resources" -ApplianceConnection $ConnectedSessi

ons
Create a "MyFinanceScope" with a descrition for all appliance connections. ### Related Links * [Get-HPOVScope]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVScope) * [Remove-HPOVScope]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVScope) ***
Top
### HPE OneView 4.00 Library ## New-HPOVScope
Create new Scope. ### SYNTAX
New-HPOVScope [-Name] <String>[ [-Description] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
scopes based on:
* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Name <String>
Name of the scope to create.

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.Scope [System.Management.Automation.PSCustomObject]
Appliance Scope resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVScope -Name MyFinanceScope
Create a 'MyFinanceScope' for the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVScope -Name MyFinanceScope -Descrition 'Finance Scope of resources'
Create a 'MyFinanceScope' with a descrition for the default appliance connection.
-------------------------- EXAMPLE 3 --------------------------
New-HPOVScope -Name MyFinanceScope -Descrition 'Finance Scope of resources' -ApplianceConnection $ConnectedSessi

ons
Create a 'MyFinanceScope' with a descrition for all appliance connections.
Related Links
Get-HPOVScope
Remove-HPOVScope
Top
Create or Import a Server Profile
SYNTAX
New-HPOVServerProfile [-Name] <String> [-AssignmentType] <String>[ [-Enclosure] <Object>][ [-EnclosureBay] <Int3
2>][ [-Server] <Object>][ [-Description] <String>][ [-Connections] <Array>][ [-EnclosureGroup] <Object>] [-Serve
rHardwareType] <Object>[ [-Firmware] <SwitchParameter>][ [-Baseline] <Object>][ [-FirmwareInstallMode] <String>]
[ [-FirmwareActivationMode] <String>][ [-FirmwareActivateDateTime] <DateTime>] [-ForceInstallFirmware] <SwitchPa
rameter SwitchParameter>[ [-Bios] <SwitchParameter>] [-BiosSettings] <Array> [-BootMode] <String> [-PxeBootPolic
y] <String>[ [-ManageBoot] <SwitchParameter>] [-BootOrder] <Array>[ [-SecureBoot] <String>][ [-LocalStorage] <Sw
itchParameter>][ [-StorageController] <Object>] [-Affinity] <String> [-MacAssignment] <String> [-WwnAssignment]
<String> [-SnAssignment] <String> [-SerialNumber] <String> [-Uuid] <String> [-HideUnusedFlexNics] <Boolean>[ [-O
SDeploymentPlan] <Object>][ [-OSDeploymentAttributes] <Array>][ [-Async] <SwitchParameter>][ [-ApplianceConnecti
on] <Object>] [-Passthru] <SwitchParameter> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
New-HPOVServerProfile [-Name] <String>[ [-ServerProfileTemplate] <Object>] [-AssignmentType] <String>[ [-Enclosu

re] <Object>][ [-EnclosureBay] <Int32>][ [-Server] <Object>][ [-Description] <String>][ [-Connections] <Array>][
[-Firmware] <SwitchParameter>][ [-Baseline] <Object>][ [-FirmwareInstallMode] <String>][ [-FirmwareActivationMod
e] <String>][ [-FirmwareActivateDateTime] <DateTime>] [-ForceInstallFirmware] <SwitchParameter SwitchParameter>[
[-ManageBoot] <SwitchParameter>][ [-LocalStorage] <SwitchParameter>][ [-StorageController] <Object>] [-IscsiIPv4
Address] <Array> [-ISCSIInitatorName] <String> [-ChapSecret] <SecureString> [-MutualChapSecret] <SecureString>[
[-OSDeploymentPlan] <Object>][ [-OSDeploymentAttributes] <Array>][ [-Async] <SwitchParameter>][ [-ApplianceConne
ction] <Object>] [-Passthru] <SwitchParameter> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
New-HPOVServerProfile [-Name] <String>[ [-SANStorage] <SwitchParameter>] [-HostOStype] <String> [-StorageVolume]

<Object> [-AssignmentType] <String>[ [-Enclosure] <Object>][ [-EnclosureBay] <Int32>][ [-Server] <Object>][ [-De
scription] <String>][ [-Connections] <Array>][ [-EnclosureGroup] <Object>] [-ServerHardwareType] <Object>[ [-Fir
mware] <SwitchParameter>][ [-Baseline] <Object>][ [-FirmwareInstallMode] <String>][ [-FirmwareActivationMode] <S
tring>][ [-FirmwareActivateDateTime] <DateTime>] [-ForceInstallFirmware] <SwitchParameter SwitchParameter>[ [-Bi
os] <SwitchParameter>] [-BiosSettings] <Array> [-BootMode] <String> [-PxeBootPolicy] <String>[ [-ManageBoot] <Sw
itchParameter>] [-BootOrder] <Array>[ [-SecureBoot] <String>][ [-LocalStorage] <SwitchParameter>][ [-StorageCont
roller] <Object>][ [-EvenPathDisabled] <SwitchParameter>][ [-OddPathDisabled] <SwitchParameter>] [-Affinity] <St
ring> [-MacAssignment] <String> [-WwnAssignment] <String> [-SnAssignment] <String> [-SerialNumber] <String> [-Uu
id] <String> [-HideUnusedFlexNics] <Boolean>[ [-OSDeploymentPlan] <Object>][ [-OSDeploymentAttributes] <Array>][
[-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-Passthru] <SwitchParameter> [-WhatIf] <> [-Confi
rm] <> [<CommonParameters>]
New-HPOVServerProfile [-IscsiIPv4Address] <Array> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
New-HPOVServerProfile[ [-Import] <SwitchParameter>] [-ProfileObj] <Object>[ [-Async] <SwitchParameter>] [-WhatIf

] <> [-Confirm] <> [<CommonParameters>]
This cmdlet is used to create or import an HPE OneView Server Profile.
A server profile is the configuration for a server instance. Server profiles capture the entire server configuration in one place,
enabling you to consistently replicate new server profiles and to rapidly modify them to reflect changes in your data center.
A server profile includes:

* Server identification information
* Connectivity settings for Ethernet networks, network sets, and Fibre Channel networks
* Firmware policy
* Local storage settings
* SAN storage settings (for environments that have Virtual Connect)
* BIOS settings
* Boot order
* Physical or virtual UUIDs, MAC addresses, and WWN addresses
You can create an unassigned server profile that serves as a template. Typically, you capture best-practice configurations in a
server profile template, and then copy and deploy instances as individual server profiles. Similar to virtual machine (VM)
templates, profiles enable you to create a provisioning baseline for server hardware types in an enclosure.
When you create a server profile, it is designated for a server hardware type and enclosure group (for server blades), whether
the profile is assigned or unassigned.
To figure out BIOS Settings to override or set within the Server Profile, you will need to get the Server Hardware Type resource
that your are modeling the Server Profile for. When retrieving the resource:
$bl460cgen9sht = Get-HPOVServerHardwareType "BL460c Gen9 1"
The "biosSettings" Array property will be available (only with supported Server Hardware Types; i.e. BL460c Gen8 or newer). To
locate potential BIOS Settings, you can use the following code as an example:
$biosSettings = $bl460cgen9sht.biosSettings | ? name -match "power"
The code example above will return all matching BIOS Settings where the name contains "power". The found BIOS settings
object(s) are then saved into $biosSettings. Update the "value" property accordingly, and you can then pass $biosSettings
variable to the -biosSettings parameter.
Parameters
-Affinity <String>
In a server profile, the Affinity control sets the remove-and-replace behavior for blade servers. If you apply a server profile to a
blade server and the server is subsequently removed from the device bay, the Affinity setting controls whether the server profile
is reapplied when you insert a server blade into the empty bay. Server profiles for rack servers do not have affinity.
Accepted values are either "Bay" or "BayAndServer". Default is "Bay".
Aliases None
Required? true
Position? named
Default value Bay
Aliases Appliance
Required? false
Position? named
-AssignmentType <String>
The instruction of how the profile will be assigned. The profile can be assigned to an empty server bay, a specific server, or
unassigned.
Valid values for this parameter are "unassigned", "server", or "bay"
Aliases assign
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value false
-Baseline <Object>
Firmware baseline to assign. Can be either Baseline Name or URI.
Aliases None
Required? false
Position? named
Default value
-Bios <SwitchParameter>
Enable BIOS Settings Management. Cannot be enabled with Server Hardware Type does not support BIOS Management (i.e. BL
G7 servers.)
Aliases None
Required? false
Position? named
Default value False
-BiosSettings <Array>
BIOS Settings that are to be managed. You can get the BIOS settings available from Get-HPOVServerHarwareType and the
returned biosSettings property.
Aliases None
Required? true
Position? named
Default value @()
-BootMode <String>
Specify the Gen9 Boot Envrionment.
Sets the boot mode as one of the following:
* UEFI
* UEFIOptimized
* BIOS
* Unmanaged
If you select UEFI or UEFI optimized for an HP ProLiant DL Gen9 rack mount server, the remaining boot setting available is the
PXE boot policy.
For the UEFI or UEFI optimized boot mode options, the boot mode choice should be based on the expected OS and required
boot features for the server hardware. UEFI optimized boot mode reduces the time the system spends in POST (Video driver
initialization). In order to select the appropriate boot mode, consider the following:
* If a secure boot is required, the boot mode must be set to UEFI or UEFI optimized .
* For operating systems that do not support UEFI (such as DOS, or older versions of Windows and Linux), the boo
t mode must be set to BIOS.
* When booting in UEFI mode, Windows 7, Server 2008, or 2008 R2 should not be set to UEFIOptimized.
Default: BIOS
Aliases None
Required? true
Position? named
Default value BIOS
-BootOrder <Array>
Boot Order settings to be managed.
Defines the order in which boot will be attempted on the available devices. For Gen7 and Gen8 server hardware the possible
values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible
values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one
value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible
values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order
configuration is not supported.
Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order:
"CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"
Aliases None
Required? true
Position? named
Default value @()
-ChapSecret <SecureString>
Parameter is required when creating a Server Profile, specifying a ServerProfileTemplate parameter value, and a Connection
iSCSI Authentication Protocol is set to Chap or MutualChap.
The CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12
and 16 characters. If HEX, it must start with 0x and with 24-32 characters.
Aliases None
Required? true
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
-Connections <Array>
The network connections that are to be part of this new server profile. This an array of profile conneciton objects which may be
created with "New-HPOVServerProfileConnection".
Expected Connection Format:
[System.Collections.ArrayList ] @( [PsCustomObject]@{ [System.Int]id - Connection ID. Valid 1-64. A 0 value is allowed, but
means Auto Connection ID assignment. [System.String]function - Ethernet or FibreChannel. [System.String]networkUri - URI to
the Network resource. [System.String]portId - Auto or the specific Port ID. For FlexLOMs, the valid portId prefix will be "Flb", and
Mezzanine would be "Mezz". Ex. FlexNIC 1a interface would be "Flb 1:1a" Ex. Mezzanine 2, FlexNIC 2c interface would be "Mezz
2:2c" [System.Int32]requestedMpbs - Requested bandwidth in Mbps. [System.Collections.Hashtable]boot - Nested Hashtable @{
[System.String]priority - Boot priority for this connection. Can be used with Ethernet or FC connections. Allowed values:
NotBootable Primary Secondary [System.Collections.ArrayList ]targets - Array of FC boot targets (only 1 entry is allowed) @(
[System.String]arrayWwpn - Target WWPN of storage array. [System.String]lun - Boot LUN ID
)
}
[System.String]macType - Allowed values:
Physical
UserDefined
Virtual
[System.String]mac - UserDefined MAC Address. Required for custom MAC and FCoE WWPN addresses.
[System.String]wwpnType - Allowed values:
Physical
UserDefined
Virtual
[System.String]wwpn - UserDefined WWPN Address
[System.String]wwnn - UserDefined WWNN Address
}
Default: No connections
Aliases None
Required? false
Position? named
Default value
Optional description for this server profile.
Aliases None
Required? false
Position? named
Default value
-Enclosure <Object>
The blade enclosure resource containing the bay where the server profile will be assigned. Only required if assignmentType is
"bay"
Aliases None
Required? false
Position? named
Default value
-EnclosureBay <Int32>
The empty enclosure bay to assign the server profile.
Aliases bay
Required? false
Position? named
Default value 0
Aliases [-eg] The Enclosure Group resource the Server Profile will be bound to. Only required when Server value is
"Unassigned".
Aliases eg
Required? false
Position? named
Default value
-EvenPathDisabled <SwitchParameter>
Aliases [-even]
Enable to disable even paths in the attached storage volume(s).
Aliases Even
Required? false
Position? named
Default value False
-Firmware <SwitchParameter>
Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL
G7 servers.)
Aliases None
Required? false
Position? named
Default value False
-FirmwareActivateDateTime <DateTime>
Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will
downgrade firmware if the component firmware is newer than what the SPP Baseline contains.
Aliases None
Required? false
Position? named
Default value
-FirmwareActivationMode <String>
Specify the firmware activation policy. Avialable options are:
* Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in
the Host OS or Proxy VM (for VMware only)
* Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to spe
cify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VM
ware only)
* NotScheduled - Scheduled firmware update is cancelled when you choose this option.
Aliases None
Required? false
Position? named
Default value Immediate
-FirmwareInstallMode <String>
Aliases [-FirmwareMode]
Specify the Firmware Baseline Policy mode. Avialable options are:
* FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Upd
ate Tools.
* FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP
Smart Update Tools.
* FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardwar
e to be powered down.
Aliases FirmwareMode
Required? false
Position? named
Default value FirmwareAndSoftware
-ForceInstallFirmware <SwitchParameter SwitchParameter>
downgrade firmware if the component firmware is newer than what the SPP Baseline contains. Using this parameter will force the
bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the
component firmware is newer than what the SPP Baseline contains.
Aliases None
Required? false false
Position? named
Default value False Fafalselse
-HideUnusedFlexNics <Boolean>
This setting provides the ability to hide unused FlexNICs from the operating system.
If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not
presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile
but map only four, your operating system will see only the four mapped FlexNICs instead of eight.
If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network
interfaces for each Flex-10 or FlexFabric adapter.
Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of
network interfaces to six.
FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds
to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on
either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and
second physical functions are enumerated in the operating system.
By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.
Aliases None
Required? true
Position? named
Default value True
-HostOStype <String>
Aliases [-OS]
Optional. Specify the Host OS type, which will set the Host OS value when HPE OneView created the Host object on the Storage
System. Accepted values:
* CitrixXen = "Citrix Xen Server 5.x/6.x"
* AIX = "AIX"
* IBMVIO = "IBM VIO Server"
* RHEL4 = "RHE Linux (Pre RHEL 5)"
* RHEL = "RHE Linux (5.x, 6.x)"
* RHEV = "RHE Virtualization (5.x, 6.x)"
* VMware = "ESX 4.x/5.x"
* Win2k3 = "Windows 2003"
* Win2k8 = "Windows 2008/2008 R2"
* Win2k12 = "Windows 2012 / WS2012 R2"
* OpenVMS = "OpenVMS"
* Egenera = "Egenera"
* Exanet = "Exanet"
* Solaris9 = "Solaris 9/10"
* Solaris11 = "Solaris 11"
* ONTAP = "NetApp/ONTAP"
* OEL = "OE Linux UEK (5.x, 6.x)"
* HPUX11iv1 = "HP-UX (11i v1, 11i v2)"
* HPUX11iv2 = "HP-UX (11i v1, 11i v2)"
* HPUX11iv3 = "HP-UX (11i v3)"
* SUSE = "SuSE (10.x, 11.x)"
* SUSE9 = "SuSE Linux (Pre SLES 10)"
* Inform = "InForm"
Aliases OS
Required? true
Position? named
Default value
-ISCSIInitatorName <String>
Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value which contain
iSCSI Connections that are bootable.
Value to provide for the iSCSI Initiator. All iSCSI Connections will share this value. If no value is provided, the connection will
default to using the Server Profile Name.
Aliases None
Required? true
Position? named
Default value
-Import <SwitchParameter>
Switch to import Server Profile JSON object or file.
Aliases None
Required? false
Position? named
Default value False
-IscsiIPv4Address <Array>
Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value.
A collection of IPv4 Addresses to allocate for found iSCSI initiators that are Bootable.
Aliases None
Required? true
Position? named
Default value
-LocalStorage <SwitchParameter>
Enable local storage settings to be managed on the server. Will only enable embedded Smart Array controller management.
Aliases None
Required? false
Position? named
Default value False
-MacAssignment <String>
Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value
when using the New-HPOVServerProfileConnection helper CMDLET.
Aliases None
Required? true
Position? named
Default value Virtual
-ManageBoot <SwitchParameter>
Aliases [-boot]
Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS
settings are disabled within the entire Server Profile.
Default: $True
Aliases boot
Required? false
Position? named
Default value False
-MutualChapSecret <SecureString>
iSCSI Authentication Protocol is set to MutualChap.
The Mutual CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen
12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters.
Aliases None
Required? true
Position? named
Default value
-Name <String>
The name of the server profile resource to be created.
Aliases None
Required? true
Position? named
Default value
-OSDeploymentAttributes <Array>
Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute.
Aliases None
Required? false
Position? named
Default value
-OSDeploymentPlan <Object>
The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.
Aliases None
Required? false
Position? named
Default value
-OddPathDisabled <SwitchParameter>
Aliases [-odd]
Enable to disable odd paths in the attached storage volume(s).
Aliases Odd
Required? false
Position? named
Default value False
-Passthru <SwitchParameter>
Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-
HPOVServerProfile Cmdlet.
Aliases None
Required? True
Position? named
Default value
-ProfileObj <Object>
Aliases [-location, -file] Source Server Profile JSON object or file.
Aliases location, file
Required? true
Position? named
Default value
-PxeBootPolicy <String>
Controls the ordering of the network modes available to the Flexible LOM (FLB); for example, IPv4 and IPv6.
Select from the following policies:

* Auto
* IPv4 only
* IPv6 only
* IPv4 then IPv6
* IPv6 then IPv4
Setting the policy to Auto means the order of the existing network boot targets in the UEFI Boot Order list will not be modified,
and any new network boot targets will be added to the end of the list using the System ROM"s default policy.
Default: Auto
Aliases None
Required? true
Position? named
Default value Auto
-SANStorage <SwitchParameter>
Optional. Enable SAN Storage Management within the Server Profile.
Aliases None
Required? false
Position? named
Default value False
-SecureBoot <String>
Specify if secure boot should be Unmanaged, Enabled or Disabled for Gen10 and newer servers. Boot Mode must be set to
'UEFI Optimized'.
Aliases None
Required? false
Position? named
Default value
When specifying snAssignment parameter to UserDefined, you can provide a user defined Serial Number value. You must also
specify the UUID by using the uuid parameter.
Aliases None
Required? true
Position? named
Default value
-Server <Object>
The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call,
and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name or URI.
Aliases None
Required? false
Position? named
Default value
Aliases [-sht] The Server Hardware Type reource the Server Profile will be bound to. Required when Server value is
"Unassigned" or assigning to an empty device bay in an enclosure which must include the -enclosure and -enclosureBay
parameters.
Aliases sht
Required? true
Position? named
Default value
Provide a Server Profile Template Object or Resource Name.
Aliases None
Required? false
Position? named
Default value
-SnAssignment <String>
Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined.
Default: Virtual serial number and UUID assignment
Aliases None
Required? true
Position? named
-StorageController <Object>
Aliases [-LogicalDisk]
A collection (System.Collections.ArrayList or System.Collections.ArrayList) of LogicalDisk Controller configuration objects from

New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController.
Aliases LogicalDisk
Required? false
Position? named
Default value
Optional. Array of Storage Volume resources to attach. Can be created by using the New-HPOVServerProfileAttachVolume
cmdlet. This parameter does not accept a Storage Volume resource from the Get-HPOVStorageVolume cmdlet.
The format of the Storage Volume resource should be a PsCustomObject PowerShell resource with the following keys and
values:
[PsCustomObject]@{ [System.Int]id - Valid Host LUN ID 0-254 [System.String]lunType - Auto or Manual [System.String]volumeUri
- URI to Storage Volume that has been created and not assigned to another Server Profile if it is a Private Volume.
[System.String]volumeStoragePoolUri - URI to HPE OneView managed Storage Pool [System.String]volumeStorageSystemUri -
URI to HPE OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC
Connection ID associated with the path to the attached volume, and if the path is enabled or disabled. @(
[System.Int]connectionId - FC Connection ID. If using New-HPOVServerProfileAttachVolume helper cmdlet, New-
HPOVServerProfile will automatically determine the FC connection ID. [System.Boolean]isEnabled - Enable or disable the path )
}
Aliases None
Required? true
Position? named
Default value
-Uuid <String>
When specifying snAssignment parameter to UserDefined, you can provide a user defined UUID value. You must also specify
the Serial Number by using the serialnumber parameter.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
-WwnAssignment <String>
Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when
using the New-HPOVServerProfileConnection helper CMDLET.
Aliases None
Required? true
Position? named
<CommonParameters>
Input Types
System.String
The full path to the Server Profile JSON export file
Server Hardware resource object
Return Values
If successful returns a task resource which may be polled to follow the progress of the profile creation. Otherwise, a request
validation error will be returned
Examples
-------------------------- EXAMPLE 1 --------------------------
$svr = Get-HPOVServer -Name "Encl1, Bay 1"

New-HPOVServerProfile -name "My Basic Server Profile" -server $svr | Wait-HPOVTaskComplete
Create a simple profile for "ServerA", and wait for it to be applied.

-------------------------- EXAMPLE 2 --------------------------
$spt = Get-HPOVServerProfileTemplate -Name "Hypervisor Cluster Node Template v1"

Get-HPOVServer -Name "Encl1, Bay 1" | New-HPOVServerProfile -name "Hyp-Clus-01" -ServerProfileTemplate $spt | Wa
it-HPOVTaskComplete
Create a Server Profile from the "Hypervisor Cluster Node Template v1" Server Profile Template, assigning to "Encl1, Bay 1"
server device.
-------------------------- EXAMPLE 3 --------------------------
$profileName = "Web Server 10"

$con1 = Get-HPOVNetwork -Name "Net-41-A" | New-HPOVServerProfileConnection -ConnectionId 1
$con2 = Get-HPOVNetwork -Name "Net-41-B" | New-HPOVServerProfileConnection -ConnectionId 2
$params = @{
>> name = $profileName;
>> assignmentType = "server";
>> server = $svr;
>> connections = ($con1, $con2);
>> ApplianceConnection = "MyAppliance.domain.com"
>> }
>>
New-HPOVServerProfile @params | Wait-HPOVTaskComplete
Create a BL Gen8 Server Profile template, and pipe to Wait-HPOVTaskComplete.

-------------------------- EXAMPLE 4 --------------------------
$profileName = "Hypervisor Cluster Node 1"

$con1 = Get-HPOVNetwork -Name "Net-41" | New-HPOVServerProfileConnection -id 1 -type Ethernet
$con3 = Get-HPOVNetwork -Name "fabric a" | New-HPOVServerProfileConnection -id 3 -type FibreChannel -bootable -p
riority Primary -arrayWWPn "21:11:00:02:AC:00:72:03" -LUN 0
$con4 = Get-HPOVNetwork "fabric b" | New-HPOVServerProfileConnection -id 4 -type FibreChannel -bootable -priorit
y Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0
$conList = $con1, $con2, $con3, $con4
$task = New-HPOVServerProfile -name $profileName -assignmentType "unassigned" -connections $conList | Wait-HPOVT
askComplete
Create an unassigned server profile which includes networks "Net-41" and "Net-42", adds FC Connections for BfS.
-------------------------- EXAMPLE 5 --------------------------

$con4 = Get-HPOVNetwork -Name "fabric b" | New-HPOVServerProfileConnection -id 4 -type FibreChannel -bootable -p
riority Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0
$volume1 = Get-HPOVStorageVolume Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1
$volume2 = Get-HPOVStorageVolume SharedVolume1 | New-HPOVServerProfileAttachVolume -volumeid 2
$attachVolumes = @($volume1,$volume2)
$task = New-HPOVServerProfile -name $profileName -assignmentType "unassigned" -connections $conList -SANStorage
-ostype VMware -StorageVolume $attachVolumes | Wait-HPOVTaskComplete
Create an unassigned server profile which includes networks "Net-41" and "Net-42", and attaches two storage volumes.
-------------------------- EXAMPLE 6 --------------------------

$bl460SHT = Get-HPOVServerHardwareTypes -name "BL460c Gen8 1"
$enclosure = Get-HPOVEnclosure -Name "Encl1"
$bay = 12
$task = New-HPOVServerProfile -name $profileName -assignmentType bay -connections $conList -sht $bl460SHT -enclo
sure $enclosure -bay $bay | Wait-HPOVTaskComplete
Create a profile which includes networks "Net-41" and "Net-42", adds FC Connections for BfS, and assign to Bay 12 of "Encl1"
which is currently empty.
-------------------------- EXAMPLE 7 --------------------------

$server = Get-HPOVServer -Name "Encl1, Bay 1"
#display the BL460 Gen8 BIOS Settings
$bl460SHT.biosSettings
#Set HP Power Profile (ID 210) to Maximum Performance and HP Power Regulator (ID 140) to HP Static High Performa
nce Mode.
$bl460bios = @(@{id=210;value=3},@{id=140;value=3})
$con41 = Get-HPOVNetwork -Name "Net-41" | New-HPOVServerProfileConnection -ID 1 -bootable -priority Primary
$con42 = Get-HPOVNetwork -Name "Net-42" | New-HPOVServerProfileConnection -ID 2 -bootable -priority Secondary
$conList = @($con41, $con42)
$task = New-HPOVServerProfile -name $profileName -assignmentType "server" -server $server -connections $conList
-manageboot -bootorder @("PXE","HardDisk","CD","Floppy","USB") -bios -biossettings $bl460bios | Wait-HPOVTaskCom
plete
Create a profile which includes networks "Net-41" and "Net-42", sets the boot order, and sets the BIOS. Then pipes to Wait-
HPOVTaskComplete.
-------------------------- EXAMPLE 8 --------------------------

$server = Get-HPOVServer -Name "Encl1, Bay 1" #Gen9 Server
$con1 = Get-HPOVNetwork -Name "Net-41-A" | New-HPOVServerProfileConnection -connectionId 1
$con2 = Get-HPOVNetwork -Name "Net-41-B" | New-HPOVServerProfileConnection -connectionId 2
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "My Local Disk" -RAID RAID1 -NumberofDrives 2 -DiskType Sa
sSsd
$params = @{
>> assignmentType = "server"
>> server = $server;
>> connections = $con1, $con2
>> manageboot = $True;
>> bootMode = "UEFI";
>> pxeBootPolicy = "IPv4ThenIPv6";
>> bootOrder = "HardDisk";
>> HideUnusedFlexnics = $True;
>> LocalStorage = $True;
>> Initialize = $True;
>> LogicalDisk = $LogicalDisk
>> }
>>
Create a BL Gen9 UEFI Server Profile, and pipe to Wait-HPOVTaskComplete.

-------------------------- EXAMPLE 9 --------------------------
$profileName = "Synergy Hypervisor Cluster Node 1"

$sht = Get-HPOVServerHardwareType -Name "SY480 Gen9 1"
$server = Get-HPOVServer -NoProfile -ServerHardwareType $sht | ? { $_.cpuCount -ge 4 -and $_.memoryMb -ge 524288
} | Select -First 1
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "Data Drive" -RAID RAID1 -NumberofDrives 5 -DiskType SasSs
d
$Controller = New-HPOVServerProfileLogicalDiskController -ControllerID "Mezz 1" -Initialize -LogicalDisk $Logica
lDisk
$params = @{
>> assignmentType = "server"
>> server = $server;
>> connections = $con1, $con2
>> Initialize = $True;
>> LogicalDisk = $LogicalDisk
>> }
>>
Create a Synergy Gen9 Server Profile by looking for the first available SY480 Gen9 with 4 CPU"s and 512GB of RAM,
configuring with D3940 Disk Storage.
-------------------------- EXAMPLE 10 --------------------------
New-HPOVServerProfile -import -file C:\profiles\ServerProfile1.json
Basic Server Profile import.

-------------------------- EXAMPLE 11 --------------------------
(Get-Content C:\profiles\ServerProfile1.json) -join "`n" | New-HPOVServerProfile -import
Read the contents from ServerProfile1.json, join each line into a single object, and pipe to New-HPOVServerProfile to import.
-------------------------- EXAMPLE 12 --------------------------
$jsonProfiles = Get-ChildItem C:\profiles\*.json

$jsonProfiles | foreach-object { New-HPOVServerProfile -import -file $_.fullname }
Retrieve list of all JSON files in C:\profiles, then pass each file and its full path to New-HPOVServerProfile. ### Related Links *
[Convert-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfile) * [Convert-
HPOVServerProfile) * [Get-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
* [New-HPOVServerProfileAssign](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileAssign) *
[New-HPOVServerProfileAttachVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
Top
### HPE OneView 4.00 Library ## New-HPOVServerProfile
Create or Import a Server Profile ### SYNTAX
New-HPOVServerProfile [-Name] <String> [-AssignmentType] <String>[ [-Enclosure] <Object>][ [-EnclosureBay] <Int3

2>][ [-Server] <Object>][ [-Description] <String>][ [-Connections] <Array>][ [-EnclosureGroup] <Object>] [-Serve
rHardwareType] <Object>[ [-Firmware] <SwitchParameter>][ [-Baseline] <Object>][ [-FirmwareInstallMode] <String>]
[ [-FirmwareActivationMode] <String>][ [-FirmwareActivateDateTime] <DateTime>] [-ForceInstallFirmware] <SwitchPa
rameter SwitchParameter>[ [-Bios] <SwitchParameter>] [-BiosSettings] <Array> [-BootMode] <String> [-PxeBootPolic
y] <String>[ [-ManageBoot] <SwitchParameter>] [-BootOrder] <Array>[ [-SecureBoot] <String>][ [-LocalStorage] <Sw
itchParameter>][ [-StorageController] <Object>] [-Affinity] <String> [-MacAssignment] <String> [-WwnAssignment]
<String> [-SnAssignment] <String> [-SerialNumber] <String> [-Uuid] <String> [-HideUnusedFlexNics] <Boolean>[ [-O
SDeploymentPlan] <Object>][ [-OSDeploymentAttributes] <Array>][ [-Async] <SwitchParameter>][ [-ApplianceConnecti
on] <Object>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
New-HPOVServerProfile [-Name] <String> [-AssignmentType] <String>[ [-ServerProfileTemplate] <Object>][ [-Enclosu

re] <Object>][ [-EnclosureBay] <Int32>][ [-Server] <Object>][ [-Description] <String>][ [-Connections] <Array>][
[-FirmwareInstallMode] <String>][ [-FirmwareActivationMode] <String>][ [-FirmwareActivateDateTime] <DateTime>] [
-ForceInstallFirmware] <SwitchParameter SwitchParameter>[ [-ManageBoot] <SwitchParameter>] [-IscsiIPv4Address] <
Array> [-ISCSIInitatorName] <String> [-ChapSecret] <SecureString> [-MutualChapSecret] <SecureString>[ [-OSDeploy
mentPlan] <Object>][ [-OSDeploymentAttributes] <Array>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Ob
ject>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
New-HPOVServerProfile [-Name] <String> [-AssignmentType] <String>[ [-SANStorage] <SwitchParameter>] [-HostOStype

] <String> [-StorageVolume] <Object>[ [-Enclosure] <Object>][ [-EnclosureBay] <Int32>][ [-Server] <Object>][ [-D
escription] <String>][ [-Connections] <Array>][ [-EnclosureGroup] <Object>] [-ServerHardwareType] <Object>[ [-Fi
rmware] <SwitchParameter>][ [-Baseline] <Object>][ [-FirmwareInstallMode] <String>][ [-FirmwareActivationMode] <
String>][ [-FirmwareActivateDateTime] <DateTime>] [-ForceInstallFirmware] <SwitchParameter SwitchParameter>[ [-B
ios] <SwitchParameter>] [-BiosSettings] <Array> [-BootMode] <String> [-PxeBootPolicy] <String>[ [-ManageBoot] <S
witchParameter>] [-BootOrder] <Array>[ [-SecureBoot] <String>][ [-LocalStorage] <SwitchParameter>][ [-StorageCon
troller] <Object>][ [-EvenPathDisabled] <SwitchParameter>][ [-OddPathDisabled] <SwitchParameter>] [-Affinity] <S
tring> [-MacAssignment] <String> [-WwnAssignment] <String> [-SnAssignment] <String> [-SerialNumber] <String> [-U
uid] <String> [-HideUnusedFlexNics] <Boolean>[ [-OSDeploymentPlan] <Object>][ [-OSDeploymentAttributes] <Array>]
[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<Co
mmonParameters>]
New-HPOVServerProfile [-IscsiIPv4Address] <Array> [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters

>]
New-HPOVServerProfile[ [-Import] <SwitchParameter>] [-ProfileObj] <Object>[ [-Async] <SwitchParameter>] [-WhatIf

] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This cmdlet is used to create or import an HP OneView Server Profile.
A server profile is the configuration for a server instance. Server profiles capture the entire server configuration in one place,
enabling you to consistently replicate new server profiles and to rapidly modify them to reflect changes in your data center.
A server profile includes:

* Server identification information
* Firmware policy
* SAN storage settings (for environments that have Virtual Connect)
* BIOS settings
* Boot order
You can create an unassigned server profile that serves as a template. Typically, you capture best-practice configurations in a
server profile template, and then copy and deploy instances as individual server profiles. Similar to virtual machine (VM)
templates, profiles enable you to create a provisioning baseline for server hardware types in an enclosure.
When you create a server profile, it is designated for a server hardware type and enclosure group (for server blades), whether
the profile is assigned or unassigned.
$bl460cgen9sht = Get-HPOVServerHardwareType 'BL460c Gen9 1'
The 'biosSettings' Array property will be available (only with supported Server Hardware Types; i.e. BL460c Gen8 or newer). To
$biosSettings = $bl460cgen9sht.biosSettings | ? name -match "power"
The code example above will return all matching BIOS Settings where the name contains 'power'. The found BIOS settings
object(s) are then saved into $biosSettings. Update the 'value' property accordingly, and you can then pass $biosSettings
Introduced in HPE OneView 4.00, if a Server Hardware resource is in any other state than "OK", this Cmdlet will prompt you to
confirm if you wish to assign the server profile resource to the potentially "unhealthy" server. To override, and force apply the
Server Profile, use the -Confirm:$false parameter.
Parameters
-Affinity <String>
Accepted values are either 'Bay' or 'BayAndServer'. Default is 'Bay'.
Aliases None
Required? true
Position? named
Default value Bay
Aliases Appliance
Required? false
Position? named
-AssignmentType <String>
The instruction of how the profile will be assigned. The profile can be assigned to an empty server bay, a specific server, or
unassigned.
Valid values for this parameter are 'unassigned', 'server', or 'bay'
Aliases assign
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value false
-Baseline <Object>
Aliases None
Required? false
Position? named
Default value
G7 servers.)
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? true
Position? named
Default value @()
-BootMode <String>
* UEFI
* UEFIOptimized
* BIOS
* Unmanaged
PXE boot policy.
Default: BIOS
Aliases None
Required? true
Position? named
Default value BIOS
-BootOrder <Array>

values are 'CD', 'Floppy', 'USB', 'HardDisk', and 'PXE'. For Gen9 BL server hardware in Legacy BIOS boot mode, the possible
values are 'CD', 'USB', 'HardDisk', and 'PXE'. For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one
value is allowed and must be either 'HardDisk' or 'PXE'. For Gen9 DL server hardware in Legacy BIOS boot mode, the possible
values are 'CD', 'USB', 'HardDisk', and 'PXE'. For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order
Gen7/8 BIOS Default Boot Order: 'CD','Floppy','USB','HardDisk','PXE' Gen9 Legacy BIOS Boot Order: 'CD','USB','HardDisk','PXE'
Gen9 UEFI Default Boot Order: 'HardDisk'
Aliases None
Required? true
Position? named
Default value @()
iSCSI Authentication Protocol is set to Chap or MutualChap.
and 16 characters. If HEX, it must start with 0x and with 24-32 characters.
Aliases None
Required? true
Position? named
Default value
Use "-Confirm:$false" to override prompting for manual user input when the target server hardware resource object "state" is
anything other than "OK", or if non-redundant SAN connections are defined in the "-Connections" parameter. Otherwise, this
Cmdlet will prompt for input to confirm assigning the server profile resource to the target server hardware.
Aliases cf
Required? false
Position? named
Default value False
created with 'New-HPOVServerProfileConnection'.

)
}
Physical
UserDefined
Virtual
Physical
UserDefined
Virtual
}
Aliases None
Required? false
Position? named
Default value
Optional description for this server profile.
Aliases None
Required? false
Position? named
Default value
-Enclosure <Object>
The blade enclosure resource containing the bay where the server profile will be assigned. Only required if assignmentType is
'bay'
Aliases None
Required? false
Position? named
Default value
-EnclosureBay <Int32>
The empty enclosure bay to assign the server profile.
Aliases bay
Required? false
Position? named
Default value 0
Aliases [-eg] The Enclosure Group resource the Server Profile will be bound to. Only required when Server value is
"Unassigned".
Aliases eg
Required? false
Position? named
Default value
Aliases [-even]
Aliases Even
Required? false
Position? named
Default value False
G7 servers.)
Aliases None
Required? false
Position? named
Default value False
-FirmwareActivateDateTime <DateTime>
Aliases None
Required? false
Position? named
Default value
ware only)
Aliases None
Required? false
Position? named
ate Tools.
Smart Update Tools.
* FirmwareOffline - Manages the firmware through HP OneView. Selecting this option requires the server hardware
to be powered down.
Required? false
Position? named

-ForceInstallFirmware <SwitchParameter SwitchParameter>
downgrade firmware if the component firmware is newer than what the SPP Baseline contains. Using this parameter will force the
bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the
component firmware is newer than what the SPP Baseline contains.
Aliases None
Required? false false
Position? named
Default value False Fafalselse
Aliases None
Required? true
Position? named
Default value True
Aliases [-OS]
Optional. Specify the Host OS type, which will set the Host OS value when HP OneView created the Host object on the Storage
* AIX = "AIX"
* Win2k8 = "Windows 2008/2008 R2"
* Win2k12 = "Windows 2012 / WS2012 R2"
* Exanet = "Exanet"
* HPUX11iv1 = "HP-UX (11i v1, 11i v2)"
* HPUX11iv2 = "HP-UX (11i v1, 11i v2)"
* SUSE = "SuSE (10.x, 11.x)"
* Inform = "InForm"
Aliases OS
Required? true
Position? named
Default value
Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value which contain
iSCSI Connections that are bootable.
Aliases None
Required? true
Position? named
Default value
-Import <SwitchParameter>
Switch to import Server Profile JSON object or file.
Aliases None
Required? false
Position? named
Default value False
-IscsiIPv4Address <Array>
Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value.
A collection of IPv4 Addresses to allocate for found iSCSI initiators that are Bootable.
Aliases None
Required? true
Position? named
Default value
Enable local storage settings to be managed on the server. Will only enable embedded Smart Array controller management.
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? true
Position? named
Aliases [-boot]
Default: $True
Aliases boot
Required? false
Position? named
Default value False
iSCSI Authentication Protocol is set to MutualChap.
12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
-OSDeploymentAttributes <Array>
Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute.
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases [-odd]
Aliases Odd
Required? false
Position? named
Default value False
-ProfileObj <Object>
Aliases [-location, -file] Source Server Profile JSON object or file.
Aliases location, file
Required? true
Position? named
Default value
* Auto
* IPv4 only
* IPv6 only
* IPv4 then IPv6
* IPv6 then IPv4
and any new network boot targets will be added to the end of the list using the System ROM's default policy.
Default: Auto
Aliases None
Required? true
Position? named
Default value Auto

Aliases None
Required? false
Position? named
Default value False
'UEFI Optimized'.
Aliases None
Required? false
Position? named
Default value
When specifying snAssignment parameter to UserDefined, you can provide a user defined Serial Number value. You must also
specify the UUID by using the uuid parameter.
Aliases None
Required? true
Position? named
Default value
-Server <Object>
The server hardware resource where the new profile is to be applied. This is normally retrieved with a 'Get-HPOVServer' call,
and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name or URI.
Aliases None
Required? false
Position? named
Default value
Aliases [-sht] The Server Hardware Type reource the Server Profile will be bound to. Required when Server value is
"Unassigned" or assigning to an empty device bay in an enclosure which must include the -enclosure and -enclosureBay
parameters.
Aliases sht
Required? true
Position? named
Default value
Provide a Server Profile Template Object or Resource Name.
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? true
Position? named
Aliases [-LogicalDisk]
A collection (System.Collections.ArrayList or System.Collections.ArrayList) of LogicalDisk Controller configuration objects from

New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController.
Aliases LogicalDisk
Required? false
Position? named
Default value
values:
[System.String]volumeStoragePoolUri - URI to HP OneView managed Storage Pool [System.String]volumeStorageSystemUri -
URI to HP OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC
}
Aliases None
Required? true
Position? named
Default value
-Uuid <String>
When specifying snAssignment parameter to UserDefined, you can provide a user defined UUID value. You must also specify
the Serial Number by using the serialnumber parameter.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
<CommonParameters>
Input Types
System.String
Server Hardware resource object
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

New-HPOVServerProfile -name "My Basic Server Profile" -server $svr | Wait-HPOVTaskComplete
Create a simple profile for 'ServerA', and wait for it to be applied.
-------------------------- EXAMPLE 2 --------------------------
$spt = Get-HPOVServerProfileTemplate -Name 'Hypervisor Cluster Node Template v1'

Get-HPOVServer -Name "Encl1, Bay 1" | New-HPOVServerProfile -name "Hyp-Clus-01" -ServerProfileTemplate $spt | Wa
it-HPOVTaskComplete
Create a Server Profile from the 'Hypervisor Cluster Node Template v1' Server Profile Template, assigning to 'Encl1, Bay 1'
server device.
-------------------------- EXAMPLE 3 --------------------------
$profileName = "Web Server 10"

$con1 = Get-HPOVNetwork -Name "Net-41-A" | New-HPOVServerProfileConnection -ConnectionId 1
$con2 = Get-HPOVNetwork -Name "Net-41-B" | New-HPOVServerProfileConnection -ConnectionId 2
$params = @{
name = $profileName;
assignmentType = "server";
server = $svr;
connections = ($con1, $con2);
ApplianceConnection = 'MyAppliance.domain.com'
}
-------------------------- EXAMPLE 4 --------------------------
$profileName = 'Hypervisor Cluster Node 1'

$con4 = Get-HPOVNetwork "fabric b" | New-HPOVServerProfileConnection -id 4 -type FibreChannel -bootable -priorit
y Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0
$task = New-HPOVServerProfile -name $profileName -assignmentType 'unassigned' -connections $conList | Wait-HPOVT
askComplete
Create an unassigned server profile which includes networks 'Net-41' and 'Net-42', adds FC Connections for BfS.
-------------------------- EXAMPLE 5 --------------------------

$task = New-HPOVServerProfile -name $profileName -assignmentType 'unassigned' -connections $conList -SANStorage
-ostype VMware -StorageVolume $attachVolumes | Wait-HPOVTaskComplete
Create an unassigned server profile which includes networks 'Net-41' and 'Net-42', and attaches two storage volumes.
-------------------------- EXAMPLE 6 --------------------------

$enclosure = Get-HPOVEnclosure -Name "Encl1"
$bay = 12
$task = New-HPOVServerProfile -name $profileName -assignmentType bay -connections $conList -sht $bl460SHT -enclo
sure $enclosure -bay $bay | Wait-HPOVTaskComplete
Create a profile which includes networks 'Net-41' and 'Net-42', adds FC Connections for BfS, and assign to Bay 12 of 'Encl1'
which is currently empty.
-------------------------- EXAMPLE 7 --------------------------

$server = Get-HPOVServer -Name "Encl1, Bay 1"

nce Mode.
$con41 = Get-HPOVNetwork -Name "Net-41" | New-HPOVServerProfileConnection -ID 1 -bootable -priority Primary
$con42 = Get-HPOVNetwork -Name "Net-42" | New-HPOVServerProfileConnection -ID 2 -bootable -priority Secondary
$task = New-HPOVServerProfile -name $profileName -assignmentType 'server' -server $server -connections $conList
-manageboot -bootorder @("PXE","HardDisk","CD","Floppy","USB") -bios -biossettings $bl460bios | Wait-HPOVTaskCom
plete
Create a profile which includes networks 'Net-41' and 'Net-42', sets the boot order, and sets the BIOS. Then pipes to Wait-
HPOVTaskComplete.
-------------------------- EXAMPLE 8 --------------------------

$server = Get-HPOVServer -Name "Encl1, Bay 1" #Gen9 Server
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name 'My Local Disk' -RAID RAID1 -NumberofDrives 2 -DiskType Sa
sSsd
$params = @{
assignmentType = "server"
server = $server;
connections = $con1, $con2
manageboot = $True;
bootMode = "UEFI";
pxeBootPolicy = "IPv4ThenIPv6";
bootOrder = "HardDisk";
HideUnusedFlexnics = $True;
LocalStorage = $True;
Initialize = $True;
LogicalDisk = $LogicalDisk
}
Create a BL Gen9 UEFI Server Profile, and pipe to Wait-HPOVTaskComplete.

-------------------------- EXAMPLE 9 --------------------------
$profileName = 'Synergy Hypervisor Cluster Node 1'

$sht = Get-HPOVServerHardwareType -Name "SY480 Gen9 1"
$server = Get-HPOVServer -NoProfile -ServerHardwareType $sht | ? { $.cpuCount -ge 4 -and $.memoryMb -ge 524288 }
| Select -First 1
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name 'Data Drive' -RAID RAID1 -NumberofDrives 5 -DiskType SasSs
d
$Controller = New-HPOVServerProfileLogicalDiskController -ControllerID 'Mezz 1' -Initialize -LogicalDisk $Logica
lDisk
$params = @{
assignmentType = "server"
server = $server;
connections = $con1, $con2
manageboot = $True;
bootMode = "UEFI";
Initialize = $True;
LogicalDisk = $LogicalDisk
}
Create a Synergy Gen9 Server Profile by looking for the first available SY480 Gen9 with 4 CPU's and 512GB of RAM,
configuring with D3940 Disk Storage.
-------------------------- EXAMPLE 10 --------------------------
New-HPOVServerProfile -import -file C:\profiles\ServerProfile1.json
Basic Server Profile import.
-------------------------- EXAMPLE 11 --------------------------
(Get-Content C:\profiles\ServerProfile1.json) -join "`n" | New-HPOVServerProfile -import
Read the contents from ServerProfile1.json, join each line into a single object, and pipe to New-HPOVServerProfile to import.
-------------------------- EXAMPLE 12 --------------------------
$jsonProfiles = Get-ChildItem C:\profiles*.json

$jsonProfiles | foreach-object { New-HPOVServerProfile -import -file $_.fullname }
Retrieve list of all JSON files in C:\profiles, then pass each file and its full path to New-HPOVServerProfile.
Related Links
Top

Unassign or Reassign an existing Server Profile.
SYNTAX
New-HPOVServerProfileAssign [-ServerProfile] <Object> [-Server] <Object>[ [-Force] <SwitchParameter>][ [-Async]
<SwitchParameter>] [-ApplianceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
New-HPOVServerProfileAssign [-ServerProfile] <Object>[ [-Unassigned] <SwitchParameter>][ [-Force] <SwitchParamet
er>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>
]
This cmdlet is used to unassign or reassign an existing HPE OneView Server Profile. The destination Server and its Server
Hardware Type does not need to match the original Server Hardware Type defined in the Server Profile. The Server Profile will
be updated accordingly.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? False
Position? named
Default value False
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Use to force add the Server Profile if there are any async task validation failures, like server hardware is in a Warning or Failed
state, or SAN attach volume only have a single path configured.
Aliases None
Required? False
Position? named
Default value
-Server <Object>
The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call,
and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name.s
Aliases None
Required? true
Position? named
Default value
Aliases [-Profile]
The name or object of the server profile resource to modify assignment.
Aliases Profile
Required? true
Position? named
Default value
Siwtch parameter to unassign a Server Profile.
Aliases None
Required? false
Position? named
Default value False
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile "Profile 1" | New-HPOVServerProfileAssign -Server "Encl1, Bay 10" | Wait-HPOVTaskComplete
Get "Profile 1" Server Profile and assign it to "Encl1, Bay 10", then wait for the async task to complete.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile "Profile 1" | New-HPOVServerProfileAssign -unassign | Wait-HPOVTaskComplete
Get "Profile 1" Server Profile and unassign it, then wait for the async task to complete. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVServerProfileAssign
Unassign or Reassign an existing Server Profile. ### SYNTAX
New-HPOVServerProfileAssign [-ServerProfile] <Object> [-Server] <Object>[ [-Force] <SwitchParameter>][ [-Async]

<SwitchParameter>] [-ApplianceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
New-HPOVServerProfileAssign [-ServerProfile] <Object>[ [-Unassigned] <SwitchParameter>][ [-Force] <SwitchParamet

er>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [-WhatIf] <> [-Confirm] <> [<CommonParameters>
]
This cmdlet is used to unassign or reassign an existing HPE OneView Server Profile. The destination Server and its Server
Hardware Type does not need to match the original Server Hardware Type defined in the Server Profile. The Server Profile will
be updated accordingly.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? False
Position? named
Default value False
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Use to force add the Server Profile if there are any async task validation failures, like server hardware is in a Warning or Failed
state, or SAN attach volume only have a single path configured.
Aliases None
Required? False
Position? named
Default value
-Server <Object>
The server hardware resource where the new profile is to be applied. This is normally retrieved with a 'Get-HPOVServer' call,
and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name.s
Aliases None
Required? true
Position? named
Default value
Aliases [-Profile]
The name or object of the server profile resource to modify assignment.
Aliases Profile
Required? true
Position? named
Default value
Siwtch parameter to unassign a Server Profile.
Aliases None
Required? false
Position? named
Default value False
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile 'Profile 1' | New-HPOVServerProfileAssign -Server 'Encl1, Bay 10' | Wait-HPOVTaskComplete
Get 'Profile 1' Server Profile and assign it to 'Encl1, Bay 10', then wait for the async task to complete.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile 'Profile 1' | New-HPOVServerProfileAssign -unassign | Wait-HPOVTaskComplete
Get 'Profile 1' Server Profile and unassign it, then wait for the async task to complete.
Related Links
Top

Create volume attachment for a server profile.
SYNTAX
New-HPOVServerProfileAttachVolume [-Volume] <Array> [-VolumeID] <Int32> [-LunIdType] <String>[ [-BootVolume] <Sw
itchParameter>][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-ApplianceConnection]
New-HPOVServerProfileAttachVolume [-Name] <Object> [-ServerProfile] <Object>[ [-PassThru] <SwitchParameter>] [-V

olumeID] <Int32>[ [-VolumeTemplate] <Object>] [-StoragePool] <Object> [-SnapshotStoragePool] <Object> [-StorageS
ystem] <Object> [-Capacity] <Int64>[ [-ProvisioningType] <String>][ [-Full] <SwitchParameter>][ [-Permanent] <Sw
itchParameter>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization] <Bool>] [-LunIdType] <String> [
-LunID] <Int32> [-HostOStype] <String>[ [-BootVolume] <SwitchParameter>][ [-TargetPortAssignment] <SwitchParamet
er>][ [-TargetAddresses] <Array>] [-ApplianceConnection] <Object> [<CommonParameters>]
New-HPOVServerProfileAttachVolume [-ServerProfile] <Object> [-Volume] <Array>[ [-PassThru] <SwitchParameter>] [-

VolumeID] <Int32> [-LunIdType] <String> [-LunID] <Int32> [-HostOStype] <String>[ [-BootVolume] <SwitchParameter>
][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-ApplianceConnection] <Object> [<Com
monParameters>]
This Cmdlet will assist with creating a Storage Volume object to then attach to a new Server Profile being created (New-
HPOVServerProfile), and attach either an existing Storage Volume (Get-HPOVStorageVolume) or new Ephemeral Volume to an
existing Server Profile (Get-HPOVServerProfile). If attempting to attach to an existing Server Profile, the HostOSType parameter
is required, and will enable SAN Management within the Server Profile, if the Server Hardware resource supports the feature.
Parameters
Aliases Appliance
Required? true
Position? named
-BootVolume <SwitchParameter>
Aliases [-Bootable]
Use to indicate this volume is a bootable device. When using this parameter, the Server Profile"s FC Connection(s)
BootVolumeSource parameter set to "ManagedVolume".
This parameter is only applicable with Private volumes.
Aliases Bootable
Required? false
Position? named
Default value False
-Capacity <Int64>
The requested Ephemeral Volume storage capacity in GB. e.g. 20 to specify 20GB.
Aliases None
Required? true
Position? named
Default value 0
-DataProtectionLevel <String>
Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are:
* NetworkRaid0None
* NetworkRaid5SingleParity
* NetworkRaid10Mirror2Way
* NetworkRaid6DualParity
Aliases None
Required? false
Position? named
Default value
-EnableAdaptiveOptimization <Bool>
Specify if HPE StoreVirtual volume Adaptive Optimization is enabled.
Aliases None
Required? False
Position? named
Default value
-Full <SwitchParameter>
DEPRECATED. This parameter is replaced by ProvisioningType.
Specify if the Ephemeral Volume provisioning type should be Thick. Default is Thin Volume.
Aliases None
Required? false
Position? named
Default value False
Aliases [-OS]
Specify the Host OS type, which will set the Host OS value when HPE OneView creates the Host object on the Storage System.
This parameter is only necessary if the Server Profile object does not have SAN Management enabled.
Accepted values:
* AIX = "AIX"
* Win2k8 = "Windows 2008/2008 R2"
* Win2k12 = "Windows 2012 / WS2012 R2"
* Exanet = "Exanet"
* HPUX11iv1 = "HP-UX (11i v1, 11i v2)"
* HPUX11iv2 = "HP-UX (11i v1, 11i v2)"
* SUSE = "SuSE (10.x, 11.x)"
* Inform = "InForm"
Aliases OS
Required? true
Position? named
Default value
-LunID <Int32>
The Host LUN ID numerical value that will be configured in the Volume export on the Storage System. Accepted range: 0-254
Aliases None
Required? true
Position? named
Default value 0
-LunIdType <String>
Aliases [-type] Specify Auto or Manual for the LUN ID assignment type. If Manual, use the -LunID parameter and provide a
numerical value.
Aliases type
Required? true
Position? named
Default value Auto

-Name <Object>
Ephemeral Storage Volume resource name.
Aliases None
Required? true
Position? named
Default value
-PassThru <SwitchParameter>
Aliases None
Required? False
Position? named
Default value False
-Permanent <SwitchParameter>
Specify if the Ephemeral Volume should be permanent.
Aliases None
Required? false
Position? named
Default value False
-ProvisioningType <String>
Specify the volume provisioning type. Supported values:
* Thin
* Full
* ThinDeduplication (only supported with HPE StoreServe)
Aliases None
Required? False
Position? named
Default value Thin

An existing Server Profile resource object from Get-HPOVServerProfile Cmdlet.
Aliases None
Required? true
Position? named
Default value
-SnapshotStoragePool <Object>
The supported Snapshot storage pool for a StoreServ storage system. Snapshot storage pool must originate from the same
storage system as the assigned storage pool.
Aliases None
Required? True
Position? named
Default value
-StoragePool <Object>
The Storage Resource Pool object to provision the Ephemeral Volume from.
Aliases None
Required? true
Position? named
Default value
If provided a StoragePool Resource Name, you must provide the StorageSystem name value if there are multiple Storage Pool
resources with the same name.
Aliases None
Required? true
Position? named
Default value

-TargetAddresses <Array>
An array of target Port ID(s) or WWN(s). Example: @("1:0:1", "1:2:1", "3:1:1", "4:0:0")
Aliases wwpns
Required? False
Position? named
Default value
-TargetPortAssignment <SwitchParameter>
Define whether host initiator port(s) should be mapped to target storage ports automatically or manually.
Aliases None
Required? False
Position? named
Default value
-Volume <Array>
The Volume Name, URI or Object to attach.
Aliases None
Required? true
Position? named
Default value
-VolumeID <Int32>
Aliases [-id] The numeric identifier for this volume. Does not pertain to exported LUN ID value on array.
Aliases id
Required? true
Position? named
Default value 1
-VolumeTemplate <Object>
For Ephemeral (private) volumes that should be provisioned from Storage Volume Templates. Provide a valid resource from
Get-HPOVStorageVolumeTemplate.
Aliases None
Required? False
Position? named
Default value
<CommonParameters>
Input Types
System.String
Storage Volume Name or URI
Storage Volume Resource object
Return Values
When attaching a one or more Storage Volumes to an existing Server Profile, an Appliance Async Task will be created
HPOneView.Profile.SanVolume [System.Management.Automation.PSCustomObject]
Returns a storage volume attachment object which may be used during profile creation.
Examples
-------------------------- EXAMPLE 1 --------------------------
$attachVolume = New-HPOVServerProfileAttachVolume -volumeid 1 -volume Volume1
Create a Volume Attach object that maps to the "Volume1" storage volume with an Auto assigned Host LUN ID.
-------------------------- EXAMPLE 2 --------------------------
$attachVolume = Get-HPOVStorageVolume Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1
Get the "Volume1" Storage Volume via the Get-HPOVStorageVolume Cmdlet, and pipe the resource object to the Get-
HPOVServerProfileAttachVolume Cmdlet.
-------------------------- EXAMPLE 3 --------------------------
$attachVolume = Get-HPOVStorageVolume Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1 -lunidtype manual

-lunid 1
Get the "Volume1" Storage Volume via the Get-HPOVStorageVolume Cmdlet, and pipe the resource object to the Get-
HPOVServerProfileAttachVolume Cmdlet, providing a manual Host LUN ID.
-------------------------- EXAMPLE 4 --------------------------

Get the "Volume1" and "SharedVolume1" Storage Volumes via the Get-HPOVStorageVolume Cmdlet, and pipe the resource
objects to the Get-HPOVServerProfileAttachVolume Cmdlet, saving to $attachVolumes array.
-------------------------- EXAMPLE 5 --------------------------
$storagepool = Get-HPOVStoragePool R1_FC

$sp = Get-HPOVServerProfile "chef-web01"
New-HPOVServerProfileAttachVolume -ServerProfile $sp -Name "Chef Web01 Vol 2" -StoragePool $storagepool | Wait-
HPOVTaskComplete
Attach a new 10Gb Ephemeral Volume to an existing Server Profile.

-------------------------- EXAMPLE 6 --------------------------
$sp = Get-HPOVServerProfile "chef-web01"

Get-HPOVStorageVolume "My New Volume 3" | New-HPOVServerProfileAttachVolume -ServerProfile $sp | Wait-HPOVTaskC
omplete
Attach an existing Storage Volume to a Server Profile.

-------------------------- EXAMPLE 7 --------------------------

$sp = Get-HPOVServerProfile "My Server Profile"
New-HPOVServerProfileAttachVolume -Name "My Server Profile Boot Vol" -ServerProfile $sp -StoragePool $storagepoo
l -Bootable | Wait-HPOVTaskComplete
Add a bootable volume to an existing Server Profile.

-------------------------- EXAMPLE 8 --------------------------
$SVT = Get-HPOVStorageVolumeTemplate -Name StoreServe4-TPDD-SVT -ErrorAction Stop

$StorageVolumeObject = New-HPOVServerProfileAttachVolume -Name "Template 3 Private Vol 1" -VolumeTemplate $SVT
Create a new ephemeral storage volume attachment, using a storage volume template. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVServerProfileAttachVolume
Create volume attachment for a server profile. ### SYNTAX
New-HPOVServerProfileAttachVolume [-Volume] <Array> [-VolumeID] <Int32> [-LunIdType] <String>[ [-BootVolume] <Sw

itchParameter>][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-ApplianceConnection]
New-HPOVServerProfileAttachVolume [-Name] <Object>[ [-VolumeTemplate] <Object>] [-ServerProfile] <Object>[ [-Pas

sThru] <SwitchParameter>] [-VolumeID] <Int32> [-Capacity] <Int64>[ [-ProvisioningType] <String>][ [-Full] <Switc
hParameter>][ [-Permanent] <SwitchParameter>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization] <
Bool>] [-LunIdType] <String> [-LunID] <Int32> [-HostOStype] <String>[ [-BootVolume] <SwitchParameter>][ [-Target
PortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-ApplianceConnection] <Object> [<CommonParamete
rs>]
New-HPOVServerProfileAttachVolume [-ServerProfile] <Object> [-Name] <Object> [-StoragePool] <Object>[ [-PassThru
] <SwitchParameter>] [-VolumeID] <Int32> [-StorageSystem] <Object> [-Capacity] <Int64>[ [-ProvisioningType] <Str
ing>][ [-Full] <SwitchParameter>][ [-Permanent] <SwitchParameter>][ [-DataProtectionLevel] <String>][ [-EnableAd
aptiveOptimization] <Bool>] [-LunIdType] <String> [-LunID] <Int32> [-HostOStype] <String>[ [-BootVolume] <Switch
Parameter>][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-ApplianceConnection] <Obj
ect> [<CommonParameters>]
New-HPOVServerProfileAttachVolume [-ServerProfile] <Object> [-Volume] <Array>[ [-PassThru] <SwitchParameter>] [-

VolumeID] <Int32> [-LunIdType] <String> [-LunID] <Int32> [-HostOStype] <String>[ [-BootVolume] <SwitchParameter>
][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-ApplianceConnection] <Object> [<Com
monParameters>]
New-HPOVServerProfileAttachVolume [-Name] <Object> [-StoragePool] <Object> [-LunIdType] <String> [-LunID] <Int32

> [-VolumeID] <Int32> [-StorageSystem] <Object> [-Capacity] <Int64>[ [-ProvisioningType] <String>][ [-Full] <Swi
tchParameter>][ [-Permanent] <SwitchParameter>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization]
<Bool>][ [-BootVolume] <SwitchParameter>][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array
>] [-ApplianceConnection] <Object> [<CommonParameters>]
New-HPOVServerProfileAttachVolume [-Name] <Object> [-StoragePool] <Object> [-VolumeID] <Int32> [-StorageSystem]

<Object> [-Capacity] <Int64>[ [-ProvisioningType] <String>][ [-Full] <SwitchParameter>][ [-Permanent] <SwitchPar
ameter>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization] <Bool>] [-LunIdType] <String>[ [-BootV
olume] <SwitchParameter>][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-ApplianceCo
New-HPOVServerProfileAttachVolume [-Volume] <Array> [-LunIdType] <String> [-LunID] <Int32> [-VolumeID] <Int32>[

[-BootVolume] <SwitchParameter>][ [-TargetPortAssignment] <SwitchParameter>][ [-TargetAddresses] <Array>] [-Appl
ianceConnection] <Object> [<CommonParameters>]
New-HPOVServerProfileAttachVolume[ [-Permanent] <SwitchParameter>][ [-EnableAdaptiveOptimization] <Bool>] [<Comm

onParameters>]
New-HPOVServerProfileAttachVolume[ [-Permanent] <SwitchParameter>][ [-EnableAdaptiveOptimization] <Bool>] [<Comm

onParameters>]
This Cmdlet will assist with creating a Storage Volume object to then attach to a new Server Profile being created (New-
HPOVServerProfile), and attach either an existing Storage Volume (Get-HPOVStorageVolume) or new Ephemeral Volume to an
existing Server Profile (Get-HPOVServerProfile). If attempting to attach to an existing Server Profile, the HostOSType parameter
is required, and will enable SAN Management within the Server Profile, if the Server Hardware resource supports the feature.
Parameters
Aliases Appliance
Required? true
Position? named
-BootVolume <SwitchParameter>
Aliases [-Bootable]
Use to indicate this volume is a bootable device. When using this parameter, the Server Profile's FC Connection(s)
BootVolumeSource parameter set to 'ManagedVolume'.
This parameter is only applicable with Private volumes.
Aliases Bootable
Required? false
Position? named
Default value False
-Capacity <Int64>
The requested Ephemeral Volume storage capacity in GB. e.g. 20 to specify 20GB.
Aliases None
Required? true
Position? named
Default value 0
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value
-EnableAdaptiveOptimization <Bool>
Specify if HPE StoreVirtual volume Adaptive Optimization is enabled.
Aliases None
Required? False
Position? named
Default value
DEPRECATED. This parameter is replaced by ProvisioningType.
Specify if the Ephemeral Volume provisioning type should be Thick. Default is Thin Volume.
Aliases None
Required? false
Position? named
Default value False
Aliases [-OS]
Specify the Host OS type, which will set the Host OS value when HP OneView creates the Host object on the Storage System.
This parameter is only necessary if the Server Profile object does not have SAN Management enabled.
Accepted values:

* AIX = "AIX"
* Win2k8 = "Windows 2008/2008 R2"
* Win2k12 = "Windows 2012 / WS2012 R2"
* Exanet = "Exanet"
* HPUX11iv1 = "HP-UX (11i v1, 11i v2)"
* HPUX11iv2 = "HP-UX (11i v1, 11i v2)"
* SUSE = "SuSE (10.x, 11.x)"
* Inform = "InForm"
Aliases OS
Required? true
Position? named
Default value
-LunID <Int32>
The Host LUN ID numerical value that will be configured in the Volume export on the Storage System. Accepted range: 0-254
Aliases None
Required? true
Position? named
Default value 0
-LunIdType <String>
Aliases [-type] Specify Auto or Manual for the LUN ID assignment type. If Manual, use the -LunID parameter and provide a
numerical value.
Aliases type
Required? true
Position? named
Default value Auto
-Name <Object>
Ephemeral Storage Volume resource name.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False

-Permanent <SwitchParameter>
Specify if the Ephemeral Volume should be permanent.
Aliases None
Required? false
Position? named
Default value False
Specify the volume provisioning type. Supported values:
* Thin
* Full
* ThinDeduplication (only supported with HPE StoreServe)
Aliases None
Required? False
Position? named
Default value Thin
An existing Server Profile resource object from Get-HPOVServerProfile Cmdlet.
Aliases None
Required? true
Position? named
Default value
The Storage Resource Pool object to provision the Ephemeral Volume from.
Aliases None
Required? true
Position? named
Default value

If provided a StoragePool Resource Name, you must provide the StorageSystem name value if there are multiple Storage Pool
resources with the same name.
Aliases None
Required? true
Position? named
Default value
-TargetAddresses <Array>
An array of target Port ID(s) or WWN(s). Example: @('1:0:1', '1:2:1', '3:1:1', '4:0:0')
Aliases wwpns
Required? False
Position? named
Default value
-TargetPortAssignment <SwitchParameter>
Define whether host initiator port(s) should be mapped to target storage ports automatically or manually.
Aliases None
Required? False
Position? named
Default value
-Volume <Array>
The Volume Name, URI or Object to attach.
Aliases None
Required? true
Position? named
Default value
-VolumeID <Int32>
Aliases [-id] The numeric identifier for this volume. Does not pertain to exported LUN ID value on array.
Aliases id
Required? true
Position? named
Default value 1
For Ephemeral (private) volumes that should be provisioned from Storage Volume Templates. Provide a valid resource from
Get-HPOVStorageVolumeTemplate.
Aliases None
Required? False
Position? named
Default value
<CommonParameters>
Input Types
System.String
Storage Volume Name or URI
Storage Volume Resource object
Return Values
When attaching a one or more Storage Volumes to an existing Server Profile, an Appliance Async Task will be created
HPOneView.Profile.SanVolume [System.Management.Automation.PSCustomObject]
Returns a storage volume attachment object which may be used during profile creation.
Examples
-------------------------- EXAMPLE 1 --------------------------
$attachVolume = New-HPOVServerProfileAttachVolume -volumeid 1 -volume Volume1
Create a Volume Attach object that maps to the 'Volume1' storage volume with an Auto assigned Host LUN ID.
-------------------------- EXAMPLE 2 --------------------------
$attachVolume = Get-HPOVStorageVolume Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1
Get the 'Volume1' Storage Volume via the Get-HPOVStorageVolume Cmdlet, and pipe the resource object to the Get-
HPOVServerProfileAttachVolume Cmdlet.
-------------------------- EXAMPLE 3 --------------------------
$attachVolume = Get-HPOVStorageVolume Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1 -lunidtype manual

-lunid 1
Get the 'Volume1' Storage Volume via the Get-HPOVStorageVolume Cmdlet, and pipe the resource object to the Get-
HPOVServerProfileAttachVolume Cmdlet, providing a manual Host LUN ID.
-------------------------- EXAMPLE 4 --------------------------

Get the 'Volume1' and 'SharedVolume1' Storage Volumes via the Get-HPOVStorageVolume Cmdlet, and pipe the resource
objects to the Get-HPOVServerProfileAttachVolume Cmdlet, saving to $attachVolumes array.
-------------------------- EXAMPLE 5 --------------------------

$sp = Get-HPOVServerProfile 'chef-web01'
New-HPOVServerProfileAttachVolume -ServerProfile $sp -Name 'Chef Web01 Vol 2' -StoragePool $storagepool | Wait-
HPOVTaskComplete
Attach a new 10Gb Ephemeral Volume to an existing Server Profile.
-------------------------- EXAMPLE 6 --------------------------
$sp = Get-HPOVServerProfile 'chef-web01'

Get-HPOVStorageVolume 'My New Volume 3' | New-HPOVServerProfileAttachVolume -ServerProfile $sp | Wait-HPOVTaskC
omplete
Attach an existing Storage Volume to a Server Profile.
-------------------------- EXAMPLE 7 --------------------------

$sp = Get-HPOVServerProfile 'My Server Profile'
New-HPOVServerProfileAttachVolume -Name 'My Server Profile Boot Vol' -ServerProfile $sp -StoragePool $storagepoo
l -Bootable | Wait-HPOVTaskComplete
Add a bootable volume to an existing Server Profile.

-------------------------- EXAMPLE 8 --------------------------
$SVT = Get-HPOVStorageVolumeTemplate -Name StoreServe4-TPDD-SVT -ErrorAction Stop

$StorageVolumeObject = New-HPOVServerProfileAttachVolume -Name 'Template 3 Private Vol 1' -VolumeTemplate $SVT
Create a new ephemeral storage volume attachment, using a storage volume template.
Related Links
Top

Create network connection for a server profile.
SYNTAX
New-HPOVServerProfileConnection [-ConnectionID] <Int32> [-Network] <Object>[ [-ConnectionType] <String>] [-PortI
d] <String>[ [-Name] <String>][ [-RequestedBW] <Int32>][ [-UserDefined] <SwitchParameter>][ [-MAC] <String>][ [-
Bootable] <SwitchParameter>][ [-LagName] <String>] [-BootVolumeSource] <String>[ [-Priority] <String>][ [-Applia
nceConnection] <Object>] [<CommonParameters>]

Bootable] <SwitchParameter>][ [-LagName] <String>] [-BootVolumeSource] <String>[ [-Priority] <String>][ [-LUN] <
Int32>][ [-IscsiIPv4AddressSource] <String>][ [-ISCSIInitatorName] <String>][ [-IscsiIPv4Address] <IPAddress>][
[-IscsiIPv4SubnetMask] <String>][ [-IscsiIPv4Gateway] <IPAddress>][ [-IscsiBootTargetIqn] <String>] [-IscsiPrima
ryBootTargetAddress] <IPAddress>[ [-IscsiPrimaryBootTargetPort] <Int32>][ [-IscsiSecondaryBootTargetAddress] <IP
Address>][ [-IscsiSecondaryBootTargetPort] <Int32>][ [-IscsiAuthenticationProtocol] <String>][ [-ChapName] <Stri
ng>][ [-ChapSecret] <SecureString>][ [-MutualChapName] <String>][ [-MutualChapSecret] <SecureString>][ [-Applian

WWNN] <String>][ [-WWPN] <String>][ [-Bootable] <SwitchParameter>][ [-LagName] <String>] [-BootVolumeSource] <St
ring>[ [-Priority] <String>][ [-TargetWwpn] <String>][ [-LUN] <Int32>][ [-ApplianceConnection] <Object>] [<Commo
nParameters>]

Virtualfunctions] <Int32>][ [-Bootable] <SwitchParameter>][ [-LagName] <String>][ [-Priority] <String>][ [-Appli
anceConnection] <Object>] [<CommonParameters>]
A helper function to assist with connections when creating (New-HPOVServerProfile) or editing (Set-HPOVProfile) a server
profile.
Parameters
Aliases Appliance
Required? false
Position? named
-BootVolumeSource <String>
Specify how the Boot Volume Source will be set. Allowed values are:
* AdapterBIOS - Boot from adapter BIOS volume parameters.

* ManagedVolume - Boot from a managed volume defined in SAN Storage section.
* UserDefined - Boot from user defined volume parameters.
Default: AdapterBIOS
Aliases None
Required? true
Position? named
Default value AdapterBIOS
-Bootable <SwitchParameter>
Specify to configure bootable settings. If omitted, then the connection is not bootable, and -priority is set to NotBootable.
Default: False
Aliases None
Required? false
Position? named
Default value False
-ChapName <String>
The CHAP challange name.
Aliases None
Required? false
Position? named
Default value
and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a
Server Profile Template.
Aliases None
Required? false
Position? named
Default value
-ConnectionID <Int32>
Aliases [-id] The numeric identifier for this connection. Connections are normally numbered sequentially from 1 within each
profile.
Aliases id
Required? true
Position? named
Default value 1
-ConnectionType <String>
Aliases [-type] Deprecated parameter. Connection type is now derived from the provided Network resource object.
Aliases type
Required? false
Position? named
If configuring a Connection for a Server Profile Template, the value will be ignored
Aliases None
Required? false
Position? named
Default value
-IscsiAuthenticationProtocol <String>
Specify the Authentication protocol to use. Allowed values are None, CHAP, MutualCHAP. When creating a Server Profile
Connection for a Server Profile Template, the CHAP and Mutual CHAP credential parameters are ignored. They will be enforced
when creating a Server Profile from a Server Profile Template.
Aliases None
Required? false
Position? named
Default value
-IscsiBootTargetIqn <String>
The IQN of the target iSCSI host.
Aliases None
Required? false
Position? named
Default value
-IscsiIPv4Address <IPAddress>
The IPv4 Address to allocate for the initiator. This parameter value is ignored when assiging the Connection to a Server Profile
Template. It will be enforced when creating a Server Profile from a Server Profile Template.
Aliases None
Required? false
Position? named
Default value
-IscsiIPv4AddressSource <String>
Specify the IPv4 Address Source for the connection. Allowed values are:
* DHCP
* UserDefined
* SubnetPool
Aliases None
Required? false
Position? named
Default value
-IscsiIPv4Gateway <IPAddress>
The IPv4 Gateway.
Aliases None
Required? false
Position? named
Default value
-IscsiIPv4SubnetMask <String>
The IPv4 Subnet Mask in full or CIDR bit value.
Aliases None
Required? false
Position? named
Default value
-IscsiPrimaryBootTargetAddress <IPAddress>
The Primary Boot Target IPv4 Address.
Aliases None
Required? true
Position? named
Default value
-IscsiPrimaryBootTargetPort <Int32>
The Primary Boot Target TCP Port. Default is 3260 if not otherwise specified.
Aliases None
Required? false
Position? named
Default value 3260
-IscsiSecondaryBootTargetAddress <IPAddress>
The Secondary Boot Target IPv4 Address.
Aliases None
Required? false
Position? named
Default value
-IscsiSecondaryBootTargetPort <Int32>
The Secondary Boot Target TCP Port. Default is 3260 if not otherwise specified.
Aliases None
Required? false
Position? named
Default value 3260
-LUN <Int32>
Target LUN ID, if BootVolumeSource is set to UserDefined.
Aliases None
Required? false
Position? named
Default value 0
-LagName <String>
Specify the LAG Name for a Synergy Ethernet connection. Allowed value is "LAG1" - "LAG24".
Aliases None
Required? false
Position? named
Default value
-MAC <String>
Requested MAC address of the connection. Must be specified if setting WWPN and WWNN, and the connection is mapped to a
FlexHBA.
Aliases None
Required? false
Position? named
Default value
-MutualChapName <String>
The Mutual CHAP challange.
Aliases None
Required? false
Position? named
Default value
12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a
Aliases None
Required? false
Position? named
Default value
-Name <String>
A string used to identify the respective connection. The connection name is case insensitive, limited to 63 characters and must
be unique within the profile.
Aliases None
Required? false
Position? named
Default value
-Network <Object>
The Network (Ethernet or Fibre Channel) or Network Set resource object to be used with this connection. Can either be the
Name, URI, or object obtained with Get-HPOVNetwork or Get-HPOVNetworkSet.
Aliases None
Required? true
Position? named
Default value
-PortId <String>
Identifies the port (FlexNIC) used for this connection. The port can be automatically selected by specifying "Auto" when creating
the connection. "None" is a valid portID for an unconfigured, and unmapped Connection. If you wish to specify the specific port,
the portId format is "[adapter_type_prefix] [adapter_id]:[subport_id]".
G7 only: For LOM ports, the valid portId prefix will be "Lom" Gen8 only: For FlexLOMs, the valid portId prefix will be "Flb"
Mezzanine adapter prefix is "Mezz"
An example of a FlexLOM 1, FlexNIC 1a interface would be "Flb 1:1a". An example Mezzanine 2, FlexNIC 2c interface would be
"Mezz 2:2c"
Aliases None
Required? true
Position? named
Default value Auto
-Priority <String>
Optional boot option for this connection, but Required if -bootable is specified. Allowed values:
* NotBootable
* UseBIOS
* Primary
* Secondary
* IscsiPrimary
* IscsiSecondary
When the Connection Type is Ethernet, this affects PXE boot. If the Connection Type is FibreChannel, this enables BfS settings.
Default: NotBootable
Aliases None
Required? false
Position? named
Default value NotBootable
-RequestedBW <Int32>
Requested bandwidth (in Mbps) to be used for this connection.
Default: 2500
Aliases None
Required? false
Position? named
Default value 2500
-TargetWwpn <String>
Aliases [-ArrayWwpn]
Target FC array WWPN.
Aliases ArrayWwpn
Required? false
Position? named
Default value
-UserDefined <SwitchParameter>
Use to specify user defined address values
Aliases None
Required? false
Position? named
Default value False
-Virtualfunctions <Int32>
Specify the number of Virtual Functions to enable on an Ethernet Connection. Must be in increments of 16.
Aliases None
Required? false
Position? named
Default value 0
-WWNN <String>
Requested WWNN address of the connection.
Aliases None
Required? false
Position? named
Default value
-WWPN <String>
Requested WWPN address of the connection.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Returns a connection object which may be used during profile creation with the New-HPOVServerProfile CMDLET
Examples
-------------------------- EXAMPLE 1 --------------------------
$net41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop

$con41 = New-HPOVServerProfileConnection -ConnectionID 1 -ConnectionType Ethernet -Network $net41
Create a Network Connection ID 1, that is assigned to Net41 network, with Auto Port assignment.
-------------------------- EXAMPLE 2 --------------------------
$con41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 1
-------------------------- EXAMPLE 3 --------------------------
$con41 = Get-HPOVNetwork -Name "FCoE Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID
1 -ConnectionType FibreChannel
Create a Network Connection ID 1, that is assigned to the FCoE network "FCoE Fabric A", with Auto Port assignment.
-------------------------- EXAMPLE 4 --------------------------

$con42 = New-HPOVServerProfileConnection -ConnectionID 2 -ConnectionType Ethernet -network $net42 -bootable -pri
ority Primary
Create a Server Profile Connection ID 2, assigned to Net42 that is PXE Primary bootable.
-------------------------- EXAMPLE 5 --------------------------
$conFabricA = Get-HPOVNetwork "Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 3 -Co

nnectionType FibreChannel -bootable -priority Primary -Bootable
Create a Server Profile Connection ID 3, assigned to Fabric A that is FC BfS Primary bootable.
-------------------------- EXAMPLE 6 --------------------------
$con41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 1 -Co

nnectionType Ethernet -userdefined -mac 11:22:33:44:55:66 -name "VLAN41 Prod Net"
Create a Network Connection ID 1, that is assigned to Net41 network, with Auto Port assignment and custom MAC Address.
-------------------------- EXAMPLE 7 --------------------------
$con41 = Get-HPOVNetwork -Name "Fabric A" | New-HPOVServerProfileConnection -ConnectionID 3 -ConnectionType Fib

reChannel -userdefined -mac 11:22:33:44:55:66 -wwpn 10:00:00:00:a1:55:1b:8f -wwnn 20:00:00:00:a1:55:1b:8f -name
"VC FF Fabric A Connection"
Create a Network Connection ID 3, that is assigned to a FibreChannel network, with Auto Port assignment and user defined
hardware address values.
-------------------------- EXAMPLE 8 --------------------------
$con41 = Get-HPOVNetwork -Name "Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 3 -

ConnectionType FibreChannel -userdefined -mac 11:22:33:44:55:66 -wwpn 10:00:00:00:a1:55:1b:8f -wwnn 20:00:00:00:
a1:55:1b:8f -name "VC FF Fabric A Connection"
-------------------------- EXAMPLE 9 --------------------------
$ISCSINetwork = Get-HPOVNetwork -Name "ImageStreamer Boot Network" -ErrorAction Stop

$IscsiParams = @{
ConnectionID = 1;
Name = "ImageStreamer Connection 1";
ConnectionType = "Ethernet";
Network = $ISCSINetwork;
Bootable = $true;
Priority = "Primary";
IscsiIPv4AddressSource = "SubnetPool"
}
$ImageStreamerBootConnection1 = New-HPOVServerProfileConnection @IscsiParams
Create an HPE Synergy Image Streamer compliant connection. ### Related Links * [Get-HPOVServerProfileConnectionList]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileConnectionList) ***
Top
### HPE OneView 4.00 Library ## New-HPOVServerProfileConnection
Create network connection for a server profile. ### SYNTAX

Bootable] <SwitchParameter>][ [-LagName] <String>] [-BootVolumeSource] <String>[ [-Priority] <String>][ [-Applia

Bootable] <SwitchParameter>][ [-LagName] <String>] [-BootVolumeSource] <String>[ [-Priority] <String>][ [-LUN] <
Int32>][ [-IscsiIPv4AddressSource] <String>][ [-ISCSIInitatorName] <String>][ [-IscsiIPv4Address] <IPAddress>][
[-IscsiIPv4SubnetMask] <String>][ [-IscsiIPv4Gateway] <IPAddress>][ [-IscsiBootTargetIqn] <String>] [-IscsiPrima
ryBootTargetAddress] <IPAddress>[ [-IscsiPrimaryBootTargetPort] <Int32>][ [-IscsiSecondaryBootTargetAddress] <IP
Address>][ [-IscsiSecondaryBootTargetPort] <Int32>][ [-IscsiAuthenticationProtocol] <String>][ [-ChapName] <Stri
ng>][ [-ChapSecret] <SecureString>][ [-MutualChapName] <String>][ [-MutualChapSecret] <SecureString>][ [-Applian

WWNN] <String>][ [-WWPN] <String>][ [-Bootable] <SwitchParameter>][ [-LagName] <String>] [-BootVolumeSource] <St
ring>[ [-Priority] <String>][ [-TargetWwpn] <String>][ [-LUN] <Int32>][ [-ApplianceConnection] <Object>] [<Commo
nParameters>]

Virtualfunctions] <Int32>][ [-Bootable] <SwitchParameter>][ [-LagName] <String>][ [-Priority] <String>][ [-Appli
anceConnection] <Object>] [<CommonParameters>]
A helper function to assist with connections when creating (New-HPOVServerProfile) or editing (Set-HPOVProfile) a server
profile.
Parameters
Aliases Appliance
Required? false
Position? named
-BootVolumeSource <String>
Specify how the Boot Volume Source will be set. Allowed values are:
* AdapterBIOS - Boot from adapter BIOS volume parameters.

* ManagedVolume - Boot from a managed volume defined in SAN Storage section.
* UserDefined - Boot from user defined volume parameters.
Default: AdapterBIOS
Aliases None
Required? true
Position? named
Default value AdapterBIOS
-Bootable <SwitchParameter>
Specify to configure bootable settings. If omitted, then the connection is not bootable, and -priority is set to NotBootable.
Default: False
Aliases None
Required? false
Position? named
Default value False
-ChapName <String>
The CHAP challange name.
Aliases None
Required? false
Position? named
Default value
and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a
Aliases None
Required? false
Position? named
Default value
-ConnectionID <Int32>
Aliases [-id] The numeric identifier for this connection. Connections are normally numbered sequentially from 1 within each
profile.
Aliases id
Required? true
Position? named
Default value 1
-ConnectionType <String>
Aliases [-type] Deprecated parameter. Connection type is now derived from the provided Network resource object.
Aliases type
Required? false
Position? named
If configuring a Connection for a Server Profile Template, the value will be ignored
Aliases None
Required? false
Position? named
Default value
-IscsiAuthenticationProtocol <String>
Specify the Authentication protocol to use. Allowed values are None, CHAP, MutualCHAP. When creating a Server Profile
Connection for a Server Profile Template, the CHAP and Mutual CHAP credential parameters are ignored. They will be enforced
when creating a Server Profile from a Server Profile Template.
Aliases None
Required? false
Position? named
Default value
-IscsiBootTargetIqn <String>
The IQN of the target iSCSI host.
Aliases None
Required? false
Position? named
Default value
-IscsiIPv4Address <IPAddress>
The IPv4 Address to allocate for the initiator. This parameter value is ignored when assiging the Connection to a Server Profile
Template. It will be enforced when creating a Server Profile from a Server Profile Template.
Aliases None
Required? false
Position? named
Default value
-IscsiIPv4AddressSource <String>
Specify the IPv4 Address Source for the connection. Allowed values are:
* DHCP
* UserDefined
* SubnetPool
Aliases None
Required? false
Position? named
Default value

-IscsiIPv4Gateway <IPAddress>
The IPv4 Gateway.
Aliases None
Required? false
Position? named
Default value
-IscsiIPv4SubnetMask <String>
The IPv4 Subnet Mask in full or CIDR bit value.
Aliases None
Required? false
Position? named
Default value
-IscsiPrimaryBootTargetAddress <IPAddress>
The Primary Boot Target IPv4 Address.
Aliases None
Required? true
Position? named
Default value
-IscsiPrimaryBootTargetPort <Int32>
The Primary Boot Target TCP Port. Default is 3260 if not otherwise specified.
Aliases None
Required? false
Position? named
Default value 3260
-IscsiSecondaryBootTargetAddress <IPAddress>
The Secondary Boot Target IPv4 Address.

Aliases None
Required? false
Position? named
Default value
-IscsiSecondaryBootTargetPort <Int32>
The Secondary Boot Target TCP Port. Default is 3260 if not otherwise specified.
Aliases None
Required? false
Position? named
Default value 3260
-LUN <Int32>
Target LUN ID, if BootVolumeSource is set to UserDefined.
Aliases None
Required? false
Position? named
Default value 0
-LagName <String>
Specify the LAG Name for a Synergy Ethernet connection. Allowed value is 'LAG1' - 'LAG24'.
Aliases None
Required? false
Position? named
Default value
-MAC <String>
Requested MAC address of the connection. Must be specified if setting WWPN and WWNN, and the connection is mapped to a
FlexHBA.
Aliases None
Required? false
Position? named
Default value
-MutualChapName <String>
The Mutual CHAP challange.
Aliases None
Required? false
Position? named
Default value
12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a
Aliases None
Required? false
Position? named
Default value
-Name <String>
A string used to identify the respective connection. The connection name is case insensitive, limited to 63 characters and must
be unique within the profile.
Aliases None
Required? false
Position? named
Default value
-Network <Object>
The Network (Ethernet or Fibre Channel) or Network Set resource object to be used with this connection. Can either be the
Name, URI, or object obtained with Get-HPOVNetwork or Get-HPOVNetworkSet.
Aliases None
Required? true
Position? named
Default value
-PortId <String>
Identifies the port (FlexNIC) used for this connection. The port can be automatically selected by specifying 'Auto' when creating
the connection. 'None' is a valid portID for an unconfigured, and unmapped Connection. If you wish to specify the specific port,
the portId format is "[adapter_type_prefix] [adapter_id]:[subport_id]".
G7 only: For LOM ports, the valid portId prefix will be "Lom" Gen8 only: For FlexLOMs, the valid portId prefix will be "Flb"
Mezzanine adapter prefix is "Mezz"
An example of a FlexLOM 1, FlexNIC 1a interface would be "Flb 1:1a". An example Mezzanine 2, FlexNIC 2c interface would be
"Mezz 2:2c"
Aliases None
Required? true
Position? named
Default value Auto
-Priority <String>
Optional boot option for this connection, but Required if -bootable is specified. Allowed values:
* NotBootable
* UseBIOS
* Primary
* Secondary
* IscsiPrimary
* IscsiSecondary
When the Connection Type is Ethernet, this affects PXE boot. If the Connection Type is FibreChannel, this enables BfS settings.
Default: NotBootable
Aliases None
Required? false
Position? named
Default value NotBootable
-RequestedBW <Int32>
Requested bandwidth (in Mbps) to be used for this connection.

Default: 2500
Aliases None
Required? false
Position? named
Default value 2500
-TargetWwpn <String>
Aliases [-ArrayWwpn]
Target FC array WWPN.
Aliases ArrayWwpn
Required? false
Position? named
Default value
-UserDefined <SwitchParameter>
Use to specify user defined address values
Aliases None
Required? false
Position? named
Default value False
-Virtualfunctions <Int32>
Specify the number of Virtual Functions to enable on an Ethernet Connection. Must be in increments of 16.
Aliases None
Required? false
Position? named
Default value 0
-WWNN <String>
Requested WWNN address of the connection.

Aliases None
Required? false
Position? named
Default value
-WWPN <String>
Requested WWPN address of the connection.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Returns a connection object which may be used during profile creation with the New-HPOVServerProfile CMDLET
Examples
-------------------------- EXAMPLE 1 --------------------------

$con41 = New-HPOVServerProfileConnection -ConnectionID 1 -ConnectionType Ethernet -Network $net41
-------------------------- EXAMPLE 2 --------------------------
$con41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 1
-------------------------- EXAMPLE 3 --------------------------
$con41 = Get-HPOVNetwork -Name "FCoE Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID
1 -ConnectionType FibreChannel
Create a Network Connection ID 1, that is assigned to the FCoE network 'FCoE Fabric A', with Auto Port assignment.
-------------------------- EXAMPLE 4 --------------------------

$con42 = New-HPOVServerProfileConnection -ConnectionID 2 -ConnectionType Ethernet -network $net42 -bootable -pri
ority Primary
Create a Server Profile Connection ID 2, assigned to Net42 that is PXE Primary bootable.
-------------------------- EXAMPLE 5 --------------------------
$conFabricA = Get-HPOVNetwork "Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 3 -Co

nnectionType FibreChannel -bootable -priority Primary -Bootable
Create a Server Profile Connection ID 3, assigned to Fabric A that is FC BfS Primary bootable.
-------------------------- EXAMPLE 6 --------------------------
$con41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 1 -Co

nnectionType Ethernet -userdefined -mac 11:22:33:44:55:66 -name "VLAN41 Prod Net"
Create a Network Connection ID 1, that is assigned to Net41 network, with Auto Port assignment and custom MAC Address.
-------------------------- EXAMPLE 7 --------------------------
$con41 = Get-HPOVNetwork -Name 'Fabric A' | New-HPOVServerProfileConnection -ConnectionID 3 -ConnectionType Fib

reChannel -userdefined -mac 11:22:33:44:55:66 -wwpn 10:00:00:00:a1:55:1b:8f -wwnn 20:00:00:00:a1:55:1b:8f -name
"VC FF Fabric A Connection"
-------------------------- EXAMPLE 8 --------------------------
$con41 = Get-HPOVNetwork -Name 'Fabric A' -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 3 -

ConnectionType FibreChannel -userdefined -mac 11:22:33:44:55:66 -wwpn 10:00:00:00:a1:55:1b:8f -wwnn 20:00:00:00:
a1:55:1b:8f -name "VC FF Fabric A Connection"
-------------------------- EXAMPLE 9 --------------------------
$ISCSINetwork = Get-HPOVNetwork -Name "ImageStreamer Boot Network" -ErrorAction Stop

$IscsiParams = @{
ConnectionID = 1;
Name = "ImageStreamer Connection 1";
ConnectionType = "Ethernet";
Network = $ISCSINetwork;
Bootable = $true;
Priority = "Primary";
IscsiIPv4AddressSource = "SubnetPool"
}
$ImageStreamerBootConnection1 = New-HPOVServerProfileConnection @IscsiParams
Create an HPE Synergy Image Streamer compliant connection.
Related Links
Top

Create Server Profile Logical Disk object.
SYNTAX
New-HPOVServerProfileLogicalDisk [-Name] <String>[ [-RAID] <String>][ [-NumberofDrives] <Int32>][ [-DriveType] <
String>][ [-StorageLocation] <String>][ [-Accelerator] <String>][ [-Bootable] <Boolean>] [<CommonParameters>]

String>][ [-DriveSelectionBy] <String>][ [-AvailableDriveType] <HPOneView.Storage.AvailableDriveType>][ [-Storag
eLocation] <String>] [-MinDriveSize] <Int32>[ [-MaxDriveSize] <Int32>][ [-EraseDataOnDelete] <SwitchParameter>][
[-Bootable] <Boolean>] [<CommonParameters>]
This helper CMDLET will create a Logical Disk object to then be assigned to a Server Profile Template or Server Profile using
the -LogicalDisk parameter. The LogicalDisk configuration is supported with the embedded (or Slot 0) HPE SmartArray controller
for DL and BL class systems only.
Parameters
-Accelerator <String>
For Gen10 Smart Array controllers only. When using Auto for drive type allocation and supplied 'Enabled', the Accelorator policy
will be set to 'ControllerCache'. If drive allocation type is an 'SSD' drive, the accelorator policy will be set to 'IOBypass'. Disabled
will set the accelorator policy to 'None'. Default is 'Unmanaged'.
Aliases None
Required? false
Position? named
Default value Unmanaged
-AvailableDriveType <HPOneView.Storage.AvailableDriveType>
A specific availabe drive type from Get-HPOVAvailableDriveType.
Aliases None
Required? false
Position? named
Default value
-Bootable <Boolean>
Indicates if the logical drive is bootable or not. Cannot be combined with an FC or FCoE Server Profile Connection that is also
set as Bootable. Parameter is not valid with defining Synergy JBOD SAS disk policies.
Aliases None
Required? false
Position? named
Default value False
-DriveSelectionBy <String>
Use to specify how the drive selection will be used. Allowed values:
* DriveType - Use Get-HPOVAvailableDriveType to locate available drive types, quantity to which SAS Logical Int
erconnect or Drive Enclosure.
* SizeAndTechnology - Use to define the attributes of the drive based on technology and min/max drive size. Th
e -DriveType and -MinDriveSize parameters are required.
Default: SizeAndTechnology
Aliases None
Required? false
Position? named
Default value SizeAndTechnology

-DriveType <String>
Defines the interface type for drives that will be used to build the logical drive. Supported values depend on the local storage
capabilities of the selected server hardware type. Allowed value:
* SAS
*SATA
*SASSSD
*SATASSD
*Auto
NOTE: Auto is not supported when attempting to create an HPE Synergy D3940 Logical or JBOD disk. You must specify a disk
technology type unless -DriveSelectionBy is changed to DriveType and -AvailableDriveType is used. Allowed values are:
* SAS
* SATA
* SASSSD
* SATASSD
* NVMeSas
* NVMeSata
* Auto
Aliases None
Required? false
Position? named
Default value Auto
-EraseDataOnDelete <SwitchParameter>
Indicates if the logical drive should be erased when it is deleted from or with the Server Profile.
Aliases None
Required? false
Position? named
Default value False
-MaxDriveSize <Int32>
Only for HPE Synergy D3940. If the parameter is not specified, the MinDriveSize parameter value will be used.
Aliases None
Required? false
Position? named
Default value 0
-MinDriveSize <Int32>
Only for HPE Synergy D3940. Specify the minimum size disk to request. Required when -DriveSelectionBy is set to
SizeAndTechnology.
Aliases None
Required? true
Position? named
Default value 0
-Name <String>
Logical Disk name. Must be unique within the Server Profile.
Aliases None
Required? true
Position? named
Default value
-NumberofDrives <Int32>
The number of physical drives to be used to build the logical drive. The provided values must be consistent with the selected
RAID level and cannot exceed the maximum supported number of drives for the selected server hardware type.
Aliases None
Required? false
Position? named
Default value 2
-RAID <String>
The RAID level of the logical drive. Supported values depend on the local storage capabilities of the selected server hardware
type.
Only RAID0 and RAID1 are supported for embedded BL disk policies. RAID5, RAID6, RAID10 are supported with DL servers with
SmartArray controller that supports the RAID type. RAID0, RAID1ADM, RAID10, RAID5, and RAID6 are supported values with
HPE Synergy D3940 disk shelf.
Aliases None
Required? false
Position? named
Default value RAID1

-StorageLocation <String>
Specify Internal for HPE Synergy Compute Nodes that have the Expanded Storage option connected to an available mezzanine
SmartArray controller for NVMe drives. DriveType parameter then must be set to NVMeSata or NVMeSAS. Use External to
specify storage will be allocated from the D3940 disk shelf.
Aliases None
Required? false
Position? named
Default value External
<CommonParameters>
Input Types
An available disk drive type from Get-HPOVAvailableDriveType Cmdlet.
Return Values
Logical Disk configuration object
System.Collections.ArrayList<System.Management.Automation.PSCustomObject>
Collection of Logical Disk configuration objects
Examples
-------------------------- EXAMPLE 1 --------------------------
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "MyDisk"
Create a default Logical Disk configuration object.

-------------------------- EXAMPLE 2 --------------------------
$ld1 = New-HPOVServerProfileLogicalDisk -Name "Boot Disk" -RAID RAID1 -NumberofDrives 2 -Bootable $True
Create a custom Logical Disk with the provided parameter values.

-------------------------- EXAMPLE 3 --------------------------
$ld1 = New-HPOVServerProfileLogicalDisk -Name "Boot Disk" -RAID RAID1 -NumberofDrives 2 -DriveType SAS -MinDrive
Size 300 -Bootable $True
Create a custom HPE Synergy D3940 bootable RAID Logical Disk with the provided parameter values.
-------------------------- EXAMPLE 4 --------------------------
$AvailableDriveType = Get-HPOVSasLogicalInterconnect -Name "LE1-Default SAS Synergy LIG-3" -ErrorAction Stop | G

et-HPOVAvailableDriveType | ? { $_.Type -eq "SASHDD" -and $_.capacity -eq 900 }
$NewLogicalDisk = New-HPOVServerProfileLogicalDisk -Name "LD1_RAID5_900GB_SASHDD" -DriveSelectionBy DriveType -N
umberofDrives 6 -RAID RAID5 -AvailableDriveType $AvailableDriveType
Create a RAID5 Logical Disk for a Server Profile using D3940 storage, and a specific available drive type, 900GB capacity and
SASHDD type.
-------------------------- EXAMPLE 5 --------------------------
$JBODLogicalDisk = New-HPOVServerProfileLogicalDisk -Name "JBOD1_900GB_SASHDD" -NumberofDrives 6 -MinDriveSize 9

00 -DriveType SAS
Create logical JBOD to then be attached to either a Gen10 Mixed Mode or Gen9 or newer HBA mode controller. ### Related
Links * [New-HPOVServerProfileLogicalDiskController](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVServerProfileLogicalDiskController) ***
Top
### HPE OneView 4.00 Library ## New-HPOVServerProfileLogicalDisk
Create Server Profile Logical Disk object. ### SYNTAX

String>][ [-StorageLocation] <String>][ [-Bootable] <Boolean>] [<CommonParameters>]

String>][ [-DriveSelectionBy] <String>][ [-AvailableDriveType] <HPOneView.Storage.AvailableDriveType>][ [-Storag
eLocation] <String>] [-MinDriveSize] <Int32>[ [-MaxDriveSize] <Int32>][ [-EraseDataOnDelete] <SwitchParameter>][
[-Bootable] <Boolean>] [<CommonParameters>]
This helper CMDLET will create a Logical Disk object to then be assigned to a Server Profile Template or Server Profile using
the -LogicalDisk parameter. The LogicalDisk configuration is supported with the embedded (or Slot 0) HPE SmartArray controller
for DL and BL class systems only.
Parameters
-AvailableDriveType <HPOneView.Storage.AvailableDriveType>
A specific availabe drive type from Get-HPOVAvailableDriveType.
Aliases None
Required? false
Position? named
Default value
-Bootable <Boolean>
Indicates if the logical drive is bootable or not. Cannot be combined with an FC or FCoE Server Profile Connection that is also
set as Bootable. Parameter is not valid with defining Synergy JBOD SAS disk policies.
Aliases None
Required? false
Position? named
Default value False
-DriveSelectionBy <String>
Use to specify how the drive selection will be used. Allowed values:
* DriveType - Use Get-HPOVAvailableDriveType to locate available drive types, quantity to which SAS Logical Int
erconnect or Drive Enclosure.
* SizeAndTechnology - Use to define the attributes of the drive based on technology and min/max drive size. Th
e -DriveType and -MinDriveSize parameters are required.
Default: SizeAndTechnology
Aliases None
Required? false
Position? named
Default value SizeAndTechnology
-DriveType <String>
Defines the interface type for drives that will be used to build the logical drive. Supported values depend on the local storage
capabilities of the selected server hardware type. Allowed value:
* SAS
*SATA
*SASSSD
*SATASSD
*Auto
NOTE: Auto is not supported when attempting to create an HPE Synergy D3940 Logical or JBOD disk. You must specify a disk
technology type unless -DriveSelectionBy is changed to DriveType and -AvailableDriveType is used. Allowed values are:
* SAS
* SATA
* SASSSD
* SATASSD
* NVMeSas
* NVMeSata
* Auto
Aliases None
Required? false
Position? named
Default value Auto
-EraseDataOnDelete <SwitchParameter>
Indicates if the logical drive should be erased when it is deleted from or with the Server Profile.
Aliases None
Required? false
Position? named
Default value False
-MaxDriveSize <Int32>
Only for HPE Synergy D3940. If the parameter is not specified, the MinDriveSize parameter value will be used.
Aliases None
Required? false
Position? named
Default value 0
-MinDriveSize <Int32>
Only for HPE Synergy D3940. Specify the minimum size disk to request. Required when -DriveSelectionBy is set to
SizeAndTechnology.
Aliases None
Required? true
Position? named
Default value 0
-Name <String>
Logical Disk name. Must be unique within the Server Profile.
Aliases None
Required? true
Position? named
Default value
-NumberofDrives <Int32>
The number of physical drives to be used to build the logical drive. The provided values must be consistent with the selected
RAID level and cannot exceed the maximum supported number of drives for the selected server hardware type.
Aliases None
Required? false
Position? named
Default value 2
-RAID <String>
The RAID level of the logical drive. Supported values depend on the local storage capabilities of the selected server hardware
type.
Only RAID0 and RAID1 are supported for embedded BL disk policies. RAID5, RAID6, RAID10 are supported with DL servers with
SmartArray controller that supports the RAID type. RAID0, RAID1ADM, RAID10, RAID5, and RAID6 are supported values with
HPE Synergy D3940 disk shelf.
Aliases None
Required? false
Position? named
Default value RAID1
-StorageLocation <String>
Specify Internal for HPE Synergy Compute Nodes that have the Expanded Storage option connected to an available mezzanine
SmartArray controller for NVMe drives. DriveType parameter then must be set to NVMeSata or NVMeSAS. Use External to
specify storage will be allocated from the D3940 disk shelf.
Aliases None
Required? false
Position? named
Default value External
<CommonParameters>
Input Types
An available disk drive type from Get-HPOVAvailableDriveType Cmdlet.
Return Values
Logical Disk configuration object

System.Collections.ArrayList<System.Management.Automation.PSCustomObject>
Collection of Logical Disk configuration objects
Examples
-------------------------- EXAMPLE 1 --------------------------
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name 'MyDisk'
Create a default Logical Disk configuration object.
-------------------------- EXAMPLE 2 --------------------------
$ld1 = New-HPOVServerProfileLogicalDisk -Name 'Boot Disk' -RAID RAID1 -NumberofDrives 2 -Bootable $True
Create a custom Logical Disk with the provided parameter values.
-------------------------- EXAMPLE 3 --------------------------
$ld1 = New-HPOVServerProfileLogicalDisk -Name 'Boot Disk' -RAID RAID1 -NumberofDrives 2 -DriveType SAS -MinDrive
Size 300 -Bootable $True
Create a custom HPE Synergy D3940 bootable RAID Logical Disk with the provided parameter values.
-------------------------- EXAMPLE 4 --------------------------
$AvailableDriveType = Get-HPOVSasLogicalInterconnect -Name 'LE1-Default SAS Synergy LIG-3' -ErrorAction Stop | G

et-HPOVAvailableDriveType | ? { $.Type -eq 'SASHDD' -and $.capacity -eq 900 }
$NewLogicalDisk = New-HPOVServerProfileLogicalDisk -Name 'LD1_RAID5_900GB_SASHDD' -DriveSelectionBy DriveType -N
SASHDD type..
Related Links
Top

Create Server Profile disk controller policy object.
SYNTAX
New-HPOVServerProfileLogicalDiskController [-ControllerID] <Object> [-Mode] <String>[ [-Initialize] <SwitchParam
eter>][ [-WriteCache] <String>] [-LogicalDisk] <Object> [<CommonParameters>]

eter>][ [-WriteCache] <String>][ [-ImportExistingConfiguration] <SwitchParameter>] [<CommonParameters>]
This helper CMDLET will create a Logical Disk controller object to then be assigned to a Server Profile Template or Server
Profile using the -LogicalDisk parameter.
Parameters
-ControllerID <Object>
Specify the Controller ID location. Supported options for this parameter are
* Embedded
* Mezz 1
* Mezz 2
* Mezz 3
Please note that Mezz 1, Mezz 2 and Mezz 3 are only supported with HPE Synergy Compute nodes connected to the HPE
Synergy D3940 disk shelf.
Aliases None
Required? true
Position? named
Default value Embedded
-ImportExistingConfiguration <SwitchParameter>
Specify to import any found Logical Disk configuration and add to the Server Profile as the Logical Disk policy. This option is not
available for Server Profile Templates. Not supported when ControllerID is "Mezz 1", "Mezz 2", or "Mezz 3".
Aliases None
Required? false
Position? named
Default value False
-Initialize <SwitchParameter>
Use this parameter to re-initialize the controller. This will wipe any existing logical disk configured for the controller and deploy
the new policy defined. Not supported when ControllerID is "Mezz 1", "Mezz 2", or "Mezz 3".
Aliases None
Required? false
Position? named
Default value False

-LogicalDisk <Object>
A collection of Logical Disk objects from the New-HPOVServerProfileLogicalDisk Cmdlet.
Aliases None
Required? true
Position? named
Default value
-Mode <String>
The mode to configure the Smart Array Controller as. Accepted values are:
* HBA
* RAID
When specifying HBA, you cannot attach a RAID Logical Disk to this policy.
Aliases None
Required? true
Position? named
Default value RAID
-WriteCache <String>
For Gen10 controllers, to enable, disable or unmanage controller write cache policy. Allowed values:
* Enabled
* Disabled
* Unmanaged
Default value: Unmanaged
Aliases None
Required? false
Position? named
Default value Unmanaged
<CommonParameters>
Input Types
HPOneView.ServerProfile.LogicalDisk [System.Management.Automation.PSCustomObject]
Logical Disk configuration policy from New-HPOVServerProfileLogicalDisk
System.Collections.ArrayList <HPOneView.ServerProfile.LogicalDisk>
Collection of Logical Disk configuration policy from New-HPOVServerProfileLogicalDisk
Return Values
HPOneView.ServerProfile.Controller [System.Management.Automation.PSCustomObject]
Server Profile Controller configuration object
System.Collections.ArrayList <HPOneView.ServerProfile.Controller>
Collection of Server Profile Controller configuration objects
Examples
-------------------------- EXAMPLE 1 --------------------------
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "MyDisk" | New-HPOVServerProfileLogicalDiskController -Ini

tialize
Create a default Logical Disk and Controller configuration object policy.

-------------------------- EXAMPLE 2 --------------------------
New-HPOVServerProfileLogicalDiskController -Mode HBA
Create an HBA controller policy, which will then set the controller to JBOD mode.
-------------------------- EXAMPLE 3 --------------------------
$LogicalDisk1 = New-HPOVServerProfileLogicalDisk -Name "MyDisk"

$LogicalDisk2 = New-HPOVServerProfileLogicalDisk -Name "MyDisk2"
$Controller = New-HPOVServerProfileLogicalDiskController -Initialize -LogicalDisk $LogicalDisk1,$LogicalDisk2

-------------------------- EXAMPLE 4 --------------------------
$LogicalDisk1 = New-HPOVServerProfileLogicalDisk -Name Boot -RAID RAID1 -MinDriveSize 300 -MaxDriveSize 300 -Dri
veType SAS -Bootable $True
$LogicalDisk2 = New-HPOVServerProfileLogicalDisk -Name Data -RAID RAID5 -NumberofDrives 5 -MinDriveSize 300 -Max
DriveSize 300 -DriveType SAS
$Controller = New-HPOVServerProfileLogicalDiskController -ControllerID "Mezz 1" -Mode RAID -LogicalDisk $Logical
Disk1,$LogicalDisk2
Create a HPE Synergy D3940 RAID disk policy, with a bootable volume.
-------------------------- EXAMPLE 5 --------------------------
$AvailableDriveType = Get-HPOVSasLogicalInterconnect -Name "LE1-Default SAS Synergy LIG-3" -ErrorAction Stop | G

et-HPOVAvailableDriveType | ? { $_.Type -eq "SASHDD" -and $_.capacity -eq 900 }
$NewLogicalDisk = New-HPOVServerProfileLogicalDisk -Name "LD1_RAID5_900GB_SASHDD" -DriveSelectionBy DriveType -N
C:\> $Controller = New-HPOVServerProfileLogicalDiskController -ControllerID "Mezz 1" -Mode RAID -LogicalDisk $Ne
wLogicalDisk
SASHDD type, and assign it to a new Controller. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVServerProfileLogicalDiskController
Create Server Profile disk controller policy object. ### SYNTAX

eter>] [-LogicalDisk] <Object> [<CommonParameters>]

eter>][ [-ImportExistingConfiguration] <SwitchParameter>] [<CommonParameters>]
This helper CMDLET will create a Logical Disk controller object to then be assigned to a Server Profile Template or Server
Profile using the -LogicalDisk parameter.
Parameters
-ControllerID <Object>
Specify the Controller ID location. Supported options for this parameter are
* Embedded
* Mezz 1
* Mezz 2
* Mezz 3
Please note that Mezz 1, Mezz 2 and Mezz 3 are only supported with HPE Synergy Compute nodes connected to the HPE
Synergy D3940 disk shelf.
Aliases None
Required? true
Position? named
Default value Embedded
-ImportExistingConfiguration <SwitchParameter>
Specify to import any found Logical Disk configuration and add to the Server Profile as the Logical Disk policy. This option is not
available for Server Profile Templates. Not supported when ControllerID is 'Mezz 1', 'Mezz 2', or 'Mezz 3'.
Aliases None
Required? false
Position? named
Default value False
-Initialize <SwitchParameter>
Use this parameter to re-initialize the controller. This will wipe any existing logical disk configured for the controller and deploy
the new policy defined. Not supported when ControllerID is 'Mezz 1', 'Mezz 2', or 'Mezz 3'.
Aliases None
Required? false
Position? named
Default value False
-LogicalDisk <Object>
A collection of Logical Disk objects from the New-HPOVServerProfileLogicalDisk Cmdlet.
Aliases None
Required? true
Position? named
Default value
-Mode <String>
The mode to configure the Smart Array Controller as. Accepted values are:
* HBA
* RAID
When specifying HBA, you cannot attach a RAID Logical Disk to this policy.
Aliases None
Required? true
Position? named
Default value RAID
<CommonParameters>
Input Types
HPOneView.ServerProfile.LogicalDisk [System.Management.Automation.PSCustomObject]
Logical Disk configuration policy from New-HPOVServerProfileLogicalDisk
System.Collections.ArrayList <HPOneView.ServerProfile.LogicalDisk>
Collection of Logical Disk configuration policy from New-HPOVServerProfileLogicalDisk
Return Values
HPOneView.ServerProfile.Controller [System.Management.Automation.PSCustomObject]
Server Profile Controller configuration object
System.Collections.ArrayList <HPOneView.ServerProfile.Controller>
Collection of Server Profile Controller configuration objects
Examples
-------------------------- EXAMPLE 1 --------------------------
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name 'MyDisk' | New-HPOVServerProfileLogicalDiskController -Ini

tialize
-------------------------- EXAMPLE 2 --------------------------
New-HPOVServerProfileLogicalDiskController -Mode HBA
Create an HBA controller policy, which will then set the controller to JBOD mode.
-------------------------- EXAMPLE 3 --------------------------
$LogicalDisk1 = New-HPOVServerProfileLogicalDisk -Name 'MyDisk'

$LogicalDisk2 = New-HPOVServerProfileLogicalDisk -Name 'MyDisk2'
$Controller = New-HPOVServerProfileLogicalDiskController -Initialize -LogicalDisk $LogicalDisk1,$LogicalDisk2
-------------------------- EXAMPLE 4 --------------------------
$LogicalDisk1 = New-HPOVServerProfileLogicalDisk -Name Boot -RAID RAID1 -MinDriveSize 300 -MaxDriveSize 300 -Dri
veType SAS -Bootable $True
$LogicalDisk2 = New-HPOVServerProfileLogicalDisk -Name Data -RAID RAID5 -NumberofDrives 5 -MinDriveSize 300 -Max
DriveSize 300 -DriveType SAS
$Controller = New-HPOVServerProfileLogicalDiskController -ControllerID 'Mezz 1' -Mode RAID -LogicalDisk $Logical
Disk1,$LogicalDisk2
Create a HPE Synergy D3940 RAID disk policy, with a bootable volume.
-------------------------- EXAMPLE 5 --------------------------
$AvailableDriveType = Get-HPOVSasLogicalInterconnect -Name 'LE1-Default SAS Synergy LIG-3' -ErrorAction Stop | G

et-HPOVAvailableDriveType | ? { $.Type -eq 'SASHDD' -and $.capacity -eq 900 }
$NewLogicalDisk = New-HPOVServerProfileLogicalDisk -Name 'LD1_RAID5_900GB_SASHDD' -DriveSelectionBy DriveType -N
C:> $Controller = New-HPOVServerProfileLogicalDiskController -ControllerID 'Mezz 1' -Mode RAID -LogicalDisk $New
LogicalDisk
SASHDD type, and assign it to a new Controller.
Related Links
Top

Create a Server Profile Template
SYNTAX
New-HPOVServerProfileTemplate [-Name] <String> [-ServerHardwareType] <Object>[ [-Description] <String>][ [-Serve
rProfileDescription] <String>][ [-ManageConnections] <Boolean>][ [-Connections] <Array>][ [-EnclosureGroup] <Obj
ect>][ [-Firmware] <SwitchParameter>][ [-FirmwareInstallMode] <String>][ [-FirmwareActivationMode] <String>][ [-
Baseline] <Object>][ [-ForceInstallFirmware] <SwitchParameter>][ [-OSDeploymentPlan] <Object>][ [-OSDeploymentPl
anAttributes] <Array>][ [-Bios] <SwitchParameter>][ [-BiosSettings] <Array>][ [-BootMode] <String>][ [-PxeBootPo
licy] <String>][ [-ManageBoot] <SwitchParameter>][ [-BootOrder] <Array>][ [-SecureBoot] <String>][ [-LocalStorag
e] <SwitchParameter>][ [-StorageController] <Object>][ [-Affinity] <String>][ [-MacAssignment] <String>][ [-WwnA
ssignment] <String>][ [-SnAssignment] <String>][ [-IscsiInitiatorNameAssignmet] <string>][ [-HideUnusedFlexNics]
<Boolean>][ [-Async] <SwitchParameter>][ [-PassThru] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Comm
onParameters>]
New-HPOVServerProfileTemplate [-Name] <String> [-ServerHardwareType] <Object>[ [-SANStorage] <SwitchParameter>][

[-HostOStype] <String>][ [-StorageVolume] <Object>][ [-Description] <String>][ [-ServerProfileDescription] <Stri
ng>][ [-ManageConnections] <Boolean>][ [-Connections] <Array>][ [-EnclosureGroup] <Object>][ [-Firmware] <Switch
Parameter>][ [-FirmwareInstallMode] <String>][ [-FirmwareActivationMode] <String>][ [-Baseline] <Object>][ [-For
ceInstallFirmware] <SwitchParameter>][ [-OSDeploymentPlan] <Object>][ [-OSDeploymentPlanAttributes] <Array>][ [-
Bios] <SwitchParameter>][ [-BiosSettings] <Array>][ [-BootMode] <String>][ [-PxeBootPolicy] <String>][ [-ManageB
oot] <SwitchParameter>][ [-BootOrder] <Array>][ [-SecureBoot] <String>][ [-LocalStorage] <SwitchParameter>][ [-S
torageController] <Object>][ [-EvenPathDisabled] <SwitchParameter>][ [-OddPathDisabled] <SwitchParameter>][ [-Af
finity] <String>][ [-MacAssignment] <String>][ [-WwnAssignment] <String>][ [-SnAssignment] <String>][ [-IscsiIni
tiatorNameAssignmet] <string>][ [-HideUnusedFlexNics] <Boolean>][ [-Async] <SwitchParameter>][ [-PassThru] <Swit
chParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet is used to create or import an HPE OneView Server Profile Template.
A Server Profile Template is the parent configuration for a Server Profile instance. Server profiles capture the entire server
configuration in one place, enabling you to consistently replicate new server profiles and to rapidly modify them to reflect
changes in your data center.
A Server Profile Template includes:
* Basic server identification information

* Firmware versions
* SAN storage settings
* BIOS settings
* Boot order
When you create a server profile template, it is designated for a server hardware type and enclosure group (for server blades).
$bl460cgen9sht = Get-HPOVServerHardwareType "BL460c Gen9 1"
The "biosSettings" Array property will be available (only with supported Server Hardware Types; i.e. BL460c Gen8 or newer). To
$biosSettings = $bl460cgen9sht.biosSettings | ? { $_.name -match "power" }
The code example above will return all matching BIOS Settings where the name contains "power". The found BIOS settings
object(s) are then saved into $biosSettings. Update the "value" property accordingly, and you can then pass $biosSettings
Parameters
-Affinity <String>
Accepted values are either "Bay" or "BayAndServer". Default is "Bay".
Aliases None
Required? false
Position? named
Default value Bay
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value false
-Baseline <Object>
Aliases None
Required? false
Position? named
Default value
G7 servers.)
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value @()
-BootMode <String>

* UEFI
* UEFIOptimized
* BIOS
* Unmanaged
PXE boot policy.
Default: BIOS
Aliases None
Required? false
Position? named
Default value BIOS
-BootOrder <Array>
values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible
values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one
value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible
values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order
Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order:
"CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"
Aliases None
Required? false
Position? named
Default value @()
created with "New-HPOVServerProfileConnection".
)
}
Physical
UserDefined
Virtual
Physical
UserDefined
Virtual
}
Aliases None
Required? false
Position? named
Default value @()
Optional description for this server profile template.
Aliases None
Required? false
Position? named
Default value
Aliases [-eg] The Enclosure Group resource the Server Profile Template will be bound to. When assigning to an Enclosure
Group, OneView will then determine what farbic connectivity and storage devices are available.
Aliases eg
Required? false
Position? named
Default value
Aliases [-even]
Aliases Even
Required? false
Position? named
Default value False
G7 servers.)
Aliases None
Required? false
Position? named
Default value False
ware only)
Aliases None
Required? false
Position? named

ate Tools.
Smart Update Tools.
* FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardwar
e to be powered down.
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value True

Aliases [-OS]
Optional. Specify the Host OS type, which will set the Host OS value when HPE OneView created the Host object on the Storage

* AIX = "AIX"
* Win2k8 = "Windows 2008/2008 R2"
* Win2k12 = "Windows 2012 / WS2012 R2"
* Exanet = "Exanet"
* HPUX11iv1 = "HP-UX (11i v1, 11i v2)"
* HPUX11iv2 = "HP-UX (11i v1, 11i v2)"
* SUSE = "SuSE (10.x, 11.x)"
* Inform = "InForm"
Aliases OS
Required? false
Position? named
Default value
-IscsiInitiatorNameAssignmet <string>
Specify if the iSCSI initiator name should be automatically managed and assigned, or a custom value should be used. Allowed
values: Virtual UserDefined Default Value: Virtual
Aliases None
Required? false
Position? named
Enable local storage settings to be managed on the server.

Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Aliases [-boot]
Default: $True
Aliases boot
Required? false
Position? named
Default value False
-ManageConnections <Boolean>
Use this parameter to specify if Connections should be tracked from the Server Profile Template for compliance. If set to False,
the -Connections parameter will be ignored, and Connections must be set and managed at the Server Profile.
Aliases None
Required? false
Position? named
Default value True
-Name <String>
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-OSDeploymentPlanAttributes <Array>
Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute. You will need to group required NIC
parameters together based on needed values.
Aliases None
Required? false
Position? named
Default value
Aliases [-odd]
Aliases Odd
Required? false
Position? named
Default value False
Use this parameter to return the modified Server Profile Template object. In order to save the changes, please use the Save-
HPOVServerProfileTemplate Cmdlet.
Aliases None
Required? false
Position? named
Default value
* Auto
* IPv4 only
* IPv6 only
* IPv4 then IPv6
* IPv6 then IPv4
and any new network boot targets will be added to the end of the list using the System ROM"s default policy.
Default: Auto
Aliases None
Required? false
Position? named
Default value Auto
Aliases None
Required? false
Position? named
Default value False
'UEFI Optimized'.
Aliases None
Required? false
Position? named
Default value
Aliases [-sht] The Server Hardware Type reource the Server Profile Template will be bound to.
Aliases sht
Required? true
Position? named
Default value
-ServerProfileDescription <String>
Optional description for created server profiles from this template.
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
A resource object containing the StorageController, LogicalDisk or SasJbod configuration. Please refer to the New-
HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController Cmdlets.
Aliases LogicalDisk
Required? false
Position? named
Default value
values:
[System.String]volumeStoragePoolUri - URI to HPE OneView managed Storage Pool [System.String]volumeStorageSystemUri -
URI to HPE OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC
}
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
<CommonParameters>
Input Types
System.String
Return Values
HPOneVIew.ServerProfileTemplate [System.Management.Automation.PSCustomObject]
When using the -PassThru parameter, the created server profile template object is returned.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Name = "HP ProLiant BL460 Gen9 Profile Template"

$con1 = Get-HPOVNetwork "Net 41-A" | New-HPOVServerProfileConnection -connectionId 1
$con2 = Get-HPOVNetwork "Net 41-B" | New-HPOVServerProfileConnection -connectionId 2
$eg = Get-HPOVEnclosureGroup "Default EG1"
$params = @{
>> name = $Name;
>> serverHardwareType = $bl460SHT;
>> enclosureGroup = $eg;
>> connections = $con1, $con2;
>> ManageBoot = $True;
>> BootMode = "UEFI";
>> ApplianceConnection = "MyAppliance1.domain.com"
>>}
>>
New-HPOVServerProfileTemplate @params | Wait-HPOVTaskComplete

-------------------------- EXAMPLE 2 --------------------------
$net41 = Get-HPOVNetwork "Net-41"

$con41 = New-HPOVServerProfileConnection -network $net41 -connectionType Ethernet -connectionId 1
$task = New-HPOVServerProfileTemplate -name $Name -serverHardwareType "bl460c Gen8 1" -enclosureGroup "Productio
n Encl Grp1" -connections $conList | Wait-HPOVTaskComplete
Create a server profile template which includes networks "Net-41" and "Net-42".
-------------------------- EXAMPLE 3 --------------------------
$profileName = "Hypervisor Cluster Node Template v1.0"

$enclosuregroup = Get-HPOVEnclosureGroup "Production EG1"
$con1 = Get-HPOVNetwork "Net 41-a" | New-HPOVServerProfileConnection -id 1
$con2 = Get-HPOVNetwork "Net 41-b" | New-HPOVServerProfileConnection -id 2
$con3 = Get-HPOVNetworkSet "Prod Networks A" | New-HPOVServerProfileConnection -id 3
$con5 = Get-HPOVNetwork "fabric a" | New-HPOVServerProfileConnection -id 5 -type FibreChannel -bootable -priori
ty Primary -arrayWWPn "21:11:00:02:AC:00:72:03" -LUN 0
$con6 = Get-HPOVNetwork "fabric b" | New-HPOVServerProfileConnection -id 6 -type FibreChannel -bootable -priori
ty Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0
$conList = $con1, $con2, $con3, $con4, $con5, $con6
$task = New-HPOVServerProfileTemplate -name $profileName -connections $conList -sht $bl460SHT -eg $enclosuregrou
p -ManageBoot | Wait-HPOVTaskComplete
Create a new Server Profile template with 6 Connections, 4 Ethernet (including Network Sets) and 2 Fibre Channel (with BfS
configured).
-------------------------- EXAMPLE 4 --------------------------
$profileName = "SQL DB Cluster Node Template v1.0"

nce Mode.
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "My Local Disk" -RAID RAID1 -NumberofDrives 2 -DiskType Sa
sSsd
$volume1 = Get-HPOVStorageVolume SharedVolume1 | New-HPOVServerProfileAttachVolume
$params = @{
>> connections = $con1, $con2, $con3, $con4;
>> bios = $true;
>> biossettings = $bl660bios
>> LogicalDisk = $LogicalDisk;
>> SANStorage = $True;
>> Ostype = "Win2k12";
>> StorageVolume = $volume1;
}
>>
Create a BL Gen9 UEFI Server Profile template with Ethernet and FC connections, local storage, SAN Storage and BIOS
Settings, then pipe to Wait-HPOVTaskComplete. ### Related Links * [Convert-HPOVServerProfileTemplate]
HPOneView/wiki/Get-HPOVServerProfileTemplate) * [Remove-HPOVServerProfileTemplate]
***
Top
### HPE OneView 4.00 Library ## New-HPOVServerProfileTemplate
Create a Server Profile Template ### SYNTAX
New-HPOVServerProfileTemplate [-Name] <String> [-ServerHardwareType] <Object>[ [-Description] <String>][ [-Serve

rProfileDescription] <String>][ [-ManageConnections] <Boolean>][ [-Connections] <Array>][ [-EnclosureGroup] <Obj
ect>][ [-Firmware] <SwitchParameter>][ [-FirmwareInstallMode] <String>][ [-FirmwareActivationMode] <String>][ [-
Baseline] <Object>][ [-ForceInstallFirmware] <SwitchParameter>][ [-OSDeploymentPlan] <Object>][ [-OSDeploymentPl
anAttributes] <Array>][ [-Bios] <SwitchParameter>][ [-BiosSettings] <Array>][ [-BootMode] <String>][ [-PxeBootPo
licy] <String>][ [-ManageBoot] <SwitchParameter>][ [-BootOrder] <Array>][ [-SecureBoot] <String>][ [-LocalStorag
e] <SwitchParameter>][ [-StorageController] <Object>][ [-Affinity] <String>][ [-MacAssignment] <String>][ [-WwnA
ssignment] <String>][ [-SnAssignment] <String>][ [-HideUnusedFlexNics] <Boolean>][ [-Async] <SwitchParameter>][
New-HPOVServerProfileTemplate [-Name] <String> [-ServerHardwareType] <Object>[ [-SANStorage] <SwitchParameter>][
[-HostOStype] <String>][ [-StorageVolume] <Object>][ [-Description] <String>][ [-ServerProfileDescription] <Stri
ng>][ [-ManageConnections] <Boolean>][ [-Connections] <Array>][ [-EnclosureGroup] <Object>][ [-Firmware] <Switch
Parameter>][ [-FirmwareInstallMode] <String>][ [-FirmwareActivationMode] <String>][ [-Baseline] <Object>][ [-For
ceInstallFirmware] <SwitchParameter>][ [-OSDeploymentPlan] <Object>][ [-OSDeploymentPlanAttributes] <Array>][ [-
Bios] <SwitchParameter>][ [-BiosSettings] <Array>][ [-BootMode] <String>][ [-PxeBootPolicy] <String>][ [-ManageB
oot] <SwitchParameter>][ [-BootOrder] <Array>][ [-SecureBoot] <String>][ [-LocalStorage] <SwitchParameter>][ [-S
torageController] <Object>][ [-EvenPathDisabled] <SwitchParameter>][ [-OddPathDisabled] <SwitchParameter>][ [-Af
finity] <String>][ [-MacAssignment] <String>][ [-WwnAssignment] <String>][ [-SnAssignment] <String>][ [-HideUnus
edFlexNics] <Boolean>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet is used to create or import an HP OneView Server Profile Template.
A Server Profile Template is the parent configuration for a Server Profile instance. Server profiles capture the entire server
configuration in one place, enabling you to consistently replicate new server profiles and to rapidly modify them to reflect
changes in your data center.
A Server Profile Template includes:
* Basic server identification information

* Firmware versions
* SAN storage settings
* BIOS settings
* Boot order
When you create a server profile template, it is designated for a server hardware type and enclosure group (for server blades).
$bl460cgen9sht = Get-HPOVServerHardwareType 'BL460c Gen9 1'
The 'biosSettings' Array property will be available (only with supported Server Hardware Types; i.e. BL460c Gen8 or newer). To
$biosSettings = $bl460cgen9sht.biosSettings | ? { $_.name -match "power" }
The code example above will return all matching BIOS Settings where the name contains 'power'. The found BIOS settings
object(s) are then saved into $biosSettings. Update the 'value' property accordingly, and you can then pass $biosSettings
Parameters
-Affinity <String>
Accepted values are either 'Bay' or 'BayAndServer'. Default is 'Bay'.
Aliases None
Required? false
Position? named
Default value Bay

Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value false
-Baseline <Object>
Aliases None
Required? false
Position? named
Default value
G7 servers.)
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value @()
-BootMode <String>
* UEFI
* UEFIOptimized
* BIOS
* Unmanaged
PXE boot policy.
Default: BIOS
Aliases None
Required? false
Position? named
Default value BIOS
-BootOrder <Array>
values are 'CD', 'Floppy', 'USB', 'HardDisk', and 'PXE'. For Gen9 BL server hardware in Legacy BIOS boot mode, the possible
values are 'CD', 'USB', 'HardDisk', and 'PXE'. For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one
value is allowed and must be either 'HardDisk' or 'PXE'. For Gen9 DL server hardware in Legacy BIOS boot mode, the possible
values are 'CD', 'USB', 'HardDisk', and 'PXE'. For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order
Gen7/8 BIOS Default Boot Order: 'CD','Floppy','USB','HardDisk','PXE' Gen9 Legacy BIOS Boot Order: 'CD','USB','HardDisk','PXE'
Gen9 UEFI Default Boot Order: 'HardDisk'
Aliases None
Required? false
Position? named
Default value @()
created with 'New-HPOVServerProfileConnection'.
)
}
Physical
UserDefined
Virtual
Physical
UserDefined
Virtual
}
Aliases None
Required? false
Position? named
Default value @()
Optional description for this server profile template.
Aliases None
Required? false
Position? named
Default value
Aliases [-eg] The Enclosure Group resource the Server Profile Template will be bound to. When assigning to an Enclosure
Group, OneView will then determine what farbic connectivity and storage devices are available.
Aliases eg
Required? false
Position? named
Default value
Aliases [-even]
Aliases Even
Required? false
Position? named
Default value False
G7 servers.)
Aliases None
Required? false
Position? named
Default value False

ware only)
Aliases None
Required? false
Position? named
ate Tools.
Smart Update Tools.
* FirmwareOffline - Manages the firmware through HP OneView. Selecting this option requires the server hardware
to be powered down.
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value True
Aliases [-OS]
Optional. Specify the Host OS type, which will set the Host OS value when HP OneView created the Host object on the Storage

* AIX = "AIX"
* Win2k8 = "Windows 2008/2008 R2"
* Win2k12 = "Windows 2012 / WS2012 R2"
* Exanet = "Exanet"
* HPUX11iv1 = "HP-UX (11i v1, 11i v2)"
* HPUX11iv2 = "HP-UX (11i v1, 11i v2)"
* SUSE = "SuSE (10.x, 11.x)"
* Inform = "InForm"
Aliases OS
Required? false
Position? named
Default value
Enable local storage settings to be managed on the server.
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Aliases [-boot]
Default: $True
Aliases boot
Required? false
Position? named
Default value False
-ManageConnections <Boolean>
Use this parameter to specify if Connections should be tracked from the Server Profile Template for compliance. If set to False,
the -Connections parameter will be ignored, and Connections must be set and managed at the Server Profile.
Aliases None
Required? false
Position? named
Default value True
-Name <String>
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-OSDeploymentPlanAttributes <Array>
Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute. You will need to group required NIC
parameters together based on needed values.
Aliases None
Required? false
Position? named
Default value
Aliases [-odd]
Aliases Odd
Required? false
Position? named
Default value False

* Auto
* IPv4 only
* IPv6 only
* IPv4 then IPv6
* IPv6 then IPv4
and any new network boot targets will be added to the end of the list using the System ROM's default policy.
Default: Auto
Aliases None
Required? false
Position? named
Default value Auto
Aliases None
Required? false
Position? named
Default value False
'UEFI Optimized'.
Aliases None
Required? false
Position? named
Default value
Aliases [-sht] The Server Hardware Type reource the Server Profile Template will be bound to.
Aliases sht
Required? true
Position? named
Default value
-ServerProfileDescription <String>
Optional description for created server profiles from this template.
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
A resource object containing the StorageController, LogicalDisk or SasJbod configuration. Please refer to the New-
HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController Cmdlets.
Aliases LogicalDisk
Required? false
Position? named
Default value
values:
[System.String]volumeStoragePoolUri - URI to HP OneView managed Storage Pool [System.String]volumeStorageSystemUri -
URI to HP OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC
}
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
<CommonParameters>
Input Types
System.String
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Name = "HP ProLiant BL460 Gen9 Profile Template"

$eg = Get-HPOVEnclosureGroup "Default EG1"
$params = @{
name = $Name;
serverHardwareType = $bl460SHT;
enclosureGroup = $eg;
connections = $con1, $con2;
ManageBoot = $True;
BootMode = 'UEFI';
ApplianceConnection = 'MyAppliance1.domain.com'
}
-------------------------- EXAMPLE 2 --------------------------

$task = New-HPOVServerProfileTemplate -name $Name -serverHardwareType "bl460c Gen8 1" -enclosureGroup "Productio
n Encl Grp1" -connections $conList | Wait-HPOVTaskComplete
Create a server profile template which includes networks 'Net-41' and 'Net-42'.
-------------------------- EXAMPLE 3 --------------------------
$profileName = 'Hypervisor Cluster Node Template v1.0'

$con1 = Get-HPOVNetwork "Net 41-a" | New-HPOVServerProfileConnection -id 1
$con2 = Get-HPOVNetwork "Net 41-b" | New-HPOVServerProfileConnection -id 2
$conList = $con1, $con2, $con3, $con4, $con5, $con6
$task = New-HPOVServerProfileTemplate -name $profileName -connections $conList -sht $bl460SHT -eg $enclosuregrou
p -ManageBoot | Wait-HPOVTaskComplete
Create a new Server Profile template with 6 Connections, 4 Ethernet (including Network Sets) and 2 Fibre Channel (with BfS
configured).
-------------------------- EXAMPLE 4 --------------------------
$profileName = 'SQL DB Cluster Node Template v1.0'


nce Mode.
$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name 'My Local Disk' -RAID RAID1 -NumberofDrives 2 -DiskType Sa
sSsd
$volume1 = Get-HPOVStorageVolume SharedVolume1 | New-HPOVServerProfileAttachVolume
$params = @{
connections = $con1, $con2, $con3, $con4;
bios = $true;
biossettings = $bl660bios
manageboot = $True;
bootMode = "UEFI";
LogicalDisk = $LogicalDisk;
SANStorage = $True;
Ostype = 'Win2k12';
StorageVolume = $volume1;
}
Create a BL Gen9 UEFI Server Profile template with Ethernet and FC connections, local storage, SAN Storage and BIOS
Settings, then pipe to Wait-HPOVTaskComplete.
Related Links
Top
New-HPOVSnmpConfiguration

New-HPOVSnmpConfiguration
Create SNMP LIG Configuration Object
SYNTAX
New-HPOVSnmpConfiguration [-ReadCommunity] <String> [-SnmpV1] <bool> [-SnmpV3] <bool> [-Contact] <String> [-Acce
ssList] <Array> [-TrapDestinations] <Array> [<CommonParameters>]
New-HPOVSnmpConfiguration [-ReadCommunity] <String> [-SnmpV3] <bool> [-SnmpV3Users] <SnmpV3User[]> [-SnmpV1] <bo

ol> [-Contact] <String> [-AccessList] <Array> [-TrapDestinations] <Array> [<CommonParameters>]
This helper Cmdlet provides the capability to create a new SNMP Configuration object for a Logical Interconnect Group or
Logical Interconnect resources.
Parameters
-AccessList <Array>
A collection [System.Collections.ArrayList ] of IP Addresses or Subnets. You must include the Subnet Mask Bit value. E.g.
10.44.120.9/32 or 172.20.148.0/22
Aliases None
Required? true
Position? named
Default value
-Contact <String>
SNMP Contact Name.
Aliases None
Required? true
Position? named
Default value

-ReadCommunity <String>
The SNMP Read Community String to set.
Aliases None
Required? true
Position? named
Default value
-SnmpV1 <bool>
Specify if SNMPv1 should be enabled. Can be disabled when SNMPv3 is enabled.
Aliases None
Required? True
Position? named
Default value
-SnmpV3 <bool>
Specify if SNMPv3 should be enabled.
Aliases None
Required? True
Position? named
Default value
-SnmpV3Users <SnmpV3User[]>
Collection of SNMPv3 users to configure within the SNMP configuration object.
Aliases None
Required? true
Position? named
Default value
-TrapDestinations <Array>
A collection [System.Collections.ArrayList ] of SNMMP Trap Destinations. Use New-HPOVTrapDestination Cmdlet to create the
object.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.SnmpConfiguration [System.Management.Automation.PSCustomObject]
SNMP Configuration object for a Logical Interconnect Group or Logical Interconnect resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.

0/22 New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1010D";
2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -enableIgmpSnooping $True -igmpIdleTimeoutInterval 300 -LoopP
rotect $True -QosConfig $QosConfig
Create a new QOS Configuration object,and use the created object to add to a new Logical Interconnect Group. ### Related
Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVSnmpConfiguration
Create SNMP LIG Configuration Object ### SYNTAX
New-HPOVSnmpConfiguration [-ReadCommunity] <String> [-Contact] <String> [-AccessList] <Array> [-TrapDestinations

] <Array> [<CommonParameters>]
This helper Cmdlet provides the capability to create a new SNMP Configuration object for a Logical Interconnect Group or
Logical Interconnect resources.
Parameters
-AccessList <Array>
A collection [System.Collections.ArrayList ] of IP Addresses or Subnets. You must include the Subnet Mask Bit value. E.g.
10.44.120.9/32 or 172.20.148.0/22
Aliases None
Required? true
Position? named
Default value
-Contact <String>
SNMP Contact Name.
Aliases None
Required? true
Position? named
Default value
-ReadCommunity <String>
The SNMP Read Community String to set.
Aliases None
Required? true
Position? named
Default value
-TrapDestinations <Array>
A collection [System.Collections.ArrayList ] of SNMMP Trap Destinations. Use New-HPOVTrapDestination Cmdlet to create the
object.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.SnmpConfiguration [System.Management.Automation.PSCustomObject]
SNMP Configuration object for a Logical Interconnect Group or Logical Interconnect resource
Examples
-------------------------- EXAMPLE 1 --------------------------

0/22
Create a new QOS Configuration object,and use the created object to add to a new Logical Interconnect Group.
Related Links
Top
New-HPOVSnmpTrapDestination

New-HPOVSnmpTrapDestination
Create SNMP Trap Destination Object
SYNTAX
New-HPOVSnmpTrapDestination [-Destination] <String> [-Community] <String>[ [-Port] <Int>] [-SnmpFormat] <String>
[-TrapSeverities] <Array> [-VCMTrapCategories] <Array> [-EnetTrapCategories] <Array> [-FCTrapCategories] <Array>
New-HPOVSnmpTrapDestination [-Destination] <String> [-SnmpV3User] <HPOneView.Appliance.SnmpV3User>[ [-Port] <Int

>] [-SnmpFormat] <String>[ [-NotificationType] <String>] [-EngineID] <String> [-TrapSeverities] <Array> [-VCMTra
pCategories] <Array> [-EnetTrapCategories] <Array> [-FCTrapCategories] <Array> [<CommonParameters>]
This helper Cmdlet provides the capability to create a new SNMP Trap Destination object. The object can then be used with
New-HPOVSnmpConfiguration to create a new SNMP Configuration for a Logical Interconnect Group or Logical Interconnect
resource.
Parameters
-Community <String>
The SNMP Trap Community String to set.
Aliases None
Required? true
Position? named
Default value public
The SNMP destination IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
-EnetTrapCategories <Array>
A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values:
* Other
* PortStatus
* PortThresholds
Aliases None
Required? true
Position? named
Default value
-EngineID <String>
The EngineId of remote SNMPv3 user. Only applicable when configuring an SNMPv3 object for the appliance, not logical
interconnect groups or logical interconnects.
Aliases None
Required? True
Position? named
Default value
-FCTrapCategories <Array>
* Other
* PortStatus
Aliases None
Required? true
Position? named
Default value
-NotificationType <String>
Indicates whether the trap should be inform message or not. Allowed values:
* Inform
* Trap
Aliases None
Required? False
Position? named
Default value Trap
-Port <Int>
Provide the alternate SNMP trap reciever port.
Aliases None
Required? False
Position? named
Default value
-SnmpFormat <String>
SNMP Format type. Allowed values:
* SNMPv1
* SNMPv2
* SNMPv3
Aliases None
Required? true
Position? named

A valid SNMPv3 user from New-HPOVSnmpV3User.
Aliases None
Required? True
Position? named
Default value
-TrapSeverities <Array>
* Critical
* Info
* Major
* Minor
* Normal
* Unknown
* Warning
Aliases None
Required? true
Position? named
Default value
-VCMTrapCategories <Array>
A collection [System.Collections.ArrayList ] of VCM Trap Categories. Allowed values:
* Legacy
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.SnmpTrapDestination [System.Management.Automation.PSCustomObject]
SNMP Trap desitnation object for an SNMP Configuration Object
Examples
-------------------------- EXAMPLE 1 --------------------------

at SNMPv1 -TrapSeverities critical,warning $Dest2 = New-HPOVSnmpTrapDestination 10.44.120.9 MyR3adcommun1ty SNMP
v1 critical,warning legacy "Other","PortStatus","PortThresholds" "Other","PortStatus" $SnmpConfig = New-HPOVSnmp
Configuration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.0/22 -TrapDestinations $De
st1,$Dest2 New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1
010D";2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -SNMP $SnmpConfig
Create a new SNMP Configuration object, with the specified Trap Destinations, and use the created object to add to a new
Logical Interconnect Group.
-------------------------- EXAMPLE 2 --------------------------
# Create SNMPv3 user account for appliance. $SNMPv3User = New-HPOVSnmpv3User -Username snmpv3user -SecurityLevel
None -ApplianceSnmpUser $Dest1 = New-HPOVSnmpTrapDestination -Destination mysnmpserver.domain.local -Community
MyR3adcommun1ty -SnmpFormat SNMPv1 -TrapSeverities critical,warning $Dest2 = New-HPOVSnmpTrapDestination 10.44.1
20.9 MyR3adcommun1ty SNMPv1 critical,warning legacy "Other","PortStatus","PortThresholds" "Other","PortStatus" $
SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.0
/22 -TrapDestinations $Dest1,$Dest2 New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Product
ion 1" -bays @{1 = "Flex1010D";2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -SNMP $SnmpConfig
Logical Interconnect Group. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVSnmpTrapDestination
Create SNMP Trap Destination Object ### SYNTAX
New-HPOVSnmpTrapDestination [-Destination] <String> [-Community] <String>[ [-Port] <Int>] [-SnmpFormat] <String>

[-TrapSeverities] <Array> [-VCMTrapCategories] <Array> [-EnetTrapCategories] <Array> [-FCTrapCategories] <Array>
New-HPOVSnmpTrapDestination [-Destination] <String> [-SnmpV3User] <HPOneView.Appliance.SnmpV3User> [-EngineID] <

String>[ [-Port] <Int>] [-SnmpFormat] <String>[ [-NotificationType] <String>] [-TrapSeverities] <Array> [-VCMTra
pCategories] <Array> [-EnetTrapCategories] <Array> [-FCTrapCategories] <Array> [<CommonParameters>]
This helper Cmdlet provides the capability to create a new SNMP Trap Destination object. The object can then be used with
New-HPOVSnmpConfiguration to create a new SNMP Configuration for a Logical Interconnect Group or Logical Interconnect
resource.
Parameters
-Community <String>
The SNMP Trap Community String to set.
Aliases None
Required? true
Position? named
Default value public
The SNMP destination IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
-EnetTrapCategories <Array>
* Other
* PortStatus
* PortThresholds
Aliases None
Required? true
Position? named
Default value
-EngineID <String>
The EngineId of remote SNMPv3 user.
Aliases None
Required? True
Position? named
Default value
-FCTrapCategories <Array>
* Other
* PortStatus
Aliases None
Required? true
Position? named
Default value
-NotificationType <String>
Indicates whether the trap should be inform message or not. Allowed values:
* Inform
* Trap
Aliases None
Required? False
Position? named
Default value Trap
-Port <Int>
Provide the alternate SNMP trap reciever port.
Aliases None
Required? False
Position? named
Default value
-SnmpFormat <String>
SNMP Format type. Allowed values:
* SNMPv1
* SNMPv2
Aliases None
Required? true
Position? named
A valid SNMPv3 user from New-HPOVSnmpV3User.

Aliases None
Required? True
Position? named
Default value
-TrapSeverities <Array>
* Critical
* Info
* Major
* Minor
* Normal
* Unknown
* Warning
Aliases None
Required? true
Position? named
Default value
-VCMTrapCategories <Array>
A collection [System.Collections.ArrayList ] of VCM Trap Categories. Allowed values:
* Legacy
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Networking.SnmpTrapDestination [System.Management.Automation.PSCustomObject]
SNMP Trap desitnation object for an SNMP Configuration Object
Examples
-------------------------- EXAMPLE 1 --------------------------

$Dest2 = New-HPOVSnmpTrapDestination 10.44.120.9 MyR3adcommun1ty SNMPv1 critical,warning legacy 'Other','PortSta
tus','PortThresholds' 'Other','PortStatus'
0/22 -TrapDestinations $Dest1,$Dest2
Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -SNMP $SnmpConfig
Logical Interconnect Group.
Related Links
Top
New-HPOVSnmpV3User

New-HPOVSnmpV3User
Create a new SNMPv3 user from appliance or Logical Interconnect/Switch resoure.
SYNTAX
New-HPOVSnmpV3User [-Username] <String>[ [-SecurityLevel] <String>][ [-AuthProtocol] <String>][ [-AuthPassword]
<SecureString>][ [-PrivProtocol] <String>][ [-PrivPassword] <SecureString>] [<CommonParameters>]
New-HPOVSnmpV3User [-Username] <String> [-ApplianceSnmpUser] <SwitchParameter>[ [-SecurityLevel] <String>][ [-Au

thProtocol] <String>][ [-AuthPassword] <SecureString>][ [-PrivProtocol] <String>][ [-PrivPassword] <SecureString
>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? False
Position? named
-ApplianceSnmpUser <SwitchParameter>
Use this to create an appliance SNMPv3 User. Default is to create an HPOneView.Networking.SnmpV3User.
Aliases None
Required? true
Position? named
Default value
-AuthPassword <SecureString>
SNMpv3 Authentication password in SecureString format.
Aliases None
Required? false
Position? named
Default value
-AuthProtocol <String>
SNMPv3 Authentication protocol. Supported values:
* None
* MD5
* SHA
* SHA1
* SHA256
* SHA384
* SHA512
Aliases None
Required? false
Position? named
Default value
-PrivPassword <SecureString>
SNMpv3 Privacy password in SecureString format.
Aliases None
Required? false
Position? named
Default value
-PrivProtocol <String>
SNMPv3 Privacy protocol. Supported values:
* none
* des56
* 3des
* aes128
* aes192
* aes256"
Aliases None
Required? false
Position? named
Default value
-SecurityLevel <String>
Specify the type of SNMPv3 security policy. Supported values:
* None
* AuthOnly
* AuthAndPriv
Aliases None
Required? false
Position? named
Default value
-Username <String>
SNMPv3 Username
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Appliance SNMPv3 user account created on the appliance.
HPOneView.Networking.SnmpV3User
SNMPv3 user account for a networking resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Snmpv3Password = ConvertTo-SecureString "Myp@ssword" -AsPlainText -Force

New-HPOVSnmpV3User -ApplianceSnmpUser -Username MySNMPv3us3r -SecurityLevel AuthAndPriv -AuthProtocol SHA512 -Au
thPassword AES192 -PrivProtocol $SnmpV3UserPrivProtocol -PrivPassword $Snmpv3Password
Create a new SNMPv3 user for the appliance. ### Related Links * [Get-HPOVSnmpV3User]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSnmpV3User) * [Remove-HPOVSnmpV3User]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVSnmpV3User) ***
Top
### HPE OneView 4.00 Library ## New-HPOVSnmpV3User
Create a new SNMPv3 user from appliance or Logical Interconnect/Switch resoure. ### SYNTAX
New-HPOVSnmpV3User [-Username] <String>[ [-SecurityLevel] <String>][ [-AuthProtocol] <String>][ [-AuthPassword]

<SecureString>][ [-PrivProtocol] <String>][ [-PrivPassword] <SecureString>][ [-ApplianceConnection] <Array>] [<C
ommonParameters>]
New-HPOVSnmpV3User [-Username] <String> [-ApplianceSnmpUser] <SwitchParameter>[ [-SecurityLevel] <String>][ [-Au

thProtocol] <String>][ [-AuthPassword] <SecureString>][ [-PrivProtocol] <String>][ [-PrivPassword] <SecureString
>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? False
Position? named
-ApplianceSnmpUser <SwitchParameter>
Use this to create an appliance SNMPv3 User. Default is to create an HPOneView.Networking.SnmpV3User.
Aliases None
Required? true
Position? named
Default value
-AuthPassword <SecureString>
SNMpv3 Authentication password in SecureString format.
Aliases None
Required? false
Position? named
Default value

-AuthProtocol <String>
SNMPv3 Authentication protocol. Supported values:
* None
* MD5
* SHA
* SHA1
* SHA256
* SHA384
* SHA512
Aliases None
Required? false
Position? named
Default value
-PrivPassword <SecureString>
SNMpv3 Privacy password in SecureString format.
Aliases None
Required? false
Position? named
Default value
-PrivProtocol <String>
SNMPv3 Privacy protocol. Supported values:
* none
* des56
* 3des
* aes128
* aes192
* aes256'
Aliases None
Required? false
Position? named
Default value
-SecurityLevel <String>
Specify the type of SNMPv3 security policy. Supported values:

* None
* AuthOnly
* AuthAndPriv
Aliases None
Required? false
Position? named
Default value
-Username <String>
SNMPv3 Username
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Appliance SNMPv3 user account created on the appliance.
HPOneView.Networking.SnmpV3User
SNMPv3 user account for a networking resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Snmpv3Password = ConvertTo-SecureString 'Myp@ssword' -AsPlainText -Force

New-HPOVSnmpV3User -ApplianceSnmpUser -Username MySNMPv3us3r -SecurityLevel AuthAndPriv -AuthProtocol SHA512 -Au
thPassword AES192 -PrivProtocol $SnmpV3UserPrivProtocol -PrivPassword $Snmpv3Password
Create a new SNMPv3 user for the appliance.
Related Links
Get-HPOVSnmpV3User
Top

Create a Storage Volume resource.
SYNTAX
New-HPOVStorageVolume [-Name] <String> [-StoragePool] <Object> [-Description] <String>[ [-SnapshotStoragePool] <
Object>][ [-StorageSystem] <Object>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization] <SwitchPar
ameter>] [-Capacity] <Int64>[ [-ProvisioningType] <String>][ [-EnableCompression] <Boolean>][ [-EnableDeduplicat
ion] <Boolean>][ [-Full] <SwitchParameter>][ [-Shared] <SwitchParameter>][ [-Scope] <HPOneView.Appliance.ScopeCo
llection>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
New-HPOVStorageVolume [-Name] <String>[ [-VolumeTemplate] <Object>] [-Description] <String>[ [-SnapshotStoragePo

ol] <Object>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization] <SwitchParameter>] [-Capacity] <I
nt64>[ [-ProvisioningType] <String>][ [-EnableCompression] <Boolean>][ [-EnableDeduplication] <Boolean>][ [-Full
] <SwitchParameter>][ [-Shared] <SwitchParameter>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <S
witchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will help create a Storage Volume resource on a managed Storage System. The volume can be created by
specifying the Storage Pool or an existing Storage Volume Template. When the Storage Pool name is not unique, you can either
use the -StorageSystem parameter, or pass via the pipeline the Storage Pool from Get-HPOVStoragePool.
If the Storage Volume Template Global Policy is enabled, a valid Storage Volume Template must be provided.
Parameters
Aliases None
Required? true
Position? named

Aliases None
Required? false
Position? named
Default value false
-Capacity <Int64>
Aliases [-size] Max volume capacity in GB. e.g. 20 to specify 20GB.
Aliases size
Required? true
Position? named
Default value 0
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-EnableAdaptiveOptimization <SwitchParameter>
Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual
Aliases None
Required? false
Position? named
Default value False
-EnableCompression <Boolean>
Enable compression for StoreServe (3PAR) supported resources. Please verify the InformOS version installed supports
Compression.
Aliases None
Required? False
Position? named
Default value False
-EnableDeduplication <Boolean>
Enable deduplication for SSD-based Storage Pools (CPG).
Aliases None
Required? False
Position? named
Default value False
NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts.
Include this switch to enable Thick volume provisioning. Omit to specify Thin storage provisioning. Default: Thin
Aliases None
Required? false
Position? named
Default value False

-Name <String>
Aliases [-VolumeName] Storage Volume Name. Device Volume created on the storage system will be this name without spaces.
Aliases VolumeName
Required? true
Position? named
Default value
Specify the type of volume to provision. Allowed values are:
* Thin
* Full
* TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CP
G"s).
Aliases ProvisionType
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value False
Aliases [-pool, -PoolName] Storage Pool URI, name or resource object.
Aliases None
Required? false
Position? named
Default value
Aliases pool, poolName
Required? true
Position? named
Default value
When the Storage Pool name is not unique, specify the Storage System name the pool is managed/associate with.
Aliases None
Required? false
Position? named
Default value
Aliases [-template, -svt] Specify the Storage Volume Template Name, URI or Resource.
Aliases template, svt
Required? false
Position? named
Default value

<CommonParameters>
Input Types
Return Values
Async create task
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVStorageVolume -name TestVol1 -PoolName PoolR1 -Size 60
Create a 60GB private, thin provisioned volume named "TestVol1" from the "PoolR1" Storage Pool.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStoragePool PoolR1 | New-HPOVStorageVolume -name TestVol1 PoolR1 -Size 60
Get the "PoolR1" Storage Pool resource and pipe it to create a 60GB private, thin provisioned volume named "TestVol1".
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStoragePool PoolR1 -StorageSystem 3ParSys1 | New-HPOVStorageVolume -name TestVol1 -Size 60
Get the "PoolR1" Storage Pool resource and pipe it to create a 60GB private, thin provisioned volume named "TestVol1".
-------------------------- EXAMPLE 4 --------------------------
New-HPOVStorageVolume -name TestVol1 -StoragePool PoolR1 -StorageSystem 3ParSys1 -Size 60
Create a 60GB private, thin provisioned volume named "TestVol1" from the "PoolR1" Storage Pool resource that is managed by
"3ParSys1".
-------------------------- EXAMPLE 5 --------------------------
$svt = Get-HPOVStorageVolumeTemplate SVT_120GB_R5

$New-HPOVStorageVolume testvol3 -volumetemplate $svt -capacity 90 | Wait-HPOVTaskComplete
Create a 90GB volume named "TestVol1", using the "SVT_120GB_R5" Storage Volume Template, then wait for volume to be
provisioned. ### Related Links * [Add-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-
HPOVStorageVolume) * [ConvertTo-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/ConvertTo-HPOVStorageVolume) * [Get-HPOVStorageVolume](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVStorageVolume) * [Get-HPOVStorageVolumeSnapShot](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVStorageVolumeSnapShot) * [Get-HPOVStorageVolumeTemplate]
HPOVStorageVolumeTemplatePolicy) * [New-HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-
Top
### HPE OneView 4.00 Library ## New-HPOVStorageVolume
Create a Storage Volume resource. ### SYNTAX
New-HPOVStorageVolume [-Name] <String> [-StoragePool] <Object> [-Description] <String>[ [-SnapshotStoragePool] <

Object>][ [-StorageSystem] <Object>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization] <SwitchPar
ameter>] [-Capacity] <Int64>[ [-ProvisioningType] <String>][ [-Full] <SwitchParameter>][ [-Shared] <SwitchParame
ter>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Obje
ct> [<CommonParameters>]
New-HPOVStorageVolume [-Name] <String>[ [-VolumeTemplate] <Object>] [-Description] <String>[ [-SnapshotStoragePo

ol] <Object>][ [-DataProtectionLevel] <String>][ [-EnableAdaptiveOptimization] <SwitchParameter>] [-Capacity] <I
nt64>[ [-ProvisioningType] <String>][ [-Full] <SwitchParameter>][ [-Shared] <SwitchParameter>][ [-Scope] <HPOneV
iew.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>
]
This cmdlet will help create a Storage Volume resource on a managed Storage System. The volume can be created by
specifying the Storage Pool or an existing Storage Volume Template. When the Storage Pool name is not unique, you can either
use the -StorageSystem parameter, or pass via the pipeline the Storage Pool from Get-HPOVStoragePool.
If the Storage Volume Template Global Policy is enabled, a valid Storage Volume Template must be provided.
Parameters
Aliases None
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value false
-Capacity <Int64>
Aliases size
Required? true
Position? named
Default value 0
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases [-VolumeName] Storage Volume Name. Device Volume created on the storage system will be this name without spaces.
Aliases VolumeName
Required? true
Position? named
Default value
* Thin
* Full
G's).
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases pool, poolName
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases [-template, -svt] Specify the Storage Volume Template Name, URI or Resource.
Aliases template, svt
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async create task
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVStorageVolume -name TestVol1 -PoolName PoolR1 -Size 60
Create a 60GB private, thin provisioned volume named 'TestVol1' from the 'PoolR1' Storage Pool.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStoragePool PoolR1 | New-HPOVStorageVolume -name TestVol1 PoolR1 -Size 60
Get the 'PoolR1' Storage Pool resource and pipe it to create a 60GB private, thin provisioned volume named 'TestVol1'.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStoragePool PoolR1 -StorageSystem 3ParSys1 | New-HPOVStorageVolume -name TestVol1 -Size 60

Get the 'PoolR1' Storage Pool resource and pipe it to create a 60GB private, thin provisioned volume named 'TestVol1'.
-------------------------- EXAMPLE 4 --------------------------
New-HPOVStorageVolume -name TestVol1 -StoragePool PoolR1 -StorageSystem 3ParSys1 -Size 60
Create a 60GB private, thin provisioned volume named 'TestVol1' from the 'PoolR1' Storage Pool resource that is managed by
'3ParSys1'.
-------------------------- EXAMPLE 5 --------------------------
$svt = Get-HPOVStorageVolumeTemplate SVT_120GB_R5

$New-HPOVStorageVolume testvol3 -volumetemplate $svt -capacity 90 | Wait-HPOVTaskComplete
Create a 90GB volume named 'TestVol1', using the 'SVT_120GB_R5' Storage Volume Template, then wait for volume to be
provisioned.
Related Links
Top


Create new Storage Volume Snapshot resource.
SYNTAX
New-HPOVStorageVolumeSnapshot [-InputObject] <Object> [-Name] <String> [-Description] <String> [-ApplianceConnec
tion] <Object> [<CommonParameters>]
This Cmdlet will help create a Storage Volume Snapshot from an existing Storage Volume resource. If a Snapshot Storage Pool
has not been configured for the Storage Volume, the Snapshot cannot be created.
Parameters
Aliases Appliance
Required? true
Position? 3
The description for the Storage Volume Snapshot.
Aliases None
Required? true
Position? 2
Default value
Aliases [-Volume]
Specify the Storage Volume object to create a snapshot for.
Aliases Volume
Required? true
Position? 0
Default value
-Name <String>
Name of Snapshot. The parameter defaults to "{volumeName}_{timestamp}" variables provided by the appliance.
Aliases None
Required? true
Position? 1
Default value {volumeName}_{timestamp}
<CommonParameters>
Input Types
Storage volume resource object
Return Values
HPOneView.Applinace.TaskResource [System.Management.Automation.PSCustomObject]
Async task to create storage volume snapshot
System.Collections.ArrayList <HPOneView.Applinace.TaskResource>
Multiple async tasks
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolume "Volume 1" -ApplianceConnection hpov.domain.com | New-HPOVStorageVolumeSnapshot
Create a new storage volume snapshot using the default values. ### Related Links * [Get-HPOVStorageVolumeSnapShot]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeSnapShot) * [Remove-
HPOVStorageVolumeSnapshot) ***
Top
### HPE OneView 4.00 Library ## New-HPOVStorageVolumeSnapshot
Create new Storage Volume Snapshot resource. ### SYNTAX
New-HPOVStorageVolumeSnapshot [-InputObject] <Object> [-Name] <String> [-Description] <String> [-ApplianceConnec

This Cmdlet will help create a Storage Volume Snapshot from an existing Storage Volume resource. If a Snapshot Storage Pool
has not been configured for the Storage Volume, the Snapshot cannot be created.
Parameters
Aliases Appliance
Required? true
Position? 3
The description for the Storage Volume Snapshot.
Aliases None
Required? true
Position? 2
Default value
Aliases [-Volume]
Specify the Storage Volume object to create a snapshot for.
Aliases Volume
Required? true
Position? 0
Default value
-Name <String>
Name of Snapshot. The parameter defaults to '{volumeName}_{timestamp}' variables provided by the appliance.
Aliases None
Required? true
Position? 1
Default value {volumeName}_{timestamp}

<CommonParameters>
Input Types
Storage volume resource object
Return Values
HPOneView.Applinace.TaskResource [System.Management.Automation.PSCustomObject]
Async task to create storage volume snapshot
System.Collections.ArrayList <HPOneView.Applinace.TaskResource>
Multiple async tasks
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolume 'Volume 1' -ApplianceConnection hpov.domain.com | New-HPOVStorageVolumeSnapshot
Create a new storage volume snapshot using the default values.
Related Links
Top

Create storage volume template.
SYNTAX
New-HPOVStorageVolumeTemplate [-Name] <String>[ [-StoragePool] <Object>] [-Capacity] <Int64>[ [-Description] <St
ring>][ [-LockStoragePool] <SwitchParameter>][ [-SnapshotStoragePool] <Object>][ [-LockSnapShotStoragePool] <Swi
tchParameter>][ [-StorageSystem] <Object>][ [-LockCapacity] <SwitchParameter>][ [-Full] <SwitchParameter>][ [-Pr
ovisioningType] <String>][ [-LockProvisionType] <SwitchParameter>][ [-EnableDeduplication] <Boolean>][ [-LockEna
bleDeduplication] <SwitchParameter>][ [-EnableCompression] <Boolean>][ [-LockEnableCompression] <SwitchParameter
>][ [-Shared] <SwitchParameter>][ [-LockProvisionMode] <SwitchParameter>][ [-Scope] <HPOneView.Appliance.ScopeCo
llection>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

ring>][ [-LockStoragePool] <SwitchParameter>][ [-StorageSystem] <Object>][ [-LockCapacity] <SwitchParameter>][ [
-Full] <SwitchParameter>][ [-ProvisioningType] <String>][ [-LockProvisionType] <SwitchParameter>][ [-Shared] <Sw
itchParameter>][ [-LockProvisionMode] <SwitchParameter>][ [-DataProtectionLevel] <String>][ [-LockProtectionLeve
l] <SwitchParameter>][ [-EnableAdaptiveOptimization] <SwitchParameter>][ [-LockAdaptiveOptimization] <SwitchPara
meter>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet supports creating Storage Volume Templates, which are then used to provision Storage Volumes.
Parameters
Aliases Appliance
Required? false
Position? named
-Capacity <Int64>
Aliases size
Required? true
Position? named
Default value 0
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value
Provide the description for the Storage Volume Template
Aliases None
Required? false
Position? named
Default value
Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual.
Aliases None
Required? false
Position? named
Default value False
-EnableCompression <Boolean>
Enable compression for StoreServe (3PAR) supported resources. Please verify the InformOS version installed supports
Compression.
Aliases None
Required? False
Position? named
Default value False

-EnableDeduplication <Boolean>
Enable deduplication for SSD-based Storage Pools (CPG).
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value False
-LockAdaptiveOptimization <SwitchParameter>
Specify to lock the EnableAdaptiveOptimization value in the template.
Aliases None
Required? false
Position? named
Default value
-LockCapacity <SwitchParameter>
Specify to lock the Capacity value in the template.
Aliases None
Required? false
Position? named
Default value False
-LockEnableCompression <SwitchParameter>
Lock the EnableCompression value.

Aliases None
Required? False
Position? named
Default value False
-LockEnableDeduplication <SwitchParameter>
Lock the EnableDeduplication value.
Aliases None
Required? False
Position? named
Default value False
-LockProtectionLevel <SwitchParameter>
Specify to lock the DataProtectionLevel value in the template.
Aliases None
Required? false
Position? named
Default value
-LockProvisionMode <SwitchParameter>
Specify to lock the Provision Mode (Shared or Private) value in the template.
Aliases None
Required? false
Position? named
Default value False
-LockProvisionType <SwitchParameter>
Specify to lock the ProvisionType value in the template.
Aliases None
Required? false
Position? named
Default value
-LockSnapShotStoragePool <SwitchParameter>
Specify to lock the SnapshotStoragePool value in the template.
Aliases None
Required? false
Position? named
Default value False
-LockStoragePool <SwitchParameter>
Specify to lock the StoragePool value in the template.
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Aliases [-TemplateName]
Storage Volume Template name
Required? true
Position? named
Default value
* Thin
* Full
G"s).
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
Include this switch to mark the Storage Volume Template as a Shareable resource for shared volume access.
Aliases None
Required? false
Position? named
Default value False
Specify the Storage Pool (aka CPG) the Storage Volume Template will use for volume snapshot use. The provided Storage Pool
must already be managed by OneView. If you omit this value, then the StoragePool parameter value will be used. Only
supported with HPE StoreServe platforms.
Aliases None
Required? false
Position? named
Default value
Specify the Storage Pool (aka CPG) the Storage Volume Template will be associated with. Storage Pool must already be
managed by OneView.
Aliases None
Required? false
Position? named
Default value
If there are multiple Storage Pool resources with the same name, use this parameter to filter for the correct pool object.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Storage.System.Pool [System.Management.Automation.PSCustomObject]
Managed Storage Pool resource
Return Values
Created Storage Volume Template resource
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVStorageVolumeTemplate -templateName yellow-svt -storagePool yellow -capacity 40
Create a new Storage Volume Template, setting the max size to 40GB, Thin Provisioning and Private.
-------------------------- EXAMPLE 2 --------------------------
$storageVolTemplate = New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -storagePool R5-CPG12 -capac

ity 250 -shared
Create a new Storage Volume Template, setting the max size to 250GB, Thin Provisioning and Shareable.
-------------------------- EXAMPLE 3 --------------------------
$storagePool = Get-HPOVStoragePool R5-CPG12

$storageVolTemplate = New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -storagePool $storagePool -c
apacity 250 -shared
Use the Get-HPOVStoragePool cmdlet to get the "R5-CPG12" pool, and create a new Storage Volume Template, setting the
max size to 250GB, Thin Provisioning and Shareable.
-------------------------- EXAMPLE 4 --------------------------
$svt = Get-HPOVStoragePool R5-CPG12 | New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -SnapshotSto

ragePool "MySnapShotPool" -capacity 250 -shared
Use the Get-HPOVStoragePool cmdlet to get the "R5-CPG12" pool, and create a new Storage Volume Template, setting the
max size to 250GB, Thin Provisioning, Shareable, and providing the Snapshot Storage Pool. ### Related Links * [Get-
HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeTemplate) *
[Get-HPOVStorageVolumeTemplatePolicy](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVStorageVolumeTemplatePolicy) * [Remove-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVStorageVolumeTemplate) * [Set-HPOVStorageVolumeTemplate]
Top
### HPE OneView 4.00 Library ## New-HPOVStorageVolumeTemplate
Create storage volume template. ### SYNTAX

ring>][ [-LockStoragePool] <SwitchParameter>][ [-SnapshotStoragePool] <Object>][ [-LockSnapShotStoragePool] <Swi
tchParameter>][ [-StorageSystem] <Object>][ [-LockCapacity] <SwitchParameter>][ [-Full] <SwitchParameter>][ [-Pr
ovisioningType] <String>][ [-LockProvisionType] <SwitchParameter>][ [-Shared] <SwitchParameter>][ [-LockProvisio
nMode] <SwitchParameter>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection] <Object>] [<C
ommonParameters>]

ring>][ [-LockStoragePool] <SwitchParameter>][ [-StorageSystem] <Object>][ [-LockCapacity] <SwitchParameter>][ [
-Full] <SwitchParameter>][ [-ProvisioningType] <String>][ [-LockProvisionType] <SwitchParameter>][ [-Shared] <Sw
itchParameter>][ [-LockProvisionMode] <SwitchParameter>][ [-DataProtectionLevel] <String>][ [-LockProtectionLeve
l] <SwitchParameter>][ [-EnableAdaptiveOptimization] <SwitchParameter>][ [-LockAdaptiveOptimization] <SwitchPara
meter>][ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet supports creating Storage Volume Templates, which are then used to provision Storage Volumes.
Parameters
Aliases Appliance
Required? false
Position? named
-Capacity <Int64>
Aliases size
Required? true
Position? named
Default value 0
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value
Provide the description for the Storage Volume Template
Aliases None
Required? false
Position? named
Default value
Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual.
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
-LockStoragePool <SwitchParameter>
Specify to lock the StoragePool value in the template.
Aliases None
Required? false
Position? named
Default value False

-Name <String>
Aliases [-TemplateName]
Storage Volume Template name
Required? true
Position? named
Default value
* Thin
* Full
G's).
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value False
Include this switch to mark the Storage Volume Template as a Shareable resource for shared volume access.
Aliases None
Required? false
Position? named
Default value False
Specify the Storage Pool (aka CPG) the Storage Volume Template will use for volume snapshot use. The provided Storage Pool
must already be managed by OneView. If you omit this value, then the StoragePool parameter value will be used. Only
supported with HPE StoreServe platforms.
Aliases None
Required? false
Position? named
Default value
Specify the Storage Pool (aka CPG) the Storage Volume Template will be associated with. Storage Pool must already be
managed by OneView.
Aliases None
Required? false
Position? named
Default value
If there are multiple Storage Pool resources with the same name, use this parameter to filter for the correct pool object.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Managed Storage Pool resource
Return Values
Created Storage Volume Template resource
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVStorageVolumeTemplate -templateName yellow-svt -storagePool yellow -capacity 40
Create a new Storage Volume Template, setting the max size to 40GB, Thin Provisioning and Private.
-------------------------- EXAMPLE 2 --------------------------
$storageVolTemplate = New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -storagePool R5-CPG12 -capac

ity 250 -shared
Create a new Storage Volume Template, setting the max size to 250GB, Thin Provisioning and Shareable.
-------------------------- EXAMPLE 3 --------------------------
$storagePool = Get-HPOVStoragePool R5-CPG12

$storageVolTemplate = New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -storagePool $storagePool -c
apacity 250 -shared
Use the Get-HPOVStoragePool cmdlet to get the 'R5-CPG12' pool, and create a new Storage Volume Template, setting the max
size to 250GB, Thin Provisioning and Shareable.
-------------------------- EXAMPLE 4 --------------------------
$svt = Get-HPOVStoragePool R5-CPG12 | New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -SnapshotSto

ragePool 'MySnapShotPool' -capacity 250 -shared
Use the Get-HPOVStoragePool cmdlet to get the 'R5-CPG12' pool, and create a new Storage Volume Template, setting the max
size to 250GB, Thin Provisioning, Shareable, and providing the Snapshot Storage Pool.
Related Links
Top
New-HPOVSupportDump
New-HPOVSupportDump
Generate and download Support Dumps.
SYNTAX
New-HPOVSupportDump [-Type] <String> [-Location] <String>[ [-Encrypted] <SwitchParameter>] [-ApplianceConnection
New-HPOVSupportDump [-LogicalInterconnect] <Object> [-Location] <String> [-ApplianceConnection] <Array> [<Common

Parameters>]
Support Dumps are required when an issue is encountered and HP Support requests one to be generated. There are two
different Support Dumps:
1. Appliance
2. Logical Interconnect
The Appliance Support Dump contains important log files about the appliance, but excludes the Logical Interconnect logs.
Parameters
Aliases Appliance
Required? true
Position? named
-Encrypted <SwitchParameter>
Use this parameter for the appliance to encrypt the Support Dump. Only HPE Support representatives can decrypt the contents.
Aliases None
Required? false
Position? named
Default value False

-Location <String>
Aliases [-save]
directory does not exist, it will be created.
Aliases save
Required? true
Position? named
Aliases [-liobject, -li, -name]
Specify the Logical Interconnect URI or Object the Support Dump will be generated for, from pipeline.
Aliases liobject, li, name
Required? true
Position? named
Default value
-Type <String>
The type of Support Dump to collect. Possible values are:
1. appliance
2. li
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Accepts pipeline input from Get-HPOVLogicalInterconnect only.
Return Values
The generated Support Dump File
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVSupportDump c: emp appliance
This command will save the Appliance support dump to C: emp, for Myappliance.domain.com Appliance Connection.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVSupportDump c: emp appliance
This command will save the Appliance support dump to C: emp, for all Appliance Connections.
-------------------------- EXAMPLE 3 --------------------------
New-HPOVSupportDump c: emp li ENC1-LI
This command will save the Logical Interconnect ENC1-LI to C: emp.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVlogicalinterconnect ENC1-LI | New-HPOVSupportDump c: emp
Accepting the response from Get-HPOVLogicalInterconnect CMDLET.

-------------------------- EXAMPLE 5 --------------------------
Get-HPOVlogicalinterconnect | New-HPOVSupportDump c: emp
Accepting the response from Get-HPOVLogicalInterconnect CMDLET for all Logical Interconnects and creating support dumps
for all. ### Related Links ***
Top
### HPE OneView 4.00 Library ## New-HPOVSupportDump
Generate and download Support Dumps. ### SYNTAX
New-HPOVSupportDump [-Type] <String> [-Location] <String>[ [-Encrypted] <SwitchParameter>] [-ApplianceConnection

New-HPOVSupportDump [-LogicalInterconnect] <Object> [-Location] <String> [-ApplianceConnection] <Array> [<Common

Parameters>]
Support Dumps are required when an issue is encountered and HP Support requests one to be generated. There are two
different Support Dumps:
1. Appliance
2. Logical Interconnect
The Appliance Support Dump contains important log files about the appliance, but excludes the Logical Interconnect logs.
Parameters
Aliases Appliance
Required? true
Position? named
-Encrypted <SwitchParameter>
Use this parameter for the appliance to encrypt the Support Dump. Only HPE Support representatives can decrypt the contents.
Aliases None
Required? false
Position? named
Default value False
-Location <String>
Aliases [-save]
directory does not exist, it will be created.
Aliases save
Required? true
Position? named
Aliases [-liobject, -li, -name]
Aliases liobject, li, name
Required? true
Position? named
Default value
-Type <String>
The type of Support Dump to collect. Possible values are:
1. appliance
2. li
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Accepts pipeline input from Get-HPOVLogicalInterconnect only.
Return Values
The generated Support Dump File
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVSupportDump c:\temp appliance
This command will save the Appliance support dump to C:\Temp, for Myappliance.domain.com Appliance Connection.
-------------------------- EXAMPLE 2 --------------------------
New-HPOVSupportDump c:\temp appliance
This command will save the Appliance support dump to C:\Temp, for all Appliance Connections.
-------------------------- EXAMPLE 3 --------------------------
New-HPOVSupportDump c:\temp li ENC1-LI
This command will save the Logical Interconnect ENC1-LI to C:\Temp.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVlogicalinterconnect ENC1-LI | New-HPOVSupportDump c:\temp
Accepting the response from Get-HPOVLogicalInterconnect CMDLET.
-------------------------- EXAMPLE 5 --------------------------
Get-HPOVlogicalinterconnect | New-HPOVSupportDump c:\temp
Accepting the response from Get-HPOVLogicalInterconnect CMDLET for all Logical Interconnects and creating support dumps
for all.
Related Links
Top

Create an Unmanaged Device.
SYNTAX
New-HPOVUnmanagedDevice [-Name] <String> [-Model] <String> [-MaxPower] <Int32> [-Height] <Int32> [-MacAddress] <
String> [-IPv4Address] <String> [-IPv6Address] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
provide a more realistic and complete data center layout. Creating a device does not provide the ability to manage it from HPE
OneView. The administrator will need to specify static characteristics of the device being added. The unmanaged device can
then be assigned into the appropriate rack manually.
Parameters
Aliases Appliance
Required? true
Position? named
-Height <Int32>
Rack Unit height of the Unmanaged Device.
Aliases None
Required? true
Position? named
Default value 1
-IPv4Address <String>
Provide the IPv4 Address value of the management interface. This value does not provide a method for an HPE OneView
appliance to communicate with the management interface.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-MacAddress <String>
Provide the management interface L2 address.
Aliases None
Required? true
Position? named
Default value
-MaxPower <Int32>
The maximum power consumption of the Unmanaged Device.
Aliases None
Required? true
Position? named
Default value 0
-Model <String>
The device model.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Newly created Unmanaged Device resource

Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVUnmanagedDevice -name "Unmanaged-SRVR1" -model "ProLiant DL380 G6" -height 2 -maxpower 750 -IPv4Address
10.154.1.10
Create a new unmanaged server device.

-------------------------- EXAMPLE 2 --------------------------
New-HPOVUnmanagedDevice -name "HPN5900CP1" -model "HPN 5900CP" -height 1 -maxpower 260 -IPv4Address 172.18.254.9
9 "MyAppliance.domain.com"
Create a new unmanaged switch device. ### Related Links * [Get-HPOVUnmanagedDevice]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVUnmanagedDevice) * [Remove-HPOVUnmanagedDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVUnmanagedDevice) ***
Top
### HPE OneView 4.00 Library ## New-HPOVUnmanagedDevice
Create an Unmanaged Device. ### SYNTAX
New-HPOVUnmanagedDevice [-Name] <String> [-Model] <String> [-MaxPower] <Int32> [-Height] <Int32> [-MacAddress] <
String> [-IPv4Address] <String> [-IPv6Address] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
provide a more realistic and complete data center layout. Creating a device does not provide the ability to manage it from HPE
OneView. The administrator will need to specify static characteristics of the device being added. The unmanaged device can
then be assigned into the appropriate rack manually.
Parameters
Aliases Appliance
Required? true
Position? named
-Height <Int32>
Rack Unit height of the Unmanaged Device.
Aliases None
Required? true
Position? named
Default value 1
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Provide the management interface L2 address.
Aliases None
Required? true
Position? named
Default value
-MaxPower <Int32>
The maximum power consumption of the Unmanaged Device.
Aliases None
Required? true
Position? named
Default value 0
-Model <String>
The device model.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Newly created Unmanaged Device resource
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVUnmanagedDevice -name "Unmanaged-SRVR1" -model "ProLiant DL380 G6" -height 2 -maxpower 750 -IPv4Address
10.154.1.10
Create a new unmanaged server device.

-------------------------- EXAMPLE 2 --------------------------
New-HPOVUnmanagedDevice -name "HPN5900CP1" -model "HPN 5900CP" -height 1 -maxpower 260 -IPv4Address 172.18.254.9
9 'MyAppliance.domain.com'
Create a new unmanaged switch device.
Related Links
Top
New-HPOVUplinkSet

New-HPOVUplinkSet
Create a new Uplink Set.
SYNTAX
New-HPOVUplinkSet [-InputObject] <Object> [-Name] <String> [-Type] <String> [-Networks] <Array> [-NativeEthNetwo
rk] <Object> [-UplinkPorts] <Array> [-EthMode] <String> [-LacpTimer] <String> [-PrimaryPort] <String>[ [-Async]
<SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
New-HPOVUplinkSet [-InputObject] <Object> [-Name] <String> [-Type] <String> [-Networks] <Array> [-UplinkPorts] <
Array> [-fcUplinkSpeed] <String>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters
>]
Interconnect uplinks are grouped into an uplink set and managed as a unit, with an assigned set of one or more networks. The
traffic carried over the uplinks is determined by the network assignment of the uplink set. Uplink sets can support either Ethernet
or Fibre Channel networks. Depending on the type of the assigned networks, uplink sets can support both an automatic and a
selective failover or distribution strategy. The uplink port state is monitored, which contributes to the overall reachability status of
the assigned networks. For each port belonging to the uplink set, the assigned port speed can be monitored. Uplink Sets can be
created for Logical Interconnect Groups or Logical Interconnects. When creating a new Uplink Set, either the Logical
Interconnect Group or Logical Interconnect must exist. Please know that the UplinkPorts parameter syntax is different between
HPE BladeSystem and HPE Synergy Virtual Connect.
Parameters

Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value false
-EthMode <String>
Aliases [-usEthMode] Sets the LACP mode on the uplink ports. Valid for ETHERNET Uplinks only. Accepted Values:
* Auto (Default)
* Failover
Aliases usEthMode
Required? true
Position? named
Default value Auto
Aliases [-li, -lig] Either a Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup) or Logical Interconnect (Get-
HPOVLogicalInterconnect) resource object.
Aliases li, lig, ligName, Resource
Required? true
Position? named
Default value
-LacpTimer <String>
Set the LACP Timer value, which sets the lacpdu frequecy to the LACP peer. Accepted values:
* Long
* Short (Default)
Aliases None
Required? true
Position? named
Default value Short
-Name <String>
Aliases [-usName] Logical Uplink set Name
Aliases usName
Required? true
Position? named
Default value
-NativeEthNetwork <Object>
Aliases [-usNativeEthNetwork, -Native, -PVID] The valid name of the Native Ethernet Network that is a member of the usNetworks
parameter.
Aliases usNativeEthNetwork, Native, PVID
Required? true
Position? named
Default value
-Networks <Array>
Aliases [-usNetworks] Array of Ethernet Network Names
Aliases usNetworks
Required? true
Position? named
Default value @()
-PrimaryPort <String>
Specify the Primary Uplink Port when EthMode is set to Failover. Parameter is not valid when EthMode parameter is set to Auto.
Example: "Bay1:X1"
Aliases None
Required? true
Position? named
Default value
-Type <String>
Aliases [-usType] Uplink set Type. Accepted values are
* Ethernet (Default)
* FibreChannel
* Tunnel
* Untagged
* ImageStreamer
ImageStreamer is only supported with Synergy infrastructure. When assigning an Ethernet Network to an ImageStreamer Uplink
Set, the network resource must be a Tagged Ethernet Network.
Aliases usType
Required? true
Position? named
Default value
Aliases [-usUplinkPorts] Array of uplink ports with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the
Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID".
FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or

"BAY3:1","BAY3:2" Synergy VC Ethernet e.g.
"Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g.
"Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port
e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or
"Bay5:Q1.2","Bay5:Q2.2"
Aliases usUplinkPorts
Required? true
Position? named
Default value @()
-fcUplinkSpeed <String>
Specify the Fibre Channel Uplink Port speed. Accepted values:

* Auto (Default)
* 2
* 4
* 8
Aliases None
Required? true
Position? named
Default value Auto
<CommonParameters>
Input Types
Logical Interconnect Resource from Get-HPOVLogicalInterconnect
Logical Interconnect Group Resource from Get-HPOVLogicalInterconnectGroup
Return Values
Async Task Resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnectGroup -Name "LIG Prod" | New-HPOVUplinkSet -Name "Uplink Set 1" -Type Ethernet -Netwo
rks "RED","BLUE","GREEN" -NativeEthNetwork "RED" -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMode "
Auto"
To Create an Ethernet Uplink Template

-------------------------- EXAMPLE 2 --------------------------
$ethNets = "Net1","Net2","Net3" | Get-HPOVNetwork -Type Ethernet

Get-HPOVLogicalInterconnectGroup -Name "LIG Prod" | New-HPOVUplinkSet -Name "Uplink Set 1" -Type Ethernet -Netwo
rks $ethNets -NativeEthNetwork $ethNets[0] -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMode "Auto"
Get the network resource objects, and define a new Uplink Set template that will be assigned to the Logical Interconnect Group
resource.
-------------------------- EXAMPLE 3 --------------------------
$LIGProd = Get-HPOVLogicalInterconnectGroup -Name "LIG Prod"

New-HPOVUplinkSet -Resource $LIGProd -Name "Fabric A" -Type FibreChannel -Networks "FABRIC_A" -UplinkPorts "BAY1
:X1","BAY1:X2"
To Create a Fibre Channel Uplink Template for VC FlexFabric modules.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalInterconnect -Name "Encl1 LIG Prod" | New-HPOVUplinkSet -Name "New Uplink Set" -Type Ethernet -Ne
tworks "RED","BLUE","GREEN" -NativeEthNetwork "RED" -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMod
e "Auto"
Add a new Uplink Set to an existing Logical Interconnect resource.

-------------------------- EXAMPLE 5 --------------------------
$MlagNetworks = Get-HPOVNetwork -Type Ethernet -Name "My MLAG Network*"

Get-HPOVLogicalInterconnectGroup -Name "My Synergy Prod LIG" | New-HPOVUplinkSet -Name "MLAG UplinkSet" -Type Et
hernet -Networks $MlagNetworks -NativeEthNetwork ($MlagNetworks | ? vlanid -eq 144) -UplinkPorts "Enclosure1:BAY
3:Q1","Enclosure1:BAY3:Q2","Enclosure2:BAY6:Q1","Enclosure2:BAY6:Q2" -EthMode "Auto"
Create a Synergy MLAG Uplink Set using 40Gb capable ports.

-------------------------- EXAMPLE 6 --------------------------
$MlagNetworks = Get-HPOVNetwork -Type Ethernet -Name "My MLAG Network*"

Get-HPOVLogicalInterconnectGroup -Name "My Synergy Prod LIG" | New-HPOVUplinkSet -Name "MLAG UplinkSet" -Type Et
3:Q1.1","Enclosure1:BAY3:Q2.1","Enclosure2:BAY6:Q1.1","Enclosure2:BAY6:Q2.1" -EthMode "Auto"
Create a Synergy MLAG Uplink Set using 10Gb subports of QSFP transceiver slots.
-------------------------- EXAMPLE 7 --------------------------
$ImageStreamerDeploymentNetworkObject = Get-HPOVNetwork -Name "Deployment Network" -ErrorAction Stop

Get-HPOVLogicalInterconnectGroup -Name "My Synergy VC+ImageStreamer LIG" -ErrorAction Stop | New-HPOVUplinkSet -
Name "Image Streamer Uplink Set" -Type ImageStreamer -Networks $ImageStreamerDeploymentNetworkObject -UplinkPort
s "Enclosure1:Bay3:Q3.1","Enclosure1:Bay3:Q4.1","Enclosure2:Bay6:Q3.1","Enclosure2:Bay6:Q4.1"
Create a Synergy ImageStreamer Uplink Set. ### Related Links * [Get-HPOVUplinkSet]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVUplinkSet) ***
Top
### HPE OneView 4.00 Library ## New-HPOVUplinkSet
Create a new Uplink Set. ### SYNTAX
New-HPOVUplinkSet [-InputObject] <Object> [-Name] <String> [-Type] <String> [-Networks] <Array> [-NativeEthNetwo
rk] <Object> [-UplinkPorts] <Array> [-EthMode] <String> [-LacpTimer] <String> [-PrimaryPort] <String>[ [-Async]
<SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
New-HPOVUplinkSet [-InputObject] <Object> [-Name] <String> [-Type] <String> [-Networks] <Array> [-UplinkPorts] <
Array> [-fcUplinkSpeed] <String>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters
>]
Interconnect uplinks are grouped into an uplink set and managed as a unit, with an assigned set of one or more networks. The
traffic carried over the uplinks is determined by the network assignment of the uplink set. Uplink sets can support either Ethernet
or Fibre Channel networks. Depending on the type of the assigned networks, uplink sets can support both an automatic and a
selective failover or distribution strategy. The uplink port state is monitored, which contributes to the overall reachability status of
the assigned networks. For each port belonging to the uplink set, the assigned port speed can be monitored. Uplink Sets can be
created for Logical Interconnect Groups or Logical Interconnects. When creating a new Uplink Set, either the Logical
Interconnect Group or Logical Interconnect must exist. Please know that the UplinkPorts parameter syntax is different between
HPE BladeSystem and HPE Synergy Virtual Connect.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value false
-EthMode <String>
Aliases [-usEthMode] Sets the LACP mode on the uplink ports. Valid for ETHERNET Uplinks only. Accepted Values:
* Auto (Default)
* Failover
Aliases usEthMode
Required? true
Position? named
Default value Auto

Aliases [-li, -lig] Either a Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup) or Logical Interconnect (Get-
HPOVLogicalInterconnect) resource object.
Aliases li, lig, ligName, Resource
Required? true
Position? named
Default value
-LacpTimer <String>
Set the LACP Timer value, which sets the lacpdu frequecy to the LACP peer. Accepted values:
* Long
* Short (Default)
Aliases None
Required? true
Position? named
Default value Short
-Name <String>
Aliases [-usName] Logical Uplink set Name
Aliases usName
Required? true
Position? named
Default value
-NativeEthNetwork <Object>
Aliases [-usNativeEthNetwork, -Native, -PVID] The valid name of the Native Ethernet Network that is a member of the usNetworks
parameter.
Aliases usNativeEthNetwork, Native, PVID
Required? true
Position? named
Default value

-Networks <Array>
Aliases [-usNetworks] Array of Ethernet Network Names
Aliases usNetworks
Required? true
Position? named
Default value @()
-PrimaryPort <String>
Specify the Primary Uplink Port when EthMode is set to Failover. Parameter is not valid when EthMode parameter is set to Auto.
Example: 'Bay1:X1'
Aliases None
Required? true
Position? named
Default value
-Type <String>
Aliases [-usType] Uplink set Type. Accepted values are
* Ethernet (Default)
* FibreChannel
* Tunnel
* Untagged
* ImageStreamer
ImageStreamer is only supported with Synergy infrastructure. When assigning an Ethernet Network to an ImageStreamer Uplink
Set, the network resource must be a Tagged Ethernet Network.
Aliases usType
Required? true
Position? named
Default value
Aliases [-usUplinkPorts] Array of uplink ports with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the
Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID".
FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or

"BAY3:1","BAY3:2" Synergy VC Ethernet e.g.
"Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g.
"Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port
e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or
"Bay5:Q1.2","Bay5:Q2.2"
Aliases usUplinkPorts
Required? true
Position? named
Default value @()
-fcUplinkSpeed <String>
Specify the Fibre Channel Uplink Port speed. Accepted values:
* Auto (Default)
* 2
* 4
* 8
Aliases None
Required? true
Position? named
Default value Auto
<CommonParameters>
Input Types
Logical Interconnect Resource from Get-HPOVLogicalInterconnect
Logical Interconnect Group Resource from Get-HPOVLogicalInterconnectGroup
Return Values
Async Task Resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalInterconnectGroup -Name 'LIG Prod' | New-HPOVUplinkSet -Name "Uplink Set 1" -Type Ethernet -Netwo
rks "RED","BLUE","GREEN" -NativeEthNetwork "RED" -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMode "
Auto"
To Create an Ethernet Uplink Template
-------------------------- EXAMPLE 2 --------------------------
$ethNets = 'Net1','Net2','Net3' | Get-HPOVNetwork -Type Ethernet

Get-HPOVLogicalInterconnectGroup -Name 'LIG Prod' | New-HPOVUplinkSet -Name "Uplink Set 1" -Type Ethernet -Netwo
rks $ethNets -NativeEthNetwork $ethNets[0] -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMode "Auto"
Get the network resource objects, and define a new Uplink Set template that will be assigned to the Logical Interconnect Group
resource.
-------------------------- EXAMPLE 3 --------------------------
$LIGProd = Get-HPOVLogicalInterconnectGroup -Name 'LIG Prod'

New-HPOVUplinkSet -Resource $LIGProd -Name "Fabric A" -Type FibreChannel -Networks "FABRIC_A" -UplinkPorts "BAY1
:X1","BAY1:X2"
To Create a Fibre Channel Uplink Template for VC FlexFabric modules.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalInterconnect -Name 'Encl1 LIG Prod' | New-HPOVUplinkSet -Name "New Uplink Set" -Type Ethernet -Ne
tworks "RED","BLUE","GREEN" -NativeEthNetwork "RED" -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMod
e "Auto"
Add a new Uplink Set to an existing Logical Interconnect resource.
-------------------------- EXAMPLE 5 --------------------------
$MlagNetworks = Get-HPOVNetwork -Type Ethernet -Name 'My MLAG Network*'

Get-HPOVLogicalInterconnectGroup -Name 'My Synergy Prod LIG' | New-HPOVUplinkSet -Name "MLAG UplinkSet" -Type Et
3:Q1","Enclosure1:BAY3:Q2","Enclosure2:BAY6:Q1","Enclosure2:BAY6:Q2" -EthMode "Auto"
Create a Synergy MLAG Uplink Set using 40Gb capable ports.
-------------------------- EXAMPLE 6 --------------------------
$MlagNetworks = Get-HPOVNetwork -Type Ethernet -Name 'My MLAG Network*'

Get-HPOVLogicalInterconnectGroup -Name 'My Synergy Prod LIG' | New-HPOVUplinkSet -Name "MLAG UplinkSet" -Type Et
3:Q1.1","Enclosure1:BAY3:Q2.1","Enclosure2:BAY6:Q1.1","Enclosure2:BAY6:Q2.1" -EthMode "Auto"
Create a Synergy MLAG Uplink Set using 10Gb subports of QSFP transceiver slots.
-------------------------- EXAMPLE 7 --------------------------
$ImageStreamerDeploymentNetworkObject = Get-HPOVNetwork -Name 'Deployment Network' -ErrorAction Stop

Get-HPOVLogicalInterconnectGroup -Name 'My Synergy VC+ImageStreamer LIG' -ErrorAction Stop | New-HPOVUplinkSet -
Name 'Image Streamer Uplink Set' -Type ImageStreamer -Networks $ImageStreamerDeploymentNetworkObject -UplinkPort
s "Enclosure1:Bay3:Q3.1","Enclosure1:Bay3:Q4.1","Enclosure2:Bay6:Q3.1","Enclosure2:Bay6:Q4.1"
Create a Synergy ImageStreamer Uplink Set.
Related Links
Get-HPOVUplinkSet
Top
New-HPOVUser

New-HPOVUser
Create a new user account.
SYNTAX
New-HPOVUser [-UserName] <String> [-Password] <String> [-Roles] <Array> [-FullName] <String>[ [-ScopePermissions
] <Array>][ [-EmailAddress] <String>][ [-OfficePhone] <String>][ [-MobilePhone] <String>][ [-Enabled] <SwitchPar
Create a new local user account on the management appliance
Parameters
Aliases Appliance
Required? true
Position? named
-EmailAddress <String>
Provide the users email address. This does not set the Email Notification value when configuring SMTP Notifications.
Aliases None
Required? false
Position? named
Default value
Deprecated parameter. By default, all new user accounts will be enabled. In order to disable a user account, use the Set-
HPOVUser Cmdlet.
Aliases None
Required? false
Position? named
Default value False
-FullName <String>
Full name for the user.
Aliases None
Required? true
Position? named
Default value
-MobilePhone <String>
Mobile phone number.
Aliases None
Required? false
Position? named
Default value
-OfficePhone <String>
Office phone number.
Aliases None
Required? false
Position? named
Default value
-Password <String>
The initial password to be assigned to the new user. Passwords must be at least 8 characters.
Aliases None
Required? true
Position? named
Default value
-Roles <Array>
Aliases None
Required? true
Position? named
Default value @()
Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings.
Stop) }
Aliases None
Required? False
Position? named
Default value
-UserName <String>
The name of the new user account to be created.

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]
If successful, returns a user resource
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVUser -username Sally -fullName "Sally Smith" -password SallysPassword -roles "server administrator","net
work administrator"
Create the Sally user account, and assigning to the Server Administrator and Network Administrator roles, on all connected
appliances. ### Related Links * [Get-HPOVUser](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVUser) *
[Remove-HPOVUser](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVUser) * [Set-HPOVUser]
Top
### HPE OneView 4.00 Library ## New-HPOVUser
Create a new user account. ### SYNTAX
New-HPOVUser [-UserName] <String> [-Password] <String> [-Roles] <Array> [-FullName] <String>[ [-ScopePermissions
] <Array>][ [-EmailAddress] <String>][ [-OfficePhone] <String>][ [-MobilePhone] <String>][ [-Enabled] <SwitchPar
Create a new local user account on the management appliance
Parameters

Aliases Appliance
Required? true
Position? named
Provide the users email address. This does not set the Email Notification value when configuring SMTP Notifications.
Aliases None
Required? false
Position? named
Default value
Deprecated parameter. By default, all new user accounts will be enabled. In order to disable a user account, use the Set-
HPOVUser Cmdlet.
Aliases None
Required? false
Position? named
Default value False
-FullName <String>
Full name for the user.
Aliases None
Required? true
Position? named
Default value
Mobile phone number.
Aliases None
Required? false
Position? named
Default value
Office phone number.
Aliases None
Required? false
Position? named
Default value
-Password <String>
The initial password to be assigned to the new user. Passwords must be at least 8 characters.
Aliases None
Required? true
Position? named
Default value
-Roles <Array>
Aliases None
Required? true
Position? named
Default value @()
Stop) }
Aliases None
Required? False
Position? named
Default value
-UserName <String>
The name of the new user account to be created.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
New-HPOVUser -username Sally -fullName "Sally Smith" -password SallysPassword -roles "server administrator","net
work administrator"
Create the Sally user account, and assigning to the Server Administrator and Network Administrator roles, on all connected
appliances.
Related Links
Get-HPOVUser
Remove-HPOVUser
Set-HPOVUser
Set-HPOVUserRole
Top
Ping-HPOVAddress

Ping-HPOVAddress
Validate IP Connectivity to resources.
SYNTAX
Ping-HPOVAddress [-Address] <String> [-Packets] <Int32> [-ApplianceConnection] <Object>[ [-Async] <SwitchParamet
This CMDLET provides the administrator the capability to PING (ICMP "echo request") to a resource the appliance is or is not
managing, to help validate L2 and/or L3 connectivity from the appliance.
Parameters
-Address <String>
The IP or FQDN Address of the target device. If using FQDN, please make sure valid DNS Servers are configured on the
appliance for proper DNS resolution.
Aliases None
Required? true
Position? 0
Default value
Aliases Appliance
Required? true
Position? 2

Aliases None
Required? false
Position? named
Default value False
-Packets <Int32>
Number of Packets to generate.
Default: 5
Aliases None
Required? true
Position? 1
Default value 5
<CommonParameters>
Input Types
System.Net.IPAddress
IP Address of target node to ping
Return Values
Task resource of the PING request
Examples
-------------------------- EXAMPLE 1 --------------------------
$results = Ping-HPOVAddress host.domain.com -Appliance appliance.contoso.com

$results.progressUpdates.statusUpdate
PING host.domain.com (192.168.1.100) 56(84) bytes of data.
64 bytes from host.domain.com (192.168.1.100): icmp_seq=1 ttl=64 time=0.462 ms
64 bytes from host.domain.com (192.168.1.100): icmp_seq=5 ttl=64 time=0.578 ms ### Related Links * [Get-
HPOVAddressPool](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAddressPool) * [Get-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAddressPoolRange) * [Get-
HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAddressPoolSubnet) * [New-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVAddressPoolRange) * [New-
HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVAddressPoolSubnet) *
[Remove-HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVAddressPoolRange) * [Remove-HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVAddressPoolSubnet) * [Set-HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVAddressPoolSubnet) ***
Top
### HPE OneView 4.00 Library ## Ping-HPOVAddress
Validate IP Connectivity to resources. ### SYNTAX
Ping-HPOVAddress [-Address] <String> [-Packets] <Int32> [-ApplianceConnection] <Object>[ [-Async] <SwitchParamet

This CMDLET provides the administrator the capability to PING (ICMP 'echo request') to a resource the appliance is or is not
managing, to help validate L2 and/or L3 connectivity from the appliance.
Parameters
-Address <String>
The IP or FQDN Address of the target device. If using FQDN, please make sure valid DNS Servers are configured on the
appliance for proper DNS resolution.
Aliases None
Required? true
Position? 0
Default value
Aliases Appliance
Required? true
Position? 2
Aliases None
Required? false
Position? named
Default value False
-Packets <Int32>
Number of Packets to generate.
Default: 5
Aliases None
Required? true
Position? 1
Default value 5
<CommonParameters>
Input Types
System.Net.IPAddress
IP Address of target node to ping
Return Values
Task resource of the PING request
Examples
-------------------------- EXAMPLE 1 --------------------------
$results = Ping-HPOVAddress host.domain.com -Appliance appliance.contoso.com

$results.progressUpdates.statusUpdate
PING host.domain.com (192.168.1.100) 56(84) bytes of data.
Related Links
Get-HPOVAddressPool
Top
Pop-HPOVAppliancePermission

Reset appliance connection active permissions back to login default.
SYNTAX
Pop-HPOVAppliancePermission[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Upon successful login, the caller can change their active permissions, and operate in a less priviledge mode at anytime by using
the Push-HPOVAppliancePermission. Use this Cmdlet to reset the appliance connection active permissions. A new SessionID
token will be stored within the ApplianceConnection, and the ConnectionPermissions within the ActivePermissions property that
were not provided will have their State set to "true".
Parameters
Aliases Appliance
Required? False
Position? 0
<CommonParameters>
Input Types
Return Values
List of appliance connection permissions and their active state.
Examples
-------------------------- EXAMPLE 1 --------------------------
Reset appliance connection active permissions to default. ### Related Links * [Push-HPOVAppliancePermission]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Push-HPOVAppliancePermission) ***
Top
### HPE OneView 4.00 Library ## Pop-HPOVAppliancePermission
Reset appliance connection active permissions back to login default. ### SYNTAX
Pop-HPOVAppliancePermission[ [-ApplianceConnection] <Array>] [<CommonParameters>]
Upon successful login, the caller can change their active permissions, and operate in a less priviledge mode at anytime by using
the Push-HPOVAppliancePermission. Use this Cmdlet to reset the appliance connection active permissions. A new SessionID
token will be stored within the ApplianceConnection, and the ConnectionPermissions within the ActivePermissions property that
were not provided will have their State set to "true".
Parameters
Aliases Appliance
Required? False
Position? 0
<CommonParameters>
Input Types
Return Values
List of appliance connection permissions and their active state.
Examples
-------------------------- EXAMPLE 1 --------------------------
Reset appliance connection active permissions to default.
Related Links
Push-HPOVAppliancePermission
Top

Change appliance connection active permissions.
SYNTAX
Push-HPOVAppliancePermission [-SetActivePermissions] <Object>[ [-ApplianceConnection] <Array>] [<CommonParameter
s>]
Upon successful login, the caller can change their active permissions, and operate in a less priviledge mode at anytime. The
Push-HPOVAppliancePermission Cmdlet will accept a single or collection of [HPOneView.Appliance.ConnectionPermission]
objects. A new SessionID token will be stored within the ApplianceConnection, and the ConnectionPermissions within the
ActivePermissions property that were not provided will have their State set to "false".
Parameters

Aliases Appliance
Required? False
Position? named
-SetActivePermissions <Object>
One or more [HPOneView.Appliance.ConnectionPermission] objects from an [HPOneView.Appliance.Connection]

ActivePermissions property.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
One or more appliance connection permissions and their active state.
Examples
-------------------------- EXAMPLE 1 --------------------------
$ConnectedSessions[0].ActivePermissions

-------- --------- ------
$NewPermissions = $ConnectedSessions[0].ActivePermissions | ? RoleName -match "Network"

Push-HPOVAppliancePermission -SetActivePermissions $NewPermissions
Change active permissions by filtering for a specific Role.

-------------------------- EXAMPLE 2 --------------------------

-------- --------- ------
$NewPermissions = $ConnectedSessions[0].ActivePermissions | ? ScopeName -match "Site A Admins"

Change active permissions by filtering for a specific Scope. ### Related Links * [Pop-HPOVAppliancePermission]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Pop-HPOVAppliancePermission) ***
Top
### HPE OneView 4.00 Library ## Push-HPOVAppliancePermission
Change appliance connection active permissions. ### SYNTAX
Push-HPOVAppliancePermission [-SetActivePermissions] <Object>[ [-ApplianceConnection] <Array>] [<CommonParameter

s>]
Upon successful login, the caller can change their active permissions, and operate in a less priviledge mode at anytime. The
Push-HPOVAppliancePermission Cmdlet will accept a single or collection of [HPOneView.Appliance.ConnectionPermission]
objects. A new SessionID token will be stored within the ApplianceConnection, and the ConnectionPermissions within the
ActivePermissions property that were not provided will have their State set to "false".
Parameters
Aliases Appliance
Required? False
Position? named
-SetActivePermissions <Object>
One or more [HPOneView.Appliance.ConnectionPermission] objects from an [HPOneView.Appliance.Connection]

ActivePermissions property.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
One or more appliance connection permissions and their active state.
Examples
-------------------------- EXAMPLE 1 --------------------------

$NewPermissions = $ConnectedSessions[0].ActivePermissions | ? RoleName -match 'Network'

Change active permissions by filtering for a specific Role.
-------------------------- EXAMPLE 2 --------------------------

$NewPermissions = $ConnectedSessions[0].ActivePermissions | ? ScopeName -match 'Site A Admins'

Change active permissions by filtering for a specific Scope.
Related Links
Top

Delete Address Pool Range from an appliance.
SYNTAX
Remove-HPOVAddressPoolRange [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>
This Cmdlet provides the ability to remove one or more IPv4 Subnet Pools and associated Address Pool Ranges from one or
more appliances.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-AddressPool] The Address Pool Range resource Object. Can be accepted via pipeline input.
Aliases AddressPool
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Address Pool Range from Get-HPOVAddressPoolRange
Return Values
Result of resource removal
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAddressPoolRange | Remove-HPOVAddressPoolSubnet
Remove all Address Pool ranges the default connected appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPoolSubnet | Where startAddress -eq "11:11:11:11:11:11" | Remove-HPOVAddressPoolSubnet
Remove "192.168.20.0" IPv4 Subnet Address Pool from MyAppliance.domain.com. ### Related Links * [Get-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAddressPoolRange) * [New-
HPOVAddressPoolRange](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVAddressPoolRange) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVAddressPoolRange
Delete Address Pool Range from an appliance. ### SYNTAX
Remove-HPOVAddressPoolRange [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>

more appliances.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-AddressPool] The Address Pool Range resource Object. Can be accepted via pipeline input.
Aliases AddressPool
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Address Pool Range from Get-HPOVAddressPoolRange
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAddressPoolRange | Remove-HPOVAddressPoolSubnet
Remove all Address Pool ranges the default connected appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPoolSubnet | Where startAddress -eq '11:11:11:11:11:11' | Remove-HPOVAddressPoolSubnet
Remove '192.168.20.0' IPv4 Subnet Address Pool from MyAppliance.domain.com.
Related Links
Top

Delete an IPv4 Subnet Pool from an appliance.
SYNTAX
Remove-HPOVAddressPoolSubnet [-IPv4Subnet] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>
more appliances.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-Subnet] The IPv4 Subnet Pool resource Object. Can be accepted via pipeline input.
Aliases Subnet
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
IPv4 Subnet Pool from Get-HPOVAddressPoolSubnet
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAddressPoolSubnet | Remove-HPOVAddressPoolSubnet
Remove all IPv4 Subnet Address Pools from any connected appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPoolSubnet 192.168.20.0 | Remove-HPOVAddressPoolSubnet
Remove "192.168.20.0" IPv4 Subnet Address Pool from MyAppliance.domain.com. ### Related Links * [Get-
HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVAddressPoolSubnet) * [Set-
HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVAddressPoolSubnet) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVAddressPoolSubnet
Delete an IPv4 Subnet Pool from an appliance. ### SYNTAX

Remove-HPOVAddressPoolSubnet [-IPv4Subnet] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>
more appliances.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-Subnet] The IPv4 Subnet Pool resource Object. Can be accepted via pipeline input.
Aliases Subnet
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
IPv4 Subnet Pool from Get-HPOVAddressPoolSubnet
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAddressPoolSubnet | Remove-HPOVAddressPoolSubnet
Remove all IPv4 Subnet Address Pools from any connected appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAddressPoolSubnet 192.168.20.0 | Remove-HPOVAddressPoolSubnet
Remove '192.168.20.0' IPv4 Subnet Address Pool from MyAppliance.domain.com.
Related Links
Top
Remove-HPOVAlert


Remove-HPOVAlert
Delete alerts.
SYNTAX
Remove-HPOVAlert [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf
This Cmdlet allows the administrator to remove one or more alerts. Alerts can be in one of two administratively controlled states:
Active or Cleared. Only alerts that are no longer active (in a Cleared state) can be removed.
In order for an administrator to remove an Alert, the administrator must be assigned to the respective resource role (Network,
Server, Storage, or Infrastructure.)
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Force remove the resource.
Aliases None
Required? false
Position? named
Default value

The alert to be removed.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Alert resource object (i.e. Get-HPOVAlert)
Return Values
Status object indicating the resource was removed.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAlert -State Cleared | Remove-HPOVAlert
Remove all cleared alerts on the appliance. ### Related Links * [Clear-HPOVAlert](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Clear-HPOVAlert) * [Get-HPOVAlert](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAlert)
* [Set-HPOVAlert](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVAlert) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVAlert
Delete alerts. ### SYNTAX

Remove-HPOVAlert [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf
This Cmdlet allows the administrator to remove one or more alerts. Alerts can be in one of two administratively controlled states:
Active or Cleared. Only alerts that are no longer active (in a Cleared state) can be removed.
In order for an administrator to remove an Alert, the administrator must be assigned to the respective resource role (Network,
Server, Storage, or Infrastructure.)
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Force remove resource. May not work with all locked alerts. An terminating exception will be generated if the alert cannot be
removed.
Aliases None
Required? false
Position? named
Default value
The alert to be removed.

Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Status object indicating the resource was removed.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVAlert -State Cleared | Remove-HPOVAlert
Remove all cleared alerts on the appliance.
Related Links
Clear-HPOVAlert
Get-HPOVAlert
Set-HPOVAlert
Top
Remove appliance HTTP/HTTPS proxy.
SYNTAX
Remove-HPOVApplianceProxy[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchPara
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove the configured HTTP/HTTP proxy settings on the appliance. ### Related Links * [Get-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceProxy) * [Set-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceProxy) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVApplianceProxy
Remove appliance HTTP/HTTPS proxy. ### SYNTAX
Remove-HPOVApplianceProxy[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchPara

Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove the configured HTTP/HTTP proxy settings on the appliance.
Related Links
Top

Remove configured appliance SNMP trap destinations.
SYNTAX
Remove-HPOVApplianceTrapDestination [-InputObject] <Object>[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchP
Use this Cmdlet to remove configured SNMPv1 and/or SNMPv3 trap destinations.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value

The HPOneView.Appliance.SnmpV1TrapDestination or HPOneView.Appliance.SnmpV3TrapDestination object from Get-

HPOVApplianceTrapDestination to remove.
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Appliance SNMPv1 trap destination from Get-HPOVHPOVApplianceTrapDestination.
Return Values
Success message of deleted resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVHPOVApplianceTrapDestination -Destination 10.45.110.76 -ErrorAction Stop | Remove-HPOVApplianceTrapDesti

nation
Remove the specified trap destination.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVHPOVApplianceTrapDestination -Type SNMPv3 | Remove-HPOVApplianceTrapDestination

Remove all of the SNMPv3 trap destinations. ### Related Links * [Get-HPOVApplianceTrapDestination]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceTrapDestination) * [New-
HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVApplianceTrapDestination) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVApplianceTrapDestination
Remove configured appliance SNMP trap destinations. ### SYNTAX
Remove-HPOVApplianceTrapDestination [-InputObject] <Object>[ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchP

Use this Cmdlet to remove configured SNMPv1 and/or SNMPv3 trap destinations.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
The HPOneView.Appliance.SnmpV1TrapDestination or HPOneView.Appliance.SnmpV3TrapDestination object from Get-

HPOVApplianceTrapDestination to remove.
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVHPOVApplianceTrapDestination -Destination 10.45.110.76 -ErrorAction Stop | Remove-HPOVApplianceTrapDesti

nation
Remove the specified trap destination.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVHPOVApplianceTrapDestination -Type SNMPv3 | Remove-HPOVApplianceTrapDestination
Remove all of the SNMPv3 trap destinations.
Related Links
Top

Remove X.509 SSL certificates from the appliace trusted store.
SYNTAX
Remove-HPOVApplianceTrustedCertificate[ [-InputObject] <String>][ [-ApplianceConnection] <Object>][ [-Async] <Sw
itchParameter>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This Cmdlet will allow the Infrastructure Administrator to remove X.509 compliant SSL certificates on the appliance within its
trusted store.
Parameters
Aliases Appliance
Required? false
Position? 1
Aliases None
Required? False
Position? named
Default value False
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases [-Certificate]
Aliases None
Required? false
Position? 0
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
A trusted certificate from Get-HPOVApplinaceTrustedCertificate.
Return Values
Status oject of successfull deletion of trusted certificate.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVApplianceTrustedCertificate -AliasName myhost1.domain.com | Remove-HPOVApplianceTrustedCertificate

Remove the specific trusted certificate from the appliances trusted certificate store. ### Related Links * [Add-
HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-
HPOVApplianceTrustedCertificate) * [Get-HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceTrustedCertificate) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVApplianceTrustedCertificate
Remove X.509 SSL certificates from the appliace trusted store. ### SYNTAX
Remove-HPOVApplianceTrustedCertificate[ [-InputObject] <String>][ [-ApplianceConnection] <Object>][ [-Async] <Sw

itchParameter>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This Cmdlet will allow the Infrastructure Administrator to remove X.509 compliant SSL certificates on the appliance within its
trusted store.
Parameters
Aliases Appliance
Required? false
Position? 1
Aliases None
Required? False
Position? named
Default value False
-Confirm <>
Aliases cf
Required?
Position? named
Default value

Aliases [-Certificate]
Aliases None
Required? false
Position? 0
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
A trusted certificate from Get-HPOVApplinaceTrustedCertificate.
Return Values
Status oject of successfull deletion of trusted certificate.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVApplianceTrustedCertificate -AliasName myhost1.domain.com | Remove-HPOVApplianceTrustedCertificate
Remove the specific trusted certificate from the appliances trusted certificate store.
Related Links
Top
Remove-HPOVBaseline

Remove-HPOVBaseline
Delete a Baseline from an appliance repository.
SYNTAX
Remove-HPOVBaseline [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Force] <SwitchParameter>][ [-Wh
atIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet provides the ability to remove one or more SPP Baselines from one or more appliances.
Parameters
Aliases Appliance
Required? false
Position? 1
Aliases cf
Required? false
Position? named
Default value

Aliases None
Required? false
Position? named
Default value
Aliases [-b, -Baseline] The SPP Baseline resource Name or Object. Can be accepted via pipeline input.
Aliases b, Baseline
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The progress of uploading the file to the appliance, and in-progress or completion result
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaseline | Remove-HPOVBaseline
Remove all baselines from any connected appliance.

-------------------------- EXAMPLE 2 --------------------------
Remove-HPOVBaseline -Name "My Custom Baseline"
Remove "My Custom Baseline" from MyAppliance.domain.com, using the -Name alias to the InputObject parameter. ### Related
Links * [Add-HPOVBaseline](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVBaseline) * [Get-
HPOVBaseline](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVBaseline) * [Get-HPOVBaselineRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVBaselineRepository) * [Show-
HPOVBaselineRepositorySize](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVBaselineRepositorySize)
***
Top
### HPE OneView 4.00 Library ## Remove-HPOVBaseline
Delete a Baseline from an appliance repository. ### SYNTAX
Remove-HPOVBaseline [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-WhatIf] <SwitchParameter>][ [-C

This Cmdlet provides the ability to remove one or more SPP Baselines from one or more appliances.
Parameters
Aliases Appliance
Required? false
Position? 1
Aliases cf
Required? false
Position? named
Default value
Aliases [-b, -Baseline] The SPP Baseline resource Name or Object. Can be accepted via pipeline input.
Aliases b, Baseline
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The progress of uploading the file to the appliance, and in-progress or completion result
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaseline | Remove-HPOVBaseline
Remove all baselines from any connected appliance.
-------------------------- EXAMPLE 2 --------------------------
Remove-HPOVBaseline -Name 'My Custom Baseline'
Remove 'My Custom Baseline' from MyAppliance.domain.com, using the -Name alias to the InputObject parameter.
Related Links
Add-HPOVBaseline
Get-HPOVBaseline
Top

Remove a datacenter resource.
SYNTAX
Remove-HPOVDataCenter [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<Com
monParameters>]
This Cmdlet will remove 1 or more datacenter resources from an appliance. Removing a datacenter resource will not delete or
remove associated resources, like Racks.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Datacenter object, from Get-HPOVDataCenter.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Datacenter resource from Get-HPOVDataCenter.
Return Values
Object with status confirmation the resource was deleted.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVDataCenter -Name DC2 | Remove-HPOVDataCenter
Remove "DC2" datacenter resource from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVDataCenter | Remove-HPOVDataCenter
Remove Datacenter resources from the appliance. ### Related Links * [Get-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVDataCenter) * [New-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVDataCenter) * [Set-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVDataCenter) * [Set-HPOVDataCenterRemoteSupport]
Top
### HPE OneView 4.00 Library ## Remove-HPOVDataCenter
Remove a datacenter resource. ### SYNTAX
Remove-HPOVDataCenter [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<Com
monParameters>]
This Cmdlet will remove 1 or more datacenter resources from an appliance. Removing a datacenter resource will not delete or
remove associated resources, like Racks.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Datacenter object, from Get-HPOVDataCenter.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Datacenter resource from Get-HPOVDataCenter.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVDataCenter -Name DC2 | Remove-HPOVDataCenter
Remove 'DC2' datacenter resource from the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVDataCenter | Remove-HPOVDataCenter
Remove Datacenter resources from the appliance.
Related Links
Get-HPOVDataCenter
New-HPOVDataCenter
Set-HPOVDataCenter
Top

Removes an enclosure and associated devices.
SYNTAX
Remove-HPOVEnclosure [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][ [-What
Removes an enclosure, its servers, and interconnects from appliance management
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Set to force-remove the enclosure. For example, if the enclosure is gone or is now being managed by a different appliance,
force-removing will remove the enclosure from this appliance without clearing vcmode.
When the request is accepted by the appliance, it does not return an Async Task Resource.
Aliases None
Required? false
Position? named
Default value False
Aliases [-name, -enclosure] The Enclosure object(s) or name(s) to be removed from management.
Aliases uri, name, Enclosure, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Collection of Enclosure Resources
Single Enclosure resource object
Return Values
Removal async task
When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVEnclosure -enclosure "Enclosure-1234" -force

Force-remove the enclosure specifed by name. Wait for remove to complete.

-------------------------- EXAMPLE 2 --------------------------
$enclosure = Get-HPOVEnclosure -name "Enclosure1"

Remove-HPOVEnclosure $enclosure -confirm:$false
Remove the enclosure specifed by $enclosure. Disable confirmation prompt.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVEnclosure | Remove-HPOVEnclosure
Search for all enclosures and remove them from appliance. ### Related Links * [Add-HPOVEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVEnclosure) * [Get-HPOVEnclosure]
Top
### HPE OneView 4.00 Library ## Remove-HPOVEnclosure
Removes an enclosure and associated devices. ### SYNTAX
Remove-HPOVEnclosure [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][ [-What

Removes an enclosure, its servers, and interconnects from appliance management
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Set to force-remove the enclosure. For example, if the enclosure is gone or is now being managed by a different appliance,
force-removing will remove the enclosure from this appliance without clearing vcmode.
Aliases None
Required? false
Position? named
Default value False
Aliases [-name, -enclosure] The Enclosure object(s) or name(s) to be removed from management.
Aliases uri, name, Enclosure, Resource
Required? true
Position? named
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Collection of Enclosure Resources
Single Enclosure resource object
Return Values
Removal async task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVEnclosure -enclosure "Enclosure-1234" -force

Force-remove the enclosure specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$enclosure = Get-HPOVEnclosure -name "Enclosure1"

Remove-HPOVEnclosure $enclosure -confirm:$false
Remove the enclosure specifed by $enclosure. Disable confirmation prompt.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVEnclosure | Remove-HPOVEnclosure
Search for all enclosures and remove them from appliance.
Related Links
Add-HPOVEnclosure
Get-HPOVEnclosure
Set-HPOVEnclosure
Top

Remove an enclosure group.
SYNTAX
Remove-HPOVEnclosureGroup [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][ [
Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of
that enclosure group.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Specify to forceably remove the resource from the appliance.
Aliases None
Required? false
Position? named
Default value False
Aliases [-EnclosureGroup, -uri, -name]
The Enclosure Group object(s), name(s) or uri(s) to be removed from management.
Aliases uri, name, EnclosureGroup, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Collection of Enclousre Resource Objects
Single Enclosure Grou Resource Object
Return Values
A PSCustomObject is returned indicating successful removal of the resource
Examples
-------------------------- EXAMPLE 1 --------------------------
$resp = Remove-HPOVEnclosureGroup -enclosureGroup "My-EG" -force
Force-remove the enclosure group specifed by name.

-------------------------- EXAMPLE 2 --------------------------
$eg = Get-HPOVEnclosureGroup -name "My-EG"

Remove-HPOVEnclosureGroup $enclosureGroup -confirm:$false
Remove the enclosure group specifed by $eg. Disable confirmation prompt.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVEnclosureGroup | Remove-HPOVEnclosureGroup
Search for all enclosure groups and remove them from appliance. ### Related Links * [Get-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVEnclosureGroup) * [Set-HPOVEnclosureGroup]
Top
### HPE OneView 4.00 Library ## Remove-HPOVEnclosureGroup
Remove an enclosure group. ### SYNTAX
Remove-HPOVEnclosureGroup [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][ [

Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of
that enclosure group.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Specify to forceably remove the resource from the appliance.
Aliases None
Required? false
Position? named
Default value False
Aliases [-EnclosureGroup, -uri, -name]
The Enclosure Group object(s), name(s) or uri(s) to be removed from management.
Aliases uri, name, EnclosureGroup, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Collection of Enclousre Resource Objects
Single Enclosure Grou Resource Object
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$resp = Remove-HPOVEnclosureGroup -enclosureGroup "My-EG" -force
Force-remove the enclosure group specifed by name.
-------------------------- EXAMPLE 2 --------------------------
$eg = Get-HPOVEnclosureGroup -name "My-EG"

Remove-HPOVEnclosureGroup $enclosureGroup -confirm:$false
Remove the enclosure group specifed by $eg. Disable confirmation prompt.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVEnclosureGroup | Remove-HPOVEnclosureGroup
Search for all enclosure groups and remove them from appliance.
Related Links
Top

Remove an existing external baseline repository.
SYNTAX
Remove-HPOVExternalRepository [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>][
[-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
* Apache
This Cmdlet supports removing an existing external repository. Removing an external baseline will cause any assigned baselines
in Server Profiles or Server Profile Templates to report the baseline as "removed". Any server profile that is configured to use a
firmware bundle residing in the external repository must not be in "staging" state.
Parameters

Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Provide the external repository object to remove.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
The external repository object from Get-HPOVBaselineRepository
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Remove-HPOVExternalRepository
Remove the existing external repository from the appliance. ### Related Links * [New-HPOVExternalRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVExternalRepository) * [Set-HPOVExternalRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVExternalRepository) * [Update-HPOVExternalRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVExternalRepository) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVExternalRepository
Remove an existing external baseline repository. ### SYNTAX
Remove-HPOVExternalRepository [-InputObject] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Arra

y>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
* Apache
This Cmdlet supports removing an existing external repository. Removing an external baseline will cause any assigned baselines
in Server Profiles or Server Profile Templates to report the baseline as 'removed'. Any server profile that is configured to use a
firmware bundle residing in the external repository must not be in 'staging' state.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Provide the external repository object to remove.

Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Remove-HPOVExternalRepository
Remove the existing external repository from the appliance.
Related Links
Top

Remove a configured Fabric Manager and associated tenants.
SYNTAX
Remove-HPOVFabricManager [-InputObject] <HPOneView.Networking.FabricManager[]>[ [-Force] <SwitchParameter>][ [-A
pplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
(APIC) policies. It represents a remote Cisco APIC or an APIC cluster that manages a Cisco ACI fabric. This Cmdlet will remove
the fabric manager and will disassociate it's tenant from all logical interconnects, networks and networks sets. Inconsistencies
with the APIC tenant configuration will no longer be monitored or remediated by OneView. Required privileges: Infrastructure
administrator or Server administrator
Parameters
Aliases Appliance
Required? False
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Force delete the resource.

Aliases None
Required? false
Position? named
Default value
-InputObject <HPOneView.Networking.FabricManager[]>
The HPOneView.Networking.FabricManager resource to remove.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Networking.FabricManager
The fabric manager resource from Get-HPOVFabricManager.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVFabricManager -Name fabricmgr.domain.com -ErrorAction Stop | Remove-HPOVFabricManager

Remove the specified fabric manager.
Related Links
Top

Remove configured hypervisor managers.
SYNTAX
Remove-HPOVHypervisorManager [-InputObject] <HPOneView.ClusterProfile.HypervisorManager>[ [-Force] <SwitchParame
ter>][ [-ApplianceConnection] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonPara
meters>]
You can register a hypervisor manager with HPE OneView by providing hostname and credentials in the Hypervisor Managers
user interface. The registered hypervisor manager contains preferences, which are used as default hypervisor or cluster
settings during hypervisor cluster profile creation. You can modify the hypervisor manager preferences using the edit operation.
You can override these values in a hypervisor cluster profile.
hypervisor manager.
OneView.
Parameters
Aliases Appliance
Required? False
Position? named

Aliases cf
Required? false
Position? named
Default value
Force delete the resource.
Aliases None
Required? false
Position? named
Default value
-InputObject <HPOneView.ClusterProfile.HypervisorManager>
The HPOneView.ClusterProfile.HypervisorManager resource to remove from Get-HPOVHypervisorManager.
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.ClusterProfile.HypervisorManager
The hypervisor manager object from Get-HPOVHypervisorManager.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVHypervisorManager -Name vcenter1.domain.com -ErrorAction Stop | Remove-HPOVHypervisorManager
Remove the specified hypervisor manager.
Related Links
Top

Remove authentication Directory.
SYNTAX
Remove-HPOVLdapDirectory [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [
Remove authentication Directory from the appliance. Can provide Directory Name or Object for removal.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Foreably remove the resource from the appliance.
Aliases None
Required? false
Position? named
Default value False
Aliases [-d, -Directory] Configured authentication Directory Name or Object.
Aliases d, Directory
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value

<CommonParameters>
Input Types
Collection of Directories
Single Directory object
Return Values
Resource Removed Status
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVLdapDirectory -Directory "My Directory1"
Remove "My Directroy Group1" from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLdapDirectory | Remove-HPOVLdapDirectory
Get all Directories and remove them from the default connected appliance. ### Related Links * [Get-HPOVLdapDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLdapDirectory) * [New-HPOVLdapDirectory]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapDirectory) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVLdapDirectory
Remove authentication Directory. ### SYNTAX
Remove-HPOVLdapDirectory [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [

Remove authentication Directory from the appliance. Can provide Directory Name or Object for removal.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Foreably remove the resource from the appliance.
Aliases None
Required? false
Position? named
Default value False
Aliases [-d, -Directory] Configured authentication Directory Name or Object.
Aliases d, Directory
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value

<CommonParameters>
Input Types
Collection of Directories
Single Directory object
Return Values
Resource Removed Status
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVLdapDirectory -Directory "My Directory1"
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLdapDirectory | Remove-HPOVLdapDirectory
Get all Directories and remove them from the default connected appliance.
Related Links
Top

Remove Directory Group.
SYNTAX
Remove-HPOVLdapGroup [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Co
nfirm] <SwitchParameter>] [<CommonParameters>]
Remove Directory Group(s) from the appliance. Can provide Group Name or Object for removal.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-g, -Group, -Name]
Configured Directory Group Name.
Aliases g, Group, Name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Group resource object
Collection of Group resource objects
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVLdapGroup -Group "My Directory Group1"

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLdapGroup | Remove-HPOVLdapGroup
Get all groups and remove them from all connected appliances. ### Related Links * [Get-HPOVLdapGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLdapGroup) * [New-HPOVLdapGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapGroup) * [Set-HPOVLdapGroupRole]
Top
### HPE OneView 4.00 Library ## Remove-HPOVLdapGroup
Remove Directory Group. ### SYNTAX
Remove-HPOVLdapGroup [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Co

Remove Directory Group(s) from the appliance. Can provide Group Name or Object for removal.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-g, -Group, -Name]
Configured Directory Group Name.
Aliases g, Group, Name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Group resource object
Collection of Group resource objects
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVLdapGroup -Group "My Directory Group1"
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLdapGroup | Remove-HPOVLdapGroup
Get all groups and remove them from all connected appliances.
Related Links
Get-HPOVLdapGroup
New-HPOVLdapGroup
Show-HPOVLdapGroups
Top

Remove an existing LDAP Directory Server.
SYNTAX
Remove-HPOVLdapServer [-InputObject] <Object> [-DirectoryServerName] <String> [-Username] <String>[ [-Password]
<Object>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Remove-HPOVLdapServer [-InputObject] <Object> [-DirectoryServerName] <String>[ [-Credential] <PSCredential>][ [-

ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This Cmdlet will remove an existing LDAP Directory Server resource from an existing LDAP Directory.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-DirectoryServerName <String>
Aliases [-Name] Directory server name.
Aliases Name
Required? true
Position? named
Default value
Aliases Directory
Required? true
Position? named
Default value
-Password <Object>
object.
Aliases p, pass
Required? false
Position? named
Default value
-Username <String>
Aliases u, user
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdapDirectory -Name MyDirectory | Remove-HPOVLdapServer -DirectoryServerName servera.domain.com -Usernam

e MyAdminName -Password (ConvertTo-SecureString "MyPAssword" -AsPlanText -Force)
Remove the specified LDAP Directory server from "MyDirectory". Will be prompted for confirmation. ### Related Links * [Add-
HPOVLdapServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVLdapServer) * [New-HPOVLdapServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLdapServer) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVLdapServer
Remove an existing LDAP Directory Server. ### SYNTAX
Remove-HPOVLdapServer [-InputObject] <Object> [-DirectoryServerName] <String> [-Username] <String>[ [-Password]

<Object>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Remove-HPOVLdapServer [-InputObject] <Object> [-DirectoryServerName] <String>[ [-Credential] <PSCredential>][ [-

ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This Cmdlet will remove an existing LDAP Directory Server resource from an existing LDAP Directory.
Parameters
Aliases Appliance
Required? false
Position? named

-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-DirectoryServerName <String>
Aliases [-Name] Directory server name.
Aliases Name
Required? true
Position? named
Default value
Aliases Directory
Required? true
Position? named
Default value
-Password <Object>
object.
Aliases p, pass
Required? false
Position? named
Default value
-Username <String>
Aliases u, user
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLdapDirectory -Name MyDirectory | Remove-HPOVLdapServer -DirectoryServerName servera.domain.com -Usernam

e MyAdminName -Password (ConvertTo-SecureString 'MyPAssword' -AsPlanText -Force)
Remove the specified LDAP Directory server from 'MyDirectory'. Will be prompted for confirmation.
Related Links
Add-HPOVLdapServer
New-HPOVLdapServer
Top
Remove-HPOVLicense

Remove-HPOVLicense
REmove installed licenses on the appliance.
SYNTAX
Remove-HPOVLicense [-InputObject] <HPOneView.Appliance.License> [-ApplianceConnection] <Object>[ [-WhatIf] <Swit
chParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will remove licenses installed on the appliance. Removing installed licenses is only support via Windows PowerShell,
Python or the HPE OneView REST API. However, if a license key is currently assigned to a resource, the license key cannot be
removed.
Parameters
Aliases Appliance
Required? true
Position? named

Aliases cf
Required? false
Position? named
Default value
-InputObject <HPOneView.Appliance.License>
Aliases [-uri, -name, -License]
Provide the License URI or object to remove.
Aliases uri, name, license, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPE OneView License object
Return Values
Success message
Error message of in-use license key
Examples
-------------------------- EXAMPLE 1 --------------------------
$LicenseKeys = Get-HPOVlicense
Remove-HPOVLicense -InputObject $LicenseKeys[0]
Get all installed licenses saving them to $LicenseKeys, then calling Remove-HPOVLicense to remove the first key in the
variable.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVlicense | Remove-HPOVLicense
Get all installed licenses and remove them. ### Related Links * [Get-HPOVLicense](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVLicense) * [New-HPOVLicense](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVLicense) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVLicense
REmove installed licenses on the appliance. ### SYNTAX
Remove-HPOVLicense [-InputObject] <HPOneView.Appliance.License> [-ApplianceConnection] <Object>[ [-WhatIf] <Swit

chParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will remove licenses installed on the appliance. Removing installed licenses is only support via Windows PowerShell,
Python or the HPE OneView REST API. However, if a license key is currently assigned to a resource, the license key cannot be
removed.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
-InputObject <HPOneView.Appliance.License>
Aliases [-uri, -name, -License]
Provide the License URI or object to remove.
Aliases uri, name, license, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPE OneView License object
Return Values
Success message
Error message of in-use license key
Examples
-------------------------- EXAMPLE 1 --------------------------
$LicenseKeys = Get-HPOVlicense
Remove-HPOVLicense -InputObject $LicenseKeys[0]
Get all installed licenses saving them to $LicenseKeys, then calling Remove-HPOVLicense to remove the first key in the
variable.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVlicense | Remove-HPOVLicense
Get all installed licenses and remove them.
Related Links
Get-HPOVLicense
New-HPOVLicense
Top

Remove a Logical Enclosure.
SYNTAX
Remove-HPOVLogicalEnclosure [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][
[-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This cmdlet willRemove a Logical Enclosure. Removing a Logical Enclosure is only supported with Synergy. If a C7000
Enclosure needs to be removed, use the Remove-HPOVEnclosure Cmdlet.
Parameters

Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Forcefully remove the Logical Enclosure resource.
Aliases None
Required? false
Position? named
Default value False
Aliases [-uri, -name-, le]
Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to remove.
Aliases uri, name, le, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Logical Enclosure resource
Multiple Logical Enclosure resources
Return Values
Async task Resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalEnclosure LogicalEnclosure1 | Remove-HPOVLogicalEnclosure
Remove "LogicalEnclosure1" Logical Enclosure resource. ### Related Links * [Get-HPOVLogicalEnclosure]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalEnclosure) * [New-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalEnclosure) * [Set-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVLogicalEnclosure) * [Update-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVLogicalEnclosure) * [Update-
Top
### HPE OneView 4.00 Library ## Remove-HPOVLogicalEnclosure
Remove a Logical Enclosure. ### SYNTAX
Remove-HPOVLogicalEnclosure [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-Force] <SwitchParameter>][

This cmdlet willRemove a Logical Enclosure. Removing a Logical Enclosure is only supported with Synergy. If a C7000
Enclosure needs to be removed, use the Remove-HPOVEnclosure Cmdlet.
Parameters

Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Forcefully remove the Logical Enclosure resource.
Aliases None
Required? false
Position? named
Default value False
Aliases [-uri, -name-, le]
Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to remove.
Aliases uri, name, le, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async task Resource object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalEnclosure LogicalEnclosure1 | Remove-HPOVLogicalEnclosure
Remove 'LogicalEnclosure1' Logical Enclosure resource.
Related Links
Top

Remove a Logical Interconnect Group.
SYNTAX
Remove-HPOVLogicalInterconnectGroup [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-force] <SwitchPar
ameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Removes a Logical Interconnect Group from appliance management
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-name, -uri, -Lig] The logical interconnect group object(s), name(s) or uris(s) to be removed from management.
Aliases uri, name, Lig, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
-force <SwitchParameter>
Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed.
Force remove succeeds even if there are network connectivity issues or resource errors. -Force is not a PowerShell option,
rather an HPE OneView API feature. This does not override the -Confirm PowerShell option.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
System.String
Logical Interconnect Group Name or URI
Logical Interconnect Group resource object
Return Values
Removal Task
Examples
-------------------------- EXAMPLE 1 --------------------------
$lig = Get-HPOVLogicalInterconnectGroup -Name "My-LIG"

Remove-HPOVLogicalInterconnectGroup $lig -confirm:$false
Remove the logical interconnect group specifed by $lig. Disable confirmation prompt.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnectGroup | Remove-HPOVLogicalInterconnectGroup
Search for all logical interconnect groups and remove them from all connected appliances. ### Related Links * [Get-
HPOVLogicalInterconnectGroup) * [New-HPOVLogicalInterconnectGroup](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVLogicalInterconnectGroup) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVLogicalInterconnectGroup
Remove a Logical Interconnect Group. ### SYNTAX
Remove-HPOVLogicalInterconnectGroup [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-force] <SwitchPar

ameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Removes a Logical Interconnect Group from appliance management
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-name, -uri, -Lig] The logical interconnect group object(s), name(s) or uris(s) to be removed from management.
Aliases uri, name, Lig, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed.
Force remove succeeds even if there are network connectivity issues or resource errors. -Force is not a PowerShell option,
rather an HPE OneView API feature. This does not override the -Confirm PowerShell option.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
System.String
Logical Interconnect Group Name or URI
Logical Interconnect Group resource object
Return Values
Removal Task
Examples
-------------------------- EXAMPLE 1 --------------------------
$lig = Get-HPOVLogicalInterconnectGroup -Name "My-LIG"

Remove-HPOVLogicalInterconnectGroup $lig -confirm:$false
Remove the logical interconnect group specifed by $lig. Disable confirmation prompt.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalInterconnectGroup | Remove-HPOVLogicalInterconnectGroup
Search for all logical interconnect groups and remove them from all connected appliances.
Related Links
Top

Remove a new Logical Switch resource.
SYNTAX
Remove-HPOVLogicalSwitch [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Force] <SwitchParameter>][
[-Async] <SwitchParameter>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will remove the configured Logical Switch from the requested appliance(s). When you delete a logical switch, HPE
OneView no longer manages the physical switches associated with it. Required privileges: Infrastructure administrator or
Network administrator
Parameters
Aliases Appliance
Required? false
Position? named

Aliases None
Required? false
Position? named
Default value
Bypass the confirmation prompt, and process all of the objects.
Aliases cf
Required? false
Position? named
Default value
Force remove resource, even if there are communication problems.
Aliases None
Required? false
Position? named
Default value
The Logical Switch resource Name or Object to update.
Aliases ls, LogicalSwitch
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Logical Switch resource.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalSwitch | Remove-HPOVLogicalSwitch
Remove all logical switch resources found on the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitch -Name "My Logical Switch 1" | Remove-HPOVLogicalSwitch -confirm:$false
Remove the "My Logical Switch 1" resource. ### Related Links * [Get-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalSwitchGroup) * [New-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitch) * [New-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitchGroup) * [Remove-
HPOVLogicalSwitchGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitchGroup) *
[Update-HPOVLogicalSwitch](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVLogicalSwitch) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVLogicalSwitch
Remove a new Logical Switch resource. ### SYNTAX
Remove-HPOVLogicalSwitch [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Force] <SwitchParameter>][

[-Async] <SwitchParameter>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will remove the configured Logical Switch from the requested appliance(s). When you delete a logical switch, HPE
OneView no longer manages the physical switches associated with it. Required privileges: Infrastructure administrator or
Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value

Aliases ls, LogicalSwitch
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalSwitch | Remove-HPOVLogicalSwitch
Remove all logical switch resources found on the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitch -Name "My Logical Switch 1" | Remove-HPOVLogicalSwitch -confirm:$false
Remove the "My Logical Switch 1" resource.
Related Links
Top

Remove a new Logical Switch Group resource.
SYNTAX
Remove-HPOVLogicalSwitchGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Force] <SwitchParamet
er>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will remove the configured Logical Switch Group from the requested appliance(s). You cannot delete a logical
switch group while it is being used by one or more logical switches. To delete the logical switch group, first delete the logical
switches using the logical switch group. Required privileges: Infrastructure administrator or Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases ls, LogicalSwitchGroup
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The async task resource object results.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalSwitchGroup | Remove-HPOVLogicalSwitchGroup
Remove all logical switch group resources found on the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1" | Remove-HPOVLogicalSwitchGroup -confirm:$fa
lse
Remove the "My Logical SwitchGroup Policy 1" resource. ### Related Links * [Get-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalSwitchGroup) * [New-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitchGroup) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVLogicalSwitchGroup
Remove a new Logical Switch Group resource. ### SYNTAX
Remove-HPOVLogicalSwitchGroup [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Force] <SwitchParamet

er>] [-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will remove the configured Logical Switch Group from the requested appliance(s). You cannot delete a logical
switch group while it is being used by one or more logical switches. To delete the logical switch group, first delete the logical
switches using the logical switch group. Required privileges: Infrastructure administrator or Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases ls, LogicalSwitchGroup
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The async task resource object results.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalSwitchGroup | Remove-HPOVLogicalSwitchGroup
Remove all logical switch group resources found on the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1" | Remove-HPOVLogicalSwitchGroup -confirm:$fa
lse
Remove the "My Logical SwitchGroup Policy 1" resource.
Related Links
Top
Remove-HPOVNetwork

Remove-HPOVNetwork
Delete network from appliance configuration.
SYNTAX
Remove-HPOVNetwork [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatI
f] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete a network and its corresponding default connection type.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Forcefully remove the network object.
Aliases None
Required? false
Position? named
Default value False

Aliases [-name, -Network]
The network object(s) or name(s) to be deleted.
Aliases uri, name, network, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
System.String
Network Name or URI
Network Resource Object
Return Values
Async Removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVNetwork -network "yellow"

Remove the network specifed by name. Wait for remove to complete.

-------------------------- EXAMPLE 2 --------------------------
$Net = Get-HPOVNetwork -name "yellow"

Remove-HPOVNetwork -network $net -confirm:$false
Remove the network specifed by $net, and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVNetwork | Remove-HPOVNetwork
Search for all networks and remove them from appliance. ### Related Links * [Get-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVNetworkSet) * [New-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetwork) * [New-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetworkSet) * [Remove-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetworkSet) * [Set-HPOVNetwork]
Top
### HPE OneView 4.00 Library ## Remove-HPOVNetwork
Delete network from appliance configuration. ### SYNTAX
Remove-HPOVNetwork [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatI

f] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete a network and its corresponding default connection type.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Forcefully remove the network object.
Aliases None
Required? false
Position? named
Default value False
Aliases [-name, -Network]
The network object(s) or name(s) to be deleted.
Aliases uri, name, network, Resource
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
System.String
Network Name or URI
Network Resource Object

Return Values
Async Removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVNetwork -network "yellow"

Remove the network specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$Net = Get-HPOVNetwork -name "yellow"

Remove-HPOVNetwork -network $net -confirm:$false
Remove the network specifed by $net, and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVNetwork | Remove-HPOVNetwork
Search for all networks and remove them from appliance.
Related Links
Get-HPOVNetwork
Get-HPOVNetworkSet
New-HPOVNetwork
New-HPOVNetworkSet
Set-HPOVNetwork
Set-HPOVNetworkSet
Top

Remove a network set.
SYNTAX
Remove-HPOVNetworkSet [-NetworkSet] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Co
Delete a network set and its corresponding default connection type.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
-NetworkSet <Object>
Aliases [-name, -uri] The network set object(s), name(s) or uri(s) to be deleted. If providing a URI, you must specify an Applinace
Connection.
Aliases uri, name
Required? true
Position? named
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Network Set resource object
Return Values
Removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVNetworkSet -networkSet "MyNetSet"

Remove the network set specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$netSet = Get-HPOVNetworkSet -name "MyNetSet" | Remove-HPOVNetwork
Remove the specified network set.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVNetworkSet | Remove-HPOVNetworkSet
Search for all network sets and remove them from appliance. ### Related Links * [Get-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVNetworkSet) * [New-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetworkSet) * [Set-HPOVNetworkSet]
Top
### HPE OneView 4.00 Library ## Remove-HPOVNetworkSet
Remove a network set. ### SYNTAX

Remove-HPOVNetworkSet [-NetworkSet] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Co
Delete a network set and its corresponding default connection type.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-name, -uri] The network set object(s), name(s) or uri(s) to be deleted. If providing a URI, you must specify an Applinace
Connection.
Aliases uri, name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Network Set resource object
Return Values
Removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVNetworkSet -networkSet "MyNetSet"

Remove the network set specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$netSet = Get-HPOVNetworkSet -name "MyNetSet" | Remove-HPOVNetwork
Remove the specified network set.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVNetworkSet | Remove-HPOVNetworkSet
Search for all network sets and remove them from appliance.
Related Links
Get-HPOVNetworkSet
New-HPOVNetworkSet
Set-HPOVNetworkSet
Top
Remove an HPE Synergy Image Streamer OS Deployment server.
SYNTAX
Remove-HPOVOSDeploymentServer [-InputObject] <HPOneView.Appliance.OSDeploymentServer>[ [-Force] <SwitchParameter
>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>
]
Deleting an Image Streamer OS deployment server removes the management and storage networking configurations of all the
Image Streamer appliances configured in HPE OneView. In addition, the Image Streamer appliances are reset to factory
defaults, removing all OS deployment artifacts and all OS volumes.
In order to successfully remove an OS Deployment Server, all associated Logical Enclosures must first be removed. If a Logical
Enclosure does not contain an HPE Synergy Image Streamer appliance, then it does not need to be removed.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False

-Confirm <>
Aliases cf
Required?
Position? named
Default value
Forceably remove an OS Deployment Server.
Aliases None
Required? false
Position? named
Default value False
-InputObject <HPOneView.Appliance.OSDeploymentServer>
OS Deployment Server object, from Get-HPOVOSDeploymentServer.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
HPE Synergy Image Streamer OS Deployment Server from Get-HPOVOSDeploymentServer
Return Values
Resource removal async task.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVOSDeploymentServer | Remove-HPOVOSDeploymentServer
Remove OS Deployment Servers from the appliance. ### Related Links * [Get-HPOVOSDeploymentServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVOSDeploymentServer) * [New-HPOVOSDeploymentServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVOSDeploymentServer) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVOSDeploymentServer
Remove an HPE Synergy Image Streamer OS Deployment server. ### SYNTAX
Remove-HPOVOSDeploymentServer [-InputObject] <HPOneView.Appliance.OSDeploymentServer>[ [-Force] <SwitchParameter

>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>
]
Deleting an Image Streamer OS deployment server removes the management and storage networking configurations of all the
Image Streamer appliances configured in HPE OneView. In addition, the Image Streamer appliances are reset to factory
defaults, removing all OS deployment artifacts and all OS volumes.
In order to successfully remove an OS Deployment Server, all associated Logical Enclosures must first be removed. If a Logical
Enclosure does not contain an HPE Synergy Image Streamer appliance, then it does not need to be removed.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Forceably remove an OS Deployment Server.
Aliases None
Required? false
Position? named
Default value False
-InputObject <HPOneView.Appliance.OSDeploymentServer>
OS Deployment Server object, from Get-HPOVOSDeploymentServer.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value

<CommonParameters>
Input Types
HPE Synergy Image Streamer OS Deployment Server from Get-HPOVOSDeploymentServer
Return Values
Resource removal async task.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVOSDeploymentServer | Remove-HPOVOSDeploymentServer
Remove OS Deployment Servers from the appliance.
Related Links
Top

Remove pending or staged appliance update.
SYNTAX
Remove-HPOVPendingUpdate [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParame
Remove a pending or staged appliance update that prevents the appliance from operating normally or the administrator would
like to update the appliance with a different update file.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
None.
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove any found pending update any connectioned appliances.
-------------------------- EXAMPLE 2 --------------------------
Remove any found pending update specified appliance connection. ### Related Links * [Get-HPOVPendingUpdate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVPendingUpdate) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVPendingUpdate
Remove pending or staged appliance update. ### SYNTAX
Remove-HPOVPendingUpdate [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParame

Remove a pending or staged appliance update that prevents the appliance from operating normally or the administrator would
like to update the appliance with a different update file.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
None.
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove any found pending update any connectioned appliances.
-------------------------- EXAMPLE 2 --------------------------
Remove any found pending update specified appliance connection.
Related Links
Top

Remove power device (iPDU)
SYNTAX
Remove-HPOVPowerDevice [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-Appl
ianceConnection] <Object>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Removes a power device (iPDU) from appliance management.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Set to $true to force-remove the power device. Force-removing will succeed even when there are connectivity issues or
resource errors.
Aliases None
Required? false
Position? named
Default value False
The Power Device object(s), name(s) or uri(s) to be removed from management.
Aliases uri, name, PowerDevice
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Power Device (iPDU) Resource Object
Return Values
Async remove task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVPowerDevice -PowerDevice "iPDU16" | Wait-HPOVTaskComplete
Remove the power device specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$ipdu = Get-HPOVPowerDevice -name "iPDU24"

Remove-HPOVPowerDevice -PowerDevice $ipdu -force -confirm:$false
Force-Remove the profile specifed by $ipdu. Disable confirmation prompt.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVPowerDevice | Remove-HPOVPowerDevice
Search for all power devices and remove them from appliance. ### Related Links * [Add-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVPowerDevice) * [Add-HPOVPowerDeviceConnection]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVPowerDeviceConnection) * [Get-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVPowerDevice) * [New-HPOVPowerDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVPowerDevice) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVPowerDevice
Remove power device (iPDU) ### SYNTAX
Remove-HPOVPowerDevice [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-Appl

ianceConnection] <Object>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Removes a power device (iPDU) from appliance management.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False

Aliases cf
Required? false
Position? named
Default value
Set to $true to force-remove the power device. Force-removing will succeed even when there are connectivity issues or
resource errors.
Aliases None
Required? false
Position? named
Default value False
The Power Device object(s), name(s) or uri(s) to be removed from management.
Aliases uri, name, PowerDevice
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Power Device (iPDU) Resource Object
Return Values
Async remove task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVPowerDevice -PowerDevice "iPDU16" | Wait-HPOVTaskComplete
Remove the power device specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$ipdu = Get-HPOVPowerDevice -name "iPDU24"

Remove-HPOVPowerDevice -PowerDevice $ipdu -force -confirm:$false
Force-Remove the profile specifed by $ipdu. Disable confirmation prompt.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVPowerDevice | Remove-HPOVPowerDevice
Search for all power devices and remove them from appliance.
Related Links
Add-HPOVPowerDevice
Get-HPOVPowerDevice
New-HPOVPowerDevice
Top
Remove-HPOVRack

Remove-HPOVRack
Remove a rack resource.
SYNTAX
Remove-HPOVRack [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonPar
ameters>]
This Cmdlet will remove an existing Rack resource. Removing a rack resource will not remove the associated rack members.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Rack object, from Get-HPOVRack.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRack -Name Rack-221 | Remove-HPOVRack
Remove "Rack-221" rack resource from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRack | Remove-HPOVRack
Remove rack resources from the appliance. ### Related Links * [Add-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVRackManager) * [Add-HPOVRackToDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVRackToDataCenter) * [Get-HPOVRack]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRack) * [Get-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRackManager) * [Get-HPOVRackMember]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRackMember) * [New-HPOVRack]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVRack) * [Remove-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRackManager) * [Remove-HPOVRackMember]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRackMember) * [Set-HPOVRackMemberLocation]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRackMemberLocation) * [Update-HPOVRackManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVRackManager) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVRack
Remove a rack resource. ### SYNTAX
Remove-HPOVRack [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonPar
ameters>]
This Cmdlet will remove an existing Rack resource. Removing a rack resource will not remove the associated rack members.
Parameters
Aliases Appliance
Required? false
Position? named

-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRack -Name Rack-221 | Remove-HPOVRack
Remove 'Rack-221' rack resource from the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVRack | Remove-HPOVRack
Remove rack resources from the appliance.
Related Links
Get-HPOVRack
Get-HPOVRackMember
New-HPOVRack
Top

Remove rack manager from appliance.
SYNTAX
Remove-HPOVRackManager [-InputObject] <HPOneView.Servers.RackManager>[ [-ApplianceConnection] <Array>][ [-Force]
<SwitchParameter>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
manager platforms within a rack. This Cmdlet will remove a claimed rack manager resource from the appliance. Minimum
required privileges: Infrastructure administrator or Server administrator.
Parameters

Aliases Appliance
Required? False
Position? 1
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Force remove resource, in cases where the device manager has been re-addressed and is no longer accessible, or there are
other communication issues preventing the resource removal.
Aliases None
Required? false
Position? named
Default value
-InputObject <HPOneView.Servers.RackManager>
An HPOneView.Servers.RackManager resource from Get-HPOVRackManager.
Aliases uri, name, Server
Required? true
Position? 0
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
An HPOneView.Servers.RackManager resource from Get-HPOVRackManager.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRackManager -Name rackmanager2.domain.com -ErrorAction Stop | Remove-HPOVRackManager
Remove the provided rack manager resource from the appliance.
Related Links
Add-HPOVRackManager
Get-HPOVRackManager
Top

Remove a member resource from a rack.
SYNTAX
Remove-HPOVRackMember [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<Com
monParameters>]
depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can
use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical
dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the
rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You
can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack
height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices
when they are relocated within and between racks for c7000 enclosures. This Cmdlet will remove a member from an existing
Rack resource. Removing a rack member resource will not delete or remove the resource from the appliance, just the
association with the rack.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Rack member resource from Get-HPOVRackMember.
Return Values
HPOneView.Appliance.TaskResource
Async task object of updating the associated rack.
Examples
-------------------------- EXAMPLE 1 --------------------------
$RackMember = Get-HPOVRack -Name Rack-221 -ErrorAction Stop | Get-HPOVRackMember -Name DL380-1 -ErrorAction Stop
Remove-HPOVRackMember -InputObject $Rack1Member
Remove "Rack-221" rack resource from the appliance. ### Related Links * [Get-HPOVRackMember]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRackMember) * [Set-HPOVRackMemberLocation]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVRackMemberLocation) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVRackMember
Remove a member resource from a rack. ### SYNTAX
Remove-HPOVRackMember [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<Com
monParameters>]
This Cmdlet will remove a member from an existing Rack resource. Removing a rack member resource will not delete or remove
the resource from the appliance, just the association with the rack.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Rack member resource from Get-HPOVRackMember.
Return Values
HPOneView.Appliance.TaskResource
Async task object of updating the associated rack.
Examples
-------------------------- EXAMPLE 1 --------------------------
$RackMember = Get-HPOVRack -Name Rack-221 -ErrorAction Stop | Get-HPOVRackMember -Name DL380-1 -ErrorAction Stop
Remove-HPOVRackMember -InputObject $Rack1Member
Remove 'Rack-221' rack resource from the appliance.
Related Links
Get-HPOVRackMember
Top

Remove a Remote Support contact.
SYNTAX
Remove-HPOVRemoteSupportContact [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm
] <> [<CommonParameters>]
Use this Cmdlet to remove an existing Remote Support Contact. The Default contact cannot be removed, and at least 1 contact
must be configured before attempting to register the appliance with HPE support using the Set-HPOVRemoteSupport Cmdlet.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases [-Contact] The contacts first or given name.
Aliases Contact
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
A Remote Support Contact from Get-HPOVRemoteSupportContact.
Return Values
Resource deleted response.
Examples
-------------------------- EXAMPLE 1 --------------------------

Configure a new user who is the default contact. ### Related Links * [Get-HPOVRemoteSupportContact]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportContact) * [New-
HPOVRemoteSupportContact](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVRemoteSupportContact) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVRemoteSupportContact
Remove a Remote Support contact. ### SYNTAX
Remove-HPOVRemoteSupportContact [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm

Use this Cmdlet to remove an existing Remote Support Contact. The Default contact cannot be removed, and at least 1 contact
must be configured before attempting to register the appliance with HPE support using the Set-HPOVRemoteSupport Cmdlet.
Parameters
Aliases Appliance
Required? false
Position? named

-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases [-Contact] The contacts first or given name.
Aliases Contact
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
A Remote Support Contact from Get-HPOVRemoteSupportContact.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

Configure a new user who is the default contact.
Related Links
Top

Remove Remote Support support and reseller partners.
SYNTAX
Remove-HPOVRemoteSupportPartner [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm
Use this Cmdlet to remove defined Remote Support partner from a specified or all appliances.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Remote Suport partner resource object, from Get-HPOVRemoteSupportPartner.
Aliases Partner
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Remote Suport partner resource from Get-HPOVRemoteSupportPartner.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRemoteSupportPartner -Name "ABC IT Vendor" -ErrorAction Stop | Remove-HPOVRemoteSupportPartner
Remove the specified remote support partner from the appliance. ### Related Links * [Get-HPOVRemoteSupportPartner]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportPartner) * [New-
HPOVRemoteSupportPartner](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVRemoteSupportPartner) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVRemoteSupportPartner
Remove Remote Support support and reseller partners. ### SYNTAX
Remove-HPOVRemoteSupportPartner [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm

Use this Cmdlet to remove defined Remote Support partner from a specified or all appliances.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Remote Suport partner resource object, from Get-HPOVRemoteSupportPartner.
Aliases Partner
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Remote Suport partner resource from Get-HPOVRemoteSupportPartner.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRemoteSupportPartner -Name 'ABC IT Vendor' -ErrorAction Stop | Remove-HPOVRemoteSupportPartner
Remove the specified remote support partner from the appliance.
Related Links
Top
Remove-HPOVResource

Remove-HPOVResource
Remove existing resource(s).
SYNTAX
Remove-HPOVResource [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-force] <SwitchParameter>] [<Commo
nParameters>]
Removes a resource identified by either the resource uri or a resource object. Remove-HPOVResource can be called with either
-nameOrUri or -resource.
*** This cmdlet will not prompt for delete confirmation. Please use with caution. ***
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases [-ro, -name, -uri, -nameOruri] A resource to be deleted. Value can be either resource object, Name or URI.
Aliases ro, nameOruri, uri, name, Resource
Required? true
Position? 0
Default value
Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed. -
Force is not a PowerShell option, rather an HPE OneView API feature. This does not override the -Confirm PowerShell option.
Not all resources support force-delete.
Aliases None
Required? false
Position? named
Default value False

<CommonParameters>
Input Types
A valid resource object first retrieved by a call to a Get-HPOV*** cmdlet
Return Values
Removal async task
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVResource -Resource "/rest/resource/1234-5678-9123"
Removes the resource specified by the URI.

-------------------------- EXAMPLE 2 --------------------------
Remove-HPOVResource -nameOrUri "ServerProfile-A"
Removes the resource named "ServerProfile-A". If multiple resources exist with the name "ServerProfile-A", an error is returned.
-------------------------- EXAMPLE 3 --------------------------
$MyResourceObject = send-hpovrequest "/rest/resource/1234-5678-9123"

Remove-HPOVResource -Resource $MyResourceObject
Removes the resource $MyReSourceObject. ### Related Links * [Add-HPOVResourceToLabel]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVResourceToScope) * [New-HPOVResource]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVResource) * [Remove-HPOVResourceFromLabel]
HPOVResourceFromScope](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVResourceFromScope) *
[Set-HPOVResource](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVResource) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVResource
Remove existing resource(s). ### SYNTAX
Remove-HPOVResource [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-force] <SwitchParameter>] [<Commo

nParameters>]
Removes a resource identified by either the resource uri or a resource object. Remove-HPOVResource can be called with either
-nameOrUri or -resource.
*** This cmdlet will not prompt for delete confirmation. Please use with caution. ***
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases [-ro, -name, -uri, -nameOruri] A resource to be deleted. Value can be either resource object, Name or URI.
Aliases ro, nameOruri, uri, name, Resource
Required? true
Position? 0
Default value
Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed. -
Force is not a PowerShell option, rather an HPE OneView API feature. This does not override the -Confirm PowerShell option.
Not all resources support force-delete.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
A valid resource object first retrieved by a call to a Get-HPOV*** cmdlet

Return Values
Removal async task
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVResource -Resource "/rest/resource/1234-5678-9123"
Removes the resource specified by the URI.
-------------------------- EXAMPLE 2 --------------------------
Remove-HPOVResource -nameOrUri "ServerProfile-A"
Removes the resource named "ServerProfile-A". If multiple resources exist with the name "ServerProfile-A", an error is returned.
-------------------------- EXAMPLE 3 --------------------------
$MyResourceObject = send-hpovrequest "/rest/resource/1234-5678-9123"

Remove-HPOVResource -Resource $MyResourceObject
Removes the resource $MyReSourceObject.
Related Links
New-HPOVResource
Set-HPOVResource
Top

Remove association of resource with existing Label.
SYNTAX
Remove-HPOVResourceFromLabel [-Name] <String> [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf
Remove-HPOVResourceFromLabel [-InputObject] <Object> [-RemoveAllLabelsFromResource] <SwitchParameter>[ [-Applian

ceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This Cmdlet will remove the specified resource from the requested label. To remove the resource from all labels, use the -
RemoveAllLabelsFromResource switch parameter. If there are no more associated resources with a label, the appliance will
automatically delete the label.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
The resource to remove associatation with the label.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
-RemoveAllLabelsFromResource <SwitchParameter>
Use to remove all associated labels with the provide resource.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Resource to remove label association.
Return Values

Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVNetwork -Name Finance* | Remove-HPOVResourceFromLabel -Name Finance
Remove the Finance network resources from the "Finance" label.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVNetwork | Remove-HPOVResourceFromLabel -RemoveAllLabelsFromResource
Remove all label associations from network resources. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVResourceFromLabel
Remove association of resource with existing Label. ### SYNTAX
Remove-HPOVResourceFromLabel [-Name] <String> [-InputObject] <Object>[ [-ApplianceConnection] <Object>] [-WhatIf

Remove-HPOVResourceFromLabel [-InputObject] <Object> [-RemoveAllLabelsFromResource] <SwitchParameter>[ [-Applian

ceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
This Cmdlet will remove the specified resource from the requested label. To remove the resource from all labels, use the -
RemoveAllLabelsFromResource switch parameter. If there are no more associated resources with a label, the appliance will
automatically delete the label.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
The resource to remove associatation with the label.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
-RemoveAllLabelsFromResource <SwitchParameter>
Use to remove all associated labels with the provide resource.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Resource to remove label association.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVNetwork -Name Finance* | Remove-HPOVResourceFromLabel -Name Finance
Remove the Finance network resources from the 'Finance' label.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVNetwork | Remove-HPOVResourceFromLabel -RemoveAllLabelsFromResource
Remove all label associations from network resources.
Related Links
Top

Remove supported resource(s) from Scope.
SYNTAX
Remove-HPOVResourceFromScope [-Scope] <HPOneView.Appliance.ScopeCollection> [-InputObject] <Object>[ [-Async] <S
witchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Aliases Resource
Required? true
Position? named
Default value

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Resources += Get-HPOVNetwork -Name ProdVLan*

$Resources += Get-HPOVServer -Name Encl1*
Add the resources collected to the MyScope scope. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVResourceFromScope
Remove supported resource(s) from Scope. ### SYNTAX
Remove-HPOVResourceFromScope [-Scope] <HPOneView.Appliance.ScopeCollection> [-InputObject] <Object>[ [-Async] <S

witchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
* Enclosures
* Server Hardware
* Network Sets
* Switches
* Logical Switches
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Aliases Resource
Required? true
Position? named
Default value

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Resources += Get-HPOVNetwork -Name ProdVLan

$Resources += Get-HPOVServer -Name Encl1
Add the resources collected to the MyScope scope.
Related Links
Top

Remove a SAN Manager.
SYNTAX
Remove-HPOVSanManager [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Co
This cmdlet is used to remove the specified SAN Manager from the appliance. Before removing a SAN Manager, the Managed
SAN resource must be removed from any configured FC or FCoE Network resources.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases cf
Required? false
Position? named
Default value
Aliases [-Name, -SanManager]
Managed SAN resource object or name to remove.
Aliases Name, SanManager
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
SAN Manager resource object(s)
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVSanManager bna.contoso.com
Remove the bna.contoso.com SAN Manager from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSanManager | Remove-HPOVSanManager
Remove all SAN Managers from all connected appliances. ### Related Links * [Add-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVSanManager) * [Get-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSanManager) * [Set-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVSanManager) * [Update-HPOVSanManager]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVSanManager) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVSanManager
Remove a SAN Manager. ### SYNTAX
Remove-HPOVSanManager [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Co

This cmdlet is used to remove the specified SAN Manager from the appliance. Before removing a SAN Manager, the Managed
SAN resource must be removed from any configured FC or FCoE Network resources.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases cf
Required? false
Position? named
Default value
Aliases [-Name, -SanManager]
Managed SAN resource object or name to remove.
Aliases Name, SanManager
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
SAN Manager resource object(s)
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVSanManager bna.contoso.com
Remove the bna.contoso.com SAN Manager from the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSanManager | Remove-HPOVSanManager
Remove all SAN Managers from all connected appliances.
Related Links
Add-HPOVSanManager
Get-HPOVSanManager
Set-HPOVSanManager
Top
Remove-HPOVScmbCertificate

Remove-HPOVScmbCertificate
Remove State Change Message Bus certificate from appliance.
SYNTAX
Remove-HPOVScmbCertificate [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Remove-HPOVScmbCertificate[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]

Remove the State Change Message Bus (SCMB) and Metric Streaming Message Bug (MSMB) read only account
(rabbitmq_readonly) certificate key pair from an appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVScmbCertificates
Remove the SCMB (rabbitmq_readonly) certificate key pair from an appliance. ### Related Links * [Get-HPOVScmbCertificates]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVScmbCertificates) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVScmbCertificate
Remove State Change Message Bus certificate from appliance. ### SYNTAX
Remove-HPOVScmbCertificate [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Remove-HPOVScmbCertificate[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Remove the State Change Message Bus (SCMB) and Metric Streaming Message Bug (MSMB) read only account
(rabbitmq_readonly) certificate key pair from an appliance.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVScmbCertificates
Remove the SCMB (rabbitmq_readonly) certificate key pair from an appliance.
Related Links
Top
Remove-HPOVScope

Remove-HPOVScope
Remove Scope from appliance
SYNTAX
Remove-HPOVScope [-Scope] <HPOneView.Appliance.ScopeCollection>[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-
Confirm] <> [<CommonParameters>]
This Cmdlet will remove a specific Scope.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Response indicating the resource was deleted successfully.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVScope MyScope | Remove-HPOVScope
Remove the specified scope. ### Related Links * [Get-HPOVScope](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Get-HPOVScope) * [New-HPOVScope](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVScope) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVScope
Remove Scope from appliance ### SYNTAX
Remove-HPOVScope [-Scope] <HPOneView.Appliance.ScopeCollection>[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-

Confirm] <> [<CommonParameters>]
This Cmdlet will remove a specific Scope.
Parameters
Aliases Appliance
Required? false
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Response indicating the resource was deleted successfully.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVScope MyScope | Remove-HPOVScope
Remove the specified scope.

Related Links
Get-HPOVScope
New-HPOVScope
Top
Remove-HPOVServer

Remove-HPOVServer
Remove a rackmount server from the appliance.
SYNTAX
Remove-HPOVServer [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatIf
Removes a physical server object from appliance management.
The server object can be specified by its name or its full URI on the appliance by using the -Server parameter. It can also be
supplied as an object by using the -resource parameter the object variable can be piped to Remove-HPOVServer.
Blade servers can only be removed by removing the enclosure (Remove-HPOVEnclosure), or phyhsically removing the blade
from the enclosure.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases cf
Required? false
Position? named
Default value
Use to force-remove the server. For example, if the server is gone or managed by a different appliance, force-remove will
remove the server from this appliance without removing any of the HPE OneView applied configuration.
Aliases None
Required? false
Position? named
Default value False
Aliases [-uri, -name, -Server] The Server object(s), name(s) or uri(s) to be removed from management.
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Provide the Server Resource Object
Return Values
Async removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVServer -name "Server-1234" -force

Force-remove the server specifed by name. Wait for remove to complete.

-------------------------- EXAMPLE 2 --------------------------
$server = Get-HPOVServer -name "Server-1234"

Remove-HPOVServer $server -confirm:$false
Remove the server specifed by $server. Disable confirmation prompt.

-------------------------- EXAMPLE 3 --------------------------

Remove-HPOVServer $server -confirm:$false -force
Remove the server specifed by $server. Disable confirmation prompt, and force remove the server.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServer | Remove-HPOVServer
Search for all rackmount servers and remove them from appliance. ### Related Links * [Add-HPOVServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVServer) * [Convert-HPOVServerProfile]
Top
### HPE OneView 4.00 Library ## Remove-HPOVServer
Remove a rackmount server from the appliance. ### SYNTAX
Remove-HPOVServer [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatIf

Removes a physical server object from appliance management.
The server object can be specified by its name or its full URI on the appliance by using the -Server parameter. It can also be
supplied as an object by using the -resource parameter the object variable can be piped to Remove-HPOVServer.
Blade servers can only be removed by removing the enclosure (Remove-HPOVEnclosure), or phyhsically removing the blade
from the enclosure.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases cf
Required? false
Position? named
Default value
Use to force-remove the server. For example, if the server is gone or managed by a different appliance, force-remove will
remove the server from this appliance without removing any of the HPE OneView applied configuration.
Aliases None
Required? false
Position? named
Default value False
Aliases [-uri, -name, -Server] The Server object(s), name(s) or uri(s) to be removed from management.
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Provide the Server Resource Object

Return Values
Async removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVServer -name "Server-1234" -force

Force-remove the server specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------

Remove-HPOVServer $server -confirm:$false
Remove the server specifed by $server. Disable confirmation prompt.
-------------------------- EXAMPLE 3 --------------------------

Remove-HPOVServer $server -confirm:$false -force
Remove the server specifed by $server. Disable confirmation prompt, and force remove the server.
-------------------------- EXAMPLE 4 --------------------------
Get-HPOVServer | Remove-HPOVServer
Search for all rackmount servers and remove them from appliance.
Related Links
Add-HPOVServer
Get-HPOVServer
Restart-HPOVServer
Set-HPOVServerPower
Start-HPOVServer
Stop-HPOVServer
Update-HPOVServer
Top

Delete Server Profile Resource(s).
SYNTAX
Remove-HPOVServerProfile [-ServerProfile] <Object> [-ApplianceConnection] <Object>[ [-force] <SwitchParameter>][
This cmdlet will remove Server Profile resources from one or more appliance connections. Server Profile objects or names are
supported. Server Profile resources can only be removed when the BladeSystem (BL) Server Hardware device is powered off.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-profile, -uri, -name] The server profile object(s), name(s) or URI(s) to be removed.
Aliases uri, name, profile
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Set to force-delete the profile. For example, force-remove will successfully remove the profile, even when connectivity has been
lost to the server or enclosure.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
System.String
Server Profile resource name.
Return Values
A task resource that can be monitored for status of the profile deletion
Examples
-------------------------- EXAMPLE 1 --------------------------


-------------------------- EXAMPLE 2 --------------------------


-------------------------- EXAMPLE 3 --------------------------
Search for all profiles and remove them from appliance. ### Related Links * [Convert-HPOVServerProfile]
HPOneView/wiki/New-HPOVServerProfileTemplate) * [Remove-HPOVServerProfileTemplate]
Top
### HPE OneView 4.00 Library ## Remove-HPOVServerProfile
Delete Server Profile Resource(s). ### SYNTAX
Remove-HPOVServerProfile [-ServerProfile] <Object> [-ApplianceConnection] <Object>[ [-force] <SwitchParameter>][

This cmdlet will remove Server Profile resources from one or more appliance connections. Server Profile objects or names are
supported. Server Profile resources can only be removed when the BladeSystem (BL) Server Hardware device is powered off.
Parameters
Aliases Appliance
Required? true
Position? named

Aliases cf
Required? false
Position? named
Default value
Aliases [-profile, -uri, -name] The server profile object(s), name(s) or URI(s) to be removed.
Aliases uri, name, profile
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
System.String
Server Profile resource name.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------

-------------------------- EXAMPLE 2 --------------------------

-------------------------- EXAMPLE 3 --------------------------
Search for all profiles and remove them from appliance.
Related Links
Top

Delete Server Profile Template Resource(s).
SYNTAX
Remove-HPOVServerProfileTemplate [-ServerProfileTemplate] <Object> [-ApplianceConnection] <Object>[ [-force] <Sw
itchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete one or multiple Server Profile Template resource(s). A Server Profile Template cannot be removed if there are linked
Server Profiles.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-spt, -name] The server profile template object(s) or name(s) to be removed.
Aliases spt, name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
System.String
Server Profile Template resource name.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVServerProfileTemplate -ServerProfileTemplate "My Template Profile"

Remove the profile template specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$spt = Get-HPOVServerProfileTemplate -name "My Template Profile"

Remove-HPOVServerProfileTemplate $spt -confirm:$false
Remove the profile template specifed by $spt. Disable confirmation prompt.

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServerProfileTemplate | Remove-HPOVServerProfileTemplate
Search for all profile template resources and remove them from appliance. ### Related Links * [Convert-
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileTemplate) * [Save-
***
Top
### HPE OneView 4.00 Library ## Remove-HPOVServerProfileTemplate
Delete Server Profile Template Resource(s). ### SYNTAX
Remove-HPOVServerProfileTemplate [-ServerProfileTemplate] <Object> [-ApplianceConnection] <Object>[ [-force] <Sw

itchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete one or multiple Server Profile Template resource(s). A Server Profile Template cannot be removed if there are linked
Server Profiles.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-spt, -name] The server profile template object(s) or name(s) to be removed.
Aliases spt, name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
System.String
Server Profile Template resource name.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVServerProfileTemplate -ServerProfileTemplate "My Template Profile"

Remove the profile template specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$spt = Get-HPOVServerProfileTemplate -name "My Template Profile"

Remove-HPOVServerProfileTemplate $spt -confirm:$false
Remove the profile template specifed by $spt. Disable confirmation prompt.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServerProfileTemplate | Remove-HPOVServerProfileTemplate
Search for all profile template resources and remove them from appliance.
Related Links
Top

Remove SNMPv3 user from appliance.
SYNTAX
Remove-HPOVSnmpV3User [-InputObject] <HPOneView.Appliance.SnmpV3User>[ [-ApplianceConnection] <Array>][ [-WhatIf
Parameters
Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
-InputObject <HPOneView.Appliance.SnmpV3User>
SNMPv3 user account from Get-HPOVSnmpV3User.
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Appliance SNMPv3 user account from Get-HPOVSnmpV3User.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Snmpv3User = Get-HPOVSnmpV3User -Name Tr@pUser -ErrorAction Stop | Remove-HPOVSnmpV3User
Remove the specific SNMPv3 user account on the appliance. ### Related Links * [Get-HPOVSnmpV3User]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSnmpV3User) * [New-HPOVSnmpV3User]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVSnmpV3User) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVSnmpV3User
Remove SNMPv3 user from appliance. ### SYNTAX
Remove-HPOVSnmpV3User [-InputObject] <HPOneView.Appliance.SnmpV3User>[ [-ApplianceConnection] <Array>][ [-WhatIf

Parameters

Aliases Appliance
Required? False
Position? named
Aliases cf
Required? false
Position? named
Default value
-InputObject <HPOneView.Appliance.SnmpV3User>
SNMPv3 user account from Get-HPOVSnmpV3User.
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Appliance SNMPv3 user account from Get-HPOVSnmpV3User.

Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Snmpv3User = Get-HPOVSnmpV3User -Name Tr@pUser -ErrorAction Stop | Remove-HPOVSnmpV3User
Remove the specific SNMPv3 user account on the appliance.
Related Links
Get-HPOVSnmpV3User
New-HPOVSnmpV3User
Top
Remove-HPOVStandbyComposerNode

Remove Standby Composer node.
SYNTAX
Remove-HPOVStandbyComposerNode [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchPa
rameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will help remove the Standby Composer node from the Synergy management ring. In order to remove the Active
node from the Synergy management ring, you first must use the Enable-HPOVComposerHANode Cmdlet to transition the
Standby node to the Active role.
Parameters
Aliases Appliance
Required? true
Position? 0
Default value (${Global:ConnectedSessions} | ? Default -eq $true)
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The Async task resource of the remove standby node request

Multiple Async task resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove the Standby Composer node in the default Appliance Connection. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVStandbyComposerNode
Remove Standby Composer node. ### SYNTAX
Remove-HPOVStandbyComposerNode [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchPa

rameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will help remove the Standby Composer node from the Synergy management ring. In order to remove the Active
node from the Synergy management ring, you first must use the Enable-HPOVComposerHANode Cmdlet to transition the
Standby node to the Active role.
Parameters
Aliases Appliance
Required? true
Position? 0
Default value (${Global:ConnectedSessions} | ? Default -eq $true)
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
The Async task resource of the remove standby node request
Multiple Async task resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove the Standby Composer node in the default Appliance Connection.
Related Links
Top

Delete storage pool resource(s).
SYNTAX
Remove-HPOVStoragePool [-InputObject] <Object>[ [-Force] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-W
Remove-HPOVStoragePool [-InputObject] <Object> [-StorageSystem] <Object>[ [-Force] <SwitchParameter>] [-Applianc

eConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete one or more storage pools from the appliance configuration.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
If specified, the Storage Pool resource will forceablly removed despite any problems with network connectivity or errors with the
resource.
Aliases None
Required? false
Position? named
Default value False
Aliases [-name, -StoragePool] The network object(s) or name(s) to be removed on the appliance.
Aliases uri, name, StoragePool
Required? true
Position? named
Default value
Aliases [-storage] Provide the Storage System Name, URI or Object when the StoragePool name is not unique.
Aliases storage
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Storage Pool resource, typically retrieved with Get-HPOVStoragePool

Return Values
Removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVStoragePool -storagePool "yellow" | Wait-HPOVTaskComplete $task
Remove the storage pool specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$pool = Get-HPOVStoragePool -name "yellow"

Remove-HPOVStoragePool -storagePool $pool -confirm:$false
Remove the network specifed by $pool, and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStoragePool | Remove-HPOVStoragePool
Search for all storage pools and remove them from appliance. ### Related Links * [Add-HPOVStoragePool]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVStoragePool) * [Get-HPOVStoragePool]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStoragePool) * [Set-HPOVStoragePool]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVStoragePool) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVStoragePool
Delete storage pool resource(s). ### SYNTAX
Remove-HPOVStoragePool [-InputObject] <Object>[ [-Force] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-W

Remove-HPOVStoragePool [-InputObject] <Object> [-StorageSystem] <Object>[ [-Force] <SwitchParameter>] [-Applianc

eConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete one or more storage pools from the appliance configuration.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
If specified, the Storage Pool resource will forceablly removed despite any problems with network connectivity or errors with the
resource.
Aliases None
Required? false
Position? named
Default value False
Aliases [-name, -StoragePool] The network object(s) or name(s) to be removed on the appliance.
Aliases uri, name, StoragePool
Required? true
Position? named
Default value
Aliases [-storage] Provide the Storage System Name, URI or Object when the StoragePool name is not unique.
Aliases storage
Required? true
Position? named
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Storage Pool resource, typically retrieved with Get-HPOVStoragePool
Return Values
Removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVStoragePool -storagePool "yellow" | Wait-HPOVTaskComplete $task
Remove the storage pool specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$pool = Get-HPOVStoragePool -name "yellow"

Remove-HPOVStoragePool -storagePool $pool -confirm:$false
Remove the network specifed by $pool, and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStoragePool | Remove-HPOVStoragePool
Search for all storage pools and remove them from appliance.
Related Links
Add-HPOVStoragePool
Get-HPOVStoragePool
Top

Remove a Storage System
SYNTAX
Remove-HPOVStorageSystem [-InputObject] <Object>[ [-force] <SwitchParameter>] [-ApplianceConnection] <Object>[ [
This cmdlet will assist with removing a discovered and managed storage system from the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-StorageSystem, -Name] Name or URI of the managed storage system.

Aliases uri, name, StorageSystem
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Switch to force removal of a storage system the appliance can no longer communicate with.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Storage System resource object
Collections of Storage System resource objects
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVStorageSystem HP3PAR_2
Remove "HP3PAR_2" storage system from the appliance. ### Related Links * [Add-HPOVStorageSystem]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVStorageSystem) * [Get-HPOVStorageSystem]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageSystem) * [Update-HPOVStorageSystem]
Top
### HPE OneView 4.00 Library ## Remove-HPOVStorageSystem
Remove a Storage System ### SYNTAX
Remove-HPOVStorageSystem [-InputObject] <Object>[ [-force] <SwitchParameter>] [-ApplianceConnection] <Object>[ [

This cmdlet will assist with removing a discovered and managed storage system from the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Aliases [-StorageSystem, -Name] Name or URI of the managed storage system.
Aliases uri, name, StorageSystem
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Switch to force removal of a storage system the appliance can no longer communicate with.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Storage System resource object
Collections of Storage System resource objects
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVStorageSystem HP3PAR_2
Remove 'HP3PAR_2' storage system from the appliance.

Related Links
Top

Remove a Storage Volume
SYNTAX
Remove-HPOVStorageVolume [-InputObject] <Object>[ [-ExportOnly] <SwitchParameter>][ [-Async] <SwitchParameter>]
[-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>
]
This cmdlet will remove storage volumes from the HPE OneView appliance. Volumes must first be removed from attached Server
Profiles prior to deleting the Storage Volume.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value false
Aliases cf
Required? false
Position? named
Default value
-ExportOnly <SwitchParameter>
Removes the volume from HPE OneView. The volume remains on the storage system, and must be managed manually until it is
added back under management of HPE OneView. Default: Delete Export AND Volume from storage system.
Aliases None
Required? false
Position? named
Default value False
Aliases [-StorageVolume, -Name, -URI] Storage Volume Name, URI or Object.
Aliases uri, name, StorageVolume
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value

<CommonParameters>
Input Types
HPOneView.Storage.System.Volume [System.Management.Automation.PSCustomObject]
Storage Volume resource object
Return Values
Async removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$VolumeToRemove = Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop

Remove-HPOVStorageVolume -InputObject $VolumeToRemove
Remove export and delete volume named "TestVol1".

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop | Remove-HPOVStorageVolume -exportonly
Remove export of volume named "TestVol1" only, which leaves the volume still provisioned on the array and is added back to
the HPE OneView Storage Volumes pool. ### Related Links * [Add-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVStorageVolume) * [Get-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolume) * [Get-HPOVStorageVolumeSnapShot]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeSnapShot) * [Get-
Top
### HPE OneView 4.00 Library ## Remove-HPOVStorageVolume
Remove a Storage Volume ### SYNTAX
Remove-HPOVStorageVolume [-InputObject] <Object>[ [-ExportOnly] <SwitchParameter>][ [-Async] <SwitchParameter>]

[-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>
]
This cmdlet will remove storage volumes from the HPE OneView appliance. Volumes must first be removed from attached Server
Profiles prior to deleting the Storage Volume.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value false
Aliases cf
Required? false
Position? named
Default value
-ExportOnly <SwitchParameter>
Removes the volume from HPE OneView. The volume remains on the storage system, and must be managed manually until it is
added back under management of HPE OneView. Default: Delete Export AND Volume from storage system.
Aliases None
Required? false
Position? named
Default value False
Aliases [-StorageVolume, -Name, -URI] Storage Volume Name, URI or Object.
Aliases uri, name, StorageVolume
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Storage.System.Volume [System.Management.Automation.PSCustomObject]
Return Values
Async removal task
Examples
-------------------------- EXAMPLE 1 --------------------------
$VolumeToRemove = Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop

Remove-HPOVStorageVolume -InputObject $VolumeToRemove
Remove export and delete volume named 'TestVol1'.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop | Remove-HPOVStorageVolume -exportonly
Remove export of volume named 'TestVol1' only, which leaves the volume still provisioned on the array and is added back to the
HPE OneView Storage Volumes pool.
Related Links
Top

Remove storage volume snapshot resource(s).
SYNTAX
Remove-HPOVStorageVolumeSnapshot [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Async] <SwitchParame
ter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet will remove a storage volume snapshot from a storage volume resource object. Removal of a snapshot is a
destructive operation of the snapshot only.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases None
Required? false
Position? named
Default value false
Aliases cf
Required? false
Position? named
Default value
Aliases [-Snapshot]
Provide the snapshot resource object to remove from the appliance.
Aliases Snapshot
Required? true
Position? 0
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Storage Volume Snapshot resource
Return Values
Async create task resource
Multiple task resources
Examples
-------------------------- EXAMPLE 1 --------------------------
$Snapshots = Get-HPOVStorageVolume -Name "Volume 1" -ErrorAction Stop | Get-HPOVStorageVolumeSnapshot

$Snapshots | ? { ((get-date) - (Get-Date $_.created)).days -ge 5 } | Remove-HPOVStorageVolumeSnapshot
Get all of the available storage volume snapshots for "Volume 1", then remove any snapshots as old or older than 5 days.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolume | Get-HPOVStorageVolumeSnapshot | Remove-HPOVStorageVolumeSnapshot
Remove all Storage Volume Snapshots managed by HPE OneView. ### Related Links * [Get-HPOVStorageVolumeSnapShot]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeSnapShot) * [New-
HPOVStorageVolumeSnapshot](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVStorageVolumeSnapshot)
***
Top
### HPE OneView 4.00 Library ## Remove-HPOVStorageVolumeSnapshot
Remove storage volume snapshot resource(s). ### SYNTAX
Remove-HPOVStorageVolumeSnapshot [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Async] <SwitchParame

This Cmdlet will remove a storage volume snapshot from a storage volume resource object. Removal of a snapshot is a
destructive operation of the snapshot only.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases None
Required? false
Position? named
Default value false
Aliases cf
Required? false
Position? named
Default value
Aliases [-Snapshot]
Provide the snapshot resource object to remove from the appliance.
Aliases Snapshot
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Storage Volume Snapshot resource
Return Values
Async create task resource
Multiple task resources
Examples
-------------------------- EXAMPLE 1 --------------------------
$Snapshots = Get-HPOVStorageVolume -Name 'Volume 1' -ErrorAction Stop | Get-HPOVStorageVolumeSnapshot

$Snapshots | ? { ((get-date) - (Get-Date $_.created)).days -ge 5 } | Remove-HPOVStorageVolumeSnapshot
Get all of the available storage volume snapshots for 'Volume 1', then remove any snapshots as old or older than 5 days.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageVolume | Get-HPOVStorageVolumeSnapshot | Remove-HPOVStorageVolumeSnapshot
Remove all Storage Volume Snapshots managed by HPE OneView.
Related Links
Top

Delete storage volume template(s) from appliance configuration.
SYNTAX
Remove-HPOVStorageVolumeTemplate [-InputObject] <Object> [-ApplianceConnection] <Array Array>[ [-Force] <SwitchP
arameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete one or more storage volume templates from the appliance configuration.
Parameters
-ApplianceConnection <Array Array>
Default Value: ${Global:ConnectSessions} Aliases [-Appliance]
Aliases Appliance
Required? true False
Position? named
Default value (${Global:ConnectedSessions} | ? Default) (${Global:ConnectedSessions} | ? Default)
Aliases cf
Required? false
Position? named
Default value
Specify to remove the resource despite any problems with network connectivity or errors on the resource itself.
Aliases None
Required? false
Position? named
Default value False
Aliases [-name, -uri, -TemplateName., -Template] The Storage Volume Template object(s), name(s) or URI(s) to be deleted.
Aliases uri, name, templateName, Template
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Storage Volume Template resource object
Multiple Storage Volume Template resources

Return Values
Removal async task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVStorageVolumeTemplate -storagePool "yellow" | Wait-HPOVTaskComplete
Remove the storage volume template specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$svt = Get-HPOVStorageVolumeTemplate -name "yellow"

Remove-HPOVStorageVolumeTemplate -name $svt -confirm:$false
Remove the network specifed by $svt, and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStoragVolumeTemplate | Remove-HPOVStorageVolumeTemplate
Search for all storage volume templates and remove them from appliance. ### Related Links * [Get-
HPOVStorageVolumeTemplatePolicy) * [New-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVStorageVolumeTemplate) * [Set-HPOVStorageVolumeTemplate]
Top
### HPE OneView 4.00 Library ## Remove-HPOVStorageVolumeTemplate
Delete storage volume template(s) from appliance configuration. ### SYNTAX
Remove-HPOVStorageVolumeTemplate [-InputObject] <Object> [-ApplianceConnection] <Array Array>[ [-Force] <SwitchP

arameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Delete one or more storage volume templates from the appliance configuration.
Parameters
-ApplianceConnection <Array Array>
Default Value: ${Global:ConnectSessions} Aliases [-Appliance]

Aliases Appliance
Required? true False
Position? named
Default value (${Global:ConnectedSessions} | ? Default) (${Global:ConnectedSessions} | ? Default)
Aliases cf
Required? false
Position? named
Default value
Specify to remove the resource despite any problems with network connectivity or errors on the resource itself.
Aliases None
Required? false
Position? named
Default value False
Aliases [-name, -uri, -TemplateName., -Template] The Storage Volume Template object(s), name(s) or URI(s) to be deleted.
Aliases uri, name, templateName, Template
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Storage Volume Template resource object
Multiple Storage Volume Template resources
Return Values
Removal async task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Remove-HPOVStorageVolumeTemplate -storagePool "yellow" | Wait-HPOVTaskComplete
Remove the storage volume template specifed by name. Wait for remove to complete.
-------------------------- EXAMPLE 2 --------------------------
$svt = Get-HPOVStorageVolumeTemplate -name "yellow"

Remove-HPOVStorageVolumeTemplate -name $svt -confirm:$false
Remove the network specifed by $svt, and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVStoragVolumeTemplate | Remove-HPOVStorageVolumeTemplate
Search for all storage volume templates and remove them from appliance.
Related Links
Top

Remove an Unmanaged Device.
SYNTAX
Remove-HPOVUnmanagedDevice [-UnmanagedDevice] <Object>[ [-force] <SwitchParameter>] [-ApplianceConnection] <Obje
ct>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Use this Cmdlet to remove an Unmanaged Device from the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value

-UnmanagedDevice <Object>
Alias [-name, -uri]
The Name, URI or Object of the Unmanaged Device to remove.
Aliases uri, name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Set to force-remove the resource.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Unmanaged Device resource object
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVUnmanagedDevice MyDevice
Remove the Unmanaged Device "MyDevice" from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Remove-HPOVUnmanagedDevice MyDevice -confirm:$false
Remove the Unmanaged Device "MyDevice" from the appliance and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVUnmanagedDevice | Remove-HPOVUnmanagedDevice
Get all Unmanaged Devices on the appliance and remove them. ### Related Links * [Get-HPOVUnmanagedDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVUnmanagedDevice) * [New-HPOVUnmanagedDevice]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVUnmanagedDevice) ***
Top
### HPE OneView 4.00 Library ## Remove-HPOVUnmanagedDevice
Remove an Unmanaged Device. ### SYNTAX
Remove-HPOVUnmanagedDevice [-UnmanagedDevice] <Object>[ [-force] <SwitchParameter>] [-ApplianceConnection] <Obje

ct>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Use this Cmdlet to remove an Unmanaged Device from the appliance.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
-UnmanagedDevice <Object>
Alias [-name, -uri]
The Name, URI or Object of the Unmanaged Device to remove.
Aliases uri, name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
Set to force-remove the resource.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Unmanaged Device resource object
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Remove-HPOVUnmanagedDevice MyDevice
Remove the Unmanaged Device 'MyDevice' from the appliance.
-------------------------- EXAMPLE 2 --------------------------
Remove-HPOVUnmanagedDevice MyDevice -confirm:$false
Remove the Unmanaged Device 'MyDevice' from the appliance and do not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVUnmanagedDevice | Remove-HPOVUnmanagedDevice
Get all Unmanaged Devices on the appliance and remove them.
Related Links
Top
Remove-HPOVUser

Remove-HPOVUser
Remove a user account.
SYNTAX
Remove-HPOVUser [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm
] <SwitchParameter>] [<CommonParameters>]
Remove a specific local user account from the management appliance
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
The user account object to be removed.
Aliases u, user, UserName, Name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value

<CommonParameters>
Input Types
HPE OneView User Account object created on an appliance
Return Values
Success message if user was deleted
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVUser Sally | Remove-HPOVUser
Retrieve "Sally" user account using Get-HPOVUser, then pipe it to Remove-HPOVUser. ### Related Links * [Get-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVUser) * [New-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVUser) * [Set-HPOVUser]
Top
### HPE OneView 4.00 Library ## Remove-HPOVUser
Remove a user account. ### SYNTAX
Remove-HPOVUser [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm

] <SwitchParameter>] [<CommonParameters>]
Remove a specific local user account from the management appliance
Parameters
Aliases Appliance
Required? true
Position? named

Aliases cf
Required? false
Position? named
Default value
The user account object to be removed.
Aliases u, user, UserName, Name
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Success message if user was deleted
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVUser Sally | Remove-HPOVUser
Retrieve 'Sally' user account using Get-HPOVUser, then pipe it to Remove-HPOVUser.
Related Links
Get-HPOVUser
New-HPOVUser
Set-HPOVUser
Set-HPOVUserRole
Top

Power reset or EFuse HPS Synergy Frame component.
SYNTAX
Reset-HPOVEnclosureDevice [-Enclosure] <Object> [-Component] <String> [-DeviceID] <Int32>[ [-Efuse] <SwitchParam
eter>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <S
Reset-HPOVEnclosureDevice [-Enclosure] <Object> [-Component] <String> [-DeviceID] <Int32>[ [-Reset] <SwitchParam

This Cmdlet will assist Server Administrators in performing various power operations with enclosure resources. The following
resources are supported with their supported operation:
* HPE Synergy Appliance Bay - EFuse

* HPE Synergy Frame Link Module - EFuse or Resetn * Device Bay - EFuse or Resetn * HPE Synergy Fabric Mod
ule Device - EFuse
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Component <String>
The embedded component to perform the action against. Allowed value:
FLM - Frame Link Module. Both EFuse and Reset are supported.
Appliance - Management Appliance; Synergy Compser or Synergy Image Streamer. Only supported method is EFuse.
ICM - Synergy Fabric Interconnect Module. Only supported method is EFuse.
Device - Synergy Device (e.g. Compute Node populated in Bay 1). Both EFuse and Reset are supported.
Aliases None
Required? true
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value

-DeviceID <Int32>
The corrisponding bay ID.
Aliases None
Required? true
Position? named
Default value 0
-Efuse <SwitchParameter>
EFuse will take away and then present power back to the device. Supported with all component types.
Aliases None
Required? false
Position? named
Default value False
-Enclosure <Object>
The Synergy Frame resource from Get-HPOVEnclosure.
Aliases None
Required? true
Position? named
Default value
-Reset <SwitchParameter>
Reset power to the device. Only supported with certain component types.
Aliases None
Required? false
Position? named
Default value False
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Enclosure
Resource from Get-HPOVEnclosure.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Enclosure = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop

Reset-HPOVEnclosureDevice -Enclosure $Enclosure -Component FLM -DeviceID 1 -EFuse
Reset the FLM in slot 1 by performing an EFuse.

-------------------------- EXAMPLE 2 --------------------------
$Task = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop | Reset-HPOVEnclosureDevice -Component Device -Devi
ceID 4 -Reset
Reset the device in bay 4 by requesting it to reset itself. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Reset-HPOVEnclosureDevice
Power reset or EFuse HPS Synergy Frame component. ### SYNTAX
Reset-HPOVEnclosureDevice [-Enclosure] <Object> [-Component] <String> [-DeviceID] <Int32>[ [-Efuse] <SwitchParam

Reset-HPOVEnclosureDevice [-Enclosure] <Object> [-Component] <String> [-DeviceID] <Int32>[ [-Reset] <SwitchParam

This Cmdlet will assist Server Administrators in performing various power operations with enclosure resources. The following
resources are supported with their supported operation:
* HPE Synergy Appliance Bay - EFuse

* HPE Synergy Frame Link Module - EFuse or Resetn * Device Bay - EFuse or Resetn * HPE Synergy Fabric Mod
ule Device - EFuse
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-Component <String>
The embedded component to perform the action against. Allowed value:
FLM - Frame Link Module. Both EFuse and Reset are supported.
Appliance - Management Appliance; Synergy Compser or Synergy Image Streamer. Only supported method is EFuse.
ICM - Synergy Fabric Interconnect Module. Only supported method is EFuse.
Device - Synergy Device (e.g. Compute Node populated in Bay 1). Both EFuse and Reset are supported.
Aliases None
Required? true
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value
-DeviceID <Int32>
The corrisponding bay ID.
Aliases None
Required? true
Position? named
Default value 0
-Efuse <SwitchParameter>
EFuse will take away and then present power back to the device. Supported with all component types.
Aliases None
Required? false
Position? named
Default value False
-Enclosure <Object>
Aliases None
Required? true
Position? named
Default value
-Reset <SwitchParameter>
Reset power to the device. Only supported with certain component types.
Aliases None
Required? false
Position? named
Default value False

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Enclosure
Resource from Get-HPOVEnclosure.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Enclosure = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop

Reset-HPOVEnclosureDevice -Enclosure $Enclosure -Component FLM -DeviceID 1 -EFuse
Reset the FLM in slot 1 by performing an EFuse.
-------------------------- EXAMPLE 2 --------------------------
$Task = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop | Reset-HPOVEnclosureDevice -Component Device -Devi
ceID 4 -Reset
Reset the device in bay 4 by requesting it to reset itself.
Related Links
Top
Restart-HPOVAppliance

Restart an HPE OneView appliance.
SYNTAX
Restart-HPOVAppliance [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>
This cmdlet will allow the administrator to restart/reboot the appliance. Restarting the appliance will cause all users to be
disconnected and all ongoing tasks to be interrupted.
Only the Infrastructure (Full) Administrator may restart the appliance.
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value

<CommonParameters>
Input Types
Appliance Connection object
Collection of HPOneView.Appliance.Connection objects
Return Values
System.String
Warning message the appliance is stopping
Management.Automation.ErrorRecord
Generated error message
Examples
-------------------------- EXAMPLE 1 --------------------------
Connect-HPOVMgmt appliance.contoso.com Administrator P@ssw0rd

Restart the appliance

-------------------------- EXAMPLE 2 --------------------------
Restart-HPOVAppliance -confirm:$false
Restart all connected appliances without confirmation. ### Related Links * [Add-HPOVApplianceTrustedCertificate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVApplianceTrustedCertificate) * [Disable-
HPOVApplianceComplexPasswords](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVApplianceComplexPasswords) * [Disable-HPOVApplianceServiceConsoleAccess]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVApplianceServiceConsoleAccess) * [Disable-
HPOVApplianceSshAccess](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVApplianceSshAccess) *
[Disable-HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVApplianceTwoFactorAuthentication) * [Enable-HPOVApplianceComplexPasswords]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVApplianceComplexPasswords) * [Enable-
HPOVApplianceServiceConsoleAccess](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-
HPOVApplianceServiceConsoleAccess) * [Enable-HPOVApplianceSshAccess](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Enable-HPOVApplianceSshAccess) * [Get-HPOVApplianceAvailableSecurityMode]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceAvailableSecurityMode) * [Get-
HPOVApplianceCertificateStatus](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceCertificateStatus) * [Get-HPOVApplianceCurrentSecurityMode](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceCurrentSecurityMode) * [Get-HPOVApplianceDateTime]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceDateTime) * [Get-HPOVApplianceGlobalSetting]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceGlobalSetting) * [Get-
HPOVApplianceNetworkConfig](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceNetworkConfig) *
[Get-HPOVApplianceProxy](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceProxy) * [Get-
HPOVApplianceSecurityProtocol](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceSecurityProtocol) * [Get-HPOVApplianceSnmpV3EngineId](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceSnmpV3EngineId) * [Get-HPOVApplianceTrapDestination]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceTrapDestination) * [Get-
HPOVApplianceTrustedCertificate) * [Get-HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceTwoFactorAuthentication) * [Install-HPOVApplianceCertificate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Install-HPOVApplianceCertificate) * [New-HPOVApplianceCsr]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVApplianceCsr) * [New-
HPOVApplianceSelfSignedCertificate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVApplianceSelfSignedCertificate) * [New-HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVApplianceTrapDestination) * [Pop-HPOVAppliancePermission]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Pop-HPOVAppliancePermission) * [Push-HPOVAppliancePermission]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Push-HPOVAppliancePermission) * [Remove-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVApplianceProxy) * [Remove-
HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVApplianceTrapDestination) * [Remove-HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVApplianceTrustedCertificate) * [Set-HPOVApplianceCurrentSecurityMode]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceCurrentSecurityMode) * [Set-
HPOVApplianceDateTime](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceDateTime) * [Set-
HPOVApplianceDefaultConnection](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVApplianceDefaultConnection) * [Set-HPOVApplianceGlobalSetting](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVApplianceGlobalSetting) * [Set-HPOVApplianceNetworkConfig]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceNetworkConfig) * [Set-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceProxy) * [Set-HPOVApplianceSecurityProtocol]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceSecurityProtocol) * [Set-
HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVApplianceTwoFactorAuthentication) * [Show-HPOVApplianceSecurityModeCompatibilityReport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVApplianceSecurityModeCompatibilityReport) * [Stop-
HPOVAppliance](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Stop-HPOVAppliance) * [Update-
HPOVApplianceTrustedAuthorityCrl](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-
HPOVApplianceTrustedAuthorityCrl) * [Wait-HPOVApplianceStart](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Wait-HPOVApplianceStart) ***
Top
### HPE OneView 4.00 Library ## Restart-HPOVAppliance
Restart an HPE OneView appliance. ### SYNTAX
Restart-HPOVAppliance [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>

This cmdlet will allow the administrator to restart/reboot the appliance. Restarting the appliance will cause all users to be
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Appliance Connection object
Return Values
System.String
Examples
-------------------------- EXAMPLE 1 --------------------------

Restart the appliance
-------------------------- EXAMPLE 2 --------------------------
Restart-HPOVAppliance -confirm:$false
Restart all connected appliances without confirmation.
Related Links
Set-HPOVApplianceDefaultConnection
Stop-HPOVAppliance
Update-HPOVApplianceTrustedAuthorityCrl
Wait-HPOVApplianceStart
Top
Restart-HPOVServer

Restart-HPOVServer
Restart Server Resource.
SYNTAX
Restart-HPOVServer [-Server] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <S
witchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Restart-HPOVServer [-Server] <Object>[ [-ColdBoot] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceCo

nnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Restart the power state of the server using the virtual power button. By default, the Cmdlet will request a "Reset" request to
initiate a server to restart. Using the ColdBoot will take away and present power back to the server resource.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-ColdBoot <SwitchParameter>
Use this parameter to request power be forcably removed then represented to the server resource.
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
-Server <Object>
A Server hardware or Server Profile resource object.
Aliases None
Required? true
Position? named
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Server Hardware Resource
Server Profile Resource
Return Values
Async task that tracks the power state change
Multiple Async tasks
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Restart-HPOVServer | Wait-HPOVTaskComplete
Restart the specific server device by passing the Server Object via pipeline.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile "MyWebServer 1" | Restart-HPOVServer | Wait-HPOVTaskComplete
Restart the specific server device by passing the Server Profile Object via pipeline.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Restart-HPOVServer -ColdBoot | Wait-HPOVTaskComplete
Restart the specific server device by passing the Server Object via pipeline, and issue a cold boot request. ### Related Links *
[Add-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVServer) * [Convert-HPOVServerProfile]
Top
### HPE OneView 4.00 Library ## Restart-HPOVServer
Restart Server Resource. ### SYNTAX
Restart-HPOVServer [-Server] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <S

witchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Restart-HPOVServer [-Server] <Object>[ [-ColdBoot] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceCo

nnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Restart the power state of the server using the virtual power button. By default, the Cmdlet will request a 'Reset' request to
initiate a server to restart. Using the ColdBoot will take away and present power back to the server resource.
Parameters

Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-ColdBoot <SwitchParameter>
Use this parameter to request power be forcably removed then represented to the server resource.
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
-Server <Object>
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Restart-HPOVServer | Wait-HPOVTaskComplete
Restart the specific server device by passing the Server Object via pipeline.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile "MyWebServer 1" | Restart-HPOVServer | Wait-HPOVTaskComplete
Restart the specific server device by passing the Server Profile Object via pipeline.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Restart-HPOVServer -ColdBoot | Wait-HPOVTaskComplete
Restart the specific server device by passing the Server Object via pipeline, and issue a cold boot request.
Related Links
Add-HPOVServer
Get-HPOVServer
Remove-HPOVServer
Set-HPOVServerPower
Start-HPOVServer
Stop-HPOVServer
Update-HPOVServer
Top

Restore a Custom Baseline after Restore of a Backup File.
SYNTAX
Restore-HPOVCustomBaseline [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet provides the ability to restore custom SPP Baselines that were created with component hotfixes on the appliance
after a backup file restore procedure has completed. It will search for any custom Baseline resources that are in the "Removed"
state, and rebuild the baseline with the associated hotfixes.
The source baseline and associated hotfixes must be present within the Baseline repository. Use the Add-HPOVBaseline to
upload the starting Baseline and hotfixes after restoring the Appliance Backup file, then use this Cmdlet to rebuild the Custom
Baseline.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
The progress of in-progress or completion result
Examples
-------------------------- EXAMPLE 1 --------------------------
Restore all Custom Baselines that were previously created on all connected appliances. ### Related Links * [New-
HPOVCustomBaseline](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVCustomBaseline) ***
Top
### HPE OneView 4.00 Library ## Restore-HPOVCustomBaseline
Restore a Custom Baseline after Restore of a Backup File. ### SYNTAX
Restore-HPOVCustomBaseline [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet provides the ability to restore custom SPP Baselines that were created with component hotfixes on the appliance
after a backup file restore procedure has completed. It will search for any custom Baseline resources that are in the 'Removed'
state, and rebuild the baseline with the associated hotfixes.
The source baseline and associated hotfixes must be present within the Baseline repository. Use the Add-HPOVBaseline to
upload the starting Baseline and hotfixes after restoring the Appliance Backup file, then use this Cmdlet to rebuild the Custom
Baseline.
Parameters
Aliases Appliance
Required? true
Position? 0
<CommonParameters>
Input Types
Return Values
The progress of in-progress or completion result
Examples
-------------------------- EXAMPLE 1 --------------------------
Restore all Custom Baselines that were previously created on all connected appliances.
Related Links
Top
Save-HPOVBackup

Save-HPOVBackup
Save existing backups on an appliance.
SYNTAX
Save-HPOVBackup[ [-Location] <String>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Save-HPOVBackup [-SaveRemoteOnly] <SwitchParameter>[ [-ApplianceConnection] <Array>] [<CommonParameters>]
backup file.
Use this cmdlet to save the created appliance backup files. Use the -SaveRemoteOnly parameter to save the backup file(s) to
the remote location if configured on the appliance.
Parameters

Aliases Appliance
Required? False
Position? named
-Location <String>
Specify the directory or UNC path where to save the backup file(s) to.
Aliases save
Required? false
Position? named
Default value
-SaveRemoteOnly <SwitchParameter>
When appliance automatic backup is configured, use this parameter to specify the backup file(s) should be saved in the remote
location, instead of the local PC.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async Task resource to monitor progress of the backup file saved to the remote location.
System.IO.FileInfo
The saved backup file located on the PC.
Examples
-------------------------- EXAMPLE 1 --------------------------
Save-HPOVBackup
Save the found backup file

-------------------------- EXAMPLE 2 --------------------------
Save-HPOVBackup -Location \\Server\BackupShare\HPOneView
Save the found backup file to the specified location. ### Related Links * [Get-HPOVBackup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVBackup) * [New-HPOVBackup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVBackup) ***
Top
### HPE OneView 4.00 Library ## Save-HPOVBackup
Save existing backups on an appliance. ### SYNTAX
Save-HPOVBackup[ [-Location] <string>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Save-HPOVBackup [-SaveRemoteOnly] <SwitchParameter>[ [-ApplianceConnection] <Array>] [<CommonParameters>]
backup file.
Use this cmdlet to save the created appliance backup files. Use the -SaveRemoteOnly parameter to save the backup file(s) to
the remote location if configured on the appliance.
Parameters
Aliases Appliance
Required? False
Position? named
-Location <string>
Specify the directory or UNC path where to save the backup file(s) to.
Aliases save
Required? false
Position? named
Default value
-SaveRemoteOnly <SwitchParameter>
When appliance automatic backup is configured, use this parameter to specify the backup file(s) should be saved in the remote
location, instead of the local PC.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async Task resource to monitor progress of the backup file saved to the remote location.
System.IO.FileInfo
The saved backup file located on the PC.
Examples
-------------------------- EXAMPLE 1 --------------------------
Save-HPOVBackup
Save the found backup file
-------------------------- EXAMPLE 2 --------------------------
Save-HPOVBackup -Location \Server\BackupShare\HPOneView
Save the found backup file to the specified location.
Related Links
Get-HPOVBackup
New-HPOVBackup
Top

Save the contents of a Server Profile to the appliance.
SYNTAX
Save-HPOVServerProfile [-InputObject] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<C
ommonParameters>]
This Cmdlet allows administrators to save the modified Server Profile object within the current PowerShell session to the target
appliance.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False

Server Profile object to be saved.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
A Server Profile resource object from Get-ServerProfile that was modified and needs to be saved.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$MyProfile = Get-HPOVServerProfile -Name "My Profile 1" -ErrorAction Stop

$MyProfile.name = "My Profile NewName 1"
Save-HPOVServerProfile -InputObject $MyProfile
Get a Server Profile, update its name, then save. ### Related Links * [Convert-HPOVServerProfile]
[Set-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfile) * [Set-
[Update-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServerProfile) ***
Top
### HPE OneView 4.00 Library ## Save-HPOVServerProfile
Save the contents of a Server Profile to the appliance. ### SYNTAX
Save-HPOVServerProfile [-InputObject] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<C

ommonParameters>]
This Cmdlet allows administrators to save the modified Server Profile object within the current PowerShell session to the target
appliance.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Server Profile object to be saved.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
A Server Profile resource object from Get-ServerProfile that was modified and needs to be saved.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$MyProfile = Get-HPOVServerProfile -Name "My Profile 1" -ErrorAction Stop

$MyProfile.name = "My Profile NewName 1"
Save-HPOVServerProfile -InputObject $MyProfile
Get a Server Profile, update its name, then save.
Related Links
Top

Save the contents of a Server Profile Template to the appliance.
SYNTAX
Save-HPOVServerProfileTemplate [-InputObject] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Arr
ay>] [<CommonParameters>]
This Cmdlet allows administrators to save the modified Server Profile Template object within the current PowerShell session to
the target appliance.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Server Profile Template object to be saved.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
A Server Profile Template resource object from Get-HPOVServerProfileTemplate that was modified and needs to be saved.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$MyProfileTemplate = Get-HPOVServerProfileTemplate -Name "My Profile Template 1" -ErrorAction Stop

$MyProfileTemplate.name = "My Profile Template NewName 1"
Save-HPOVServerProfileTemplate -InputObject $MyProfileTemplate
Get a Server Profile Template, update its name, then save. ### Related Links * [Convert-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileTemplate) * [Remove-
HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProfileTemplate) *
***
Top
### HPE OneView 4.00 Library ## Save-HPOVServerProfileTemplate
Save the contents of a Server Profile Template to the appliance. ### SYNTAX
Save-HPOVServerProfileTemplate [-InputObject] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Arr

ay>] [<CommonParameters>]
This Cmdlet allows administrators to save the modified Server Profile Template object within the current PowerShell session to
the target appliance.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Server Profile Template object to be saved.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
A Server Profile Template resource object from Get-HPOVServerProfileTemplate that was modified and needs to be saved.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$MyProfileTemplate = Get-HPOVServerProfileTemplate -Name "My Profile Template 1" -ErrorAction Stop

$MyProfileTemplate.name = "My Profile Template NewName 1"
Save-HPOVServerProfileTemplate -InputObject $MyProfileTemplate
Get a Server Profile Template, update its name, then save.
Related Links
Top
Search-HPOVAssociations

Search-HPOVAssociations
Search the association index.
SYNTAX
Search-HPOVAssociations [-AssociationName] <String> [-Parent] <Object> [-Child] <Object> [-Count] <Int32> [-Star
t] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]
Search the association index for any associations that match the specified name or uri.
Parameters
Aliases Appliance
Required? true
Position? 5
-AssociationName <String>
The association name to be matched, if specified. Valid association names are
* BLADE_TO_PROFILE
* PROFILE_TO_SERVER_HARDWARE_TYPE
* RACK_TO_PHYSICAL_DEVICE
* BLADE_TO_INTERCONNECT
* ENCLOSURE_GROUP_TO_ENCLOSURE
* ENCLOSURE_GROUP_TO_LOGICAL_INTERCONNECT_GROUP
* ENCLOSURE_TO_BLADE
* ENCLOSURE_TO_SWITCH
* LOGICAL_SWITCH_TO_LOGICAL_UPLINK
* SWITCH_TO_LOGICAL_SWITCH
* SERVER_PROFILES_TO_FC_NETWORKS
* SERVER_PROFILES_TO_NETWORKS
* STORAGE_SYSTEM_TO_STORAGE_POOL
* FC_NETWORK_TO_STORAGE_SYSTEM
* STORAGE_POOL_TO_VOLUME
* STORAGE_POOL_TO_VOLUME_TEMPLATE
Aliases None
Required? true
Position? 0
Default value
-Child <Object>
Aliases [-EndObjUri]
The uri of an object which is the end of an association
Aliases None
Required? true
Position? 2
Default value
-Count <Int32>
The maximum number of association index entries to be returned. Defaults to 50.
Aliases None
Required? true
Position? 3
Default value 50
-Parent <Object>
Aliases [-StartObjUri]
The uri of an object which is the start of an association
Aliases None
Required? true
Position? 1
Default value
-Start <Int32>
The index of the first association index to be returned, defaults to 0.
Aliases None
Required? true
Position? 4
Default value 0
<CommonParameters>
Input Types
Resource Object to find associated resources
Return Values
Single association index entry
Multiple association index entries The matching index entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Search-HPOVAssociations BLADE_TO_PROFILE -endObjUri /rest/server-profiles/1ab4c031-a631-4288-9e7d-3cfca24d30cf
Return any BLADE_TO_PROFILE associations that have an end object with the specified uri ### Related Links ***
Top
### HPE OneView 4.00 Library ## Search-HPOVAssociations
Search the association index. ### SYNTAX
Search-HPOVAssociations [-AssociationName] <String> [-Parent] <Object> [-Child] <Object> [-Count] <Int32> [-Star
t] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]
Search the association index for any associations that match the specified name or uri.
Parameters
Aliases Appliance
Required? true
Position? 5
-AssociationName <String>
The association name to be matched, if specified. Valid association names are

* BLADE_TO_PROFILE
* PROFILE_TO_SERVER_HARDWARE_TYPE
* RACK_TO_PHYSICAL_DEVICE
* BLADE_TO_INTERCONNECT
* ENCLOSURE_GROUP_TO_ENCLOSURE
* ENCLOSURE_GROUP_TO_LOGICAL_INTERCONNECT_GROUP
* ENCLOSURE_TO_BLADE
* ENCLOSURE_TO_SWITCH
* LOGICAL_SWITCH_TO_LOGICAL_UPLINK
* SWITCH_TO_LOGICAL_SWITCH
* SERVER_PROFILES_TO_FC_NETWORKS
* SERVER_PROFILES_TO_NETWORKS
* STORAGE_SYSTEM_TO_STORAGE_POOL
* FC_NETWORK_TO_STORAGE_SYSTEM
* STORAGE_POOL_TO_VOLUME
* STORAGE_POOL_TO_VOLUME_TEMPLATE
Aliases None
Required? true
Position? 0
Default value
-Child <Object>
Aliases [-EndObjUri]
The uri of an object which is the end of an association
Aliases None
Required? true
Position? 2
Default value
-Count <Int32>
The maximum number of association index entries to be returned. Defaults to 50.
Aliases None
Required? true
Position? 3
Default value 50
-Parent <Object>
Aliases [-StartObjUri]
The uri of an object which is the start of an association

Aliases None
Required? true
Position? 1
Default value
-Start <Int32>
The index of the first association index to be returned, defaults to 0.
Aliases None
Required? true
Position? 4
Default value 0
<CommonParameters>
Input Types
Resource Object to find associated resources
Return Values
Single association index entry
Multiple association index entries The matching index entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Search-HPOVAssociations BLADE_TO_PROFILE -endObjUri /rest/server-profiles/1ab4c031-a631-4288-9e7d-3cfca24d30cf
Return any BLADE_TO_PROFILE associations that have an end object with the specified uri
Related Links
Top
Search-HPOVIndex
Search-HPOVIndex
Search the resource index.
SYNTAX
Search-HPOVIndex [-Search] <String> [-Category] <String> [-Count] <Int32> [-Start] <Int32> [-ApplianceConnection
] <Object> [<CommonParameters>]
Search the resource index for any objects that match the specified search string or category
Parameters
Aliases Appliance
Required? true
Position? 4
-Category <String>
The resource category to be matched, if specified. Valid resource categories are:
* domains
* users
* racks
* enclosure-groups
* enclosures
* uplink-sets
* interconnect-types
* interconnects
* networks
* firmware-drivers
* server-hardware-types
* server-hardware
* server-profiles
* alerts
* storage-volumes
* storage-systems
Aliases None
Required? true
Position? 1
Default value
-Count <Int32>
The maximum number of resource index entries to be returned. Defaults to 50.
Aliases None
Required? true
Position? 2
Default value 50
-Search <String>
The search query, text to be found in the index.
Aliases None
Required? true
Position? 0
Default value
-Start <Int32>
The index of the first resource index to be returned, defaults to 0.
Aliases None
Required? true
Position? 3
Default value 0
<CommonParameters>
Input Types
Return Values
The matching index entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Search-HPOVIndex "Profile1"
Return all the index entries which include this string.

-------------------------- EXAMPLE 2 --------------------------
Search-HPOVIndex -categroy uplink-sets
Search for all Uplink Set resources. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Search-HPOVIndex
Search the resource index. ### SYNTAX
Search-HPOVIndex [-Search] <String> [-Category] <String> [-Count] <Int32> [-Start] <Int32> [-ApplianceConnection
] <Object> [<CommonParameters>]
Search the resource index for any objects that match the specified search string or category
Parameters
Aliases Appliance
Required? true
Position? 4
-Category <String>
The resource category to be matched, if specified. Valid resource categories are:

* domains
* users
* racks
* enclosure-groups
* enclosures
* uplink-sets
* interconnect-types
* interconnects
* networks
* firmware-drivers
* server-hardware-types
* server-hardware
* server-profiles
* alerts
* storage-volumes
* storage-systems
Aliases None
Required? true
Position? 1
Default value
-Count <Int32>
The maximum number of resource index entries to be returned. Defaults to 50.
Aliases None
Required? true
Position? 2
Default value 50
-Search <String>
The search query, text to be found in the index.
Aliases None
Required? true
Position? 0
Default value
-Start <Int32>
The index of the first resource index to be returned, defaults to 0.
Aliases None
Required? true
Position? 3
Default value 0
<CommonParameters>
Input Types
Return Values
The matching index entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Search-HPOVIndex "Profile1"
Return all the index entries which include this string.
-------------------------- EXAMPLE 2 --------------------------
Search-HPOVIndex -categroy uplink-sets
Search for all Uplink Set resources.
Related Links
Top
Send-HPOVRequest

Send-HPOVRequest
Sends a request to the management appliance
SYNTAX
Send-HPOVRequest [-uri] <String> [-method] <String> [-body] <Object> [-start] <Int32> [-count] <Int32> [-AddHead
er] <Hashtable>[ [-OverrideContentType] <String>][ [-OverrideTimeout] <Int>] [-Hostname] <Object> [<CommonParame
ters>]
Receives the request input, properly constructs and formats the request header and body and sends the request to the
management appliance. This is the main cmdlet that interacts with the appliance.
The message body can contain valid JSON data, with the correct URI and accepted HTTP method accepted by the target
resource manager. Please see the on-appliance Resource Model for more information
(https://[appliance_IP]/help/cic/en/content/images/api/.)
Parameters
-AddHeader <Hashtable>
If additional headers are needed/required than the defaults, include header names and values within a Hashtable.
Aliases None
Required? true
Position? 5
Default value
-Hostname <Object>
The destination appliance to process the request. When specifying a Value, it must match the HostName attribute of a valid
HPOneView.Appliance.Connection object within the Global $ConnectedSessions variable. If no match is found, or no
HPOneView.Appliance.Connection objects exist, an error will be thrown.
Default Value: All valid Appliance Connections within $Global:ConnectedSessions
Aliases Appliance, ApplianceConnection
Required? true
Position? named
-OverrideContentType <String>
Workaround to override ContentType where needed (e.g. PATCH /rest/scopes/{GUID}.
Aliases None
Required? false
Position? 6
Default value
-OverrideTimeout <Int>
Specify to override the HttpWebRequest syncronous timeout being made.
Aliases None
Required? false
Position? 7
Default value
-body <Object>
Body for the request. Required if the method is POST or PUT.
Aliases None
Required? true
Position? 2
Default value
-count <Int32>
For GETs on resource collections, this specifies the number of collection members to return. If not specified, all members of the
collection are returned from this function.
Aliases None
Required? true
Position? 4
Default value 0
-method <String>
The request HTTP Method.
* "GET" (default) to get a resource from the appliance (read)

* "POST" to create a new resource
* "PUT" to modify a resource (write)
* "PATCH" to modify a resource (write), with specific attributes set to values, other attributes should be set
to $null.
* "DELETE" to delete a resource
Aliases None
Required? true
Position? 1
Default value GET

-start <Int32>
For GETs on resource collections, this specifies the starting index in the collection. If not specified, collection members starting
from the beginning are returned.
Aliases None
Required? true
Position? 3
Default value 0
-uri <String>
The uri that identifies the required resource on the appliance.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
If collection of resources (.i.e. GET /rest/ethernet-networks)
Single object returned from appliance
If Async task, a Hashtable is returned with the following contents:
@{
uri = TaskUri;
category = "tasks";
type = "TaskResourceV2";
taskState = "New";
resource = @{};
}
If no resources are found, a PsCustomObject is returned that contains:
@{
statusCode = [int]HTTP Status Code;
statusMessage = [string]HTTP Status Message;
lastCall = [string]URI;
}
Examples
-------------------------- EXAMPLE 1 --------------------------
Send-HPOVRequest "/rest/enclosures"
Returns all the enclosure objects managed by the appliance.

-------------------------- EXAMPLE 2 --------------------------
$e = Send-HPOVRequest "/rest/enclosures/SGH2X6J1" -Appliance MyAppliance.domain.com

$e.name = "New Name"
Send-HPOVRequest $e.uri "PUT" $e -Appliance MyAppliance.domain.com
Updates the name of the enclosure object specified by the uri and Appliance Connection name. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Send-HPOVRequest
Sends a request to the management appliance ### SYNTAX
Send-HPOVRequest [-uri] <String> [-method] <String> [-body] <Object> [-start] <Int32> [-count] <Int32> [-AddHead
er] <Hashtable>[ [-OverrideContentType] <String>][ [-OverrideTimeout] <Int>] [-Hostname] <Object> [<CommonParame
ters>]
Receives the request input, properly constructs and formats the request header and body and sends the request to the
management appliance. This is the main cmdlet that interacts with the appliance.
The message body can contain valid JSON data, with the correct URI and accepted HTTP method accepted by the target
resource manager. Please see the on-appliance Resource Model for more information
(https://[appliance_IP]/help/cic/en/content/images/api/.)
Parameters
-AddHeader <Hashtable>
If additional headers are needed/required than the defaults, include header names and values within a Hashtable.
Aliases None
Required? true
Position? 5
Default value
-Hostname <Object>
The destination appliance to process the request. When specifying a Value, it must match the HostName attribute of a valid
HPOneView.Appliance.Connection object within the Global $ConnectedSessions variable. If no match is found, or no
HPOneView.Appliance.Connection objects exist, an error will be thrown.
Default Value: All valid Appliance Connections within $Global:ConnectedSessions
Aliases Appliance, ApplianceConnection
Required? true
Position? named
-OverrideContentType <String>
Workaround to override ContentType where needed (e.g. PATCH /rest/scopes/{GUID}.
Aliases None
Required? false
Position? 6
Default value
-OverrideTimeout <Int>
Specify to override the HttpWebRequest syncronous timeout being made.
Aliases None
Required? false
Position? 7
Default value
-body <Object>
Body for the request. Required if the method is POST or PUT.
Aliases None
Required? true
Position? 2
Default value
-count <Int32>
For GETs on resource collections, this specifies the number of collection members to return. If not specified, all members of the
collection are returned from this function.
Aliases None
Required? true
Position? 4
Default value 0
-method <String>
The request HTTP Method.
* "GET" (default) to get a resource from the appliance (read)

* "POST" to create a new resource
* "PUT" to modify a resource (write)
* "PATCH" to modify a resource (write), with specific attributes set to values, other attributes should be set
to $null.
* "DELETE" to delete a resource
Aliases None
Required? true
Position? 1
Default value GET
-start <Int32>
For GETs on resource collections, this specifies the starting index in the collection. If not specified, collection members starting
from the beginning are returned.
Aliases None
Required? true
Position? 3
Default value 0
-uri <String>
The uri that identifies the required resource on the appliance.
Aliases None
Required? true
Position? 0
Default value

<CommonParameters>
Input Types
Return Values
If collection of resources (.i.e. GET /rest/ethernet-networks)
Single object returned from appliance
If Async task, a Hashtable is returned with the following contents:
@{
uri = TaskUri;
category = "tasks";
type = "TaskResourceV2";
taskState = "New";
resource = @{};
}
If no resources are found, a PsCustomObject is returned that contains:
@{
statusCode = [int]HTTP Status Code;
statusMessage = [string]HTTP Status Message;
lastCall = [string]URI;
}
Examples
-------------------------- EXAMPLE 1 --------------------------
Send-HPOVRequest "/rest/enclosures"
Returns all the enclosure objects managed by the appliance.
-------------------------- EXAMPLE 2 --------------------------
$e = Send-HPOVRequest "/rest/enclosures/SGH2X6J1" -Appliance MyAppliance.domain.com

$e.name = "New Name"
Send-HPOVRequest $e.uri "PUT" $e -Appliance MyAppliance.domain.com
Updates the name of the enclosure object specified by the uri and Appliance Connection name.
Related Links
Top

Update an IPv4 Subnet Pool configuration.
SYNTAX
Set-HPOVAddressPoolSubnet [-InputObject] <Object>[ [-SubnetMask] <IPAddress>][ [-Gateway] <IPAddress>][ [-Domain
] <String>][ [-DNSServers] <Array>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will assist with updating an existing IPv4 Address Pool. When updating an IPv4 Address Subnet, you must provide
the Subnet Object or Name to modify. Only the Gateway, Domain Name, and DNS Servers can be updated once an IPv4 Subnet
has been assigned to a resoruce.
Parameters
Aliases Appliance
Required? false
Position? named
-DNSServers <Array>
Aliases None
Required? false
Position? named
Default value

-Domain <String>
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases [-Subnet, -IPv4Subnet]
The IPv4 Subnet resource object to update.
Aliases Subnet, IPv4Subnet
Required? true
Position? named
Default value
-SubnetMask <IPAddress>
IPv4 Subnet Mask of the subnet. Please know that if the Subnet is associated with another resource (Ethernet Network, Logical
Enclosure or Deployment Server), there will be an error as the mask cannot be changed until it is unassociated with the
resource.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
IPv4 Address Subnet
Return Values
Updated IPv4 Address Subnet
Examples
-------------------------- EXAMPLE 1 --------------------------
PS C:> Get-HPOVAddressPoolSubnet 192.168.20.0 | Set-HPOVAddressPoolSubnet -Gateway 192.168.20.1
Update the IPv4 Subnet Address Pool"s default gateway to the new address. ### Related Links * [Get-
HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVAddressPoolSubnet) *
[Remove-HPOVAddressPoolSubnet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVAddressPoolSubnet) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVAddressPoolSubnet
Update an IPv4 Subnet Pool configuration. ### SYNTAX
Set-HPOVAddressPoolSubnet [-InputObject] <Object>[ [-SubnetMask] <IPAddress>][ [-Gateway] <IPAddress>][ [-Domain

] <String>][ [-DNSServers] <Array>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
This cmdlet will assist with updating an existing IPv4 Address Pool. When updating an IPv4 Address Subnet, you must provide
the Subnet Object or Name to modify. Only the Gateway, Domain Name, and DNS Servers can be updated once an IPv4 Subnet
has been assigned to a resoruce.
Parameters
Aliases Appliance
Required? false
Position? named
-DNSServers <Array>
Aliases None
Required? false
Position? named
Default value
-Domain <String>
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases [-Subnet, -IPv4Subnet]
The IPv4 Subnet resource object to update.
Aliases Subnet, IPv4Subnet
Required? true
Position? named
Default value
-SubnetMask <IPAddress>
IPv4 Subnet Mask of the subnet. Please know that if the Subnet is associated with another resource (Ethernet Network, Logical
Enclosure or Deployment Server), there will be an error as the mask cannot be changed until it is unassociated with the
resource.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
IPv4 Address Subnet
Return Values
Updated IPv4 Address Subnet
Examples
-------------------------- EXAMPLE 1 --------------------------
PS C:> Get-HPOVAddressPoolSubnet 192.168.20.0 | Set-HPOVAddressPoolSubnet -Gateway 192.168.20.1
Update the IPv4 Subnet Address Pool's default gateway to the new address.
Related Links
Top
Set-HPOVAlert

Set-HPOVAlert
Change status of an alert.
SYNTAX
Set-HPOVAlert [-InputObject] <Object> [-AssignToUser] <String> [-Notes] <String>[ [-ApplianceConnection] <Object
>] [<CommonParameters>]
Set-HPOVAlert [-InputObject] <Object>[ [-Active] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonPa

rameters>]
Set-HPOVAlert [-InputObject] <Object>[ [-Cleared] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonP

arameters>]
Alerts can be in one of two administratively controlled states: Active or Cleared. This Cmdlet allows the administrator to change
the status of an alert to either Active or Cleared.
In order for an Administrator to change the status of an Alert, the Administrator must be assigned to the respective resource role
(Network, Server, Storage, or Infrastructure.)
Parameters
-Active <SwitchParameter>
Change the alert to "Active" status.
Aliases None
Required? false
Position? named
Default value False
Aliases Appliance
Required? false
Position? named
-AssignToUser <String>
The users name in String value to assign the alert to. The user name does not require, nor is mapped to, a local user account.
Aliases None
Required? true
Position? named
Default value
-Cleared <SwitchParameter>
Change the alert to "Cleared" status.
Aliases None
Required? false
Position? named
Default value False
The alert to be cleared. Can be URI or resource object.
Aliases alertUri, Alert
Required? true
Position? named
Default value
-Notes <String>
Notes of the action for the alert.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Alert URI
Return Values
The updated alert
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVAlert -InputObject $Alert -Cleared
Clears the alert.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAlert -AlertState Active | Set-HPOVAlert -Cleared
Get all alerts in an "Active" state, and set their state to "Cleared". ### Related Links * [Clear-HPOVAlert]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Clear-HPOVAlert) * [Get-HPOVAlert]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVAlert) * [Remove-HPOVAlert]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVAlert) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVAlert
Change status of an alert. ### SYNTAX
Set-HPOVAlert [-InputObject] <Object> [-AssignToUser] <String> [-Notes] <String>[ [-ApplianceConnection] <Object

Set-HPOVAlert [-InputObject] <Object>[ [-Active] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonPa

rameters>]
Set-HPOVAlert [-InputObject] <Object>[ [-Cleared] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonP

arameters>]
Alerts can be in one of two administratively controlled states: Active or Cleared. This Cmdlet allows the administrator to change
the status of an alert to either Active or Cleared.
In order for an Administrator to change the status of an Alert, the Administrator must be assigned to the respective resource role
(Network, Server, Storage, or Infrastructure.)
Parameters
-Active <SwitchParameter>
Change the alert to 'Active' status.
Aliases None
Required? false
Position? named
Default value False

Aliases Appliance
Required? false
Position? named
-AssignToUser <String>
The users name in String value to assign the alert to. The user name does not require, nor is mapped to, a local user account.
Aliases None
Required? true
Position? named
Default value
-Cleared <SwitchParameter>
Change the alert to 'Cleared' status.
Aliases None
Required? false
Position? named
Default value False
The alert to be cleared. Can be URI or resource object.
Aliases alertUri, Alert
Required? true
Position? named
Default value
-Notes <String>
Notes of the action for the alert.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Alert URI
Return Values
The updated alert
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVAlert -InputObject $Alert -Cleared
Clears the alert.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVAlert -AlertState Active | Set-HPOVAlert -Cleared
Get all alerts in an 'Active' state, and set their state to 'Cleared'.
Related Links
Clear-HPOVAlert
Get-HPOVAlert
Remove-HPOVAlert
Top

Change the appliance current security mode.
SYNTAX
Set-HPOVApplianceCurrentSecurityMode [-SecurityMode] <HPOVApplianceAvailableSecurityMode>[ [-ApplianceConnection
] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Use this Cmdlet to change the current security mode (Legacy, FIPS or CNSA) of the appliance. Before modifying the appliance
security mode, a compatibility report should be run using the Show-HPOVApplianceSecurityModeCompatibilityReport. When
changing active security mode will require an immediate appliance reboot.
Parameters
Aliases Appliance
Required? False
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value

-SecurityMode <HPOVApplianceAvailableSecurityMode>
Specify the Security Mode to change the appliance to by using Get-HPOVApplianceAvailableSecurityMode.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
The specified applinace security mode from Get-HPOVApplianceAvailableSecurityMode.
Return Values
After appliance reboots, the appliance current security mode is returned.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVApplianceAvailableSecurityMode -ModeName CNSA | Set-HPOVApplianceCurrentSecurityMode
Put the appliance into CNSA mode. After confirmation prompt, appliance will immediately reboot.
Related Links
Top
Update Appliance Date/Time Configuration.
SYNTAX
Set-HPOVApplianceDateTime[ [-SyncWithHost] <SwitchParameter>] [-Locale] <String> [-ApplianceConnection] <Object>
Set-HPOVApplianceDateTime [-NTPServers] <Array> [-PollingInterval] <Int32> [-Locale] <String> [-ApplianceConnect

ion] <Object> [<CommonParameters>]
Update the appliance Date and Time configuration, including Locale, NTP Servers, and NTP Polling.
Using the -SyncWithHost parameter will set the NTPServers property to null.
Parameters
Aliases Appliance
Required? true
Position? named
-Locale <String>
Specify the language local for the appliance
* en_US - US English
* zh_CN - Simplified Chinese
* ja_JP - Japanese
Aliases None
Required? true
Position? named
Default value

-NTPServers <Array>
Parameter is deprecated. Please use the Set-HPOVApplianceDateTime Cmdlet.
Aliases None
Required? true
Position? named
Default value
-PollingInterval <Int32>
The polling interval in seconds the NTP client will use to verify time drift.
Aliases None
Required? true
Position? named
Default value 0
-SyncWithHost <SwitchParameter>
Specify to configure the embedded hypervisor integration agent to sync time with the hypervisor host.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceDateTime -NTPServers 10.55.1.1,10.54.1.1 -PollingInterval 60
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVApplianceDateTime -SyncWithHost
This example passes in updated values to set for the appliance networking configuration. ### Related Links * [Get-
HPOVApplianceDateTime](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceDateTime) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVApplianceDateTime
Update Appliance Date/Time Configuration. ### SYNTAX
Set-HPOVApplianceDateTime[ [-SyncWithHost] <SwitchParameter>] [-Locale] <String> [-ApplianceConnection] <Object>

Set-HPOVApplianceDateTime [-NTPServers] <Array> [-PollingInterval] <Int32> [-Locale] <String> [-ApplianceConnect

ion] <Object> [<CommonParameters>]
Update the appliance Date and Time configuration, including Locale, NTP Servers, and NTP Polling.
Using the -SyncWithHost parameter will set the NTPServers property to null.
Parameters
Aliases Appliance
Required? true
Position? named
-Locale <String>
Specify the language local for the appliance
* en_US - US English
* zh_CN - Simplified Chinese
* ja_JP - Japanese
Aliases None
Required? true
Position? named
Default value
-NTPServers <Array>
Parameter is deprecated. Please use the Set-HPOVApplianceDateTime Cmdlet.
Aliases None
Required? true
Position? named
Default value
-PollingInterval <Int32>
The polling interval in seconds the NTP client will use to verify time drift.
Aliases None
Required? true
Position? named
Default value 0
-SyncWithHost <SwitchParameter>
Specify to configure the embedded hypervisor integration agent to sync time with the hypervisor host.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceDateTime -NTPServers 10.55.1.1,10.54.1.1 -PollingInterval 60
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVApplianceDateTime -SyncWithHost
Related Links
Top

Set the Default Appliance Connection.
SYNTAX
Set-HPOVApplianceDefaultConnection [-ApplianceConnection] <Object> [<CommonParameters>]
When establishing multiple Appliance Connections, this Cmdlet will help set one of the appliance connections stored in the
${Global:ConnectedSessions} variable to the default connection. All Cmdlets that require a specific Appliance Connection will
use the default.
Parameters
[Aliases -Connection]
Either the HPOneView.Appliance.Connection object, full or partial value of the connection objects Name property.
Aliases Appliance, Connection

Required? true
Position? 0
Default value
<CommonParameters>
Input Types
The Appliance Connection object either provided from the Connect-HPOVMgmt output or ${Global:ConnectedSessions} variable
Return Values
System.Collections.ArrayList <HPOneView.Appliance.Connection>
Updated collection of [HPOneView.Appliance.Connection] Objects
Examples
-------------------------- EXAMPLE 1 --------------------------
$ConnectedSessions
ConnectionID Name UserName AuthLoginDomain Default Connection
------------ ---- -------- --------------- ------------------
1 Appliance1.domain.local administrator LOCAL True
2 Appliance2.domain.local administrator LOCAL False
Set-HPOVApplianceDefaultConnection "Appliance2"

------------ ---- -------- --------------- ------------------
Display the current appliance connections, then set the new default to "Appliance2" using the parital name value.
-------------------------- EXAMPLE 2 --------------------------
$ConnectedSessions
------------ ---- -------- --------------- ------------------
$ConnectedSessions[1] | Set-HPOVApplianceDefaultConnection

------------ ---- -------- --------------- ------------------
Display the current appliance connections, then set the new default to "Appliance2" using the pipline by passing the
HPOneView.Appliance.Connection object. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVApplianceDefaultConnection
Set the Default Appliance Connection. ### SYNTAX
Set-HPOVApplianceDefaultConnection [-ApplianceConnection] <Object> [<CommonParameters>]
When establishing multiple Appliance Connections, this Cmdlet will help set one of the appliance connections stored in the
${Global:ConnectedSessions} variable to the default connection. All Cmdlets that require a specific Appliance Connection will
use the default.
Parameters
[Aliases -Connection]
Either the HPOneView.Appliance.Connection object, full or partial value of the connection objects Name property.
Aliases Appliance, Connection
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
The Appliance Connection object either provided from the Connect-HPOVMgmt output or ${Global:ConnectedSessions} variable
Return Values
System.Collections.ArrayList <HPOneView.Appliance.Connection>
Updated collection of [HPOneView.Appliance.Connection] Objects
Examples
-------------------------- EXAMPLE 1 --------------------------
$ConnectedSessions

Set-HPOVApplianceDefaultConnection 'Appliance2'

Display the current appliance connections, then set the new default to 'Appliance2' using the parital name value.
-------------------------- EXAMPLE 2 --------------------------
$ConnectedSessions

$ConnectedSessions[1] | Set-HPOVApplianceDefaultConnection

Display the current appliance connections, then set the new default to 'Appliance2' using the pipline by passing the
HPOneView.Appliance.Connection object.
Related Links
Top

(Reserved for future use) Update appliance global settings.
SYNTAX
Set-HPOVApplianceGlobalSetting [-Name] <String> [-Value] <String> [-ApplianceConnection] <Object> [<CommonParame
ters>]
Set-HPOVApplianceGlobalSetting [-InputObject] <HPOneView.Appliance.GlobalSetting> [-ApplianceConnection] <Object

> [<CommonParameters>]
(Reserved for future use) Updates the value for an existing global parameter.
Parameters
Aliases Appliance
Required? true
Position? named
-InputObject <HPOneView.Appliance.GlobalSetting>
Aliases [-Object]
The Appliance Global Setting object from Get-HPOVApplianceGlobalSetting.
Aliases Object
Required? true
Position? named
Default value
-Name <String>
The name of the global parameter.
Aliases None
Required? true
Position? named
Default value
-Value <String>
The updated value for the global parameter.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Appliance.GlobalSetting
Appliance global setting from Get-HPOVApplianceGlobalSetting.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceGlobalSetting alertMax 75000
Returns the "alertMax" setting object with the updated value of 75000 ### Related Links * [Get-HPOVApplianceGlobalSetting]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceGlobalSetting) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVApplianceGlobalSetting
(Reserved for future use) Update appliance global settings. ### SYNTAX
Set-HPOVApplianceGlobalSetting [-Name] <String> [-Value] <String> [-ApplianceConnection] <Object> [<CommonParame
ters>]
Set-HPOVApplianceGlobalSetting [-Object] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
(Reserved for future use) Updates the value for an existing global parameter.
Parameters
Aliases Appliance
Required? true
Position? named
-Name <String>
The name of the global parameter.
Aliases None
Required? true
Position? named
Default value
-Object <Object>
The Appliance Global Setting object from Get-HPOVApplianceGlobalSetting.
Aliases None
Required? true
Position? named
Default value
-Value <String>
The updated value for the global parameter.

Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceGlobalSetting alertMax 75000
Returns the 'alertMax' setting object with the updated value of 75000
Related Links
Top

Updates the configuration parameters for the primary network interface on the appliance.
SYNTAX
Set-HPOVApplianceNetworkConfig [-Hostname] <String> [-IPv4Type] <String> [-IPv4Addr] <IPAddress> [-IPv4Subnet] <
String> [-IPv4Gateway] <IPAddress> [-IPv6Type] <String> [-IPv6Addr] <IPAddress> [-IPv6Subnet] <String> [-IPv6Gat
eway] <String>[ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchParameter>] [-DomainNam
e] <String> [-SearchDomains] <Array> [-IPv4NameServers] <Array> [-IPv6NameServers] <Array> [-NtpServers] <Object
>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVApplianceNetworkConfig [-Hostname] <String> [-IPv4Addr] <IPAddress> [-IPv4Subnet] <String> [-IPv4Gateway
] <IPAddress> [-ServiceIPv4Node1] <IPAddress> [-ServiceIPv4Node2] <IPAddress> [-IPv4Type] <String> [-IPv6Type] <
String> [-IPv6Addr] <IPAddress> [-IPv6Subnet] <String> [-IPv6Gateway] <String>[ [-ServiceIPv6Node1] <IPAddress>]
[ [-ServiceIPv6Node2] <IPAddress>][ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchPar
ameter>] [-DomainName] <String> [-SearchDomains] <Array> [-IPv4NameServers] <Array> [-IPv6NameServers] <Array>[
Set-HPOVApplianceNetworkConfig [-importFile] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Updates any or all configuration parameters for the primary network interface on the appliance. All parameters are Current
settings will be retained for any parameters NOT specified.
Parameters
Aliases None
Required? false
Position? named
-DomainName <String>
DNS domain name for the appliance: "my.com"
Aliases None
Required? true
Position? named
Default value
-Hostname <String>
Fully-qualified hostname for the appliance
Aliases None
Required? true
Position? named
Default value

-IPv4Addr <IPAddress>
"www.xxx.yyy.zzz" (leave blank for DHCP)
Aliases None
Required? true
Position? named
Default value
-IPv4Gateway <IPAddress>
Aliases None
Required? true
Position? named
Default value
-IPv4NameServers <Array>
Aliases [-nameServers] Array of DNS servers: "www.xxx.yyy.zzz", "sss.ttt.uuu.vvv"
Aliases nameServers
Required? true
Position? named
Default value
-IPv4Subnet <String>
Aliases None
Required? true
Position? named
Default value
-IPv4Type <String>
"DHCP", "STATIC" or "UNCONFIGURE"
Aliases None
Required? true
Position? named
Default value STATIC
"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)
Aliases None
Required? true
Position? named
Default value
-IPv6Gateway <String>
Aliases None
Required? true
Position? named
Default value
Array of DNS servers: "fe80::200:f8ff:fe21:67cf", "fe80::200:f8ff:fe21:89cb"
Aliases None
Required? true
Position? named
Default value
"ffff:ffff:ffff:ffff:0:0:0:0" (leave blank for DHCP)
Aliases None
Required? true
Position? named
Default value
-IPv6Type <String>
Aliases None
Required? true
Position? named
Default value UNCONFIGURE
-NtpServers <Object>
Deprecated parameter. NTP Server configuration is now controlled in the Set-HPOVApplianceDateTime Cmdlet. Please update
your scripts accordingly.
Aliases None
Required? true
Position? named
Default value
-OverrideIPv4DhcpDns <SwitchParameter>
Aliases [-overrideDhcpDns] Switch to override DHCP provided DNS Servers
Aliases overrideDhcpDns
Required? false
Position? named
Default value False
Switch to override DHCPv6 provided DNS Servers
Aliases None
Required? false
Position? named
Default value False

-SearchDomains <Array>
Array of DNS search domains: "my.com", "other.com"
Aliases None
Required? true
Position? named
Default value
-ServiceIPv4Node1 <IPAddress>
Reserved for Synergy.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value

Aliases None
Required? false
Position? named
Default value
-importFile <Object>
Aliases [-i, -import] File containing JSON formatted input values for the appliance network configuration parameters.
Aliases i, import
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Final Task status (for asynchronous appliance config)
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceNetworkConfig -hostname "appliance1.my.com" -IPv4Type "DHCP" -IPv6Type "UNCONFIGURE" -domainNam

e "my.com"
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVApplianceNetworkConfig -importFile "c:\myNetworkInput.json"
This example passes the name of an input file containing JSON formatted properties and values for the appliance network
configuration. ### Related Links * [Get-HPOVApplianceNetworkConfig](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceNetworkConfig) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVApplianceNetworkConfig
Updates the configuration parameters for the primary network interface on the appliance. ### SYNTAX
Set-HPOVApplianceNetworkConfig [-Hostname] <String> [-IPv4Type] <String> [-IPv4Addr] <IPAddress> [-IPv4Subnet] <
String> [-IPv4Gateway] <IPAddress> [-IPv6Type] <String> [-IPv6Addr] <IPAddress> [-IPv6Subnet] <String> [-IPv6Gat
eway] <String>[ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchParameter>] [-DomainNam
e] <String> [-SearchDomains] <Array> [-IPv4NameServers] <Array> [-IPv6NameServers] <Array> [-NtpServers] <Object
>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVApplianceNetworkConfig [-Hostname] <String> [-IPv4Addr] <IPAddress> [-IPv4Subnet] <String> [-IPv4Gateway

] <IPAddress> [-ServiceIPv4Node1] <IPAddress> [-ServiceIPv4Node2] <IPAddress> [-IPv4Type] <String> [-IPv6Type] <
String> [-IPv6Addr] <IPAddress> [-IPv6Subnet] <String> [-IPv6Gateway] <String>[ [-ServiceIPv6Node1] <IPAddress>]
[ [-ServiceIPv6Node2] <IPAddress>][ [-OverrideIPv4DhcpDns] <SwitchParameter>][ [-OverrideIPv6DhcpDns] <SwitchPar
ameter>] [-DomainName] <String> [-SearchDomains] <Array> [-IPv4NameServers] <Array> [-IPv6NameServers] <Array>[
Set-HPOVApplianceNetworkConfig [-importFile] <Object>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Updates any or all configuration parameters for the primary network interface on the appliance. All parameters are Current
settings will be retained for any parameters NOT specified.
Parameters
Aliases None
Required? false
Position? named
-DomainName <String>
DNS domain name for the appliance: "my.com"
Aliases None
Required? true
Position? named
Default value
-Hostname <String>
Fully-qualified hostname for the appliance
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
-IPv4Gateway <IPAddress>
Aliases None
Required? true
Position? named
Default value
Aliases [-nameServers] Array of DNS servers: "www.xxx.yyy.zzz", "sss.ttt.uuu.vvv"
Aliases nameServers
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value

-IPv4Type <String>
Aliases None
Required? true
Position? named
Default value STATIC
Aliases None
Required? true
Position? named
Default value
-IPv6Gateway <String>
Aliases None
Required? true
Position? named
Default value
Array of DNS servers: "fe80::200:f8ff:fe21:67cf", "fe80::200:f8ff:fe21:89cb"
Aliases None
Required? true
Position? named
Default value
"ffff:ffff:ffff:ffff:0:0:0:0" (leave blank for DHCP)

Aliases None
Required? true
Position? named
Default value
-IPv6Type <String>
Aliases None
Required? true
Position? named
Default value UNCONFIGURE
-NtpServers <Object>
Deprecated parameter. NTP Server configuration is now controlled in the Set-HPOVApplianceDateTime Cmdlet. Please update
your scripts accordingly.
Aliases None
Required? true
Position? named
Default value
Aliases [-overrideDhcpDns] Switch to override DHCP provided DNS Servers
Aliases overrideDhcpDns
Required? false
Position? named
Default value False
Switch to override DHCPv6 provided DNS Servers
Aliases None
Required? false
Position? named
Default value False
-SearchDomains <Array>
Array of DNS search domains: "my.com", "other.com"
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-importFile <Object>
Aliases [-i, -import] File containing JSON formatted input values for the appliance network configuration parameters.
Aliases i, import
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Final Task status (for asynchronous appliance config)
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceNetworkConfig -hostname "appliance1.my.com" -IPv4Type "DHCP" -IPv6Type "UNCONFIGURE" -domainNam

e "my.com"
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVApplianceNetworkConfig -importFile "c:\myNetworkInput.json"

This example passes the name of an input file containing JSON formatted properties and values for the appliance network
configuration.
Related Links
Top

Configure appliance web proxy.
SYNTAX
Set-HPOVApplianceProxy [-Hostname] <String> [-Port] <Int>[ [-Https] <SwitchParameter>][ [-Async] <SwitchParamete
r>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVApplianceProxy [-Hostname] <String> [-Port] <Int> [-Username] <String> [-Password] <SecureString>[ [-Htt
ps] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
When configuring Remote Support, a Web Proxy may be required. This Cmdlet will assist in defining an HTTPS web proxy for
Remote Support outbound connectivity. Proxy configuration does not support SOCKS.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
-Hostname <String>
The FQDN or IP Address of the HTTPS Proxy server.
Aliases None
Required? true
Position? named
Default value
-Https <SwitchParameter>
Specify if target proxy server requires HTTPS. The target SSL/TSL certificate must be added to the appliance using the Add-
HPOVApplianceTrustedCertificate Cmdlet.
Aliases None
Required? False
Position? named
Default value
The proxy server account password.
Aliases None
Required? true
Position? named
Default value
-Port <Int>
The web proxy TCP port to connect to.
Aliases None
Required? true
Position? named
Default value 0
-Username <String>
The user name of your proxy server to authenticate with.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080
Configure the appliance proxy server by providing the required Hostname and Port values.
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080 -Username MyUserAccount -Password (ConvertTo-Secu

reString -String MyPassword -AsPlainText -Force)
Configure the appliance proxy server by providing the required Hostname and Port values, and using proxy authentication. ###
Related Links * [Get-HPOVApplianceProxy](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceProxy) * [Remove-HPOVApplianceProxy](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVApplianceProxy) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVApplianceProxy
Configure appliance web proxy. ### SYNTAX
Set-HPOVApplianceProxy [-Hostname] <String> [-Port] <Int>[ [-Https] <SwitchParameter>][ [-Async] <SwitchParamete

r>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVApplianceProxy [-Hostname] <String> [-Port] <Int> [-Username] <String> [-Password] <SecureString>[ [-Htt
ps] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
When configuring Remote Support, a Web Proxy may be required. This Cmdlet will assist in defining an HTTPS web proxy for
Remote Support outbound connectivity. Proxy configuration does not support SOCKS.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
-Hostname <String>
The FQDN or IP Address of the HTTPS Proxy server.
Aliases None
Required? true
Position? named
Default value
-Https <SwitchParameter>
Specify if target proxy server requires HTTPS. The target SSL/TSL certificate must be added to the appliance using the Add-
HPOVApplianceTrustedCertificate Cmdlet.
Aliases None
Required? False
Position? named
Default value
The proxy server account password.
Aliases None
Required? true
Position? named
Default value
-Port <Int>
The web proxy TCP port to connect to.
Aliases None
Required? true
Position? named
Default value 0
-Username <String>
The user name of your proxy server to authenticate with.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080
Configure the appliance proxy server by providing the required Hostname and Port values.
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080 -Username MyUserAccount -Password (ConvertTo-Secu

reString -String MyPassword -AsPlainText -Force)
Configure the appliance proxy server by providing the required Hostname and Port values, and using proxy authentication.
Related Links
Top

Change the appliance current security protocols.
SYNTAX
Set-HPOVApplianceSecurityProtocol [-EnableTlsVersion] <String[]>[ [-ApplianceConnection] <Array>] [-WhatIf] <> [
-Confirm] <> [<CommonParameters>]
Use this Cmdlet to change the enabled security protocol(s) on the appliance. Before modifying the security protocols, a
compatibility report should be run using the Show-HPOVApplianceSecurityModeCompatibilityReport.
NOTE When changing active security protocols will require an immediate appliance reboot. NOTE
Not all devices that HPE OneView manages or monitors support these stronger cryptography modes. Some examples are:
* ProLiant Gen 6 systems have iLO versions that only support TLS 1.0. These servers are not supported when the
appliance is in the FIPS or CNSA modes.
* Gen7 systems have iLO versions that only support TLS 1.0 and 1.1. These servers are not supported when the ap
pliance is in the CNSA mode.
* ProLiant Gen8 systems have iLO versions that support TLS 1.1 and 1.2, and are compatible with both FIPS and C
NSA modes.
Parameters
Aliases Appliance
Required? False
Position? named
-Confirm <>
Aliases cf
Required?
Position? named
Default value
-EnableTlsVersion <String[]>
Specify 1 or more security protocols to enable. Allowed values:
* TLSv1
* TLSv1.1
* TLSv1.2
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.SecurityProtocol
After appliance reboots, the updated security protocol configuration is returned.
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceSecurityProtocol -EnableTlsVersion Tlsv1.2
Set the appliance to only enable TLSv1.2. After confirmation prompt, appliance will immediately reboot.
Related Links
Top

Configure appliance two-factor authentication settings.
SYNTAX
Set-HPOVApplianceTwoFactorAuthentication[ [-SmartCardLoginOnly] <Bool>][ [-EnableEmergencyLocalLogin] <Bool>][ [
-EmergencyLoginAllowType] <String>][ [-SubjectAlternativeNamePatterns] <Array>][ [-SubjectPatterns] <String>][ [
-ValidationOids] <Array>][ [-DirectoryDomainType] <String>][ [-DirectoryDomain] <String>][ [-ApplianceConnection
] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
HPE OneView.
Parameters
Aliases Appliance
Required? False
Position? named
Override confirmation prompt when using -SmartCardLoginOnly parameter.
Aliases cf
Required? false
Position? named
Default value
-DirectoryDomain <String>
Selection values for the "Manually specify" control
In the fields of a certificate, the domain components are usually represented by multiple "DC=" entries. A domain BaseDN, like
abc.example.com, is represented by the three entries "DC=abc", "DC=example", and "DC=com".
Use "example.com" as the domain to use when searching for users in an enterprise directory:
example.com
Configure HPE OneView to look in multiple certificate locations for domain information. HPE OneView tries each item in order
until it finds a successful user entry in the enterprise directory.
Subject.DC=(.),Issuer.DC=(.),SubjectAlternativeName.DirName.DC=(.*),groupA.example.com,groupB.example.com
Aliases None
Required? false
Position? named
Default value
-DirectoryDomainType <String>
The Directory domain control allows you to specify which domain or directory to use when searching for the user in an
enterprise directory. The domain name must match the Base DN of at least one of the directories added to HPE OneView. The
options include:
* Subject
* Subject Alternative Name
* Issuer
* Manually specify
After you select which certificate field HPE OneView must use to extract the domain name, the name is extracted from the DC
attributes specified therein. The DC=(.) configuration extracts the first domain component from the field. The administrator can
only specify DC=(.) here.
If you select Manually specify, you can enter a specific domain using dot notation, or an alternate certificate location from which
to retrieve domain information to use when querying the directory. You can specify multiple entries or domains in the
configuration using ",". Additionally, you can specify the subject, subject alternative name and Issuer DC attributes to support
multiple card configuration.
Aliases None
Required? false
Position? named
Default value
-EmergencyLoginAllowType <String>
Allow emergency login access if the configured authentication directory(ies) for 2-factor are unavailable. Highest security is
obtained by restricting the local administrator account to "ApplianceConsoleOnly". Choose "NetworkAndApplianceConsole" to
allow emergency access via the network.
Aliases None
Required? false
Position? named
Default value

-EnableEmergencyLocalLogin <Bool>
Boolean value to enable ($true) or disable ($false) emergency local login. Must be set to $false when -SmartCardLoginOnly is
used.
Aliases None
Required? false
Position? named
Default value
-SmartCardLoginOnly <Bool>
Use to enforce smart card authentication only. Enabling Smart card only login disables the authentication using a user name
and password. User name and password login is still available through the appliance console. You will be prompted to confirm
the use of this parameter. Use the -Confirm to override prompt.
Aliases None
Required? false
Position? named
Default value
-SubjectAlternativeNamePatterns <Array>
By default, the attribute entry associated with the "Subject Alternative Name" item, within the "Certificate owner" entry, contains
OtherName.UPN=(.*). This tells HPE OneView to extract the user name from the "OtherName.UPN" attribute within the Subject
Alternative Name field of the certificate on the smart card. This is the user name that HPE OneView uses to query the enterprise
directory.
You can edit the value to enable HPE OneView to search for the user name within other additional attributes within Subject
Alternative Name. The options include:
* OtherName.UPN=(.*)
The Microsoft certificate viewer displays "OtherName.UPN" underSubject Alternative Name as:
Other Name:
Principal Name=John.Doe@test.com
* OtherName.RFC822Name=(.*)
The Microsoft certificate viewer displays OtherName.RFC822Name as:
Other Name:
RFC822 Name=John.Doe@test.com
* RFC822Name=(.*)
The Microsoft certificate viewer displays RFC822Name as:
* DirName=(.*)
The Microsoft certificate viewer displays "DirName" under Subject Alternative Name as:
Directory Address:
CN=John Doe
OU=Test Group
O=Test Org
C=US
DC=test
DC=com
Use a comma-separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject
Alternative Name attributes for a valid user name.
NOTE: You can instruct HPE OneView to search for the user name within the attributes of the "Subject" field of the smart card
certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes). See subject entry in the
"Certificate owner" field for details.
Subject Alternative Name multiple attribute entry example OtherName.UPN=(.),OtherName.RFC822Name=(.),RFC822Name=

(.),DirName=(.)
Aliases None
Required? false
Position? named
Default value
-SubjectPatterns <String>
By default, the attribute entry box associated with the "Subject" entry, within the "Certificate owner" field, contains CN=(.*). With
this value, HPE OneView extracts the first user name it encounters within a "CN" attribute within the "Subject" field in the smart
card certificate. You can edit the regular expression for the "CN" attribute using regular expressions to refine the list of
acceptable values. You can edit the value if you need HPE OneView to search for the user name within other additional
attributes within the certificate "Subject" field. The choices include:
* CN=(.*)
* E=(.*)
* UID=(.*)
* DN=(.*)
Microsoft Active Directory users must note that the DN is extracted as an aggregate of the subject attributes from the certificate.
This should match the DN value configured for the user in the Active Directory. If this is not an exact match, the login operation
fails.
Use a comma separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject
attributes for a valid user name.
certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes).
Subject multiple attribute entry example
* CN=(.*),E=(.*),UID=(.*),DN=(.*)
Variations for the CN attribute: examples To match only user names starting with "J_" use CN=(^J_.$) To match names in
"LastName, FirstName" format use CN=(^[a-zA-Z], [a-zA-Z]+$) To match user names containing only numbers CN=(^[0-9]+$)
NOTE: This is applicable when there are multiple CN attributes configured in a certificate and the user wants to specify a specific
attribute rather than the first available in the CN attribute. It is recommended to use patterns that begin with "^" and ends with "$"
so that the system can perform an exact match.
Aliases None
Required? false
Position? named
Default value
-ValidationOids <Array>
This parameter allows you to configure who can access HPE OneView by specifying the Key Usage, Extended Key Usage and
Policy ID Object Identifiers (OIDs) that must be present within a smart card certificate in order for the user associated with the
card to be authenticated. You can configure up to five OID combinations to accommodate different groups of users within your
organization.
By default, one combination is configured, containing the OID combination Smart Card Logon (1.3.6.1.4.1.311.20.2.2), Client
Authentication (1.3.6.1.5.5.7.3.2). This combination requires the certificate on the smart card to be configured to allow the
certificate to be used for smart card logon and for client authentication. It should work for most installations. You can edit this
field to opt for a different combination of OIDs, or to add additional OIDs. A maximum of ten OIDs can be configured in a single
string.
NOTE: If you specify multiple OID combinations and one is a super-set of another, configure the more restrictive combination
first.
Aliases None
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceTwoFactorAuthentication -ValidationOids @(@{"1.3.6.1.4.1.311.20.2.2" = "Smart Card Logon"; "1.3

.6.1.5.5.7.3.2" = "Client Authentication"})
Configured two-factory authentication using default validation OIDs. ### Related Links * [Disable-
HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVApplianceTwoFactorAuthentication) * [Get-HPOVApplianceTwoFactorAuthentication]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceTwoFactorAuthentication) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVApplianceTwoFactorAuthentication
Configure appliance two-factor authentication settings. ### SYNTAX
Set-HPOVApplianceTwoFactorAuthentication[ [-SmartCardLoginOnly] <Bool>][ [-EnableEmergencyLocalLogin] <Bool>][ [

-EmergencyLoginAllowType] <String>][ [-SubjectAlternativeNamePatterns] <Array>][ [-SubjectPatterns] <String>][ [
-ValidationOids] <Array>][ [-DirectoryDomainType] <String>][ [-DirectoryDomain] <String>][ [-ApplianceConnection
] <Array>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
HPE OneView.
Parameters
Aliases Appliance
Required? False
Position? named
Override confirmation prompt when using -SmartCardLoginOnly parameter.

Aliases cf
Required? false
Position? named
Default value
-DirectoryDomain <String>
Selection values for the 'Manually specify' control
In the fields of a certificate, the domain components are usually represented by multiple "DC=" entries. A domain BaseDN, like
abc.example.com, is represented by the three entries "DC=abc", "DC=example", and "DC=com".
Use "example.com" as the domain to use when searching for users in an enterprise directory:
example.com
Configure HPE OneView to look in multiple certificate locations for domain information. HPE OneView tries each item in order
until it finds a successful user entry in the enterprise directory.
Subject.DC=(.),Issuer.DC=(.),SubjectAlternativeName.DirName.DC=(.*),groupA.example.com,groupB.example.com
Aliases None
Required? false
Position? named
Default value
-DirectoryDomainType <String>
The Directory domain control allows you to specify which domain or directory to use when searching for the user in an
enterprise directory. The domain name must match the Base DN of at least one of the directories added to HPE OneView. The
options include:
* Subject
* Subject Alternative Name
* Issuer
* Manually specify
After you select which certificate field HPE OneView must use to extract the domain name, the name is extracted from the DC
attributes specified therein. The DC=(.) configuration extracts the first domain component from the field. The administrator can
only specify DC=(.) here.
If you select Manually specify, you can enter a specific domain using dot notation, or an alternate certificate location from which
to retrieve domain information to use when querying the directory. You can specify multiple entries or domains in the
configuration using ",". Additionally, you can specify the subject, subject alternative name and Issuer DC attributes to support
multiple card configuration.
Aliases None
Required? false
Position? named
Default value
-EmergencyLoginAllowType <String>
Allow emergency login access if the configured authentication directory(ies) for 2-factor are unavailable. Highest security is
obtained by restricting the local administrator account to "ApplianceConsoleOnly". Choose "NetworkAndApplianceConsole" to
allow emergency access via the network.
Aliases None
Required? false
Position? named
Default value
-EnableEmergencyLocalLogin <Bool>
Boolean value to enable ($true) or disable ($false) emergency local login. Must be set to $false when -SmartCardLoginOnly is
used.
Aliases None
Required? false
Position? named
Default value
-SmartCardLoginOnly <Bool>
Use to enforce smart card authentication only. Enabling Smart card only login disables the authentication using a user name
and password. User name and password login is still available through the appliance console. You will be prompted to confirm
the use of this parameter. Use the -Confirm to override prompt.
Aliases None
Required? false
Position? named
Default value
-SubjectAlternativeNamePatterns <Array>
By default, the attribute entry associated with the "Subject Alternative Name" item, within the "Certificate owner" entry, contains
OtherName.UPN=(.*). This tells HPE OneView to extract the user name from the "OtherName.UPN" attribute within the Subject
Alternative Name field of the certificate on the smart card. This is the user name that HPE OneView uses to query the enterprise
directory.
You can edit the value to enable HPE OneView to search for the user name within other additional attributes within Subject
Alternative Name. The options include:
* OtherName.UPN=(.*)
The Microsoft certificate viewer displays "OtherName.UPN" underSubject Alternative Name as:
Other Name:
Principal Name=John.Doe@test.com
* OtherName.RFC822Name=(.*)
The Microsoft certificate viewer displays OtherName.RFC822Name as:
Other Name:
* RFC822Name=(.*)
The Microsoft certificate viewer displays RFC822Name as:
* DirName=(.*)
The Microsoft certificate viewer displays "DirName" under Subject Alternative Name as:
Directory Address:
CN=John Doe
OU=Test Group
O=Test Org
C=US
DC=test
DC=com
Use a comma-separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject
Alternative Name attributes for a valid user name.
certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes). See subject entry in the
"Certificate owner" field for details.
Subject Alternative Name multiple attribute entry example OtherName.UPN=(.),OtherName.RFC822Name=(.),RFC822Name=

(.),DirName=(.)
Aliases None
Required? false
Position? named
Default value
-SubjectPatterns <String>
By default, the attribute entry box associated with the "Subject" entry, within the "Certificate owner" field, contains CN=(.*). With
this value, HPE OneView extracts the first user name it encounters within a "CN" attribute within the "Subject" field in the smart
card certificate. You can edit the regular expression for the "CN" attribute using regular expressions to refine the list of
acceptable values. You can edit the value if you need HPE OneView to search for the user name within other additional
attributes within the certificate "Subject" field. The choices include:
* CN=(.*)
* E=(.*)
* UID=(.*)
* DN=(.*)
Microsoft Active Directory users must note that the DN is extracted as an aggregate of the subject attributes from the certificate.
This should match the DN value configured for the user in the Active Directory. If this is not an exact match, the login operation
fails.
Use a comma separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject
attributes for a valid user name.
certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes).
Subject multiple attribute entry example
* CN=(.*),E=(.*),UID=(.*),DN=(.*)
Variations for the CN attribute: examples To match only user names starting with "J_" use CN=(^J_.$) To match names in
"LastName, FirstName" format use CN=(^[a-zA-Z], [a-zA-Z]+$) To match user names containing only numbers CN=(^[0-9]+$)
NOTE: This is applicable when there are multiple CN attributes configured in a certificate and the user wants to specify a specific
attribute rather than the first available in the CN attribute. It is recommended to use patterns that begin with '^' and ends with '$'
so that the system can perform an exact match.
Aliases None
Required? false
Position? named
Default value
-ValidationOids <Array>
This parameter allows you to configure who can access HPE OneView by specifying the Key Usage, Extended Key Usage and
Policy ID Object Identifiers (OIDs) that must be present within a smart card certificate in order for the user associated with the
card to be authenticated. You can configure up to five OID combinations to accommodate different groups of users within your
organization.
By default, one combination is configured, containing the OID combination Smart Card Logon (1.3.6.1.4.1.311.20.2.2), Client
Authentication (1.3.6.1.5.5.7.3.2). This combination requires the certificate on the smart card to be configured to allow the
certificate to be used for smart card logon and for client authentication. It should work for most installations. You can edit this
field to opt for a different combination of OIDs, or to add additional OIDs. A maximum of ten OIDs can be configured in a single
string.
NOTE: If you specify multiple OID combinations and one is a super-set of another, configure the more restrictive combination
first.
Aliases None
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVApplianceTwoFactorAuthentication -ValidationOids @(@{"1.3.6.1.4.1.311.20.2.2" = "Smart Card Logon"; "1.3

.6.1.5.5.7.3.2" = "Client Authentication"})
Configured two-factory authentication using default validation OIDs.
Related Links
Top

Configure automatic appliance backup.
SYNTAX
Set-HPOVAutomaticBackupConfig [-Hostname] <String> [-Username] <String> [-Password] <SecureString> [-HostSSHKey]
<String> [-Directory] <String> [-Protocol] <String> [-Interval] <String> [-Days] <Array> [-Time] <String>[ [-Asy
nc] <SwitchParameter>] [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter
Set-HPOVAutomaticBackupConfig[ [-Disabled] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceConnection
] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Introduced in HPE OneView 3.0, an automatic appliance backup schedule can be configured. The automatic backup process will
generate the backup file, then transfer it to a host that supports SCP or SFTP. The hosts public SSH key will be needed in order
to successfuly configure.
During the configuration process, a test file will be created and stored on the host. This file can be safely deleted once the
async task has successfully completed.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
-Days <Array>
If specifying a Weekly backup, provide the days in an Array. Accepted values are:
* SU or SUN or Sunday
* MO or MON or Monday
* TU or TUE or Tuesday
* WE or WED or Wednesday
* TH or THUR or Thursday
* FR or FRI or Friday
* SA or SAT or Saturday
Aliases None
Required? true
Position? named
Default value
-Directory <String>
The remote directory on the host where the file will be saved to. Omit to sepcify the root or default directory the user account is
associated with.
Aliases None
Required? true
Position? named
Default value
-Disabled <SwitchParameter>
Disable the automatic backup schedule.
Aliases None
Required? false
Position? named
Default value False
-HostSSHKey <String>
The SCP/SFTP hosts public key, in OpenSSH String format.
Aliases None
Required? true
Position? named
Default value

-Hostname <String>
The IP Address or FQDN of the target SCP or SFTP host.
Aliases None
Required? true
Position? named
Default value
-Interval <String>
The frequency the backup will be generated. Supported values are:
* Daily
* Weekly
Aliases None
Required? true
Position? named
Default value
The password of the user.
Aliases None
Required? true
Position? named
Default value
-Protocol <String>
The protocol to connect to the remote host with. Supported values are:
* SCP
* SFTP
Default: SCP
Aliases None
Required? true
Position? named
Default value SCP
-Time <String>
The time to execute, in 24hr clock.
Aliases None
Required? true
Position? named
Default value
-Username <String>
The username to authenticate to the SCP/SFTP host with.
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Appliance async task to monitor

System.Collections.Arraylist <HPOneView.Appliance.TaskResource>
Multiple appliance async task to monitor
Examples
-------------------------- EXAMPLE 1 --------------------------
$HostSSHKey = Get-Content C:\host.key

Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureStri
ng password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI"
-Time 18:00
This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to
execute at 18:00 (6:00PM).
-------------------------- EXAMPLE 2 --------------------------

ng password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI"
-Time 18:00
New-HPOVBackup
execute at 18:00 (6:00PM). Then, a call to New-HPOVBackup will be made, which will generate and copy the backup file to the
remote location configured. ### Related Links * [Get-HPOVAutomaticBackupConfig](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVAutomaticBackupConfig) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVAutomaticBackupConfig
Configure automatic appliance backup. ### SYNTAX
Set-HPOVAutomaticBackupConfig [-Hostname] <String> [-Username] <String> [-Password] <SecureString> [-HostSSHKey]

<String> [-Directory] <String> [-Protocol] <String> [-Interval] <String> [-Days] <Array> [-Time] <String>[ [-Asy
nc] <SwitchParameter>] [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter
Set-HPOVAutomaticBackupConfig[ [-Disabled] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceConnection

] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Introduced in HPE OneView 3.0, an automatic appliance backup schedule can be configured. The automatic backup process will
generate the backup file, then transfer it to a host that supports SCP or SFTP. The hosts public SSH key will be needed in order
to successfuly configure.
During the configuration process, a test file will be created and stored on the host. This file can be safely deleted once the
async task has successfully completed.
Parameters

Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
-Days <Array>
If specifying a Weekly backup, provide the days in an Array. Accepted values are:
* SU or SUN or Sunday
* MO or MON or Monday
* TU or TUE or Tuesday
* WE or WED or Wednesday
* TH or THUR or Thursday
* FR or FRI or Friday
* SA or SAT or Saturday
Aliases None
Required? true
Position? named
Default value
-Directory <String>
The remote directory on the host where the file will be saved to. Omit to sepcify the root or default directory the user account is
associated with.
Aliases None
Required? true
Position? named
Default value
Disable the automatic backup schedule.
Aliases None
Required? false
Position? named
Default value False
-HostSSHKey <String>
The SCP/SFTP hosts public key, in OpenSSH String format.
Aliases None
Required? true
Position? named
Default value
-Hostname <String>
The IP Address or FQDN of the target SCP or SFTP host.
Aliases None
Required? true
Position? named
Default value
-Interval <String>
The frequency the backup will be generated. Supported values are:

* Daily
* Weekly
Aliases None
Required? true
Position? named
Default value
The password of the user.
Aliases None
Required? true
Position? named
Default value
-Protocol <String>
The protocol to connect to the remote host with. Supported values are:
* SCP
* SFTP
Default: SCP
Aliases None
Required? true
Position? named
Default value SCP
-Time <String>
The time to execute, in 24hr clock.
Aliases None
Required? true
Position? named
Default value
-Username <String>
The username to authenticate to the SCP/SFTP host with.
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Appliance async task to monitor
System.Collections.Arraylist <HPOneView.Appliance.TaskResource>
Multiple appliance async task to monitor
Examples
-------------------------- EXAMPLE 1 --------------------------

ng password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days 'MON','WED','FRI'
-Time 18:00
execute at 18:00 (6:00PM).
-------------------------- EXAMPLE 2 --------------------------

ng password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days 'MON','WED','FRI'
-Time 18:00
New-HPOVBackup
execute at 18:00 (6:00PM). Then, a call to New-HPOVBackup will be made, which will generate and copy the backup file to the
remote location configured.
Related Links
Top
Set-HPOVDataCenter

Set-HPOVDataCenter
Modify an existing Datacenter resource.
SYNTAX
Set-HPOVDataCenter [-InputObject] <Object> [-Name] <String> [-Width] <Float> [-Depth] <Float>[ [-Millimeters] <S
witchParameter>][ [-ElectricalDerating] <Int>][ [-ElectricalDeratingType] <String>][ [-DefaultVoltage] <Int>][ [
-Currency] <String>][ [-PowerCosts] <Float>][ [-CoolingCapacity] <Int>][ [-CoolingMultiplier] <Float>][ [-Applia
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Default: 1.5
Aliases None
Required? false
Position? named
Default value 1.5
-Currency <String>
Aliases None
Required? false
Position? named
Default value USD

Default: 220
Aliases None
Required? false
Position? named
Default value 220
-Depth <Float>
Aliases None
Required? true
Position? named
Default value
Default: 20%
Aliases None
Required? false
Position? named
Default value 20
Default: NA/Jp
Aliases None
Required? false
Position? named
Default value NA/Jp
Datacenter object from Get-HPOVDataCenter.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
-PowerCosts <Float>
Aliases None
Required? false
Position? named
Default value
-Width <Float>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$DataCenter1Name = "LA DC 12"

Create new "LA DC 12" datacenter.

-------------------------- EXAMPLE 2 --------------------------
$NewDCParams = @{
Name = "Houston DC1";

Width = 10668;
Depth = 13716;
PowerCosts = 0.10;
Address1 = "123 Main Place";
Address2 = "Suite 400";
City = "Houston;
State = "TX";
Country = "US";
PostCode = "77002";
TimeZone = "US/Central";
PrimaryContact = (Get-HPOVRemoteSupportContact -Name "Joe Ellis" -EA Stop)
SecondaryContact = (Get-HPOVRemoteSupportContact -Name "Brandon Pear" -EA Stop)
}
Create a new datacenter with Remote Support settings. ### Related Links * [Get-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVDataCenter) * [New-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVDataCenter) * [Remove-HPOVDataCenter]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVDataCenter) * [Set-HPOVDataCenterRemoteSupport]
Top
### HPE OneView 4.00 Library ## Set-HPOVDataCenter
Modify an existing Datacenter resource. ### SYNTAX
Set-HPOVDataCenter [-InputObject] <Object> [-Name] <String> [-Width] <Float> [-Depth] <Float>[ [-Millimeters] <S
witchParameter>][ [-ElectricalDerating] <Int>][ [-ElectricalDeratingType] <String>][ [-DefaultVoltage] <Int>][ [
-Currency] <String>][ [-PowerCosts] <Float>][ [-CoolingCapacity] <Int>][ [-CoolingMultiplier] <Float>][ [-Applia
Parameters

Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Default: 1.5
Aliases None
Required? false
Position? named
Default value 1.5
-Currency <String>
Aliases None
Required? false
Position? named
Default value USD

Default: 220
Aliases None
Required? false
Position? named
Default value 220
-Depth <Float>
Aliases None
Required? true
Position? named
Default value
Default: 20%
Aliases None
Required? false
Position? named
Default value 20
Default: NA/Jp
Aliases None
Required? false
Position? named
Default value NA/Jp

Datacenter object from Get-HPOVDataCenter.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Name <String>
Aliases None
Required? true
Position? named
Default value
-PowerCosts <Float>
Aliases None
Required? false
Position? named
Default value
-Width <Float>
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$DataCenter1Name = 'LA DC 12'

Create new 'LA DC 12' datacenter.

-------------------------- EXAMPLE 2 --------------------------
$NewDCParams = @{
Name = 'Houston DC1';

Width = 10668;
Depth = 13716;
PowerCosts = 0.10;
Address1 = '123 Main Place';
Address2 = 'Suite 400';
City = 'Houston;
State = 'TX';
Country = 'US';
PostCode = '77002';
TimeZone = 'US/Central';
PrimaryContact = (Get-HPOVRemoteSupportContact -Name 'Joe Ellis' -EA Stop)
SecondaryContact = (Get-HPOVRemoteSupportContact -Name 'Brandon Pear' -EA Stop)
}
Create a new datacenter with Remote Support settings.
Related Links
Get-HPOVDataCenter
New-HPOVDataCenter
Top

Modify an existing Datacenter Remote Support setting.
SYNTAX
Set-HPOVDataCenterRemoteSupport [-InputObject] <Object>[ [-PrimaryContact] <Object>][ [-SecondaryContact] <Objec
t>][ [-Address1] <String>][ [-Address2] <String>][ [-City] <String>][ [-State] <String>] [-PostCode] <String>[ [
-Country] <String>][ [-TimeZone] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Comm
onParameters>]
This Cmdlet will help modify an existing DataCenters Remote Support location and contacts. In order to set a DataCenter
Remote Support location, the appliance must be configured and regsitered with Remote Support.
Parameters
-Address1 <String>
Aliases None
Required? false
Position? named
Default value
-Address2 <String>
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named

Aliases None
Required? false
Position? named
Default value
-City <String>
Aliases None
Required? false
Position? named
Default value
-Country <String>
Aliases None
Required? false
Position? named
Default value
The DataCenter to modify.
Aliases None
Required? true
Position? named
Default value
-PostCode <String>

Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-State <String>
Aliases None
Required? false
Position? named
Default value
-TimeZone <String>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
DataCenter facility object from Get-HPOVDataCenter.
Return Values
HPOneView.Appliance.AyncTask
Modified datacenter Remote Support location asyncronous task.
Examples
-------------------------- EXAMPLE 1 --------------------------
$NewPrimaryConact = Get-HPOVRemoteSupportContact -Name "Vivian Waters" -ErrorAction Stop

Get-HPOVDataCenter -Name "LA DC 12" -ErrorAction Stop | Set-HPOVDataCenterRemoteSupport -PrimaryContact $NewPrim
aryConact
Modify "LA DC 12" datacenter with new Primary Contact. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVDataCenterRemoteSupport
Modify an existing Datacenter Remote Support setting. ### SYNTAX
Set-HPOVDataCenterRemoteSupport [-InputObject] <Object>[ [-PrimaryContact] <Object>][ [-SecondaryContact] <Objec

t>][ [-Address1] <String>][ [-Address2] <String>][ [-City] <String>][ [-State] <String>] [-PostCode] <String>[ [
-Country] <String>][ [-TimeZone] <String>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<Comm
onParameters>]
This Cmdlet will help modify an existing DataCenters Remote Support location and contacts. In order to set a DataCenter
Remote Support location, the appliance must be configured and regsitered with Remote Support.
Parameters
-Address1 <String>
Aliases None
Required? false
Position? named
Default value
-Address2 <String>
Aliases None
Required? false
Position? named
Default value
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-City <String>

Aliases None
Required? false
Position? named
Default value
-Country <String>
Aliases None
Required? false
Position? named
Default value
The DataCenter to modify.
Aliases None
Required? true
Position? named
Default value
-PostCode <String>
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-State <String>
Aliases None
Required? false
Position? named
Default value
-TimeZone <String>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AyncTask
Modified datacenter Remote Support location asyncronous task.
Examples
-------------------------- EXAMPLE 1 --------------------------
$NewPrimaryConact = Get-HPOVRemoteSupportContact -Name 'Vivian Waters' -ErrorAction Stop

Get-HPOVDataCenter -Name 'LA DC 12' -ErrorAction Stop | Set-HPOVDataCenterRemoteSupport -PrimaryContact $NewPrim
aryConact
Modify 'LA DC 12' datacenter with new Primary Contact.
Related Links
Top
Set-HPOVEnclosure

Set-HPOVEnclosure
Rename Synergy Frame Name or Rack Name.
SYNTAX
Set-HPOVEnclosure [-InputObject] <Object>[ [-Name] <String>][ [-RackName] <String>][ [-ApplianceConnection] <Obj
This Cmdlet provides the ability to set a Synergy Frame/Enclosure Name and/or the Synergy Rack Name to provided values.
Each requires a seperate async task to complete.
Parameters
Aliases Appliance
Required? false
Position? named

Aliases [-Encl, -Enclosure]
A Syngery Frame/Enclosure Object.
Aliases Enclosure, Encl
Required? true
Position? named
Default value
-Name <String>
The new name of a Synergy Frame.
Aliases None
Required? false
Position? named
Default value
-RackName <String>
The new name of ta Synergy Rack.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Syngery Enclosure resource
Return Values
Single async task resource for resource name update
Collection of async tasks
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosure -Name "0000A66101" -ErrorAction Stop | Set-HPOVEnclosure -Name "MyEnclName1" | Wait-HPOVTaskCo

mplete
Set the provided Synergy Frame resource Name to a new value.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVEnclosure -Name "0000A66101" -ErrorAction Stop | Set-HPOVEnclosure -Name "MyEnclName1" -RackName "DC11-R
ack4A" | Wait-HPOVTaskComplete
Set the provided Synergy Frame resource Name and RackName to a new value. ### Related Links * [Add-HPOVEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVEnclosure) * [Get-HPOVEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Reset-HPOVEnclosureDevice) * [Set-HPOVEnclosureActiveFLM]
Top
### HPE OneView 4.00 Library ## Set-HPOVEnclosure
Rename Synergy Frame Name or Rack Name. ### SYNTAX
Set-HPOVEnclosure [-InputObject] <Object>[ [-Name] <String>][ [-RackName] <String>][ [-ApplianceConnection] <Obj

This Cmdlet provides the ability to set a Synergy Frame/Enclosure Name and/or the Synergy Rack Name to provided values.
Each requires a seperate async task to complete.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases [-Encl, -Enclosure]
A Syngery Frame/Enclosure Object.
Aliases Enclosure, Encl
Required? true
Position? named
Default value
-Name <String>
The new name of a Synergy Frame.
Aliases None
Required? false
Position? named
Default value
-RackName <String>
The new name of ta Synergy Rack.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Syngery Enclosure resource

Return Values
Single async task resource for resource name update
Collection of async tasks
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosure -Name '0000A66101' -ErrorAction Stop | Set-HPOVEnclosure -Name 'MyEnclName1' | Wait-HPOVTaskCo

mplete
Set the provided Synergy Frame resource Name to a new value.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVEnclosure -Name '0000A66101' -ErrorAction Stop | Set-HPOVEnclosure -Name 'MyEnclName1' -RackName 'DC11-R
ack4A' | Wait-HPOVTaskComplete
Set the provided Synergy Frame resource Name and RackName to a new value.
Related Links
Add-HPOVEnclosure
Get-HPOVEnclosure
Top

Power reset Enclosure component.
SYNTAX
Set-HPOVEnclosureActiveFLM [-Enclosure] <Object> [-BayID] <Int32>[ [-Force] <SwitchParameter>][ [-WhatIf] <Switc
hParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Parameters
-BayID <Int32>
BAYID
Aliases None
Required? true
Position? named
Default value 0
Aliases cf
Required? false
Position? named
Default value
-Enclosure <Object>
Aliases None
Required? true
Position? named
Default value
FORCE
Aliases None
Required? false
Position? named
Default value False
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Object
Enclosure Report
Async task resource to monitor
Examples
-------------------------- EXAMPLE 1 --------------------------
EXAMPLE1

-------------------------- EXAMPLE 2 --------------------------
Example2

-------------------------- EXAMPLE 3 --------------------------
EXAMPLE3
Display a brief list of the enclosures managed or monitored by the appliance. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVEnclosureActiveFLM
Power reset Enclosure component. ### SYNTAX

Set-HPOVEnclosureActiveFLM [-Enclosure] <Object> [-BayID] <Int32>[ [-Force] <SwitchParameter>][ [-WhatIf] <Switc
hParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Parameters
-BayID <Int32>
BAYID
Aliases None
Required? true
Position? named
Default value 0
Aliases cf
Required? false
Position? named
Default value
-Enclosure <Object>
Aliases None
Required? true
Position? named
Default value
FORCE
Aliases None
Required? false
Position? named
Default value False

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
System.Object
Enclosure Report
Async task resource to monitor
Examples
-------------------------- EXAMPLE 1 --------------------------
EXAMPLE1
-------------------------- EXAMPLE 2 --------------------------
Example2
-------------------------- EXAMPLE 3 --------------------------
EXAMPLE3
Related Links
Top

Modify an existing enclosure group policy.
SYNTAX
Set-HPOVEnclosureGroup [-InputObject] <Object> [-Name] <String> [-ConfigurationScript] <String> [-PowerRedundant
Mode] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
An enclosure group is a logical resource that defines a standard configuration for member logical enclosures. Use this Cmdlet to
update the configuration policy for a specific enclosure group resource.
Required permissions: Server administrator or Infrastructure administrator
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? True
Position? named
Default value

An enclosure group resource from Get-HPOVEnclosureGroup.
Aliases EnclosureGroup
Required? True
Position? named
Default value
-Name <String>
Specify a new resource name.
Aliases None
Required? True
Position? named
Default value
Allowed Values:

Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Servers.EnclosureGroup [System.Management.Automation.PSCustomObject]
Enclosure group resource from Get-HPOVEnclosureGroup.
Return Values
The updated enclosure group resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
$EnclosureGroup = Get-HPOVEnclosureGroup -Name ProdEG1 -ErrorAction Stop Set-HPOVEnclosureGroup -InputObject $En

closureGroup -Name VirtProdEG1
Change the name of the provided enclosure group resource.

-------------------------- EXAMPLE 2 --------------------------
$UpdatedConfigScript = 'REMOVE USER "admin"

ADD USER "ops" "*********"
SET USER CONTACT "ops" "MySecretPassword"
SET USER FULLNAME "ops" ""
SET USER ACCESS "ops" OPERATOR
ASSIGN SERVER 1-16 "ops"
ENABLE USER "ops"
hponcfg all >> end_marker
end_marker' Get-HPOVEnclosureGroup -Name EG1 -ErrorAction Stop | Set-HPOVEnclosureGroup -ConfigurationScript $Up

datedConfigScript
Update the configuration script of the provided enclosure group. ### Related Links * [Get-HPOVEnclosureGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVEnclosureGroup) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVEnclosureGroup
Modify an existing enclosure group policy. ### SYNTAX
Set-HPOVEnclosureGroup [-InputObject] <Object> [-Name] <String> [-ConfigurationScript] <String> [-PowerRedundant

Mode] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
An enclosure group is a logical resource that defines a standard configuration for member logical enclosures. Use this Cmdlet to
update the configuration policy for a specific enclosure group resource.
Required permissions: Server administrator or Infrastructure administrator
Parameters

Aliases Appliance
Required? False
Position? named
Aliases None
Required? True
Position? named
Default value
An enclosure group resource from Get-HPOVEnclosureGroup.
Aliases EnclosureGroup
Required? True
Position? named
Default value
-Name <String>
Specify a new resource name.
Aliases None
Required? True
Position? named
Default value
Allowed Values:

Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
Enclosure group resource from Get-HPOVEnclosureGroup.
Return Values
The updated enclosure group resource.
Examples
-------------------------- EXAMPLE 1 --------------------------
$EnclosureGroup = Get-HPOVEnclosureGroup -Name ProdEG1 -ErrorAction Stop Set-HPOVEnclosureGroup -InputObject $En

closureGroup -Name VirtProdEG1
Change the name of the provided enclosure group resource.

-------------------------- EXAMPLE 2 --------------------------
$UpdatedConfigScript = 'REMOVE USER "admin"

ADD USER "ops" "*"
SET USER CONTACT "ops" "MySecretPassword"
SET USER FULLNAME "ops" ""
SET USER ACCESS "ops" OPERATOR
ASSIGN SERVER 1-16 "ops"
ENABLE USER "ops"
hponcfg all >> end_marker
<USER_INFO MODE="write">
<ADD_USER
USER_NAME="ops"
USER_LOGIN="ops"
PASSWORD="Supersecretpassword">
<ADMIN_PRIV value ="N"/>
<REMOTE_CONS_PRIV value ="Y"/>
<RESET_SERVER_PRIV value ="N"/>
<VIRTUAL_MEDIA_PRIV value ="N"/>
<CONFIG_ILO_PRIV value="Yes"/>
</ADD_USER>
</USER_INFO>
end_marker' Get-HPOVEnclosureGroup -Name EG1 -ErrorAction Stop | Set-HPOVEnclosureGroup -ConfigurationScript $Up

datedConfigScript
Update the configuration script of the provided enclosure group.
Related Links
Top
Set-HPOVEulaStatus

Set-HPOVEulaStatus
Accept the EULA and set support access for the specified appliance.
SYNTAX
Set-HPOVEulaStatus [-Appliance] <Object> [-SupportAccess] <String> [<CommonParameters>]
Parameters
-Appliance <Object>
The FQDN or IP Address of an HPE OneView appliance or HPOneView.Applinace.Connection must be provided.
Aliases None
Required? true
Position? 0
Default value
-SupportAccess <String>
Set to "yes" to allow HP suport access to the appliance, otherwise set to "no".
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Version and current support access state
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVEulaStatus -Appliance appliance.contoso.com -supportAccess "yes"
Connects to a specific appliance, accepting the EULA and enable Support Access. ### Related Links * [Get-HPOVEulaStatus]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVEulaStatus) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVEulaStatus
Accept the EULA and set support access for the specified appliance. ### SYNTAX
Set-HPOVEulaStatus [-Appliance] <Object> [-SupportAccess] <String> [<CommonParameters>]
Parameters
-Appliance <Object>
The FQDN or IP Address of an HPE OneView appliance or HPOneView.Applinace.Connection must be provided.
Aliases None
Required? true
Position? 0
Default value
-SupportAccess <String>
Set to 'yes' to allow HP suport access to the appliance, otherwise set to 'no'.
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Version and current support access state
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVEulaStatus -Appliance appliance.contoso.com -supportAccess "yes"
Connects to a specific appliance, accepting the EULA and enable Support Access.
Related Links
Get-HPOVEulaStatus
Top

Modify an existing external baseline repository.
SYNTAX
Set-HPOVExternalRepository [-InputObject] <Object> [-Name] <String>[ [-Username] <String>][ [-Password] <SecureS
tring>][ [-Certificate] <String>][ [-Async] <SwitchParameter>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Set-HPOVExternalRepository [-InputObject] <Object> [-Name] <String> [-Credential] <String>[ [-Certificate] <Stri

ng>][ [-Async] <SwitchParameter>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Set-HPOVExternalRepository[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
* Apache
This Cmdlet supports modifying an existing external repository. Use this Cmdlet to modify the Name, authentication credentials
and/or HTTP SSL certificate.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
Default value

Provide the external repository object to modify.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Update the configured repository with the new name.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Username <String>
Aliases None
Required? false
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Name UpdatedRepoName
Modify an existing external repository with a new name.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Credentia

l (Get-PSCredential -Username "Domain\MyUpdatedAccountName")
Modify an existing repository with new credentials.

-------------------------- EXAMPLE 3 --------------------------
$UpdatedSslCertificate = Get-Content C:\Dir\UpdatedCert.cer -raw

Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Certificate $Updated
SslCertificate
Modify an existing repository with new Base64 SSL public certificate. ### Related Links * [New-HPOVExternalRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVExternalRepository) * [Remove-HPOVExternalRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVExternalRepository) * [Update-
HPOVExternalRepository](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVExternalRepository) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVExternalRepository
Modify an existing external baseline repository. ### SYNTAX
Set-HPOVExternalRepository [-InputObject] <Object> [-Name] <String>[ [-Username] <String>][ [-Password] <SecureS

tring>][ [-Certificate] <String>][ [-Async] <SwitchParameter>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Set-HPOVExternalRepository [-InputObject] <Object> [-Name] <String> [-Credential] <String>[ [-Certificate] <Stri
ng>][ [-Async] <SwitchParameter>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
Set-HPOVExternalRepository[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
* Apache
This Cmdlet supports modifying an existing external repository. Use this Cmdlet to modify the Name, authentication credentials
and/or HTTP SSL certificate.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Aliases None
Required? true
Position? named
Default value
Provide the external repository object to modify.
Aliases None
Required? true
Position? named
Default value
-Name <String>
Update the configured repository with the new name.
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Username <String>
Aliases None
Required? false
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values

Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Name UpdatedRepoName
Modify an existing external repository with a new name.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Credentia

l (Get-PSCredential -Username 'Domain\MyUpdatedAccountName')
Modify an existing repository with new credentials.
-------------------------- EXAMPLE 3 --------------------------
$UpdatedSslCertificate = Get-Content C:\Dir\UpdatedCert.cer -raw

Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Certificate $Updated
SslCertificate
Modify an existing repository with new Base64 SSL public certificate.
Related Links
Top

Modify an existing hypervisor manager.
SYNTAX
Set-HPOVHypervisorManager [-InputObject] <HPOneView.Cluster.HypervisorManager>[ [-Hostname] <String>][ [-Display
Name] <String>][ [-Port] <int>][ [-Credential] <PSCredential>][ [-VirtualSwitchType] <String>][ [-DistributedSwi
tchUsage] <String>][ [-DistributedSwitchVersion] <String>][ [-HAEnabled] <bool>][ [-DRSEnabled] <bool>][ [-Multi
NicVMotionEnabled] <bool>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
You can register a new hypervisor manager with HPE OneView by providing the hostname and credentials. The registered
hypervisor manager contains preferences, which are used as default hypervisor or cluster settings during hypervisor cluster
profile creation. You can modify the hypervisor manager preferences using the edit operation. You can override these values in
a hypervisor cluster profile.
hypervisor manager.
OneView.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? False
Position? named
Default value
-DRSEnabled <bool>
Choose to enable or disable VMware DRS. Additional DRS policy settings must be made within the vSphere client.
Aliases None
Required? false
Position? named
Default value
-DisplayName <String>
Change the hypervisor managers display name. Used for resource lookup.
Aliases None
Required? false
Position? named
Default value
-DistributedSwitchUsage <String>
Applicable only when vSwitch type is Distributed. This specifies which networks should be configured for distributed switches.
Allowed values:
* AllNetworks - Configures all the networks in the hypervisor cluster profile with distributed virtual switches
. All networks include Management, special purpose and general purpose networks. The special purpose networks c
omprise VM Migration, iSCSI and Fault Tolerance.
* GeneralNetworks - Configures the general purpose networks in the hypervisor cluster profile with distributed
virtual switches.
Aliases None
Required? false
Position? named
Default value
-DistributedSwitchVersion <String>
Applicable only when vSwitch type is of type distributed. Configures distributed virtual switch with the specified version, and must
be supported by the Hypervisor Manager.
Aliases None
Required? false
Position? named
Default value

-HAEnabled <bool>
Enable VMware High Availability on a hypervisor cluster to ensure decreased downtime in a virtual environment. Additional
VMware HA settings much be made within the vSphere client.
Aliases None
Required? false
Position? named
Default value
-Hostname <String>
Update the vCenter hostname or IP Address.
Aliases None
Required? false
Position? named
Default value
-InputObject <HPOneView.Cluster.HypervisorManager>
The HPOneView.Cluster.HypervisorManager resource from Get-HPOVHypervisorManager.
Aliases Name
Required? true
Position? named
Default value
-MultiNicVMotionEnabled <bool>
Configures VMware Multi-NIC vMotion on hypervisors when there are multiple NICs to VM Migration network. Enable Multi-NIC
vMotion to load balance a single or multiple vMotion transmissions over multiple physical NICs.
Aliases None
Required? false
Position? named
Default value
-Port <int>
Modify the vCenter API SSL port.

Aliases None
Required? false
Position? named
Default value
-VirtualSwitchType <String>
Configures virtual switch on a hypervisor with a specified type. Allowed values:
* Standard - A virtual switch configured and managed at the hypervisor level; provides networking to virtual ma
chines and VM kernels.
* Distributed - A virtual switch configured and managed at data center level and configured for each hypervisor
to provide networking to virtual machines and VM Kernels.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Cluster.HypervisorManager
The hypervisor manager from Get-HPOVHypervisorManager.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Manager = Get-HPOVHypervisorManager -Name vCenter1 -ErrorAction Stop

Set-HPOVHypervisorManager -InputObject $Manager -Credential (Get-Credential NewUser@domain.com -Message Password
) -DRSEnabled $true
Update the vCenter credentials to use for the conencted hypervisor manager, and enable DRS preference to true.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVHypervisorManager -Name vCenter1 -ErrorAction Stop | Set-HPOVHypervisorManager -VirtualSwitchType Distri

buted -DistributedSwitchUsage AllNetworks -DistributedSwitchVersion 6.0
Change the vCenter preferences to enable Distributed virtual switch for all networking, and set the distributed switch version to
6.0.
-------------------------- EXAMPLE 3 --------------------------
$Manager = Get-HPOVHypervisorManager -Name vCenter1 -ErrorAction Stop
$Manager.AvailableDvsVersions
4.0
4.1.0
5.0.0
5.1.0
5.5.0
Set-HPOVHypervisorManager -DistributedSwitchVersion 5.5.0
Get the hypervisor manager, display the supported and available distribute switch versions, and set the manager to the
maximum supported version 5.5.0.
Related Links
Top
Set-HPOVInitialPassword

Set-HPOVInitialPassword
Change the initial password of the Administrator user account.
SYNTAX
Set-HPOVInitialPassword [-OldPassword] <String> [-NewPassword] <String> [-Appliance] <Object> [<CommonParameters
>]
Changes the initial default password of the Administrator local appliance account to the supplied new password during first time
setup (FTS.)
Parameters
-Appliance <Object>
Specify Appliance FQDN, Name or IP Address. If no valid Appliance Connection is found, a temporary connection is created for
the specified appliance.
Aliases None
Required? true
Position? named
Default value
-NewPassword <String>
New password for this account. Will prompt for password if not supplied.
Aliases None
Required? true
Position? named
Default value
-OldPassword <String>
Current default password for this account. Will prompt for password if not supplied.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
None.
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVInitialPassword -Appliance MyAppliance.domain.com
Change the Administrator password, and prompted for both the original and new password. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVInitialPassword
Change the initial password of the Administrator user account. ### SYNTAX
Set-HPOVInitialPassword [-OldPassword] <String> [-NewPassword] <String> [-Appliance] <Object> [<CommonParameters

>]
Changes the initial default password of the Administrator local appliance account to the supplied new password during first time
setup (FTS.)
Parameters
-Appliance <Object>
Specify Appliance FQDN, Name or IP Address. If no valid Appliance Connection is found, a temporary connection is created for
the specified appliance.
Aliases None
Required? true
Position? named
Default value
-NewPassword <String>
New password for this account. Will prompt for password if not supplied.
Aliases None
Required? true
Position? named
Default value
-OldPassword <String>
Current default password for this account. Will prompt for password if not supplied.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
None.
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVInitialPassword -Appliance MyAppliance.domain.com
Change the Administrator password, and prompted for both the original and new password.
Related Links
Top

Configure Authentication Directory default directory.
SYNTAX
Set-HPOVLdapDefaultDirectory [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-DisableLocalLogin] <Swit
chParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Use this cmdlet to set the default Authentication Directory on the appliance. Use Get-HPOVLdapDirectory to pass in the
directory to configure as the default. Once the Default Directory is set, the CMDLET will configure a Registry Key
(HKCU:\Software\Hewlett-Packard\HPOneView) called "AuthProvider#{ApplianceConnectionName}". The Library will read this
value upon load and use it as the default value for the -AuthDirectory parameter in Connect-HPOVMgmt.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases cf
Required? false
Position? named
Default value
-DisableLocalLogin <SwitchParameter>
Use to disable appliance local login accounts. You cannot use this parameter if an Authentication Directory is not configured.
Aliases None
Required? false
Position? named
Default value False
Aliases [-Directory] Provide the Directory Name, URI or Object. If you want to set the Authentication Directory back to Local,
specify LOCAL as the name.
Aliases Directory
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Authentication Directory retrieved using Get-HPOVLdapDirectory
Return Values
Appliance Authentication Directory setting
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVLdapDefaultDirectory -InputObject "Domain1"

# CMDLET will create:
# HKCU:\Software\Hewlett-Packard\HPOneView\AuthProvider#MyAppliance.domain.com REG_SZ, value = "Domain1"
Set "Domain1" as the default authentication directory for the appliance. Then, the CMDLET will create the REG_SZ
"AuthProvider#MyAppliance.domain.com" with a value of "Domain1". ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVLdapDefaultDirectory
Configure Authentication Directory default directory. ### SYNTAX
Set-HPOVLdapDefaultDirectory [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-DisableLocalLogin] <Swit

chParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Use this cmdlet to set the default Authentication Directory on the appliance. Use Get-HPOVLdapDirectory to pass in the
directory to configure as the default. Once the Default Directory is set, the CMDLET will configure a Registry Key
(HKCU:\Software\Hewlett-Packard\HPOneView) called "AuthProvider#{ApplianceConnectionName}". The Library will read this
value upon load and use it as the default value for the -AuthDirectory parameter in Connect-HPOVMgmt.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases cf
Required? false
Position? named
Default value
-DisableLocalLogin <SwitchParameter>
Use to disable appliance local login accounts. You cannot use this parameter if an Authentication Directory is not configured.
Aliases None
Required? false
Position? named
Default value False
Aliases [-Directory] Provide the Directory Name, URI or Object. If you want to set the Authentication Directory back to Local,
specify LOCAL as the name.
Aliases Directory
Required? true
Position? 0
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Authentication Directory retrieved using Get-HPOVLdapDirectory
Return Values
Appliance Authentication Directory setting
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVLdapDefaultDirectory -InputObject "Domain1"
CMDLET will create:
HKCU:\Software\Hewlett-Packard\HPOneView\AuthProvide
r#MyAppliance.domain.com REG_SZ, value = "Domain1"
Set 'Domain1' as the default authentication directory for the appliance. Then, the CMDLET will create the REG_SZ
"AuthProvider#MyAppliance.domain.com" with a value of "Domain1".
Related Links
Top

Assign or change roles for LDAP Groups.
SYNTAX
Set-HPOVLdapGroupRole [-InputObject] <Object> [-Roles] <Array> [-UserName] <String> [-Password] <SecureString>[
[-Credential] <PSCredential>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVLdapGroupRole [-InputObject] <Object> [-Roles] <Array>[ [-ScopePermissions] <Array>] [-UserName] <String

> [-Password] <SecureString>[ [-Credential] <PSCredential>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVLdapGroupRole [-InputObject] <Object>[ [-ScopePermissions] <Array>] [-UserName] <String> [-Password] <Se

cureString>[ [-Credential] <PSCredential>] [-ApplianceConnection] <Object> [<CommonParameters>]
Changes current roles of an LDAP Group with a given set of roles. You must provide the list of all roles the LDAP Group should
be set to, and not a subset of roles.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? False
Position? named
Default value
Aliases [-g, -GroupName, -Group]
Directroy Group to add.
Aliases g, name, GroupName, Group
Required? true
Position? named
Default value
Aliases [-p]
Directory User account password
Aliases p
Required? true
Position? named
Default value
-Roles <Array>
Aliases r, role
Required? true
Position? named
Default value
Stop) }
Aliases None
Required? False
Position? named
Default value
-UserName <String>
Aliases [-u]
Directory Username to authenticate with

Aliases u
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.SecureString
Return Values
Updated LDAP Group object with new role assignment(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles "Server administrator" -u "Sarah Peters
on"
-------------------------- EXAMPLE 2 --------------------------
$roles = "Server administrator","Backup administrator"

$password = convertto-SecureString -asplaintext "password123890" -force
Set-HPOVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles $roles -u "Sarah Peterson" -p $password
Set "MY Directory Group1" from Domain1 with Server and Backup administrator roles, and specify password for group
validation.
-------------------------- EXAMPLE 3 --------------------------
$LdapDirectoryName = "CorpDomain"
$MyAdCreds = Get-Credential
Get-HPOVLdapGroup -Group $CorpNetworkAdmins -ErrorAction Stop | ? loginDomain -eq $LdapDirectoryName | Set-HPOVL
dapGroupRole -ScopePermissions @{Role = "Network administrator"; Scope = $NewSBACScope } -Credential $MyAdCreds
Change the Scope permissions for the specified authentication directory group. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVLdapGroupRole
Assign or change roles for LDAP Groups. ### SYNTAX
Set-HPOVLdapGroupRole [-InputObject] <Object> [-Roles] <Array> [-UserName] <String> [-Password] <SecureString>[

[-Credential] <PSCredential>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVLdapGroupRole [-InputObject] <Object> [-Roles] <Array>[ [-ScopePermissions] <Array>] [-UserName] <String
> [-Password] <SecureString>[ [-Credential] <PSCredential>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVLdapGroupRole [-InputObject] <Object>[ [-ScopePermissions] <Array>] [-UserName] <String> [-Password] <Se

cureString>[ [-Credential] <PSCredential>] [-ApplianceConnection] <Object> [<CommonParameters>]
Changes current roles of an LDAP Group with a given set of roles. You must provide the list of all roles the LDAP Group should
be set to, and not a subset of roles.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? False
Position? named
Default value
Aliases [-g, -GroupName, -Group]
Directroy Group to add.
Aliases g, name, GroupName, Group
Required? true
Position? named
Default value
Aliases [-p]
Directory User account password
Aliases p
Required? true
Position? named
Default value
-Roles <Array>
Aliases r, role
Required? true
Position? named
Default value
Stop) }
Aliases None
Required? False
Position? named
Default value
-UserName <String>
Aliases [-u]
Directory Username to authenticate with
Aliases u
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.SecureString
Return Values
Updated LDAP Group object with new role assignment(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles "Server administrator" -u 'Sarah Peters
on'
-------------------------- EXAMPLE 2 --------------------------
$roles = "Server administrator","Backup administrator"

Set-HPOVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles $roles -u 'Sarah Peterson' -p $password
Set "MY Directory Group1" from Domain1 with Server and Backup administrator roles, and specify password for group
validation.
-------------------------- EXAMPLE 3 --------------------------
$LdapDirectoryName = 'CorpDomain'
$MyAdCreds = Get-Credential
Get-HPOVLdapGroup -Group $CorpNetworkAdmins -ErrorAction Stop | ? loginDomain -eq $LdapDirectoryName | Set-HPOVL
dapGroupRole -ScopePermissions @{Role = 'Network administrator'; Scope = $NewSBACScope } -Credential $MyAdCreds
Change the Scope permissions for the specified authentication directory group.
Related Links
Top

Modify a configured Logical Enclosure resource.
SYNTAX
Set-HPOVLogicalEnclosure [-InputObject] <Object>[ [-Name] <String>][ [-EnclosureGroup] <Object>][ [-PowerMode] <
String>][ [-AmbientTemperatureSetting] <String>][ [-ApplianceConnection] <Array>][ [-Async] <SwitchParameter>] [
<CommonParameters>]
Use this Cmdlet to modify an existing Logical Enclosure.
Parameters
-AmbientTemperatureSetting <String>
The ambient temperature mode describing the environment in which the logical enclosure should be optimized to operate. When
not specified, a default value of Standard is assumed.
Allowed values:
* ASHRAE_A3 - Extended ambient temperatures up to 40C/104F degrees.

* Standard - Expected ambient temperatures up to 35C/95F degrees.
* Telco - Extended ambient temperatures up to 40C/104F degrees and operation extremes up to 55C/131F degrees.
Aliases None
Required? false
Position? 4
Default value
Aliases Appliance
Required? False
Position? 5
Aliases None
Required? False
Position? named
Default value False
Associate the Logical Enclosure with a new Enclosure Group.
Aliases eg
Required? false
Position? 2
Default value
Logical Enclosure resource from Get-HPOVLogicalEnclosure.
Aliases None
Required? true
Position? 0
Default value
-Name <String>
Specify a new Logical Enclosure name.
Aliases None
Required? false
Position? 1
Default value

-PowerMode <String>
Change the Power Mode of the Logical Enclosure.
Allowed values:
* RedundantPowerFeed - There are at least twice as many power supplies as are necessary (n + n).
* RedundantPowerSupply - There is at least 1 more power supply than is necessary (n + 1).
Aliases None
Required? false
Position? 3
Default value
<CommonParameters>
Input Types
HPOneView.LogicalEnclosure
HPE Syngery Logical Enclosure resource from Get-HPOVLogicalEnclosure.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalEnclosure -Name OriginalName | Set-HPOVLogicalEnclosure -Name NewName
Change the Logical Enclosure name.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalEnclosure -Name OriginalName | Set-HPOVLogicalEnclosure -AmbientTemperatureSetting ASHRAE_A3
Change the Logical Enclosure ambient temperature setting. ### Related Links * [Get-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalEnclosure) * [Remove-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalEnclosure) * [Update-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVLogicalEnclosure) * [Update-
Top
### HPE OneView 4.00 Library ## Set-HPOVLogicalEnclosure
Modify a configured Logical Enclosure resource. ### SYNTAX

Set-HPOVLogicalEnclosure [-InputObject] <Object>[ [-Name] <String>][ [-EnclosureGroup] <Object>][ [-PowerMode] <
String>][ [-AmbientTemperatureSetting] <String>][ [-ApplianceConnection] <Array>][ [-Async] <SwitchParameter>] [
<CommonParameters>]
Use this Cmdlet to modify an existing Logical Enclosure.
Parameters
-AmbientTemperatureSetting <String>
The ambient temperature mode describing the environment in which the logical enclosure should be optimized to operate. When
not specified, a default value of Standard is assumed.
Allowed values:

* Standard - Expected ambient temperatures up to 35C/95F degrees.
* Telco - Extended ambient temperatures up to 40C/104F degrees and operation extremes up to 55C/131F degrees.
Aliases None
Required? false
Position? 4
Default value
Aliases Appliance
Required? False
Position? 5
Aliases None
Required? False
Position? named
Default value False
Associate the Logical Enclosure with a new Enclosure Group.
Aliases eg
Required? false
Position? 2
Default value
Logical Enclosure resource from Get-HPOVLogicalEnclosure.
Aliases None
Required? true
Position? 0
Default value
-Name <String>
Specify a new Logical Enclosure name.
Aliases None
Required? false
Position? 1
Default value
-PowerMode <String>
Change the Power Mode of the Logical Enclosure.
Allowed values:
* RedundantPowerFeed - There are at least twice as many power supplies as are necessary (n + n).
* RedundantPowerSupply - There is at least 1 more power supply than is necessary (n + 1).
Aliases None
Required? false
Position? 3
Default value
<CommonParameters>
Input Types
HPOneView.LogicalEnclosure
HPE Syngery Logical Enclosure resource from Get-HPOVLogicalEnclosure.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalEnclosure -Name OriginalName | Set-HPOVLogicalEnclosure -Name NewName
Change the Logical Enclosure name.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalEnclosure -Name OriginalName | Set-HPOVLogicalEnclosure -AmbientTemperatureSetting ASHRAE_A3
Change the Logical Enclosure ambient temperature setting.
Related Links
Top

Set appliancce Login Message.
SYNTAX
Set-HPOVLoginMessage [-Message] <String> [-Acknowledgment] <Boolean> [-ApplianceConnection] <Object> [<CommonPar
ameters>]
Configure the Login Message for the connected appliance(s). You can also set the Acknowledgement to be required.
Parameters
-Acknowledgment <Boolean>
Set to True if the login message should be acknowledged before authentication completes. If set to True, the COnnect-
HPOVMgmt Cmdlet will prompt the user to acknowledge the message, if -LoginAcknowledge is not provided in the Cmdlet
parameters.
Aliases None
Required? true
Position? named
Default value False
Aliases Appliance
Required? true
Position? named
-Message <String>
The login message to set.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVLoginMessage -Message "************************************

>> ***** WARNING ********
>> ************************************
>> Updated Message: This management appliance is a company owned asset and provided for the exclusive use of aut
horized personnel. Unauthorized use or
>> abuse of this system may lead to corrective action including termination, civil and/or criminal penalties."
>> -Acknowledgement $true
Set the Login Message from all connected appliances.

-------------------------- EXAMPLE 2 --------------------------
$Message = "************************************
>> ***** WARNING ********
>> ************************************
>> Updated Message: This management appliance is a company owned asset and provided for the exclusive use of aut
horized personnel. Unauthorized use or
>> abuse of this system may lead to corrective action including termination, civil and/or criminal penalties."
>>
Set-HPOVLoginMessage -Message $Message -Acknowledgment $true
Set the Login Message from the specified appliance connection. ### Related Links * [Get-HPOVLoginMessage]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLoginMessage) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVLoginMessage
Set appliancce Login Message. ### SYNTAX
Set-HPOVLoginMessage [-Message] <String> [-Acknowledgment] <Boolean> [-ApplianceConnection] <Object> [<CommonPar

ameters>]
Configure the Login Message for the connected appliance(s). You can also set the Acknowledgement to be required.
Parameters
-Acknowledgment <Boolean>
Set to True if the login message should be acknowledged before authentication completes. If set to True, the COnnect-
HPOVMgmt Cmdlet will prompt the user to acknowledge the message, if -LoginAcknowledge is not provided in the Cmdlet
parameters.
Aliases None
Required? true
Position? named
Default value False
Aliases Appliance
Required? true
Position? named
-Message <String>
The login message to set.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVLoginMessage -Message '**
* WARNING **
Updated Message: This management appliance is a company owned asset and provided for the
exclusive use of authorized personnel. Unauthorized use or
abuse of this system may lead to corrective action including termination, civil and/or cr
iminal penalties.'
-Acknowledgement $true
Set the Login Message from all connected appliances.
-------------------------- EXAMPLE 2 --------------------------
$Message = '**
* WARNING **
Updated Message: This management appliance is a company owned asset and provided for the
exclusive use of authorized personnel. Unauthorized use or
abuse of this system may lead to corrective action including termination, civil and/or cr
iminal penalties.'
Set-HPOVLoginMessage -Message $Message -Acknowledgment $true
Set the Login Message from the specified appliance connection.
Related Links
Top
Set-HPOVManagedSan

Set-HPOVManagedSan
Enable or Disable Automated SAN Zoning.
SYNTAX
Set-HPOVManagedSan [-InputObject] <Object>[ [-EnableAutomatedZoning] <SwitchParameter>] [-ZoningPolicy] <String>
[ [-EnableAliasing] <SwitchParameter>][ [-InitiatorNameFormat] <String>][ [-TargetGroupNameFormat] <String>][ [-
TargetNameFormat] <String>][ [-ZoneNameFormat] <String>][ [-UpdateZoneNames] <Boolean>][ [-UpdateInitiatorAliase
s] <Boolean>][ [-UpdateTargetAliases] <Boolean>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

[ [-DisableAliasing] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVManagedSan [-InputObject] <Object> [-DisableAutomatedZoning] <SwitchParameter> [-ZoningPolicy] <String>[

This cmdlet is used to Enable or Disable a Managed SAN resource on the appliance. Disabling a Managed SAN will prevent the
appliance from configuring FC Zones.
Parameters
Aliases Appliance
Required? false
Position? named
-DisableAliasing <SwitchParameter>
Disable aliases to be created for initiators, targets and target groups based on the specified name formats
Aliases None
Required? false
Position? named
Default value false
-DisableAutomatedZoning <SwitchParameter>
(DEPRICATED - Please use -ZoningPolicy parameter.) Disable Automated Zoning for the specified Managed SAN.
Aliases ZoningDisable, Disable
Required? true
Position? named
Default value False
-EnableAliasing <SwitchParameter>
Enable aliases to be created for initiators, targets and target groups based on the specified name formats
Aliases None
Required? false
Position? named
Default value False
-EnableAutomatedZoning <SwitchParameter>
(DEPRICATED - Please use -ZoningPolicy parameter.) Enable Automated Zoning for the specified Managed SAN. When used,
the default Zone Policy "SingleInitiatorAllTargets" is set.
Aliases ZoningEnable, Enable
Required? false
Position? named
Default value False
-InitiatorNameFormat <String>
Format to use for initiator alias names. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}.
Example: "initiator_{hostname}_{initiatorName}"
Aliases None
Required? false
Position? named
Default value
Aliases [-Fabric, -Name, -ManagedSan]
Managed SAN Name or Object.
Aliases Fabric, Name, ManagedSan, Resource
Required? true
Position? named
Default value
-TargetGroupNameFormat <String>
Format to use for target group (ex. storage system port group) alias names. The following built-in variables can be used:
{storageSystemName}, {targetGroupName}.
Example: "TargetGroup_{storageSystemName}_{targetGroupName}"
Aliases None
Required? false
Position? named
Default value
-TargetNameFormat <String>
Format to use for target (ex. storage system port) alias names. The following built-in variables can be used:
{storageSystemName}, {targetName}.
Example: "Target_{storageSystemName}_{targetName}"
Aliases None
Required? false
Position? named
Default value
-UpdateInitiatorAliases <Boolean>
Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName},
{initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName}
Example: "{initiatorWwn}_{initiatorName}"
Aliases None
Required? false
Position? named
Default value
-UpdateTargetAliases <Boolean>
Aliases None
Required? false
Position? named
Default value
-UpdateZoneNames <Boolean>
Aliases None
Required? false
Position? named
Default value
-ZoneNameFormat <String>
Aliases None
Required? false
Position? named
Default value

-ZoningPolicy <String>
Policy setting that affects the way that zones are created. Allowed values:
* NoZoning - Disable all automated zoning on the SAN and ignore policy settings related to zoning.
* SingleInitiatorAllTargets - Create one zone per initiator containing all targets connected to that initiator.
* SingleInitiatorSingleStorageSystem - Similar to SingleInitiatorAllTargets except that separate zones are crea
ted for targets that reside on different storage systems.
Aliases None
Required? true
Position? named
Default value SingleInitiatorAllTargets
<CommonParameters>
Input Types
Single Resource
System.Collection.ArrayList <HPOneView.Storage.ManagedSan>
Multiple Resources
Return Values
Single Resource
Multiple Resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVManagedSan Fabric_A -ZoningPolicy SingleInitiatorAllTargets
Enable Automated SAN Zoning for "Fabric_A"

-------------------------- EXAMPLE 2 --------------------------
Set-HPOVManagedSan Fabric_A -ZoningPolicy NoZoning
Disable Automated SAN Zoning for "Fabric_A"

-------------------------- EXAMPLE 3 --------------------------
Get-HPOVManagedSan | Set-HPOVManagedSan -ZoningPolicy SingleInitiatorAllTargets
Enable Automated SAN Zoning for all managed SAN Fabrics ### Related Links * [Get-HPOVManagedSan]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVManagedSan) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVManagedSan
Enable or Disable Automated SAN Zoning. ### SYNTAX

[ [-EnableAliasing] <SwitchParameter>][ [-InitiatorNameFormat] <String>][ [-TargetGroupNameFormat] <String>][ [-
TargetNameFormat] <String>][ [-ZoneNameFormat] <String>][ [-UpdateZoneNames] <Boolean>][ [-UpdateInitiatorAliase
s] <Boolean>][ [-UpdateTargetAliases] <Boolean>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

[ [-DisableAliasing] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVManagedSan [-InputObject] <Object> [-DisableAutomatedZoning] <SwitchParameter> [-ZoningPolicy] <String>[

This cmdlet is used to Enable or Disable a Managed SAN resource on the appliance. Disabling a Managed SAN will prevent the
appliance from configuring FC Zones.
Parameters
Aliases Appliance
Required? false
Position? named
-DisableAliasing <SwitchParameter>
Disable aliases to be created for initiators, targets and target groups based on the specified name formats
Aliases None
Required? false
Position? named
Default value false

-DisableAutomatedZoning <SwitchParameter>
(DEPRICATED - Please use -ZoningPolicy parameter.) Disable Automated Zoning for the specified Managed SAN.
Aliases ZoningDisable, Disable
Required? true
Position? named
Default value False
-EnableAliasing <SwitchParameter>
Enable aliases to be created for initiators, targets and target groups based on the specified name formats
Aliases None
Required? false
Position? named
Default value False
-EnableAutomatedZoning <SwitchParameter>
(DEPRICATED - Please use -ZoningPolicy parameter.) Enable Automated Zoning for the specified Managed SAN. When used,
the default Zone Policy 'SingleInitiatorAllTargets' is set.
Aliases ZoningEnable, Enable
Required? false
Position? named
Default value False
-InitiatorNameFormat <String>
Format to use for initiator alias names. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}.
Example: "initiator_{hostname}_{initiatorName}"
Aliases None
Required? false
Position? named
Default value

Aliases [-Fabric, -Name, -ManagedSan]
Managed SAN Name or Object.
Aliases Fabric, Name, ManagedSan, Resource
Required? true
Position? named
Default value
-TargetGroupNameFormat <String>
Format to use for target group (ex. storage system port group) alias names. The following built-in variables can be used:
{storageSystemName}, {targetGroupName}.
Example: "TargetGroup_{storageSystemName}_{targetGroupName}"
Aliases None
Required? false
Position? named
Default value
-TargetNameFormat <String>
Format to use for target (ex. storage system port) alias names. The following built-in variables can be used:
{storageSystemName}, {targetName}.
Example: "Target_{storageSystemName}_{targetName}"
Aliases None
Required? false
Position? named
Default value
-UpdateInitiatorAliases <Boolean>
Aliases None
Required? false
Position? named
Default value
-UpdateTargetAliases <Boolean>
Aliases None
Required? false
Position? named
Default value
-UpdateZoneNames <Boolean>
Aliases None
Required? false
Position? named
Default value
-ZoneNameFormat <String>
Aliases None
Required? false
Position? named
Default value
-ZoningPolicy <String>
Policy setting that affects the way that zones are created. Allowed values:
* NoZoning - Disable all automated zoning on the SAN and ignore policy settings related to zoning.
* SingleInitiatorAllTargets - Create one zone per initiator containing all targets connected to that initiator.
* SingleInitiatorSingleStorageSystem - Similar to SingleInitiatorAllTargets except that separate zones are crea
ted for targets that reside on different storage systems.
Aliases None
Required? true
Position? named
Default value SingleInitiatorAllTargets
<CommonParameters>
Input Types
Single Resource
System.Collection.ArrayList <HPOneView.Storage.ManagedSan>
Multiple Resources
Return Values
Single Resource
Multiple Resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVManagedSan Fabric_A -ZoningPolicy SingleInitiatorAllTargets
Enable Automated SAN Zoning for 'Fabric_A'
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVManagedSan Fabric_A -ZoningPolicy NoZoning
Disable Automated SAN Zoning for 'Fabric_A'
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVManagedSan | Set-HPOVManagedSan -ZoningPolicy SingleInitiatorAllTargets
Enable Automated SAN Zoning for all managed SAN Fabrics

Related Links
Get-HPOVManagedSan
Top
Set-HPOVNetwork

Set-HPOVNetwork
Modify an existing network.
SYNTAX
Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-Purpose]
<String>][ [-Smartlink] <Boolean>][ [-PrivateNetwork] <Boolean>][ [-TypicalBandwidth] <Int32>][ [-MaximumBandwid
th] <Int32>][ [-IPv4Subnet] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-TypicalB
andwidth] <Int32>][ [-MaximumBandwidth] <Int32>][ [-LinkStabilityTime] <Int32>][ [-AutoLoginRedistribution] <Boo
lean>][ [-ManagedSan] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Modify a network and it"s attributes information. Use this cmdlet to change the Network Name, Purpose, Enable or Disable
Smartlink, Enable or Disable Private Network, and adjust the allocated bandwidth.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases [-ald] Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an
uplink that was down becomes available). Parameter is only supported with FibreChannel network resources.
initiated manually.
Aliases ald
Required? false
Position? named
Default value
Associate with IPv4Subnet.
Aliases None
Required? false
Position? named
Default value
Aliases [-net, -Network] The Name or Resource object of the network to be modified.
Aliases net, Network
Required? true
Position? named
Default value
Aliases [-lst] The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login
redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline
repeatedly). Parameter is only supported with FibreChannel network resources.
Minimum Value: 1 Maximum Value: 1800
Aliases lst
Required? false
Position? named
Default value 0
Managed SAN Name or URI.
Aliases None
Required? false
Position? named
Default value
The maximum bandwidth of a network connection, that will be allowed and reflected witin the Server Profile Connection,
expressed in Mbps. In Flex10 adapters, the maximum supported Ethernet bandwidth is 10 Gbps. With 10Gb FlexFabric
adapters, the maximum FCoE bandwidth is 8Gbps. With FlexFabric 20Gb adapters, the maximum Ethernet bandwidth is
20Gbps.
Aliases None
Required? false
Position? named
Default value 0
-Name <String>
The network resource"s new Name value.
Aliases None
Required? false
Position? named
Default value
-Prefix <String>
Use this parameter to add a new prefix to the name. Will not change the original name value, simply add the prefix to the orignal
name. Use the -Name parameter to adjust the entire name.
Aliases None
Required? false
Position? named
Default value
Enable or Disable Private Network within the Ethernet Network.

Aliases None
Required? false
Position? named
Default value
-Purpose <String>
A description of the network"s role within the logical interconnect. Accepted values in string format are:
* General
* Management
* VMMigration
* FaultTolerance
Aliases None
Required? false
Position? named
Default value
-Smartlink <Boolean>
Enable or Disable Smartlink within the Ethernet Network.
Aliases None
Required? false
Position? named
Default value
-Suffix <String>
Use this parameter to add a new suffix to the name. Will not change the original name value, simply add the suffix to the orignal
Aliases None
Required? false
Position? named
Default value
Preferred amount of bandwidth to assign within the Server Profile Connection, specified in Mbps.
Aliases None
Required? false
Position? named
Default value 0
<CommonParameters>
Input Types
HPOneView.Networking.EthernetNetwork [System.Management.Automation.PSCustomObject]
Ethernet Network resource object
HPOneView.Networking.FCNetwork [System.Management.Automation.PSCustomObject]
FC Network resource object
HPOneView.Networking.FCoENetwork [System.Management.Automation.PSCustomObject]
FCoE Network resource object
Return Values
The Update Network Resource Task object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVNetwork "Net-11" | Set-HPOVNetwork -name NewNet-11 -Purpose Management -SmartLink $true -PrivateNetwork
$false -TypicalBandwidth 500 -MaximumBandwidth 1500 | Wait-HPOVTaskComplete
Get the "Net-11" Ethernet Network, pipe it to Set-HPOVNetwork to update values.

-------------------------- EXAMPLE 2 --------------------------
$fabricAManagedSan = Get-HPOVManagedSan -Name "Fabric A"

Get-HPOVNetwork "Prod Fabric A" | Set-HPOVNetwork -ManagedSan $fabricAManagedSan | Wait-HPOVTaskComplete
Update "Prod Fabric A" FC Network with "Fabric a" Managed SAN resource.
-------------------------- EXAMPLE 3 --------------------------
$NewSuffix = "-prod A"

Get-HPOVNetwork -type Ethernet | Set-HPOVNetwork -Suffix $NewSuffix
Get all Ethernet networks, and add a Suffix to their names. ### Related Links * [Get-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVNetworkSet) * [New-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetwork) * [New-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetworkSet) * [Remove-HPOVNetwork]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetwork) * [Remove-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetworkSet) * [Set-HPOVNetworkSet]
Top
### HPE OneView 4.00 Library ## Set-HPOVNetwork
Modify an existing network. ### SYNTAX
Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-Purpose]
<String>][ [-Smartlink] <Boolean>][ [-PrivateNetwork] <Boolean>][ [-TypicalBandwidth] <Int32>][ [-MaximumBandwid
th] <Int32>][ [-IPv4Subnet] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-TypicalB
andwidth] <Int32>][ [-MaximumBandwidth] <Int32>][ [-LinkStabilityTime] <Int32>][ [-AutoLoginRedistribution] <Boo
lean>][ [-ManagedSan] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Modify a network and it's attributes information. Use this cmdlet to change the Network Name, Purpose, Enable or Disable
Smartlink, Enable or Disable Private Network, and adjust the allocated bandwidth.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases [-ald] Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an
uplink that was down becomes available). Parameter is only supported with FibreChannel network resources.
initiated manually.
Aliases ald
Required? false
Position? named
Default value

Associate with IPv4Subnet.
Aliases None
Required? false
Position? named
Default value
Aliases [-net, -Network] The Name or Resource object of the network to be modified.
Aliases net, Network
Required? true
Position? named
Default value
Aliases [-lst] The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login
redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline
repeatedly). Parameter is only supported with FibreChannel network resources.
Minimum Value: 1 Maximum Value: 1800
Aliases lst
Required? false
Position? named
Default value 0
Managed SAN Name or URI.
Aliases None
Required? false
Position? named
Default value
The maximum bandwidth of a network connection, that will be allowed and reflected witin the Server Profile Connection,
expressed in Mbps. In Flex10 adapters, the maximum supported Ethernet bandwidth is 10 Gbps. With 10Gb FlexFabric
adapters, the maximum FCoE bandwidth is 8Gbps. With FlexFabric 20Gb adapters, the maximum Ethernet bandwidth is
20Gbps.
Aliases None
Required? false
Position? named
Default value 0
-Name <String>
The network resource's new Name value.
Aliases None
Required? false
Position? named
Default value
-Prefix <String>
Use this parameter to add a new prefix to the name. Will not change the original name value, simply add the prefix to the orignal
Aliases None
Required? false
Position? named
Default value
Enable or Disable Private Network within the Ethernet Network.
Aliases None
Required? false
Position? named
Default value
-Purpose <String>
A description of the network's role within the logical interconnect. Accepted values in string format are:
* General
* Management
* VMMigration
* FaultTolerance
Aliases None
Required? false
Position? named
Default value
-Smartlink <Boolean>
Enable or Disable Smartlink within the Ethernet Network.
Aliases None
Required? false
Position? named
Default value
-Suffix <String>
Use this parameter to add a new suffix to the name. Will not change the original name value, simply add the suffix to the orignal
Aliases None
Required? false
Position? named
Default value
Preferred amount of bandwidth to assign within the Server Profile Connection, specified in Mbps.
Aliases None
Required? false
Position? named
Default value 0
<CommonParameters>
Input Types
HPOneView.Networking.EthernetNetwork [System.Management.Automation.PSCustomObject]
Ethernet Network resource object
HPOneView.Networking.FCNetwork [System.Management.Automation.PSCustomObject]
FC Network resource object
HPOneView.Networking.FCoENetwork [System.Management.Automation.PSCustomObject]
FCoE Network resource object
Return Values
The Update Network Resource Task object
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVNetwork "Net-11" | Set-HPOVNetwork -name NewNet-11 -Purpose Management -SmartLink $true -PrivateNetwork
$false -TypicalBandwidth 500 -MaximumBandwidth 1500 | Wait-HPOVTaskComplete
Get the 'Net-11' Ethernet Network, pipe it to Set-HPOVNetwork to update values.
-------------------------- EXAMPLE 2 --------------------------
$fabricAManagedSan = Get-HPOVManagedSan -Name "Fabric A"

Get-HPOVNetwork "Prod Fabric A" | Set-HPOVNetwork -ManagedSan $fabricAManagedSan | Wait-HPOVTaskComplete
Update 'Prod Fabric A' FC Network with 'Fabric a' Managed SAN resource.
-------------------------- EXAMPLE 3 --------------------------
$NewSuffix = "-prod A"

Get-HPOVNetwork -type Ethernet | Set-HPOVNetwork -Suffix $NewSuffix
Get all Ethernet networks, and add a Suffix to their names.
Related Links
Get-HPOVNetwork
Get-HPOVNetworkSet
New-HPOVNetwork
New-HPOVNetworkSet
Remove-HPOVNetwork
Set-HPOVNetworkSet
Top
Set-HPOVNetworkSet

Set-HPOVNetworkSet
Modify an existing network set.
SYNTAX
Set-HPOVNetworkSet [-NetworkSet] <Object> [-Name] <String> [-Networks] <Object> [-UntaggedNetwork] <Object> [-Ty
picalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]
Modify a network set and/or its connection information.
Parameters
Aliases Appliance
Required? true
Position? 6
The updated MAximum bandwidth, in Mbps.
Aliases None
Required? true
Position? 5
Default value 0
-Name <String>
The updated name value of the Network Set.
Aliases None
Required? true
Position? 1
Default value
Aliases [-netSet] The Network Set resource object or name to be modified.
Aliases NetSet
Required? true
Position? 0
Default value
-Networks <Object>
An array containing the updated list of networks. May contain Network Names or URI"s.
Aliases None
Required? true
Position? 2
Default value
The updated Typical or Preferred bandwidth, in Mbps.
Aliases None
Required? true
Position? 4
Default value 0
Aliases [-untagged, -native, -untaggedNetworkUri] The Name or URI of the Untaggged, or Native Network for the Network Set.

Required? true
Position? 3
Default value
<CommonParameters>
Input Types
Single Network Set resource
Return Values
Update Network Set resource task
Examples
-------------------------- EXAMPLE 1 --------------------------
$netset = Get-HPOVNetworkSet "Set-1"

$netset.maximumBandwidth = 5000
$netset.typicalBandwidth = 3000
Set-HPOVNetworkSet $netset
Modify "Set-1" to be maximum bandwidth of 5000.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVNetworkSet NetSet-1 | Set-HPOVNetworkSet -name NewNetSet-1 -networks @(bluenet,rednet,greennet) -untagge

d bluenet
Update "NetSet-1" with a new name, adjust the networks, and set "bluenet" as the Untagged Network. ### Related Links * [Get-
HPOVNetworkSet](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVNetworkSet) * [New-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVNetworkSet) * [Remove-HPOVNetworkSet]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVNetworkSet) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVNetworkSet
Modify an existing network set. ### SYNTAX
Set-HPOVNetworkSet [-NetworkSet] <Object> [-Name] <String> [-Networks] <Object> [-UntaggedNetwork] <Object> [-Ty
picalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]
Modify a network set and/or its connection information.
Parameters
Aliases Appliance
Required? true
Position? 6
The updated MAximum bandwidth, in Mbps.
Aliases None
Required? true
Position? 5
Default value 0
-Name <String>
The updated name value of the Network Set.
Aliases None
Required? true
Position? 1
Default value
Aliases [-netSet] The Network Set resource object or name to be modified.
Aliases NetSet
Required? true
Position? 0
Default value
-Networks <Object>
An array containing the updated list of networks. May contain Network Names or URI's.
Aliases None
Required? true
Position? 2
Default value
The updated Typical or Preferred bandwidth, in Mbps.
Aliases None
Required? true
Position? 4
Default value 0
Aliases [-untagged, -native, -untaggedNetworkUri] The Name or URI of the Untaggged, or Native Network for the Network Set.
Required? true
Position? 3
Default value
<CommonParameters>
Input Types
Single Network Set resource
Return Values
Update Network Set resource task
Examples
-------------------------- EXAMPLE 1 --------------------------
$netset = Get-HPOVNetworkSet "Set-1"

$netset.maximumBandwidth = 5000
$netset.typicalBandwidth = 3000
Set-HPOVNetworkSet $netset
Modify "Set-1" to be maximum bandwidth of 5000.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVNetworkSet NetSet-1 | Set-HPOVNetworkSet -name NewNetSet-1 -networks @(bluenet,rednet,greennet) -untagge

d bluenet
Update 'NetSet-1' with a new name, adjust the networks, and set 'bluenet' as the Untagged Network.
Related Links
Get-HPOVNetworkSet
New-HPOVNetworkSet
Top

Modify an existing rack member U location.
SYNTAX
Set-HPOVRackMemberLocation [-InputObject] <HPOneView.Facilities.RackMember> [-ULocation] <Int>[ [-ApplianceConne
This Cmdlet will modify an existing rack member U Location within the rack it is located.
Parameters
Aliases Appliance
Required? false
Position? named
-InputObject <HPOneView.Facilities.RackMember>
The rack member to modify from Get-HPOVRackMember.
Aliases None
Required? true
Position? named
Default value
-ULocation <Int>
The new Rack Unit location where the resource is located.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Modified rack member object with the updated Rack Unit location.
Examples
-------------------------- EXAMPLE 1 --------------------------
$RackMember = Get-HPOVRack -Name "Rack-221" -ErrorAction Stop | Get-HPOVRackMember -Name "DL380 1" -ErrorAction
Stop
Set-HPOVRackMemberLocation -InputObject $RackMember -ULocation ($RackMember.ULocation + 5)
Update the "DL380 1" rack member raising its current rack unit location by 5. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVRackMemberLocation
Modify an existing rack member U location. ### SYNTAX
Set-HPOVRackMemberLocation [-InputObject] <HPOneView.Facilities.RackMember> [-ULocation] <Int>[ [-ApplianceConne

This Cmdlet will modify an existing rack member U Location within the rack it is located.
Parameters
Aliases Appliance
Required? false
Position? named
-InputObject <HPOneView.Facilities.RackMember>
The rack member to modify from Get-HPOVRackMember.
Aliases None
Required? true
Position? named
Default value
-ULocation <Int>
The new Rack Unit location where the resource is located.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Modified rack member object with the updated Rack Unit location.
Examples
-------------------------- EXAMPLE 1 --------------------------
$RackMember = Get-HPOVRack -Name 'Rack-221' -ErrorAction Stop | Get-HPOVRackMember -Name 'DL380 1' -ErrorAction
Stop
Set-HPOVRackMemberLocation -InputObject $RackMember -ULocation ($RackMember.ULocation + 5)
Update the 'DL380 1' rack member raising its current rack unit location by 5.
Related Links
Top

Configure Remote Support and authorize appliance.
SYNTAX
Set-HPOVRemoteSupport [-CompanyName] <String>[ [-OptimizeOptIn] <SwitchParameter>][ [-AutoEnableDevices] <bool>]
[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVRemoteSupport [-CompanyName] <String> [-InsighOnlineUsername] <String> [-InsightOnlinePassword] <SecureS

tring>[ [-OptimizeOptIn] <SwitchParameter>][ [-AutoEnableDevices] <bool>][ [-Async] <SwitchParameter>] [-Applian
ceConnection] <Object> [<CommonParameters>]
Set-HPOVRemoteSupport [-Enable] <SwitchParameter>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [

<CommonParameters>]
Set-HPOVRemoteSupport [-Disable] <SwitchParameter>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>

support.
Once the appliance is configured, it cannot be unauthorized or disabled.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? False
Position? named
Default value False
-AutoEnableDevices <bool>
Choose to allow the appliance to auto enable remote support for all and devices added in the future.
Aliases None
Required? false
Position? named
Default value
-CompanyName <String>
The company name Remote Support will be authorized for.
Aliases None
Required? true
Position? named
Default value
-Disable <SwitchParameter>
Use this parameter to disable remote support globally on the appliance. Use the -Enable parameter to re-enable Remote
Support.
Aliases None
Required? true
Position? named
Default value
-Enable <SwitchParameter>
Use this parameter to enable remote support on an appliance, only if the appliance was previously configured for Remote
Support and it was disabled.
Aliases None
Required? true
Position? named
Default value
-InsighOnlineUsername <String>
The user name of your Insight Online account.
Aliases None
Required? true
Position? named
Default value
-InsightOnlinePassword <SecureString>
The Insight Online account password.
Aliases None
Required? true
Position? named
Default value

-OptimizeOptIn <SwitchParameter>
Opt-in to allow HPE marketing to discuss datacenter optimization.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.RemoteSupportConfig [System.Management.Automation.PSCustomObject]
The appliance Remote Support configuration applied.
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSupport -CompanyName MyCompany
Configure and register the applinace for Remote Support.

-------------------------- EXAMPLE 2 --------------------------
Set-HPOVRemoteSupport -CompanyName MyCompany -InsightOnlineUsername mypassport@domain.local -InsightOnlinePasswo

rd (ConvertTo-SecureString -String MyPassword -AsPlainText -Force)
Configure and register the applinace for Remote Support, and enable Insight Online portal registration.
-------------------------- EXAMPLE 3 --------------------------
Set-HPOVRemoteSupport -Disable
Disable Remote Support on the appliance.

-------------------------- EXAMPLE 4 --------------------------
Set-HPOVRemoteSupport -Enable -ApplianceConnection $Appliance2
Enable Remote Support after it was previously disabled for the specific appliance. ### Related Links * [Disable-
HPOVRemoteSupport](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVRemoteSupport) * [Enable-
HPOVRemoteSupport](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVRemoteSupport) * [Get-
HPOVRemoteSupport](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupport) * [Get-
HPOVRemoteSupportContact](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportContact) *
[Get-HPOVRemoteSupportDataCollectionSchedule](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVRemoteSupportPartner) * [Set-
Top
### HPE OneView 4.00 Library ## Set-HPOVRemoteSupport
Configure Remote Support and authorize appliance. ### SYNTAX
Set-HPOVRemoteSupport [-CompanyName] <String>[ [-OptimizeOptIn] <SwitchParameter>] [-ApplianceConnection] <Objec

t> [<CommonParameters>]
Set-HPOVRemoteSupport [-CompanyName] <String> [-InsighOnlineUsername] <String> [-InsightOnlinePassword] <SecureS

tring>[ [-OptimizeOptIn] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVRemoteSupport [-Enable] <SwitchParameter> [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVRemoteSupport [-Disable] <SwitchParameter> [-ApplianceConnection] <Object> [<CommonParameters>]
support.
Once the appliance is configured, it cannot be unauthorized or disabled.
Parameters
Aliases Appliance
Required? true
Position? named
-CompanyName <String>
The company name Remote Support will be authorized for.
Aliases None
Required? true
Position? named
Default value
Use this parameter to disable remote support globally on the appliance. Use the -Enable parameter to re-enable Remote
Support.
Aliases None
Required? true
Position? named
Default value
Use this parameter to enable remote support on an appliance, only if the appliance was previously configured for Remote
Support and it was disabled.
Aliases None
Required? true
Position? named
Default value
-InsighOnlineUsername <String>
The user name of your Insight Online account.

Aliases None
Required? true
Position? named
Default value
-InsightOnlinePassword <SecureString>
The Insight Online account password.
Aliases None
Required? true
Position? named
Default value
-OptimizeOptIn <SwitchParameter>
Opt-in to allow HPE marketing to discuss datacenter optimization.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.RemoteSupportConfig [System.Management.Automation.PSCustomObject]
The appliance Remote Support configuration applied.
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSupport -CompanyName MyCompany
Configure and register the applinace for Remote Support.

-------------------------- EXAMPLE 2 --------------------------
Set-HPOVRemoteSupport -CompanyName MyCompany -InsightOnlineUsername mypassport@domain.local -InsightOnlinePasswo

rd (ConvertTo-SecureString -String MyPassword -AsPlainText -Force)
Configure and register the applinace for Remote Support, and enable Insight Online portal registration.
-------------------------- EXAMPLE 3 --------------------------
Set-HPOVRemoteSupport -Disable
Disable Remote Support on the appliance.
-------------------------- EXAMPLE 4 --------------------------
Set-HPOVRemoteSupport -Enable -ApplianceConnection $Appliance2
Enable Remote Support after it was previously disabled for the specific appliance.
Related Links
Top
Modify Remote Support Schedule settings on an appliance.
SYNTAX
Set-HPOVRemoteSupportDataCollectionSchedule [-DateTime] <DateTime>[ [-Type] <String>][ [-Async] <SwitchParameter
Use this Cmdlet to set a new schedule to collect Remote Support logs. There are two defined schedules: Active Health
scheduled on a weekly basis, and Server Basic Configuration scheduled on a monthly basis. Either scheduled collection task
can be modified, to set the Day of Week, Day of Month, Hour and Minute. When supplying a DateTime value, the Day will be
converted to the Day of Month, and Day of the Week respectively. For instance, if "Oct 30, 2016 13:00" is provided, Day of
Month will be every "30th" day, and Day of Week will be every "Sunday" (which Oct 30th 2016 is a Sunday). To schedule
different Day of the Month and Day of the Week, use the -Type paramter to specify AHS or Basic. The -DateTime paramter
value will only be applied to that schedule.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False

-DateTime <DateTime>
Specify a DateTime value for the schedule to execute. AHS schedule is executed on a weekly basis, and Server Basic
Configuration is executed on a monthly basis. When needing to configure a schedule for AHS log collection, the Month Day"s
week day name will be used. For instance, if "Oct 30, 2016" is provided and scheduling for AHS log collection, the task will
execute every Sunday, which October 30th 2016 is on a Sunday. When providing the hour of the day to execute, the value must
be in 24hr time.
Aliases None
Required? true
Position? named
Default value
-Type <String>
* AHS
*Basic
If no value is provided, both schedules will be modified.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSupportDataCollectionSchedule -DateTime "11/01/2016 20:00"
Set a new Remote Support schedule for November 11, 2016, which is a Monday, at 20:00 (8:00pm).
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVRemoteSupportDataCollectionSchedule -Type AHS -DateTime "11/01/2016 20:00"
Set a new schedule to collect AHS logs every Monday of every week, at 20:00 (8:00pm). ### Related Links * [Get-
HPOVRemoteSupportDataCollectionSchedule) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVRemoteSupportDataCollectionSchedule
Modify Remote Support Schedule settings on an appliance. ### SYNTAX
Set-HPOVRemoteSupportDataCollectionSchedule [-DateTime] <DateTime>[ [-Type] <String>][ [-Async] <SwitchParameter

Use this Cmdlet to set a new schedule to collect Remote Support logs. There are two defined schedules: Active Health
scheduled on a weekly basis, and Server Basic Configuration scheduled on a monthly basis. Either scheduled collection task
can be modified, to set the Day of Week, Day of Month, Hour and Minute. When supplying a DateTime value, the Day will be
converted to the Day of Month, and Day of the Week respectively. For instance, if "Oct 30, 2016 13:00" is provided, Day of
Month will be every "30th" day, and Day of Week will be every "Sunday" (which Oct 30th 2016 is a Sunday). To schedule
different Day of the Month and Day of the Week, use the -Type paramter to specify AHS or Basic. The -DateTime paramter
value will only be applied to that schedule.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value False
-DateTime <DateTime>
Specify a DateTime value for the schedule to execute. AHS schedule is executed on a weekly basis, and Server Basic
Configuration is executed on a monthly basis. When needing to configure a schedule for AHS log collection, the Month Day's
week day name will be used. For instance, if "Oct 30, 2016" is provided and scheduling for AHS log collection, the task will
execute every Sunday, which October 30th 2016 is on a Sunday. When providing the hour of the day to execute, the value must
be in 24hr time.
Aliases None
Required? true
Position? named
Default value
-Type <String>
* AHS
*Basic
If no value is provided, both schedules will be modified.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSupportDataCollectionSchedule -DateTime "11/01/2016 20:00"
Set a new Remote Support schedule for November 11, 2016, which is a Monday, at 20:00 (8:00pm).
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVRemoteSupportDataCollectionSchedule -Type AHS -DateTime "11/01/2016 20:00"
Set a new schedule to collect AHS logs every Monday of every week, at 20:00 (8:00pm).
Related Links
Top

Define the Remote Support Default Site.
SYNTAX
Set-HPOVRemoteSupportDefaultSite [-AddressLine1] <String> [-City] <String> [-State] <String> [-Country] <String>
[-TimeZone] <String> [-AddressLine2] <String>[ [-PostalCode] <String>][ [-ApplianceConnection] <Object>] [<Commo
nParameters>]
Use this Cmdlet to set the default data center site used for Remote Support. All resources defined will use this data center site.
Parameters
-AddressLine1 <String>
Aliases [-a1] Primary Address line 1.
Aliases a1
Required? true
Position? named
Default value
Aliases a2
Required? true
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-City <String>
City.
Aliases None
Required? true
Position? named
Default value
-Country <String>
2-letter country code.
Aliases None
Required? true
Position? named
Default value
-PostalCode <String>
Postal or zip code.
Aliases None
Required? false
Position? named
Default value
-State <String>
Aliases [-Provence] State or Provence.
Aliases Province
Required? true
Position? named
Default value
-TimeZone <String>
Timezone of the data center, in ISO-3166 location format (e.g. US/Central).
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSupportDefaultSite -AddressLine1 "3000 Hanover St." -City "Palo Alto" -State CA -PostalCode 94304
-Country US -TimeZone "US/Pacific"
Get the configured Remote Support default site. ### Related Links * [Get-HPOVRemoteSupportDefaultSite]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteSupportDefaultSite) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVRemoteSupportDefaultSite
Define the Remote Support Default Site. ### SYNTAX
Set-HPOVRemoteSupportDefaultSite [-AddressLine1] <String> [-City] <String> [-State] <String> [-Country] <String>

[-TimeZone] <String> [-AddressLine2] <String>[ [-PostalCode] <String>][ [-ApplianceConnection] <Object>] [<Commo
nParameters>]
Use this Cmdlet to set the default data center site used for Remote Support. All resources defined will use this data center site.
Parameters
Aliases a1
Required? true
Position? named
Default value
Aliases a2
Required? true
Position? named
Default value
Aliases Appliance
Required? false
Position? named
-City <String>
City.
Aliases None
Required? true
Position? named
Default value
-Country <String>
2-letter country code.
Aliases None
Required? true
Position? named
Default value
-PostalCode <String>
Postal or zip code.
Aliases None
Required? false
Position? named
Default value
-State <String>
Aliases [-Provence] State or Provence.
Aliases Province
Required? true
Position? named
Default value
-TimeZone <String>
Timezone of the data center, in ISO-3166 location format (e.g. US/Central).
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSupportDefaultSite -AddressLine1 "3000 Hanover St." -City "Palo Alto" -State CA -PostalCode 94304
-Country US -TimeZone "US/Pacific"
Get the configured Remote Support default site.
Related Links
Top

Configure supported resource Remote Support settings.
SYNTAX
Set-HPOVRemoteSupportSetting [-InputObject] <Object> [-PrimaryContact] <Object>[ [-SecondaryContact] <Object>][
[-ServicePartner] <Object>][ [-Reseller] <Object>][ [-ContractType] <String>][ [-SupportID] <String>][ [-NewSeri
alNumber] <String>][ [-NewProductNumber] <String>][ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>
Use this Cmdlet to configure a supported resources Remote Support collection settings.
Parameters
Aliases Appliance
Required? false
Position? 9
Aliases None
Required? false
Position? named
Default value False
-ContractType <String>
Use to override the contract type. If specifying a different contract type, you must supply the SupportID. Allowed values are:
* SupportAgreement
* PackagedSupport.
Aliases None
Required? false
Position? 5
Default value
Aliases None
Required? true
Position? 0
Default value
-NewProductNumber <String>
Use to update the HPE support backend with an updated product number
Aliases None
Required? false
Position? 8
Default value
-NewSerialNumber <String>
Use to update the HPE support backend with an updated serial number.
Aliases None
Required? false
Position? 7
Default value
Primary Remote Support Contact user object.
Aliases None
Required? true
Position? 1
Default value
-Reseller <Object>
Authorized HPE reseller partner object from Get-HPOVRemoteSupportPartner.
Aliases None
Required? false
Position? 4
Default value

Secondary Remote Support Contact user object.
Aliases None
Required? false
Position? 2
Default value
-ServicePartner <Object>
Authorized HPE service partner object from Get-HPOVRemoteSupportPartner.
Aliases None
Required? false
Position? 3
Default value
-SupportID <String>
The support Contract ID. You must specify the type of contract by using the -ContractType parameter.
Aliases None
Required? false
Position? 6
Default value
<CommonParameters>
Input Types
Return Values

Examples
-------------------------- EXAMPLE 1 --------------------------
$NewReseller = Get-HPOVRemoteSupportContact -Name "New Reseller Name"

Get-HPOVEnclosure -Name Encl1 | Set-HPOVRemoteSupportSetting -Reseller $NewReseller
Update "Encl1" with a new reseller contact that was added to the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer -Name Prd-host-* | Set-HPOVRemoteSupportSetting -ContractType SupportAgreement -SupportID 1111999

90
Update the servers with a new support agreement.

-------------------------- EXAMPLE 3 --------------------------
PrimaryContact = Get-HPOVRemoteSupportContact -Name "Gladi Chua"

$SecondaryContact = Get-HPOVRemoteSupportContact -Name "Luke Smith"
Get-HPOVEnclosure -Name Prod* | Set-HPOVRemoteSupportSetting -PrimaryContact $PrimaryContact -SecondaryContact $
SecondaryContact -Async -OutVariable Tasks
Update the Enclosures with new primary and secondary contacts, returning async tasks to monitor using the OutVariable
Common Parameter. ### Related Links * [Get-HPOVRemoteSupportSetting](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVRemoteSupportSetting) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVRemoteSupportSetting
Configure supported resource Remote Support settings. ### SYNTAX
Set-HPOVRemoteSupportSetting [-InputObject] <Object> [-PrimaryContact] <Object>[ [-SecondaryContact] <Object>][

[-ServicePartner] <Object>][ [-Reseller] <Object>][ [-ContractType] <String>][ [-SupportID] <String>][ [-NewSeri
alNumber] <String>][ [-NewProductNumber] <String>][ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>
Use this Cmdlet to configure a supported resources Remote Support collection settings.
Parameters
Aliases Appliance
Required? false
Position? 9
Aliases None
Required? false
Position? named
Default value False
-ContractType <String>
Use to override the contract type. If specifying a different contract type, you must supply the SupportID. Allowed values are:
* SupportAgreement
* PackagedSupport.
Aliases None
Required? false
Position? 5
Default value
Aliases None
Required? true
Position? 0
Default value
-NewProductNumber <String>
Use to update the HPE support backend with an updated product number
Aliases None
Required? false
Position? 8
Default value
-NewSerialNumber <String>
Use to update the HPE support backend with an updated serial number.
Aliases None
Required? false
Position? 7
Default value
Primary Remote Support Contact user object.
Aliases None
Required? true
Position? 1
Default value
-Reseller <Object>
Authorized HPE reseller partner object from Get-HPOVRemoteSupportPartner.
Aliases None
Required? false
Position? 4
Default value
Secondary Remote Support Contact user object.
Aliases None
Required? false
Position? 2
Default value
-ServicePartner <Object>
Authorized HPE service partner object from Get-HPOVRemoteSupportPartner.
Aliases None
Required? false
Position? 3
Default value
-SupportID <String>
The support Contract ID. You must specify the type of contract by using the -ContractType parameter.
Aliases None
Required? false
Position? 6
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$NewReseller = Get-HPOVRemoteSupportContact -Name 'New Reseller Name'

Get-HPOVEnclosure -Name Encl1 | Set-HPOVRemoteSupportSetting -Reseller $NewReseller
Update 'Encl1' with a new reseller contact that was added to the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer -Name Prd-host-* | Set-HPOVRemoteSupportSetting -ContractType SupportAgreement -SupportID 1111999

90
Update the servers with a new support agreement.

-------------------------- EXAMPLE 3 --------------------------
PrimaryContact = Get-HPOVRemoteSupportContact -Name 'Gladi Chua'

$SecondaryContact = Get-HPOVRemoteSupportContact -Name 'Luke Smith'
Get-HPOVEnclosure -Name Prod* | Set-HPOVRemoteSupportSetting -PrimaryContact $PrimaryContact -SecondaryContact $
SecondaryContact -Async -OutVariable Tasks
Update the Enclosures with new primary and secondary contacts, returning async tasks to monitor using the OutVariable
Common Parameter.
Related Links
Top

Configure remote syslog.
SYNTAX
Set-HPOVRemoteSyslog [-Destination] <IPAddress> [-Port] <Int32>[ [-SendTestMessage] <SwitchParameter>][ [-Async]
setting or updating the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView
appliance will deploy the SysLog settings to managed resources automatically.
Parameters
Aliases Appliance
Required? false
Position? named

Aliases None
Required? false
Position? named
Default value False
-Destination <IPAddress>
Destination IPv4 Address of the Remote SysLog.
Aliases None
Required? true
Position? named
Default value
-Port <Int32>
The destination TCP port.
Default value: 514
Aliases None
Required? true
Position? named
Default value 514
-SendTestMessage <SwitchParameter>
Use to generate a syslog test message after the managed endpoint has finished configuring.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
If successful, returns Appliance Async Task object to monitor
Collection of Appliance Async Task objects to monitor
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSyslog -Destination 10.150.20.1 -SendTestMessage -Async | Wait-HPOVTaskComplete
Set the remote syslog to the provided destination, using the default destination TCP port, and send a test message for all
connected appliances. ### Related Links * [Disable-HPOVRemoteSyslog](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Disable-HPOVRemoteSyslog) * [Enable-HPOVRemoteSyslog](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Enable-HPOVRemoteSyslog) * [Get-HPOVRemoteSyslog](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVRemoteSyslog) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVRemoteSyslog
Configure remote syslog. ### SYNTAX
Set-HPOVRemoteSyslog [-Destination] <IPAddress> [-Port] <Int32>[ [-SendTestMessage] <SwitchParameter>][ [-Async]

setting or updating the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView
appliance will deploy the SysLog settings to managed resources automatically.
Parameters
Aliases Appliance
Required? false
Position? named

Aliases None
Required? false
Position? named
Default value False
-Destination <IPAddress>
Destination IPv4 Address of the Remote SysLog.
Aliases None
Required? true
Position? named
Default value
-Port <Int32>
The destination TCP port.
Default value: 514
Aliases None
Required? true
Position? named
Default value 514
-SendTestMessage <SwitchParameter>
Use to generate a syslog test message after the managed endpoint has finished configuring.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
If successful, returns Appliance Async Task object to monitor
Collection of Appliance Async Task objects to monitor
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVRemoteSyslog -Destination 10.150.20.1 -SendTestMessage -Async | Wait-HPOVTaskComplete
Set the remote syslog to the provided destination, using the default destination TCP port, and send a test message for all
connected appliances.
Related Links
Top

Modify the reserved VLAN range for HPE Synergy.
SYNTAX
Set-HPOVReservedVlanRange [-Start] <int> [-Length] <int>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
By default, HPE Synergy reserves VLANs 3967-4095. In order to modify the default range, Tunnel, untagged and FC networks
must not exist. The -Length parameter must not exceed 128. The reserved VLAN range is concurrent.
Required permissions: Network administrator, Infrastructure administrator
Parameters
Aliases Appliance
Required? False
Position? named
-Length <int>
Must not exceed 128.
Aliases None
Required? True
Position? named
Default value
-Start <int>
The starting VLAN ID.
Aliases None
Required? True
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVReservedVlanRange -Start 2700 -Length 128
Change the reserved VLAN range to start at 2700, and end at 2828.
Related Links
Top
Set-HPOVResource

Set-HPOVResource
Update existing resource(s).
SYNTAX
Set-HPOVResource [-InputObject] <Object> [-ApplianceConnection] <Object> [-Force] <String> [<CommonParameters>]
This CMDLET will assist the user to update an existing resource. The resource should first be retrieved with a "Get-
HPOV[resourcename]" CMDLET. The PowerShell resource may then be modified, followed by this "Set-HPOVResource" cmdlet.
Parameters
Aliases Appliance
Required? true
Position? 1
-Force <String>
Set to $true to force-update the resource. Not all resources support force-update.
Aliases None
Required? true
Position? named
Default value False
The modified resource that is to be updated. Can be resource object, name or URI.
Aliases Resource
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Resource Object to modify by either using Send-HPOVRequest with the resource URI, or the resource GET CMDLET
Return Values
The modified resource or async task depending on the resource being modified
Examples
-------------------------- EXAMPLE 1 --------------------------
$profile = Get-HPOVServerProfile "Profile 1"

$profile.name = "New Name"
Set-HPOVResource $profile
Updates the name of the Server Profile resource. ### Related Links * [Add-HPOVResourceToLabel]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVResourceToScope) * [New-HPOVResource]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVResource) * [Remove-HPOVResource]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVResource) * [Remove-HPOVResourceFromLabel]
HPOVResourceFromScope](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVResourceFromScope) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVResource
Update existing resource(s). ### SYNTAX
Set-HPOVResource [-InputObject] <Object> [-ApplianceConnection] <Object> [-Force] <String> [<CommonParameters>]
This CMDLET will assist the user to update an existing resource. The resource should first be retrieved with a 'Get-
HPOV[resourcename]' CMDLET. The PowerShell resource may then be modified, followed by this 'Set-HPOVResource' cmdlet.
Parameters
Aliases Appliance
Required? true
Position? 1
-Force <String>
Set to $true to force-update the resource. Not all resources support force-update.
Aliases None
Required? true
Position? named
Default value False
The modified resource that is to be updated. Can be resource object, name or URI.
Aliases Resource
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Resource Object to modify by either using Send-HPOVRequest with the resource URI, or the resource GET CMDLET
Return Values
The modified resource or async task depending on the resource being modified
Examples
-------------------------- EXAMPLE 1 --------------------------
$profile = Get-HPOVServerProfile 'Profile 1'

$profile.name = "New Name"
Set-HPOVResource $profile
Updates the name of the Server Profile resource.
Related Links
New-HPOVResource
Remove-HPOVResource
Top
Set-HPOVSanManager

Set-HPOVSanManager
Update SAN Manager configuration
SYNTAX
Set-HPOVSanManager [-InputObject] <Object> [-Username] <String> [-Password] <Object>[ [-Hostname] <String>][ [-P
ort] <Int32>][ [-EnableSsl] <SwitchParameter>][ [-DisableSsl] <SwitchParameter>][ [-Async] <SwitchParameter>] [-
ApplianceConnection] <Object> [<CommonParameters>]
ort] <Int32>][ [-SnmpUserName] <String>][ [-SnmpAuthLevel] <String>][ [-SnmpAuthProtocol] <String>][ [-SnmpAuthP
assword] <Object>][ [-SnmpPrivProtocol] <String>][ [-SnmpPrivPassword] <Object>][ [-Async] <SwitchParameter>] [-
Updates an existing SAN Manager configuration. Can update the hostname/IP Address and credentials. At least one optional
parameter must be provided.
Parameters
Aliases None
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-DisableSsl <SwitchParameter>
Enable Secure WBEM communications to Brocade SAN Network Advisor.
Aliases None
Required? false
Position? named
Default value False

-EnableSsl <SwitchParameter>
Aliases None
Required? false
Position? named
Default value False
-Hostname <String>
Updated Hostname or IP Address of the SAN Manager.
Aliases None
Required? false
Position? named
Default value
Aliases [-name] Resource Object (from Get-HPOVSanManager) or Name of the SAN Manager to update. If specifying a resource
Name, the ApplianceConnection parameter is required.
Aliases name, Resource
Required? true
Position? named
Default value
-Password <Object>
Updated Password used to authenticate and manage the SAN Manager. Can either be a String or SecureString value.
Aliases None
Required? true
Position? named
Default value
-Port <Int32>
Updated TCP Port of the SAN Manager.
Aliases None
Required? false
Position? named
Default value 0

Aliases None
Required? false
Position? named
Default value None
SNMPv3 UserName Password. Can either be a String or SecureString value.
Aliases None
Required? false
Position? named
Default value
* SHA
* MD5
Aliases None
Required? false
Position? named
Default value
SNMPv3 Privacy Encryption Password. Can either be a String or SecureString value.
Aliases None
Required? false
Position? named
Default value
* AES
* DES
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Username <String>
Updated Username used to authenticate and manage the SAN Manager.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
SAN Manager resource from Get-HPOVSanManager
Return Values
Update async task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Get-HPOVSanManager bna.domain.com -ApplianceConnection hpov.domain.com | Set-HPOVSanManager -hostname bn

a.newdomain.com | Wait-HPOVTaskComplete
Get the SAN Manager using Get-HPOVSanManager, and pipling the resource in order to update the hostname value.
-------------------------- EXAMPLE 2 --------------------------
$task = Set-HPOVSanManager -name BNA.contoso.com -hostname bna.newdomain.com -ApplianceConnection hpov.domain.co

m | Wait-HPOVTaskComplete
Update the existing Brocade Network Advisor SAN Manager"s hostname with the new value.
-------------------------- EXAMPLE 3 --------------------------
$task = Set-HPOVSanManager -name BNA.contoso.com -username newadmin -password updatedpassword -ApplianceConnecti

on hpov.domain.com | Wait-HPOVTaskComplete
Update the existing Brocade Network Advisor SAN Manager"s username and password. ### Related Links * [Add-
HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVSanManager) * [Get-
HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSanManager) * [Remove-
HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVSanManager) * [Update-
HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVSanManager) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVSanManager
Update SAN Manager configuration ### SYNTAX
ort] <Int32>][ [-EnableSsl] <SwitchParameter>][ [-DisableSsl] <SwitchParameter>][ [-Async] <SwitchParameter>] [-
ort] <Int32>][ [-SnmpUserName] <String>][ [-SnmpAuthLevel] <String>][ [-SnmpAuthProtocol] <String>][ [-SnmpAuthP
assword] <Object>][ [-SnmpPrivProtocol] <String>][ [-SnmpPrivPassword] <Object>][ [-Async] <SwitchParameter>] [-
Updates an existing SAN Manager configuration. Can update the hostname/IP Address and credentials. At least one optional
parameter must be provided.
Parameters
Aliases None
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
-DisableSsl <SwitchParameter>
Aliases None
Required? false
Position? named
Default value False
-EnableSsl <SwitchParameter>
Aliases None
Required? false
Position? named
Default value False
-Hostname <String>
Updated Hostname or IP Address of the SAN Manager.
Aliases None
Required? false
Position? named
Default value
Aliases [-name] Resource Object (from Get-HPOVSanManager) or Name of the SAN Manager to update. If specifying a resource
Name, the ApplianceConnection parameter is required.
Aliases name, Resource
Required? true
Position? named
Default value
-Password <Object>
Updated Password used to authenticate and manage the SAN Manager. Can either be a String or SecureString value.
Aliases None
Required? true
Position? named
Default value
-Port <Int32>
Updated TCP Port of the SAN Manager.
Aliases None
Required? false
Position? named
Default value 0

Aliases None
Required? false
Position? named
Default value None
SNMPv3 UserName Password. Can either be a String or SecureString value.
Aliases None
Required? false
Position? named
Default value
* SHA
* MD5
Aliases None
Required? false
Position? named
Default value
SNMPv3 Privacy Encryption Password. Can either be a String or SecureString value.
Aliases None
Required? false
Position? named
Default value
* AES
* DES
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Username <String>
Updated Username used to authenticate and manage the SAN Manager.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
SAN Manager resource from Get-HPOVSanManager
Return Values
Update async task
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Get-HPOVSanManager bna.domain.com -ApplianceConnection hpov.domain.com | Set-HPOVSanManager -hostname bn

a.newdomain.com | Wait-HPOVTaskComplete
Get the SAN Manager using Get-HPOVSanManager, and pipling the resource in order to update the hostname value.
-------------------------- EXAMPLE 2 --------------------------
$task = Set-HPOVSanManager -name BNA.contoso.com -hostname bna.newdomain.com -ApplianceConnection hpov.domain.co

m | Wait-HPOVTaskComplete
Update the existing Brocade Network Advisor SAN Manager's hostname with the new value.
-------------------------- EXAMPLE 3 --------------------------
$task = Set-HPOVSanManager -name BNA.contoso.com -username newadmin -password updatedpassword -ApplianceConnecti

on hpov.domain.com | Wait-HPOVTaskComplete
Update the existing Brocade Network Advisor SAN Manager's username and password.
Related Links
Add-HPOVSanManager
Get-HPOVSanManager
Top

Rename or set a description to a Server Hardware Type resource.
SYNTAX
Set-HPOVServerHardwareType [-InputObject] <Object> [-Name] <String>[ [-Description] <String>][ [-ApplianceConnec
tion] <Array>] [<CommonParameters>]
Use this Cmdlet to rename or set a description to one or more Server Hardware Type resource(s).
Required permissions: Server administrator
Parameters
Aliases Appliance
Required? False
Position? 3
Set a new description.
Aliases None
Required? false
Position? 2
Default value
HPOneView.ServerHardwareType resource from Get-HPOVServerHardwareType.
Aliases Resource
Required? true
Position? 0
Default value
-Name <String>
Set a new name.
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
HPOneView.ServerHardwareType
Resource from Get-HPOVServerHardwareType.
Return Values
The updated resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerHardwareType -Name "BL460c Gen9 1" -ErrorAction Stop | Set-HPOVServerHardwareType -Name "Corp Hype
rvisor Host Type"
Rename the default "BL460c Gen9 1" server hardware type resource to a new name. ### Related Links * [Get-
HPOVServerHardwareType](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerHardwareType) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVServerHardwareType
Rename or set a description to a Server Hardware Type resource. ### SYNTAX
Set-HPOVServerHardwareType [-InputObject] <Object> [-Name] <string>[ [-Description] <string>][ [-ApplianceConnec

tion] <Array>] [<CommonParameters>]
Use this Cmdlet to rename or set a description to one or more Server Hardware Type resource(s).
Required permissions: Server administrator
Parameters

Aliases Appliance
Required? False
Position? 3
-Description <string>
Set a new description.
Aliases None
Required? false
Position? 2
Default value
HPOneView.ServerHardwareType resource from Get-HPOVServerHardwareType.
Aliases Resource
Required? true
Position? 0
Default value
-Name <string>
Set a new name.
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Resource from Get-HPOVServerHardwareType.
Return Values
The updated resource object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerHardwareType -Name 'BL460c Gen9 1' -ErrorAction Stop | Set-HPOVServerHardwareType -Name 'Corp Hype
rvisor Host Type'
Rename the default 'BL460c Gen9 1' server hardware type resource to a new name.
Related Links
Top
Set-HPOVServerPower

Set-HPOVServerPower
[DEPRECATED] Set the power state of a server.
SYNTAX
Set-HPOVServerPower [-Server] <Object> [-State] <String> [-powerControl] <String> [-ApplianceConnection] <Object
>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet is now deprecated. Please use the Start-HPOVServer, Stop-HPOVServer or Restart-HPOVServer Cmdlets.
Parameters
Aliases Appliance
Required? true
Position? 3

Aliases cf
Required? false
Position? named
Default value
-Server <Object>
Aliases [-name, -uri, -serverUri]
The server object, URI or Name, or can be a Server Profile object.
Aliases name, uri, serverUri
Required? true
Position? 0
Default value
-State <String>
Optional power state. Default is On, other option is Off
Aliases PowerState
Required? true
Position? 1
Default value On
Aliases wi
Required? false
Position? named
Default value
-powerControl <String>
Optional setting to control the virtual power button.

Aliases None
Required? true
Position? 2
Default value MomentaryPress
<CommonParameters>
Input Types
None
None
Return Values
None
None
Examples
Related Links
Top
### HPE OneView 4.00 Library ## Set-HPOVServerPower
[DEPRECATED] Set the power state of a server. ### SYNTAX
Set-HPOVServerPower [-Server] <Object> [-State] <String> [-powerControl] <String> [-ApplianceConnection] <Object

>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This Cmdlet is now deprecated. Please use the Start-HPOVServer, Stop-HPOVServer or Restart-HPOVServer Cmdlets. ###
Parameters -ApplianceConnection <Object>
Aliases Appliance
Required? true
Position? 3
Aliases cf
Required? false
Position? named
Default value
-Server <Object>
Aliases [-name, -uri, -serverUri] The server object, URI or Name, or can be a Server Profile object.
Aliases name, uri, serverUri
Required? true
Position? 0
Default value
-State <String>
Optional power state. Default is On, other option is Off
Aliases PowerState
Required? true
Position? 1
Default value On
Aliases wi
Required? false
Position? named
Default value
-powerControl <String>
Optional setting to control the virtual power button.
Aliases None
Required? true
Position? 2
Default value MomentaryPress

### Input Types None None ### Return Values None None ### Examples ### Related Links ***
Top

Not implemented.
SYNTAX
Set-HPOVServerProfile [<CommonParameters>]
Not implemented.
Parameters
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example ### Related Links * [Convert-HPOVServerProfile](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Convert-HPOVServerProfile) * [Convert-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Convert-HPOVServerProfileTemplate) * [ConvertTo-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVServerProfileTemplate) * [Copy-HPOVServerProfile]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Copy-HPOVServerProfile) * [Get-HPOVServerProfile]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfile) * [Get-HPOVServerProfileConnectionList]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileConnectionList) * [Get-
HPOVServerProfileMessage](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileMessage) * [Get-
[Join-HPOVServerProfileToTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Join-
HPOVServerProfileToTemplate) * [New-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVServerProfile) * [New-HPOVServerProfileAssign](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVServerProfileAssign) * [New-HPOVServerProfileAttachVolume](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVServerProfileAttachVolume) * [New-HPOVServerProfileConnection]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileConnection) * [New-
HPOVServerProfileLogicalDisk](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileLogicalDisk) *
[New-HPOVServerProfileLogicalDiskController](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
[Update-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServerProfile) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVServerProfile
Not implemented. ### SYNTAX
Set-HPOVServerProfile [<CommonParameters>]
Not implemented.
Parameters
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example
Related Links
Top

Not implemented.
SYNTAX
Set-HPOVServerProfileTemplate [<CommonParameters>]
Not implemented.
Parameters
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example ### Related Links * [Convert-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-

HPOneView/wiki/Convert-HPOVServerProfileTemplate) * [ConvertTo-HPOVServerProfileTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVServerProfileTemplate) * [Get-
[New-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileTemplate)
* [Remove-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVServerProfileTemplate) * [Save-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Save-HPOVServerProfileTemplate) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVServerProfileTemplate
Not implemented. ### SYNTAX
Set-HPOVServerProfileTemplate [<CommonParameters>]
Not implemented.
Parameters
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example
Related Links
Top
Set SNMP Read Community.
SYNTAX
Set-HPOVSnmpReadCommunity [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Set a new SNMP Read Community value on the appliance. Updating this value will cause the appliance to refresh the managed
devices with the updated Read-Only SNMP Community string. This does not update the SNMP trap destination(s) for Logical
Interconnects or Logical Interconnect Groups.
Parameters
Aliases Appliance
Required? true
Position? 1
-Name <String>
The name of the new SNMP Read-Only Community.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
None.
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVSnmpReadCommunity -name "MySNMPC0mmunity"
Set the appliance SNMP Read Community string to the new value. ### Related Links * [Get-HPOVSnmpReadCommunity]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSnmpReadCommunity) ***
Top
### HPE OneView 4.00 Library ## Set-HPOVSnmpReadCommunity
Set SNMP Read Community. ### SYNTAX
Set-HPOVSnmpReadCommunity [-Name] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Set a new SNMP Read Community value on the appliance. Updating this value will cause the appliance to refresh the managed
devices with the updated Read-Only SNMP Community string. This does not update the SNMP trap destination(s) for Logical
Interconnects or Logical Interconnect Groups.
Parameters
Aliases Appliance
Required? true
Position? 1
-Name <String>
The name of the new SNMP Read-Only Community.
Aliases None
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
None.
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVSnmpReadCommunity -name "MySNMPC0mmunity"
Set the appliance SNMP Read Community string to the new value.
Related Links
Top
Set-HPOVStoragePool

Set-HPOVStoragePool
Modify storage pool managed state.
SYNTAX
Set-HPOVStoragePool [-InputObject] <HPOneView.Storage.StoragePool[]> [-Managed] <bool>[ [-ApplianceConnection] <
Array>] [<CommonParameters>]
A storage pool is an aggregation of physical storage resources (disks) in a storage system. Storage systems contain information
about the storage ports through which they can be accessed. You can provision logical storage spaces, known as volumes,
from storage pools. You cannot create or delete storage pools from the appliance, you can only add or remove them from
management. Using this Cmdlet will change the managed state of a storage pool. Its management state cannot be changed
when volumes are currently provisioned from it and managed by HPE OneView, or a storage volume template specify the
storage pool. If you remove a storage system from the appliance, all storage pools in it are removed automatically. Minimum
required privileges: Infrastructure administrator or Storage administrator.
Parameters
Aliases Appliance
Required? False
Position? named
-InputObject <HPOneView.Storage.StoragePool[]>
One or more HPOneView.Storage.StoragePool resources from Get-HPOVStoragePool.
Aliases Pool
Required? true
Position? named
Default value
-Managed <bool>
Specify a boolean value to modify the storage pools managed state.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Storage.StoragePool
Storage pool resource(s) from Get-HPOVStoragePool.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$StoragePool = Get-HPOVStoragePool -Name "r5_cpg1" -ErrorAction Stop Set-HPOVStoragePool -InputObject $StoragePo

ol -Managed $true
Manage the specified storage pool to provision volumes.
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStoragePool -Name r5_* -ErrorAction Stop | Set-HPOVStoragePool -Managed $false
Change the managed state to "unmanaged" of the specified storage pools.
Related Links
Add-HPOVStoragePool
Get-HPOVStoragePool
Top

Modify an existing Storage Volume resource.
SYNTAX
Set-HPOVStorageVolume [-InputObject] <Object>[ [-Name] <String>][ [-Description] <String>] [-Capacity] <Int64>[
[-SnapShotStoragePool] <Object>][ [-DataProtectionLevel] <String>][ [-PermitAdaptiveOptimization] <Boolean>][ [-
Shared] <Boolean>] [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will help modify an existing Storage Volume resource. Only the Volume Name, Description, Capcity, volume shared
state and permenance can be modified.
Parameters
Aliases Appliance
Required? true
Position? named
-Capacity <Int64>
Aliases [-size] New Max volume capacity in GB. Volume capacity can be increased to maximum of 16 TiB. Decreasing the
capacity of volume is not supported.
Before increasing the capacity of fully provisioned volumes, ensure that the storage pool has enough capacity to support the
operation. The update operation might fail if there is not enough space available in the storage pool.
e.g. 20 to specify 20GB.
Aliases size
Required? true
Position? named
Default value 0
Specify the new StoreVirtual data protection level (aka Network RAID). Allowed values:
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value False
Updated description for the volume.
Aliases None
Required? false
Position? named
Default value
Aliases [-SourceVolume] Source Storage Volume resource object.
Aliases SourceVolume
Required? true
Position? named
Default value
-Name <String>
Aliases [-VolumeName]
Updated Storage Volume Name.
Aliases VolumeName
Required? false
Position? named
Default value
-PermitAdaptiveOptimization <Boolean>
Aliases None
Required? false
Position? named
Default value False
-Shared <Boolean>
Aliases None
Required? false
Position? named
Default value False
-SnapShotStoragePool <Object>
The Storage Pool Name, URI or Object to be used for Volume Snapshots.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async create task
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolume ProdVol1 | Set-HPOVStorageVolume -Size 160
Update "ProdVol1" volume size to 160GB. ### Related Links * [Add-HPOVStorageVolume]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVStorageVolume) * [Get-HPOVStorageVolume]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolume) * [Get-HPOVStorageVolumeSnapShot]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageVolumeSnapShot) * [Get-
HPOneView/wiki/Remove-HPOVStorageVolumeTemplate) * [Set-HPOVStorageVolumeTemplate]
Top
### HPE OneView 4.00 Library ## Set-HPOVStorageVolume
Modify an existing Storage Volume resource. ### SYNTAX
Set-HPOVStorageVolume [-InputObject] <Object>[ [-Name] <String>][ [-Description] <String>] [-Capacity] <Int64>[

[-SnapShotStoragePool] <Object>][ [-DataProtectionLevel] <String>][ [-PermitAdaptiveOptimization] <Boolean>][ [-
Shared] <Boolean>] [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will help modify an existing Storage Volume resource. Only the Volume Name, Description, Capcity, volume shared
state and permenance can be modified.
Parameters
Aliases Appliance
Required? true
Position? named
-Capacity <Int64>
Aliases size
Required? true
Position? named
Default value 0
Specify the new StoreVirtual data protection level (aka Network RAID). Allowed values:
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases [-SourceVolume] Source Storage Volume resource object.
Aliases SourceVolume
Required? true
Position? named
Default value
-Name <String>
Aliases [-VolumeName]
Updated Storage Volume Name.
Aliases VolumeName
Required? false
Position? named
Default value

-PermitAdaptiveOptimization <Boolean>
Aliases None
Required? false
Position? named
Default value False
-Shared <Boolean>
Aliases None
Required? false
Position? named
Default value False
-SnapShotStoragePool <Object>
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Async create task
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolume ProdVol1 | Set-HPOVStorageVolume -Size 160
Update 'ProdVol1' volume size to 160GB.
Related Links
Top

Modify an existing Storage Volume Template resource.
SYNTAX
Set-HPOVStorageVolumeTemplate [-InputObject] <Object>[ [-Capacity] <Int64>][ [-Name] <String>][ [-Description] <
String>][ [-SnapshotStoragePool] <Object>][ [-LockSnapShotStoragePool] <SwitchParameter>][ [-StorageSystem] <Obj
ect>][ [-LockCapacity] <SwitchParameter>][ [-Thin] <SwitchParameter>][ [-Full] <SwitchParameter>][ [-LockProvisi
onType] <SwitchParameter>][ [-Shared] <Boolean>][ [-LockProvisionMode] <SwitchParameter>] [-ApplianceConnection]
String>][ [-StorageSystem] <Object>][ [-LockCapacity] <SwitchParameter>][ [-Thin] <SwitchParameter>][ [-Full] <S
witchParameter>][ [-LockProvisionType] <SwitchParameter>][ [-Shared] <Boolean>][ [-LockProvisionMode] <SwitchPar
ameter>][ [-DataProtectionLevel] <String>][ [-LockProtectionLevel] <SwitchParameter>][ [-EnableAdaptiveOptimizat
ion] <SwitchParameter>][ [-LockAdaptiveOptimization] <SwitchParameter>] [-ApplianceConnection] <Object> [<Common
Parameters>]
This cmdlet will help modify an existing Storage Volume Template resource. Only the Volume Name, Description, Capcity,
Snapshot Storage Pool, volume shared state and permenance can be modified.
Parameters
Aliases Appliance
Required? true
Position? named
-Capacity <Int64>
Aliases size
Required? false
Position? named
Default value 0
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Include to change the provisioned type to Full.
Aliases None
Required? false
Position? named
Default value False
Aliases [-SVT, -Template]
Source Storage Volume Template resource object.

Aliases SVT, Template
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
-Name <String>
Updated Storage Volume Template Name.
Required? false
Position? named
Default value
-Shared <Boolean>
Aliases None
Required? false
Position? named
Default value False

Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
-Thin <SwitchParameter>
Include to change the provisioned type to Thin.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Storage Volume Template resource.
Return Values
Updated Storage Volume Template object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolumeTemplate -Name MyProdVolTemplate | Set-HPOVStorageVolumeTemplate -Size 160
Update "MyProdVolTemplate" volume size to 160GB. ### Related Links * [Get-HPOVStorageVolumeTemplate]

HPOVStorageVolumeTemplatePolicy) * [New-HPOVStorageVolumeTemplate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVStorageVolumeTemplate) * [Remove-HPOVStorageVolumeTemplate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStorageVolumeTemplate) * [Set-
Top
### HPE OneView 4.00 Library ## Set-HPOVStorageVolumeTemplate
Modify an existing Storage Volume Template resource. ### SYNTAX

String>][ [-SnapshotStoragePool] <Object>][ [-LockSnapShotStoragePool] <SwitchParameter>][ [-StorageSystem] <Obj
ect>][ [-LockCapacity] <SwitchParameter>][ [-Thin] <SwitchParameter>][ [-Full] <SwitchParameter>][ [-LockProvisi
onType] <SwitchParameter>][ [-Shared] <Boolean>][ [-LockProvisionMode] <SwitchParameter>] [-ApplianceConnection]

String>][ [-StorageSystem] <Object>][ [-LockCapacity] <SwitchParameter>][ [-Thin] <SwitchParameter>][ [-Full] <S
witchParameter>][ [-LockProvisionType] <SwitchParameter>][ [-Shared] <Boolean>][ [-LockProvisionMode] <SwitchPar
ameter>][ [-DataProtectionLevel] <String>][ [-LockProtectionLevel] <SwitchParameter>][ [-EnableAdaptiveOptimizat
ion] <SwitchParameter>][ [-LockAdaptiveOptimization] <SwitchParameter>] [-ApplianceConnection] <Object> [<Common
Parameters>]
This cmdlet will help modify an existing Storage Volume Template resource. Only the Volume Name, Description, Capcity,
Snapshot Storage Pool, volume shared state and permenance can be modified.
Parameters
Aliases Appliance
Required? true
Position? named
-Capacity <Int64>
Aliases size
Required? false
Position? named
Default value 0
* NetworkRaid0None
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Include to change the provisioned type to Full.
Aliases None
Required? false
Position? named
Default value False
Aliases [-SVT, -Template]
Source Storage Volume Template resource object.
Aliases SVT, Template
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False

-Name <String>
Updated Storage Volume Template Name.
Required? false
Position? named
Default value
-Shared <Boolean>
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? false
Position? named
Default value
Aliases None
Required? false
Position? named
Default value

-Thin <SwitchParameter>
Include to change the provisioned type to Thin.
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Storage Volume Template resource.
Return Values
Updated Storage Volume Template object.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageVolumeTemplate -Name MyProdVolTemplate | Set-HPOVStorageVolumeTemplate -Size 160
Update 'MyProdVolTemplate' volume size to 160GB.
Related Links
Top

Set Storage Volume Template Global Policy
SYNTAX
Set-HPOVStorageVolumeTemplatePolicy[ [-Enable] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParamet
ers>]
Set-HPOVStorageVolumeTemplatePolicy[ [-Disable] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParame

ters>]
By default, Storage Volumes can be created without reference to a Storage Volume Template. This cmdlet will allow the
administrator to change the global policy setting. Use with caution, as this will prevent copying Server Profiles that contain
attached Storage Volumes.
Parameters
Aliases Appliance
Required? true
Position? named
Switch to disable the policy
Aliases None
Required? false
Position? named
Default value False
Switch to enable the policy
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
System.Boolean
Returned boolean value after changing policy
Examples
-------------------------- EXAMPLE 1 --------------------------
--------- ---- -----
Set-HPOVStorageVolumeTemplatePolicy -disable -ApplianceConnection $ConnectedSessions

--------- ---- -----
MyAppliance.domain.com StorageVolumeTemplateRequired false
Get the Storage Volume Template Global Policy setting, then disable it for all connected appliances. ### Related Links * [Get-
Top
### HPE OneView 4.00 Library ## Set-HPOVStorageVolumeTemplatePolicy
Set Storage Volume Template Global Policy ### SYNTAX
Set-HPOVStorageVolumeTemplatePolicy[ [-Enable] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParamet

ers>]
Set-HPOVStorageVolumeTemplatePolicy[ [-Disable] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParame

ters>]
By default, Storage Volumes can be created without reference to a Storage Volume Template. This cmdlet will allow the
administrator to change the global policy setting. Use with caution, as this will prevent copying Server Profiles that contain
attached Storage Volumes.
Parameters
Aliases Appliance
Required? true
Position? named
Switch to disable the policy
Aliases None
Required? false
Position? named
Default value False
Switch to enable the policy
Aliases None
Required? false
Position? named
Default value False
<CommonParameters>
Input Types
Return Values
System.Boolean
Returned boolean value after changing policy
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVStorageVolumeTemplatePolicy -disable -ApplianceConnection $ConnectedSessions
MyAppliance.domain.com StorageVolumeTemplateRequired false

Get the Storage Volume Template Global Policy setting, then disable it for all connected appliances.
Related Links
Top
Set-HPOVUser

Set-HPOVUser
Modify an existing user account.
SYNTAX
Set-HPOVUser [-UserName] <String> [-Password] <String> [-FullName] <String> [-Roles] <Array>[ [-ScopePermissions
] <Array>] [-EmailAddress] <String> [-OfficePhone] <String> [-MobilePhone] <String>[ [-Enabled] <SwitchParameter
>][ [-Disabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVUser [-UserObject] <Object> [-Password] <String> [-FullName] <String> [-Roles] <Array>[ [-ScopePermissio
ns] <Array>] [-EmailAddress] <String> [-OfficePhone] <String> [-MobilePhone] <String>[ [-Enabled] <SwitchParamet
er>][ [-Disabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
Modify or update an existing local user account on the management appliance. This cmdlet will not update the password or roles
of the currently logged in user account. To update your HPE OneView appliance local account"s password, please use the Set-
HPOVUserPassword cmdlet.
Parameters
Aliases Appliance
Required? true
Position? named
Disable the local user account.
Aliases disable
Required? false
Position? named
Default value False
Updated Email Address of the User Account.
Aliases None
Required? true
Position? named
Default value
Enable the local user account.
Aliases enable
Required? false
Position? named
Default value False
-FullName <String>
Updated Full Name of the User Account.
Aliases None
Required? true
Position? named
Default value
Updated mobile phone number
Aliases None
Required? true
Position? named
Default value
Updated office phone of the User Account.
Aliases None
Required? true
Position? named
Default value
-Password <String>
New password for the user account. Passwords must be at least 8 characters.
Aliases None
Required? true
Position? named
Default value

-Roles <Array>
Aliases None
Required? true
Position? named
Default value
Stop) }
Aliases None
Required? False
Position? named
Default value
-UserName <String>
The name or object of the user account to be updated.
Aliases None
Required? true
Position? named
Default value
-UserObject <Object>
The object of the user account to be updated.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVUser -username Sally -roles @("server administrator","network administrator")
Update the user account "Sally" with new roles.

-------------------------- EXAMPLE 2 --------------------------
Set-HPOVUser -username Sally -password NewP@ssw0rd
Update the user account "Sally" with a new password.

-------------------------- EXAMPLE 3 --------------------------
$Scope = Get-HPOVScope -Name Scope1 -ErrorAction Stop

Get-HPOVUser -Username Sally | Set-HPOVUser -Roles "Server administrator" -ScopePermissions @{Role = "Network ad
ministrator"; Scope = $Scope }
Modify the user account with the new role and scope permissions. ### Related Links * [Get-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVUser) * [New-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVUser) * [Remove-HPOVUser]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVUser) * [Set-HPOVUserPassword]
Top
### HPE OneView 4.00 Library ## Set-HPOVUser
Modify an existing user account. ### SYNTAX
Set-HPOVUser [-UserName] <String> [-Password] <String> [-FullName] <String> [-Roles] <Array>[ [-ScopePermissions
] <Array>] [-EmailAddress] <String> [-OfficePhone] <String> [-MobilePhone] <String>[ [-Enabled] <SwitchParameter
>][ [-Disabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
Set-HPOVUser [-UserObject] <Object> [-Password] <String> [-FullName] <String> [-Roles] <Array>[ [-ScopePermissio
ns] <Array>] [-EmailAddress] <String> [-OfficePhone] <String> [-MobilePhone] <String>[ [-Enabled] <SwitchParamet
er>][ [-Disabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]
Modify or update an existing local user account on the management appliance. This cmdlet will not update the password or roles
of the currently logged in user account. To update your HPE OneView appliance local account's password, please use the Set-
HPOVUserPassword cmdlet.
Parameters
Aliases Appliance
Required? true
Position? named
Disable the local user account.
Aliases disable
Required? false
Position? named
Default value False
Updated Email Address of the User Account.
Aliases None
Required? true
Position? named
Default value
Enable the local user account.
Aliases enable
Required? false
Position? named
Default value False
-FullName <String>
Updated Full Name of the User Account.
Aliases None
Required? true
Position? named
Default value
Updated mobile phone number
Aliases None
Required? true
Position? named
Default value
Updated office phone of the User Account.
Aliases None
Required? true
Position? named
Default value
-Password <String>
New password for the user account. Passwords must be at least 8 characters.
Aliases None
Required? true
Position? named
Default value
-Roles <Array>
Aliases None
Required? true
Position? named
Default value
Stop) }
Aliases None
Required? False
Position? named
Default value
-UserName <String>
The name or object of the user account to be updated.
Aliases None
Required? true
Position? named
Default value
-UserObject <Object>
The object of the user account to be updated.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVUser -username Sally -roles @("server administrator","network administrator")
Update the user account 'Sally' with new roles.
-------------------------- EXAMPLE 2 --------------------------
Set-HPOVUser -username Sally -password NewP@ssw0rd
Update the user account 'Sally' with a new password.
-------------------------- EXAMPLE 3 --------------------------
$Scope = Get-HPOVScope -Name Scope1 -ErrorAction Stop

Get-HPOVUser -Username Sally | Set-HPOVUser -Roles 'Server administrator' -ScopePermissions @{Role = 'Network ad
ministrator'; Scope = $Scope }
Modify the user account with the new role and scope permissions.
Related Links
Get-HPOVUser
New-HPOVUser
Remove-HPOVUser
Set-HPOVUserRole
Top

Update current user account password.
SYNTAX
Set-HPOVUserPassword [-Current] <String> [-New] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet provides the ability to update the current user account password. Only HPE OneView appliance local account
passwords will be changed. This cmdlet does not assist with modifying or updating an LDAP or Active Directory user account"s
password.
Parameters
Aliases Appliance
Required? true
Position? 2
-Current <String>
Aliases [-CurrentPassword]
The current password of the user account. If omitted, the cmdlet will prompt for the users password as a secure string.
Aliases CurrentPassword
Required? true
Position? 0
Default value

-New <String>
Aliases [-NewPassword]
The new password to be set for the user account. If omitted, the cmdlet will prompt for the users password as a secure string.
Aliases NewPassword
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVUserPassword MyCurrentPass NewP@ssw0rd
Update your HPE OneView account password to the new value on all connected appliances. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVUserPassword
Update current user account password. ### SYNTAX
Set-HPOVUserPassword [-Current] <String> [-New] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet provides the ability to update the current user account password. Only HPE OneView appliance local account
passwords will be changed. This cmdlet does not assist with modifying or updating an LDAP or Active Directory user account's
password.
Parameters
Aliases Appliance
Required? true
Position? 2

-Current <String>
Aliases [-CurrentPassword]
The current password of the user account. If omitted, the cmdlet will prompt for the users password as a secure string.
Aliases CurrentPassword
Required? true
Position? 0
Default value
-New <String>
Aliases [-NewPassword]
The new password to be set for the user account. If omitted, the cmdlet will prompt for the users password as a secure string.
Aliases NewPassword
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVUserPassword MyCurrentPass NewP@ssw0rd
Update your HPE OneView account password to the new value on all connected appliances.
Related Links
Top
Set-HPOVUserRole
Set-HPOVUserRole
(Deprecated) Assign or change roles for an existing user.
SYNTAX
Set-HPOVUserRole [-Name] <Object> [-Roles] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]
This CMDLET is now deprecated. Please use the Set-HPOVUser CMDLET to modify user accounts and associated
roles/permissions
Parameters
Aliases Appliance
Required? true
Position? 2
-Name <Object>
Aliases [-user, -username] The name of the user account to have a role assigned.
Aliases user, userName
Required? true
Position? 0
Default value
-Roles <Array>
Aliases roleName
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
HPE OneView applinace user account
Return Values
Updated user account with new role(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVUserRole -user Sally -roleName "Server Administrator"
Set the Server Administrator role for Sally"s user account. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Set-HPOVUserRole
(Deprecated) Assign or change roles for an existing user. ### SYNTAX
Set-HPOVUserRole [-Name] <Object> [-Roles] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]
This CMDLET is now deprecated. Please use the Set-HPOVUser CMDLET to modify user accounts and associated
roles/permissions
Parameters
Aliases Appliance
Required? true
Position? 2
-Name <Object>
Aliases [-user, -username] The name of the user account to have a role assigned.
Aliases user, userName
Required? true
Position? 0
Default value
-Roles <Array>
Aliases roleName
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
HPE OneView applinace user account
Return Values
Updated user account with new role(s)
Examples
-------------------------- EXAMPLE 1 --------------------------
Set-HPOVUserRole -user Sally -roleName "Server Administrator"
Set the Server Administrator role for Sally's user account.
Related Links
Top
Show-HPOVActiveUser

Show-HPOVActiveUser
Display active and connected users.
SYNTAX
Show-HPOVActiveUser[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Use this Cmdlet to display active and connected users to an HPE OneView or Synergy management appliance. Infrastructure
administrator or Security administrator role is required in order to view all connected users.
Parameters
Aliases Appliance
Required? false
Position? named
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.ActiveUserSession
Connected user session and its details.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVActiveUser UserName LoginDomain ClientHost LoginTime -------- ------

----- ---------- --------- BobSmith@domain.local doctors-lab.local 192.168.19.3 11/1/2018 9: 39: 34 PM
administrator Local 192.168.19.20 11/7/2018 1: 58: 48 PM Administrator Local
192.168.19.3 11/10/2018 5: 36: 39 AM
Display connected active users to the appliance. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Show-HPOVActiveUser
Get HPE Synergy Image Streamer deployment plan parameters. ### SYNTAX
Show-HPOVActiveUser[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? false
Position? named
<CommonParameters>
Input Types

Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVOSDeploymentPlan -Name 'RHEL 7.2 OS' -ErrorAction Stop | Get-HPOVOSDeploymentPlanAttribute
Return OS Deployment Plan parameters from the 'RHEL 7.2 OS' deployment plan.
Related Links
Top
Show-HPOVApplianceSecurityModeCompatibilityReport

Show-HPOVApplianceSecurityModeCompatibilityReport
Generate or show security mode compatability report.
SYNTAX
Show-HPOVApplianceSecurityModeCompatibilityReport [-TargetSecurityMode] <HPOneView.Appliance.SecurityMode>[ [-Up
dateReport] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
When you are considering switching the cryptography mode for your appliance, Hewlett Packard Enterprise recommends that
you run the compatibility report to check for compatibility issues for a chosen cryptography mode. Compatibility reports contain
information about the behavior of devices and external servers managed or configured by HPE OneView. The report lists the
various resources (storage devices, network devices, servers, enclosures) managed by HPE OneView that are not compatible
with the chosen cryptography mode. You can use the compatibility reports to:
* Determine the impact of the mode switch on various resources, such as, the appliance certificates, external
servers and managed devices.
* Understand the actions recommended to be taken before switching the cryptography mode of the appliance. Exam
ples:
* Re-importing a higher strength certificate signed by your certificate authority (CA).

* Configuring the managed device or external server to be compliant with the cryptography mode of HPE OneV
iew.
* Determine the devices or class of devices that cannot be managed by HPE OneView in the target mode. Running
this Cmdlet will generate a new compatibility report if one does not exist. Use the -UpdateReport switch to gen
erate a new report.
Parameters
Aliases Appliance
Required? False
Position? named
-TargetSecurityMode <HPOneView.Appliance.SecurityMode>
Specify the target security mode to test resources from Get-HPOVApplianceAvailableSecurityMode.
Aliases None
Required? true
Position? named
Default value
-UpdateReport <SwitchParameter>
Specify to regenerate the report.
Aliases None
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Available security mode from Get-HPOVApplianceAvailableSecurityMode.
Return Values
HPOneView.Appliance.SecurityModeCompatibilityReport
Security mode compatibility report.
Examples
-------------------------- EXAMPLE 1 --------------------------
$TargetSecurityMode = Get-HPOVApplianceAvailableSecurityMode -ModeName CNSA

Show-HPOVApplianceSecurityModeCompatibilityReport -TargetSecurityMode $TargetSecurityMode
Generate a compatibility report for changing the appliance mode to CNSA.
Related Links
Top
Show-HPOVFirmwareReport

Show-HPOVFirmwareReport
Generate firmware report
SYNTAX
Show-HPOVFirmwareReport [-InputObject] <Object> [-Baseline] <Object> [-Location] <String> [-ApplianceConnection]
<Object>[ [-Export] <SwitchParameter>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? true
Position? 3
-Baseline <Object>
Resource Object or Name of the Firmware Baseline to report against what is installed.
Aliases None
Required? true
Position? 1
Default value
Indicate to export the report to a CSV file.
Aliases None
Required? false
Position? named
Default value False
The managed resource object to generate the report for. Allowed resource object types are:
* EG (Enclosure Group)
* Enclosure
* Server
* Interconnect
By specifying an Enclosure Group, all associated Enclosures will be included in the report.
Aliases Resource
Required? true
Position? 0
Default value
-Location <String>
File system location where to save the exported report to.
Default: Current Working Directory
Aliases None
Required? true
Position? 2

<CommonParameters>
Input Types
HPOneView.EnclosureGroup or HPOneView.Enclosure or HPOneView.ServerHardware or
HPOneView.Networking.Interconnect
HPE OneView Managed Resource object
Return Values
System.Object
Firmware report
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosureGroup "Production EG" | Show-HPOVFirmwareReport
Display a firmware report of all associated enclosures to "Production EG" Enclosure Group currently managed by the appliance.
-------------------------- EXAMPLE 2 --------------------------
$Baseline = Get-HPOVBaseline -SppName "Production EG"

Get-HPOVEnclosureGroup "Production EG" | Show-HPOVFirmwareReport -Baseline $Baseline
Display a firmware report of the "Production EG" resource, and components (servers, interconnects and Onboard
Administrators) currently managed by the appliance, and compare to the provided Baseline. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Show-HPOVFirmwareReport
Generate firmware report ### SYNTAX
Show-HPOVFirmwareReport [-InputObject] <Object> [-Baseline] <Object> [-Location] <String> [-ApplianceConnection]

<Object>[ [-Export] <SwitchParameter>] [<CommonParameters>]
Parameters
Aliases Appliance
Required? true
Position? 3

-Baseline <Object>
Resource Object or Name of the Firmware Baseline to report against what is installed.
Aliases None
Required? true
Position? 1
Default value
Indicate to export the report to a CSV file.
Aliases None
Required? false
Position? named
Default value False
The managed resource object to generate the report for. Allowed resource object types are:
* EG (Enclosure Group)
* Enclosure
* Server
* Interconnect
By specifying an Enclosure Group, all associated Enclosures will be included in the report.
Aliases Resource
Required? true
Position? 0
Default value
-Location <String>
File system location where to save the exported report to.
Default: Current Working Directory
Aliases None
Required? true
Position? 2
<CommonParameters>
Input Types
HPOneView.EnclosureGroup or HPOneView.Enclosure or HPOneView.ServerHardware or
HPOneView.Networking.Interconnect
HPE OneView Managed Resource object
Return Values
System.Object
Firmware report
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosureGroup 'Production EG' | Show-HPOVFirmwareReport
Display a firmware report of all associated enclosures to 'Production EG' Enclosure Group currently managed by the appliance.
-------------------------- EXAMPLE 2 --------------------------
$Baseline = Get-HPOVBaseline -SppName 'Production EG'

Get-HPOVEnclosureGroup 'Production EG' | Show-HPOVFirmwareReport -Baseline $Baseline
Display a firmware report of the 'Production EG' resource, and components (servers, interconnects and Onboard
Administrators) currently managed by the appliance, and compare to the provided Baseline.
Related Links
Top
Show-HPOVHypervisorCluster

Default content
SYNTAX
Show-HPOVHypervisorCluster [-Name] <string>[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Default content
Parameters
Aliases Appliance
Required? False
Position? 1
-Name <string>
Aliases None
Required? True
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Default example
Related Links
Top
Show-HPOVLdapGroups

Show-HPOVLdapGroups
List Directory Groups from the configured LDAP Directory.
SYNTAX
Show-HPOVLdapGroups [-Directory] <Object> [-UserName] <String> [-Password] <SecureString> [-GroupName] <String>
Show-HPOVLdapGroups [-Directory] <Object>[ [-Credential] <PSCredential>] [-GroupName] <String> [-ApplianceConnec

This cmdlet will display the available Authentication Directory security groups. The displayed Directory Groups can then be used
to define new Directory Group Role assignment on the appliance with the New-HPOVLdapGroup cmdlet.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? False
Position? named
Default value
-Directory <Object>
Aliases [-d, -domain, -AuthProvider]
The configured LDAP Directory object on the appliance.
Aliases d, domain, AuthProvider
Required? true
Position? named
Default value
-GroupName <String>
Provide the name of the Directory Group to search for. If omitted, all found Directory Groups will be returned.
Aliases None
Required? true
Position? named
Default value
Aliases [-p]
User account password
Aliases p
Required? true
Position? named
Default value
-UserName <String>
Aliases [-u]
Username to authenticate with
Aliases u
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuthDirectoryGroup [System.Management.Automation.PSCustomObject]
Authentication Directory Group
System.Collections.ArrayList<HPOneView.Appliance.AuthDirectoryGroup>
Array of Authentication Directory Groups found
Examples
-------------------------- EXAMPLE 1 --------------------------
Show-HPOVLdapGroups -u "Sarah Peterson" -d Domain1
Get list of Directory Groups from Domain1 and prompt for password.
-------------------------- EXAMPLE 2 --------------------------

$Directory = Get-HPOVLdapDirectory "Domain99"
Show-HPOVLdapGroups -u "Sarah Peterson" -p $password -d $Directory
Automate list of Directory Groups from Domain99 with the provided password.
-------------------------- EXAMPLE 3 --------------------------

$Directory = Get-HPOVLdapDirectory "Domain99"
Show-HPOVLdapGroups -u "Sarah Peterson" -p $password -d $Directory -GroupName "Admins"
Automate list of Directory Groups from Domain99 with the provided password, searching for group names that contain "Admins".
Top
### HPE OneView 4.00 Library ## Show-HPOVLdapGroups
List Directory Groups from the configured LDAP Directory. ### SYNTAX
Show-HPOVLdapGroups [-Directory] <Object> [-UserName] <String> [-Password] <SecureString> [-GroupName] <String>

Show-HPOVLdapGroups [-Directory] <Object>[ [-Credential] <PSCredential>] [-GroupName] <String> [-ApplianceConnec
This cmdlet will display the available Authentication Directory security groups. The displayed Directory Groups can then be used
to define new Directory Group Role assignment on the appliance with the New-HPOVLdapGroup cmdlet.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? False
Position? named
Default value
-Directory <Object>
Aliases [-d, -domain, -AuthProvider]
The configured LDAP Directory object on the appliance.
Aliases d, domain, AuthProvider
Required? true
Position? named
Default value
-GroupName <String>
Provide the name of the Directory Group to search for. If omitted, all found Directory Groups will be returned.
Aliases None
Required? true
Position? named
Default value
Aliases [-p]
User account password
Aliases p
Required? true
Position? named
Default value
-UserName <String>
Aliases [-u]
Username to authenticate with
Aliases u
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
HPOneView.Appliance.AuthDirectoryGroup [System.Management.Automation.PSCustomObject]
Authentication Directory Group
System.Collections.ArrayList<HPOneView.Appliance.AuthDirectoryGroup>
Array of Authentication Directory Groups found

Examples
-------------------------- EXAMPLE 1 --------------------------
Show-HPOVLdapGroups -u 'Sarah Peterson' -d Domain1
Get list of Directory Groups from Domain1 and prompt for password.
-------------------------- EXAMPLE 2 --------------------------

$Directory = Get-HPOVLdapDirectory 'Domain99'
Show-HPOVLdapGroups -u 'Sarah Peterson' -p $password -d $Directory
Automate list of Directory Groups from Domain99 with the provided password.
-------------------------- EXAMPLE 3 --------------------------

$Directory = Get-HPOVLdapDirectory 'Domain99'
Show-HPOVLdapGroups -u 'Sarah Peterson' -p $password -d $Directory -GroupName 'Admins'
Automate list of Directory Groups from Domain99 with the provided password, searching for group names that contain 'Admins'.
Related Links
Top

Show the MAC Table for Logical Interconnect resource(s).
SYNTAX
Show-HPOVLogicalInterconnectMacTable [-InputObject] <Object> [-network] <String> [-Export] <String> [-ApplianceC
onnection] <Object> [<CommonParameters>]

Show-HPOVLogicalInterconnectMacTable [-InputObject] <Object> [-MacAddress] <String> [-Export] <String> [-Applian

This cmdlet will help show the MAC Table of Logical Interconnect resources. The REST API currently limits the first 100 MAC
addresses from the MAC table, regardless of the number of MAC Addresses learned in the table.
Use the -Network parameter to specify the Network Name to display learned MAC Addresses. You can export the results to a
CSV file, by providing the full path and filename to export to, using the -ExportFile parameter.
To display the results in a formatted list, use the -List parameter.
Parameters
Aliases Appliance
Required? true
Position? named
-Export <String>
Aliases [-x, -exportFile] Export to a CSV, provide the full path and filename.
Required? true
Position? named
Default value
Aliases [-name, -li, -LogicalInterconnect] The Name, URI, Logical Interconnect Resource or an array of either to display the MAC
Address tables from.
Aliases name, li, LogicalInterconnect
Required? true
Position? named
Default value
Provide a MAC Address to locate in the MAC Table.
Aliases mac
Required? true
Position? named
Default value
-network <String>
Provide the Network Name to filter the MAC Table results for.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
An Array of Logical Interconnect resource URI"s, Names or Objects
Return Values
Collection of MAC Address Table entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Return as many MAC Addresses allowed by the API for all Logical Interconnect resources.
-------------------------- EXAMPLE 2 --------------------------
Show-HPOVLogicalInterconnectMacTable -network VLAN100

Enclosure Interconnect Interface Address Type Network VLAN
--------- ------------ --------- ------- ---- ------- ----
Encl1 interconnect 2 LAG 27 38:22:D6:35:5A:62 Learned VLAN100 30
Encl1 interconnect 1 LAG 26 78:AC:C0:72:E5:D9 Learned VLAN100 30
Display all available MAC Addresses learned in "VLAN100" network in all Logical Interconnect resources, and display in a
formatted table.
-------------------------- EXAMPLE 3 --------------------------
Show-HPOVLogicalInterconnectMacTable -network VLAN100 -exportfile C:\reports\Encl1-LI_vlan100_mactable.csv
Retrieve the available MAC Addresses learned in "VLAN100" network, and export to C:\reports\Encl1-LI_vlan100_mactable.csv
Top
### HPE OneView 4.00 Library ## Show-HPOVLogicalInterconnectMacTable
Show the MAC Table for Logical Interconnect resource(s). ### SYNTAX


Show-HPOVLogicalInterconnectMacTable [-InputObject] <Object> [-MacAddress] <String> [-Export] <String> [-Applian

This cmdlet will help show the MAC Table of Logical Interconnect resources. The REST API currently limits the first 100 MAC
addresses from the MAC table, regardless of the number of MAC Addresses learned in the table.
Use the -Network parameter to specify the Network Name to display learned MAC Addresses. You can export the results to a
CSV file, by providing the full path and filename to export to, using the -ExportFile parameter.
To display the results in a formatted list, use the -List parameter.
Parameters
Aliases Appliance
Required? true
Position? named

-Export <String>
Aliases [-x, -exportFile] Export to a CSV, provide the full path and filename.
Required? true
Position? named
Default value
Aliases [-name, -li, -LogicalInterconnect] The Name, URI, Logical Interconnect Resource or an array of either to display the MAC
Address tables from.
Aliases name, li, LogicalInterconnect
Required? true
Position? named
Default value
Provide a MAC Address to locate in the MAC Table.
Aliases mac
Required? true
Position? named
Default value
-network <String>
Provide the Network Name to filter the MAC Table results for.
Aliases None
Required? true
Position? named
Default value

<CommonParameters>
Input Types
An Array of Logical Interconnect resource URI's, Names or Objects
Return Values
Collection of MAC Address Table entries
Examples
-------------------------- EXAMPLE 1 --------------------------
Return as many MAC Addresses allowed by the API for all Logical Interconnect resources.
-------------------------- EXAMPLE 2 --------------------------
Show-HPOVLogicalInterconnectMacTable -network VLAN100

Enclosure Interconnect Interface Address Type Network VLAN

Encl1 interconnect 1 LAG 26 78:AC:C0:72:E5:D9 Learned VLAN100 30
Display all available MAC Addresses learned in 'VLAN100' network in all Logical Interconnect resources, and display in a
formatted table.
-------------------------- EXAMPLE 3 --------------------------
Show-HPOVLogicalInterconnectMacTable -network VLAN100 -exportfile C:\reports\Encl1-LI_vlan100_mactable.csv
Retrieve the available MAC Addresses learned in 'VLAN100' network, and export to C:\reports\Encl1-LI_vlan100_mactable.csv
Related Links
Top
Show-HPOVPortStatistics
Show-HPOVPortStatistics
Display Interconnect Port Statistics.
SYNTAX
Show-HPOVPortStatistics [-Interconnect] <Object> [-Port] <Object> [-ApplianceConnection] <Object> [<CommonParame
ters>]
Show-HPOVPortStatistics [-Port] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will display the utilization (Format-Table view) or error (Format-List) statistics of a given Interconnect or Interconnect
Port. The default view is Format-Table. Piping output to Format-List will display error statistics.
Parameters
Aliases Appliance
Required? true
Position? named
-Interconnect <Object>
The Interconnect resource the Port ID is a member of.
Aliases None
Required? true
Position? named
Default value
-Port <Object>
The name of the Interconnect Port ID (i.e. X1 or D5) to retrieve. If no Port ID is provided, all Ports of the Interconnect will be
returned.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Netwroking.Interconnect.Port [System.Management.Automation.PSCustomObject]
An Interconnect Port object
Return Values
HPOneView.Networking.PortStatistics.Ethernet [System.Management.Automation.PSCustomObject]
Ethernet Uplink Port statistics
HPOneView.Networking.PortStatistics.FibreChannel [System.Management.Automation.PSCustomObject]
Collection of multiple Interconnect Port statistics
Examples
-------------------------- EXAMPLE 1 --------------------------
Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1" -port X1

Port Type: Ethernet
Name Rx Kb/s Tx Kb/s Rx Packets Tx Packets Rx Non-Unicast PPS Tx Non-Unicast PPS

---- ------- ------- ---------- ---------- ------------------ ------------------
X1 5Kbps (1min) 0Kbps (1min) 6pps (1min) 0pps (1min) 6pps (1min) 0pps (1min)
Displays the interface throughput statistics for X1 in a Format-Table display.

-------------------------- EXAMPLE 2 --------------------------
Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1" -port X1 | FL

Port Type: Ethernet
Name : X4
Rx Kb/s : 5Kbps (1min)
Tx Kb/s : 0Kbps (1min)
In Discards :
Out Discards :
In Errors :
Out Errors :
CRC Errors Rx/Tx :
MTU Exceeded Discards Rx/Tx :
Giants Rx/Tx :
Displays the interface error statistics for X1 in a Format-List display.

-------------------------- EXAMPLE 3 --------------------------
(Get-HPOVInterconnect "Encl1, Interconnect 1").ports | ? name -eq X1 | Show-HPOVPortStatistics
Pipe an Interconnect Port object to Show-HPOVPortStatistics and show the interface throughput statistics.
-------------------------- EXAMPLE 4 --------------------------
Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1"

Port Type: Ethernet

---- ------- ------- ---------- ---------- ------------------ ------------------
d1 0Kbps (1min) 8Kbps (1min) 0pps (1min) 6pps (1min) 0pps (1min) 5pps (1min)
Port Type: FibreChannel
Name Rx Throughput Tx Throughput Rx Frames (Total) Tx Frames (Total) Rx Bytes (Total) Tx Bytes (Total)
---- ------------- ------------- ----------------- ----------------- ---------------- ----------------
X1 0 MB/s 0 MB/s 56868 85074 84809592 146546884
X2 0 MB/s 0 MB/s 7999 7999 579644 622152
X3 0 MB/s 0 MB/s 0 0 0 0
Display all available ports of the provided Interconnect, using the Interconnect Name.
-------------------------- EXAMPLE 5 --------------------------
$Interconnect = Get-HPOVInterconnect "Encl1, Interconnect 1"

Show-HPOVPortStatistics $Interconnect
Display all available ports of the provided Interconnect, using an Interconnect PowerShell object. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Show-HPOVPortStatistics
Display Interconnect Port Statistics. ### SYNTAX
Show-HPOVPortStatistics [-Interconnect] <Object> [-Port] <Object> [-ApplianceConnection] <Object> [<CommonParame

ters>]
Show-HPOVPortStatistics [-Port] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will display the utilization (Format-Table view) or error (Format-List) statistics of a given Interconnect or Interconnect
Port. The default view is Format-Table. Piping output to Format-List will display error statistics.
Parameters
Aliases Appliance
Required? true
Position? named
-Interconnect <Object>
The Interconnect resource the Port ID is a member of.
Aliases None
Required? true
Position? named
Default value
-Port <Object>
The name of the Interconnect Port ID (i.e. X1 or D5) to retrieve. If no Port ID is provided, all Ports of the Interconnect will be
returned.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Netwroking.Interconnect.Port [System.Management.Automation.PSCustomObject]
An Interconnect Port object
Return Values
HPOneView.Networking.PortStatistics.Ethernet [System.Management.Automation.PSCustomObject]
HPOneView.Networking.PortStatistics.FibreChannel [System.Management.Automation.PSCustomObject]
Collection of multiple Interconnect Port statistics
Examples
-------------------------- EXAMPLE 1 --------------------------
Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1" -port X1

Port Type: Ethernet
Displays the interface throughput statistics for X1 in a Format-Table display.

-------------------------- EXAMPLE 2 --------------------------
Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1" -port X1 | FL

Port Type: Ethernet
Name : X4
Rx Kb/s : 5Kbps (1min)
Tx Kb/s : 0Kbps (1min)
In Discards :
Out Discards :
In Errors :
Out Errors :
CRC Errors Rx/Tx :
MTU Exceeded Discards Rx/Tx :
Giants Rx/Tx :
Displays the interface error statistics for X1 in a Format-List display.
-------------------------- EXAMPLE 3 --------------------------
(Get-HPOVInterconnect 'Encl1, Interconnect 1').ports | ? name -eq X1 | Show-HPOVPortStatistics
Pipe an Interconnect Port object to Show-HPOVPortStatistics and show the interface throughput statistics.
-------------------------- EXAMPLE 4 --------------------------
Show-HPOVPortStatistics -interconnect 'Encl1, Interconnect 1'

Port Type: Ethernet
Port Type: FibreChannel
Name Rx Throughput Tx Throughput Rx Frames (Total) Tx Frames (Total) Rx Bytes (Total) Tx Bytes (Total)
X1 0 MB/s 0 MB/s 56868 85074 84809592 146546884

X2 0 MB/s 0 MB/s 7999 7999 579644 622152
X3 0 MB/s 0 MB/s 0 0 0 0
Display all available ports of the provided Interconnect, using the Interconnect Name.
-------------------------- EXAMPLE 5 --------------------------
$Interconnect = Get-HPOVInterconnect "Encl1, Interconnect 1"

Show-HPOVPortStatistics $Interconnect
Display all available ports of the provided Interconnect, using an Interconnect PowerShell object.
Related Links
Top
Show-HPOVSanEndpoint

View Managed SAN FC Endpoints.
SYNTAX
Show-HPOVSanEndpoint [-SAN] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
Show-HPOVSanEndpoint [-WWN] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will dispay the Managed SAN endpoints, or FC addresses, their node information, and Zone Name. By default, all
SAN endpoints will be returned. You can filter the results based on Managed SAN resource or WWN address.
Parameters
Aliases Appliance
Required? true
Position? named
-SAN <Object>
The Managed SAN Resource Object or Name. Cannot be combined with the WWN parameter.
Aliases None
Required? true
Position? named
Default value

-WWN <String>
The WWN of the node you are looking for. Cannot be combined with the SAN parameter.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneview.Storage.ManagedSan
Return Values
Async task
Examples
-------------------------- EXAMPLE 1 --------------------------
Appliance WWN Port Type Online SAN Name Zone Name
--------- --- --------- ------ -------- ---------
hpov-tot2 10:00:F6:9F:5F:70:00:02 N_Port False SAN1_1 Node_1_8
hpov-tot2 20:00:00:02:AC:00:08:DF N_Port True SAN1_1 Node_1_8
hpov-tot2 20:00:00:02:AC:00:08:E3 N_Port True SAN1_1 Node_1_8
hpov-tot2 20:00:00:02:AC:00:08:DE N_Port True SAN1_0 Node_1_7
hpov-tot2 AA:AA:AA:AA:AA:AA:AA:AA N_Port False SAN1_0 dummy_zone
hpov-tot2 20:00:00:02:AC:00:09:03 N_Port True SAN1_0
hpov-tot2 00:00:4A:2B:21:E0:00:1B N_Port True SAN1_1
hpov-tot2 00:00:4A:2B:21:E0:00:14 N_Port True SAN1_0
hpov-tot2 00:00:4A:2B:21:E0:00:0D N_Port True SAN1_1
hpov-tot2 20:00:00:02:AC:00:08:FF N_Port True SAN1_0
Return all SAN Endpoints from the appliance.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVManagedSan SAN1_1 | Show-HPOVSanEndpoint

--------- --- --------- ------ -------- ---------
Return all SAN Endpoints for the specified Managed SAN resource from the appliance.
-------------------------- EXAMPLE 3 --------------------------
Show-HPOVSanEndpoint -WWN 10:00:F6:9F:5F:70:00:02

--------- --- --------- ------ -------- ---------
Return the specific SAN Endpoint from the appliance. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Show-HPOVSanEndpoint
View Managed SAN FC Endpoints. ### SYNTAX
Show-HPOVSanEndpoint [-SAN] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
Show-HPOVSanEndpoint [-WWN] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
This Cmdlet will dispay the Managed SAN endpoints, or FC addresses, their node information, and Zone Name. By default, all
SAN endpoints will be returned. You can filter the results based on Managed SAN resource or WWN address.
Parameters
Aliases Appliance
Required? true
Position? named
-SAN <Object>
The Managed SAN Resource Object or Name. Cannot be combined with the WWN parameter.
Aliases None
Required? true
Position? named
Default value
-WWN <String>
The WWN of the node you are looking for. Cannot be combined with the SAN parameter.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
HPOneview.Storage.ManagedSan
Return Values
Async task
Examples
-------------------------- EXAMPLE 1 --------------------------

hpov-tot2 20:00:00:02:AC:00:08:DE N_Port True SAN1_0 Node_1_7
hpov-tot2 AA:AA:AA:AA:AA:AA:AA:AA N_Port False SAN1_0 dummy_zone
hpov-tot2 20:00:00:02:AC:00:08:FF N_Port True SAN1_0
Return all SAN Endpoints from the appliance.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVManagedSan SAN1_1 | Show-HPOVSanEndpoint


Return all SAN Endpoints for the specified Managed SAN resource from the appliance.
-------------------------- EXAMPLE 3 --------------------------
Show-HPOVSanEndpoint -WWN 10:00:F6:9F:5F:70:00:02


Return the specific SAN Endpoint from the appliance.
Related Links
Top

Display user logon sessions.
SYNTAX
Show-HPOVUserSession [<CommonParameters>]
This cmdlet is decprecated as of v2.0. Please use the $ConnectedSessions Global variable for appliance session information.
Parameters
<CommonParameters>
Input Types
None.
None
Return Values
None.
None
Examples
Related Links
Top
### HPE OneView 4.00 Library ## Show-HPOVUserSession
Display user logon sessions. ### SYNTAX
Show-HPOVUserSession [<CommonParameters>]

This cmdlet is decprecated as of v2.0. Please use the $ConnectedSessions Global variable for appliance session information.
### Parameters <CommonParameters> This cmdlet supports the common parameters: Verbose, Debug, ErrorAction,
ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see
### Input Types None. None ### Return Values None. None ### Examples ### Related Links ***
Top
Start-HPOVLibraryTrace

Start HPOV Library Verbose Trace.
SYNTAX
Start-HPOVLibraryTrace[ [-Location] <String>] [<CommonParameters>]
This Cmdlet is deprecated. Please use Get-HPOVCommandTrace.
Parameters
-Location <String>
Location where to store the log file.
Aliases None
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Stop-HPOVLibraryTrace
Transcript stopped, output file is C:\Users\Administrator\1604251128_HPOV_transcript.trace ### Related Links * [Stop-

HPOVLibraryTrace](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Stop-HPOVLibraryTrace) ***
Top
### HPE OneView 4.00 Library ## Start-HPOVLibraryTrace
Start HPOV Library Verbose Trace. ### SYNTAX
Start-HPOVLibraryTrace[ [-Location] <String>] [<CommonParameters>]
Parameters
-Location <String>
Location where to store the log file.
Aliases None
Required? false
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
None
Examples
-------------------------- EXAMPLE 1 --------------------------
Transcript stopped, output file is C:\Users\Administrator\1604251128_HPOV_transcript.trace
Related Links
Top

Begin Remote Support collection from endpoints.
SYNTAX
Start-HPOVRemoteSupportCollection [-InputObject] <Object> [-Type] <Object>[ [-ApplianceConnection] <Object>][ [-
Async] <SwitchParameter>] [<CommonParameters>]
Use this Cmdlet to initiate colleciton of remote support data. This will help send collection reports back to HPE that are in
between the default scheduled task.
Parameters
Aliases Appliance
Required? false
Position? 2
Aliases None
Required? false
Position? named
Default value False
A supported Gen8 or newer compute, HPE BladeSystem enclosure, or HPE Synergy frame.
Aliases None
Required? true
Position? 0
Default value
-Type <Object>
Used to specify the type of remote support collection to start. Allowed values are:
* AHS - Active Health Service collection

* Basic - Basic server configuration collection
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod-Sql-01 | Start-HPOVRemoteSupportCollection -Type AHS
Start the collection of AHS logs immediately for the specified server.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVEnclosure | Start-HPOVRemoteSupportCollection -Type Basic
Start the collection of basic server configuration immediately. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Start-HPOVRemoteSupportCollection
Begin Remote Support collection from endpoints. ### SYNTAX
Start-HPOVRemoteSupportCollection [-InputObject] <Object> [-Type] <Object>[ [-ApplianceConnection] <Object>][ [-

Async] <SwitchParameter>] [<CommonParameters>]
Use this Cmdlet to initiate colleciton of remote support data. This will help send collection reports back to HPE that are in
between the default scheduled task.
Parameters
Aliases Appliance
Required? false
Position? 2
Aliases None
Required? false
Position? named
Default value False
A supported Gen8 or newer compute, HPE BladeSystem enclosure, or HPE Synergy frame.
Aliases None
Required? true
Position? 0
Default value
-Type <Object>
Used to specify the type of remote support collection to start. Allowed values are:
* AHS - Active Health Service collection

* Basic - Basic server configuration collection
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod-Sql-01 | Start-HPOVRemoteSupportCollection -Type AHS
Start the collection of AHS logs immediately for the specified server.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVEnclosure | Start-HPOVRemoteSupportCollection -Type Basic
Start the collection of basic server configuration immediately.
Related Links
Top
Start-HPOVServer

Start-HPOVServer
Power on Server Resource.
SYNTAX
Start-HPOVServer [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>] [<CommonPa
rameters>]
Start the power state of the server using the virtual power button.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases None
Required? false
Position? named
Default value False
Aliases [-Server]
Aliases Server
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Start-HPOVServer
Power on the specific server device by passing the Server Object via pipeline.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer "Encl1, *" | Start-HPOVServer -Async
Power on the server devices found by passing the Server Object via pipeline, and return the async task immediately.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServerProfile "MyWebServer 1" | Start-HPOVServer
Power on the specific server device by passing the Server Profile Object via pipeline. ### Related Links * [Add-HPOVServer]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVServer) * [Convert-HPOVServerProfile]
[Stop-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Stop-HPOVServer) * [Update-HPOVServer]
Top
### HPE OneView 4.00 Library ## Start-HPOVServer
Power on Server Resource. ### SYNTAX
Start-HPOVServer [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Async] <SwitchParameter>] [<CommonPa

rameters>]
Start the power state of the server using the virtual power button.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases None
Required? false
Position? named
Default value False
Aliases [-Server]
Aliases Server
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Start-HPOVServer
Power on the specific server device by passing the Server Object via pipeline.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServer "Encl1, *" | Start-HPOVServer -Async
Power on the server devices found by passing the Server Object via pipeline, and return the async task immediately.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServerProfile "MyWebServer 1" | Start-HPOVServer
Power on the specific server device by passing the Server Profile Object via pipeline.
Related Links
Add-HPOVServer
Get-HPOVServer
Remove-HPOVServer
Restart-HPOVServer
Set-HPOVServerPower
Stop-HPOVServer
Update-HPOVServer
Top
Stop-HPOVAppliance

Stop-HPOVAppliance
Stop an HPE OneView appliance.
SYNTAX
Stop-HPOVAppliance [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [
<CommonParameters>]
This cmdlet will allow the administrator to stop/shutdown the appliance. Shutdown of the appliance will cause all users to be
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Connected Appliance Session
Return Values
System.String
Examples
-------------------------- EXAMPLE 1 --------------------------

Stop-HPOVAppliance
Shutdown the appliance.

-------------------------- EXAMPLE 2 --------------------------
Stop-HPOVAppliance -confirm:$false
Shutdown all connected appliances, disable confirmation. ### Related Links * [Add-HPOVApplianceTrustedCertificate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVApplianceTrustedCertificate) * [Disable-
HPOVApplianceComplexPasswords](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVApplianceComplexPasswords) * [Disable-HPOVApplianceServiceConsoleAccess]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVApplianceServiceConsoleAccess) * [Disable-
HPOVApplianceSshAccess](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVApplianceSshAccess) *
[Disable-HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-
HPOVApplianceTwoFactorAuthentication) * [Enable-HPOVApplianceComplexPasswords]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-HPOVApplianceComplexPasswords) * [Enable-
HPOVApplianceServiceConsoleAccess](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-
HPOVApplianceServiceConsoleAccess) * [Enable-HPOVApplianceSshAccess](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Enable-HPOVApplianceSshAccess) * [Get-HPOVApplianceAvailableSecurityMode]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceAvailableSecurityMode) * [Get-
HPOVApplianceCertificateStatus](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceCertificateStatus) * [Get-HPOVApplianceCurrentSecurityMode](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceCurrentSecurityMode) * [Get-HPOVApplianceDateTime]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceDateTime) * [Get-HPOVApplianceGlobalSetting]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceGlobalSetting) * [Get-
HPOVApplianceNetworkConfig](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceNetworkConfig) *
[Get-HPOVApplianceProxy](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceProxy) * [Get-
HPOVApplianceSecurityProtocol](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVApplianceSecurityProtocol) * [Get-HPOVApplianceSnmpV3EngineId](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceSnmpV3EngineId) * [Get-HPOVApplianceTrapDestination]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVApplianceTrapDestination) * [Get-
HPOVApplianceTrustedCertificate) * [Get-HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVApplianceTwoFactorAuthentication) * [Install-HPOVApplianceCertificate]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Install-HPOVApplianceCertificate) * [New-HPOVApplianceCsr]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVApplianceCsr) * [New-
HPOVApplianceSelfSignedCertificate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-
HPOVApplianceSelfSignedCertificate) * [New-HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/New-HPOVApplianceTrapDestination) * [Pop-HPOVAppliancePermission]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Pop-HPOVAppliancePermission) * [Push-HPOVAppliancePermission]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Push-HPOVAppliancePermission) * [Remove-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVApplianceProxy) * [Remove-
HPOVApplianceTrapDestination](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVApplianceTrapDestination) * [Remove-HPOVApplianceTrustedCertificate](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Remove-HPOVApplianceTrustedCertificate) * [Restart-HPOVAppliance]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Restart-HPOVAppliance) * [Set-HPOVApplianceCurrentSecurityMode]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceCurrentSecurityMode) * [Set-
HPOVApplianceDateTime](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceDateTime) * [Set-
HPOVApplianceDefaultConnection](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVApplianceDefaultConnection) * [Set-HPOVApplianceGlobalSetting](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Set-HPOVApplianceGlobalSetting) * [Set-HPOVApplianceNetworkConfig]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceNetworkConfig) * [Set-HPOVApplianceProxy]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceProxy) * [Set-HPOVApplianceSecurityProtocol]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVApplianceSecurityProtocol) * [Set-
HPOVApplianceTwoFactorAuthentication](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-
HPOVApplianceTwoFactorAuthentication) * [Show-HPOVApplianceSecurityModeCompatibilityReport]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Show-HPOVApplianceSecurityModeCompatibilityReport) * [Update-
HPOVApplianceTrustedAuthorityCrl](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-
HPOVApplianceTrustedAuthorityCrl) * [Wait-HPOVApplianceStart](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Wait-HPOVApplianceStart) ***
Top
### HPE OneView 4.00 Library ## Stop-HPOVAppliance
Stop an HPE OneView appliance. ### SYNTAX
Stop-HPOVAppliance [-ApplianceConnection] <Array>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [

<CommonParameters>]
This cmdlet will allow the administrator to stop/shutdown the appliance. Shutdown of the appliance will cause all users to be
Parameters
Aliases Appliance
Required? true
Position? 0
Aliases cf
Required? false
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Connected Appliance Session
Return Values
System.String
Examples
-------------------------- EXAMPLE 1 --------------------------

Stop-HPOVAppliance
Shutdown the appliance.
-------------------------- EXAMPLE 2 --------------------------
Stop-HPOVAppliance -confirm:$false
Shutdown all connected appliances, disable confirmation.
Related Links
Top


Stop HPOV Library Verbose Trace.
SYNTAX
Stop-HPOVLibraryTrace [<CommonParameters>]
Parameters
<CommonParameters>
Input Types
Return Values
System.IO.File
{filename}.trace file is generated in the location specified in the Start-HPOVLibraryTrace Cmdlet
Examples
-------------------------- EXAMPLE 1 --------------------------
Transcript stopped, output file is C:\Users\Administrator\1604251128_HPOV_transcript.trace ### Related Links * [Start-

HPOVLibraryTrace](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Start-HPOVLibraryTrace) ***
Top
### HPE OneView 4.00 Library ## Stop-HPOVLibraryTrace
Stop HPOV Library Verbose Trace. ### SYNTAX
Stop-HPOVLibraryTrace [<CommonParameters>]
Parameters
<CommonParameters>
Input Types
Return Values
System.IO.File
{filename}.trace file is generated in the location specified in the Start-HPOVLibraryTrace Cmdlet
Examples
-------------------------- EXAMPLE 1 --------------------------
Transcript stopped, output file is C:\Users\Administrator\1604251128_HPOV_transcript.trace
Related Links
Top
Stop-HPOVServer

Stop-HPOVServer
Power off Server Resource.
SYNTAX
Stop-HPOVServer [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf]
Stop-HPOVServer [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceCon

nection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Stop the power state of the server using the virtual power button. By default, the Cmdlet will request a "Momentary Press"
request to initiate a server to shutdown.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Use this parameter to request the "Press and Hold" virtual power button method, which will forcable power off a server without a
graceful shutdown.
Aliases None
Required? false
Position? named
Default value False
Aliases [-Server]
Aliases Server
Required? true
Position? named
Default value

Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer | Wait-HPOVTaskComplete
Power off the specific server device by passing the Server Object via pipeline.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile "MyWebServer 1" | Stop-HPOVServer | Wait-HPOVTaskComplete
Power off the specific server device by passing the Server Profile Object via pipeline.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer -Force | Wait-HPOVTaskComplete
Power off the specific server device by passing the Server Object via pipeline, and forcably power off. ### Related Links * [Add-
HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVServer) * [Convert-HPOVServerProfile]
[Start-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Start-HPOVServer) * [Update-HPOVServer]
Top
### HPE OneView 4.00 Library ## Stop-HPOVServer
Power off Server Resource. ### SYNTAX
Stop-HPOVServer [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf]

Stop-HPOVServer [-InputObject] <Object>[ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceCon

nection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Stop the power state of the server using the virtual power button. By default, the Cmdlet will request a 'Momentary Press'
request to initiate a server to shutdown.
Parameters

Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Use this parameter to request the 'Press and Hold' virtual power button method, which will forcable power off a server without a
graceful shutdown.
Aliases None
Required? false
Position? named
Default value False
Aliases [-Server]
Aliases Server
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer | Wait-HPOVTaskComplete
Power off the specific server device by passing the Server Object via pipeline.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile "MyWebServer 1" | Stop-HPOVServer | Wait-HPOVTaskComplete
Power off the specific server device by passing the Server Profile Object via pipeline.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer -Force | Wait-HPOVTaskComplete
Power off the specific server device by passing the Server Object via pipeline, and forcably power off.
Related Links
Add-HPOVServer
Get-HPOVServer
Remove-HPOVServer
Restart-HPOVServer
Set-HPOVServerPower
Start-HPOVServer
Update-HPOVServer
Top
Test-HPOVEmailAlert

Test-HPOVEmailAlert
Test appliance Email Alerting configuration.
SYNTAX
Test-HPOVEmailAlert [-Recipients] <Array>[ [-Subject] <String>] [-Body] <String>[ [-ApplianceConnection] <Object
This cmdlet will generate a test email message.
Parameters
Aliases Appliance
Required? false
Position? 3
-Body <String>
Provide a custom message body. Can be either a plan text or HTML message.
Aliases None
Required? fasle
Position? 2
Default value Test email message from HPE OneView appliance.

-Recipients <Array>
Specify the Sender Email Address for the appliance.
Aliases None
Required? true
Position? 0
Default value
-Subject <String>
Provide a custom subject for the email message.
Aliases None
Required? false
Position? 1
Default value This is a test message.
<CommonParameters>
Input Types
Return Values
If successful, returns an object with the test message details.
Examples
-------------------------- EXAMPLE 1 --------------------------
Test-HPOVEmailAlert -Recipients user1@contoso.com
Generate a test email message to "user1@contoso.com".

-------------------------- EXAMPLE 2 --------------------------
Test-HPOVEmailAlert -Recipients user1@contoso.com.,user2@contoso.com -Subject "This is a test email message."
Generate a test email message to multiple recipients with a custom subject. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Test-HPOVEmailAlert
Test appliance Email Alerting configuration. ### SYNTAX
Test-HPOVEmailAlert [-Recipients] <Array>[ [-Subject] <String>] [-Body] <String>[ [-ApplianceConnection] <Object

This cmdlet will generate a test email message.
Parameters
Aliases Appliance
Required? false
Position? 3
-Body <String>
Provide a custom message body. Can be either a plan text or HTML message.
Aliases None
Required? fasle
Position? 2
Default value Test email message from HPE OneView appliance.
-Recipients <Array>
Specify the Sender Email Address for the appliance.
Aliases None
Required? true
Position? 0
Default value
-Subject <String>
Provide a custom subject for the email message.
Aliases None
Required? false
Position? 1
Default value This is a test message.
<CommonParameters>
Input Types
Return Values
If successful, returns an object with the test message details.
Examples
-------------------------- EXAMPLE 1 --------------------------
Test-HPOVEmailAlert -Recipients user1@contoso.com
Generate a test email message to 'user1@contoso.com'.
-------------------------- EXAMPLE 2 --------------------------
Test-HPOVEmailAlert -Recipients user1@contoso.com.,user2@contoso.com -Subject "This is a test email message."
Generate a test email message to multiple recipients with a custom subject.
Related Links
Top

Update appliance certificate authority revocation list.
SYNTAX
Update-HPOVApplianceTrustedAuthorityCrl [-InputObject] <HPOneView.Appliance.TrustedCertificateAuthority[]>[ [-As
ync] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Update-HPOVApplianceTrustedAuthorityCrl [-InputObject] <HPOneView.Appliance.TrustedCertificateAuthority[]> [-Pat

h] <FileInfo>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
in the trust store and for certificates received during communication with a managed device or external server. Certificate
revocation checks are enabled by default. However, if a matching CRL has not been imported for a CA-issued certificate, or if a
CRL has expired, the appliance bypasses the revocation check for the associated certificate when performing an HTTPS
connection. If you want to restrict (or relax) revocation checking, use the options below on the edit screen.
The Cmdlet will attempt to download the CRL from the HTTP location specified within the TrustedCertificateAuthority object. You
can manually download the updated CRL and use the -Path paramter to specify the offline CRL.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
-InputObject <HPOneView.Appliance.TrustedCertificateAuthority[]>
HPOneView.Appliance.TrustedCertificateAuthority resource from Get-HPOVApplianceTrustedCertificate.
Aliases None
Required? true
Position? named
Default value
-Path <FileInfo>
Path to manually downloaded CRL.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
resource from Get-HPOVApplianceTrustedCertificate.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVApplianceTrustedCertificate -Name "VeriSign Class 3 Public Primary Certification Authority - G5" | Updat
e-HPOVApplianceTrustedAuthorityCrl
Update the built-in certificate authority resource.

-------------------------- EXAMPLE 2 --------------------------
# Download CA CRL for offline use

$CA = Get-HPOVApplianceTrustedCertificate -CertificateAuthoritiesOnly -Name "DigiCert Global CA G2"
Invoke-WebRequest -Uri $CA.CRLInfo.EndPointList[0] -OutFile C:\Directory\CA-updated.crl
# Copy offline CRL to other PC

Get-HPOVApplianceTrustedCertificate -CertificateAuthoritiesOnly -Name "DigiCert Global CA G2" | Update-HPOVAppli
anceTrustedAuthorityCrl -Path C:\Directory\CA-updated.crl
Update the built-in certificate authority resource. ### Related Links ***
Top
### HPE OneView 4.00 Library ## Update-HPOVApplianceTrustedAuthorityCrl
Update appliance certificate authority revocation list. ### SYNTAX
Update-HPOVApplianceTrustedAuthorityCrl [-InputObject] <HPOneView.Appliance.TrustedCertificateAuthority[]>[ [-As

ync] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Update-HPOVApplianceTrustedAuthorityCrl [-InputObject] <HPOneView.Appliance.TrustedCertificateAuthority[]> [-Pat

h] <FileInfo>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
in the trust store and for certificates received during communication with a managed device or external server. Certificate
revocation checks are enabled by default. However, if a matching CRL has not been imported for a CA-issued certificate, or if a
CRL has expired, the appliance bypasses the revocation check for the associated certificate when performing an HTTPS
connection. If you want to restrict (or relax) revocation checking, use the options below on the edit screen.
The Cmdlet will attempt to download the CRL from the HTTP location specified within the TrustedCertificateAuthority object. You
can manually download the updated CRL and use the -Path paramter to specify the offline CRL.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
-InputObject <HPOneView.Appliance.TrustedCertificateAuthority[]>
HPOneView.Appliance.TrustedCertificateAuthority resource from Get-HPOVApplianceTrustedCertificate.
Aliases None
Required? true
Position? named
Default value
-Path <FileInfo>
Path to manually downloaded CRL.
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
Input Types
resource from Get-HPOVApplianceTrustedCertificate.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVApplianceTrustedCertificate -Name "VeriSign Class 3 Public Primary Certification Authority - G5" | Updat
e-HPOVApplianceTrustedAuthorityCrl

-------------------------- EXAMPLE 2 --------------------------
Download CA CRL for offline use

$CA = Get-HPOVApplianceTrustedCertificate -CertificateAuthoritiesOnly -Name "DigiCert Global CA G2"
Invoke-WebRequest -Uri $CA.CRLInfo.EndPointList[0] -OutFile C:\Directory\CA-updated.crl
Copy offline CRL to other PC

Get-HPOVApplianceTrustedCertificate -CertificateAuthoritiesOnly -Name "DigiCert Global CA G2" | Update-HPOVAppli
anceTrustedAuthorityCrl -Path C:\Directory\CA-updated.crl
Related Links
Top

Update or Refresh an enclosure.
SYNTAX
Update-HPOVEnclosure[ [-Refresh] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array> [-Hos
tname] <String> [-Username] <String> [-Password] <String>[ [-Credential] <PSCredential>][ [-Async] <SwitchParame
Update-HPOVEnclosure[ [-Reapply] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-As

ync] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This cmdlet will update or refresh an enclosure. An Enclosure Refresh will instruct HPE OneView to go inventory the enclosure
and update any missing management configurations.
Use the -Refresh switch for scenarios where adding an enclosure results in a warning or critical error when a BL server cannot
be managed due to an existing _HPOneViewAdmin account that cannot be reset or too many HP SSO Certificates are
configured (iLO supports no more than 5) and you have manually cleared the HP SSO list and/or removed the
_HPOneViewAdmin account.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Hostname <String>
When an Enclosure is in an Error state where the Primary Onboard Administrator IP Address changed, or the HPE OneView
managed configuration is no longer present, you will need to provide the IP Address or FQDN of one of the Onboard
Administrators in the target enclosure. You will be prompted for this value if needed.
Aliases None
Required? true
Position? named
Default value
Aliases [-Enclosure] Provide the Enclosure name or Object, or [System.Collections.ArrayList] of names or Objects to
refresh/update.
Aliases Enclosure
Required? true
Position? named
Default value
-Password <String>
Provide the password of the Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an
error state and the HPE OneView managed configuration is no longer present. You will be prompted for this value if needed.
Aliases None
Required? true
Position? named
Default value
-Reapply <SwitchParameter>
Reapply the Enclosure Configuration.
Aliases None
Required? false
Position? named
Default value False
-Refresh <SwitchParameter>
Refresh the enclosure to fix configuration issues.

Aliases None
Required? false
Position? named
Default value False
-Username <String>
Provide the Username of an Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Enclosure resource
Multiple Enclosure resources
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosure | Update-HPOVEnclosure -Refresh
Refresh all available enclosures, from all connected sessions.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVEnclosure -Name Enclosure1 | Update-HPOVEnclosure -Refresh
Refresh "Enclosure1" enclosure.

-------------------------- EXAMPLE 3 --------------------------
$TaskResourceToMonitor = Get-HPOVEnclosure -Name Enclosure1 | Update-HPOVEnclosure -Refresh -Hostname UpdatedOAF

QDN.domain.local -Username Administrator -Password MyOAPassw0rd -Async
Refresh "Enclosure1" enclosure, supplying the updated OA FQDN and administrator credentials ### Related Links * [Add-
HPOVEnclosure](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVEnclosure) * [Get-HPOVEnclosure]
Top
### HPE OneView 4.00 Library ## Update-HPOVEnclosure
Update or Refresh an enclosure. ### SYNTAX
Update-HPOVEnclosure[ [-Refresh] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array> [-Hos

tname] <String> [-Username] <String> [-Password] <String>[ [-Credential] <PSCredential>][ [-Async] <SwitchParame
Update-HPOVEnclosure[ [-Reapply] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array>[ [-As

ync] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This cmdlet will update or refresh an enclosure. An Enclosure Refresh will instruct HPE OneView to go inventory the enclosure
and update any missing management configurations.
Parameters

Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases None
Required? False
Position? named
Default value
-Hostname <String>
When an Enclosure is in an Error state where the Primary Onboard Administrator IP Address changed, or the HPE OneView
managed configuration is no longer present, you will need to provide the IP Address or FQDN of one of the Onboard
Administrators in the target enclosure. You will be prompted for this value if needed.
Aliases None
Required? true
Position? named
Default value
Aliases [-Enclosure] Provide the Enclosure name or Object, or [System.Collections.ArrayList] of names or Objects to
refresh/update.
Aliases Enclosure
Required? true
Position? named
Default value
-Password <String>
Provide the password of the Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an
Aliases None
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
-Refresh <SwitchParameter>
Refresh the enclosure to fix configuration issues.
Aliases None
Required? false
Position? named
Default value False
-Username <String>
Provide the Username of an Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an
Aliases None
Required? true
Position? named
Default value
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Enclosure resource
Multiple Enclosure resources
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVEnclosure | Update-HPOVEnclosure -Refresh
Refresh all available enclosures, from all connected sessions.

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVEnclosure -Name Enclosure1 | Update-HPOVEnclosure -Refresh
Refresh 'Enclosure1' enclosure.
-------------------------- EXAMPLE 3 --------------------------
$TaskResourceToMonitor = Get-HPOVEnclosure -Name Enclosure1 | Update-HPOVEnclosure -Refresh -Hostname UpdatedOAF

QDN.domain.local -Username Administrator -Password MyOAPassw0rd -Async
Refresh 'Enclosure1' enclosure, supplying the updated OA FQDN and administrator credentials
Related Links
Add-HPOVEnclosure
Get-HPOVEnclosure
Set-HPOVEnclosure
Top

Refresh an existing external baseline repository.
SYNTAX
Update-HPOVExternalRepository [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-WhatIf] <> [-Confirm] <> [<
CommonParameters>]
Update-HPOVExternalRepository[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
* Apache
This Cmdlet supports refreshing an existing external repository. Use this Cmdlet to refresh the details(advertized repo size) and
contents of an external repository.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Provide the external repository object to refresh.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Update-HPOVExternalRepository
Refresh an existing external repository. ### Related Links * [New-HPOVExternalRepository]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVExternalRepository) * [Remove-HPOVExternalRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVExternalRepository) * [Set-HPOVExternalRepository]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVExternalRepository) ***
Top
### HPE OneView 4.00 Library ## Update-HPOVExternalRepository
Refresh an existing external baseline repository. ### SYNTAX

Update-HPOVExternalRepository [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-WhatIf] <> [-Confirm] <> [<
CommonParameters>]
Update-HPOVExternalRepository[ [-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
* Apache
This Cmdlet supports refreshing an existing external repository. Use this Cmdlet to refresh the details(advertized repo size) and
contents of an external repository.
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
Provide the external repository object to refresh.
Aliases None
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Update-HPOVExternalRepository

Refresh an existing external repository.
Related Links
Top

Update or Refresh a Logical Enclosure.
SYNTAX
Update-HPOVLogicalEnclosure[ [-Reapply] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array
>[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Update-HPOVLogicalEnclosure[ [-Update] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array>

[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This cmdlet will update or refresh a Logical Enclosure. A Refresh will instruct HPE OneView to go inventory the enclosure and
update any missing management configurations. An Update will perform Logical Enclosure compliance remediation with the
parent Enclosure Group.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases [-le, -LogicalEnclosure]
Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to
refresh/update.
Aliases le, LogicalEnclosure
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False

-Update <SwitchParameter>
Aliases [-UpdateFromEG]
Useing this switch will update the Logical Enclosure to be compliant with the Parent Enclosure Group. Can be combined with the
-WhatIf parameter to perform a Compare with group and return object with differences.
Aliases UpdateFromGroup
Required? false
Position? named
Default value False
Use this parameter to identify what is different or changed from the parent group policy.
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
HPOneView.Library.CompareObject
The Cmdlet will return a compare object with the Parent and Child object and settings that are different. Otherwise, no object is
returned.
Property Name | Description
==========================================================
InputObject | Compared Object Property or Setting Value
----------------------------------------------------------
ParentSetting | Name of Property or Setting
----------------------------------------------------------
ChildSetting | Name of Property or Setting
----------------------------------------------------------
Parent | Name of Parent Object
----------------------------------------------------------
Child | Name of Child Object
----------------------------------------------------------
Description | Description Name of difference
----------------------------------------------------------
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalEnclosure | Update-HPOVLogicalEnclosure -Refresh
Refresh all available Logical Enclosures, for the default connected session.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalEnclosure -ApplianceConnect $ConnectedSessions | Update-HPOVLogicalEnclosure -Update
Refresh all available Logical Enclosures, for the all connected sessions.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVLogicalEnclosure -Name LogicalEnclosure1 | Update-HPOVLogicalEnclosure -Refresh
Refresh "LogicalEnclosure1" Logical Enclosure.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalEnclosure -Name Encl1 | Update-HPOVLogicalEnclosure -Update -WhatIf

What if: Performing the operation "Update Logical Enclosure configuration. WARNING: Depending on this action, th
ere might be a brief outage." on target "Encl1".
InputObject SideIndicator ParentSetting ChildSetting Parent Child D

escription
----------- ------------- ------------- ------------ ------ ----- -
----------
macRefreshInterval <=> 7 5 Default VC FF LIG Encl1-Default VC FF LIG S
ETTING_MISMATCH
enablePauseFloodProtection <=> False True Default VC FF LIG Encl1-Default VC FF LIG S
ETTING_MISMATCH
enableRichTLV <=> True False Default VC FF LIG Encl1-Default VC FF LIG S
ETTING_MISMATCH
enableTaggedLldp <=> True False Default VC FF LIG Encl1-Default VC FF LIG S
ETTING_MISMATCH
ActiveQosConfig <= CustomWithFCoE Passthrough Default VC FF LIG Encl1-Default VC FF LIG S
ETTING_MISMATCH
Uplink Set 2 <= Heartbeat Default VC FF LIG Encl1-Default VC FF LIG M
ISSING_NETWORK
FC Fabric B => Bay2:X8 Default VC FF LIG Encl1-Default VC FF LIG A
DDITIONAL_UPLINKPORT
FC Fabric B:Bay2:X7 <=> Auto 2Gb Default VC FF LIG Encl1-Default VC FF LIG L
INKSPEED_MISMATCH
UplinkSets <= New Uplink Set Default VC FF LIG Encl1-Default VC FF LIG M
ISSING_UPLINKSET
InternalNetworks => Heartbeat Default VC FF LIG Encl1-Default VC FF LIG E
XTRA_NETWORK
InternalNetworks <= Dev VLAN 103-A Default VC FF LIG Encl1-Default VC FF LIG M
ISSING_NETWORK
Refresh "LogicalEnclosure1" Logical Enclosure. ### Related Links * [Get-HPOVLogicalEnclosure]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalEnclosure) * [Remove-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalEnclosure) * [Set-HPOVLogicalEnclosure]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVLogicalEnclosure) * [Update-
Top
### HPE OneView 4.00 Library ## Update-HPOVLogicalEnclosure
Update or Refresh a Logical Enclosure. ### SYNTAX
Update-HPOVLogicalEnclosure[ [-Reapply] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array

>[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Update-HPOVLogicalEnclosure[ [-Update] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Array>

[ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
This cmdlet will update or refresh a Logical Enclosure. A Refresh will instruct HPE OneView to go inventory the enclosure and
update any missing management configurations. An Update will perform Logical Enclosure compliance remediation with the
parent Enclosure Group.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
Aliases [-le, -LogicalEnclosure]
Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to
refresh/update.
Required? true
Position? named
Default value
Aliases None
Required? false
Position? named
Default value False
-Update <SwitchParameter>
Aliases [-UpdateFromEG]
Useing this switch will update the Logical Enclosure to be compliant with the Parent Enclosure Group. Can be combined with the
-WhatIf parameter to perform a Compare with group and return object with differences.
Aliases UpdateFromGroup
Required? false
Position? named
Default value False
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
returned.
==========================================================
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalEnclosure | Update-HPOVLogicalEnclosure -Refresh
Refresh all available Logical Enclosures, for the default connected session.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalEnclosure -ApplianceConnect $ConnectedSessions | Update-HPOVLogicalEnclosure -Update
Refresh all available Logical Enclosures, for the all connected sessions.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVLogicalEnclosure -Name LogicalEnclosure1 | Update-HPOVLogicalEnclosure -Refresh
Refresh 'LogicalEnclosure1' Logical Enclosure.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalEnclosure -Name Encl1 | Update-HPOVLogicalEnclosure -Update -WhatIf

What if: Performing the operation "Update Logical Enclosure configuration. WARNING: Depending on this action, th
ere might be a brief outage." on target "Encl1".

escription

ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ISSING_NETWORK
INKSPEED_MISMATCH
ISSING_UPLINKSET
XTRA_NETWORK
ISSING_NETWORK
Related Links
Top
Update-HPOVLogicalEnclosureFirmware

Update-HPOVLogicalEnclosureFirmware
Initiate Logical Enclosure Firmware update.
SYNTAX
Update-HPOVLogicalEnclosureFirmware [-InputObject] <Object> [-Baseline] <HPOneView.Appliance.Baseline> [-Firmwar
eUpdateProcess] <String>[ [-InterconnectActivationMode] <String>][ [-ForceInstallation] <SwitchParameter>][ [-As
ync] <SwitchParameter>][ [-ApplianceConnection] <Array>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]
You can update firmware from a logical enclosure for shared infrastructure, shared infrastructure and profiles, and OA
(Onboard Administrators) only, if any. When you update the firmware for an enclosure associated with a logical enclosure, the
firmware baseline configured for the logical enclosure sets the baseline on the enclosure and each of the logical interconnects
in the enclosure, as well as the OA. Firmware is updated in the following order:
* Onboard Administrators
* Logical interconnects
* Server hardware and their associated server profiles
The Orchestrated activation option allows nondisruptive updates of interconnects in a production ready, properly configured,
and redundant environment. Orchestrated firmware updates do not affect the network traffic and no outages are caused while
the update process is in progress as one virtual connect module is always forwarding network traffic, with no or minimal impact
to application network connection. A default delay of 8 minutes is set between activating or rebooting interconnect modules.
Hypervisor clusters are updated nondisruptively when the orchestrated activation option is chosen. If the logical enclosure
contains one or more hypervisor profiles, each hypervisor is serially placed into a maintenance mode before updating. It can
take up to 90 minutes to place a hypervisor into the maintenance mode, perform the firmware update, and take it back out of the
maintenance mode. Parallel activation activates all the interconnect modules at the same time, resulting in disruption of the
network and storage connectivity. It is recommended to perform parallel activation during a maintenance window when you can
better coordinate the downtime. When selecting "SharedInfrastructureAndServerProfiles" firmware update process, any servers
without profiles will perform an automated offline firmware update. Assigned Server Profiles will require HPE Smart Update Tools
(HPSUT, iSUT) to be installed and available. Required Privileges: Infrastructure administrator or Server administrator
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False

-Baseline <HPOneView.Appliance.Baseline>
The firmware bundle or baseline to install.
Aliases None
Required? true
Position? named
Default value
-Confirm <>
Aliases cf
Required?
Position? named
Default value
-FirmwareUpdateProcess <String>
Specify the type of firmware update to invoke. Allowed values:
* EnclosureOnly - Will only upgrade enclosure or frame components (c-Class Onboard Administrator, Synergy Frame
Link Module)
* SharedInfrastructureOnly
* SharedInfrastructureAndServerProfiles
Aliases None
Required? true
Position? named
Default value
-ForceInstallation <SwitchParameter>
Force the re-installation or downgrade of components within the baseline.
Aliases None
Required? false
Position? named
Default value
The HPOneView.LogicalEnclosure from Get-HPOVLogicalEnclosure.
Required? true
Position? named
Default value
-InterconnectActivationMode <String>
Specify the logical interconnect activation mode. Choosing "Parallel" is the fastest update operation but will require downtime
and servers to be powered off. Allowed values:
* Orchestrated
* Parallel Default: Orchestrated
Aliases None
Required? false
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Logical enclosure resource from Get-HPOVLogicalEnclosure.

Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
$Basline = Get-HPOVBaseline -Name "HPE Service Pack for ProLiant" -ErrorAction Stop Get-HPOVLogicalEnclosure -Na
me Encl1 -ErrorAction Stop | Update-HPOVLogicalEnclosureFirmware -Baseline $Basline -FirmwareUpdateProcess Share
dInfrastructureOnly
Get the specified baseline, and update the specified logical enclosure's shared infrastructure only.
Related Links
Top

Updates a Logical Interconnect.
SYNTAX
Update-HPOVLogicalInterconnect [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParamet
Update-HPOVLogicalInterconnect[ [-Reapply] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Ob

ject>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
When a Logical Interconnect is inconsistent with its parent Logical Interconnect Group, it can be made consistent with this
CMDLET. Updating the Logical Interconnect with its parent could cause an network outage depending on the changes about to
be applied.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Required? true
Position? named
Default value
Switch to reapply the Logical Interconnect configuration. This does NOT update the Logical Interconnect from the parent Logical
Interconnect Group.
Aliases None
Required? false
Position? named
Default value False
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Logical Interconnect resource object
System.Collections.ArrayList <HPOneView.Networking.LogicalInterconnect>
Collection of Logical Interconnect Names, URIs or System.Management.Automation.PSCustomObject
Return Values
Single async Update Task
Multiple async Update Tasks
returned.

==========================================================
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Update-HPOVLogicalInterconnect -name Encl1-LI

Perform an update of the Encl1-LI Logical Interconnect. Will be prompted for confirmation.
-------------------------- EXAMPLE 2 --------------------------
$task = Update-HPOVLogicalInterconnect -name Encl1-LI -confirm:$false | Wait-HPOVTaskComplete

Perform an update of the Encl1-LI Logical Interconnect. Disable confirmation prompt.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVLogicalInterconnect | Update-HPOVLogicalInterconnect
Search for all Logical Interconnects and update them.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalInterconnect -Name Encl1-Default VC FF LIG | Update-HPOVLogicalInterconnect -WhatIf

What if: Performing the operation "Update Logical Interconnect from Group "Default VC FF LIG". WARNING: Dependin
g on the Update, there might be a brief outage." on target "Encl1-Default VC FF LIG".

escription
----------- ------------- ------------- ------------ ------ ----- -
----------
ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ISSING_NETWORK
INKSPEED_MISMATCH
ISSING_UPLINKSET
XTRA_NETWORK
ISSING_NETWORK
Refresh "LogicalEnclosure1" Logical Enclosure. ### Related Links * [Disable-HPOVLogicalInterconnectPortMonitoring]

(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Disable-HPOVLogicalInterconnectPortMonitoring) * [Enable-
HPOVLogicalInterconnectPortMonitoring](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Enable-
HPOVLogicalInterconnectPortMonitoring) * [Get-HPOVLogicalInterconnect](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Get-HPOVLogicalInterconnect) * [Get-HPOVLogicalInterconnectGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalInterconnectGroup) * [Get-
HPOVLogicalInterconnectPortMonitoring](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-
HPOVLogicalInterconnectPortMonitoring) * [Install-HPOVLogicalInterconnectFirmware](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Install-HPOVLogicalInterconnectFirmware) * [New-HPOVLogicalInterconnectGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalInterconnectGroup) * [Remove-
HPOVLogicalInterconnectGroup](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-
HPOVLogicalInterconnectGroup) * [Show-HPOVLogicalInterconnectMacTable](https://github.com/HewlettPackard/POSH-
HPOneView/wiki/Show-HPOVLogicalInterconnectMacTable) ***
Top
### HPE OneView 4.00 Library ## Update-HPOVLogicalInterconnect
Updates a Logical Interconnect. ### SYNTAX
Update-HPOVLogicalInterconnect [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParamet

Update-HPOVLogicalInterconnect[ [-Reapply] <SwitchParameter>] [-InputObject] <Object> [-ApplianceConnection] <Ob

ject>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
When a Logical Interconnect is inconsistent with its parent Logical Interconnect Group, it can be made consistent with this
CMDLET. Updating the Logical Interconnect with its parent could cause an network outage depending on the changes about to
be applied.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases cf
Required? false
Position? named
Default value
Required? true
Position? named
Default value
Switch to reapply the Logical Interconnect configuration. This does NOT update the Logical Interconnect from the parent Logical
Interconnect Group.
Aliases None
Required? false
Position? named
Default value False
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Logical Interconnect resource object
System.Collections.ArrayList <HPOneView.Networking.LogicalInterconnect>
Collection of Logical Interconnect Names, URIs or System.Management.Automation.PSCustomObject
Return Values
Single async Update Task
Multiple async Update Tasks
returned.
==========================================================
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
----------------------------------------------------------
Examples
-------------------------- EXAMPLE 1 --------------------------
$task = Update-HPOVLogicalInterconnect -name Encl1-LI

Perform an update of the Encl1-LI Logical Interconnect. Will be prompted for confirmation.
-------------------------- EXAMPLE 2 --------------------------
$task = Update-HPOVLogicalInterconnect -name Encl1-LI -confirm:$false | Wait-HPOVTaskComplete
Perform an update of the Encl1-LI Logical Interconnect. Disable confirmation prompt.
-------------------------- EXAMPLE 3 --------------------------
Get-HPOVLogicalInterconnect | Update-HPOVLogicalInterconnect
Search for all Logical Interconnects and update them.

-------------------------- EXAMPLE 4 --------------------------
Get-HPOVLogicalInterconnect -Name Encl1-Default VC FF LIG | Update-HPOVLogicalInterconnect -WhatIf

What if: Performing the operation "Update Logical Interconnect from Group 'Default VC FF LIG'. WARNING: Dependin
g on the Update, there might be a brief outage." on target "Encl1-Default VC FF LIG".

escription

ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ETTING_MISMATCH
ISSING_NETWORK
INKSPEED_MISMATCH
ISSING_UPLINKSET
XTRA_NETWORK
ISSING_NETWORK
Related Links
Top
Refresh a new Logical Switch resource.
SYNTAX
Update-HPOVLogicalSwitch [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>]
[-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
A logical switch is based on a logical switch group configuration. If the logical switch transitions to an "Inconsistent with group
state", due to changes in either the logical switch or the logical switch group, this Cmdlet will update (or refresh) the logical
switch configuration based on the logical switch group and return to a consistent state. Required privileges: Infrastructure
administrator or Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value

Aliases cf
Required? false
Position? named
Default value
Aliases LS, LogicalSwitch
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Collection of Update Logical Switch async task resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalSwitch | Update-HPOVLogicalSwitch
Update all logical switch resources found on the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitch -Name "My Logical Switch 1" | Update-HPOVLogicalSwitch -confirm:$false
Update the "My Logical Switch 1" resource. ### Related Links * [Get-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVLogicalSwitchGroup) * [New-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitch) * [New-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVLogicalSwitchGroup) * [Remove-HPOVLogicalSwitch]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitch) * [Remove-HPOVLogicalSwitchGroup]
(https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVLogicalSwitchGroup) ***
Top
### HPE OneView 4.00 Library ## Update-HPOVLogicalSwitch
Refresh a new Logical Switch resource. ### SYNTAX
Update-HPOVLogicalSwitch [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>]

[-WhatIf] <>[ [-Confirm] <SwitchParameter>] [<CommonParameters>]
A logical switch is based on a logical switch group configuration. If the logical switch transitions to an "Inconsistent with group
state", due to changes in either the logical switch or the logical switch group, this Cmdlet will update (or refresh) the logical
switch configuration based on the logical switch group and return to a consistent state. Required privileges: Infrastructure
administrator or Network administrator
Parameters
Aliases Appliance
Required? false
Position? named
Aliases None
Required? false
Position? named
Default value
Aliases cf
Required? false
Position? named
Default value
Aliases LS, LogicalSwitch
Required? true
Position? named
Default value
-WhatIf <>
Aliases wi
Required?
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Collection of Update Logical Switch async task resources.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVLogicalSwitch | Update-HPOVLogicalSwitch
Update all logical switch resources found on the default appliance connection.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVLogicalSwitch -Name "My Logical Switch 1" | Update-HPOVLogicalSwitch -confirm:$false
Update the "My Logical Switch 1" resource.
Related Links
Top

Refresh or reconnect a rack manager resource.
SYNTAX
Update-HPOVRackManager [-InputObject] <HPOneView.Servers.RackManager[]>[ [-Force] <SwitchParameter>][ [-Async] <
SwitchParameter>][ [-ApplianceConnection] <Array>] [<CommonParameters>]
Update-HPOVRackManager [-InputObject] <HPOneView.Servers.RackManager[]> [-Hostname] <String>[ [-Credential] <PSC

redential>][ [-Force] <SwitchParameter>][ [-Async] <SwitchParameter>] [<CommonParameters>]
Update-HPOVRackManager[ [-ApplianceConnection] <Array>] [<CommonParameters>]
manager platforms within a rack. This Cmdlet will perform a refresh of the claimed rack manager. If there is a communication
issue, the -Hostname and -Crednetial parameters will need to be provided, which will then re-establish communication to the
rack manager. Minimum required privileges: Infrastructure administrator or Server administrator.
Parameters
Aliases Appliance
Required? False
Position? named
Aliases None
Required? False
Position? named
Default value False
Aliases None
Required? False
Position? named
Default value
Force update the resource.

Aliases None
Required? false
Position? named
Default value
-Hostname <String>
The FQDN or IP Address of the rack manager.
Aliases None
Required? true
Position? named
Default value
-InputObject <HPOneView.Servers.RackManager[]>
The HPOneView.Servers.RackManager resource to refresh.
Aliases name, Server
Required? true
Position? named
Default value
<CommonParameters>
Input Types
The rack manager resource from Get-HPOVRackManager.
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVRackManager -Name rackmanager1.domain.com -ErrorAction Stop | Update-HPOVRackManager
Refresh the specified rack manager resource.
-------------------------- EXAMPLE 2 --------------------------
$RackManager = Get-HPOVRackManager -Name rackmanager1.domain.com -ErrorAction Stop $Credential = Get-Credential

Administrator -Message "Password" $RefreshParams = @{ InputObject = $RackManager}
Check the rack manager for its state and refresh sta
te reason if ($RackManager.State -eq 'Unmanaged' -an
d $RackManager.RefreshState -eq 'RefreshFailed') {
# Add the "Credential" parameter to the Hashtable
splat $RackManager.Add("Credential", $Credentia
l)
# Add the Hostname to the Hashtable splat $RackManager.Add("Hostname", $RackManager.SubResources.Manager

s[0].Hostname) } Update-HPOVRackManager @RefreshParams</pre>
Refresh the specified rack manager resource, and provide the credentials to restablish.
Related Links
Add-HPOVRackManager
Get-HPOVRackManager
Top


Refresh Remote Support entitlement for a supported resource.
SYNTAX
Update-HPOVRemoteSupportEntitlement [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnectio

n] <Object> [<CommonParameters>]
This Cmdlet will initiate a refresh of the Remote Support entitlement for a compute or enclosure resource. If r
emote support has not been globally enabled and configured on the appliance, this Cmdlet will fail.
Parameters
Aliases Appliance
Required? true
Position? named

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to compl
ete.
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? true
Position? named
Default value
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVa
riable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://g
o.microsoft.com/fwlink/?LinkID=113216)
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Update-HPOVRemoteSupportEntitlement
Get the servers with their name matching "Prod" and refresh their Remote Support entitlement.
-------------------------- EXAMPLE 2 --------------------------

Update-HPOVRemoteSupportEntitlement -InputObject $Enclusre
Get the specific enclosure reousrce and refresh Remote Support entitlement.
### Related Links
* [Get-HPOVRemoteSupportEntitlementStatus](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVRemoteS
upportEntitlementStatus)
***
Top
### HPE OneView 4.00 Library
## Update-HPOVRemoteSupportEntitlement
Refresh Remote Support entitlement for a supported resource.
### SYNTAX
Update-HPOVRemoteSupportEntitlement [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnectio

n] <Object> [<CommonParameters>]
This Cmdlet will initiate a refresh of the Remote Support entitlement for a compute or enclosure resource. If r
emote support has not been globally enabled and configured on the appliance, this Cmdlet will fail.
Parameters
Aliases Appliance
Required? true
Position? named
ete.
Aliases None
Required? false
Position? named
Default value False
Aliases None
Required? true
Position? named
Default value

<CommonParameters>
Input Types
Return Values
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer -Name Prod* | Update-HPOVRemoteSupportEntitlement
Get the servers with their name matching 'Prod' and refresh their Remote Support entitlement.
-------------------------- EXAMPLE 2 --------------------------

Update-HPOVRemoteSupportEntitlement -InputObject $Enclusre
Get the specific enclosure reousrce and refresh Remote Support entitlement.
Related Links
Top

Refresh SAN Manager and it"s configuration.
SYNTAX
Update-HPOVSanManager [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet is used to refresh a SAN Managers configuration. You can provide the Name or Object of a single or
multiple SAN Managers.
Parameters
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is pr
ovided via Pipeline, the ApplianceConnection property of the object will be used.
Aliases Appliance
Required? true
Position? 1
Aliases [-SanManager]
Managed SAN Object to update.
Aliases Name, SANManager
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
SAN Manager resource object from Get-HPOVSanManager
Multiple SAN Manager resource objects from Get-HPOVSanManager
Return Values
Return Values
Async Task to update SAN Manager
Single or Multiple Resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSanManager -name bna.contoso.com | Update-HPOVSanManager | Wait-HPOVTaskComplete
Refreshes the SAN Manager.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSanManager | Update-HPOVSanManager | Wait-HPOVTaskComplete
Refreshes all SAN Managers on the appliance.
### Related Links
* [Add-HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVSanManager)
* [Get-HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSanManager)
* [Remove-HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVSanManager)
* [Set-HPOVSanManager](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVSanManager)
***
Top
## Update-HPOVSanManager
Refresh SAN Manager and it's configuration.
### SYNTAX
Update-HPOVSanManager [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet is used to refresh a SAN Managers configuration. You can provide the Name or Object of a single or
multiple SAN Managers.
Parameters
Aliases Appliance
Required? true
Position? 1
Aliases [-SanManager]
Managed SAN Object to update.
Aliases Name, SANManager
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
SAN Manager resource object from Get-HPOVSanManager
Multiple SAN Manager resource objects from Get-HPOVSanManager
Return Values
Async Task to update SAN Manager
Single or Multiple Resources
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVSanManager -name bna.contoso.com | Update-HPOVSanManager | Wait-HPOVTaskComplete
Refreshes the SAN Manager.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVSanManager | Update-HPOVSanManager | Wait-HPOVTaskComplete
Refreshes all SAN Managers on the appliance.
Related Links
Add-HPOVSanManager
Get-HPOVSanManager
Set-HPOVSanManager
Top
Update-HPOVServer

Update-HPOVServer
Refresh the state of a server resource.
SYNTAX
Update-HPOVServer [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<Comm

onParameters>]
Update-HPOVServer [-InputObject] <Object> [-Credential] <String> [-Hostname] <String>[ [-Async] <SwitchParame

Update-HPOVServer [-ApplianceConnection] <Object> [<CommonParameters>]
By using this cmdlet, you can manually refresh the connection between the appliance and server hardware by using
the Refresh option on the Actions menu. You must refresh server hardware if it has lost connectivity or if it i
s not synchronized with the appliance. Connectivity loss can occur during normal appliance operation. A device c
an become unsynchronized if you make changes to it outside of the appliance
Parameters
Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pip
eline, the ApplianceConnection property of the object will be used.
Aliases Appliance
Required? true
Position? named
ete.
Aliases None
Required? false
Position? named
Default value False
Provide a PSCredential object instead of the Username and Password.
Aliases None
Required? true
Required? true
Position? named
Default value
-Hostname <String>
When a server hardware resource is in an Error state where the iLO IP Address or FQDN has changed, or the HPE On
eView managed configuration is no longer present, you will need to provide the IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
Aliases [-Name, -Server]

The Server object or Name, or can be a Server Profile object.
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Server Hardware Name

Return Values
Async task that tracks the server refresh request
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Update-HPOVServer | Wait-HPOVTaskComplete
Refresh the state of the provided server hardware device.
-------------------------- EXAMPLE 2 --------------------------
$task = Get-HPOVServerProfile "Profile1" | Update-HPOVServer
Refresh the state of the server hardware device assigned to the Server Profile object.
### Related Links
* [Add-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVServer)
* [Convert-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfile)
* [Convert-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerPr
ofileTemplate)
* [ConvertTo-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVServ
erProfileTemplate)
* [Copy-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Copy-HPOVServerProfile)
* [Get-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServer)
* [Get-HPOVServerHardwareType](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerHardwareType)
* [Get-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfile)
* [Get-HPOVServerProfileConnectionList](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProf
ileConnectionList)
* [Get-HPOVServerProfileMessage](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileMess
age)
* [Get-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileTem
plate)
* [Join-HPOVServerProfileToTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Join-HPOVServerProfil
eToTemplate)
eToTemplate)
* [New-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfile)
* [New-HPOVServerProfileAssign](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileAssig
n)
* [New-HPOVServerProfileAttachVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfil
eAttachVolume)
* [New-HPOVServerProfileConnection](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileC
onnection)
* [New-HPOVServerProfileLogicalDisk](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfile
LogicalDisk)
* [New-HPOVServerProfileLogicalDiskController](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVSer
verProfileLogicalDiskController)
* [New-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileTem
plate)
* [Remove-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServer)
* [Remove-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProfile)
* [Remove-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProf
ileTemplate)
* [Restart-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Restart-HPOVServer)
* [Save-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfile)
* [Save-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfileT
emplate)
* [Set-HPOVServerHardwareType](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerHardwareType)
* [Set-HPOVServerPower](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerPower)
* [Set-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfile)
* [Set-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfileTem
plate)
* [Start-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Start-HPOVServer)
* [Stop-HPOVServer](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Stop-HPOVServer)
* [Update-HPOVServerHardwareLicenseIntent](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServ
erHardwareLicenseIntent)
* [Update-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Update-HPOVServerProfile)
***
Top
## Update-HPOVServer
Refresh the state of a server resource.
### SYNTAX
Update-HPOVServer [-InputObject] <Object>[ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object> [<Comm

onParameters>]
Update-HPOVServer [-InputObject] <Object> [-Credential] <String> [-Hostname] <String>[ [-Async] <SwitchParame

Update-HPOVServer [-ApplianceConnection] <Object> [<CommonParameters>]
By using this cmdlet, you can manually refresh the connection between the appliance and server hardware by using
s not synchronized with the appliance. Connectivity loss can occur during normal appliance operation. A device c
an become unsynchronized if you make changes to it outside of the appliance
Parameters
Aliases Appliance
Required? true
Position? named
ete.
Aliases None
Required? false
Position? named
Default value False
Provide a PSCredential object instead of the Username and Password.
Aliases None
Required? true
Position? named
Default value
-Hostname <String>
When a server hardware resource is in an Error state where the iLO IP Address or FQDN has changed, or the HPE On
eView managed configuration is no longer present, you will need to provide the IP Address or FQDN.
Aliases None
Required? true
Position? named
Default value
Aliases [-Name, -Server]

The Server object or Name, or can be a Server Profile object.
Required? true
Position? named
Default value
<CommonParameters>
Input Types
System.String
Server Hardware Name
Return Values
Async task that tracks the server refresh request
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServer "Encl1, Bay 1" | Update-HPOVServer | Wait-HPOVTaskComplete
Refresh the state of the provided server hardware device.
-------------------------- EXAMPLE 2 --------------------------
$task = Get-HPOVServerProfile "Profile1" | Update-HPOVServer
Refresh the state of the server hardware device assigned to the Server Profile object.
Related Links
Add-HPOVServer
Get-HPOVServer
Remove-HPOVServer
Restart-HPOVServer
Set-HPOVServerPower
Start-HPOVServer
Stop-HPOVServer
Top
Update-HPOVServerHardwareLicenseIntent

Update-HPOVServerHardwareLicenseIntent
Change the license intent of a server.
SYNTAX
Update-HPOVServerHardwareLicenseIntent [-InputObject] <Object>[ [-Async] <SwitchParameter>][ [-ApplianceConne

The licensing intent of a server may be changed to either "OneView" (HPE OneView Advanced) or "OneViewNoiLO" (HP
E OneView Advanced w/o iLO). The server must be unlicensed and managed in order to be able to update the licensi
ng intent. In addition, a server licensed with "OneViewNoiLO" may be upgraded to "OneView", provided a "OneView"
license is available and the server does not already have an embedded or "iLO Advanced" license installed.
Parameters
Aliases Appliance
Required? False
Position? named
ete.
Aliases None
Required? False
Position? named
Default value False
A server hardware resource from Get-HPOVServer.

Required? True
Position? named
Default value
<CommonParameters>
Input Types
A server hardware resource from Get-HPOVServer.
Return Values
null
If the resource is already assigned a valid upgraded license, a null response is returned.
Examples
-------------------------- EXAMPLE 1 --------------------------
$Server = Get-HPOVServer -Name iLO123.domain.com -ErrorAction Stop

Update-HPOVServerHardwareLicenseIntent -InputObject $Server
Get the specific server resource, and attempt upgrading the license to "OneView".
-------------------------- EXAMPLE 2 --------------------------
$Servers = Get-HPOVServer | ? licensingIntent -eq "OneViewNoIlo"

$Tasks = $Servers | Update-HPOVServerHardwareLicenseIntent -async
Get server resources with "OneViewNoIlo" license, and attempt upgrading the license to "OneView".
Related Links
Top

Update Server Profile from Template
SYNTAX
Update-HPOVServerProfile [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter

>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Update-HPOVServerProfile [-InputObject] <Object>[ [-Reapply] <SwitchParameter>][ [-Baseline] <SwitchParameter

>][ [-AdapterAndBoot] <SwitchParameter>][ [-Connections] <SwitchParameter>][ [-LocalStorage] <SwitchParameter
>][ [-SANStorage] <SwitchParameter>][ [-BIOS] <SwitchParameter>][ [-OSDeployment] <SwitchParameter>][ [-Appli
anceConnection] <Object>][ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParam
This Cmdlet will perform the "Update from Server Profile Template" operation on 1 or more Server Profile resourc
es. If a Server Profile is already in a "Compliant" state, then no action will be taken.
Parameters
-AdapterAndBoot <SwitchParameter>
Re-apply Boot settings, including adapter boot preference.
Aliases None
Required? false
Position? named
Default value False
Aliases Appliance
Required? false
Position? named
ete.
Aliases None
Required? false
Position? named
Default value False
-BIOS <SwitchParameter>
Re-apply BIOS settings. Gen8 server hardware must be powered off for this operation to be allowed. Gen9 and ne
wer can be performed while the server hardware is powered on.
Aliases None
Required? false
Position? named
Default value False
-Baseline <SwitchParameter>
Re-apply Baseline. If setting is Firmware only, the associated server hardware must be powered off.
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value

-Connections <SwitchParameter>
Re-apply Vitual Connect connections. Will re-provision downlink ports and connection templates for the provided
server profile.
Aliases None
Required? false
Position? named
Default value False
Aliases [-Profile, -ServerProfile]

The Name or Resource Object of the specific Server Profile to update.
Aliases profile, ServerProfile
Required? true
Position? named
Default value
Re-apply Local Storage settings. This will cause the SmartArray to rescan for disks that should be part of the
configured Logical Disk. Server Hardware must be powered off in order for operation to be successful.
Aliases None
Required? false
Position? named
Default value False
-OSDeployment <SwitchParameter>
Re-apply OS Deployment Plan settings.

Aliases None
Required? false
Position? named
Default value False
Use to perform the Reapply Server Profile operation. Server should be powered off to perform certain operations
.
Aliases None
Required? false
Position? named
Default value False
Re-apply SAN storage settings. Only applies to SAN zoning and volume presentation, and not recreating SAN volum
es.
Aliases None
Required? false
Position? named
Default value False
When using this parameter, an HPOneView.ServerProfile.CompliancePreview object is returned, which contains the o
perations that will be performed.
Aliases wi
Required? false
Position? named
Default value

<CommonParameters>
Input Types
Single Server Profile
System.CollectionsArrayList <HPOneView.ServerProfile>
Multiple Server Profiles
Return Values
HPOneView.ServerProfile.CompliancePreview
Object containing the operations to be performed when the Server Profile object is not compliant.
HPOneView.Appliance.Task {System.Management.Automation.PSCustomObject}
Async update task
System.Collections.ArrayList <HPOneView.Appliance.Task>
Multiple Async update tasks
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile -Name "My Profile 1" | Update-HPOVServerProfile

-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile | Update-HPOVServerProfile
Get all Server Profile resources and perform the Update from Server Profile Template action.
### Related Links
* [Convert-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerProfile)
* [Convert-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Convert-HPOVServerPr
ofileTemplate)
* [ConvertTo-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/ConvertTo-HPOVServ
erProfileTemplate)
* [Copy-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Copy-HPOVServerProfile)
* [Get-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfile)
* [Get-HPOVServerProfileConnectionList](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProf
ileConnectionList)
* [Get-HPOVServerProfileMessage](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileMess
age)
* [Get-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVServerProfileTem
plate)
* [Join-HPOVServerProfileToTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Join-HPOVServerProfil
eToTemplate)
* [New-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfile)
* [New-HPOVServerProfileAssign](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileAssig
n)
* [New-HPOVServerProfileAttachVolume](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfil
eAttachVolume)
* [New-HPOVServerProfileConnection](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileC
onnection)
* [New-HPOVServerProfileLogicalDisk](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfile
LogicalDisk)
* [New-HPOVServerProfileLogicalDiskController](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVSer
verProfileLogicalDiskController)
* [New-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/New-HPOVServerProfileTem
plate)
* [Remove-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProfile)
* [Remove-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVServerProf
ileTemplate)
* [Save-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfile)
* [Save-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Save-HPOVServerProfileT
emplate)
* [Set-HPOVServerProfile](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfile)
* [Set-HPOVServerProfileTemplate](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Set-HPOVServerProfileTem
plate)
***
Top
## Update-HPOVServerProfile
Update Server Profile from Template
### SYNTAX
Update-HPOVServerProfile [-InputObject] <Object>[ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter

>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]
Update-HPOVServerProfile [-InputObject] <Object>[ [-Reapply] <SwitchParameter>][ [-Baseline] <SwitchParameter
>][ [-AdapterAndBoot] <SwitchParameter>][ [-Connections] <SwitchParameter>][ [-LocalStorage] <SwitchParameter
>][ [-SANStorage] <SwitchParameter>][ [-BIOS] <SwitchParameter>][ [-OSDeployment] <SwitchParameter>][ [-Appli
anceConnection] <Object>][ [-Async] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParam
This Cmdlet will perform the 'Update from Server Profile Template' operation on 1 or more Server Profile resourc
es. If a Server Profile is already in a 'Compliant' state, then no action will be taken.
Parameters
-AdapterAndBoot <SwitchParameter>
Re-apply Boot settings, including adapter boot preference.
Aliases None
Required? false
Position? named
Default value False
Aliases Appliance
Required? false
Position? named

ete.
Aliases None
Required? false
Position? named
Default value False
-BIOS <SwitchParameter>
Re-apply BIOS settings. Gen8 server hardware must be powered off for this operation to be allowed. Gen9 and ne
wer can be performed while the server hardware is powered on.
Aliases None
Required? false
Position? named
Default value False
-Baseline <SwitchParameter>
Re-apply Baseline. If setting is Firmware only, the associated server hardware must be powered off.
Aliases None
Required? false
Position? named
Default value False
Aliases cf
Required? false
Position? named
Default value
-Connections <SwitchParameter>
Re-apply Vitual Connect connections. Will re-provision downlink ports and connection templates for the provided
server profile.
Aliases None
Required? false
Position? named
Default value False
Aliases [-Profile, -ServerProfile]

The Name or Resource Object of the specific Server Profile to update.
Aliases profile, ServerProfile
Required? true
Position? named
Default value
Re-apply Local Storage settings. This will cause the SmartArray to rescan for disks that should be part of the
configured Logical Disk. Server Hardware must be powered off in order for operation to be successful.
Aliases None
Required? false
Position? named
Default value False

-OSDeployment <SwitchParameter>
Re-apply OS Deployment Plan settings.
Aliases None
Required? false
Position? named
Default value False
Use to perform the Reapply Server Profile operation. Server should be powered off to perform certain operations
.
Aliases None
Required? false
Position? named
Default value False
Re-apply SAN storage settings. Only applies to SAN zoning and volume presentation, and not recreating SAN volum
es.
Aliases None
Required? false
Position? named
Default value False
When using this parameter, an HPOneView.ServerProfile.CompliancePreview object is returned, which contains the o
perations that will be performed.
Aliases wi
Required? false
Position? named
Default value
<CommonParameters>
Input Types
Single Server Profile
System.CollectionsArrayList <HPOneView.ServerProfile>
Multiple Server Profiles
Return Values
HPOneView.ServerProfile.CompliancePreview
Object containing the operations to be performed when the Server Profile object is not compliant.
HPOneView.Appliance.Task {System.Management.Automation.PSCustomObject}
Async update task
System.Collections.ArrayList <HPOneView.Appliance.Task>
Multiple Async update tasks
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVServerProfile -Name 'My Profile 1' | Update-HPOVServerProfile
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVServerProfile | Update-HPOVServerProfile
Get all Server Profile resources and perform the Update from Server Profile Template action.
Related Links
Top

Update/Refresh available Storage Systems
SYNTAX
Update-HPOVStorageSystem [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will update or refresh the specific storage system(s) configured on the HPE OneView appliance. Refr
eshing the storage system will cause HPE OneView to validate connectivity, the addition of any new CPG"s, and an
y Storage System Host Port configuration changes.
Parameters
Aliases Appliance
Required? true
Position? named
Aliases [-StorageSystem]
The Storage System resource object to update/refresh.
Aliases Name, StorageSystem
Required? true
Position? named
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Update Storage System async task object
Multiple Update Storage System async task objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageSystem | Update-HPOVStorageSystem
Get all managed Storage Systems and refresh them.
-------------------------- EXAMPLE 2 --------------------------

Get-HPOVStorageSystem -Name MyStorageSystem | Update-HPOVStorageSystem
Get the "MyStorageSystem" managed Storage Systems and refresh it.
### Related Links
* [Add-HPOVStorageSystem](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVStorageSystem)
* [Get-HPOVStorageSystem](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVStorageSystem)
* [Remove-HPOVStorageSystem](https://github.com/HewlettPackard/POSH-HPOneView/wiki/Remove-HPOVStorageSystem)
***
Top
## Update-HPOVStorageSystem
Update/Refresh available Storage Systems
### SYNTAX
Update-HPOVStorageSystem [-InputObject] <Object> [-ApplianceConnection] <Object> [<CommonParameters>]
This cmdlet will update or refresh the specific storage system(s) configured on the HPE OneView appliance. Refr
eshing the storage system will cause HPE OneView to validate connectivity, the addition of any new CPG's, and an
y Storage System Host Port configuration changes.
Parameters
Aliases Appliance
Required? true
Position? named

Aliases [-StorageSystem]
The Storage System resource object to update/refresh.
Aliases Name, StorageSystem
Required? true
Position? named
Default value
<CommonParameters>
Input Types
Return Values
Update Storage System async task object
Multiple Update Storage System async task objects
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-HPOVStorageSystem | Update-HPOVStorageSystem
Get all managed Storage Systems and refresh them.
-------------------------- EXAMPLE 2 --------------------------
Get-HPOVStorageSystem -Name MyStorageSystem | Update-HPOVStorageSystem
Get the "MyStorageSystem" managed Storage Systems and refresh it.
Related Links
Top


Wait for Appliance services to start.
SYNTAX
Wait-HPOVApplianceStart [-Hostname] <String> [<CommonParameters>]
Internal module helper function to wait for the appliance services to start. This helper function will be calle
d by Send-HPOVRequest when the [System.Net.WebRequest] GetResponse() client generates an [Net.WebException] exce
ption. Then, this function will be called to provide the caller with an indication that the appliance is starti
ng its services. This will display two prompts:
1. An initial text-based progress bar while the System.Net.WebRequest is able to access the web service on the
appliance to begin polling for service startup status.
2. Write-Progress indicator displaying the overall service startup.
If any service fails to startup, this function will cause a terminating error, informing the caller to go visit
the appliance kiosk console to get more information about the startup error.
When the appliance successfully starts, this function will return.
Parameters
-Hostname <String>
Specify the appliance FQDN or IP Address without a valid connection created by using Connect-HPOVMgmt.
Aliases Appliance
Aliases Appliance
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Write-Progress
The Write-Progress cmdlet is used to display the startup progress
Examples
-------------------------- EXAMPLE 1 --------------------------
Wait-HPOVApplianceStart -Appliance appliance.contoso.com
Wait for the appliance to start, and specify the appliance name.
### Related Links
***
Top
## Wait-HPOVApplianceStart
Wait for Appliance services to start.
### SYNTAX
Wait-HPOVApplianceStart [-Hostname] <String> [<CommonParameters>]
Internal module helper function to wait for the appliance services to start. This helper function will be calle
d by Send-HPOVRequest when the [System.Net.WebRequest] GetResponse() client generates an [Net.WebException] exce
ption. Then, this function will be called to provide the caller with an indication that the appliance is starti
ng its services. This will display two prompts:
1. An initial text-based progress bar while the System.Net.WebRequest is able to access the web service on the
appliance to begin polling for service startup status.
2. Write-Progress indicator displaying the overall service startup.
If any service fails to startup, this function will cause a terminating error, informing the caller to go visit
the appliance kiosk console to get more information about the startup error.
When the appliance successfully starts, this function will return.
Parameters
-Hostname <String>
Specify the appliance FQDN or IP Address without a valid connection created by using Connect-HPOVMgmt.
Aliases Appliance
Required? true
Position? 0
Default value
<CommonParameters>
Input Types
Return Values
Write-Progress
The Write-Progress cmdlet is used to display the startup progress
Examples
-------------------------- EXAMPLE 1 --------------------------
Wait-HPOVApplianceStart -Appliance appliance.contoso.com
Wait for the appliance to start, and specify the appliance name.
Related Links
Top

Wait for a task to complete.
SYNTAX
Wait-HPOVTaskComplete [-InputObject] <Object> [-Timeout] <TimeSpan> [-ApplianceConnection] <Object>[ [-Applia

nceWillReboot] <SwitchParameter>] [<CommonParameters>]
HPE OneView utilizes a task subsystem for operations that will take longer than 200ms, and will execute them Asy
ncrounously. An async task resource object is created and returned to the caller once the request has passed va
lidation.
This blocking cmdlet assists a caller with monitoring a specific task resource, and will wait for the given task
to "complete" (get to a terminal state, including error) or timeout. The cmdlet accepts either the task URI or
resource object via pipeline.
Once the task is no longer in a running state, the cmlet will return the task resource object. The caller shoul
d examine the taskState property/key for the final task status.
Parameters
Aliases Appliance
Required? true
Position? 2
-ApplianceWillReboot <SwitchParameter>
Internal use t indicate if a task will cause appliance to reboot.
Aliases None
Required? false
Position? named
Default value
Aliases [-TaskUri, -Task]

The uri of the task resource to wait for.
Aliases TaskUri, Task
Required? true
Position? 0
Default value
-Timeout <TimeSpan>
The timespan to wait for the task to complete. Default is to wait for 20 minutes.
Aliases None
Required? true
Position? 1
Default value $DefaultTimeout
<CommonParameters>
Input Types
System.String
Task URI
Task resource object
Return Values
The finished Task object that includes the task result
Examples
-------------------------- EXAMPLE 1 --------------------------
Wait-HPOVTaskComplete /rest/tasks/F08EE040-DBA7-4806-BB62-993DD0CB4250
Waiting for task to complete...Task completed successfully!
Wait for task to complete.
-------------------------- EXAMPLE 2 --------------------------
Wait-HPOVTaskComplete $task -timeout (New-TimeSpan -minute 10)

Wait for task to complete, modifying the default timeout to 10 minutes.
-------------------------- EXAMPLE 3 --------------------------
$svr = Get-HPOVServer "ServerA"

$taskResults = New-HPOVServerProfile -name "Profile 1" -server $svr | Wait-HPOVTaskComplete
Retreive the server details for ServerA, create a Server Profile and pass via pipeline the task resource object.
### Related Links

***
Top
## Wait-HPOVTaskComplete
Wait for a task to complete.
### SYNTAX
Wait-HPOVTaskComplete [-InputObject] <Object> [-Timeout] <TimeSpan> [-ApplianceConnection] <Object> [<CommonP

arameters>]
HPE OneView utilizes a task subsystem for operations that will take longer than 200ms, and will execute them Asy
ncrounously. An async task resource object is created and returned to the caller once the request has passed va
lidation.
This blocking cmdlet assists a caller with monitoring a specific task resource, and will wait for the given task
to "complete" (get to a terminal state, including error) or timeout. The cmdlet accepts either the task URI or
resource object via pipeline.
Once the task is no longer in a running state, the cmlet will return the task resource object. The caller shoul
d examine the taskState property/key for the final task status.
Parameters
Aliases Appliance
Required? true
Position? 2

Aliases [-TaskUri, -Task]

The uri of the task resource to wait for.
Aliases TaskUri, Task
Required? true
Position? 0
Default value
-Timeout <TimeSpan>
The timespan to wait for the task to complete. Default is to wait for 20 minutes.
Aliases None
Required? true
Position? 1
Default value $DefaultTimeout
<CommonParameters>
Input Types
System.String
Task URI
Task resource object

Return Values
The finished Task object that includes the task result
Examples
-------------------------- EXAMPLE 1 --------------------------
Wait-HPOVTaskComplete /rest/tasks/F08EE040-DBA7-4806-BB62-993DD0CB4250
Wait for task to complete.
-------------------------- EXAMPLE 2 --------------------------
Wait-HPOVTaskComplete $task -timeout (New-TimeSpan -minute 10)

Wait for task to complete, modifying the default timeout to 10 minutes.
-------------------------- EXAMPLE 3 --------------------------
$svr = Get-HPOVServer "ServerA"

$taskResults = New-HPOVServerProfile -name "Profile 1" -server $svr | Wait-HPOVTaskComplete
Retreive the server details for ServerA, create a Server Profile and pass via pipeline the task resource object.
Related Links
Top
Wait-HPOVTaskStart
Wait-HPOVTaskStart

Wait-HPOVTaskStart
Wait for a task to start.
SYNTAX
Wait-HPOVTaskStart [-InputObject] <Object> [-resourceName] <String> [-Timeout] <TimeSpan> [-ApplianceConnecti

on] <Object> [<CommonParameters>]
Wait for the given task to "start" (get beyond validation phase) or timeout.
Parameters
Aliases Appliance
Aliases Appliance
Required? true
Position? 3
Aliases [-taskuri, -task]

The uri or object of the task resource to wait for.
Aliases taskuri, task
Required? true
Position? 0
Default value
-Timeout <TimeSpan>
The time or object to wait for the task to start. Default is to wait for 20 minutes.
Aliases None
Required? true
Position? 2
Default value $script:defaultTimeout
-resourceName <String>
Specify the associated ResourceName to the task to display in the Write-Progress -activity parameter.
Aliases None
Required? true
Position? 1
Default value

<CommonParameters>
Input Types
Task async object
Return Values
Task async object
Examples
-------------------------- EXAMPLE 1 --------------------------
$Task = Add-HPOVServer MyiLO.domain.com Administrator password | Wait-HPOVTaskstart
Add a new Server Device to the appliance, wait for the asyncronous task to enter Starting State, and save the ta
sk object.
### Related Links
***
Top
## Wait-HPOVTaskStart
Wait for a task to start.
### SYNTAX
Wait-HPOVTaskStart [-InputObject] <Object> [-resourceName] <String> [-Timeout] <TimeSpan> [-ApplianceConnecti

on] <Object> [<CommonParameters>]
Wait for the given task to "start" (get beyond validation phase) or timeout.
Parameters
Aliases Appliance
Required? true
Position? 3
Aliases [-taskuri, -task]

The uri or object of the task resource to wait for.
Aliases taskuri, task
Required? true
Position? 0
Default value
-Timeout <TimeSpan>
The time or object to wait for the task to start. Default is to wait for 20 minutes.
Aliases None
Required? true
Position? 2
Default value $script:defaultTimeout
-resourceName <String>
Specify the associated ResourceName to the task to display in the Write-Progress -activity parameter.
Aliases None
Required? true
Position? 1
Default value
<CommonParameters>
Input Types
Task async object
Return Values
Task async object
Examples
-------------------------- EXAMPLE 1 --------------------------

$Task = Add-HPOVServer MyiLO.domain.com Administrator password | Wait-HPOVTaskstart
Add a new Server Device to the appliance, wait for the asyncronous task to enter Starting State, and save the ta
sk object.
Related Links
Top

Posh Hponeview 4.20

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Posh Hponeview 4.20

Uploaded by

Copyright:

Available Formats

Documentation

Wiki Table of Contents

Permission is hereby granted, free of charge, to any person obtaining a copy

PowerShell library for HP OneView 4.10

-- Initial 4.20 release.

This library provides HP OneView management capabilities for Windows PowerShell.

For information regarding this project, to request features or report

(C) Copyright 2013-2019 Hewlett Packard Enterprise Development LP

Permission is hereby granted, free of charge, to any person obtaining a copy

PowerShell library for HP OneView 4.10

-- Initial 4.10 release.

This library provides HP OneView management capabilities for Windows PowerShell.

For information regarding this project, to request features or report

(C) Copyright 2013-2018 Hewlett Packard Enterprise Development LP

Permission is hereby granted, free of charge, to any person obtaining a copy

PowerShell library for HP OneView 4.00

-- First release of HPE OneView 4.00 PowerShell library.

This library provides HP OneView management capabilities for Windows PowerShell.

For information regarding this project, to request features or report

Explains how Multiple Appliance Connections are handled with the

In the HPE OneView 2.0 or newer PowerShell library is the ability to

-- When using Connect-HPOVMgmt, an [HPOneView.Appliance.Connection] object

-- The [HPOneView.Appliance.Connection] object is stored in a global variable

-- Within the [HPOneView.Appliance.Connection] object is a property called

GLBOAL CONNECTION TRACKING OBJECT

Contained in the $ConnectedSessions Global varilable, will be each

-- ConnectID - Unique per PowerShell library session

After successfully authenticating to an appliance, the

HOW TO USE CONNECTION IN CMDLETS

The PowerShell user can store the returned HPOneView.Appliance.Connection

Some CMDLETs will default to using all connections within $ConnectedSessions,

For instance, Get-HPOVNetwork will default to processing all appliance

This example shows how to use the connection 'object':

PS C:\> $Connection1 = Connect-HPOVMgmt hpov1.domain.com administrator MyPassw0rd

ConnectionID Name UserName AuthLoginDomain Default

PS C:\> Get-HPOVNetwork -ApplianceConnection $Connection1

This example shows how to use the connection 'name':

PS C:\> $Connection1 = Connect-HPOVMgmt hpov1.domain.com administrator MyPassw0rd

ConnectionID Name UserName AuthLoginDomain Default

PS C:\> Get-HPOVNetwork -ApplianceConnection hpov1.domain.com

SETTING DEFAULT APPLIANCE CONNECTION

When authenticating to your first appliance, the 'Default' property is automatically

PS C:\> $Connection1 = Connect-HPOVMgmt hpov1.domain.com administrator MyPassw0rd

ConnectionID Name UserName AuthLoginDomain Default

PS C:\> $Connection2 | Set-HPOVApplianceDefaultConnection

ConnectionID Name UserName AuthLoginDomain Default

APPLIANCECONNECTION PROPERTY VALUE IN OBJECTS

The 'ConnectionID' and 'Name' sub-properties reference the Appliance Connection

A user or group may be assigned multiple permissions. Use the Set-HPOVUser or

Allowing a user to operate in a least privilege mode is a security best practice. It

CHANGING ACTIVE PERMISSIONS

PS C:\> # Show current SessionID

RoleName ScopeName Active

PS C:\> $NewPermissions = $ConnectedSessions[0].ActivePermissions | ? RoleName -match 'Network'

RoleName ScopeName Active

PS C:\> # Show updated SessionID

PS C:\> # Show current SessionID

RoleName ScopeName Active

PS C:\> $NewPermissions = $ConnectedSessions[0].ActivePermissions | ? ScopeName -match 'Site A Admins'

RoleName ScopeName Active

PS C:\> # Show updated SessionID

Passwords, no matter how complex, provide insufficient security for many

HPE OneView user/password authentication

Users can be configured in HPE OneView as local users, or remotely in an