Set-PcsvDeviceBootConfiguration
Modifies the boot configuration on the remote hardware device.
Syntax
Set-PcsvDeviceBootConfiguration
[-TimeoutSec <UInt32>]
[[-OneTimeBootSource] <String>]
[[-PersistentBootSource] <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-PcsvDeviceBootConfiguration
[-TargetAddress] <String>
[-Credential] <PSCredential>
[-ManagementProtocol] <ManagementProtocol>
[[-Port] <UInt16>]
[-Authentication <Authentication>]
[-UseSSL]
[-SkipCACheck]
[-SkipCNCheck]
[-SkipRevocationCheck]
[-TimeoutSec <UInt32>]
[[-OneTimeBootSource] <String>]
[[-PersistentBootSource] <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-PcsvDeviceBootConfiguration
-InputObject <CimInstance[]>
[[-OneTimeBootSource] <String>]
[[-PersistentBootSource] <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-PcsvDeviceBootConfiguration cmdlet modifies the boot configuration for a remote hardware device. To retrieve the current boot configuration for a device, use the Get-PcsvDevice cmdlet.
The StructuredBootString property of the returned instance lists the valid boot sources, and the OneTimeBootSource property indicates whether one of the valid boot sources has already been configured to be the primary boot source for the next time the device undergoes a full restart.
Examples
Example 1 Modify the device boot configuration to use PXE boot
PS C:\> $MyCred = Get-Credential
PS C:\> Set-PCSVDeviceBootConfiguration -TargetAddress 10.1.12.43 -ManagementProtocol WSMan -Credential $MyCred -UseSSL -OneTimeBootSource "CIM:Network:1"This example configures the boot source to use Pre-Boot Execution Environment (PXE) boot the next time the system boots.
The first command uses the Get-Credential cmdlet to get credentials, and stores the credentials in the variable named $MyCred.
The cmdlet prompts you for a user name and password.
For more information, type Get-Help Get-Credential.
The second command modifies the device boot configuration for the target computer, by using the OneTimeBootSource parameter to specify the boot configuration.
Example 2: Modify the device boot configuration to use the DVD drive
PS C:\> $MyCred = Get-Credential
PS C:\> Get-PCSVDevice -TargetAddress 10.1.12.43 -ManagementProtocol WSMan -Credential $MyCred -UseSSL | Set-PcsvDeviceBootConfiguration -OneTimeBootSource "CIM:CD/DVD:1"This example configures the boot source to use the DVD drive for the next time the system boots.
The first command uses the Get-Credential cmdlet to get credentials, and stores the credentials in the variable named $MyCred.
The cmdlet prompts you for a user name and password.
For more information, type Get-Help Get-Credential.
The second command uses the Get-PcsvDevice cmdlet to retrieve the configuration for the target computer, and passes the output to the Set-PcsvDeviceBootConfiguration cmdlet by using the pipeline operator.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Authentication
Specifies an authentication method to use for devices managed by Web Services for Management (WS-Management). Do not use this parameter for devices managed by using Intelligent Platform Management Interface (IPMI). The acceptable values for this parameter are:
- Basic
- Digest -- Default
If you specify Default for this parameter and a value of WSMAN for the ManagementProtocol parameter, the cmdlet uses Basic authentication.
| Type: | Authentication |
| Accepted values: | Default, Basic, Digest |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies a PSCredential object based on a user name and password.
To obtain a PSCredential object, use the Get-Credential cmdlet.
For more information, type Get-Help Get-Credential.
This parameter specifies the credential for the remote hardware device.
| Type: | PSCredential |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ManagementProtocol
Specifies a management protocol used to communicate with a device. The acceptable values for this parameter are:
- WSMAN
- IPMI
Refer to your hardware documentation for supported management protocols.
Specify WSMAN for devices that represent information by using Systems Management Architecture for Server Hardware (SMASH), Desktop and mobile Architecture for System Hardware (DASH) or Physical Computer System View profiles.
| Type: | ManagementProtocol |
| Aliases: | MP |
| Accepted values: | WSMan, IPMI |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OneTimeBootSource
Specifies a one-time boot source, in the format CIM:<identifier>:<index>. For example, you can specify a boot source as CIM:Network:1. The StructuredBootString property of the PcsvDevice instance contains a list of valid boot sources.
| Type: | String |
| Aliases: | OT, NextBoot |
| Position: | 3001 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PersistentBootSource
| Type: | String[] |
| Aliases: | PT, Persistent |
| Position: | 3002 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
Specifies a network port on the remote computer to use for the management connection. If you do not specify a port, the cmdlet uses the following default values:
- IPMI and WSMAN over HTTP. Port 623 -- WSMAN over HTTPS. Port 664.
| Type: | UInt16 |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkipCACheck
Indicates that the client connects by using HTTPS without validating that a trusted CA signed the server certificate. Do not specify this parameter if you specify a value of IPMI for the ManagementProtocol parameter.
Do not specify this parameter unless you can establish trust in another way, such as if the remote computer is part of a network that is physically secure and isolated, or if the remote computer is a trusted host in a Windows Remote Management (WinRM) configuration.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkipCNCheck
Indicates that the certificate common name of the server does not need to match the hostname of the server. Do not specify this parameter if you specify a value of IPMI for the ManagementProtocol parameter.
Specify this parameter only for remote operations with WS-Management devices that use the HTTPS protocol. Use this parameter only for trusted computers.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkipRevocationCheck
Indicates that the cmdlet skips the revocation check of server certificates. Do not specify this parameter if you specify a value of IPMI for the ManagementProtocol parameter.
Be sure to specify this parameter only for trusted computers.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetAddress
Specifies the name or IP address of the management port on the remote hardware device. For server hardware, this is typically a dedicated Baseboard Management Controller (BMC) IP address. For other devices, like network switches, this is the IP address of their management port. For desktop and mobile devices, the BMC sometimes shares the same IP address as the computer.
| Type: | String |
| Aliases: | CN, ComputerName, IpAddress |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeoutSec
Specifies how long to wait, in seconds, for a response from the remote hardware device. After this period, the cmdlet abandons the connection attempt.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UseSSL
Indicates that the cmdlet connects to a remote device by using SSL. WS-Management encrypts all content transmitted over the network. Specify this parameter to use the additional protection of HTTPS instead of HTTP. If you specify this parameter and SSL is not available on the connection port, the command fails.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PcsvDevice.ManagementProtocol
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PcsvDevice.Authentication
Outputs
The PCSV device is only returned as output if the PassThru parameter is specified.