Set-PowerCLIConfiguration

This cmdlet modifies the VMware PowerCLI configuration.

Syntax

[-CEIPDataTransferProxyPolicy  <ProxyPolicy>]
[-DefaultVIServerMode  <DefaultVIServerMode>]
[-DisplayDeprecationWarnings  <Boolean>]
[-InvalidCertificateAction  <BadCertificateAction>]
[-ParticipateInCeip  <Boolean>]
[-ProxyPolicy  <ProxyPolicy>]
[-Scope  <ConfigurationScope>]
[-VMConsoleWindowBrowser  <String>]
[-WebOperationTimeoutSeconds  <Int32>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
CEIPDataTransferProxyPolicy
ProxyPolicy named Specifies the proxy policy for the connection through which Customer Experience Improvement Program (CEIP) data is sent to VMware. Setting this option is valid only when ParticipateInCEIP option is set to $true. Changing this setting requires a restart of PowerCLI before it takes effect.
optional
DefaultVIServerMode
DefaultVIServerMode named Specifies the server connection mode. The new configuration takes effect immediately after you run the cmdlet. The following values are valid:
optional
DisplayDeprecationWarnings
Boolean named Indicates whether you want to see warnings about deprecated elements.
optional
InvalidCertificateAction
BadCertificateAction named Define the action to take when an attempted connection to a server fails due to a certificate error. The following values are valid:
optional
ParticipateInCeip
Boolean named Specifies if PowerCLI should send anonymous usage information to VMware. For more information about the Customer Experience Improvement Program (CEIP), see the PowerCLI User's Guide. Setting this option is valid only for the AllUsers and User configuration scopes. Changing this setting requires a restart of PowerCLI before it takes effect.
optional
ProxyPolicy
ProxyPolicy named
  • pipeline
  • Specifies whether VMware PowerCLI uses a system proxy server to connect to the vCenter Server system. The valid values are NoProxy and UseSystemProxy.
    optional
    Scope
    ConfigurationScope named Specifies the scope of the setting that you want to modify. The parameter accepts Session, User, and All Users values. *Session - the setting is valid for the current VMware PowerCLI session only and overrides any User and All Users settings. *User - the setting is valid for the current Windows user only, overrides All Users settings, and is applied only if a Session setting cannot be detected. *All Users - the setting is valid for all users and is applied only if Session and User settings cannot be detected.
    optional
    VMConsoleWindowBrowser
    String named Specifies the Web browser to be used for opening virtual machine console windows (by using the Open-VMConsoleWindow cmdlet). The browser must be 32-bit.
    optional
    WebOperationTimeoutSeconds
    Int32 named Defines the timeout for Web operations. The default value is 300 sec. To specify an infinite operation timeout, pass a negative integer to this parameter. Changing this setting requires a restart of PowerCLI before it takes effect.

    Output

    VMware.VimAutomation.ViCore.Types.V1.PowerCLIConfiguration

    Examples


    Example 1

    Set-PowerCLIConfiguration -ProxyPolicy NoProxy -Scope Session

    Modifies the proxy policy of VMware PowerCLI for the Session scope.

    Example 2

    Set-PowerCLIConfiguration -ProxyPolicy NoProxy -DefaultVIServerMode Single

    Changes the default server connection mode and the proxy policy of VMware PowerCLI for the User scope.

    Example 3

    Set-PowerCLIConfiguration -DefaultVIServerMode 'Single' -Scope ([VMware.VimAutomation.ViCore.Types.V1.ConfigurationScope]::User -bor [VMware.VimAutomation.ViCore.Types.V1.ConfigurationScope]::AllUsers)

    Changes the default server connection mode of VMware PowerCLI for the User and AllUsers scopes.

    Related Commands

    Feedback

    Was this page helpful?