Tarefas Administrativas de Domínio do Serviço de Catálogo

É possível usar os idiomas de script Jacl ou Jython para gerenciar os domínios de serviço de catálogo em sua configuração do WebSphere Application Server.

Requisitos

É necessário ter o WebSphere eXtreme Scale Client instalado em seu ambiente do WebSphere Application Server.

Lista de Todas as Tarefas Administrativas

Para obter uma lista de todas as tarefas administrativas associadas aos domínios do serviço de catálogo, execute o seguinte comando com wsadmin:
wsadmin>$AdminTask help XSDomainManagement 

Comandos

As tarefas administrativas para os domínios do serviço de catálogo incluem os seguintes comandos:

createXSDomain

O comando createXSDomain registra um novo domínio do serviço de catálogo.
Tabela 1. Argumentos de Comando createXSDomain
Argumento Descrição
-name (obrigatório) Especifica o nome do domínio do serviço de catálogo que deseja criar.
-default Especifica se o domínio do serviço de catálogo é o padrão para a célula. O valor-padrão é true. (Booleano: configurar para true ou false)
-properties Especifica as propriedades customizadas para o domínio do serviço de catálogo.
Tabela 2. Argumentos da Etapa defineDomainServers
Argumento Descrição
name_of_endpoint Especifica o nome do terminal do serviço de catálogo.
  • Para servidores de aplicativos existentes: O nome do terminal deve estar no seguinte formato: cell_name\node_name\server_name
  • Para servidores remotos: Especifica o nome do host do servidor remoto. É possível usar o mesmo nome para diversos terminais, mas os valores de porta do cliente devem ser exclusivos para cada terminal.
custom_properties Especifica propriedades customizadas para o terminal do domínio do serviço de catálogo. Se não tiver nenhuma propriedade customizada, use um conjunto de aspas duplas ("") para este argumento.
endpoint_ports
Especifica os números de porta para o terminal do domínio do serviço de catálogo. As portas devem ser especificadas na seguinte ordem: <client_port>,<listener_port>
Porta do Cliente
Especifica a porta que é usada para a comunicação entre os servidores de catálogos no domínio de serviço de catálogo. Este valor é necessário para os servidores de catálogos que estão em execução apenas nos processos do WebSphere Application Server e podem ser configurados para qualquer porta que não está sendo usada em outro lugar.
Porta do Listener
Especifica a porta que é usada para comunicação com clientes. Este valor é necessário para terminais remotos e deve corresponder ao valor usado quando o serviço de catálogo foi iniciado. A porta do listener é usada pelos clientes e contêiners se comunicarem com o serviço de catálogo.
Para obter os terminais remotos do WebSphere eXtreme Scale : Define a porta do listener do Object Request Broker (ORB) para os contêiners e clientes se comunicarem com o serviço de catálogo por meio do ORB. Para terminais do WebSphere Application Server, o valor da porta do listener é opcional porque o valor é herdado da configuração da porta BOOTSTRAP_ADDRESS.
Tabela 3. Argumentos da Etapa configureClientSecurity
Argumento Descrição
-securityEnabled Especifica que a segurança do cliente está ativada para o servidor de catálogos. O arquivo das propriedades de servidor que está associado ao servidor de catálogos selecionado deve ter a configuração securityEnabled correspondente no arquivo de propriedades de servidor. Se essas configurações não corresponderem, uma exceção ocorrerá. (Booleano: configurar para true ou false)
-credentialAuthentication (opcional) Indica se a autenticação da credencial é forçada ou suportada.
Nunca

Nenhuma autenticação por certificado de cliente é forçada.

Requerido
A autenticação de credencial é sempre forçada. Se o servidor não suportar autenticação de credencial, o cliente não poderá se conectar ao servidor.
Suportado
(Padrão) A autenticação de credencial é forçada apenas se o cliente e o servidor suportarem a autenticação de credencial.
-authenticationRetryCount (opcional) Especifica o número de vezes que a autenticação é tentada novamente se a credencial expirar.

Se você não deseja tentar a autenticação novamente, configure o valor para 0. O valor padrão é 0.

-credentialGeneratorClass Indicates the com.ibm.websphere.objectgrid.security.plugins.builtins. Classe de implementação WSTokenCredentialGenerator, para que o cliente recupere os tokens de segurança do encadeamento.
-credentialGeneratorProps Especifica as propriedades para a classe de implementação CredentialGenerator. As propriedades são configuradas para o objeto com o método setProperties(String). O valor da propriedades do gerador de credencial é usado apenas quando um valor for especificado para o campo Classe do Gerador de Credencial.

Valor de retorno:

Uso de exemplo do modo em lote

O modo em lote requer formatação correta da entrada do comando. Considere usar o modo interativo para assegurar que os valores que você inserir sejam processados corretamente. Quando usar o modo em lote, você deverá definir os argumentos da etapa -defineDomainServers usando uma matriz de propriedades específica. Esta matriz de propriedades está no formato name_of_endpoint custom_properties endpoint_ports. O valor de endpoint_ports é uma lista de portas que devem ser especificadas na seguinte ordem: <client_port>,<listener_port>.

Uso de exemplo do modo interativo
  • Usando Jacl:
    $AdminTask createXSDomain {-interactive}
  • Usando a cadeia Jython:
    AdminTask.createXSDomain ('[-interactive]')

deleteXSDomain

O comando deleteXSDomain exclui um domínio do serviço de catálogo.

Parâmetros obrigatórios:
-name
Especifica o nome do domínio do serviço de catálogo a excluir.

Valor de retorno:

Uso de exemplo do modo em lote
  • Usando Jacl:
    $AdminTask deleteXSDomain {-name TestDomain }
  • Usando a cadeia Jython:
    AdminTask.deleteXSDomain('[-name TestDomain ]')
Uso de exemplo do modo interativo
  • Usando Jacl:
    $AdminTask deleteXSDomain {-interactive}
  • Usando a cadeia Jython:
    AdminTask.deleteXSDomain ('[-interactive]')

getDefaultXSDomain

O comando getDefaultXSDomain retorna o domínio do serviço de catálogo padrão para a célula.

Parâmetros obrigatórios: Nenhum

Valor de retorno: O nome do domínio do serviço de catálogo padrão.

Uso de exemplo do modo em lote
  • Usando Jacl:
    $AdminTask getDefaultXSDomain
  • Usando a cadeia Jython:
    AdminTask.getDefaultXSDomain
Uso de exemplo do modo interativo
  • Usando Jacl:
    $AdminTask getDefaultXSDomain {-interactive}
  • Usando a cadeia Jython:
    AdminTask.getDefaultXSDomain ('[-interactive]')

listXSDomains

O comando listXSDomains retorna uma lista dos domínios do serviço de catálogo existentes.

Parâmetros obrigatórios: Nenhum

Valor de retorno: Uma lista de todos os domínios do serviço de catálogo na célula.

Uso de exemplo do modo em lote
  • Usando Jacl:
    $AdminTask listXSDomains
  • Usando a cadeia Jython:
    AdminTask.listXSDomains
Uso de exemplo do modo interativo
  • Usando Jacl:
    $AdminTask listXSDomains {-interactive}
  • Usando a cadeia Jython:
    AdminTask.listXSDomains ('[-interactive]')

modifyXSDomain

O comando modifyXSDomain modifica um domínio do serviço de catálogo existente.

O modo em lote requer formatação correta da entrada do comando. Considere usar o modo interativo para assegurar que os valores que você inserir sejam processados corretamente. Quando usar o modo em lote, você deve definir os argumentos da etapa -modifyEndpoints, -addEndpoints e -removeEndpoints usando uma matriz de propriedades específica. Esta matriz de propriedades está no formato name_of_endpoint host_name custom_properties endpoint_ports. O valor de endpoint_ports é uma lista de portas que devem ser especificadas na seguinte ordem: <client_port>,<listener_port>.

Tabela 4. Argumentos de Comando modifyXSDomain
Argumento Descrição
-name (obrigatório) Especifica o nome do domínio do serviço de catálogo que você deseja editar.
-default Se configurado para true, especifica que o domínio do serviço de catálogo selecionado é o padrão para a célula. (Booleano)
-properties Especifica as propriedades customizadas para o domínio do serviço de catálogo.
Tabela 5. Argumentos da Etapa modifyEndpoints
Argumento Descrição
name_of_endpoint Especifica o nome do terminal do serviço de catálogo.
  • Para servidores de aplicativos existentes: O nome do terminal deve estar no seguinte formato: cell_name\node_name\server_name
  • Para servidores remotos: Especifica o nome do host do servidor remoto. É possível usar o mesmo nome para diversos terminais, mas os valores da porta do listener devem ser exclusivos para cada terminal.
endpoint_ports
Especifica os números de porta para o terminal do domínio do serviço de catálogo. Os terminais devem ser especificados na seguinte ordem: <client_port>,<listener_port>
Porta do Cliente
Especifica a porta que é usada para a comunicação entre os servidores de catálogos no domínio de serviço de catálogo. Este valor é necessário para os servidores de catálogos que estão em execução apenas nos processos do WebSphere Application Server e podem ser configurados para qualquer porta que não está sendo usada em outro lugar.
Porta do Listener
Especifica a porta que é usada para comunicação com clientes. Este valor é necessário para terminais remotos e deve corresponder ao valor usado quando o serviço de catálogo foi iniciado. A porta do listener é usada pelos clientes e contêiners se comunicarem com o serviço de catálogo.
Para obter os terminais remotos do WebSphere eXtreme Scale : Define a porta do listener do Object Request Broker (ORB) para os contêiners e clientes se comunicarem com o serviço de catálogo por meio do ORB. Para terminais do WebSphere Application Server, a especificação do valor da porta do listener é opcional porque o valor é herdado da configuração da porta BOOTSTRAP_ADDRESS.
Tabela 6. Argumentos da Etapa addEndpoints
Argumento Descrição
name_of_endpoint Especifica o nome do terminal do serviço de catálogo.
  • Para servidores de aplicativos existentes: O nome do terminal deve estar no seguinte formato: cell_name\node_name\server_name
  • Para servidores remotos: Especifica o nome do host do servidor remoto. É possível usar o mesmo nome para diversos terminais, mas os valores da porta do listener devem ser exclusivos para cada terminal.
custom_properties Especifica propriedades customizadas para o terminal do domínio do serviço de catálogo. Se não tiver nenhuma propriedade customizada, use um conjunto de aspas duplas ("") para este argumento.
endpoint_ports
Especifica os números de porta para o terminal do domínio do serviço de catálogo. Os terminais devem ser especificados na seguinte ordem: <client_port>,<listener_port>
Porta do Cliente
Especifica a porta que é usada para a comunicação entre os servidores de catálogos no domínio de serviço de catálogo. Este valor é necessário para os servidores de catálogos que estão em execução apenas nos processos do WebSphere Application Server e podem ser configurados para qualquer porta que não está sendo usada em outro lugar.
Porta do Listener
Especifica a porta que é usada para comunicação com clientes. Este valor é necessário para terminais remotos e deve corresponder ao valor usado quando o serviço de catálogo foi iniciado. A porta do listener é usada pelos clientes e contêiners se comunicarem com o serviço de catálogo.
Para obter os terminais remotos do WebSphere eXtreme Scale : Define a porta do listener do Object Request Broker (ORB) para os contêiners e clientes se comunicarem com o serviço de catálogo por meio do ORB. Para terminais do WebSphere Application Server, a especificação do valor da porta do listener é opcional porque o valor é herdado da configuração da porta BOOTSTRAP_ADDRESS.
Tabela 7. Argumentos da Etapa removeEndpoints
Argumento Descrição
name_of_endpoint Especifica o nome do terminal do serviço de catálogo a excluir.
Tabela 8. Argumentos da Etapa configureClientSecurity
Argumento Descrição
-securityEnabled Especifica que a segurança do cliente está ativada para o servidor de catálogos. O arquivo das propriedades de servidor que está associado ao servidor de catálogos selecionado deve ter a configuração securityEnabled correspondente no arquivo de propriedades de servidor. Se essas configurações não corresponderem, uma exceção ocorrerá. (Booleano: configurar para true ou false)
-credentialAuthentication (opcional) Indica se a autenticação da credencial é forçada ou suportada.
Nunca

Nenhuma autenticação por certificado de cliente é forçada.

Requerido
A autenticação de credencial é sempre forçada. Se o servidor não suportar autenticação de credencial, o cliente não poderá se conectar ao servidor.
Suportado
(Padrão) A autenticação de credencial é forçada apenas se o cliente e o servidor suportarem a autenticação de credencial.
-authenticationRetryCount (opcional) Especifica o número de vezes que a autenticação é tentada novamente se a credencial expirar.

Se você não deseja tentar a autenticação novamente, configure o valor para 0. O valor padrão é 0.

-credentialGeneratorClass Indicates the com.ibm.websphere.objectgrid.security.plugins.builtins. Classe de implementação WSTokenCredentialGenerator, para que o cliente recupere os tokens de segurança do encadeamento.
-credentialGeneratorProps Especifica as propriedades para a classe de implementação CredentialGenerator. As propriedades são configuradas para o objeto com o método setProperties(String). O valor da propriedades do gerador de credencial é usado apenas quando um valor for especificado para o campo Classe do Gerador de Credencial.

Valor de retorno:

Uso de exemplo do modo em lote
  • Usando Jacl:
    $AdminTask modifyXSDomain {-name TestDomain -default true -modifyEndpoints 
    {{xhost1.ibm.com "" ,2809}} -addEndpoints {{xhost2.ibm.com "" ,2809}}} 
    -removeEndpoints {{xhost3.ibm.com}}}
  • Usando a cadeia Jython:
    AdminTask.modifyXSDomain('[-name TestDomain  
    -default false -modifyEndpoints [[xhost1.ibm.com "" ,2809]] 
    -addEndpoints [[xhost3.ibm.com "" ,2809]] 
    -removeEndpoints [[xhost2.ibm.com]]]')
  • Usando a especificação de segurança do cliente durante o comando de modificação:
    $AdminTask modifyXSDomain {-name myDomain -default false 
    -configureClientSecurity {-securityEnabled true - 
    Supported -authenticationRetryCount 1 -credentialGeneratorClass 
    com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
     -credentialGeneratorProps "manager manager1"}}
Uso de exemplo do modo interativo
  • Usando Jacl:
    $AdminTask modifyXSDomain {-interactive}
  • Usando a cadeia Jython:
    AdminTask.modifyXSDomain ('[-interactive]')

testXSDomainConnection

O comando testXSDomainConnection testa a conexão com um domínio do serviço de catálogo.

Parâmetros obrigatórios:
-name
Especifica o nome do domínio do serviço de catálogo para o qual testar a conexão.
Parâmetros Opcionais
-timeout
Especifica o período máximo de tempo a aguardar a conexão, em segundos.

Valor de retorno: Se uma conexão puder ser feita, retornará true, caso contrário, serão retornadas informações de erro de conexão.

Uso de exemplo do modo em lote
  • Usando Jacl:
    $Admintask testXSDomainConnection
  • Usando a cadeia Jython:
    AdminTask.testXSDomainConnection
Uso de exemplo do modo interativo
  • Usando Jacl:
    $AdminTask testXSDomainConnection {-interactive}
  • Usando a cadeia Jython:
    AdminTask.testXSDomainConnection ('[-interactive]')

testXSServerConnection

O comando testXSServerConnection testa a conexão com um servidor de catálogos. Este comando funciona para servidores independentes e para servidores que fazem parte de um domínio do serviço de catálogo.

Parâmetros obrigatórios:
host
Especifica o host no qual reside o servidor de catálogos.
listenerPort
Especifica a porta do listener para o servidor de catálogos.
Parâmetros Opcionais
timeout
Especifica o período máximo de tempo a aguardar uma conexão para o servidor de catálogos, em segundos.
domain
Especifica o nome de um domínio do serviço de catálogo. Se você definir um valor para este parâmetro, as propriedades de segurança do cliente para o domínio de serviço de catálogo especificado serão usadas para testar a conexão. Caso contrário, ocorrerá uma procura para localizar o domínio de serviço de catálogo para o host especificado e a porta do listener. Se um domínio de serviço de catálogo for localizado, as propriedades de segurança do cliente que forem definidas para o domínio de serviço de catálogo serão usadas para testar o servidor. Caso contrário, nenhuma propriedade de segurança do cliente será usada durante o teste.

Valor de retorno:

Uso de exemplo do modo em lote
  • Usando Jacl:
    $Admintask testXSServerConnection {-host xhost1.ibm.com -listenerPort 2809}
  • Usando a cadeia Jython:
    AdminTask.testXSServerConnection('[-host xshost3.ibm.com -listenerPort 2809]')
Uso de exemplo do modo interativo
  • Usando Jacl:
    $AdminTask testXSServerConnection {-interactive}
  • Usando a cadeia Jython:
    AdminTask.testXSServerConnection ('[-interactive]')