< Back
Set-iBMCFruControl
Post
NAME Set-iBMCFruControl
SYNOPSIS
Perform power control on a field replaceable unit (FRU).
SYNTAX
Set-iBMCFruControl [-Session] <RedfishSession[]> [-FRU] {OS | Base | Fabric | FC} [-ControlType] {On |
GracefulShutdown | ForceRestart | Nmi | ForcePowerCycle} [<CommonParameters>]
DESCRIPTION
Perform power control on a field replaceable unit (FRU).
Note: This cmdlet may affect the normal operation of system. It should be used with caution.
PARAMETERS
-Session <RedfishSession[]>
iBMC redfish session object which is created by Connect-iBMC cmdlet.
A session object identifies an iBMC server to which this cmdlet will be executed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-FRU
Indicates the FRU to control.
Available Value Set: OS, Base, Fabric, FC.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ControlType
Indicates the FRU power control type.
Available Value Set: On, GracefulShutdown, ForceRestart, Nmi, ForcePowerCycle.
- On: power on the Server.
- GracefulShutdown: gracefully shut down the Server.
- ForceRestart: forcibly restart the Server.
- Nmi: triggers a non-maskable interrupt (NMI).
- ForcePowerCycle: forcibly power off and then power on the Server.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
Returns None if cmdlet executes successfully.
In case of an error or warning, exception will be returned.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$credential = Get-Credential
PS C:\\> $session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert
PS C:\\> Set-iBMCFruControl -Session $session -FRU OS -ControlType On
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Connect-iBMC
Disconnect-iBMC
SYNOPSIS
Perform power control on a field replaceable unit (FRU).
SYNTAX
Set-iBMCFruControl [-Session] <RedfishSession[]> [-FRU] {OS | Base | Fabric | FC} [-ControlType] {On |
GracefulShutdown | ForceRestart | Nmi | ForcePowerCycle} [<CommonParameters>]
DESCRIPTION
Perform power control on a field replaceable unit (FRU).
Note: This cmdlet may affect the normal operation of system. It should be used with caution.
PARAMETERS
-Session <RedfishSession[]>
iBMC redfish session object which is created by Connect-iBMC cmdlet.
A session object identifies an iBMC server to which this cmdlet will be executed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-FRU
Indicates the FRU to control.
Available Value Set: OS, Base, Fabric, FC.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ControlType
Indicates the FRU power control type.
Available Value Set: On, GracefulShutdown, ForceRestart, Nmi, ForcePowerCycle.
- On: power on the Server.
- GracefulShutdown: gracefully shut down the Server.
- ForceRestart: forcibly restart the Server.
- Nmi: triggers a non-maskable interrupt (NMI).
- ForcePowerCycle: forcibly power off and then power on the Server.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
Returns None if cmdlet executes successfully.
In case of an error or warning, exception will be returned.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$credential = Get-Credential
PS C:\\> $session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert
PS C:\\> Set-iBMCFruControl -Session $session -FRU OS -ControlType On
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Connect-iBMC
Disconnect-iBMC