File size: 57,032 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 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
using System.Management.Automation.Internal;
using System.Management.Automation.Remoting;
using System.Management.Automation.Remoting.Client;
using System.Management.Automation.Runspaces;
using System.Threading;
using Dbg = System.Management.Automation.Diagnostics;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// This cmdlet connects a running command associated with a PS session and then
/// directs the command output either:
/// a) To Host. This is the synchronous mode of the cmdlet which won't return
/// until the running command completes and all output data is received on
/// the client.
/// b) To a job object. This is the asynchronous mode of the cmdlet which will
/// return immediately providing the job object that is collecting the
/// running command output data.
///
/// The running command becomes disconnected when the associated runspace is
/// disconnected (via the Disconnect-PSSession cmdlet).
///
/// The associated runspace object must be in the Opened state (connected) before
/// the running command can be connected. If the associated runspace object is
/// in the disconnected state, it will first be connected before the running
/// command is connected.
///
/// The user can specify how command output data is returned by using the public
/// OutTarget enumeration (Host, Job).
/// The default actions of this cmdlet is to always direct output to host unless
/// a job object already exists on the client that is associated with the running
/// command. In this case the existing job object is connected to the running
/// command and returned.
///
/// The cmdlet can be used in the following ways:
///
/// Receive PS session data by session object
/// > $session = New-PSSession serverName
/// > $job1 = Invoke-Command $session { [script] } -asjob
/// > Disconnect-PSSession $session
/// > Connect-PSSession $session
/// > Receive-PSSession $session // command output continues collecting at job object.
///
/// Receive PS session data by session Id
/// > Receive-PSSession $session.Id
///
/// Receive PS session data by session instance Id
/// > Receive-PSSession $session.InstanceId
///
/// Receive PS session data by session Name. Direct output to job
/// > Receive-PSSession $session.Name
///
/// Receive a running command from a computer.
/// > $job = Receive-PSSession -ComputerName ServerOne -Name SessionName -OutTarget Job.
/// </summary>
[SuppressMessage("Microsoft.PowerShell", "PS1012:CallShouldProcessOnlyIfDeclaringSupport")]
[Cmdlet(VerbsCommunications.Receive, "PSSession", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Low,
DefaultParameterSetName = ReceivePSSessionCommand.SessionParameterSet, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096800",
RemotingCapability = RemotingCapability.OwnedByCommand)]
public class ReceivePSSessionCommand : PSRemotingCmdlet
{
#region Parameters
private const string IdParameterSet = "Id";
private const string InstanceIdParameterSet = "InstanceId";
private const string NameParameterSet = "SessionName";
private const string ComputerSessionNameParameterSet = "ComputerSessionName"; // Computer name and session Name.
private const string ConnectionUriSessionNameParameterSet = "ConnectionUriSessionName";
private const string ConnectionUriInstanceIdParameterSet = "ConnectionUriInstanceId";
/// <summary>
/// The PSSession object to receive data from.
/// </summary>
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ValueFromPipeline = true,
ParameterSetName = ReceivePSSessionCommand.SessionParameterSet)]
[ValidateNotNullOrEmpty]
public PSSession Session { get; set; }
/// <summary>
/// Session Id of PSSession object to receive data from.
/// </summary>
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ValueFromPipeline = true,
ParameterSetName = ReceivePSSessionCommand.IdParameterSet)]
public int Id { get; set; }
/// <summary>
/// Computer name to receive session data from.
/// </summary>
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[ValidateNotNullOrEmpty]
[Alias("Cn")]
public string ComputerName { get; set; }
/// <summary>
/// This parameters specifies the appname which identifies the connection
/// end point on the remote machine. If this parameter is not specified
/// then the value specified in DEFAULTREMOTEAPPNAME will be used. If that's
/// not specified as well, then "WSMAN" will be used.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
public string ApplicationName
{
get
{
return _appName;
}
set
{
_appName = ResolveAppName(value);
}
}
private string _appName;
/// <summary>
/// If this parameter is not specified then the value specified in
/// the environment variable DEFAULTREMOTESHELLNAME will be used. If
/// this is not set as well, then Microsoft.PowerShell is used.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
public string ConfigurationName
{
get
{
return _shell;
}
set
{
_shell = ResolveShell(value);
}
}
private string _shell;
/// <summary>
/// A complete URI(s) specified for the remote computer and shell to
/// connect to and create a runspace for.
/// </summary>
[Parameter(Position = 0, Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(Position = 0, Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
[ValidateNotNullOrEmpty]
[Alias("URI", "CU")]
public Uri ConnectionUri { get; set; }
/// <summary>
/// The AllowRedirection parameter enables the implicit redirection functionality.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
public SwitchParameter AllowRedirection
{
get { return _allowRedirection; }
set { _allowRedirection = value; }
}
private bool _allowRedirection = false;
/// <summary>
/// Instance Id of PSSession object to receive data from.
/// </summary>
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ValueFromPipeline = true,
ParameterSetName = ReceivePSSessionCommand.InstanceIdParameterSet)]
[Parameter(Mandatory = true,
ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(Mandatory = true,
ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
[ValidateNotNullOrEmpty]
public Guid InstanceId { get; set; }
/// <summary>
/// Name of PSSession object to receive data from.
/// </summary>
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ValueFromPipeline = true,
ParameterSetName = ReceivePSSessionCommand.NameParameterSet)]
[Parameter(Mandatory = true,
ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(Mandatory = true,
ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[ValidateNotNullOrEmpty]
public string Name { get; set; }
/// <summary>
/// Determines how running command output is returned on client.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.SessionParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.IdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.InstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.NameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
public OutTarget OutTarget { get; set; } = OutTarget.Default;
/// <summary>
/// Provides job name when job is created for returned data.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.SessionParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.IdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.InstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.NameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
[ValidateNotNullOrEmpty]
public string JobName { get; set; } = string.Empty;
/// <summary>
/// Specifies the credentials of the user to impersonate in the
/// remote machine. If this parameter is not specified then the
/// credentials of the current user process will be assumed.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
[Credential]
public PSCredential Credential
{
get
{
return _psCredential;
}
set
{
_psCredential = value;
PSRemotingBaseCmdlet.ValidateSpecifiedAuthentication(Credential, CertificateThumbprint, Authentication);
}
}
private PSCredential _psCredential;
/// <summary>
/// Use basic authentication to authenticate the user.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
public AuthenticationMechanism Authentication
{
get
{
return _authentication;
}
set
{
_authentication = value;
PSRemotingBaseCmdlet.ValidateSpecifiedAuthentication(Credential, CertificateThumbprint, Authentication);
}
}
private AuthenticationMechanism _authentication;
/// <summary>
/// Specifies the certificate thumbprint to be used to impersonate the user on the
/// remote machine.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
public string CertificateThumbprint
{
get
{
return _thumbprint;
}
set
{
_thumbprint = value;
PSRemotingBaseCmdlet.ValidateSpecifiedAuthentication(Credential, CertificateThumbprint, Authentication);
}
}
private string _thumbprint;
/// <summary>
/// Port specifies the alternate port to be used in case the
/// default ports are not used for the transport mechanism
/// (port 80 for http and port 443 for useSSL)
/// </summary>
/// <remarks>
/// Currently this is being accepted as a parameter. But in future
/// support will be added to make this a part of a policy setting.
/// When a policy setting is in place this parameter can be used
/// to override the policy setting
/// </remarks>
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[ValidateRange((int)1, (int)UInt16.MaxValue)]
public int Port { get; set; }
/// <summary>
/// This parameter suggests that the transport scheme to be used for
/// remote connections is useSSL instead of the default http.Since
/// there are only two possible transport schemes that are possible
/// at this point, a SwitchParameter is being used to switch between
/// the two.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "SSL")]
public SwitchParameter UseSSL { get; set; }
/// <summary>
/// Session options.
/// </summary>
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerInstanceIdParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ComputerSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)]
[Parameter(ParameterSetName = ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)]
public PSSessionOption SessionOption { get; set; }
#endregion
#region Cmdlet Overrides
/// <summary>
/// Process input.
/// </summary>
protected override void ProcessRecord()
{
if (ParameterSetName == ReceivePSSessionCommand.ComputerSessionNameParameterSet ||
ParameterSetName == ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)
{
QueryForAndConnectCommands(Name, Guid.Empty);
}
else if (ParameterSetName == ReceivePSSessionCommand.ComputerInstanceIdParameterSet ||
ParameterSetName == ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet)
{
QueryForAndConnectCommands(string.Empty, InstanceId);
}
else
{
GetAndConnectSessionCommand();
}
}
/// <summary>
/// User has signaled a stop for this cmdlet.
/// </summary>
protected override void StopProcessing()
{
RemotePipeline tmpPipeline;
Job tmpJob;
lock (_syncObject)
{
_stopProcessing = true;
tmpPipeline = _remotePipeline;
tmpJob = _job;
}
tmpPipeline?.StopAsync();
tmpJob?.StopJob();
}
#endregion
#region Private Methods
/// <summary>
/// Queries the remote computer for the specified session, creates a disconnected
/// session object, connects the runspace/command and collects command data.
/// Command output is either returned (OutTarget.Host) or collected
/// in a job object that is returned (OutTarget.Job).
/// </summary>
/// <param name="name">Name of session to find.</param>
/// <param name="instanceId">Instance Id of session to find.</param>
private void QueryForAndConnectCommands(string name, Guid instanceId)
{
WSManConnectionInfo connectionInfo = GetConnectionObject();
// Retrieve all disconnected runspaces on the remote computer.
Runspace[] runspaces;
try
{
runspaces = Runspace.GetRunspaces(connectionInfo, this.Host, QueryRunspaces.BuiltInTypesTable);
}
catch (System.Management.Automation.RuntimeException e)
{
int errorCode;
string msg = StringUtil.Format(RemotingErrorIdStrings.QueryForRunspacesFailed, connectionInfo.ComputerName,
QueryRunspaces.ExtractMessage(e.InnerException, out errorCode));
string FQEID = WSManTransportManagerUtils.GetFQEIDFromTransportError(errorCode, "ReceivePSSessionQueryForSessionFailed");
Exception reason = new RuntimeException(msg, e.InnerException);
ErrorRecord errorRecord = new ErrorRecord(reason, FQEID, ErrorCategory.InvalidOperation, connectionInfo);
WriteError(errorRecord);
return;
}
// Convert configuration name into shell Uri for comparison.
string shellUri = null;
if (!string.IsNullOrEmpty(ConfigurationName))
{
shellUri = ConfigurationName.Contains(WSManNativeApi.ResourceURIPrefix, StringComparison.OrdinalIgnoreCase)
? ConfigurationName
: WSManNativeApi.ResourceURIPrefix + ConfigurationName;
}
// Connect selected runspace/command and direct command output to host
// or job objects.
foreach (Runspace runspace in runspaces)
{
if (_stopProcessing)
{
break;
}
// Filter returned runspaces by ConfigurationName if provided.
if (shellUri != null)
{
// Compare with returned shell Uri in connection info.
WSManConnectionInfo wsmanConnectionInfo = runspace.ConnectionInfo as WSManConnectionInfo;
if (wsmanConnectionInfo != null &&
!shellUri.Equals(wsmanConnectionInfo.ShellUri, StringComparison.OrdinalIgnoreCase))
{
continue;
}
}
// Find specified session.
bool haveMatch = false;
if (!string.IsNullOrEmpty(name) &&
string.Equals(name, ((RemoteRunspace)runspace).RunspacePool.RemoteRunspacePoolInternal.Name, StringComparison.OrdinalIgnoreCase))
{
// Selected by friendly name.
haveMatch = true;
}
else if (instanceId.Equals(runspace.InstanceId))
{
// Selected by instance Id (note that session/runspace/runspacepool instanceIds are identical.)
haveMatch = true;
}
if (haveMatch &&
ShouldProcess(((RemoteRunspace)runspace).PSSessionName, VerbsCommunications.Receive))
{
// Check the local repository for an existing viable session.
PSSession locSession = this.RunspaceRepository.GetItem(runspace.InstanceId);
// Connect the session here. If it fails (connectedSession == null) revert to the
// reconstruct method.
Exception ex;
PSSession connectedSession = ConnectSession(locSession, out ex);
if (connectedSession != null)
{
// Make sure that this connected session is included in the PSSession repository.
// If it already exists then replace it because we want the latest/connected session in the repository.
this.RunspaceRepository.AddOrReplace(connectedSession);
// Since we have a local runspace we will do a *reconnect* operation and will
// need the corresponding job object.
PSRemotingJob job = FindJobForSession(connectedSession);
if (this.OutTarget == OutTarget.Host)
{
ConnectSessionToHost(connectedSession, job);
}
else
{
// Connection to Job is default option.
ConnectSessionToJob(connectedSession, job);
}
}
else
{
// Otherwise create a new session from the queried runspace object.
// This will be a *reconstruct* operation.
// Create and connect session.
PSSession newSession = new PSSession(runspace as RemoteRunspace);
connectedSession = ConnectSession(newSession, out ex);
if (connectedSession != null)
{
// Try to reuse the existing local repository PSSession object.
if (locSession != null)
{
connectedSession = locSession.InsertRunspace(connectedSession.Runspace as RemoteRunspace) ? locSession : connectedSession;
}
// Make sure that this connected session is included in the PSSession repository.
// If it already exists then replace it because we want the latest/connected session in the repository.
this.RunspaceRepository.AddOrReplace(connectedSession);
if (this.OutTarget == OutTarget.Job)
{
ConnectSessionToJob(connectedSession);
}
else
{
// Connection to Host is default option.
ConnectSessionToHost(connectedSession);
}
}
else
{
string message = StringUtil.Format(RemotingErrorIdStrings.RunspaceCannotBeConnected, newSession.Name);
WriteError(new ErrorRecord(new ArgumentException(message, ex), "ReceivePSSessionCannotConnectSession",
ErrorCategory.InvalidOperation, newSession));
}
}
break;
}
}
}
private WSManConnectionInfo GetConnectionObject()
{
WSManConnectionInfo connectionInfo = new WSManConnectionInfo();
if (ParameterSetName == ReceivePSSessionCommand.ComputerSessionNameParameterSet ||
ParameterSetName == ReceivePSSessionCommand.ComputerInstanceIdParameterSet)
{
// Create the WSManConnectionInfo object for the specified computer name.
string scheme = UseSSL.IsPresent ? WSManConnectionInfo.HttpsScheme : WSManConnectionInfo.HttpScheme;
connectionInfo.Scheme = scheme;
connectionInfo.ComputerName = ResolveComputerName(ComputerName);
connectionInfo.AppName = ApplicationName;
connectionInfo.ShellUri = ConfigurationName;
connectionInfo.Port = Port;
if (CertificateThumbprint != null)
{
connectionInfo.CertificateThumbprint = CertificateThumbprint;
}
else
{
connectionInfo.Credential = Credential;
}
connectionInfo.AuthenticationMechanism = Authentication;
UpdateConnectionInfo(connectionInfo);
}
else
{
connectionInfo.ConnectionUri = ConnectionUri;
connectionInfo.ShellUri = ConfigurationName;
if (CertificateThumbprint != null)
{
connectionInfo.CertificateThumbprint = CertificateThumbprint;
}
else
{
connectionInfo.Credential = Credential;
}
connectionInfo.AuthenticationMechanism = Authentication;
UpdateConnectionInfo(connectionInfo);
}
return connectionInfo;
}
/// <summary>
/// Updates connection info with the data read from cmdlet's parameters.
/// </summary>
/// <param name="connectionInfo"></param>
private void UpdateConnectionInfo(WSManConnectionInfo connectionInfo)
{
if (ParameterSetName != ReceivePSSessionCommand.ConnectionUriInstanceIdParameterSet &&
ParameterSetName != ReceivePSSessionCommand.ConnectionUriSessionNameParameterSet)
{
// uri redirection is supported only with URI parameter set
connectionInfo.MaximumConnectionRedirectionCount = 0;
}
if (!_allowRedirection)
{
// uri redirection required explicit user consent
connectionInfo.MaximumConnectionRedirectionCount = 0;
}
// Update the connectionInfo object with passed in session options.
if (SessionOption != null)
{
connectionInfo.SetSessionOptions(SessionOption);
}
}
/// <summary>
/// Gets the PSSession object to connect based on Id, Name, etc.
/// Connects the running command associated with the PSSession runspace object.
/// Command output is either returned (OutTarget.Host) or collected
/// in a job object that is returned (OutTarget.Job).
/// </summary>
private void GetAndConnectSessionCommand()
{
PSSession session = null;
if (ParameterSetName == ReceivePSSessionCommand.SessionParameterSet)
{
session = Session;
}
else if (ParameterSetName == ReceivePSSessionCommand.IdParameterSet)
{
session = GetSessionById(Id);
if (session == null)
{
WriteInvalidArgumentError(PSRemotingErrorId.RemoteRunspaceNotAvailableForSpecifiedSessionId,
RemotingErrorIdStrings.RemoteRunspaceNotAvailableForSpecifiedSessionId,
Id);
return;
}
}
else if (ParameterSetName == ReceivePSSessionCommand.NameParameterSet)
{
session = GetSessionByName(Name);
if (session == null)
{
WriteInvalidArgumentError(PSRemotingErrorId.RemoteRunspaceNotAvailableForSpecifiedName,
RemotingErrorIdStrings.RemoteRunspaceNotAvailableForSpecifiedName,
Name);
return;
}
}
else if (ParameterSetName == ReceivePSSessionCommand.InstanceIdParameterSet)
{
session = GetSessionByInstanceId(InstanceId);
if (session == null)
{
WriteInvalidArgumentError(PSRemotingErrorId.RemoteRunspaceNotAvailableForSpecifiedRunspaceId,
RemotingErrorIdStrings.RemoteRunspaceNotAvailableForSpecifiedRunspaceId,
InstanceId);
return;
}
}
else
{
Dbg.Assert(false, "Invalid Parameter Set");
}
// PS session disconnection is not supported for VM/Container sessions.
if (session.ComputerType != TargetMachineType.RemoteMachine)
{
string msg = StringUtil.Format(RemotingErrorIdStrings.RunspaceCannotBeReceivedForVMContainerSession,
session.Name, session.ComputerName, session.ComputerType);
Exception reason = new PSNotSupportedException(msg);
ErrorRecord errorRecord = new ErrorRecord(reason, "CannotReceiveVMContainerSession", ErrorCategory.InvalidOperation, session);
WriteError(errorRecord);
return;
}
if (ShouldProcess(session.Name, VerbsCommunications.Receive))
{
Exception ex;
if (ConnectSession(session, out ex) == null)
{
// Unable to connect runspace. If this was a *reconnect* runspace then try
// obtaining a connectable runspace directly from the server and do a
// *reconstruct* connect.
PSSession oldSession = session;
session = TryGetSessionFromServer(oldSession);
if (session == null)
{
// No luck. Return error.
string message = StringUtil.Format(RemotingErrorIdStrings.RunspaceCannotBeConnected, oldSession.Name);
WriteError(new ErrorRecord(new ArgumentException(message, ex), "ReceivePSSessionCannotConnectSession",
ErrorCategory.InvalidOperation, oldSession));
return;
}
}
// Look to see if there exists a job associated with this runspace.
// If so then we use this job object, unless the user explicitly specifies
// output to host.
PSRemotingJob job = FindJobForSession(session);
if (job != null)
{
// Default is to route data to job.
if (OutTarget == OutTarget.Host)
{
// This performs a *reconstruct* connection scenario where a new
// pipeline object is created and connected.
ConnectSessionToHost(session, job);
}
else
{
// This preforms a *reconnect* scenario where the existing job
// and runspace objects are reconnected.
ConnectSessionToJob(session, job);
}
}
else
{
// Default is to route data to host.
if (OutTarget == OutTarget.Job)
{
// This performs a *reconstruct* connection scenario where new
// pipeline/job objects are created and connected.
ConnectSessionToJob(session);
}
else
{
// This performs a *reconstruct* connection scenario where a new
// pipeline object is created and connected.
ConnectSessionToHost(session);
}
}
// Make sure that if this session is successfully connected that it is included
// in the PSSession repository. If it already exists then replace it because we
// want the latest/connected session in the repository.
if (session.Runspace.RunspaceStateInfo.State != RunspaceState.Disconnected)
{
this.RunspaceRepository.AddOrReplace(session);
}
}
}
private bool CheckForDebugMode(PSSession session, bool monitorAvailabilityChange)
{
RemoteRunspace remoteRunspace = session.Runspace as RemoteRunspace;
if (remoteRunspace.RunspaceAvailability == RunspaceAvailability.RemoteDebug)
{
DisconnectAndStopRunningCmds(remoteRunspace);
WriteDebugStopWarning();
return true;
}
if (monitorAvailabilityChange)
{
// Monitor runspace availability transition to RemoteDebug
remoteRunspace.AvailabilityChanged += HandleRunspaceAvailabilityChanged;
}
return false;
}
private void HandleRunspaceAvailabilityChanged(object sender, RunspaceAvailabilityEventArgs e)
{
if ((e.RunspaceAvailability == RunspaceAvailability.RemoteDebug))
{
RemoteRunspace remoteRunspace = sender as RemoteRunspace;
remoteRunspace.AvailabilityChanged -= HandleRunspaceAvailabilityChanged;
DisconnectAndStopRunningCmds(remoteRunspace);
}
}
private void DisconnectAndStopRunningCmds(RemoteRunspace remoteRunspace)
{
// Disconnect runspace to stop command from running and to allow reconnect
// via the Enter-PSSession cmdlet.
if (remoteRunspace.RunspaceStateInfo.State == RunspaceState.Opened)
{
Job job;
ManualResetEvent stopPipelineReceive;
lock (_syncObject)
{
job = _job;
stopPipelineReceive = _stopPipelineReceive;
}
remoteRunspace.Disconnect();
try
{
stopPipelineReceive?.Set();
}
catch (ObjectDisposedException) { }
job?.StopJob();
}
}
private void WriteDebugStopWarning()
{
WriteWarning(
GetMessage(RemotingErrorIdStrings.ReceivePSSessionInDebugMode));
WriteObject(string.Empty);
}
/// <summary>
/// Connects session, retrieves command output data and writes to host.
/// </summary>
/// <param name="session">PSSession object.</param>
/// <param name="job">Job object associated with session.</param>
private void ConnectSessionToHost(PSSession session, PSRemotingJob job = null)
{
RemoteRunspace remoteRunspace = session.Runspace as RemoteRunspace;
Dbg.Assert(remoteRunspace != null, "PS sessions can only contain RemoteRunspace type.");
if (job != null)
{
// If we have a job object associated with the session then this means
// the user explicitly chose to connect and return data synchronously.
// Reconnect the job object and stream data to host.
lock (_syncObject) { _job = job; _stopPipelineReceive = new ManualResetEvent(false); }
using (_stopPipelineReceive)
using (job)
{
Job childJob = job.ChildJobs[0];
job.ConnectJobs();
if (CheckForDebugMode(session, true))
{
return;
}
do
{
// Retrieve and display results from child job as they become
// available.
int index = WaitHandle.WaitAny(new WaitHandle[] {
_stopPipelineReceive,
childJob.Results.WaitHandle });
foreach (var result in childJob.ReadAll())
{
result?.WriteStreamObject(this);
}
if (index == 0)
{
WriteDebugStopWarning();
return;
}
}
while (!job.IsFinishedState(job.JobStateInfo.State));
}
lock (_syncObject) { _job = null; _stopPipelineReceive = null; }
return;
}
// Otherwise this must be a new disconnected session object that has a running command
// associated with it.
if (remoteRunspace.RemoteCommand == null)
{
// There is no associated running command for this runspace, so we cannot proceed.
// Check to see if session is in debug mode.
CheckForDebugMode(session, false);
return;
}
// Create a RemotePipeline object for this command and attempt to connect.
lock (_syncObject)
{
_remotePipeline = (RemotePipeline)session.Runspace.CreateDisconnectedPipeline();
_stopPipelineReceive = new ManualResetEvent(false);
}
using (_stopPipelineReceive)
{
using (_remotePipeline)
{
// Connect to remote running command.
ManualResetEvent pipelineConnectedEvent = new ManualResetEvent(false);
using (pipelineConnectedEvent)
{
_remotePipeline.StateChanged += (sender, args) =>
{
if (pipelineConnectedEvent != null &&
(args.PipelineStateInfo.State == PipelineState.Running ||
args.PipelineStateInfo.State == PipelineState.Stopped ||
args.PipelineStateInfo.State == PipelineState.Failed))
{
pipelineConnectedEvent.Set();
}
};
_remotePipeline.ConnectAsync();
pipelineConnectedEvent.WaitOne();
}
pipelineConnectedEvent = null;
if (CheckForDebugMode(session, true))
{
return;
}
// Wait for remote command to complete, while writing any available data.
while (!_remotePipeline.Output.EndOfPipeline)
{
if (_stopProcessing)
{
break;
}
int index = WaitHandle.WaitAny(new WaitHandle[] {
_stopPipelineReceive,
_remotePipeline.Output.WaitHandle });
if (index == 0)
{
WriteDebugStopWarning();
return;
}
while (_remotePipeline.Output.Count > 0)
{
if (_stopProcessing)
{
break;
}
PSObject psObject = _remotePipeline.Output.Read();
WriteRemoteObject(psObject, session);
}
}
// Write pipeline object errors.
if (_remotePipeline.Error.Count > 0)
{
while (!_remotePipeline.Error.EndOfPipeline)
{
object errorObj = _remotePipeline.Error.Read();
if (errorObj is Collection<ErrorRecord>)
{
Collection<ErrorRecord> errorCollection = (Collection<ErrorRecord>)errorObj;
foreach (ErrorRecord errorRecord in errorCollection)
{
WriteError(errorRecord);
}
}
else if (errorObj is ErrorRecord)
{
WriteError((ErrorRecord)errorObj);
}
else
{
Dbg.Assert(false, "Objects in pipeline Error collection must be ErrorRecord type.");
}
}
}
// Wait for pipeline to finish.
int wIndex = WaitHandle.WaitAny(new WaitHandle[] {
_stopPipelineReceive,
_remotePipeline.PipelineFinishedEvent });
if (wIndex == 0)
{
WriteDebugStopWarning();
return;
}
// Set the runspace RemoteCommand to null. It is not needed anymore and it
// allows the runspace to become available after pipeline completes.
remoteRunspace.RunspacePool.RemoteRunspacePoolInternal.ConnectCommands = null;
// Check for any terminating errors to report.
if (_remotePipeline.PipelineStateInfo.State == PipelineState.Failed)
{
Exception reason = _remotePipeline.PipelineStateInfo.Reason;
string msg;
if (reason != null && !string.IsNullOrEmpty(reason.Message))
{
msg = StringUtil.Format(RemotingErrorIdStrings.PipelineFailedWithReason, reason.Message);
}
else
{
msg = RemotingErrorIdStrings.PipelineFailedWithoutReason;
}
ErrorRecord errorRecord = new ErrorRecord(new RuntimeException(msg, reason),
"ReceivePSSessionPipelineFailed",
ErrorCategory.OperationStopped,
_remotePipeline
);
WriteError(errorRecord);
}
}
}
lock (_syncObject) { _remotePipeline = null; _stopPipelineReceive = null; }
}
/// <summary>
/// Helper method to append computer name and session GUID
/// note properties to the PSObject before it is written.
/// </summary>
/// <param name="psObject">PSObject.</param>
/// <param name="session">PSSession.</param>
private void WriteRemoteObject(
PSObject psObject,
PSSession session)
{
if (psObject == null)
{
return;
}
// Add note properties for this session if they don't already exist.
if (psObject.Properties[RemotingConstants.ComputerNameNoteProperty] == null)
{
psObject.Properties.Add(new PSNoteProperty(RemotingConstants.ComputerNameNoteProperty, session.ComputerName));
}
if (psObject.Properties[RemotingConstants.RunspaceIdNoteProperty] == null)
{
psObject.Properties.Add(new PSNoteProperty(RemotingConstants.RunspaceIdNoteProperty, session.InstanceId));
}
if (psObject.Properties[RemotingConstants.ShowComputerNameNoteProperty] == null)
{
psObject.Properties.Add(new PSNoteProperty(RemotingConstants.ShowComputerNameNoteProperty, true));
}
WriteObject(psObject);
}
/// <summary>
/// Connects session, collects command output data in a job object.
/// If a PSRemotingJob object is passed in then that job will be
/// (re)connected. Otherwise a new job object will be created that
/// will be connected to the session's running command.
/// </summary>
/// <param name="session">PSSession object.</param>
/// <param name="job">Job object to connect to.</param>
private void ConnectSessionToJob(PSSession session, PSRemotingJob job = null)
{
// Otherwise create a new job object in the disconnected state for this
// session and then connect it.
bool newJobCreated = false;
if (job == null)
{
// The PSRemoting job object uses helper objects to track remote command execution.
List<IThrottleOperation> helpers = new List<IThrottleOperation>();
// Create the remote pipeline object that will represent the running command
// on the server machine. This object will be in the disconnected state.
Pipeline remotePipeline = session.Runspace.CreateDisconnectedPipeline();
// Create a disconnected runspace helper for this remote command.
helpers.Add(new DisconnectedJobOperation(remotePipeline));
// Create the job object in a disconnected state. Note that the job name
// will be autogenerated.
job = new PSRemotingJob(helpers, 0, JobName, false);
job.PSJobTypeName = InvokeCommandCommand.RemoteJobType;
job.HideComputerName = false;
newJobCreated = true;
}
if (job.JobStateInfo.State == JobState.Disconnected)
{
// Connect the job to the remote command running on the server.
job.ConnectJob(session.Runspace.InstanceId);
// Add the created job to the store if it was connected successfully.
if (newJobCreated)
{
JobRepository.Add(job);
}
}
if (CheckForDebugMode(session, true))
{
return;
}
// Write the job object to output.
WriteObject(job);
}
/// <summary>
/// Helper method to connect the runspace. If the session/runspace can't
/// be connected or fails to be connected then a null PSSessionobject is
/// returned.
/// </summary>
/// <param name="session">Session to connect.</param>
/// <param name="ex">Optional exception object.</param>
/// <returns>Connected session or null.</returns>
private static PSSession ConnectSession(PSSession session, out Exception ex)
{
ex = null;
if (session == null ||
(session.Runspace.RunspaceStateInfo.State != RunspaceState.Opened &&
session.Runspace.RunspaceStateInfo.State != RunspaceState.Disconnected))
{
return null;
}
else if (session.Runspace.RunspaceStateInfo.State == RunspaceState.Opened)
{
return session;
}
try
{
session.Runspace.Connect();
}
catch (PSInvalidOperationException e)
{
ex = e;
}
catch (InvalidRunspaceStateException e)
{
ex = e;
}
catch (RuntimeException e)
{
ex = e;
}
return (ex == null) ? session : null;
}
/// <summary>
/// Helper method to attempt to retrieve a disconnected runspace object
/// from the server, based on the provided session object.
/// </summary>
/// <param name="session">PSSession session object.</param>
/// <returns>PSSession disconnected runspace object.</returns>
private PSSession TryGetSessionFromServer(PSSession session)
{
if (session.Runspace is not RemoteRunspace remoteRunspace)
{
return null;
}
remoteRunspace = null;
Runspace[] runspaces = Runspace.GetRunspaces(session.Runspace.ConnectionInfo, this.Host, QueryRunspaces.BuiltInTypesTable);
foreach (Runspace runspace in runspaces)
{
if (runspace.InstanceId == session.Runspace.InstanceId)
{
remoteRunspace = runspace as RemoteRunspace;
break;
}
}
if (remoteRunspace != null)
{
// Try inserting connected runspace into existing PSSession.
session = session.InsertRunspace(remoteRunspace) ? session : new PSSession(remoteRunspace);
return session;
}
return null;
}
/// <summary>
/// Helper method to search the local PS client job repository
/// for a job associated with the provided session.
/// </summary>
/// <param name="session">PSSession object.</param>
/// <returns>Associated job object from the job repository.</returns>
private PSRemotingJob FindJobForSession(PSSession session)
{
PSRemotingJob job = null;
RemoteRunspace remoteSessionRunspace = session.Runspace as RemoteRunspace;
if (remoteSessionRunspace == null ||
remoteSessionRunspace.RemoteCommand != null)
{
// The provided session is created for *reconstruction* and we
// cannot connect a previous job even if one exists. A new job
// will have to be created.
return null;
}
foreach (Job repJob in this.JobRepository.Jobs)
{
if (repJob is PSRemotingJob)
{
foreach (PSRemotingChildJob childJob in repJob.ChildJobs)
{
if (childJob.Runspace.InstanceId.Equals(session.InstanceId) &&
(childJob.JobStateInfo.State == JobState.Disconnected))
{
job = (PSRemotingJob)repJob;
break;
}
}
if (job != null)
{
break;
}
}
}
return job;
}
/// <summary>
/// Searches runspace repository for session by Id.
/// </summary>
/// <param name="id">Id to match.</param>
/// <returns>PSSession object.</returns>
private PSSession GetSessionById(int id)
{
foreach (PSSession session in this.RunspaceRepository.Runspaces)
{
if (session.Id == id)
{
return session;
}
}
return null;
}
/// <summary>
/// Searches runspace repository for session by Name.
/// </summary>
/// <param name="name">Name to match.</param>
/// <returns>PSSession object.</returns>
private PSSession GetSessionByName(string name)
{
WildcardPattern namePattern = WildcardPattern.Get(name, WildcardOptions.IgnoreCase);
foreach (PSSession session in this.RunspaceRepository.Runspaces)
{
if (namePattern.IsMatch(session.Name))
{
return session;
}
}
return null;
}
/// <summary>
/// Searches runspace repository for session by InstanceId.
/// </summary>
/// <param name="instanceId">InstanceId to match.</param>
/// <returns>PSSession object.</returns>
private PSSession GetSessionByInstanceId(Guid instanceId)
{
foreach (PSSession session in this.RunspaceRepository.Runspaces)
{
if (instanceId.Equals(session.InstanceId))
{
return session;
}
}
return null;
}
/// <summary>
/// Write invalid argument error.
/// </summary>
private void WriteInvalidArgumentError(PSRemotingErrorId errorId, string resourceString, object errorArgument)
{
string message = GetMessage(resourceString, errorArgument);
WriteError(new ErrorRecord(new ArgumentException(message), errorId.ToString(),
ErrorCategory.InvalidArgument, errorArgument));
}
#endregion
#region Private Members
private bool _stopProcessing;
private RemotePipeline _remotePipeline;
private Job _job;
private ManualResetEvent _stopPipelineReceive;
private readonly object _syncObject = new object();
#endregion
}
#region OutTarget Enum
/// <summary>
/// Output modes available to the Receive-PSSession cmdlet.
/// </summary>
public enum OutTarget
{
/// <summary>
/// Default mode. If.
/// </summary>
Default = 0,
/// <summary>
/// Synchronous mode. Receive-PSSession output data goes to host (returned by cmdlet object).
/// </summary>
Host = 1,
/// <summary>
/// Asynchronous mode. Receive-PSSession output data goes to returned job object.
/// </summary>
Job = 2
}
#endregion
}
|