File size: 11,816 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#region Using directives
using System;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
using Microsoft.Management.Infrastructure.Options;
#endregion
namespace Microsoft.Management.Infrastructure.CimCmdlets
{
/// <summary>
/// This Cmdlet enables the IT Pro to create a CIM Session. CIM Session object
/// is a client-side representation of the connection between the client and the
/// server.
/// The CimSession object returned by the Cmdlet is used by all other CIM
/// cmdlets.
/// </summary>
[Alias("ncms")]
[Cmdlet(VerbsCommon.New, "CimSession", DefaultParameterSetName = CredentialParameterSet, HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227967")]
[OutputType(typeof(CimSession))]
public sealed class NewCimSessionCommand : CimBaseCommand
{
#region cmdlet parameters
/// <summary>
/// The following is the definition of the input parameter "Authentication".
/// The following is the validation set for allowed authentication types.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = CredentialParameterSet)]
public PasswordAuthenticationMechanism Authentication
{
get
{
return authentication;
}
set
{
authentication = value;
authenticationSet = true;
}
}
private PasswordAuthenticationMechanism authentication;
private bool authenticationSet = false;
/// <summary>
/// The following is the definition of the input parameter "Credential".
/// Specifies a user account that has permission to perform this action.
/// The default is the current user.
/// </summary>
[Parameter(Position = 1, ParameterSetName = CredentialParameterSet)]
[Credential]
public PSCredential Credential { get; set; }
/// <summary>
/// The following is the definition of the input parameter "CertificateThumbprint".
/// This is specificly for wsman protocol.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = CertificateParameterSet)]
public string CertificateThumbprint { get; set; }
/// <summary>
/// The following is the definition of the input parameter "ComputerName".
/// Specifies the computer on which the commands associated with this session
/// will run. The default value is LocalHost.
/// </summary>
[Alias(AliasCN, AliasServerName)]
[Parameter(
Position = 0,
ValueFromPipelineByPropertyName = true)]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] ComputerName { get; set; }
/// <summary>
/// <para>
/// The following is the definition of the input parameter "Name".
/// Specifies a friendly name for the CIM Session connection.
/// </para>
/// <para>
/// If a name is not passed, then the session is given the name CimSession<int>,
/// where <int> is the next available session number. Example, CimSession1,
/// CimSession2, etc...
/// </para>
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true)]
public string Name { get; set; }
/// <summary>
/// <para>
/// The following is the definition of the input parameter "OperationTimeoutSec".
/// Specifies the operation timeout for all operations in session. Individual
/// operations can override this timeout.
/// </para>
/// <para>
/// The unit is Second.
/// </para>
/// </summary>
[Alias(AliasOT)]
[Parameter(ValueFromPipelineByPropertyName = true)]
public uint OperationTimeoutSec
{
get
{
return operationTimeout;
}
set
{
operationTimeout = value;
operationTimeoutSet = true;
}
}
private uint operationTimeout;
internal bool operationTimeoutSet = false;
/// <summary>
/// <para>
/// The following is the definition of the input parameter "SkipTestConnection".
/// Specifies where test connection should be skipped
/// </para>
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter SkipTestConnection { get; set; }
/// <summary>
/// The following is the definition of the input parameter "Port".
/// Specifies the port number to use, if different than the default port number.
/// This is specificly for wsman protocol.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true)]
public uint Port
{
get
{
return port;
}
set
{
port = value;
portSet = true;
}
}
private uint port;
private bool portSet = false;
/// <summary>
/// <para>
/// The following is the definition of the input parameter "SessionOption".
/// Specifies the SessionOption object that is passed to the Cmdlet as argument.
/// </para>
/// <para>
/// If the argument is not given, a default SessionOption will be created for
/// the session in .NET API layer.
/// </para>
/// <para>
/// If a <see cref="DCOMSessionOption"/> object is passed, then
/// connection is made using DCOM. If a <see cref="WsManSessionOption"/>
/// object is passed, then connection is made using WsMan.
/// </para>
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true)]
public Microsoft.Management.Infrastructure.Options.CimSessionOptions SessionOption { get; set; }
#endregion
#region cmdlet processing methods
/// <summary>
/// BeginProcessing method.
/// </summary>
protected override void BeginProcessing()
{
cimNewSession = new CimNewSession();
this.CmdletOperation = new CmdletOperationTestCimSession(this, this.cimNewSession);
this.AtBeginProcess = false;
}
/// <summary>
/// ProcessRecord method.
/// </summary>
protected override void ProcessRecord()
{
CimSessionOptions outputOptions;
CimCredential outputCredential;
BuildSessionOptions(out outputOptions, out outputCredential);
cimNewSession.NewCimSession(this, outputOptions, outputCredential);
cimNewSession.ProcessActions(this.CmdletOperation);
}
/// <summary>
/// EndProcessing method.
/// </summary>
protected override void EndProcessing()
{
cimNewSession.ProcessRemainActions(this.CmdletOperation);
}
#endregion
#region helper methods
/// <summary>
/// Build a CimSessionOptions, used to create CimSession.
/// </summary>
/// <returns>Null means no prefer CimSessionOptions.</returns>
internal void BuildSessionOptions(out CimSessionOptions outputOptions, out CimCredential outputCredential)
{
DebugHelper.WriteLogEx();
CimSessionOptions options = null;
if (this.SessionOption != null)
{
// clone the sessionOption object
if (this.SessionOption is WSManSessionOptions)
{
options = new WSManSessionOptions(this.SessionOption as WSManSessionOptions);
}
else
{
options = new DComSessionOptions(this.SessionOption as DComSessionOptions);
}
}
outputOptions = null;
outputCredential = null;
if (options != null)
{
if (options is DComSessionOptions dcomOptions)
{
bool conflict = false;
string parameterName = string.Empty;
if (this.CertificateThumbprint != null)
{
conflict = true;
parameterName = @"CertificateThumbprint";
}
if (portSet)
{
conflict = true;
parameterName = @"Port";
}
if (conflict)
{
ThrowConflictParameterWasSet(@"New-CimSession", parameterName, @"DComSessionOptions");
return;
}
}
}
if (portSet || (this.CertificateThumbprint != null))
{
WSManSessionOptions wsmanOptions = (options == null) ? new WSManSessionOptions() : options as WSManSessionOptions;
if (portSet)
{
wsmanOptions.DestinationPort = this.Port;
portSet = false;
}
if (this.CertificateThumbprint != null)
{
CimCredential credentials = new(CertificateAuthenticationMechanism.Default, this.CertificateThumbprint);
wsmanOptions.AddDestinationCredentials(credentials);
}
options = wsmanOptions;
}
if (this.operationTimeoutSet)
{
if (options != null)
{
options.Timeout = TimeSpan.FromSeconds((double)this.OperationTimeoutSec);
}
}
if (this.authenticationSet || (this.Credential != null))
{
PasswordAuthenticationMechanism authentication = this.authenticationSet ? this.Authentication : PasswordAuthenticationMechanism.Default;
if (this.authenticationSet)
{
this.authenticationSet = false;
}
CimCredential credentials = CreateCimCredentials(this.Credential, authentication, @"New-CimSession", @"Authentication");
if (credentials == null)
{
return;
}
DebugHelper.WriteLog("Credentials: {0}", 1, credentials);
outputCredential = credentials;
if (options != null)
{
DebugHelper.WriteLog("Add credentials to option: {0}", 1, options);
options.AddDestinationCredentials(credentials);
}
}
DebugHelper.WriteLogEx("Set outputOptions: {0}", 1, outputOptions);
outputOptions = options;
}
#endregion
#region private members
/// <summary>
/// <para>
/// CimNewSession object
/// </para>
/// </summary>
private CimNewSession cimNewSession;
#endregion
#region IDisposable
/// <summary>
/// Clean up resources.
/// </summary>
protected override void DisposeInternal()
{
base.DisposeInternal();
// Dispose managed resources.
this.cimNewSession?.Dispose();
}
#endregion
}
}
|