< Back
Set-PcsvDeviceNetworkConfiguration
Post
NAME Set-PcsvDeviceNetworkConfiguration
SYNOPSIS
Changes the network configuration of a PCSV device.
SYNTAX
Set-PcsvDeviceNetworkConfiguration [-TargetAddress] <String> [-Credential] <PSCredential> [-IPv4AddressOrigin] {Static | DHCP} [-ManagementProtocol]
{WSMan | IPMI} [[-Port] <UInt16>] [-Authentication {Default | Basic | Digest}] [-CimSession <CimSession[]>] [-IPv4Address <String>] [-IPv4DefaultGateway
<String>] [-IPv4SubnetMask <String>] [-PassThru] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-ThrottleLimit <Int32>] [-TimeoutSec <UInt32>]
[-UseSSL] [<CommonParameters>]
Set-PcsvDeviceNetworkConfiguration [-IPv4AddressOrigin] {Static | DHCP} [-CimSession <CimSession[]>] [-IPv4Address <String>] [-IPv4DefaultGateway
<String>] [-IPv4SubnetMask <String>] [-PassThru] [-ThrottleLimit <Int32>] [-TimeoutSec <UInt32>] [<CommonParameters>]
Set-PcsvDeviceNetworkConfiguration [-IPv4AddressOrigin] {Static | DHCP} [-CimSession <CimSession[]>] [-IPv4Address <String>] [-IPv4DefaultGateway
<String>] [-IPv4SubnetMask <String>] [-PassThru] [-ThrottleLimit <Int32>] [<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.
PARAMETERS
-Authentication [<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:The acceptable values for this parameter are:
-- Basic
-- Digest
-- Default
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
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.
Required? true
Position? 3
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-IPv4Address [<String>]
Specifies an IPv4 address for the PCSV device.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPv4AddressOrigin <PossibleIPv4Origins>
Specifies how the IP address is acquired. The acceptable values for this parameter are:The acceptable values for this parameter are:??
-- Static
-- DHCP
Required? true
Position? 3002
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPv4DefaultGateway [<String>]
Specifies an IPv4 default gateway for the PCSV device.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPv4SubnetMask [<String>]
Specifies an IPv4 subnet mask for the PCSV device.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ManagementProtocol <ManagementProtocol>
Specifies a management protocol used to communicate with a device. The acceptable values for this parameter are:The acceptable values for this
parameter are:
-- WSMAN
-- IPMI
This cmdlet currently supports only devices that use the IPMI protocol.
Required? true
Position? 4
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Passthru
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Port [<UInt16>]
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.
Required? false
Position? 5
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCACheck [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCNCheck [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipRevocationCheck [<SwitchParameter>]
Indicates that the cmdlet skips the revocation check of server certificates.
Be sure to specify this parameter only for trusted computers.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-TargetAddress <String>
Specifies the name or IP address of the remote hardware device.
Required? true
Position? 2
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSec [<UInt32>]
Specifies how long to wait, in seconds, for a response from the remote hardware device. After this period, the cmdlet abandons the connection
attempt.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-UseSSL [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(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
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.
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.
RELATED LINKS
Get-PcsvDevice
Set-PcsvDeviceBootConfiguration
SYNOPSIS
Changes the network configuration of a PCSV device.
SYNTAX
Set-PcsvDeviceNetworkConfiguration [-TargetAddress] <String> [-Credential] <PSCredential> [-IPv4AddressOrigin] {Static | DHCP} [-ManagementProtocol]
{WSMan | IPMI} [[-Port] <UInt16>] [-Authentication {Default | Basic | Digest}] [-CimSession <CimSession[]>] [-IPv4Address <String>] [-IPv4DefaultGateway
<String>] [-IPv4SubnetMask <String>] [-PassThru] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-ThrottleLimit <Int32>] [-TimeoutSec <UInt32>]
[-UseSSL] [<CommonParameters>]
Set-PcsvDeviceNetworkConfiguration [-IPv4AddressOrigin] {Static | DHCP} [-CimSession <CimSession[]>] [-IPv4Address <String>] [-IPv4DefaultGateway
<String>] [-IPv4SubnetMask <String>] [-PassThru] [-ThrottleLimit <Int32>] [-TimeoutSec <UInt32>] [<CommonParameters>]
Set-PcsvDeviceNetworkConfiguration [-IPv4AddressOrigin] {Static | DHCP} [-CimSession <CimSession[]>] [-IPv4Address <String>] [-IPv4DefaultGateway
<String>] [-IPv4SubnetMask <String>] [-PassThru] [-ThrottleLimit <Int32>] [<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.
PARAMETERS
-Authentication [<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:The acceptable values for this parameter are:
-- Basic
-- Digest
-- Default
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
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.
Required? true
Position? 3
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-IPv4Address [<String>]
Specifies an IPv4 address for the PCSV device.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPv4AddressOrigin <PossibleIPv4Origins>
Specifies how the IP address is acquired. The acceptable values for this parameter are:The acceptable values for this parameter are:??
-- Static
-- DHCP
Required? true
Position? 3002
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPv4DefaultGateway [<String>]
Specifies an IPv4 default gateway for the PCSV device.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPv4SubnetMask [<String>]
Specifies an IPv4 subnet mask for the PCSV device.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ManagementProtocol <ManagementProtocol>
Specifies a management protocol used to communicate with a device. The acceptable values for this parameter are:The acceptable values for this
parameter are:
-- WSMAN
-- IPMI
This cmdlet currently supports only devices that use the IPMI protocol.
Required? true
Position? 4
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Passthru
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Port [<UInt16>]
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.
Required? false
Position? 5
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCACheck [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCNCheck [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipRevocationCheck [<SwitchParameter>]
Indicates that the cmdlet skips the revocation check of server certificates.
Be sure to specify this parameter only for trusted computers.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-TargetAddress <String>
Specifies the name or IP address of the remote hardware device.
Required? true
Position? 2
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSec [<UInt32>]
Specifies how long to wait, in seconds, for a response from the remote hardware device. After this period, the cmdlet abandons the connection
attempt.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-UseSSL [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(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
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.
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.
RELATED LINKS
Get-PcsvDevice
Set-PcsvDeviceBootConfiguration