Introducción a los cmdlets de la Consola de administración de SharePoint

Artículo
09/24/2014

Última modificación: jueves, 14 de enero de 2010

Hace referencia a: SharePoint Foundation 2010

Windows PowerShell™ es una nueva herramienta de línea de comandos y un lenguaje de scripting auxiliar de Microsoft que complementa Cmd.exe en el contexto de administración de Windows y que sustituye a la herramienta de administración Stsadm.exe. Aunque Cmd.exe y Stsadm.exe se conservarán para compatibilidad con versiones anteriores, esta nueva tecnología de scripting deberá emplearse en todo el desarrollo actual y futuro de scripts y archivos administrativos de SharePoint Foundation.

Conceptos básicos sobre Windows PowerShell

A diferencia de la mayoría de las herramientas de línea de comandos, que aceptan y devuelven texto, Windows PowerShell se basa en Microsoft .NET Framework y acepta y devuelve objetos de .NET Framework. Este cambio fundamental en el entorno aporta herramientas y métodos totalmente nuevos que mejoran en gran medida el control, la eficiencia y la productividad de programadores y administradores.

Windows PowerShell es una herramienta de línea de comandos simple que introduce el concepto de cmdlet. Un cmdlet es una combinación de verbo y nombre que comprende un comando y un objeto sobre el que actúa el comando. Los nombres de cmdlet de Windows PowerShell constan de verbos y nombres, separados por un guión (-), que en conjunto denotan sus propiedades funcionales. Por ejemplo, el nombre de cmdlet Get-SPSite combina el verbo (comando) "Get" con el nombre (objeto) "SPSite" para denominar al cmdlet que recupera un objeto SPSite especificado. Puede usar los cmdlets individualmente o unirlos como secuencias vinculadas para realizar tareas complejas.

Los nombres de cmdlet toman parámetros como pares nombre-valor que otorgan especificidad al nombre de cmdlet. Cuando se invocan, los cmdlets devuelven objetos de salida. Estos objetos devueltos también tienen propiedades que se muestran como pares nombre-valor. Debido a que los cmdlets devuelven objetos, estos últimos pueden pasarse (o "canalizarse") a otro cmdlet, en secuencia. De este modo, los cmdlets pueden encadenarse y proporcionar una gran flexibilidad.

De hecho, este es solo el comienzo de las diferencias significativas entre un cmdlet de Windows PowerShell y los comandos de stsadm.exe. Por ejemplo, es importante tener en cuenta que un cmdlet no es un ejecutable, sino que es una sesión de una clase de .NET Framework. Por lo tanto, con unas pocas excepciones, los cmdlets devuelven objetos en lugar de secuencias de texto y procesan los objetos de entrada de una canalización de objetos.

Como se puede ver, Windows PowerShell no es solo una herramienta de línea de comandos. También es, más importante aún, un nuevo lenguaje de scripting. Windows PowerShell se instala de forma nativa con más de 100 cmdlets de Windows principales. La biblioteca de cmdlets de SharePoint Foundation, que actualmente consta de más de 500 cmdlets, se instala aparte de estos cmdlets de Windows principales. Estos cmdlets específicos de SharePoint se exponen en un shell especial de su propiedad denominado Consola de administración de SharePoint.

Cmdlets de la Consola de administración de SharePoint

Windows PowerShell proporciona tanto implementaciones generales como específicas de SharePoint. Realmente, esta diferencia se refleja en el hecho de que, mientras los cmdlets de Windows PowerShell derivan de la clase base PSCmdlet, los cmdlets de SharePoint Foundation derivan de una clase base de SharePoint especializada denominada SPCmdlet.

Importante
La distinción entre los cmdlets de Windows PowerShell, que derivan de la clase PSCmdlet, y los cmdlets de SharePoint, que derivan de la clase SPCmdlet, es muy importante. Todos los cmdlets de SharePoint que se incluyen en SharePoint Foundation y se exponen en Consola de administración de SharePoint, derivan de la clase SPCmdlet. Además, todos los cmdlets personalizados que se escriben para admitir las implementaciones de SharePoint también deben ser cmdlets de SharePoint.

La distinción entre los cmdlets de Windows PowerShell, que derivan de la clase PSCmdlet, y los cmdlets de SharePoint, que derivan de la clase SPCmdlet, es muy importante. Todos los cmdlets de SharePoint que se incluyen en SharePoint Foundation y se exponen en Consola de administración de SharePoint, derivan de la clase SPCmdlet. Además, todos los cmdlets personalizados que se escriben para admitir las implementaciones de SharePoint también deben ser cmdlets de SharePoint.

A continuación se encuentra la firma de la clase base SPCmdlet. Tenga en cuenta que SPCmdlet deriva de la clase PSCmdlet.

public abstract class SPCmdlet : PSCmdlet

Tenga en cuenta que al usar los cmdlets de operador variables, que incluyen Get, Set, New y Remove, debe usar las implementaciones de la clase SPCmdlet específicas en lugar de las derivadas de la clase PSCmdlet. Esto es coherente con el modelo de scripting para el uso de cmdlets de Windows PowerShell en SharePoint Foundation.

Para cmdlets que controlan objetos persistentes: