SharePoint 2013: Como crear un cmdlet personalizado (I)!

En SharePoint 2013 como en la versión predecesora, es posible crear comandos PowerShell personalizados para añadir nueva funcionalidad no existente en los comandos disponibles por defecto (+ de 750). Una primera aproximación para crear un cmdlet personalizado pasa por crear un ensamblado con el cmdlet e importarlo luego en la Consola de Administración de SharePoint 2013 mediante Import-Module. En este post veremos una de las opciones posibles para crear un comando personalizado:

  • En Visual Studio 2012, creamos un proyecto de tipo “Biblioteca de clases” eligiendo como versión de .NET Framework la 4.0.
  • Añadimos las siguientes referencias al proyecto:
    • System.Management.Automation.dll, ubicada en “C:\Program Files (x86)\Reference Assemblies\Microsoft\WindowsPowerShell\v3.0”.
    • System.Configuration.Install.dll, ubicada en “C:\Windows\Microsoft.NET\Framework\v2.0.50727”.
    • Microsoft.SharePoint.dll, ubicada en el “..\15\ISAPI”.
    • Microsoft.SharePoint.PowerShell.dll ubicada en “C:\Windows\Microsoft.NET\assembly\GAC_MSIL\Microsoft.SharePoint.PowerShell\v4.0_15.0.0.0__71e9bce111e9429c”.
  • Añadimos directivas “using” a Microsoft.SharePoint, Microsoft.SharePoint.Administration, Microsoft.SharePoint.PowerShell y System.Management.Automation.
  • Codificamos el archivo de clase de acuerdo al siguiente código:
   1:  using System;
   2:  using System.Collections.Generic;
   3:  using System.Linq;
   4:  using System.Text;
   5:   
   6:  //Espacios de nombres necesarios
   7:  using Microsoft.SharePoint;
   8:  using Microsoft.SharePoint.Administration;
   9:  using Microsoft.SharePoint.PowerShell;
  10:  using System.Management.Automation;
  11:   
  12:  namespace CIIN.SharePoint.PowerShell
  13:  {
  14:      [Cmdlet(VerbsCommon.Get,"SPSolutionsFromSolutionStore")]
  15:      public class SPCmdletCopySolutions : SPGetCmdletBase<string>
  16:      {
  17:          protected override IEnumerable<string> RetrieveDataObjects()
  18:          {
  19:              try
  20:              {
  21:                  Console.WriteLine("Iniciando el proceso de extracción de soluciones");
  22:                  int iNumeroSoluciones = 0;
  23:                  SPSolutionCollection spColeccionSoluciones =
  24:                      SPFarm.Local.Solutions;
  25:                  Console.WriteLine("Se han encontrado {0} soluciones a extraer",
  26:                      spColeccionSoluciones.Count);
  27:                  foreach (SPSolution spSolucion in spColeccionSoluciones)
  28:                  {
  29:                      SPPersistedFile spArchivoSolucion =
  30:                          spSolucion.SolutionFile;
  31:                      spArchivoSolucion.SaveAs(spArchivoSolucion.DisplayName);
  32:                      iNumeroSoluciones += 1;
  33:                  }
  34:                  return new string []
  35:                  {
  36:                      "Proceso de extración de soluciones concluido",
  37:                      "Nº Total de soluciones extraidas: " +
  38:                      iNumeroSoluciones.ToString()
  39:                  };
  40:              }
  41:              catch (Exception ex)
  42:              {
  43:                  return new string[]
  44:                  {
  45:                     ex.Message
  46:                  };                
  47:              } 
  48:          }
  49:      }
  50:  }

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, “Courier New”, courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

  • Compilamos el proyecto para comprobar que no hay errores.Ejecutamos la Consola de Administración de SharePoint 2013 y para registrar el comando en la sesión iniciada, ejecutamos la siguiente sentencia:

Import-Module “<Path_Ensamblado>\<NombreEnsamblado.dll

  • Ejecutamos a continuación el commando PowerShell que acabamos de registrar: Get-SPSolutionsFromSolutionStore.
  • Comprobamos que las soluciones se han extraido como se esperaba:
image image