TEMA
    about_Parameters

DESCRIPCIÓN BREVE
    Describe cómo usar los parámetros de los cmdlets de Windows 
    PowerShell. 


DESCRIPCIÓN DETALLADA
    La mayoría de los cmdlets y funciones de Windows PowerShell se 
    basan en parámetros para permitir a los usuarios seleccionar 
    opciones o proporcionar datos. Los parámetros van precedidos del 
    nombre del cmdlet o de la función y suelen tener este formato:


        -<nombre del parámetro> <valor del parámetro>


    El nombre de un parámetro va precedido de un guión (-), que indica 
    a Windows PowerShell que la palabra que sigue al guión es un 
    parámetro y no un valor que se pase al cmdlet o a la función. No todos los 
    parámetros requieren un valor y no es necesario especificar todos los 
    nombres de parámetros. En algunos casos, el nombre de parámetro está 
    implícito y no es necesario incluirlo en el comando.

    
    El tipo y los requisitos de los parámetros varían según el cmdlet y la 
    función. Para obtener información sobre los parámetros de un cmdlet, 
    use el cmdlet Get-Help. Por ejemplo, para obtener información sobre 
    los parámetros del cmdlet Get-ChildItem, escriba:


        get-help get-childitem


    Para obtener información sobre los parámetros de una función, 
    revise las definiciones de parámetro. Los parámetros se definen 
    después del nombre de la función o en el cuerpo de la función, 
    mediante la palabra clave Param. Para obtener más información, 
    vea about_Functions.


    Algunas funciones también contienen ayuda basada en comentarios 
    sobre los parámetros. Utilice el cmdlet Get-Help con estas 
    funciones. Para obtener más información, vea el tema de Ayuda 
    correspondiente a Get-Help y about_Comment_Based_Help. 


    El cmdlet Get-Help devuelve varios detalles sobre el cmdlet o la 
    función, como una descripción del cmdlet o de la función, la 
    sintaxis de los comandos, información sobre los parámetros y 
    ejemplos en los que se muestra cómo usar el cmdlet o la función.
 

    Asimismo, se puede usar el parámetro Parameter de la función o 
    del cmdlet Get-Help para obtener información sobre un parámetro 
    concreto. O bien, se puede usar el carácter comodín (*) con el 
    parámetro Parameter para obtener información sobre todos los 
    parámetros del cmdlet o de la función. Por ejemplo, el comando 
    siguiente obtiene información sobre todos los parámetros de la 
    función o del cmdlet Get-Member:


        get-help get-member -parameter *


    Esta información incluye los detalles necesarios para poder usar el 
    parámetro. Por ejemplo, el tema de Ayuda correspondiente al cmdlet 
    Get-ChildItem incluye los detalles siguientes sobre su parámetro Path:

        -path <string[]>
            Especifica una ruta de acceso a una o varias ubicaciones. 
            Se permite el uso de caracteres comodín. La ubicación 
            predeterminada es el directorio actual (.).

        ¿Requerido?                    false
        ¿Posición?                     1
        Valor predeterminado           Directorio actual
        ¿Aceptar canalización?         true (ByValue, ByPropertyName) 
        ¿Aceptar caracteres comodín?   sí


    La información sobre el parámetro incluye la sintaxis, una descripción 
    y los atributos del parámetro.
    En las secciones siguientes se describen los atributos de los 
    parámetros.


  ¿Es un parámetro obligatorio?
    Esta opción indica si el parámetro es obligatorio, es decir, si 
    todos los comandos que utilizan este cmdlet deben incluir este 
    parámetro. Si su valor es "True" y el comando no incluye el parámetro, 
    Windows PowerShell pedirá que se proporcione un valor para el parámetro.


  Posición del parámetro
    Esta opción indica si se puede proporcionar el valor de un 
    parámetro sin que vaya precedido del nombre del parámetro. Si su 
    valor es "0" o "named", se requiere un nombre de parámetro. Este 
    tipo de parámetro se denomina parámetro con nombre. Un parámetro 
    con nombre puede aparecer en cualquier posición después del nombre del 
    cmdlet.


    Si la opción "Posición del parámetro" está establecida en un 
    entero distinto de 0, el nombre de parámetro no es necesario. Los 
    parámetros de este tipo se denominan parámetros posicionales y el 
    número indica la posición en la que debe aparecer el parámetro 
    con respecto a otros parámetros posicionales. Si se incluye el 
    nombre de un parámetro posicional, el parámetro podrá aparecer en 
    cualquier posición después del nombre del cmdlet.


    Por ejemplo, el cmdlet Get-ChildItem tiene los parámetros Path y 
    Exclude. El valor de la opción "Posición del parámetro" para Path 
    es 1, lo que significa que es un parámetro posicional. El valor 
    de la opción "Posición del parámetro" para Exclude es 0, lo que 
    significa que es un parámetro con nombre. 


    Esto significa que Path no requiere el nombre del parámetro, pero 
    su valor debe ser el primero o el único valor de parámetro sin 
    nombre en el comando. Sin embargo, dado que el parámetro Exclude es un 
    parámetro con nombre, se puede colocarlo en cualquier posición en el 
    comando.


    Como resultado de los valores de "Posición del parámetro" para 
    estos dos parámetros, se puede usar cualquiera de los siguientes 
    comandos:


        Get-ChildItem -path c:\techdocs -exclude *.ppt
        Get-ChildItem c:\techdocs -exclude *.ppt
        Get-ChildItem -exclude *.ppt -path c:\techdocs
        Get-ChildItem -exclude *.ppt c:\techdocs


    Si desea incluir otro parámetro posicional sin incluir el nombre del 
    parámetro, deberá colocarlo en el orden especificado por la opción 
    "Posición del parámetro".


  Tipo de parámetro
    Esta opción especifica el tipo de Microsoft .NET Framework del 
    valor de parámetro. Por ejemplo, si el tipo es Int32, el valor de 
    parámetro debe ser un entero. Si el tipo es una cadena, el valor de 
    parámetro debe ser una cadena de caracteres. Si la cadena contiene 
    espacios, el valor debe estar entre comillas o los espacios deben ir 
    precedidos por el carácter de escape (`).


  Valor predeterminado
    Esta opción especifica el valor que el parámetro usará si no se 
    proporciona ningún otro valor. Por ejemplo, el valor predeterminado 
    del parámetro Path suele ser el directorio actual. Los parámetros 
    obligatorios nunca tienen un valor predeterminado. Para muchos 
    parámetros opcionales, no hay ningún valor predeterminado porque el 
    parámetro no surte ningún efecto si no se utiliza. 


  ¿Acepta múltiples valores?
    Esta opción indica si un parámetro acepta varios valores. Cuando un 
    parámetro acepta varios valores, se puede escribir una lista 
    delimitada por comas como valor del parámetro en el comando, o bien, 
    guardar una lista delimitada por comas (matriz) en una variable y, 
    a continuación, especificar la variable como valor del parámetro.


    Por ejemplo, el parámetro ServiceName del cmdlet Get-Service 
    acepta varios valores. Los dos comandos siguientes son válidos:


        get-service -servicename winrm, netlogon


        $s = "winrm", "netlogon"
        get-service -servicename $s


  ¿Acepta entradas de canalizaciones?
    Esta opción indica si se puede utilizar el operador de 
    canalización (|) para enviar un valor al parámetro. 

    
    Valor                    Descripción
    -----                    -----------
    False                    Indica que no se puede canalizar un valor 
                             al parámetro.


    True (by Value)          Indica que se puede canalizar cualquier valor 
                             al parámetro, siempre y cuando el valor tenga 
                             el tipo de .NET Framework especificado para el 
                             parámetro o pueda convertirse en el tipo 
                             de .NET Framework especificado.


                             Cuando un parámetro tiene el valor "True (by 
                             Value)", Windows PowerShell intenta asociar 
                             cualquier valor canalizado a ese parámetro 
                             antes de recurrir a otros métodos para 
                             interpretar el comando.


    True (by Property Name)  Indica que se puede canalizar un valor al parámetro, 
                             pero el tipo de .NET Framework del parámetro debe 
                             incluir una propiedad con el mismo nombre que el 
                             parámetro.
 
                             Por ejemplo, se puede canalizar un valor a un 
                             parámetro Name únicamente si el valor tiene una 
                             propiedad denominada "Name".


  ¿Acepta caracteres comodín?
    Esta configuración indica si el valor del parámetro puede contener 
    caracteres comodín de forma que se pueda buscar coincidencias con el 
    valor del parámetro entre varios elementos existentes en el contenedor 
    de destino.


  Parámetros comunes
    Los parámetros comunes son parámetros que se pueden usar con cualquier cmdlet.
    Para obtener más información sobre los parámetros comunes, escriba:


        help about_commonparameters


VEA TAMBIÉN
    about_Command_syntax
    about_Comment_Based_Help
    about_Functions_Advanced
    about_Pipelines
    about_Wildcards




Tabla de contenido