Grupo de Comandos AdministrativeJobs para o Objeto AdminTask Utilizando a Programação de Script Wsadmin
É possível utilizar as linguagens de script Jython para configurar e gerenciar tarefas administrativas com a ferramenta wsadmin.
deleteJob
O comando deleteJob exclui uma tarefa existente do gerenciador de tarefas. Se a tarefa estiver em execução quando você chamar o comando, o sistema ainda retornará os resultados da tarefa quer ela tenha ou não sido excluída.
Objeto de Destino
Nenhum.
Parâmetros Obrigatórios
- -jobToken
- Especifica o identificador exclusivo da tarefa a ser excluída. (Cadeia, requerido)
Valor de Retorno
O comando não retorna saída.
Uso de exemplo do modo em lote
- Utilizando a cadeia Jython:
AdminTask.deleteJob('-jobToken myToken')
- Utilizando a lista Jython:
AdminTask.deleteJob('-jobToken', 'myToken')
Uso de exemplo do modo interativo
- Utilizando Jython:
AdminTask.deleteJob('-interactive')
getJobTargets
O comando getJobTargets exibe o destino para uma tarefa de interesse. O destino que o comando retorna para uma tarefa pode não estar inscrito ou ter sido excluído.
Objeto de Destino
Nenhum.
Parâmetros Obrigatórios
- -jobToken
- Especifica o identificador exclusivo da tarefa de interesse. (Cadeia, requerido)
Valor de Retorno
O comando retorna o nome do nó dos destinos da tarefa de interesse.
Exemplo de uso do modo em lote
- Utilizando a cadeia Jython:
AdminTask.getJobTargets('-jobToken myToken')
- Utilizando a lista Jython:
AdminTask.getJobTargets('-jobToken', 'myToken')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.getJobTargets('-interactive')
getJobTargetStatus
O comando getJobTargetStatus exibe o status de destino da tarefa mais recente para a tarefa de interesse.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -jobToken
- Especifica o identificador exclusivo da tarefa de interesse. (Sequência, requerido)
Parâmetros Opcionais
- -targetList
- Especifica uma lista de nomes de nós de destino. (Sequência[], opcional)
Valor de retorno
O comando retorna o status da tarefa mais recente para os destinos. O status poderá ser: NOT_ATTEMPTED, DISTRIBUTED, ASYNC_IN_PROGRESS, SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED, DELAYED ou REJECTED.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.getJobTargetStatus('-jobToken myToken')
- Utilizando a lista Jython:
AdminTask.getJobTargetStatus('-jobToken', 'myToken')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.getJobTargetStatus('-interactive')
getJobTargetHistory
O comando getJobTargetHistory exibe o histórico de destino da tarefa de interesse.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -jobToken
- Especifica o identificador exclusivo da tarefa de interesse. (Sequência, requerido)
- -target
- Especifica o nome do nó do destino de interesse. (Sequência, requerido)
- -maxReturn
- Especifica o número máximo de resultados a ser retornado. (Número inteiro, obrigatório)
Parâmetros Opcionais
- -startingTime
- Especifica a hora a partir da qual o comando retorna o histórico de destino da tarefa. (Sequência, opcional)
- -endingTime
- Especifica a hora em que o comando pára de retornar o histórico de destino da tarefa. (Sequência, opcional)
- -ascending
- Especifica se os resultados devem ser retornados na ordem crescente ou decrescente. Especifique true para exibir os resultados na ordem crescente ou false para exibi-los na ordem decrescente. (Booleano, opcional)
Valor de retorno
O comando retorna uma lista de atributos, em que o primeiro atributo especifica o número de correspondências e o segundo atributo especifica o histórico da tarefa no destino. Cada lista contém os atributos timestamp, status, message e result.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.getJobTargetHistory('-jobToken 2846493472984754 -target 3820J37H3017N294 -maxReturn 20')
- Utilizando a lista Jython:
AdminTask.getJobTargetHistory('-jobToken', '2846493472984754', '-target', '3820J37H3017N294', '-maxReturn', '20')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.getJobTargetHistory('-interactive')
getJobTypes
O comando getJobTypes exibe os tipos de tarefas suportados para um terminal de interesse.
Objeto de destino
Nenhum.
Parâmetros Opcionais
- -targetList
- Especifica uma lista de nomes de nós para o destino. (Sequência[], opcional)
- -group
- Especifica o nome do grupo para o destino. (Sequência, opcional)
Valor de retorno
O comando retorna uma lista de tipos de tarefas que cada destino especificado suporta.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.getJobTypes('-target myProfileKey')
- Utilizando a lista Jython:
AdminTask.getJobTypes('-target', 'myProfileKey')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.getJobTypes('-interactive')
getJobTypeMetadata
O comando getJobTypeMetadata exibe os metadados que estão associados a um tipo de tarefa específico.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -jobTypeList
- Especifica uma lista de tipos de tarefas de interesse. (Sequência[], opcional)
Valor de retorno
O comando retorna uma lista de atributos, incluindo os atributos name, label, description, job-properties e job-parameters.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.getJobTypeMetadata('-jobTypeList inventory')
- Utilizando a lista Jython:
AdminTask.getJobTypeMetadata('-jobTypeList', 'inventory')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.getJobTypeMetadata('-interactive')
getOverallJobStatus
O comando getOverallJobStatus exibe o status geral de uma tarefa específica ou de uma lista de tarefas de interesse.
Objeto de destino
Nenhum.
Parâmetros Opcionais
- -jobTokenList
- Especifica um ou mais dos identificadores exclusivos das tarefas de interesse. (Sequência[], opcional)
Valor de retorno
- O atributo STATE especifica o estado atual da tarefa.
- O atributo TOTAL_RESULTS especifica o número total de tarefas.
- O atributo DISTRIBUTED especifica o número de tarefas distribuídas.
- O atributo ASYNC_IN_PROGRESS especifica o número de tarefas assíncronas em progresso.
- O atributo SUCCEEDED especifica o número de tarefas bem-sucedidas.
- O atributo PARTIALLY_SUCCEEDED especifica o número de tarefas parcialmente concluídas. Por exemplo, o êxito parcial poderá ocorrer quando um nó representa vários servidores e apenas alguns dos servidores no nó concluem a tarefa com êxito.
- O atributo FAILED especifica o número de tarefas com falha.
- O atributo NOT_ATTEMPTED especifica o número de tarefas que o sistema não tentou.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.getOverallJobStatus('-jobTokenList myJobToken')
- Utilizando a lista Jython:
AdminTask.getOverallJobStatus('-jobTokenList', 'myJobToken')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.getOverallJobStatus('-interactive')
queryJobs
O comando queryJobs consulta o gerenciador de tarefas para cada tarefa enviada.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -query
- Especifica a expressão de procura a ser utilizada para consultar tarefas. (Sequência,
requerido)Utilize as seguintes diretrizes ao criar suas consultas de tarefas:
- A consulta consiste em uma chave, um operador e um valor ou uma lista de valores. Você pode especificar um único valor ou uma lista de valores separados por vírgula.
- Separe várias expressões por um espaço e o operador AND.
- As seguintes chaves sensíveis a maiúsculas e minúsculas são suportadas:
- jobToken
- Especifica o token da tarefa de uma tarefa específica a ser consultada.
- group
- Especifica o nome do grupo de nós a ser consultado.
- descrição
- Especifica a descrição da tarefa a ser consultada. Se a descrição contiver várias palavras, formate a descrição com aspas simples ou duplas, como description = "job description".
- activationDateTime
- Especifica a data e hora em que o sistema ativa a tarefa, como 2006-05-03T10:30:45-0000. A seção -0000 do valor da chave activationDateTime representa o formato RFC 822. Você pode especificar Z como um atalho para GMT (Horário de Greenwich), como 2006-05-03T10:30:45Z. Se você não especificar o fuso horário, o sistema utilizará o fuso horário do servidor.
- expirationDateTime
- Especifica a data e a hora em que a tarefa expira, como 2006-05-03T10:30:45-0000. A seção -0000 do valor da chave activationDateTime representa o formato RFC 822. Você pode especificar Z como um atalho para GMT (Horário de Greenwich), como 2006-05-03T10:30:45Z. Se você não especificar o fuso horário, o sistema utilizará o fuso horário do servidor.
- estado
- Especifica o estado da tarefa. Os valores válidos incluem ASYNC_IN_PROGRESS, SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED, DELAYED, REJECTED e NOT_ATTEMPTED.
- target
- Especifica o nó de destino de uma tarefa. Utilize essa chave para retornar as tarefas de um nó específico. O comando retorna as tarefas do nó específico e dos grupos de nós aos quais o nó pertence. Só é possível especificar um targetID por consulta.
- Os seguintes operadores são suportados:
Tabela 1. Operadores queryJobs -query. Use um operador em uma consulta. Caractere Valor = Igual a. Especifique se o valor for nulo utilizando = NULL. != Diferente de. Especifique se o valor não for nulo utilizando != NULL > Maior que < Menor que >= Maior que ou igual a <= Menor que ou igual a
- -maxReturn
- Especifica o número máximo de correspondências a ser retornado. (Número inteiro, obrigatório)
Valor de retorno
[ [result [{activationDateTime=2008-03-11T11:56:48-0500,
expirationDateTime=2008-05-10T11:56:48-0500, jobToken=120525460839085191,
description=testSubmitJobToValidBaseTargetList}{activationDateTime=2008-03-11T14:05:33-0500,
expirationDateTime=2008-05-10T14:05:33-0500, jobToken=120526233387582472,
description=testSubmitJobToValidBaseTargetList}]] [size 2] ]
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
print AdminTask.queryJobs('-query activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01" -maxReturn 20')
print AdminTask.queryJobs('[-query "target = node3" -maxReturn 2]')
- Utilizando a lista Jython:
AdminTask.queryJobs('-query', 'activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01"', '-maxReturn', '20')
print AdminTask.queryJobs(['-query', '"target = node3"', '-maxReturn', '2'])
Exemplo de uso do modo interativo
- Utilizando a sequência Jython:
AdminTask.queryJobs('-interactive')
resumeJob
O comando resumeJob retoma uma tarefa iniciada anteriormente ou suspensa.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -jobToken
- Especifica o identificador exclusivo da tarefa de interesse. (Sequência, requerido)
Valor de retorno
O comando não retorna saída.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.resumeJob('-jobToken myToken')
- Utilizando a lista Jython:
AdminTask.resumeJob('-jobToken', 'myToken')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.resumeJob('-interactive')
submitJob
O comando submitJob envia uma nova tarefa administrativa ao gerenciador de tarefas.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -jobType
- Especifica o tipo de tarefa a ser enviado. (Sequência, requerido)
Parâmetros Opcionais
- -group
- Especifica o nome do grupo para o destino. (Sequência, opcional)
- -targetList
- Especifica uma lista de nós para o destino. (Sequência[], opcional)
- -jobParams
- Especifica os parâmetros necessários para a tarefa a ser enviada. (Properties, opcional)
- -username
- Especifica o nome de usuário a ser utilizado para submeter a tarefa quando a segurança estiver ativada. (Cadeia, opcional)
- -password
- Especifica a senha para o nome de usuário a ser utilizado para submeter a tarefa quando a segurança estiver ativada. (Cadeia, opcional)
- -description
- Especifica uma descrição da tarefa. (Sequência, opcional)
- -activationDateTime
- Especifica a data e hora de ativação da tarefa no formato "2006-05-03T10:30:45-0000". A seção "-0000" do valor do parâmetro activationDateTime representa o formato RFC 822. Você pode especificar "Z" como atalho para GMT (Horário de Greenwich), como "2006-05-03T10:30:45Z". Se você não especificar o fuso horário, o sistema utilizará o fuso horário do servidor. (Cadeia, opcional)
- -expirationDateTime
- Especifica a data de expiração da tarefa. (Cadeia, opcional)
- -executionWindow
- Especifica o intervalo recorrente da tarefa. (Sequência, opcional)
- -executionWindowUnit
- Especifica a unidade de medida do intervalo recorrente do valor definido pelo parâmetro executionWindow. Especifique DAILY para executar a tarefa diariamente, WEEKLY para executar a tarefa semanalmente, MONTHLY para executar a tarefa mensalmente ou YEARLY para executar a tarefa anualmente. Além disso, você pode especificar CONNECTION para executar a tarefa sempre que o nó conectar-se ao gerenciador de tarefas para sondar as tarefas. Ao especificar CONNECTION, não configure o parâmetro executionWindow. (Cadeia, opcional)
- Especifica o endereço de e-mail para o qual o sistema envia a tarefa. (Sequência, opcional)
Valor de retorno
O comando retorna um token de tarefa para a tarefa recém-enviada.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.submitJob('[-jobType createApplicationServer -target profileKey -jobParams "[serverName myServer]" ]')
- Utilizando a lista Jython:
AdminTask.submitJob(['-jobType', 'createApplicationServer', '-target', 'profileKey', '-jobParams', '"[serverName myServer]"'])
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.submitJob('-interactive')
suspendJob
O comando suspendJob suspende uma tarefa que foi enviada anteriormente.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -jobToken
- Especifica o identificador exclusivo da tarefa a ser suspensa. (Sequência, requerido)
Valor de retorno
O comando não retorna saída.
Exemplo de uso do modo em lote
- Utilizando a sequência Jython:
AdminTask.suspendJob('-jobToken myToken')
- Utilizando a lista Jython:
AdminTask.suspendJob('-jobToken', 'myToken')
Exemplo de uso do modo interativo
- Utilizando Jython:
AdminTask.suspendJob('-interactive')