Grupo de mandatos dpManagerCommands para el objeto AdminTask

Puede utilizar el lenguaje de scripts Jython para configurar el gestor de dispositivos DataPower con la herramienta wsadmin. El gestor de dispositivos IBM WebSphere DataPower proporciona un conjunto de capacidades para gestionar dispositivos DataPower. Utilice los mandatos y parámetros del grupo dpManagerCommands para consultar, configurar y administrar el gestor de dispositivos DataPower.

Los dispositivos IBM® WebSphere® DataPower SOA Appliance son dispositivos de red creados con una finalidad y fáciles de desplegar que simplifican, ayudan a proteger y aceleran el despliegue de los servicios web y XML.La primera vez que se utiliza el gestor de dispositivos DataPower no existe ningún dispositivo, ningún conjunto gestionado ni ninguna versión de firmware. Debe crear dispositivos, añadir versiones de firmware y crear conjuntos gestionados.

Antes de empezar, verifique que cada dispositivo que desee gestionar tiene el nivel de firmware 3.6.0.4 o posterior. Además, verifique que el punto final AMP (Appliance Management Protocol) esté habilitado para cada dispositivo. Si el punto final AMP de la interfaz de gestión XML se ha inhabilitado durante la instalación, utilice la GUI web de DataPower para habilitar el punto final AMP.

Nota: La GUI web de DataPower es distinta del gestor de dispositivos DataPower de la consola administrativa.
Utilice los mandatos siguientes para administrar el gestor de dispositivos DataPower:
Utilice los mandatos siguientes para administrar conjuntos gestionados:
Utilice los mandatos siguientes para gestionar tareas:

dpExport

El mandato dpExport exporta la configuración y las versiones del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-file
Especifica el archivo del sistema local al que el gestor de dispositivos DataPower exporta la configuración y las versiones. (String, obligatorio)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el sistema.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    [Windows]
    AdminTask.dpExport('-file c:/temp/DPManager.export_doc') 
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpExport('-file 
     /temp/DPManager.export')
  • Utilizando la lista Jython:
    [Windows]
    AdminTask.dpExport(['-file', 'C:/temp/DPManager.export'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpExport(['-file', 
     '/temp/DPManager.export'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpExport('-interactive')

dpGetManager

El mandato dpGetManager muestra las propiedades del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los valores actuales del gestor de dispositivos DataPower.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la lista y la serie Jython:
    AdminTask.dpGetManager()

dpGetManagerStatus

El mandato dpGetManagerStatus muestra el estado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Valor de retorno

El mandato devuelve una descripción del estado del gestor de dispositivos DataPower.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la lista y la serie Jython:
    AdminTask.dpGetManagerStatus()

dpImport

El mandato dpImport importa la configuración y las versiones del gestor de dispositivos DataPower. El mandato sustituye la configuración y las versiones existentes por la configuración y las versiones importadas.

Objeto de destino

Ninguno.

Parámetros necesarios

-file
Especifica el archivo del sistema del gestor de dispositivos DataPower que contiene la configuración y las versiones que deben importarse. (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    [Windows]
    AdminTask.dpImport('-file c:/temp/DPManager.import')
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpImport('-file 
     /temp/DPManager.import')
  • Utilizando la lista Jython:
    [Windows]
    AdminTask.dpImport(['-file', 'C:/temp/DPManager.export'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpImport(['-file', 
     '/temp/DPManager.export'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpImport('-interactive')

dpSetManager

El mandato dpSetManager modifica la configuración del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros opcionales

-maxVersionsToStore
Especifica el número máximo nuevo de versiones que deben mantenerse. (Integer, opcional)
-versionsDirectory
Especifica el directorio del sistema del gestor de dispositivos DataPower en el que el gestor crea las versiones. El mandato mueve las versiones existentes del directorio de versiones actual al directorio de versiones nuevo. (String, opcional)

Valor de retorno

Si especifica un valor para el parámetro versionsDirectory, el mandato devuelve el ID de la tarea que el mandato crea.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetManager('-maxVersionsToStore 20
    -versionsDirectory newDir')
  • Utilizando la lista Jython:
    AdminTask.dpSetManager(['-maxVersionsToStore', '20', '-versionsDirectory', 'newDir'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetManager('-interactive')

dpStopManager

El mandato dpStopManager detiene el gestor de dispositivos DataPower. El gestor se reinicia automáticamente la próxima vez que se utiliza el gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la lista y la serie Jython:
    AdminTask.dpStopManager()

dpAddAppliance

El mandato dpAddAppliance añade un dispositivo al gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-hostname
Especifica el nombre de host o la dirección IP del dispositivo. (String, obligatorio)
-hlmPort
Especifica el número de puerto que el gestor de dispositivos DataPower utiliza para comunicarse con el dispositivo. El valor predeterminado es 5550. (Integer, obligatorio)
-name
Especifica el nombre exclusivo del dispositivo en el gestor de dispositivos DataPower. No especifique los caracteres siguientes dentro del parámetro de nombre: \\/,#$@:;\"*?<>|=+&%' (String, obligatorio)
-userId
Especifica el ID de usuario que el gestor de dispositivos DataPower utiliza para acceder al dispositivo. (String, obligatorio)
-password
Especifica la contraseña codificado en base 64 que el gestor de dispositivos DataPower utiliza para acceder al dispositivo. (String, obligatorio)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el sistema. Cuando finaliza la tarea, el valor del atributo de resultado de la tarea contiene el ID del nuevo dispositivo.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpAddAppliance('[-hostname midispositivo.ibm.com – name midispositivo -userId
     admin -password mypassword]')
  • Utilizando la lista Jython:
    AdminTask.dpAddAppliance(['-hostname', 'midispositivo.ibm.com', '–name', 'midispositivo', '-userId', '
      admin', '-password', 'mypassword'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpAddAppliance('-interactive')

dpGetAllApplianceIds

El mandato dpGetAllApplianceIds muestra el ID de cada dispositivo del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Valor de retorno

El mandato devuelve una matriz de series que contiene cada ID de dispositivo de la configuración. Para los dispositivos, el ID es el número de serie del dispositivo DataPower.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la lista y la serie Jython:
    AdminTask.dpGetAllApplianceIds()

dpGetAllMSApplianceIds

El mandato dpGetAllMSApplianceIds muestra los ID de cada dispositivo en un conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve una matriz de series que contiene los ID de los dispositivos del conjunto gestionado de interés.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAllMSApplianceIds('[-managedSetId
    myManagedSet]')
  • Utilizando la lista Jython:
    AdminTask.dpGetAllMSApplianceIds(['-managedSetId',
    'myManagedSet'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAllMSApplianceIds('-interactive')

dpGetAppliance

El mandato dpGetAppliance muestra un dispositivo específico del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-applianceId
Especifica el ID del dispositivo en el gestor de dispositivos DataPower que debe visualizarse. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos del dispositivo de interés, como se muestra en la salida de ejemplo siguiente:
[
[userId admin] [applianceType XI50] [serialNumber [00605 20356]]
 [firmwareManagementStatus ManagementStatus.synced] [actualFirmwareLevel 3.6.1.0] [rollupOperationalStatus 
 OperationalStatus.unknown] [hostname dp3.dyn.webahead.ibm.com] [settingsManagementStatus ManagementStatus.synced] 
 [rollupManagementStatus ManagementStatus.synced] [applianceId [00605 20356]] [guiPort 8080] [modelType 9002] [isManaged true] 
 [managedSetId jgMS1] [featureLicenses [MQ, TAM, DataGlue, JAXP-API, PKCS7-SMIME, WebSphere-JMS]] [hlmPort 5550] [isMaster true] 
 [name dp3] ]
Tabla 1. Atributos de mandato. En la tabla siguiente se proporcionan descripciones de cada uno de los atributos devueltos por el mandato:
Atributo Descripción
applianceId Muestra el ID del dispositivo de interés.
managedSetId Muestra el ID del conjunto gestionado del que el dispositivo forma parte. Si el dispositivo no está gestionado, el mandato no devuelve este atributo.
actualFirmwareLevel Muestra el nivel de firmware del dispositivo.
featureLicenses Muestra una lista de titularidades de característica para el dispositivo, como MQ, TAM, etc.
guiPort Muestra el puerto del dispositivo para la interfaz GUI web de DataPower.
hlmPort Muestra el número de puerto para la comunicación entre el gestor de dispositivos DataPower y el dispositivo.
hostname Muestra el nombre de host o la dirección IP (Protocolo Internet) del dispositivo.
isManaged Muestra el valor true si el gestor de dispositivos DataPower gestiona el dispositivo.
isMaster Muestra el valor true si el dispositivo es el dispositivo maestro en el conjunto gestionado. Esta propiedad no se visualiza si el dispositivo no está gestionado por el gestor de dispositivos DataPower.
modelType Muestra el tipo de modelo del dispositivo.
applianceType Muestra el tipo de dispositivo.
settingsManagementStatus Muestra el estado de gestión de los valores del dispositivo. Este atributo también se conoce como estado de sincronización en la GUI web de DataPower.
firmwareManagementStatus Muestra el estado de gestión del firmware en el dispositivo. Este atributo también se conoce como estado de sincronización en la GUI web de DataPower.
domainManagementStatus Muestra el estado de gestión de un dominio específico en el dispositivo. Este atributo también se conoce como estado de sincronización en la GUI web de DataPower.
domainOperationalStatus Muestra el estado operativo de un dominio específico en el dispositivo.
rollupManagementStatus Muestra el estado de gestión agregado del firmware, de los valores y de los dominios en el dispositivo. Este atributo también se conoce como estado de sincronización en la GUI web de DataPower.
rollupOperationalStatus Muestra el estado operativo agregado del firmware, de los valores y de los dominios en el dispositivo.
serialNumber Muestra el número de serie del dispositivo de interés.
nombre Muestra el nombre del dispositivo en el gestor de dispositivos DataPower.
userId Muestra el ID de usuario que el gestor de dispositivos DataPower utiliza para acceder al dispositivo.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAppliance('-applianceId "00605 20356"')
  • Utilizando la lista Jython:
    AdminTask.dpGetAppliance(['-applianceId', '00605 20356']) 

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAppliance('-interactive')

dpManageAppliance

El mandato dpManageAppliance añade el dispositivo a un conjunto gestionado e inicia la gestión del dispositivo.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado del que el dispositivo forma parte. (String, obligatorio)
-applianceId
Especifica el ID del dispositivo del gestor de dispositivos DataPower que debe añadirse al conjunto gestionado. (String, obligatorio)

Parámetros opcionales

-asMaster
Especifica si el dispositivo debe establecerse como dispositivo maestro del conjunto gestionado. El primer dispositivo que se añade al conjunto gestionado se establece como dispositivo maestro, aun cuando no se especifique este parámetro. (String, opcional)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato. Cuando finaliza la tarea, el valor del atributo de resultado es el ID del dispositivo.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpManageAppliance('-managedSetId testMS1 -applianceId "00605 20351"')
  • Utilizando la lista Jython:
    AdminTask.dpManageAppliance(['-managedSetId', 'testMS1',
    '-applianceId', '00605 20351'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpManageAppliance('-interactive')

dpRemoveAppliance

El mandato dpRemoveAppliance elimina un dispositivo del gestor de dispositivos DataPower. Del mismo modo, el mandato elimina el dispositivo de un conjunto gestionado, si se trata de un miembro. No es posible eliminar un dispositivo establecido como dispositivo maestro de un conjunto gestionado. Debe seleccionar un dispositivo distinto como dispositivo maestro para eliminar el dispositivo maestro.

Objeto de destino

Ninguno.

Parámetros necesarios

-applianceId
Especifica el ID del dispositivo en el gestor de dispositivos DataPower que debe eliminarse del conjunto gestionado. Para los dispositivos, el ID es el número de serie del dispositivo DataPower. (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpRemoveAppliance('[-applianceId "00605 20356"]')
  • Utilizando la lista Jython:
    AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpRemoveAppliance('-interactive')

dpSetAppliance

El mandato dpSetAppliance modifica la configuración del gestor de dispositivos DataPower para un dispositivo.

Objeto de destino

Ninguno.

Parámetros necesarios

-applianceId
Especifica el ID del dispositivo en el gestor de dispositivos DataPower que debe modificarse. (String, obligatorio)

Parámetros opcionales

-hostname
Especifica el nombre de host o la dirección IP del dispositivo. (String, opcional)
-hlmPort
Especifica el número de puerto que el gestor de dispositivos DataPower utiliza para comunicarse con el dispositivo. El valor predeterminado es 5550. (Integer, opcional)
-name
Especifica el nombre exclusivo del dispositivo en el gestor de dispositivos DataPower. No especifique los caracteres siguientes dentro dle nombre de parámetro: \\/,#$@:;\"*?<>|=+&%' (String, optional)
-userId
Especifica el ID de usuario que el gestor de dispositivos DataPower utiliza para acceder al dispositivo. (String, opcional)
-password
Especifica la contraseña codificado en base 64 que el gestor de dispositivos DataPower utiliza para acceder al dispositivo. (String, opcional)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetAppliance('[-applianceId "00605 20356" -hostname myappliance2.ibm.com 
     -name myappliance2 -hlmPort 4500 -userId admin2 -password myPassword]')
  • Utilizando la lista Jython:
    AdminTask.dpSetAppliance(['-applianceId', '00605 20356', '-hostname', 
     'myappliance2.ibm.com', '-name', 'myappliance2', '-hlmPort', '4500', '-userId', 'admin2', 
     '-password', 'myPassword']) 

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetAppliance('-interactive')

dpUnmanageAppliance

El mandato dpUnmanageAppliance elimina el dispositivo de interés de su conjunto gestionado. El dispositivo deja de estar gestionado, pero permanece definido en el gestor.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado del que el dispositivo forma parte. (String, obligatorio)
-applianceId
Especifica el ID del dispositivo en el gestor de dispositivos DataPower que debe eliminarse del conjunto gestionado. (String, obligatorio)

Valor de retorno

El mandato devuelve la tarea que el mandato crea.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpUnmanageAppliance('[-managedSetId testMS1 -applianceId "00605 
     20351"]')
  • Utilizando la lista Jython:
    AdminTask.dpUnmanageAppliance(['-managedSetId', 'testMS1', '-applianceId "00605 20351"'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpUnmanageAppliance('-interactive')

dpAddManagedSet

El mandato dpAddManagedSet añade un conjunto gestionado al gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-name
Especifica el nombre exclusivo del dispositivo en el gestor de dispositivos DataPower. No especifique los caracteres siguientes dentro del parámetro de nombre: \\/,#$@:;\"*?<>|=+&%' (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpAddManagedSet('-name testMS')
  • Utilizando la lista Jython:
    AdminTask.dpAddManagedSet(['-name testMS'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpAddManagedSet('-interactive')

dpGetAllManagedSetIds

El mandato dpGetAllManagedSetIds muestra los ID de cada conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Valor de retorno

El mandato devuelve una matriz de series que contiene cada ID de conjunto gestionado.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la lista y la serie Jython:
    AdminTask.dpGetAllManagedSetIds()

dpGetManagedSet

El mandato dpGetManagedSet muestra información para un conjunto gestionado específico del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos para el conjunto gestionado.
Tabla 2. Atributos de mandato. En la tabla siguiente se proporciona información adicional sobre los atributos que el mandato devuelve:
Atributo Descripción
managedSetId Muestra el ID del conjunto gestionado.
masterApplianceId Muestra el ID del dispositivo maestro del conjunto gestionado.
desiredFirmwareVersionId Muestra el ID de la versión de firmware que debe utilizarse para el conjunto gestionado.
nombre Muestra el nombre asociado con el conjunto gestionado.
rollupOperationalStatus Muestra el estado operativo del conjunto gestionado.
rollupManagementStatus Muestra el estado de gestión del conjunto gestionado.
settingsId Muestra el ID de los valores del conjunto gestionado.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetManagedSet('-managedSetId testMS1')
  • Utilizando la lista Jython:
    AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1']) 

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetManagedSet('-interactive')

dpRemoveManagedSet

El mandato dpRemoveManagedSet elimina un conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado que debe eliminarse. (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpRemoveManagedSet('-managedSetId  testMS')
  • Utilizando la lista Jython:
    AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpRemoveManagedSet('-interactive')

dpSetManagedSet

El mandato dpSetManagedSet modifica un conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado que debe modificarse. (String, obligatorio)

Parámetros opcionales

-masterApplianceId
Especifica el ID del dispositivo que debe establecerse como dispositivo maestro para el conjunto gestionado. El dispositivo debe ser miembro del conjunto gestionado. Este parámetro se excluye mutuamente con el parámetro desiredFirmwareVersionId. (String, opcional)
-desiredFirmwareVersionId
Especifica el ID de la versión de firmware para sincronizar cada dispositivo del conjunto gestionado. Este parámetro se excluye mutuamente con el parámetro masterApplianceId. (String, opcional)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 
     20356"')
  • Utilizando la lista Jython:
    AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet',
    '-masterApplianceId', '"00605 20356"'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetManagedSet('-interactive')

dpSynchManagedSet

El mandato dpSynchManagedSet sincroniza manualmente un conjunto gestionado del gestor de dispositivos DataPower. El gestor intenta sincronizar automáticamente los dispositivos miembros.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado que debe sincronizarse. (String, obligatorio)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')
  • Utilizando la lista Jython:
    AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSynchManagedSet('-interactive')

dpAddFirmwareVersion

El mandato dpAddFirmwareVersion añade una versión de firmware al gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-file
Especifica el archivo del sistema de archivos del gestor de dispositivos DataPower que contiene la imagen de firmware que debe almacenarse en la versión de firmware. (String, obligatorio)

Parámetros opcionales

-userComment
Especifica el comentario que debe almacenarse en la versión de firmware. (String, opcional)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato. Cuando la tarea finaliza, el valor del atributo de resultado muestra el ID de la nueva versión de firmware.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    [Windows]
    AdminTask.dpAddFirmwareVersion('[-file 
     "C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpAddFirmwareVersion('[-file 
     "/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
  • Utilizando la lista Jython:
    [Windows]
    AdminTask.dpAddFirmwareVersion(['-file', 
     '"C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpAddFirmwareVersion(['-file', 
     '"/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpAddFirmwareVersion('-interactive')

dpGetAllFirmwareIds

El mandato dpGetAllFirmwareIds muestra los ID de cada firmware del gestor de dispositivos DataPower de la configuración.

Objeto de destino

Ninguno.

Valor de retorno

El mandato devuelve una matriz de series para cada ID de firmware de la configuración del gestor de dispositivos DataPower.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la lista y la serie Jython:
    AdminTask.dpGetAllFirmwareIds()

dpGetAllFirmwareVersionIds

El mandato dpGetAllFirmwareVersionIds muestra los ID de cada versión de firmware del gestor de dispositivos DataPower. Una versión de firmware representa una imagen de firmware que puede desplegar en un dispositivo DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-firmwareId
Especifica el ID del firmware que se debe consultar. (String, obligatorio)

Valor de retorno

El mandato devuelve una matriz de series que contiene todas las versiones de firmware de la configuración.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAllFirmwareVersionIds('-firmwareId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
  • Utilizando la lista Jython:
    AdminTask.dpGetAllFirmwareVersionIds(['-firmwareId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAllFirmwareVersionIds('-interactive')

dpGetAllMSIdsUsingFirmwareVersion

El mandato dpGetAllMSIdsUsingFirmwareVersion muestra los ID de los conjuntos gestionados que utilizan una versión de firmware.

Objeto de destino

Ninguno.

Parámetros necesarios

-firmwareVersionId
Especifica el ID de la versión de firmware de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve una matriz de series que contiene los ID de los conjuntos gestionados que utilizan la versión de firmware de interés.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Utilizando la lista Jython:
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-interactive')

dpGetBestFirmware

El mandato dpGetBestFirmware muestra el firmware del gestor de dispositivos DataPower que presenta mayor coincidencia con los parámetros. El firmware del gestor de dispositivos DataPower contiene una o más versiones de firmware que representan distintas versiones de firmware. El mandato no identifica el release de firmware óptimo de DataPower. El mandato identifica la versión de firmware que coincide con el dispositivo.

Objeto de destino

Ninguno.

Parámetros necesarios

-applianceType
Especifica el tipo de dispositivo del dispositivo DataPower para el que debe visualizarse el firmware. (String, obligatorio)
-modelType
Especifica el tipo de modelo del dispositivo DataPower para el que debe visualizarse el firmware. (String, obligatorio)
-applianceFeatures
Especifica las características de dispositivo del dispositivo DataPower para el que debe visualizarse el firmware. (String, obligatorio)

Parámetros opcionales

-level
Especifica el nivel de versión de firmware que debe contener el firmware devuelto. (String, opcional)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos del firmware.
Tabla 3. Atributos de mandato. En la tabla siguiente se describen los atributos que devuelve el mandato:
Atributo Descripción
firmwareId Muestra el ID del firmware.
applianceType Muestra el tipo de dispositivo para el que se utiliza el firmware.
modelType Muestra el tipo de modelo del firmware.
strictFeatures Muestra las características estrictas para las que se utiliza el firmware.
nonStrictFeatures Muestra las características no estrictas para las que se utiliza el firmware.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetBestFirmware('-applianceType "XS40" -modelType "9002" 
     -applianceFeatures "JAXP-API" -level "3.6.0.4"')
  • Utilizando la lista Jython:
    AdminTask.dpGetBestFirmware(['-applianceType', 'XS40', '-modelType', '9002', 
     '-applianceFeatures', 'JAXP-API', '-level', '3.6.0.4'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetBestFirmware('-interactive')

dpGetFirmware

El mandato dpGetFirmware muestra atributos para un firmware de gestor de dispositivos DataPower específico.

Objeto de destino

Ninguno.

Parámetros necesarios

-firmwareId
Especifica el ID del firmware de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos del firmware de interés.
Tabla 4. Atributos de mandato. En la tabla siguiente se describen los atributos que devuelve el mandato:
Atributo Descripción
firmwareId Muestra el ID del firmware.
applianceType Muestra el tipo de dispositivo para el que se utiliza el firmware.
modelType Muestra el tipo de modelo del firmware.
strictFeatures Muestra las características estrictas para las que se utiliza el firmware.
nonStrictFeatures Muestra las características no estrictas para las que se utiliza el firmware.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetFirmware('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
  • Utilizando la lista Jython:
    AdminTask.dpGetFirmware(['-firmwareId',
    'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetFirmware('-interactive')

dpGetFirmwareVersion

El mandato dpGetFirmwareVersion muestra una versión de firmware del gestor de dispositivos DataPower específica. Una versión de firmware representa una imagen de firmware que puede desplegar en un dispositivo DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-firmwareVersionId
Especifica el ID de la versión de firmware de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos de la versión de firmware.
Tabla 5. Atributos de mandato. En la tabla siguiente se ofrece información adicional sobre cada uno de los atributos que devuelve el mandato:
Atributo Descripción
firmwareVersionId Muestra el ID de la versión de firmware.
firmareId Muestra el ID del firmware que contiene la versión de firmware.
nivel Muestra el nivel de firmware.
manufactureDate Muestra la fecha de fabricación del firmware.
timestamp Muestra la fecha de carga de la imagen de firmware en el gestor de dispositivos DataPower.
userComment Muestra el comentario almacenado con la versión de firmware.
isInUse Muestra si un conjunto gestionado utiliza la versión de firmware.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Utilizando la lista Jython:
    AdminTask.dpGetFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetFirmwareVersion('-interactive')

dpRemoveFirmwareVersion

El mandato dpRemoveFirmwareVersion elimina una versión de firmware del gestor de dispositivos DataPower. El firmware que el sistema asocia con la versión de firmware permanece en el sistema. Antes de ejecutar este mandato, verifique que no existe ningún conjunto gestionado que utilice la versión de firmware que se debe eliminar.

Objeto de destino

Ninguno.

Parámetros necesarios

-firmwareVersionId
Especifica el ID de la versión de firmware que se debe eliminar. (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpRemoveFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Utilizando la lista Jython:
    AdminTask.dpRemoveFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpRemoveFirmwareVersion('-interactive')

dpSetFirmwareVersion

El mandato dpSetFirmwareVersion modifica una versión de firmware del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-firmwareVersionId
Especifica el ID de la versión de firmware que se debe modificar. (String, obligatorio)

Parámetros opcionales

-userComment
Especifica el comentario que debe almacenarse en la versión de firmware. (String, opcional)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15" -userComment "new user comment"')
  • Utilizando la lista Jython:
    AdminTask.dpSetFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15', '-userComment', 'new user comment'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetFirmwareVersion('-interactive')

dpCopyMSDomainVersion

El mandato dpCopyMSDomainVersion copia una versión de dominio gestionado del gestor de dispositivos DataPower en un nuevo conjunto gestionado.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado de interés. (String, obligatorio)
-msDomainVersionId
Especifica el ID de la versión del dominio gestionado que se debe copiar. (String, obligatorio)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpCopyMSDomainVersion('[-managedSetId myManagedSet
    -msDomainVersionId "myManagedSet:default:1"]')
  • Utilizando la lista Jython:
    AdminTask.dpCopyMSDomainVersion(['-managedSetId',
    'myManagedSet', '-msDomainVersionId',
    'myManagedSet:default:1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpCopyMSDomainVersion('-interactive')

dpGetAllDomainNames

El mandato dpGetAllDomainNames muestra los nombres de cada uno de los dominios de un dispositivo DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-applianceId
Especifica el ID del dispositivo en el gestor de dispositivos DataPower que debe visualizarse. (String, obligatorio)

Parámetros opcionales

-managed
Indica si se deben devolver los dominios gestionados. El mandato devuelve el nombre de cada uno de los dominios del dispositivo si no se especifican los parámetros managed o unmanaged, o si se especifican ambos parámetros. (String, opcional)
-unmanaged
Indica si el mandato devuelve los dominios no gestionados. El mandato devuelve el nombre de cada uno de los dominios del dispositivo si no se especifican los parámetros managed o unmanaged, o si se especifican ambos parámetros. (String, opcional)

Valor de retorno

El mandato devuelve una matriz de series de los nombres de los dominios del dispositivo.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAllDomainNames('[-applianceId "00605 20356" -managed -unmanaged]')
  • Utilizando la lista Jython:
    AdminTask.dpGetAllDomainNames(['-applianceId', '00605 20356', '-managed', 
     '-unmanaged'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAllDomainNames('-interactive')

dpGetAllMSDomainIds

El mandato dpGetAllMSDomainIds muestra los ID de cada dominio de un conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve una matriz de series que contiene los ID de los dominios del conjunto gestionado.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')
  • Utilizando la lista Jython:
    AdminTask.dpGetAllMSDomainIds(['-managedSetId',
    'myManagedSet'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAllMSDomainIds('-interactive')

dpGetAllMSDomainVersionIds

El mandato dpGetAllMSDomainVersionIds muestra el ID de la versión de cada dominio para un domino de un conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msDomainId
Especifica el ID del dominio gestionado que se debe visualizar. (String, obligatorio)

Valor de retorno

El mandato devuelve el ID para cada versión de dominio que existe para el domino del conjunto gestionado.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId
    ms1:domain1]')
  • Utilizando la lista Jython:
    AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId',
    'ms1:domain1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAllMSDomainVersionIds('-interactive')

dpGetMSDomain

El mandato dpGetMSDomain muestra un dominio en un conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msDomainId
Especifica el ID del dominio gestionado que se debe visualizar. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos para el dominio del conjunto gestionado de interés.
Tabla 6. Atributos de mandato. En la tabla siguiente se proporciona información adicional sobre cada uno de los atributos que devuelve el mandato:
Atributo Descripción
msDomainId Muestra el ID del dominio.
managedSetId Muestra el ID del conjunto gestionado al que pertenece el dominio.
nombre Muestra el nombre del dominio.
desiredDomainVersionId Muestra el ID de la versión del dominio que el conjunto gestionado utiliza para el dominio.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')
  • Utilizando la lista Jython:
    AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetMSDomain('-interactive')

dpGetMSDomainVersion

El mandato dpGetMSDomainVersion muestra una versión de dominio gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msDomainVersionId
Especifica el ID de la versión del dominio gestionado de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos de la versión del dominio del conjunto gestionado de interés.
Tabla 7. Atributos de mandato. En la tabla siguiente se proporciona información adicional sobre los atributos que el mandato devuelve:
Atributo Descripción
msDomainVersionId Muestra el ID de la versión del dominio gestionado.
msDomainId Muestra el ID del dominio gestionado.
versionNumber Muestra el número de versión.
timestamp Muestra la fecha en que el sistema creó la copia.
userComment Muestra el comentario almacenado con la versión del dominio del conjunto gestionado.
isInUse Muestra si el conjunto gestionado utiliza la versión del dominio para el dominio.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetMSDomainVersion('[-msDomainVersionId
    ms1:domain1:1]')
  • Utilizando la lista Jython:
    AdminTask.dpGetMSDomainVersion(['-msDomainVersionId',
    'ms1:domain1:1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetMSDomainVersion('-interactive')

dpManageDomain

El mandato dpManageDomain añade el dominio a un conjunto gestionado y empieza a gestionar el dominio.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado que se debe gestionar. (String, obligatorio)
-domain
Especifica el nombre del dominio en el dispositivo maestro que se debe gestionar. (String, obligatorio)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato. Cuando finaliza la tarea, el valor del atributo de resultado contiene el ID del nuevo dominio.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpManageDomain('[-managedSetId testMS1 -domain
    default]') 
  • Utilizando la lista Jython:
    AdminTask.dpManageDomain(['-managedSetId', 'testMS1',
    '-domain', 'default']) 

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpManageDomain('-interactive')

dpRemoveMSDomainVersion

El mandato dpRemoveMSDomainVersion elimina una versión de dominio gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msDomainVersionId
Especifica el ID de la versión de dominio gestionado que se debe eliminar. (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpRemoveMSDomainVersion('[-msDomainVersionId
    ms1:domain1:1]')
  • Utilizando la lista Jython:
    AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId',
    'ms1:domain1:1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpRemoveMSDomainVersion('-interactive')

dpSetMSDomain

El mandato dpSetMSDomain modifica un dominio gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msDomainId
Especifica el ID del dominio gestionado que se debe modificar. (String, obligatorio)

Parámetros opcionales

-desiredDomainVersionId
Especifica el ID de la versión del dominio gestionado que se debe sincronizar con cada dispositivo del conjunto gestionado. (String, opcional)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetMSDomain('[-msDomainId  ms1:domain1
    -desiredDomainVersionId ms1:domain1:1]')
  • Utilizando la lista Jython:
    AdminTask.dpSetMSDomain(['-msDomainId', 'ms1:domain1',
    '-desiredDomainVersionId', 'ms1:domain1:1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetMSDomain('-interactive')

dpSetMSDomainVersion

El mandato dpSetMSDomainVersion modifica una versión de dominio gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msDomainVersionId
Especifica el ID de la versión de dominio gestionado que se debe modificar. (String, obligatorio)

Parámetros opcionales

-userComment
Especifica el comentario que debe almacenarse en la versión del dominio. (String, opcional)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetMSDomainVersion('[-msDomainVersionId ms1:domain1:2 -userComment "New Web 
     Service proxy for banking application"]')
  • Utilizando la lista Jython:
    AdminTask.dpSetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:2',  '-userComment', 
     'New web service proxy for banking application'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetMSDomainVersion('-interactive')

dpUnmanageDomain

El mandato dpUnmanageDomain elimina el dominio de un conjunto gestionado y detiene la gestión del dominio.

Objeto de destino

Ninguno.

Parámetros necesarios

-msDomainId
Especifica el ID del dominio gestionado que se debe eliminar del conjunto gestionado. (String, obligatorio)

Parámetros opcionales

-clean
Suprime el dominio de cada dispositivo del conjunto gestionado. (String, opcional)

Valor de retorno

Si especifica el parámetro clean, el mandato devuelve el ID de la tarea que crea el sistema.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpUnmanageDomain('-msDomainId testMS1:default
    -clean')
  • Utilizando la lista Jython:
    AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default',
    '-clean'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpUnmanageDomain('-interactive')

dpCopyMSSettingsVersion

El mandato dpCopyMSSettingsVersion copia una versión de valores gestionados del gestor de dispositivos DataPower en un nuevo conjunto gestionado.

Objeto de destino

Ninguno.

Parámetros necesarios

-managedSetId
Especifica el ID del conjunto gestionado de interés. (String, obligatorio)
-msSettingsVersionId
Especifica el ID de la versión de valores gestionados que se debe copiar. (String, obligatorio)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')
  • Utilizando la lista Jython:
    AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet', ,-msSettingsVersionId', 
     'myManagedSet1:1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpCopyMSSettingsVersion('-interactive')

dpGetAllMSSettingsVersionIds

El mandato dpGetAllMSSettingsVersionIds muestra los ID de cada versión de valores de un conjunto gestionado del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msSettingsId
Especifica el ID de los valores gestionados de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve una matriz de series que contiene los ID de las versiones de los valores de conjuntos gestionados de interés.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')
  • Utilizando la lista Jython:
    AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId',
    'ms1:2'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetAllMSSettingsVersionIds('-interactive')

dpGetMSSettings

El mandato dpGetMSSettings muestra el ID del conjunto gestionado al que pertenecen los valores.

Objeto de destino

Ninguno.

Parámetros necesarios

-msSettingsId
Especifica el ID de los valores gestionados de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos de los valores de interés.
Tabla 8. Atributos de mandato. En la tabla siguiente se proporciona información adicional sobre los atributos que el mandato devuelve:
Atributo Descripción
msSettingsId Muestra el ID de los valores.
managedSetId Muestra el ID del ID gestionado al que se han asignado los valores.
desiredSettingsVersionId Muestra el ID de la versión de valores que el conjunto gestionado utiliza.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetMSSettings('-msSettingsId ms1:2')
  • Utilizando la lista Jython:
    AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetMSSettings('-interactive')

dpGetMSSettingsVersion

El mandato dpGetMSSettingsVersion muestra una versión de valores gestionados del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msSettingsVersionId
Especifica el ID de la versión de valores gestionados de interés. (String, obligatorio)

Valor de retorno

El mandato devuelve un objeto de propiedades que contiene los atributos de la versión de valores del conjunto gestionado de interés.
Tabla 9. Atributos de mandato. En la tabla siguiente se proporciona información adicional sobre los atributos que el mandato devuelve:
Atributo Descripción
msSetSettingsVersionId Muestra el ID de la versión de valores del conjunto gestionado.
msSettingsId Muestra el ID de los valores del conjunto gestionado de interés.
timestamp Muestra la fecha en que el sistema creó la copia.
versionNumber Muestra el número de versión.
userComment Muestra el comentario asociado con la versión de los valores del conjunto gestionado.
isInUse Muestra el ID de la versión de valores que el conjunto gestionado utiliza.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')
  • Utilizando la lista Jython:
    AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId',
    'ms1:2'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetMSSettingsVersion('-interactive')

dpRemoveMSSettingsVersion

El mandato dpRemoveMSSettingsVersion elimina una versión de valores gestionados del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msSettingsVersionId
Especifica el ID de la versión de los valores gestionados que se deben eliminar. (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpRemoveMSSettingsVersion('-msSettingsVersionId
    ms1:2')
  • Utilizando la lista Jython:
    AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId',
    'ms1:2'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpRemoveMSSettingsVersion('-interactive')

dpSetMSSettings

El mandato dpSetMSSettings modifica los valores gestionados del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msSettingsId
Especifica el ID de los valores gestionados que se deben modificar. (String, obligatorio)

Parámetros opcionales

-desiredSettingsVersionId
Especifica el ID de la versión de valores que se deben sincronizar con cada dispositivo del conjunto gestionado. (String, opcional)

Valor de retorno

El mandato devuelve el ID de la tarea que crea el mandato.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetMSSettings('-msSettingsId ms1
    -desiredSettingsVersionId ms1:1')
  • Utilizando la lista Jython:
    AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1',
    '-desiredSettingsVersionId', 'ms1:1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetMSSettings('-interactive')

dpSetMSSettingsVersion

el mandato dpSetMSSettingsVersion modifica una versión de valores gestionados del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Parámetros necesarios

-msSettingsVersionId
Especifica el ID de la versión de los valores gestionados que se deben modificar. (String, obligatorio)

Parámetros opcionales

-userComment
Especifica el comentario que debe almacenarse en la versión de los valores. (String, opcional)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpSetMSSettingsVersion('[-msSettingsVersionId ms1:2 -userComment "has new 
     timeserver added"]')
  • Utilizando la lista Jython:
    AdminTask.dpSetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2', '-userComment', 'has 
     new timeserver added'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpSetMSSettingsVersion('-interactive')

dpGetAllTaskIds

El mandato dpGetAllTaskIds muestra los ID de cada una de las tarea del gestor de dispositivos DataPower.

Objeto de destino

Ninguno.

Valor de retorno

El mandato devuelve una lista de los ID de las tareas asíncronas que existen actualmente en el gestor de dispositivos DataPower.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la lista y la serie Jython:
    AdminTask.dpGetAllTaskIds()

dpGetTask

El mandato dpGetTask muestra información para una tarea de gestor de dispositivos DataPower específica.

Objeto de destino

Ninguno.

Parámetros necesarios

-taskId
Especifica el ID de la tarea de interés. (String, obligatorio)

Valor de retorno

Tabla 10. Atributos de mandato. El mandato devuelve información sobre la tarea asíncrona de interés, incluidos los atributos siguientes:
Atributo Descripción
taskId Muestra el ID exclusivo de la tarea.
taskDescription Muestra una descripción de la tarea.
creationDate Muestra la fecha y la hora en que el sistema creó la tarea.
createdByUser Muestra el usuario que creó la tarea.
currentStep Muestra el número de paso actual para la tarea.
currentStepDescription Muestra una descripción del paso actual.
currentStepTimestamp Muestra la fecha y la hora de la última actualización del paso actual en la tarea. El sistema actualiza el atributo currentTimeStamp cuando el sistema construye el objeto, actualiza un paso, marca la tarea como terminada o experimenta una excepción.
error Muestra el mensaje de error de la excepción que ha causado la finalización de la tarea, si procede.
totalSteps Muestra el número total estimado de pasos para la tarea. Este argumento no debe utilizarse para determinar si la tarea ha terminado. Consulte el atributo isComplete para determinar si la tarea ha terminado.
hasError Muestra el valor true si la tarea no ha terminado correctamente.
hasUpdate Muestra el valor true si la tarea se ha actualizado.
isComplete Muestra el valor true si la tarea ha terminado.
taskStatus Muestra un valor entero que representa el estado de la tarea. Si el valor devuelto es 0, la tarea está en una cola y el sistema no ha iniciado la tarea. Si el valor devuelto es 1, la tarea está en curso. Si el valor devuelto es 2, la tarea ha finalizado satisfactoriamente. Si el valor devuelto es 3, la tarea ha experimentado una excepción.
result Muestra el resultado devuelto por la tarea. Consulte el mandato específico para determinar si el mandato devuelve datos de salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpGetTask('-taskId 1')
  • Utilizando la lista Jython:
    AdminTask.dpGetTask(['-taskId', '1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpGetTask('-interactive')

dpPurgeTask

El mandato dpPurgeTask depura una tarea específica del gestor de dispositivos DataPower. El sistema suprime automáticamente la tarea transcurridas 24 horas.

Objeto de destino

Ninguno.

Parámetros necesarios

-taskId
Especifica el ID de la tarea en el gestor de dispositivos DataPower que se debe depurar. (String, obligatorio)

Valor de retorno

El mandato no devuelve ninguna salida.

Ejemplo de utilización de la modalidad por lotes

  • Utilizando la serie Jython:
    AdminTask.dpPurgeTask('-taskId 1')
  • Utilizando la lista Jython:
    AdminTask.dpPurgeTask(['-taskId', '1'])

Ejemplo de utilización de la modalidad interactiva

  • En Jython:
    AdminTask.dpPurgeTask('-interactive')

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_7dpManagerCommands
File name: rxml_7dpManagerCommands.html