// Copyright (c) Microsoft Corporation. // Licensed under the MIT License. using System; using System.Collections; using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics.CodeAnalysis; using System.IO; using System.Management.Automation; using System.Management.Automation.Provider; using System.Reflection; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; using System.Xml; namespace Microsoft.WSMan.Management { /// /// Executes action on a target object specified by RESOURCE_URI, where /// parameters are specified by key value pairs. /// eg., Call StartService method on the spooler service /// Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/Win32_Service /// -SelectorSet {Name=Spooler} /// [Cmdlet(VerbsLifecycle.Invoke, "WSManAction", DefaultParameterSetName = "URI", HelpUri = "https://go.microsoft.com/fwlink/?LinkId=2096843")] [OutputType(typeof(XmlElement))] public class InvokeWSManActionCommand : AuthenticatingWSManCommand, IDisposable { /// /// The following is the definition of the input parameter "Action". /// Indicates the method which needs to be executed on the management object /// specified by the ResourceURI and selectors. /// [Parameter(Mandatory = true, Position = 1)] [ValidateNotNullOrEmpty] public string Action { get { return action; } set { action = value; } } private string action; /// /// The following is the definition of the input parameter "ApplicationName". /// ApplicationName identifies the remote endpoint. /// [Parameter(ParameterSetName = "ComputerName")] [ValidateNotNullOrEmpty] public string ApplicationName { get { return applicationname; } set { applicationname = value; } } private string applicationname = null; /// /// The following is the definition of the input parameter "ComputerName". /// Executes the management operation on the specified computer(s). The default /// is the local computer. Type the fully qualified domain name, NETBIOS name or /// IP address to indicate the remote host(s) /// [Parameter(ParameterSetName = "ComputerName")] [Alias("cn")] public string ComputerName { get { return computername; } set { computername = value; if ((string.IsNullOrEmpty(computername)) || (computername.Equals(".", StringComparison.OrdinalIgnoreCase))) { computername = "localhost"; } } } private string computername = null; /// /// The following is the definition of the input parameter "ConnectionURI". /// Specifies the transport, server, port, and ApplicationName of the new /// runspace. The format of this string is: /// transport://server:port/ApplicationName. /// [Parameter(ParameterSetName = "URI")] [ValidateNotNullOrEmpty] [Alias("CURI", "CU")] [SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "URI")] public Uri ConnectionURI { get { return connectionuri; } set { connectionuri = value; } } private Uri connectionuri; /// /// The following is the definition of the input parameter "FilePath". /// Updates the management resource specified by the ResourceURI and SelectorSet /// via this input file. /// [Parameter] [Alias("Path")] [ValidateNotNullOrEmpty] public string FilePath { get { return filepath; } set { filepath = value; } } private string filepath; /// /// The following is the definition of the input parameter "OptionSet". /// OptionSet is a hashtable and is used to pass a set of switches to the /// service to modify or refine the nature of the request. /// [Parameter(ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)] [ValidateNotNullOrEmpty] [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")] [Alias("os")] public Hashtable OptionSet { get { return optionset; } set { optionset = value; } } private Hashtable optionset; /// /// The following is the definition of the input parameter "Port". /// Specifies the port to be used when connecting to the ws management service. /// [Parameter(ParameterSetName = "ComputerName")] [ValidateNotNullOrEmpty] [ValidateRange(1, int.MaxValue)] public int Port { get { return port; } set { port = value; } } private int port = 0; /// /// The following is the definition of the input parameter "SelectorSet". /// SelectorSet is a hash table which helps in identify an instance of the /// management resource if there are more than 1 instance of the resource /// class. /// [Parameter(Position = 2, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)] [ValidateNotNullOrEmpty] [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")] public Hashtable SelectorSet { get { return selectorset; } set { selectorset = value; } } private Hashtable selectorset; /// /// The following is the definition of the input parameter "SessionOption". /// Defines a set of extended options for the WSMan session. This hashtable can /// be created using New-WSManSessionOption. /// [Parameter] [ValidateNotNullOrEmpty] [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")] [Alias("so")] public SessionOption SessionOption { get { return sessionoption; } set { sessionoption = value; } } private SessionOption sessionoption; /// /// The following is the definition of the input parameter "UseSSL". /// Uses the Secure Sockets Layer (SSL) protocol to establish a connection to /// the remote computer. If SSL is not available on the port specified by the /// Port parameter, the command fails. /// [Parameter(ParameterSetName = "ComputerName")] [SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "SSL")] public SwitchParameter UseSSL { get { return usessl; } set { usessl = value; } } private SwitchParameter usessl; /// /// The following is the definition of the input parameter "ValueSet". /// ValueSet is a hahs table which helps to modify resource represented by the /// ResourceURI and SelectorSet. /// [Parameter] [ValidateNotNullOrEmpty] [SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")] public Hashtable ValueSet { get { return valueset; } set { valueset = value; } } private Hashtable valueset; /// /// The following is the definition of the input parameter "ResourceURI". /// URI of the resource class/instance representation. /// [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)] [ValidateNotNullOrEmpty] [Alias("ruri")] [SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "URI")] public Uri ResourceURI { get { return resourceuri; } set { resourceuri = value; } } private Uri resourceuri; private WSManHelper helper; private readonly IWSManEx m_wsmanObject = (IWSManEx)new WSManClass(); private IWSManSession m_session = null; private string connectionStr = string.Empty; /// /// BeginProcessing method. /// protected override void BeginProcessing() { helper = new WSManHelper(this); helper.WSManOp = "invoke"; // create the connection string connectionStr = helper.CreateConnectionString(connectionuri, port, computername, applicationname); } /// /// ProcessRecord method. /// protected override void ProcessRecord() { try { // create the resourcelocator object IWSManResourceLocator m_resource = helper.InitializeResourceLocator(optionset, selectorset, null, null, m_wsmanObject, resourceuri); // create the session object m_session = helper.CreateSessionObject(m_wsmanObject, Authentication, sessionoption, Credential, connectionStr, CertificateThumbprint, usessl.IsPresent); string rootNode = helper.GetRootNodeName(helper.WSManOp, m_resource.ResourceUri, action); string input = helper.ProcessInput(m_wsmanObject, filepath, helper.WSManOp, rootNode, valueset, m_resource, m_session); string resultXml = m_session.Invoke(action, m_resource, input, 0); XmlDocument xmldoc = new XmlDocument(); xmldoc.LoadXml(resultXml); WriteObject(xmldoc.DocumentElement); } finally { if (!string.IsNullOrEmpty(m_wsmanObject.Error)) { helper.AssertError(m_wsmanObject.Error, true, resourceuri); } if (!string.IsNullOrEmpty(m_session.Error)) { helper.AssertError(m_session.Error, true, resourceuri); } if (m_session != null) Dispose(m_session); } } #region IDisposable Members /// /// Public dispose method. /// public void Dispose() { // CleanUp(); GC.SuppressFinalize(this); } /// /// Public dispose method. /// public void Dispose(IWSManSession sessionObject) { sessionObject = null; this.Dispose(); } #endregion IDisposable Members /// /// BeginProcessing method. /// protected override void EndProcessing() { // WSManHelper helper = new WSManHelper(); helper.CleanUp(); } } }