Grupo de Comandos dpManagerCommands para o Objeto AdminTask

Você pode usar a linguagem de script Jython para configurar o gerenciador de dispositivo DataPower com a ferramenta wsadmin. O gerenciador de dispositivo IBM WebSphere DataPower fornece um conjunto de recursos para gerenciamento dos dispositivos DataPower. Use os comandos e comandos no grupo dpManagerCommands para consultar, configurar e administrar o gerenciador de dispositivo DataPower.

Os dispositivos SOA do IBM® WebSphere® DataPower são dispositivos de rede fáceis de implementar, com propósito integrado, que simplificam, ajudam a proteger e aceleram as implementações de serviços da Web e XML. Na primeira vez que você usar o gerenciador de dispositivo DataPower, nenhum dispositivo, conjunto gerenciado ou versão de firmware existirá. Você deve criar dispositivos, incluir versões de firmware e criar conjuntos gerenciados.

Antes de começar, verifique se cada dispositivo que você deseja gerenciar tem um nível 3.6.0.4 ou superior de firmware. Além disso, verifique se o terminal AMP (Appliance Management Protocol) está ativado para cada dispositivo. Se o terminal AMP da interface Gerenciamento de XML for desativado durante a instalação, utilize a WebGUI do DataPower para ativar o terminal AMP.

Nota: A GUI da Web do DataPower é diferente do gerenciador de dispositivo DataPower no console administrativo.
Use os seguintes comandos para administrar o gerenciador de dispositivo DataPower:
Use os seguintes comandos para administrar conjuntos gerenciados:
Use os seguintes comandos para administrar tarefas:

dpExport

O comando dpExport exporta a configuração e as versões do gerenciador de dispositivo DataPower.

Objeto de destino

Nenhum.

Parâmetros Obrigatórios

-file
Especifica o arquivo de sistema local para o qual o gerenciador de dispositivo DataPower exporta a configuração e as versões. (Cadeia, obrigatória)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo sistema.

Uso de exemplo do modo em lote

  • Utilizando a cadeia 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 a 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'])

Exemplo de uso do modo interativo

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

dpGetManager

O comando dpGetManager exibe as propriedades do gerenciador de dispositivo DataPower.

Objeto de destino

Nenhum.

Valor de Retorno

O comando retorna um objeto de propriedades que contém as configurações atuais do gerenciador de dispositivo DataPower.

Uso de exemplo do modo em lote

  • Usando a lista e a cadeia Jython:
    AdminTask.dpGetManager()

dpGetManagerStatus

O comando dpGetManagerStatus exibe o status do gerenciador de dispositivo DataPower.

Objeto de destino

Nenhum.

Valor de Retorno

O comando retorna uma descrição do status do gerenciador de dispositivo DataPower.

Uso de exemplo do modo em lote

  • Usando a lista e a cadeia Jython:
    AdminTask.dpGetManagerStatus()

dpImport

O comando dpImport importa a configuração e as versões do gerenciador de dispositivo DataPower. O comando substitui a configuração e as versões existentes pela configuração e as versões importadas.

Objeto de destino

Nenhum.

Parâmetros Obrigatórios

-file
Especifica o arquivo de sistema do gerenciador de dispositivo DataPower que contém a configuração e as versões para importação. (Cadeia, obrigatória)

Valor de Retorno

O comando não retorna saída.

Uso de exemplo do modo em lote

  • Utilizando a cadeia 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 a 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'])

Exemplo de uso do modo interativo

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

dpSetManager

O comando dpSetManager modifica a configuração do gerenciador de dispositivo DataPower.

Objeto de destino

Nenhum.

Parâmetros Opcionais

-maxVersionsToStore
Especifica o novo número máximo de versões a ser mantido. (Integer, opcional)
-versionsDirectory
Especifica o diretório do sistema do gerenciador de dispositivo DataPower onde o gerenciador cria as versões. O comando move as versões existentes do diretório de versões atual para o novo diretório de versões. (Cadeia, opcional)

Valor de Retorno

Se você especificar um valor para o parâmetro versionsDirectory, o comando retornará o ID da tarefa criado pelo comando.

Uso de exemplo do modo em lote

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

Exemplo de uso do modo interativo

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

dpStopManager

O comando dpStopManager para o gerenciador de dispositivo DataPower. O gerenciador é reiniciado automaticamente na próxima vez que o gerenciador de dispositivo DataPower é usado.

Objeto de destino

Nenhum.

Valor de Retorno

O comando não retorna saída.

Uso de exemplo do modo em lote

  • Usando a lista e a cadeia Jython:
    AdminTask.dpStopManager()

dpAddAppliance

O comando dpAddAppliance inclui um dispositivo no gerenciador de dispositivo DataPower.

Objeto de destino

Nenhum.

Parâmetros Obrigatórios

-hostname
Especifica o nome do host ou o endereço IP do dispositivo. (Sequência, obrigatória)
-hlmPort
Especifica o número da porta que o gerenciador de dispositivo DataPower usa para se comunicar com o dispositivo. O valor padrão é 5550. (Integer, obrigatório)
-name
Especifica o nome exclusivo do dispositivo que o gerenciador de dispositivo DataPower usa. Não especifique os seguintes caracteres no parâmetro de nome: \\/,#$@:;\"*?<>|=+&%' (Cadeia, necessário)
-userId
Especifica o ID do usuário que o gerenciador de dispositivo DataPower usa para acessar o dispositivo. (Cadeia, obrigatória)
-password
Specifies the base-64 encoded password that the DataPower appliance manager uses to access the appliance. (Cadeia, obrigatória)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo sistema. Quando a tarefa terminar, o valor do atributo resultante na tarefa conterá o ID do novo dispositivo.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllApplianceIds

O comando dpGetAllApplianceIds exibe o ID de cada dispositivo do gerenciador de dispositivo DataPower.

Objeto de destino

Nenhum.

Valor de Retorno

O comando retorna uma matriz de cadeias contendo cada ID de dispositivo em sua configuração. Para dispositivos, o ID é o número de série do dispositivo DataPower.

Uso de exemplo do modo em lote

  • Usando a lista e a cadeia Jython:
    AdminTask.dpGetAllApplianceIds()

dpGetAllMSApplianceIds

O comando dpGetAllMSApplianceIds exibe os IDs de cada dispositivo em um conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de destino

Nenhum.

Parâmetros Obrigatórios

-managedSetId
Specifies the ID of the managed set of interest. (Cadeia, obrigatória)

Valor de Retorno

O comando retorna uma matriz de cadeias contendo os IDs dos dispositivos no conjunto gerenciado de seu interesse.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAppliance

O comando dpGetAppliance exibe um dispositivo do gerenciador de dispositivo DataPower específico.

Objeto de destino

Nenhum.

Parâmetros Obrigatórios

-applianceId
Especifica o ID do dispositivo no gerenciador de dispositivo DataPower a ser exibido. (Cadeia, obrigatória)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos do dispositivo de seu interesse, conforme exibido na saída de amostra a seguir:
[ [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] ]
Tabela 1. Atributos de Comando. A tabela a seguir fornece descrições de cada atributo que o comando retorna:
Atributo Descrição
applianceId Exibe o ID do dispositivo de seu interesse.
managedSetId Exibe o ID do conjunto gerenciado do qual o dispositivo é um membro. Se o dispositivo não for gerenciado, o comando não retornará esse atributo.
actualFirmwareLevel Exibe o nível do firmware do dispositivo.
featureLicenses Exibe uma lista de autorizações de recursos para o dispositivo, como MQ, TAM, e assim por diante.
guiPort Exibe a porta do dispositivo para a interface GUI da Web do DataPower.
hlmPort Exibe o número da porta para a comunicação entre o gerenciador de dispositivo DataPower e o dispositivo.
hostname Exibe o nome do host ou endereço do protocolo da Internet (IP) do dispositivo.
isManaged Exibe um valor de true se o gerenciador de dispositivo DataPower gerenciar o dispositivo.
isMaster Exibe um valor de true se o dispositivo for o dispositivo principal no conjunto gerenciado. Essa propriedade não será exibida se o dispositivo não for gerenciado pelo gerenciador de dispositivo DataPower.
modelType Exibe o tipo de modelo do dispositivo.
applianceType Exibe o tipo de dispositivo.
settingsManagementStatus Exibe o status de gerenciamento das configurações no dispositivo. Esse atributo também é chamado de status de sincronização na GUI da Web do DataPower.
firmwareManagementStatus Exibe o status de gerenciamento do firmware no dispositivo. Esse atributo também é chamado de status de sincronização na GUI da Web do DataPower.
domainManagementStatus Exibe o status de gerenciamento de um domínio específico no dispositivo. Esse atributo também é chamado de status de sincronização na GUI da Web do DataPower.
domainOperationalStatus Exibe o status operacional de um domínio específico no dispositivo.
rollupManagementStatus Exibe o status de gerenciamento agregado do firmware, das configurações e dos domínios no dispositivo. Esse atributo também é chamado de status de sincronização na GUI da Web do DataPower.
rollupOperationalStatus Exibe o status operacional agregado do firmware, das configurações e dos domínios no dispositivo.
serialNumber Exibe o número de série do dispositivo de seu interesse.
nome Exibe o nome do dispositivo no gerenciador de dispositivo DataPower.
userId Exibe o ID do usuário que o gerenciador de dispositivo DataPower usa para acessar o dispositivo.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpManageAppliance

O comando dpManageAppliance inclui o dispositivo em um conjunto gerenciado e começa a gerenciar o dispositivo.

Objeto de Destino

Nenhum.

Parâmetros necessários

-managedSetId
Especifica o ID do conjunto gerenciado do qual o dispositivo é um membro. (Cadeia, requerido)
-applianceId
Especifica o ID do dispositivo no gerenciador de dispositivo DataPower para incluir no conjunto gerenciado. (Cadeia, requerido)

Parâmetros Opcionais

-asMaster
Especifica se você deve configurar o dispositivo como dispositivo principal do conjunto gerenciado. O primeiro dispositivo incluído no conjunto gerenciado é configurado como dispositivo principal, mesmo que esse parâmetro não esteja especificado. (Sequência, opcional)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando. Quando a tarefa for concluída, o valor do atributo resultante será o ID do dispositivo.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpRemoveAppliance

O comando dpRemoveAppliance remove um dispositivo do gerenciador de dispositivo DataPower. Além disso, o comando remove o dispositivo de um conjunto gerenciado, se ele for um membro. Você não pode remover um dispositivo que seja principal em um conjunto gerenciado. Você deve selecionar um dispositivo diferente como principal antes de remover o dispositivo principal.

Objeto de Destino

Nenhum.

Parâmetros necessários

-applianceId
Especifica o ID do dispositivo no gerenciador de dispositivo DataPower para remover do conjunto gerenciado. Para dispositivos, o ID é o número de série do dispositivo DataPower. (Cadeia, requerido)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSetAppliance

O comando dpSetAppliance modifica a configuração do gerenciador de dispositivo DataPower para um dispositivo.

Objeto de Destino

Nenhum.

Parâmetros necessários

-applianceId
Especifica o ID do dispositivo no gerenciador de dispositivo DataPower para ser modificado. (Cadeia, requerido)

Parâmetros Opcionais

-hostname
Especifica o nome do host ou o endereço IP do dispositivo. (Sequência, opcional)
-hlmPort
Especifica o número da porta que o gerenciador de dispositivo DataPower usa para se comunicar com o dispositivo. O valor padrão é 5550. (Inteiro, opcional)
-name
Especifica o nome exclusivo do dispositivo que o gerenciador de dispositivo DataPower usa. Não especifique os seguintes caracteres no parâmetro de nome: \\/,#$@:;\"*?<>|=+&%' (Cadeia, opcional)
-userId
Especifica o ID do usuário que o gerenciador de dispositivo DataPower usa para acessar o dispositivo. (Sequência, opcional)
-password
Specifies the base-64 encoded password that the DataPower appliance manager uses to access the appliance. (Sequência, opcional)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpUnmanageAppliance

O comando dpUnmanageAppliance remove o dispositivo de seu interesse do conjunto gerenciado. O dispositivo não é mais gerenciado, mas continua definido para o gerenciador.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-managedSetId
Especifica o ID do conjunto gerenciado do qual o dispositivo é um membro. (Cadeia, requerido)
-applianceId
Especifica o ID do dispositivo no gerenciador de dispositivo DataPower para remover do conjunto gerenciado. (Cadeia, requerido)

Valor de Retorno

The command returns the task that the command creates.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpAddManagedSet

O comando dpAddManagedSet inclui um conjunto gerenciado no gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-name
Especifica o nome exclusivo do dispositivo que o gerenciador de dispositivo DataPower usa. Não especifique os seguintes caracteres no parâmetro de nome: \\/,#$@:;\"*?<>|=+&%' (Cadeia, necessário)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllManagedSetIds

O comando dpGetAllManagedSetIds exibe os IDs de cada conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Valor de Retorno

O comando retorna uma matriz de cadeias contendo cada ID do conjunto gerenciado.

Exemplo de uso do modo em lote

  • Usando a lista e a cadeia Jython:
    AdminTask.dpGetAllManagedSetIds()

dpGetManagedSet

O comando dpGetManagedSet exibe informações para um conjunto gerenciado do gerenciador de dispositivo DataPower específico.

Objeto de Destino

Nenhum.

Parâmetros necessários

-managedSetId
Specifies the ID of the managed set of interest. (Cadeia, requerido)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos para o conjunto gerenciado.
Tabela 2. Atributos de Comando. A tabela a seguir fornece informações adicionais sobre os atributos retornados pelo comando:
Atributo Descrição
managedSetId Exibe o ID do conjunto gerenciado.
masterApplianceId Exibe o ID do dispositivo principal do conjunto gerenciado.
desiredFirmwareVersionId Exibe o ID da versão do firmware a ser usado para o conjunto gerenciado.
nome Exibe o nome associado ao conjunto gerenciado.
rollupOperationalStatus Exibe o status operacional do conjunto gerenciado.
rollupManagementStatus Exibe o status de gerenciamento do conjunto gerenciado.
settingsId Exibe o ID das configurações para o conjunto gerenciado.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpRemoveManagedSet

O comando dpRemoveManagedSet remove um conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-managedSetId
Especifica o ID do conjunto gerenciado a ser removido. (Cadeia, requerido)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSetManagedSet

O comando dpSetManagedSet modifica um conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-managedSetId
Especifica o ID do conjunto gerenciado a ser modificado. (Cadeia, requerido)

Parâmetros Opcionais

-masterApplianceId
Especifica o ID do dispositivo a ser configurado como dispositivo principal para o conjunto gerenciado. Esse dispositivo deve ser membro do conjunto gerenciado. Esse parâmetro é mutuamente exclusivo com o parâmetro desiredFirmwareVersionId. (Sequência, opcional)
-desiredFirmwareVersionId
Especifica o ID da versão do firmware para sincronizar com cada dispositivo no conjunto gerenciado. Esse parâmetro é mutuamente exclusivo com o parâmetro masterApplianceId. (Sequência, opcional)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSynchManagedSet

O comando dpSynchManagedSet sincroniza manualmente um conjunto gerenciado do gerenciador de dispositivo DataPower. O gerenciador tenta sincronizar automaticamente os dispositivos do membro.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-managedSetId
Especifica o ID do conjunto gerenciado a ser sincronizado. (Cadeia, requerido)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpAddFirmwareVersion

O comando dpAddFirmwareVersion inclui uma versão de firmware no gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-file
Especifica o arquivo no sistema de arquivos do gerenciador de dispositivo DataPower que contém a imagem do firmware para armazenar na versão do firmware. (Cadeia, requerido)

Parâmetros Opcionais

-userComment
Especifica o comentário a ser armazenado na versão do firmware. (Sequência, opcional)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando. Quando a tarefa terminar, o valor do atributo resultante exibirá o ID da nova versão do firmware.

Exemplo de uso do modo em lote

  • Utilizando a cadeia 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 a 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"'])

Exemplo de uso do modo interativo

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

dpGetAllFirmwareIds

O comando dpGetAllFirmwareIds exibe os IDs de cada firmware do gerenciador de dispositivo DataPower na configuração.

Objeto de Destino

Nenhum.

Valor de Retorno

O comando retorna uma matriz de cadeias para cada ID de firmware na configuração do gerenciador de dispositivo DataPower.

Exemplo de uso do modo em lote

  • Usando a lista e a cadeia Jython:
    AdminTask.dpGetAllFirmwareIds()

dpGetAllFirmwareVersionIds

O comando dpGetAllFirmwareVersionIds exibe os IDs de cada versão de firmware do gerenciador de dispositivo DataPower. Uma versão de firmware representa uma imagem de firmware que você pode implementar em dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-firmwareId
Especifica o ID do firmware a ser consultado. (Cadeia, requerido)

Valor de Retorno

O comando retorna uma matriz de cadeias contendo cada versão de firmware em sua configuração.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllMSIdsUsingFirmwareVersion

O comando dpGetAllMSIdsUsingFirmwareVersion exibe os IDs dos conjuntos gerenciados que usam uma versão de firmware.

Objeto de Destino

Nenhum.

Parâmetros necessários

-firmwareVersionId
Especifica o ID da versão de firmware de seu interesse. (Cadeia, requerido)

Valor de Retorno

O comando retorna uma matriz de cadeias contendo os IDs dos conjuntos gerenciados que usam a versão de firmware de seu interesse.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetBestFirmware

O comando dpGetBestFirmware exibe o firmware no gerenciador de dispositivo DataPower que corresponde melhor aos parâmetros. O firmware no gerenciador de dispositivo DataPower contém uma ou mais versões que representam diferentes versões do firmware. Esse comando não identifica o release do firmware ideal do DataPower. O comando identifica a versão do firmware que corresponde ao dispositivo.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-applianceType
Especifica o tipo de dispositivo do dispositivo DataPower para o qual exibir o firmware. (Cadeia, requerido)
-modelType
Especifica o tipo de modelo do dispositivo DataPower para o qual exibir o firmware. (Cadeia, requerido)
-applianceFeatures
Especifica os recursos de dispositivo do dispositivo DataPower para o qual exibir o firmware. (Cadeia, requerido)

Parâmetros Opcionais

-level
Especifica o nível da versão do firmware que deve ser contido no firmware retornado. (Sequência, opcional)

Valor de Retorno

The command returns a properties object that contains the attributes of the firmware.
Tabela 3. Atributos de Comando. A tabela a seguir descreve os atributos retornados pelo comando:
Atributo Descrição
firmwareId Exibe o ID do firmware.
applianceType Exibe o tipo de dispositivo para o qual o firmware é usado.
modelType Exibe o tipo de modelo do firmware.
strictFeatures Exibe os recursos estritos para os quais o firmware é usado.
nonStrictFeatures Exibe os recursos não estritos para os quais o firmware é usado.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetFirmware

O comando dpGetFirmware exibe atributos para um firmware do gerenciador de dispositivo DataPower específico.

Objeto de Destino

Nenhum.

Parâmetros necessários

-firmwareId
Especifica o ID do firmware de seu interesse. (Cadeia, requerido)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos do firmware de seu interesse.
Tabela 4. Atributos de Comando. A tabela a seguir descreve os atributos retornados pelo comando:
Atributo Descrição
firmwareId Exibe o ID do firmware.
applianceType Exibe o tipo de dispositivo para o qual o firmware é usado.
modelType Exibe o tipo de modelo do firmware.
strictFeatures Exibe os recursos estritos para os quais o firmware é usado.
nonStrictFeatures Exibe os recursos não estritos para os quais o firmware é usado.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetFirmwareVersion

O comando dpGetFirmwareVersion exibe uma versão de firmware do gerenciador de dispositivo DataPower específico. Uma versão de firmware representa uma imagem de firmware que você pode implementar em um dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-firmwareVersionId
Especifica o ID da versão de firmware de seu interesse. (Cadeia, requerido)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos da versão de firmware.
Tabela 5. Atributos de Comando. A tabela a seguir exibe informações adicionais sobre cada atributo retornado pelo comando:
Atributo Descrição
firmwareVersionId Exibe o ID da versão do firmware.
firmareId Exibe o ID do firmware contendo a versão do firmware.
level Exibe o nível do firmware.
manufactureDate Exibe a data em que o firmware foi fabricado.
timestamp Exibe a data em que a imagem do firmware foi carregada no gerenciador de dispositivo DataPower.
userComment Exibe o comentário armazenado com a versão do firmware.
isInUse Exibe se um conjunto gerenciado usa a versão do firmware.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpRemoveFirmwareVersion

O comando dpRemoveFirmwareVersion remove uma versão de firmware do gerenciador de dispositivo DataPower. O firmware que o sistema associa à versão do firmware permanece. Verifique se um conjunto gerenciado não está usando atualmente a versão de firmware a ser removida antes de você executar esse comando.

Objeto de Destino

Nenhum.

Parâmetros necessários

-firmwareVersionId
Especifica o ID da versão do firmware a ser removido. (Cadeia, requerido)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSetFirmwareVersion

O comando dpSetFirmwareVersion modifica uma versão de firmware do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-firmwareVersionId
Especifica o ID da versão do firmware a ser modificado. (Cadeia, requerido)

Parâmetros Opcionais

-userComment
Especifica o comentário a ser armazenado na versão do firmware. (Sequência, opcional)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpCopyMSDomainVersion

O comando dpCopyMSDomainVersion copia uma versão de domínio gerenciado do gerenciador de dispositivo DataPower em um novo conjunto gerenciado.

Objeto de Destino

Nenhum.

Parâmetros necessários

-managedSetId
Specifies the ID of the managed set of interest. (Cadeia, requerido)
-msDomainVersionId
Specifies the ID of the managed domain version to copy. (Cadeia, requerido)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllDomainNames

O comando dpGetAllDomainNames exibe os nomes de cada domínio em um dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-applianceId
Especifica o ID do dispositivo no gerenciador de dispositivo DataPower a ser exibido. (Cadeia, requerido)

Parâmetros Opcionais

-managed
Indica se você deve retornar os domínios gerenciados. The command returns the name of each domain on the appliance if you do not specify the managed or unmanaged parameters, or if you specify both parameters. (Sequência, opcional)
-unmanaged
Indica se o comando retorna os domínios não gerenciados. The command returns the name of each domain on the appliance if you do not specify the managed or unmanaged parameters, or if you specify both parameters. (String, opcional)

Valor de Retorno

O comando retorna uma matriz de cadeias dos nomes dos domínios no dispositivo.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllMSDomainIds

O comando dpGetAllMSDomainIds exibe os IDs de cada domínio em um conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros necessários

-managedSetId
Specifies the ID of the managed set of interest. (Cadeia, requerido)

Valor de Retorno

O comando retorna uma matriz de cadeias contendo os IDs dos domínios no conjunto gerenciado.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllMSDomainVersionIds

O comando dpGetAllMSDomainVersionIds exibe o ID de cada versão de domínio para um domínio em um conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-msDomainId
Specifies the ID of the managed domain to display. (Cadeia, requerido)

Valor de Retorno

O comando retorna o ID para cada versão de domínio que existe para o domínio do conjunto gerenciado.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetMSDomain

O comando dpGetMSDomain exibe um domínio em um conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-msDomainId
Specifies the ID of the managed domain to display. (Cadeia, requerido)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos para o domínio do conjunto gerenciado de seu interesse.
Tabela 6. Atributos de Comando. A tabela a seguir fornece informações adicionais sobre cada atributo retornado pelo comando:
Atributo Descrição
msDomainId Exibe o ID do domínio.
managedSetId Exibe o ID do conjunto gerenciado ao qual o domínio pertence.
nome Exibe o nome do domínio.
desiredDomainVersionId Exibe o ID da versão do domínio que o conjunto gerenciado usa para o domínio.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetMSDomainVersion

O comando dpGetMSDomainVersion exibe uma versão de domínio do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros necessários

-msDomainVersionId
Specifies the ID of the managed domain version of interest. (Cadeia, requerido)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos da versão de domínio do conjunto gerenciado de seu interesse.
Tabela 7. Atributos de Comando. A tabela a seguir fornece informações adicionais sobre os atributos retornados pelo comando:
Atributo Descrição
msDomainVersionId Exibe o ID da versão do domínio gerenciado.
msDomainId Exibe o ID do domínio gerenciado.
versionNumber Exibe o número da versão.
timestamp Exibe a data em que o sistema criou a cópia.
userComment Exibe o comentário que está armazenado com a versão do domínio do conjunto gerenciado.
isInUse Exibe se o conjunto gerenciado usa a versão do domínio para o domínio.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpManageDomain

O comando dpManageDomain inclui o domínio em um conjunto gerenciado e começa a gerenciar o domínio.

Objeto de Destino

Nenhum.

Parâmetros necessários

-managedSetId
Specifies the ID of the managed set to manage. (Cadeia, requerido)
-domain
Especifica o nome do domínio no dispositivo principal a ser gerenciado. (Cadeia, requerido)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando. Quando a tarefa for concluída, o valor do atributo resultante conterá o ID do novo domínio.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpRemoveMSDomainVersion

O comando dpRemoveMSDomainVersion remove uma versão de domínio gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-msDomainVersionId
Specifies the ID of the managed domain version to remove. (Cadeia, requerido)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSetMSDomain

O comando dpSetMSDomain modifica um domínio gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-msDomainId
Specifies the ID of the managed domain to modify. (Cadeia, requerido)

Parâmetros Opcionais

-desiredDomainVersionId
Especifica o ID da versão do domínio para sincronizar com cada dispositivo no conjunto gerenciado. (Sequência, opcional)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSetMSDomainVersion

O comando dpSetMSDomainVersion modifica uma versão de domínio do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros necessários

-msDomainVersionId
Specifies the ID of the managed domain version to modify. (Cadeia, requerido)

Parâmetros Opcionais

-userComment
Especifica o comentário a ser armazenado na versão do domínio. (Sequência, opcional)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpUnmanageDomain

O comando dpUnmanageDomain remove o domínio de um conjunto gerenciado e para de gerenciar o domínio.

Objeto de Destino

Nenhum.

Parâmetros necessários

-msDomainId
Especifica o ID do domínio gerenciado a ser removido do conjunto gerenciado. (Cadeia, requerido)

Parâmetros Opcionais

-clean
Exclui o domínio de cada dispositivo no conjunto gerenciado. (Sequência, opcional)

Valor de Retorno

Se você especificar o parâmetro clean, o comando retornará o ID da tarefa criada pelo sistema.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpCopyMSSettingsVersion

O comando dpCopyMSSettingsVersion copia uma versão das configurações gerenciadas do gerenciador de dispositivo DataPower em um novo conjunto gerenciado.

Objeto de Destino

Nenhum.

Parâmetros necessários

-managedSetId
Specifies the ID of the managed set of interest. (Cadeia, requerido)
-msSettingsVersionId
Specifies the ID of the managed settings version to copy. (Cadeia, requerido)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllMSSettingsVersionIds

O comando dpGetAllMSSettingsVersionIds exibe os IDs de cada versão de configurações em um conjunto gerenciado do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros necessários

-msSettingsId
Specifies the ID of the managed settings of interest. (Cadeia, requerido)

Valor de Retorno

O comando retorna uma matriz de cadeias contendo os IDs das versões das configurações do conjunto gerenciado de seu interesse.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetMSSettings

O comando dpGetMSSettings exibe o ID do conjunto gerenciado ao qual as configurações pertencem.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-msSettingsId
Specifies the ID of the managed settings of interest. (Cadeia, requerido)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos das configurações de seu interesse.
Tabela 8. Atributos de Comando. A tabela a seguir fornece informações adicionais sobre os atributos retornados pelo comando:
Atributo Descrição
msSettingsId Exibe o ID das configurações.
managedSetId Exibe o ID do ID gerenciado ao qual as configurações são designadas.
desiredSettingsVersionId Exibe o ID da versão das configurações que o conjunto gerenciado usa.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetMSSettingsVersion

O comando dpGetMSSettingsVersion exibe uma versão das configurações gerenciadas do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros necessários

-msSettingsVersionId
Specifies the ID of the managed settings version of interest. (Cadeia, requerido)

Valor de Retorno

O comando retorna um objeto de propriedades contendo os atributos da versão de configurações do conjunto gerenciado de seu interesse.
Tabela 9. Atributos de Comando. A tabela a seguir fornece informações adicionais sobre os atributos retornados pelo comando:
Atributo Descrição
msSetSettingsVersionId Exibe o ID da versão de configurações do conjunto gerenciado.
msSettingsId Exibe o ID das configurações do conjunto gerenciado de seu interesse.
timestamp Exibe a data em que o sistema criou a cópia.
versionNumber Exibe o número da versão.
userComment Exibe o comentário associado à versão das configurações do conjunto gerenciado.
isInUse Exibe o ID da versão das configurações que o conjunto gerenciado usa.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpRemoveMSSettingsVersion

O comando dpRemoveMSSettingsVersion remove uma versão de configurações gerenciadas do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-msSettingsVersionId
Specifies the ID of the managed settings version to remove. (Cadeia, requerido)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSetMSSettings

O comando dpSetMSSettings modifica as configurações gerenciadas do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-msSettingsId
Specifies the ID of the managed settings to modify. (Cadeia, requerido)

Parâmetros Opcionais

-desiredSettingsVersionId
Especifica o ID da versão das configurações para sincronizar com cada dispositivo no conjunto gerenciado. (Sequência, opcional)

Valor de Retorno

O comando retorna o ID da tarefa criada pelo comando.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpSetMSSettingsVersion

O comando dpSetMSSettingsVersion modifica uma versão de configurações gerenciadas do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Parâmetros necessários

-msSettingsVersionId
Specifies the ID of the managed settings version to modify. (Cadeia, requerido)

Parâmetros Opcionais

-userComment
Especifica o comentário a ser armazenado na versão de configurações. (Sequência, opcional)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpGetAllTaskIds

O comando dpGetAllTaskIds exibe os IDs de cada uma das tarefas do gerenciador de dispositivo DataPower.

Objeto de Destino

Nenhum.

Valor de Retorno

O comando retorna uma lista de cada ID de tarefa assíncrona que existe atualmente no gerenciador de dispositivo DataPower.

Exemplo de uso do modo em lote

  • Usando a lista e a cadeia Jython:
    AdminTask.dpGetAllTaskIds()

dpGetTask

O comando dpGetTask exibe informações para uma tarefa do gerenciador de dispositivo DataPower específico.

Objeto de Destino

Nenhum.

Parâmetros Obrigatórios

-taskId
Especifica o ID da tarefa de seu interesse. (Cadeia, requerido)

Valor de Retorno

Tabela 10. Atributos de Comando. O comando retorna informações sobre a tarefa assíncrona de seu interesse, incluindo os seguintes atributos:
Atributo Descrição
taskId Exibe o ID exclusivo da tarefa.
taskDescription Exibe uma descrição da tarefa.
creationDate Exibe a data e o horário em que o sistema criou a tarefa.
createdByUser Exibe o usuário que criou a tarefa.
currentStep Exibe o número da etapa atual da tarefa.
currentStepDescription Exibe uma descrição da etapa atual.
currentStepTimestamp Exibe o horário e a data em que a etapa atual foi atualizada pela última fez na tarefa. O sistema atualiza o atributo currentTimeStamp quando constrói o objeto, atualiza uma etapa, marca a tarefa concluída ou experimenta uma exceção.
error Exibe a mensagem de erro da exceção que fez com que a tarefa terminasse, se aplicável.
totalSteps Exibe o número total estimado de etapas para a tarefa. Não use esse argumento para determinar se a tarefa foi concluída. Consulte o atributo isComplete para determinar se a tarefa foi concluída.
hasError Exibe um valor de true se a tarefa não for concluída com sucesso.
hasUpdate Exibe um valor de true se a tarefa for atualizada.
isComplete Exibe um valor de true se a tarefa for concluída.
taskStatus Exibe um número inteiro que representa o status da tarefa. Se o valor retornado for 0, a tarefa estará em uma fila e o sistema não iniciou a tarefa. Se o valor retornado for 1, a tarefa estará em progresso. Se o valor retornado for 2, então a tarefa foi concluída com êxito. Se o valor retornado for 3, a tarefa encontrou uma exceção.
resultado Exibe o resultado retornado pela tarefa. Consulte o comando específico para determinar se o comando retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

dpPurgeTask

O comando dpPurgeTask limpa uma tarefa do gerenciador de dispositivo DataPower específico. O sistema exclui automaticamente a tarefa após 24 horas.

Objeto de Destino

Nenhum.

Parâmetros necessários

-taskId
Especifica o ID da tarefa no gerenciador de dispositivo DataPower para limpeza. (Cadeia, requerido)

Valor de Retorno

O comando não retorna uma saída.

Exemplo de uso do modo em lote

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

Exemplo de uso do modo interativo

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

Ícone que indica o tipo de tópico Tópico de Referência



Ícone de registro de data e hora Última atualização: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rxml_7dpManagerCommands
Nome do arquivo: rxml_7dpManagerCommands.html