Set-PowerCLIConfiguration

Synopsis

Syntax

Related Commands

Online version

Get-PowerCLIConfiguration

Detailed Description

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	false	$true
DefaultVIServerMode	DefaultVIServerMode	Change the server connection mode. The new configuration takes effect immediately after you run the cmdlet. The following values are valid: - Single - Switching to "single" removes all server connections except the last established one. If no target servers are specified, cmdlets run only on the last connected server. - Multiple - All servers connected after switching to "multiple" mode are stored together with the current server connection in an array variable. If no target servers are specified, cmdlets run on the servers in the variable. For more information on default servers, see the description of Connect-VIServer.	false	false
DisplayDeprecationWarnings	Boolean	Indicate whether you want to see warnings about deprecated elements.	false	false
InvalidCertificateAction	BadCertificateAction	Define the action to take when an attempted connection to a server fails due to a certificate error. The following values are valid: Unset - this is the default value and it acts as a ?Warn? value for Connect-VIServer and as ?Prompt? for ?Connect-CloudServer?. Prompt - if the server certificate is not trusted the cmdlet will prompt you for a course of action before it continues. There are several options: Deny - no connection will be established. Accept for once - accept the connection only for the current PowerCLI session. You will be prompted again if you attempt to connect to the same server from other processes. Accept Permanently - the action will add this certificate as an exception in the ?SSL Certificate Exceptions? user list. Connect cmdlets will never prompt again what action to take for this particulate certificate and server. Accept For All Users - same as the above, however the exception will be added to all user lists, which is common for all Windows accounts on the current machine. Fail - the cmdlet will not establish connection if the certificate is not valid. Ignore - the cmdlet will establish the connection without taking into account that the certificate is invalid. Warn - the cmdlet will display a warning saying that the certificate is not valid, the reason why it is not considered valid and then will print additional information about the certificate.	false	false	Unset
ProxyPolicy	ProxyPolicy	Specify whether the vSphere PowerCLI uses a system proxy server to connect to the vSphere server. The valid values are NoProxy and UseSystemProxy.	false	true (ByValue)
WhatIf	SwitchParameter	Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Name

Type

Description

Required?

Pipeline Input

Default Value

Confirm

SwitchParameter

If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.

false

$true

DefaultVIServerMode

DefaultVIServerMode

Change the server connection mode. The new configuration takes effect immediately after you run the cmdlet. The following values are valid:

- Single - Switching to "single" removes all server connections except the last established one. If no target servers are specified, cmdlets run only on the last connected server.

- Multiple - All servers connected after switching to "multiple" mode are stored together with the current server connection in an array variable. If no target servers are specified, cmdlets run on the servers in the variable.

For more information on default servers, see the description of Connect-VIServer.

false

DisplayDeprecationWarnings

Boolean

Indicate whether you want to see warnings about deprecated elements.

false

InvalidCertificateAction

BadCertificateAction

Define the action to take when an attempted connection to a server fails due to a certificate error. The following values are valid:

Unset - this is the default value and it acts as a ?Warn? value for Connect-VIServer and as ?Prompt? for ?Connect-CloudServer?.

Prompt - if the server certificate is not trusted the cmdlet will prompt you for a course of action before it continues. There are several options:
Deny - no connection will be established.
Accept for once - accept the connection only for the current PowerCLI session. You will be prompted again if you attempt to connect to the same server from other processes.
Accept Permanently - the action will add this certificate as an exception in the ?SSL Certificate Exceptions? user list. Connect cmdlets will never prompt again what action to take for this particulate certificate and server.
Accept For All Users - same as the above, however the exception will be added to all user lists, which is common for all Windows accounts on the current machine.

Fail - the cmdlet will not establish connection if the certificate is not valid.

Ignore - the cmdlet will establish the connection without taking into account that the certificate is invalid.
Warn - the cmdlet will display a warning saying that the certificate is not valid, the reason why it is not considered valid and then will print additional information about the certificate.

false

Unset

ProxyPolicy

ProxyPolicy

Specify whether the vSphere PowerCLI uses a system proxy server to connect to the vSphere server. The valid values are NoProxy and UseSystemProxy.

false

true (ByValue)

WhatIf

SwitchParameter

Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.

false

Return Type

PowerCLIConfiguration

Notes

Examples

-------------- Example 1 --------------

Set-PowerCLIConfiguration -ProxyPolicy NoProxy -Confirm

Specifies that the VMware vSphere PowerCLI does not use a proxy server to connect to the vSphere server.

-------------- Example 2 --------------

Set-PowerCLIConfiguration -DefaultVIServerMode multiple ?Confirm

Sets the server connection mode of PowerCLI to "multiple".

-------------- Example 3 --------------

Set-PowerCLIConfiguration -ProxyPolicy NoProxy -DefaultVIServerMode Single

Changes the default server connection mode and the proxy policy of PowerCLI.

vSphere PowerCLI Reference

Synopsis