13. Cmdlets

Nota editorial

Importante

La Especificación del lenguaje de Windows PowerShell, versión 3.0 se publicó en diciembre de 2012 y está basada en Windows PowerShell 3.0. Esta especificación no refleja el estado actual de PowerShell. No hay ningún plan para actualizar esta documentación para reflejar el estado actual. Esta documentación se presenta aquí para obtener referencia histórica.

El documento de especificación está disponible como un documento de Microsoft Word del Centro de descarga de Microsoft en: https://www.microsoft.com/download/details.aspx?id=36389 Ese documento de Word se ha convertido para su presentación aquí en Microsoft Learn. Durante la conversión, se han realizado algunos cambios editoriales para dar cabida al formato de la plataforma Docs. Se han corregido algunos errores tipográficos y menores.

Un cmdlet es un comando de característica única que manipula objetos en PowerShell. Los cmdlets se pueden reconocer por su formato de nomenclatura, un verbo y un nombre separados por un guión (-), como Get-Help, Get-Process y Start-Service. Un patrón de verbo es un verbo expresado con caracteres comodín, como en W*. Un patrón de nombre es un nombre expresado con caracteres comodín, como en evento.

Los cmdlets deben ser sencillos y estar diseñados para usarse en combinación con otros cmdlets. Por ejemplo, los cmdlets Get solo deben recuperar datos, los cmdlets Set solo deben establecer o cambiar datos, los cmdlets Format solo deben dar formato a los datos y los cmdlets Out solo deben dirigir la salida a un destino especificado.

Para cada cmdlet, escriba lo siguiente para proporcionar un archivo de ayuda al que se pueda acceder:

Get-Help *cmdlet-name* -Detailed

La vista detallada del archivo de ayuda del cmdlet debe incluir una descripción del cmdlet, la sintaxis del comando, las descripciones de los parámetros y un ejemplo que muestra el uso de ese cmdlet.

Los cmdlets se usan de forma similar a los comandos y utilidades del sistema operativo. Los comandos de PowerShell no distinguen mayúsculas de minúsculas.

Nota

Nota del editor: El documento original contiene una lista de cmdlets con descripciones, diagramas de sintaxis, definiciones de parámetros y ejemplos. Esta información está incompleta y sin fecha. Para obtener información actual sobre el cmdlet, consulte la sección Reference de la documentación de PowerShell.

13.1 Parámetros comunes

Los parámetros comunes son un conjunto de parámetros de cmdlet que se pueden usar con cualquier cmdlet. Se implementan mediante el propio entorno de tiempo de ejecución de PowerShell, no por el desarrollador de cmdlets, y están disponibles automáticamente para cualquier cmdlet o función que use el atributo parameter (§12.3.7) o atributo CmdletBinding (§12.3.5).

Aunque cualquier cmdlet acepta los parámetros comunes, es posible que no tengan ninguna semántica para ese cmdlet. Por ejemplo, si un cmdlet no genera ninguna salida detallada, el uso del parámetro común Verbose no tiene ningún efecto.

Varios parámetros comunes invalidan los valores predeterminados o preferencias del sistema que se pueden establecer mediante variables de preferencia (§2.3.2.3). A diferencia de las variables de preferencia, los parámetros comunes solo afectan a los comandos en los que se usan.

Nota

Nota del editor: El documento original contiene una lista de los parámetros comunes. Esta información está incompleta y sin fecha. Para obtener información actual, consulte about_CommonParameters.