NewCimSessionOptionCommand Class

Definition

Namespace:

Microsoft.Management.Infrastructure.CimCmdlets

Assembly:

Microsoft.Management.Infrastructure.CimCmdlets.dll

Package:

Microsoft.Management.Infrastructure.CimCmdlets v7.4.0

The Cmdlet allows the IT Pro to create a CimSessionOptions object that she/he can subsequently use to create one or more CimSession connections. The options object holds the CIM Session information that is less commonly set and used by the IT Pro, and most commonly defaulted.

The Cmdlet has two parameter sets, one for WMMan options and one for DCOM options. Depending on the arguments the Cmdlet will return an instance of DComSessionOptions or WSManSessionOptions, which derive from CimSessionOptions.

[System.Management.Automation.Alias(new System.String[] { "ncso" })]
[System.Management.Automation.Cmdlet("New", "CimSessionOption", DefaultParameterSetName="ProtocolTypeSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227969")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.Management.Infrastructure.Options.CimSessionOptions) })]
public sealed class NewCimSessionOptionCommand : Microsoft.Management.Infrastructure.CimCmdlets.CimBaseCommand

[<System.Management.Automation.Alias(new System.String[] { "ncso" })>]
[<System.Management.Automation.Cmdlet("New", "CimSessionOption", DefaultParameterSetName="ProtocolTypeSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227969")>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.Management.Infrastructure.Options.CimSessionOptions) })>]
type NewCimSessionOptionCommand = class
    inherit CimBaseCommand

Public NotInheritable Class NewCimSessionOptionCommand
Inherits CimBaseCommand

Inheritance

Object

InternalCommand

Cmdlet

CimBaseCommand

NewCimSessionOptionCommand

Attributes

AliasAttribute CmdletAttribute OutputTypeAttribute

Constructors

NewCimSessionOptionCommand()

Initializes a new instance of the NewCimSessionOptionCommand class.

Properties

CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
Culture	The following is the definition of the input parameter "Culture". Specifies the culture to use. i.e. en-us, ar-sa.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
EncodePortInServicePrincipalName	The following is the definition of the input parameter "EncodePortInServicePrincipalName". Switch indicating if to encode Port In Service Principal Name.
Encoding	The following is the definition of the input parameter "Encoding". Defined the message encoding. The allowed encodings are { Default | Utf8 | Utf16 }. The default value should be Utf8.
HttpPrefix	The following is the definition of the input parameter "HttpPrefix". This is the HTTP URL on the server on which the WSMan service is listening. In most cases it is /wsman, which is the default.
Impersonation	The following is the definition of the input parameter "Impersonation". Used to select if, and if so what kind of, impersonation should be used. Applies only to the DCOM channel.
MaxEnvelopeSizeKB	The following is the definition of the input parameter "MaxEnvelopeSizeKB". Sets the limit to the maximum size of the WSMan message envelope.
NoEncryption	The following is the definition of the input parameter "NoEncryption". Switch indicating if WSMan can use no encryption in the given CimSession (there are also global client and server WSMan settings - AllowUnencrypted).
PacketIntegrity	The following is the definition of the input parameter "PacketIntegrity". Switch indicating if the package integrity in DCOM connections should be checked/enforced.
PacketPrivacy	The following is the definition of the input parameter "PacketPrivacy". Switch indicating if packet privacy of the packets in DCOM communications should be checked/enforced.
Protocol	The following is the definition of the input parameter "Protocol". Switch indicating if to encode Port In Service Principal Name.
ProxyAuthentication	The following is the definition of the input parameter "ProxyAuthentication". Which proxy authentication types to use: Allowed set is:
ProxyCertificateThumbprint	The following is the definition of the input parameter "ProxyCertificateThumbprint".
ProxyCredential	The following is the definition of the input parameter "ProxyCredential". Ps Credential used by the proxy server when required by the server.
ProxyType	The following is the definition of the input parameter "ProxyType". Which proxy type to use: Valid set is: { InternetExplorer | WinHttp | Auto | None }
SkipCACheck	The following is the definition of the input parameter "CertificateCACheck". Switch indicating if Certificate Authority should be validated.
SkipCNCheck	The following is the definition of the input parameter "CertificateCNCheck". Switch indicating if Certificate Name should be validated.
SkipRevocationCheck	The following is the definition of the input parameter "CertRevocationCheck". Switch indicating if certificate should be revoked.
Stopping	Is this command stopping? (Inherited from Cmdlet)
UICulture	The following is the definition of the input parameter "UICulture". Specifies the UI Culture to use. i.e. en-us, ar-sa.
UseSsl	The following is the definition of the input parameter "UseSSL". Switch indicating if Secure Sockets Layer connection should be used.

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
Dispose()	Dispose() calls Dispose(true). Implement IDisposable. Do not make this method virtual. A derived class should not be able to override this method. (Inherited from CimBaseCommand)
Dispose(Boolean)	Dispose(bool disposing) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. (Inherited from CimBaseCommand)
DisposeInternal()	Clean up resources. (Inherited from CimBaseCommand)
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	When overridden in the derived class, performs execution of the command. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	StopProcessing method. (Inherited from CimBaseCommand)
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)