New-CimSessionOption

Specifies advanced options for the New-CimSession cmdlet. PowerShell reference

From the PowerShell reference 19 parameters Alias ncso

What it does

from the PowerShell reference, CC BY 4.0

Specifies advanced options for the New-CimSession cmdlet. The New-CimSessionOption cmdlet creates an instance of a CIM session options object. You use a CIM session options object as input to the New-CimSession cmdlet to specify the options for a CIM session. This cmdlet has two parameter sets, one for WsMan options and one for Distributed Component Object Model (DCOM) options. Depending on which parameters you use, the cmdlet returns either an instance of DCOM session options or returns WsMan session options.

New-CimSessionOption [-Protocol] <ProtocolType> [-UICulture <CultureInfo>] [-Culture <CultureInfo>] [<CommonParameters>]

New-CimSessionOption [-NoEncryption] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-EncodePortInServicePrincipalName] [-Encoding <PacketEncoding>] [-HttpPrefix <Uri>] [-MaxEnvelopeSizeKB <UInt32>] [-ProxyAuthentication <PasswordAuthenticationMechanism>] [-ProxyCertificateThumbprint <String>] [-ProxyCredential <PSCredential>] [-ProxyType <ProxyType>] [-UseSsl] [-UICulture <CultureInfo>] [-Culture <CultureInfo>] [<CommonParameters>]

New-CimSessionOption [-Impersonation <ImpersonationType>] [-PacketIntegrity] [-PacketPrivacy] [-UICulture <CultureInfo>] [-Culture <CultureInfo>] [<CommonParameters>]

Create a CIM session options object for DCOM

$so = New-CimSessionOption -Protocol Dcom
New-CimSession -ComputerName Server01 -SessionOption $so

Identify

Create a CIM session options object for WsMan

$option = @{
ProxyAuthentication = 'Kerberos'
ProxyCredential = $cred
SkipCACheck = $true
SkipCNCheck = $true
UseSsl = $true
}
New-CimSessionOption @option

Identify

Create a CIM session options object with the culture specified

New-CimSessionOption -Culture fr-FR -Protocol WsmanIdentify

Its page in the reference: New-CimSessionOption.

Parameters

19 in the PowerShell reference

Show its 19 parameters

-CultureSpecifies the user interface culture to use for the CIM session. Specify the value for this parameter using one of the following formats: - A culture name in <languagecode2>-<country/regioncode2> format such as "en-US". - A variable that contains a CultureInfo object. - A command that gets a CultureInfo object, such as Get-Culture

-EncodePortInServicePrincipalNameIndicates that the Kerberos connection is connecting to a service whose service principal name (SPN) includes the service port number. This type of connection is not common.

-EncodingSpecifies the encoding used for the WsMan protocol. The acceptable values for this parameter are: Default, Utf8, or Utf16.

-HttpPrefixSpecifies the part of the HTTP URL after the computer name and port number. Changing this is not common. By default, the value of this parameter is /wsman.

-ImpersonationCreates a DCOM session to Windows Management Instrumentation (WMI) using impersonation. Valid values for this parameter are: - Default: DCOM can choose the impersonation level using its normal security negotiation algorithm. - None: The client is anonymous to the server. The server process can impersonate the client, but the impersonation token does not contain any information and cannot be used. - Identify: Allows objects to query the credentials of the caller. - Impersonate: Allows objects to use the credentials of the caller. - Delegate: Allows objects to permit other objects to use the credentials of the caller. If Impersonation is not specified, the New-CimSession cmdlet uses the value of Impersonate.

-MaxEnvelopeSizeKBSpecifies the size limit of WsMan XML messages for either direction.

-NoEncryptionSpecifies that data encryption is turned off.

-PacketIntegritySpecifies that the DCOM session created to WMI uses the Component Object Model (COM) _PacketIntegrity_ functionality. By default, all CIM sessions created using DCOM have the PacketIntegrity parameter set to True.

-PacketPrivacyCreates a DCOM session to WMI using the COM _PacketPrivacy_. By default, all CIM sessions created using DCOM have the PacketPrivacy parameter set to true.

-ProtocolSpecifies the protocol to use. The acceptable values for this parameter are: Dcom, Default, or Wsman.

-ProxyAuthenticationSpecifies the authentication method to use for proxy resolution. The acceptable values for this parameter are: Default, Digest, Negotiate, Basic, Kerberos, NtlmDomain, or CredSsp.

-ProxyCertificateThumbprintSpecifies the (x.509) digital public key certificate of a user account for proxy authentication. Enter the certificate thumbprint of the certificate. Certificates are used in client certificate-based authentication. They can only be mapped to local user accounts and they do not work with domain accounts. To get a certificate thumbprint, use the Get-Item or Get-ChildItem cmdlets in the PowerShell Cert: drive.

-ProxyCredentialSpecifies the credentials to use for proxy authentication. Enter one of the following: - A variable that contains a PSCredential object. - A command that gets a PSCredential object, such as Get-Credential If this option is not set, then you cannot specify any credentials.

-ProxyTypeSpecifies the host name resolution mechanism to use. The acceptable values for this parameter are: None, WinHttp, Auto, or InternetExplorer. The default value of this parameter is InternetExplorer.

-SkipCACheckIndicates that when connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certification authority (CA). Use this parameter only when the remote computer is trusted using another mechanism, such as when the remote computer is part of a network that is physically secure and isolated, or when the remote computer is listed as a trusted host in a WinRM configuration.

-SkipCNCheckIndicates that the certificate common name (CN) of the server does not need to match the hostname of the server. Use this parameter for remote operations only with trusted computers that use the HTTPS protocol.

-SkipRevocationCheckIndicates that the revocation check for server certificates is skipped. Use this parameter only for trusted computers.

-UICultureSpecifies the user interface culture to use for the CIM session. Specify the value for this parameter using one of the following formats: - A culture name in <languagecode2>-<country/regioncode2> format such as "en-US". - A variable that contains a CultureInfo object. - A command that gets a CultureInfo object, such as Get-Culture.

-UseSslIndicates that SSL should be used to establish a connection to the remote computer. By default, SSL is not used. WsMan encrypts all content that is transmitted over the network, even when using HTTP. This parameter lets you specify the additional protection of HTTPS instead of HTTP. If SSL is not available on the port used for the connection and you specify this parameter, then the command fails. It is recommended that you use this parameter only when the PacketPrivacy parameter is not specified.

New-CimSessionOption

What it does

Parameters

See also