File size: 13,316 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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation.Internal;
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation.Runspaces
{
/// <summary>
/// Computer target type.
/// </summary>
public enum TargetMachineType
{
/// <summary>
/// Target is a machine with which the session is based on networking.
/// </summary>
RemoteMachine,
/// <summary>
/// Target is a virtual machine with which the session is based on Hyper-V socket.
/// </summary>
VirtualMachine,
/// <summary>
/// Target is a container with which the session is based on Hyper-V socket (Hyper-V
/// container) or named pipe (windows container)
/// </summary>
Container
}
/// <summary>
/// Class that exposes read only properties and which conveys information
/// about a remote runspace object to the user. The class serves the
/// following purpose:
/// 1. Exposes useful information to the user as properties
/// 2. Shields the remote runspace object from directly being exposed
/// to the user. This way, the user will not be able to directly
/// act upon the object, but instead will have to use the remoting
/// cmdlets. This will prevent any unpredictable behavior.
/// </summary>
public sealed class PSSession
{
#region Private Members
private RemoteRunspace _remoteRunspace;
private string _transportName;
/// <summary>
/// Static variable which is incremented to generate id.
/// </summary>
private static int s_seed = 0;
#endregion Private Members
#region Public Properties
/// <summary>
/// Type of the computer target.
/// </summary>
public TargetMachineType ComputerType { get; set; }
/// <summary>
/// Name of the computer target.
/// </summary>
public string ComputerName
{
get
{
return _remoteRunspace.ConnectionInfo.ComputerName;
}
}
/// <summary>
/// Id of the container target.
/// </summary>
public string ContainerId
{
get
{
if (ComputerType == TargetMachineType.Container)
{
ContainerConnectionInfo connectionInfo = _remoteRunspace.ConnectionInfo as ContainerConnectionInfo;
return connectionInfo.ContainerProc.ContainerId;
}
else
{
return string.Empty;
}
}
}
/// <summary>
/// Name of the virtual machine target.
/// </summary>
public string VMName
{
get
{
if (ComputerType == TargetMachineType.VirtualMachine)
{
return _remoteRunspace.ConnectionInfo.ComputerName;
}
else
{
return string.Empty;
}
}
}
/// <summary>
/// Guid of the virtual machine target.
/// </summary>
public Guid? VMId
{
get
{
if (ComputerType == TargetMachineType.VirtualMachine)
{
VMConnectionInfo connectionInfo = _remoteRunspace.ConnectionInfo as VMConnectionInfo;
return connectionInfo.VMGuid;
}
else
{
return null;
}
}
}
/// <summary>
/// Shell which is executed in the remote machine.
/// </summary>
public string ConfigurationName { get; }
/// <summary>
/// InstanceID that identifies this runspace.
/// </summary>
public Guid InstanceId
{
get
{
return _remoteRunspace.InstanceId;
}
}
/// <summary>
/// SessionId of this runspace. This is unique only across
/// a session.
/// </summary>
public int Id { get; }
/// <summary>
/// Friendly name for identifying this runspace.
/// </summary>
public string Name { get; set; }
/// <summary>
/// Indicates whether the specified runspace is available
/// for executing commands.
/// </summary>
public RunspaceAvailability Availability
{
get
{
return Runspace.RunspaceAvailability;
}
}
/// <summary>
/// Private data to be used by applications built on top of PowerShell.
/// Optionally sent by the remote server when creating a new session / runspace.
/// </summary>
public PSPrimitiveDictionary ApplicationPrivateData
{
get
{
return this.Runspace.GetApplicationPrivateData();
}
}
/// <summary>
/// The remote runspace object based on which this information object
/// is derived.
/// </summary>
/// <remarks>This property is marked internal to allow other cmdlets
/// to get access to the RemoteRunspace object and operate on it like
/// for instance test-runspace, close-runspace etc</remarks>
public Runspace Runspace
{
get
{
return _remoteRunspace;
}
}
/// <summary>
/// Name of the transport used.
/// </summary>
public string Transport => GetTransportName();
#endregion Public Properties
#region Public Methods
/// <summary>
/// ToString method override.
/// </summary>
/// <returns>String.</returns>
public override string ToString()
{
// PSSession is a PowerShell type name and so should not be localized.
const string formatString = "[PSSession]{0}";
return StringUtil.Format(formatString, Name);
}
#endregion
#region Internal Methods
/// <summary>
/// Internal method to insert a runspace into a PSSession object.
/// This is used only for Disconnect/Reconnect scenarios where the
/// new runspace is a reconstructed runspace having the same Guid
/// as the existing runspace.
/// </summary>
/// <param name="remoteRunspace">Runspace to insert.</param>
/// <returns>Boolean indicating if runspace was inserted.</returns>
internal bool InsertRunspace(RemoteRunspace remoteRunspace)
{
if (remoteRunspace == null ||
remoteRunspace.InstanceId != _remoteRunspace.InstanceId)
{
return false;
}
_remoteRunspace = remoteRunspace;
return true;
}
#endregion
#region Constructor
/// <summary>
/// This constructor will be used to created a remote runspace info
/// object with a auto generated name.
/// </summary>
/// <param name="remoteRunspace">Remote runspace object for which
/// the info object need to be created</param>
internal PSSession(RemoteRunspace remoteRunspace)
{
_remoteRunspace = remoteRunspace;
// Use passed in session Id, if available.
if (remoteRunspace.PSSessionId != -1)
{
Id = remoteRunspace.PSSessionId;
}
else
{
Id = System.Threading.Interlocked.Increment(ref s_seed);
remoteRunspace.PSSessionId = Id;
}
// Use passed in friendly name, if available.
if (!string.IsNullOrEmpty(remoteRunspace.PSSessionName))
{
Name = remoteRunspace.PSSessionName;
}
else
{
Name = "Runspace" + Id;
remoteRunspace.PSSessionName = Name;
}
switch (remoteRunspace.ConnectionInfo)
{
case WSManConnectionInfo _:
ComputerType = TargetMachineType.RemoteMachine;
string fullShellName = WSManConnectionInfo.ExtractPropertyAsWsManConnectionInfo<string>(
remoteRunspace.ConnectionInfo,
"ShellUri", string.Empty);
ConfigurationName = GetDisplayShellName(fullShellName);
break;
case VMConnectionInfo vmConnectionInfo:
ComputerType = TargetMachineType.VirtualMachine;
ConfigurationName = vmConnectionInfo.ConfigurationName;
break;
case ContainerConnectionInfo containerConnectionInfo:
ComputerType = TargetMachineType.Container;
ConfigurationName = containerConnectionInfo.ContainerProc.ConfigurationName;
break;
case SSHConnectionInfo _:
ComputerType = TargetMachineType.RemoteMachine;
ConfigurationName = "DefaultShell";
break;
case NewProcessConnectionInfo _:
ComputerType = TargetMachineType.RemoteMachine;
break;
default:
// Default for custom connection and transports.
ComputerType = TargetMachineType.RemoteMachine;
break;
}
}
#endregion Constructor
#region Private Methods
/// <summary>
/// Generates and returns the runspace name.
/// </summary>
/// <returns>Auto generated name.</returns>
private string GetTransportName()
{
switch (_remoteRunspace.ConnectionInfo)
{
case WSManConnectionInfo _:
return "WSMan";
case SSHConnectionInfo _:
return "SSH";
case NamedPipeConnectionInfo _:
return "NamedPipe";
case ContainerConnectionInfo _:
return "Container";
case NewProcessConnectionInfo _:
return "Process";
case VMConnectionInfo _:
return "VMBus";
default:
return string.IsNullOrEmpty(_transportName) ? "Custom" : _transportName;
}
}
/// <summary>
/// Returns shell configuration name with shell prefix removed.
/// </summary>
/// <param name="shell">Shell configuration name.</param>
/// <returns>Display shell name.</returns>
private static string GetDisplayShellName(string shell)
{
const string shellPrefix = System.Management.Automation.Remoting.Client.WSManNativeApi.ResourceURIPrefix;
int index = shell.IndexOf(shellPrefix, StringComparison.OrdinalIgnoreCase);
return (index == 0) ? shell.Substring(shellPrefix.Length) : shell;
}
#endregion Private Methods
#region Static Methods
/// <summary>
/// Creates a PSSession object from the provided remote runspace object.
/// If psCmdlet argument is non-null, then the new PSSession object is added to the
/// session runspace repository (Get-PSSession).
/// </summary>
/// <param name="runspace">Runspace for the new PSSession.</param>
/// <param name="transportName">Optional transport name.</param>
/// <param name="psCmdlet">Optional cmdlet associated with the PSSession creation.</param>
public static PSSession Create(
Runspace runspace,
string transportName,
PSCmdlet psCmdlet)
{
if (runspace is not RemoteRunspace remoteRunspace)
{
throw new PSArgumentException(RemotingErrorIdStrings.InvalidPSSessionArgument);
}
var psSession = new PSSession(remoteRunspace)
{
_transportName = transportName
};
psCmdlet?.RunspaceRepository.Add(psSession);
return psSession;
}
/// <summary>
/// Generates a unique runspace id.
/// </summary>
/// <param name="rtnId">Returned Id.</param>
/// <returns>Returned name.</returns>
internal static string GenerateRunspaceName(out int rtnId)
{
int id = GenerateRunspaceId();
rtnId = id;
return "Runspace" + id.ToString();
}
/// <summary>
/// Increments and returns a session unique runspace Id.
/// </summary>
/// <returns>Id.</returns>
internal static int GenerateRunspaceId()
{
return System.Threading.Interlocked.Increment(ref s_seed);
}
#endregion
}
}
|