Ayuda
Se aplica a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
Última modificación del tema: 2006-11-15
En Microsoft Exchange Server 2007, el Shell de administración de Exchange proporciona muchos recursos de ayuda para ayudarle a utilizarlo en todo su potencial. Este tema describe los siguientes recursos y funcionalidades de ayuda:
Archivo de ayuda de Exchange 2007 El archivo de Ayuda de Exchange 2007 contiene todos los temas de cmdlets en una jerarquía basada en funciones y tareas. Los temas de ayuda del cmdlet también se vinculan con temas de procedimientos que indican cómo realizar tareas específicas.
Cmdlets de ayuda El Shell de administración de Exchange tiene varios cmdlets de ayuda que permiten encontrar la información adecuada para llevar a cabo la tarea.
Vistas de ayuda La ayuda del Shell de administración de Exchange contiene amplia información acerca de los cmdlets que están disponibles. Las vistas de ayuda permiten el acceso a la información necesaria acerca de un cmdlet.
Funciones, componentes y funcionalidad de cmdlet Los cmdlets pueden aparecer por función, componente o por la funcionalidad que administran. Esto permite buscar el cmdlet correspondiente para la función, el componente o la funcionalidad que se desee administrar.
Implementación del tabulador Puede utilizar la implementación del tabulador en nombres de cmdlet y nombres de parámetros para reducir la cantidad de texto escrito en la línea de comando.
Archivo de ayuda de Exchange 2007
El archivo de Ayuda de Exchange 2007 contiene la misma información de ayuda de cmdlet que está disponible en cada cmdlet en el Shell de administración de Exchange. No obstante, en el archivo de Ayuda de Exchange 2007, la ayuda de todos los cmdlets está organizada por función de servidor y tarea de administración para facilitar la búsqueda de los cmdlets concretos asociados a la tarea que desea realizar. Asimismo, los temas sobre cmdlets del archivo de Ayuda de Exchange 2007 están vinculados a temas que presentan las características que administran, enseñan cómo utilizar los cmdlets para administrar dicha tarea y proporcionan detalles concretos acerca de la característica o de casos comunes.
Si desea obtener más información acerca de los temas de ayuda de cmdlet disponibles en el archivo de Ayuda de Exchange 2007, consulte Shell de administración de Exchange (SP1 y SP2).
Para obtener más información acerca de cómo usar los cmdlets del Shell de administración de Exchange para realizar determinadas tareas, consulte Operaciones.
Cmdlets de ayuda
Las siguientes tablas proporcionan ejemplos acerca de cómo utilizar los cmdlets Get-Help, Get-Command y Get-ExCommand para tener acceso a la información de ayuda que está disponible para cada cmdlet del Shell de administración de Exchange.
La tabla 1 proporciona ejemplos de cómo se utiliza el cmdlet Get-Help.
Tabla 1 Ejemplos de cómo utilizar el comando Get-Help
| Comando | Descripción |
|---|---|
|
Cuando utilice el cmdlet Get-Help por sí mismo, proporcionará instrucciones básicas acerca de cómo utilizar el sistema de ayuda del Shell de administración de Exchange. |
|
Al proporcionar al cmdlet Get-Help un cmdlet del shell como argumento, mostrará la información de ayuda para ese cmdlet. Por ejemplo, para obtener la información de ayuda para el cmdlet Get-SystemMessage, utilice el siguiente comando:
|
|
Cuando proporcione al cmdlet Get-Help un cmdlet del shell como argumento, junto con un carácter comodín, el cmdlet Get-Help devolverá una lista de todos los cmdlets que coincidan con el texto proporcionado. Puede utilizar varios métodos para obtener una lista de cmdlets del shell. Entre estos métodos se incluyen:
Al utilizar de esta forma caracteres comodines, puede ver fácilmente una lista de todos los cmdlets que están disponibles para una determinada característica. Por ejemplo, al utilizar el comando Get-Help *-TransportAgent, puede ver una lista de todos los verbos de cmdlet disponibles para los agentes de transporte. |
|
El comando Get-Help About_* proporciona una lista de todos los temas de ayuda generales del Shell de administración de Exchange, para ayudarle a comprender mejor y a utilizar el Shell de administración de Exchange. Si desea aprender más acerca de un tema de la lista que aparece, ejecute la característica> del comando Get-Help About_<<. Por ejemplo, si desea aprender más acerca de la instrucción |
|
Consulte la sección Vistas de ayuda, más adelante en este mismo tema. |
|
Consulte la sección Vistas de ayuda, más adelante en este mismo tema. |
|
Consulte la sección Vistas de ayuda, más adelante en este mismo tema. |
|
Consulte la sección Vistas de ayuda, más adelante en este mismo tema. |
|
Consulte la sección Parámetros Role, Component y Functionality, más adelante en este mismo tema. |
|
Consulte la sección Parámetros Role, Component y Functionality, más adelante en este mismo tema. |
|
Consulte la sección Parámetros Role, Component y Functionality, más adelante en este mismo tema. |
La tabla 2 proporciona ejemplos de cómo se utiliza el cmdlet Get-Command.
Tabla 2 Ejemplos de cómo utilizar el comando Get-Command
| Cmdlet | Descripción |
|---|---|
|
El cmdlet Get-Command proporciona una lista de todos los cmdlets que están disponibles para el Shell. Al igual que el cmdlet Get-Help, el cmdlet Get-Command permite la expansión del carácter comodín. Puede utilizar este cmdlet con los cmdlets Format-List y Format-Table para proporcionar un visor más legible. Por ejemplo, utilice |
|
El comando Get-Command <Cmdlet> proporciona información detallada acerca de los parámetros de cmdlet y otros componentes especificados. Puede utilizar este comando junto con los cmdlets Format-List y Format-Table para proporcionar un visor más legible. Por ejemplo, utilice |
|
El comando Get-Command -Noun <CmdletNoun> muestra una relación de todos los cmdlets que existen con el nombre especificado. Este comando resulta útil cuando se desea ver una lista de todos los cmdlets que están asociados a una determinada característica. Por ejemplo, el comando Get-Help -Noun SystemMessage devuelve todos los cmdlets que están disponibles para la característica |
|
El comandoGet-Command -Verb <CmdletVerb> muestra una relación de todos los cmdlets que existen con el verbo especificado. Este comando resulta útil cuando se desea ver una lista de todos los cmdlets que están asociados a una determinada acción. Por ejemplo, el comando Get-Help -Verb Enable devuelve todos los cmdlets disponibles para realizar la acción de habilitar. Puede utilizar este comando junto con los cmdlets Format-List y Format-Table para proporcionar un visor más legible. Por ejemplo, utilice |
|
El cmdlet Get-ExCommand se comporta de forma idéntica al cmdlet Get-Command, pero devuelve sólo cmdlets que están disponibles para administrar Exchange 2007. |
|
El cmdlet Get-PSCommand se comporta de forma idéntica al cmdlet Get-Command, pero excluye los cmdlets que están disponibles para administrar Exchange 2007. |
La tabla 3 ofrece ejemplos de cómo utilizar distintos comandos de ayuda.
Tabla 3 Ejemplos de cómo utilizar distintos comandos de ayuda
| Cmdlet | Descripción |
|---|---|
|
El comando QuickRef abre un gráfico HTML imprimible que contiene una lista con los cmdlets de uso más frecuente en el Shell de administración de Exchange. Para ver la versión más actualizada de este gráfico, consulte la referencia rápida del Shell de administración de Exchange (en inglés). |
|
Utilice el comando <Cmdlet> -? junto con cualquier cmdlet para encontrar la misma información de ayuda que está disponible cuando se utiliza el cmdlet Get-Help. Por ejemplo, escriba |
|
El cmdlet Get-Tip genera una nueva sugerencia del día del Shell de administración de Exchange. |
|
El cmdlet Get-ExBlog abre Microsoft Internet Explorer para que se muestre el blog del Equipo de Exchange. |
Vistas de ayuda
Cuando un cmdlet se especifica como parámetro del cmdlet Get-Help, se muestra la información de ayuda para el cmdlet especificado. En algunos casos, la información que se devuelve puede ser extensa, pero es posible que sólo desee ver información específica. Las vistas de ayuda permiten ver determinada información acerca de un cmdlet, sin tener que revisar información que puede que no necesite.
El Shell de administración de Exchange ofrece cuatro vistas que presentan exactamente la información que necesita. También puede obtener un determinado parámetro o un conjunto de parámetros similares. En la Tabla 4 se resumen las secciones que se muestran en cada una de las vistas.
Tabla 4 Vistas de ayuda del Shell de administración de Exchange
| Vista de ayuda | Predeterminada | En detalle | Completa | Ejemplos |
|---|---|---|---|---|
Sinopsis |
X |
X |
X |
X |
Sintaxis |
X |
X |
X |
|
Descripción detallada |
X |
X |
X |
|
Parámetros sin metadatos |
|
X |
|
|
Parámetros con metadatos |
|
|
X |
|
Tipo de entrada |
|
|
X |
|
Tipo de valores devueltos |
|
|
X |
|
Errores |
|
|
X |
|
Notas |
|
|
X |
|
Ejemplos |
|
X |
X |
X |
Vínculos relacionados |
X |
|
X |
|
Observaciones |
X |
X |
|
|
La tabla 5 describe cada vista y proporciona un ejemplo de un comando que llama a cada vista.
Tabla 5 Ejemplos de vistas de ayuda del Shell de administración de Exchange
| Vista de ayuda | Ejemplo | Descripción |
|---|---|---|
|
|
La vista predeterminada aparece cuando se utiliza el comando |
|
|
La vista Para obtener más información acerca de los parámetros, consulte Parámetros. |
|
|
La vista
Para obtener más información acerca de los parámetros, consulte Parámetros. |
|
|
La vista |
Además de estas cuatro vistas de ayuda, el Shell de administración de Exchange también permite el acceso a la descripción y los metadatos de un determinado parámetro o conjunto de parámetros similares. Puede especificar el parámetro junto con el comando Get-Help <cmdlet>. El siguiente ejemplo muestra cómo puede mostrar la descripción del parámetro ForwardingAddress en el cmdlet Set-Mailbox:
Get-Help Set-Mailbox -Parameter ForwardingAddress
También puede mostrar un conjunto de parámetros similares que existen en un determinado cmdlet, si especifica el nombre parcial de un parámetro, junto con un carácter comodín (*). El siguiente ejemplo muestra cómo es posible mostrar todos los parámetros del cmdlet Set-Mailbox que contiene la palabra "Quota":
Get-Help Set-Mailbox -Parameter *Quota*
Nota
Cuando utilice el parámetro Parameter con el cmdlet Get-Help para obtener ayuda para un cmdlet que tiene sólo un parámetro, el cmdlet Get-Help no devolverá resultados aunque utilice el carácter comodín (*). Éste es un problema conocido de Microsoft Windows PowerShell.
Parámetros Role, Component y Functionality
Cuando se llama al cmdlet Get-Help sin especificar un determinado cmdlet, se recibe una lista de todos los cmdlets disponibles en el Shell de administración de Exchange. No obstante, es posible que desee ver una lista de los cmdlets que administran una determinada función de servidor o característica de componente, o que afectan a los objetos a través de un determinado ámbito de funcionalidad. El cmdlet Get-Help permite hacer esto con tres parámetros: Role, Component y Functionality.
Cuando se utiliza el cmdlet Get-Help con los parámetros Role, Component o Functionality, tiene que encerrar entre caracteres comodín (*) los valores que especifique para esos parámetros. A continuación, encontrará ejemplos de cómo llamar a Get-Help con cada uno de los parámetros:
Get-Help -Role *Mailbox*
Get-Help -Component *Recipient*
Get-Help -Functionality *Server*
En las siguientes tablas se indica una relación de todos los valores que se pueden utilizar con los parámetros Role, Component y Functionality en el cmdlet Get-Help. En la tabla 6 se muestran los valores que se pueden utilizar con el parámetro Role.
Tabla 6 Valores válidos para Get-Help -Role
| Función | Valor | Valor alternativo |
|---|---|---|
Buzón |
|
|
Transporte de concentradores |
|
|
Acceso de cliente |
|
|
Mensajería unificada |
|
|
Transporte perimetral |
|
|
Administrador de organización |
|
|
Administrador de servidor |
|
|
Administrador de destinatarios |
|
|
Administrador de Windows |
|
|
Sólo lectura |
|
|
En la tabla 7 se muestran los valores que se pueden utilizar con el parámetro Component.
Tabla 7 Valores válidos para Get-Help -Component
| Valor | Valor |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
En la tabla 8 se muestran los valores que se pueden utilizar con el parámetro Functionality.
Tabla 8 Valores válidos para Get-Help -Functionality
| Valor |
|---|
|
|
|
Implementación del tabulador
La implementación del tabulador le permite no tener que escribir tanto cuando utiliza el Shell de administración de Exchange. Cuando escriba un nombre parcial de cmdlet, presione la tecla TAB y el Shell de administración de Exchange completará el nombre del cmdlet si encuentra uno que coincida. Si se encuentran varios nombres de cmdlet que coincidan, se irá cambiando de nombre al presionar el tabulador. Cuando se usa la implementación del tabulador con nombres de cmdlet, hay que proporcionar al menos el verbo y el guión (-). Los siguientes ejemplos muestran cómo se puede utilizar una implementación del tabulador cuando se introduzca un nombre de cmdlet.
Get-Transport<Tab>
Enable-<Tab>
Al presionar el tabulador en el primer ejemplo, el Shell de administración de Exchange cambia de uno a otro de los nombres de cmdlet que empiecen por Get Transport. En el segundo ejemplo, el Shell de administración de Exchange va de un cmdlet a otro con el verbo Enable.
Al igual que sucede con los nombres de cmdlet, puede utilizar la implementación del tabulador cuando desee que el Shell de administración de Exchange complete el nombre de parámetro parcial que haya escrito. Cuando utilice la implementación del tabulador con nombres de parámetros, tiene que especificar todo el nombre del cmdlet, bien escribiéndolo directamente, bien utilizando la implementación del tabulador. Los siguientes ejemplos muestran cómo se puede utilizar una implementación del tabulador cuando se introduzca un nombre de parámetro.
Set-Mailbox -Email<Tab>
New-TransportRule -Cond<Tab>
Al presionar el tabulador en el primer ejemplo, el Shell de administración de Exchange cambia de uno a otro de los nombres de cmdlet que empiecen por Email en el cmdlet Set-Mailbox. En el segundo ejemplo, cuando se pulsa el tabulador, el Shell de administración de Exchange completa el parámetro Condition en el cmdlet New-TransportRule.