Mandatos del objeto Help con scripts wsadmin

Puede utilizar los lenguajes de script Jython o Jacl para encontrar ayuda general e información en línea dinámica de ayuda general acerca de los MBeans que están ejecutándose actualmente con la herramienta wsadmin. Utilice el objeto Help como ayuda para escribir y ejecutar scripts con el objeto AdminControl.

AdminApp

Utilice el mandato AdminApp para ver un resumen de cada método disponible para el objeto AdminApp.

Objeto de destino

Ninguno.

Parámetros necesarios

Ninguno.

Parámetros opcionales

Ninguno.

Salida de ejemplo

WASX7095I: El objeto AdminApp permite manipular objetos de aplicación,
que incluye la instalación, la desinstalación, la edición y el
listado.  La mayoría de los mandatos que admite AdminApp funcionan en dos
modalidades: la modalidad predeterminada es una en la que AdminApp se comunica con
el producto para realizar las tareas. También es posible la
modalidad local, en la que no tiene lugar ninguna comunicación del servidor.  Para invocar
la modalidad de operación local, active el cliente de scripts sin ningún
servidor conectado utilizando la opción de línea de mandatos "-conntype NONE" o establezca la propiedad 
"com.ibm.ws.scripting.connectionType=NONE" en wsadmin.properties.

AdminConfig da soporte a los mandatos siguientes; si desea obtener información 
más detallada sobre cada uno de estos mandatos, utilice el mandato "help" de AdminAppp y 
del mandato como un argumento.

deleteUserAndGroupEntries  Suprime toda la información de usuarios o grupos de todos los roles y toda 
la información de nombre de usuario y contraseña de los roles RunAs de una aplicación determinada.

edit Edita las propiedades de una aplicación.

editInteractive Edita las propiedades de una aplicación de modo interactivo.

export Exporta una aplicación a archivo.

exportDDL Exporta una DDL de la
aplicación a un directorio

help Muestra información de ayuda.

install Instala una aplicación, dado un nombre de archivo y una serie de opción.

installInteractive Instala una aplicación en modalidad interactiva, dado un 
un nombre de archivo y una serie de opción.

isAppReady Comprueba si la aplicación está lista para ejecutarse

list Lista todas las aplicaciones instaladas, ya sean todas las aplicaciones o las aplicaciones de un ámbito de destino concreto. 

listModules Lista los módulos de una aplicación especificada.

options Muestra las opciones disponibles, para
un archivo dado o en general.

publishWSDL Publica archivos WSDL
para una aplicación dada

taskInfo        			Muestra información detallada perteneciente a una tarea de instalación dada

uninstall       			Desinstala una aplicación, dado un nombre de archivo y una serie de opción.

updateAccessIDs Actualiza la información de enlaces de usuario o grupo con el accessID del registro de usuarios 
para una aplicación dada

view Visualiza una aplicación o un módulo,
dado un nombre de aplicación o de módulo

Ejemplos

  • Utilizando Jacl:
    $Help AdminApp
  • Utilizando Jython:
    print Help.AdminApp()

AdminConfig

Utilice el mandato AdminConfig para ver un resumen de cada método disponible para el objeto AdminConfig.

Objeto de destino

Ninguno.

Parámetros necesarios

Ninguno.

Parámetros opcionales

Ninguno.

Salida de ejemplo

WASX7053I: Las
funciones siguientes están 
soportadas por AdminConfig: 


create Crea un objeto de configuración, 
si se proporciona un tipo, un padre y 

una lista de atributos. 


create Crea un objeto de configuración, 
si se proporciona un tipo, un padre y 

una lista de atributos y un nombre de atributo 
para el objeto nuevo 

remove Elimina el objeto de la configuración 
especificado. 

list Lista todos los objetos de configuración de 
un tipo determinado 

list Lista todos los objetos de configuración de 
un tipo determinado, 

dentro del ámbito proporcionado. 

show Muestra todos los atributos de un 
objeto de configuración 

show Muestra los atributos especificados de un 
objeto de configuración dado 

modify Cambia los atributos especificados de un 
objeto de configuración dado 

getId Muestra el configId de un objeto, 
dada una versión de serie de 

su contenedor. 

contents Muestra los objetos que contienen 
un tipo determinado 

parents Muestra los objetos que contienen 
un tipo determinado 

attributes Muestra los atributos de 
un tipo determinado 

types Muestra los tipos posibles para la 
configuración 

help Muestra información de ayuda. 

Ejemplos

  • Utilizando Jacl:
    $Help AdminConfig
  • Utilizando Jython:
    print Help.AdminConfig()

AdminControl

Utilice el mandato AdminControl para ver un resumen de los mandatos de ayuda y formas de invocar un mandato administrativo.

Objeto de destino

Ninguno.

Parámetros necesarios

Ninguno.

Parámetros opcionales

Ninguno.

Salida de ejemplo

WASX7027I: En AdminControl, se admiten las siguientes funciones: 

getHost Devuelve la representación de serie del host conectado. 

getPort Devuelve la representación de serie del puerto en uso. 

getType Devuelve la representación de serie del tipo de conexión en uso 

reconnect Vuelve a conectar con el servidor. 

queryNames Dados ObjectName y QueryExp, recupera el conjunto de ObjectNames que coinciden. 

queryNames Dado la versión de serie de ObjectName, recupera la serie de ObjectNames que coinciden. 

getMBeanCount   			Devuelve el número de beans registrados 

getDomainName Devuelve "WebSphere" 

getDefaultDomain Devuelve "WebSphere" 

getMBeanInfo Dado ObjectName, devuelve la estructura MBeanInfo del MBean 

isInstanceOf Dados ObjectName y el nombre de clase, devuelve true si el MBean es de esa clase 

isRegistered Es true si el ObjectName suministrado está registrado 

isRegistered Es true si la versión de serie suministrada de ObjectName está registrada 

getAttribute Dados ObjectName y el nombre de atributo, devuelve el valor de atributo 

getAttribute Dados ObjectName y el nombre de atributo, devuelve el valor de atributo 

getAttributes		Dados ObjectName y la matriz de nombres de atributos, devuelve AttributeList 

getAttributes  Dados la versión de serie de ObjectName y los nombres de atributos, 
devuelve la serie de pares de valores de nombres 

setAttribute Dados ObjectName y el objeto Attribute, establece el atributo del MBean especificado 

setAttribute dada la versión de String de ObjectName, el nombre de atributo y el valor de atributo, 
establece el atributo para el MBean especificado 

setAttributes Dados ObjectName y el objeto AttributeList, establece atributos para el MBean especificado 

invoke Cuando se proporcionan ObjectName, el nombre del método la matriz de parámetros y la firma, se invoca el método 
en el MBean especificado 

invoke Dada la versión de serie de ObjectName, el nombre de método, la versión de serie de la lista de
parámetro, invoca 
el método en el MBean especificado. 

invoke dados la versión de serie de ObjectName, el nombre de método, la versión de serie de la lista de parámetros, y 
la versión de serie de la matriz de signaturas, invoca el método en el MBean especificado. 

makeObjectName  			Devuelve un ObjectName creado con la serie proporcionada 

completeObjectName		Devuelve una versión de serie de un nombre de objeto dado un nombre de plantilla 

trace           			Establece la especificación de rastreo de wsadmin 

help Muestra información de ayuda. 

Ejemplos

  • Utilizando Jacl:
    $Help AdminControl
  • Utilizando Jython:
    print Help.AdminControl()

AdminTask

Utilice el mandato AdminTask para ver un resumen de los mandatos de ayuda y formas de invocar un mandato administrativo con el objeto AdminTask.

Objeto de destino

Ninguno.

Parámetros necesarios

Ninguno.

Parámetros opcionales

Ninguno.

Salida de ejemplo

WASX8001I: El objeto AdminTask habilita los mandatos administrativos disponibles. Los mandatos AdminTask 
operan en dos modalidades: la modalidad predeterminada en la que whichAdminTask se comunica con  el producto para realizar su tarea. 
Una modalidad local también está disponible en la que no tiene lugar ninguna comunicación de servidor. La modalidad local de operación se invoca
activando el cliente de script mediante la opción de línea de mandatos "-conntype NONE" o estableciendo la propiedad
"com.ibm.ws.scripting.connectiontype=NONE" en el archivo wsadmin.properties.

El número de mandatos administrativos varía en función de la
instalación del producto. Utilice los siguientes mandatos
 de ayuda para obtener una lista de los mandatos soportados y sus parámetros:

help -commands		 					lista todos los mandatos administrativos
help -commandGroups			lista todos los grupos de mandatos administrativos
help commandName 					muestra información detallada sobre el mandato especificado
help commandName stepName		muestra información detallada para el paso especificado perteneciente al mandato especificado
help commandGroupName		muestra información detallada para el grupo de mandatos especificado

Hay varias formas de invocar un mandato administrativo. Por ejemplo:

commandName invoca un mandato administrativo que no necesita ningún argumento

commandName targetObject invoca un mandato administrativo con la serie del objeto de destino, por ejemplo,
el nombre del objeto de configuración de un adaptador de recursos. El objeto de destino esperado varía con
el mandato de administración invocado.

Utilice el mandato help para obtener información acerca del objeto de destino de un mandato administrativo.

commandName  opciones invoca un mandato administrativo con las series de opciones especificadas. Esta sintaxis de invocación
 se utiliza para invocar un mandato administrativo que no requiere un objeto de destino.

También se utiliza para entrar en modalidad interactiva si se incluye la modalidad "-interactive" en la serie de opciones.

commandName targetObject opciones invoca un mandato administrativo con el objeto de destino especificado
y series de opciones.

Si se incluye "-interactive" en la serie e opciones, entonces se entra en la modalidad interactiva. 
El objeto de destino y las series de opciones varían según el mandato administrativo que se invoque. 
Utilice el mandato help para obtener información acerca del objeto de destino y las opciones.

Ejemplos

  • Utilizando Jacl:
    $AdminTask help
  • Utilizando Jython:
    print AdminTask.help()

todos

Utilice el mandato all para ver un resumen de la información que el MBean define por nombre.

Objeto de destino

Ninguno.

Parámetros necesarios

Nombre de MBean
Especifica el nombre del objeto que representa al MBean de interés. (Serie)

Parámetros opcionales

Ninguno.

Salida de ejemplo

Name: WebSphere:cell=pongo,name=TraceService,mbeanIdentifier=cells/pongo/nodes/pongo/servers/server1/
server.xml#TraceService_1,type=TraceService,node=pongo,process=server1
Description: null
Class name: javax.management.modelmbean.RequiredModelMBean

Attribute Type Access
ringBufferSize                  int                             RW
traceSpecification java.lang.String RW

Operation
int getRingBufferSize()
void setRingBufferSize(int)
java.lang.String getTraceSpecification()
void setTraceState(java.lang.String)
void appendTraceString(java.lang.String)
void dumpRingBuffer(java.lang.String)
void clearRingBuffer()
[Ljava.lang.String; listAllRegisteredComponents()
[Ljava.lang.String; listAllRegisteredGroups()
[Ljava.lang.String; listComponentsInGroup
(java.lang.String)
[Lcom.ibm.websphere.ras.TraceElementState; 
getTracedComponents()
[Lcom.ibm.websphere.ras.TraceElementState; 
getTracedGroups()
java.lang.String getTraceSpecification(java.
lang.String)
void processDumpString(java.lang.String)
void checkTraceString(java.lang.String)
void setTraceOutputToFile(java.lang.String, 
int, int, java.lang.String)
void setTraceOutputToRingBuffer(int, java.
lang.String)
java.lang.String rolloverLogFileImmediate
(java.lang.String, java.lang.String)


Notifications
jmx.attribute.changed

Constructors

Ejemplos

  • Utilizando Jacl:
    $Help all [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
  • Utilizando Jython:
    print Help.all(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

attributes

Utilice el mandato attributes para ver un resumen de todos los atributos que el MBean define por nombre. Si proporciona el nombre del MBean, el mandato muestra información acerca de los atributos, operaciones, constructores, descripción, notificaciones y nombre de clase del MBean especificado. Si especifica el nombre de MBean y el nombre de atributo, el mandato muestra información acerca del atributo especificado para el MBean especificado.

Objeto de destino

Ninguno.

Parámetros necesarios

Nombre de MBean
Especifica el nombre del objeto que representa al MBean de interés. (Serie)

Parámetros opcionales

nombre de atributo
Especifica el atributo de interés. (Serie)

Salida de ejemplo

Attribute Type Access 

ringBufferSize java.lang.Integer RW 

traceSpecification string RW 

Ejemplos

  • Utilizando Jacl:
    $Help attributes [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
  • Utilizando Jython:
    print Help.attributes(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

classname

Utilice el mandato classname para ver un nombre de clase que define el MBean por nombre.

Objeto de destino

Ninguno.

Parámetros necesarios

Nombre de MBean
Especifica el nombre del objeto que representa al MBean de interés. (Serie)

Parámetros opcionales

Ninguno.

Salida de ejemplo

javax.management.modelmbean.RequiredModelMBean

Ejemplos

  • Utilizando Jacl:
    $Help classname [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
  • Utilizando Jython:
    print Help.classname(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

constructors

Utilice el mandato constructors para ver un resumen de todos los constructores que el MBean define por nombre.

Objeto de destino

Ninguno.

Parámetros necesarios

Nombre de MBean
Especifica el nombre del objeto que representa al MBean de interés. (Serie)

Parámetros opcionales

Ninguno.

Salida de ejemplo

Constructors

Ejemplos

  • Utilizando Jacl:
    $Help constructors [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
  • Utilizando Jython:
    print Help.constructors(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

descripción

Utilice el mandato description para ver una descripción que define el MBean por nombre.

Objeto de destino

Ninguno.

Parámetros necesarios

Nombre de MBean
Especifica el nombre del objeto que representa al MBean de interés. (Serie)

Parámetros opcionales

Ninguno.

Salida de ejemplo

Objeto gestionado para el proceso de servidor global.

Ejemplos

  • Utilizando Jacl:
    $Help description [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
  • Utilizando Jython:
    print Help.description(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

help

Utilice el mandato help para ver un resumen de todos los métodos disponibles para el objeto Help.

Objeto de destino

Ninguno.

Parámetros necesarios

Ninguno.

Parámetros opcionales

Ninguno.

Salida de ejemplo

WASX7028I: El
objeto Help tiene dos objetivos:

En primer lugar, proporcione información de ayuda general para los objetos que proporciona la herramienta wsadmin 
para scripts: Help, AdminApp, AdminConfig y AdminControl.

En segundo lugar, proporcione medios para obtener información de interfaz acerca de los MBean que se ejecutan en el 
sistema.  Para este fin, se dispone de diferentes mandatos para obtener 
información acerca de las operaciones, atributos y otra información de interfaz 
acerca de los MBeans determinados.

Help da soporte a los siguientes mandatos. Se puede obtener información más detallada acerca de 
estos mandatos utilizando el mandato "help" y proporcionando el nombre del 
del mandato como un argumento.

attributes Dado un MBean, devuelve ayuda de atributos
operations Dado un MBean, devuelve ayuda de operaciones
constructors Dado un MBean, devuelve ayuda de constructores
description Dado un MBean, devuelve ayuda de descripción
notifications Dado un MBean, devuelve ayuda de notificaciones
classname Dado un MBean, devuelve ayuda de nombre de clase
all Dado un MBean, devuelve ayuda de todo lo anterior
help Devuelve este texto de ayuda
AdminCongtrol Devuelve texto de ayuda general del objeto AdminControl
AdminConfig Devuelve texto de ayuda general del objeto AdminConfig
AdminApp Devuelve texto de ayuda general del objeto AdminApp
AdminTask Devuelve texto de ayuda general del objeto AdminTask
wsadmin   Devuelve el texto de ayuda general para el iniciador de scripts de wsadmin
message   Dado un ID de mensaje, devuelve una explicación y una acción del usuario 

Ejemplos

  • Utilizando Jacl:
    $Help help
  • Utilizando Jython:
    print Help.help()

message

Utilice el mandato message para ver información para un ID de mensaje.

Objeto de destino

Ninguno.

Parámetros necesarios

ID de mensaje
Especifica el ID mensaje del mensaje de interés. (Serie)

Parámetros opcionales

Ninguno.

Salida de ejemplo

Explicación: el contenedor no ha podido 
desactivar un enterprise bean debido a la 
excepción {2} 
Acción del usuario: Efectúe la acción que se muestra 
en el mensaje de la excepción {2}

Ejemplos

  • Utilizando Jacl:
    $Help message CNTR0005W
  • Utilizando Jython:
    print Help.message('CNTR0005W')

notifications

Utilice el mandato notifications para ver un resumen de todas las notificaciones que el MBean define por nombre.

Objeto de destino

Ninguno.

Parámetros necesarios

Nombre de MBean
Especifica el nombre del objeto del MBean de interés. (Serie)

Parámetros opcionales

Ninguno.

Salida de ejemplo

Notification 

websphere.messageEvent.audit 

websphere.messageEvent.fatal 

websphere.messageEvent.error 

websphere.seriousEvent.info 

websphere.messageEvent.warning 

jmx.attribute.changed 

Ejemplos

  • Utilizando Jacl:
    $Help notifications [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
  • Utilizando Jython:
    print Help.notifications(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))

operations

Utilice el mandato operations con el parámetro de nombre de MBean para ver un resumen de todas las operaciones que el MBean define por nombre. Especifique un valor para el nombre de MBean y el nombre de operación para visualizar la firma de la operación para el MBean definido por nombre.

Objeto de destino

Ninguno.

Parámetros necesarios

Nombre de MBean
Especifica el nombre del objeto del MBean de interés. (Serie)

Parámetros opcionales

nombre de la operación
Especifica la operación de interés. (Serie)

Salida de ejemplo

El mandato devuelve una salida similar al ejemplo siguiente si especifique únicamente el parámetro de nombre de MBean:
Operation
int getRingBufferSize()
void setRingBufferSize(int)
java.lang.String getTraceSpecification()
void setTraceState(java.lang.String)
void appendTraceString(java.lang.String)
void dumpRingBuffer(java.lang.String)
void clearRingBuffer()
[Ljava.lang.String; listAllRegisteredComponents()
[Ljava.lang.String; listAllRegisteredGroups()
[Ljava.lang.String; listComponentsInGroup(java.lang.String)
[Lcom.ibm.websphere.ras.TraceElementState; getTracedComponents()
[Lcom.ibm.websphere.ras.TraceElementState; getTracedGroups()
java.lang.String getTraceSpecification(java.lang.String)
void processDumpString(java.lang.String)
void checkTraceString(java.lang.String)
void setTraceOutputToFile(java.lang.String, int, int, java.lang.String)
void setTraceOutputToRingBuffer(int, java.lang.String)
java.lang.String rolloverLogFileImmediate(java.lang.String, java.lang.String)
El mandato devuelve una salida similar al ejemplo siguiente si especifica los parámetros de nombre de MBean y nombre de la operación:
void processDumpString(string)

Descripción: graba el contenido del almacenamiento intermedio 
en anillo de servicios Ras en el archivo
especificado.

Parámetros:

Tipo         string
Nombre         dumpString
Description  Una serie con el formato especificado para procesar o un valor nulo.

Ejemplos

  • Utilizando Jacl:
    $Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*]
    $Help operations [$AdminControl queryNames type=TraceService,process=server1,node=pongo,*] processDumpString
  • Utilizando Jython:
    print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'))
    print Help.operations(AdminControl.queryNames('type=TraceService,process=server1,node=pongo,*'), 
    'processDumpString')

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rxml_helpobject
File name: rxml_helpobject.html