Set-Pcsv Device Network Configuration

Module:
pcsvdevice
Changes the network configuration of a PCSV device.

Syntax 

Set-PcsvDeviceNetworkConfiguration
   [-TimeoutSec <UInt32>]
   [-IPv4AddressOrigin] <PossibleIPv4Origins>
   [-IPv4Address <String>]
   [-IPv4DefaultGateway <String>]
   [-IPv4SubnetMask <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-PcsvDeviceNetworkConfiguration
   [-TargetAddress] <String>
   [-Credential] <PSCredential>
   [-ManagementProtocol] <ManagementProtocol>
   [[-Port] <UInt16>]
   [-Authentication <Authentication>]
   [-UseSSL]
   [-SkipCACheck]
   [-SkipCNCheck]
   [-SkipRevocationCheck]
   [-TimeoutSec <UInt32>]
   [-IPv4AddressOrigin] <PossibleIPv4Origins>
   [-IPv4Address <String>]
   [-IPv4DefaultGateway <String>]
   [-IPv4SubnetMask <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-PcsvDeviceNetworkConfiguration
   -InputObject <CimInstance[]>
   [-IPv4AddressOrigin] <PossibleIPv4Origins>
   [-IPv4Address <String>]
   [-IPv4DefaultGateway <String>]
   [-IPv4SubnetMask <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-PcsvDeviceNetworkConfiguration cmdlet changes the network configuration of a Physical Computer System View (PCSV) device. You can configure the network settings of a device statically or dynamically, by using the DHCP service. If you specify a static network configuration, you must specify the IP address, subnet mask, and default gateway. This cmdlet currently supports devices that use the Intelligent Platform Management Interface (IPMI) protocol. Changing the network configuration disrupts the out-of-band session, and, therefore, this cmdlet can only be run on an in-band connection. To use with an in-band connection, you must have elevated privileges.

Examples

Example 1: Configure network settings dynamically 

PS C:\>Set-PcsvDeviceNetworkConfiguration -IPv4AddressOrigin DHCP

This command configures network settings for the PCSV device. The DHCP service updates the IP address, subnet mask and default gateway.

Example 2: Configure network settings statically 

PS C:\>Set-PcsvDeviceNetworkConfiguration -IPv4AddressOrigin Static -IPv4Address "10.0.1.2" -IPv4DefaultGateway "10.0.0.1" -IPv4SubnetMask "255.255.0.0"

This command configures network settings for the PCSV device. The command specifies the IP address, subnet mask, and default gateway for the device.

Required Parameters

-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 . For IPMI devices, specify credentials that correspond to a user with Administrator privileges on the device.

Type: PSCredential
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-IPv4AddressOrigin

Specifies how the IP address is acquired. The acceptable values for this parameter are:

  • Static
  • DHCP
Type: PossibleIPv4Origins
Parameter Sets: Static, DHCP
Position: 3001
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-ManagementProtocol

Specifies a management protocol used to communicate with a device. The acceptable values for this parameter are:

  • WSMAN
  • IPMI

This cmdlet currently supports only devices that use the IPMI protocol.

Type: ManagementProtocol
Aliases: MP
Parameter Sets: WSMan, IPMI
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TargetAddress

Specifies the name or IP address of the remote hardware device.

Type: String
Aliases: CN, ComputerName, IpAddress
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional 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
Accept pipeline input: False
Accept wildcard characters: False
-Authentication

Specifies an authentication method to use for devices managed by WS-Management. Do not specify this parameter for devices managed by using IPMI. The acceptable values for this parameter are:

  • Basic
  • Digest
  • Default
Type: Authentication
Parameter Sets: Default, Basic, Digest
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
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: None
Accept pipeline input: False
Accept wildcard characters: False
-IPv4Address

Specifies an IPv4 address for the PCSV device.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IPv4DefaultGateway

Specifies an IPv4 default gateway for the PCSV device.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IPv4SubnetMask

Specifies an IPv4 subnet mask for the PCSV device.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

Passthru

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Port

Specifies a port on the remote computer to use for the management connection. If you do not specify a port, the cmdlet uses the following default ports:

  • IPMI and WSMAN over HTTP. Port 623.
  • WSMAN over HTTPS. Port 664.
Type: UInt16
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SkipCACheck

Indicates that the client connects by using HTTPS without validating that a trusted certification authority (CA) signed the server certificate. Do not specify this parameter if you specify a value of IPMI for the ManagmentProtocol 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
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SkipCNCheck

Indicates that the certificate common name (CN) of the server does not need to match the host name of the server. Do not specify this parameter if you specify a value of IPMI for the ManagmentProtocol parameter.

Specify this parameter only for managing devices by using WSMAN over HTTPS. Be sure to specify this parameter only for trusted computers.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SkipRevocationCheck

Indicates that the cmdlet skips the revocation check of server certificates.

Be sure to specify this parameter only for trusted computers.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
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
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-UseSSL

Indicates that the server connects to the target computer by using SSL. WSMAN 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
Accept pipeline input: True (ByPropertyName)
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: None
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance, Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/HardwareManagement/MSFT_PCSVDevice

This cmdlet returns a PCSV device object, if you specify the PassThru parameter.