CSA: utilitários de linha de comando Service e Admin (somente local)

ccppmop1593
Para iniciar, interromper ou gerenciar serviços fora da Administração do sistema do
Classic PPM
(CSA), use os utilitários de linha de comando. Você pode usar utilitários de linha de comando em scripts para automatizar uma série de tarefas de administração do sistema.
 
 
3
 
 
Comando Service
Use o comando de serviço para gerenciar serviços pela linha de comando. Esse comando tem o seguinte formato:
service start|stop|status|add|clone|remove|deploy|destroy {all|service name} [-info] [-verbose] [-help]
start
Inicia todos os serviços ou os serviços especificados.
Exemplos:
service start nsa service start nsa bg
stop
Interrompe todos os serviços ou os serviços especificados. Você pode usar essa opção junto com a opção start para interromper e reiniciar um ou mais serviços.
Exemplos:
service stop beacon service stop start beacon service stop app bg nsa beacon
status
Exibe o status de todos os serviços ou dos serviços especificados.
Exemplo
:
service status all
add
Ativa todos os serviços ou os serviços especificados em um servidor local.
clone
Cria uma cópia do serviço app ou bg no mesmo servidor que o original. Portas, nomes de serviço e outras propriedades do serviço podem ser incrementados para evitar conflitos.
Exemplo
:
service clone app
remove
Desativa todos os serviços ou os serviços especificados em um servidor local.
Exemplo
:
service remove app bg nsa beacon
deploy
Distribui as configurações para servidores do agrupamento.
destroy
Remove e destrói um serviço anteriormente clonado. O serviço original não pode ser destruído.
{all | nome do serviço}
Indica se a tarefa é executada em todos os serviços ou em dos seguintes serviços:
  • app
  • beacon
  • nsa
  • db
  • bg
  • reports (indisponível no
    Classic PPM
    releases 14.4 e superior)
-info
Exibe mensagens informativas.
-verbose
Exibe mensagens detalhadas.
-help
Exibe a Ajuda de comandos de todas as opções ou de uma opção específica.
Exemplo
:
service -help service stop -help
É possível combinar os comandos. Por exemplo, a seguinte combinação pode ser usada para reiniciar os serviços de aplicativo e de segundo plano:
service stop start app bg
Os seguintes comandos interrompem e removem todos os serviços do servidor atual único ou agrupado:
service stop remove all
Comando Admin
Use os utilitários de linha de comando
admin
para executar as seguintes tarefas de banco de dados, índice e sistema:
  • Preparar o sistema antes e depois de uma atualização.
  • Analisar, exportar e importar bancos de dados.
  • Ler metadados XDM e gerar novos arquivos e recursos.
  • Compactar arquivos da Administração do Sistema do
    Clarity
    .
  • Criar e recriar o índice de pesquisa.
  • Migrar documentos do sistema de arquivos para o banco de dados.
Esse comando tem o seguinte formato:
admin xdm|search|package|[-info] [-verbose] [-help]
xdm
opção
Processa o XDM do
Classic PPM
. Esse comando está disponível apenas em sistemas atualizados que usam o XDM antes da atualização. Aqui estão as opções de XDM disponíveis:
  • install
    Aplica alterações de configuração.
  • validate
    Valida a configuração de XDM.
  • gen-glossary
    Gera o arquivo de glossário.
  • apply-glossary
    Aplica alterações no glossário.
  • force
    Conclui o processamento mesmo quando são encontrados erros. Se essa opção não for especificada, um erro interrompe o processamento.
  • all
    Aplica alterações na definição de XDM.
search
opção
Gerencia o índice. As seguintes opções estão disponíveis:
  • migrate
    Migra documentos do sistema de arquivos para o banco de dados.
  • recreate-index-files
    Recria arquivos no repositório de arquivos.
  • recreate-index-data
    Recria o índice de todos os dados relacionais da coleção cscoll.
  • index
    Indexa imediatamente os arquivos e todos os dados relacionais nas filas.
package {app | bg}
Compacta o serviço Aplicativo do
Clarity
(app) ou Segundo plano do
Clarity
(bg) em um arquivo de dados. O pacote gerado é denominado
app.ear
ou
bg.ear
.
db
opção
Gerencia os objetos do banco de dados no servidor de aplicativos. Aqui estão as opções disponíveis:
  • compile
    Compila todos os objetos de banco de dados válidos (somente Oracle).
  • analyze
    Analisa o esquema de banco de dados (somente Oracle).
  • upgrade
    Atualiza o esquema de banco de dados da versão 13.0 ou superior para a release atual.
  • compare -Dreport.file= caminho do arquivo de relatório
    Compara o banco de dados com o esquema XML especificado (somente Oracle). O arquivo padrão é installdir/logs/compare-report.txt.
  • compare-any parâmetros
    Compara o banco de dados com outro esquema XML. Para obter informações detalhadas sobre os parâmetros necessários, exiba a linha de comando Help (admin db compare-any -help).
  • post-install
    Executa os procedimentos pós-instalação do banco de dados.
backup
Quando solicitado, forneça o diretório de destino para o arquivo de backup.
opção
general
Gerencia arquivos de configuração e a propriedade de arquivos. Aqui estão as opções disponíveis:
  • view-config
    Exibe a versão do arquivo de configuração que está no banco de dados.
  • upload-all-config
    Faz upload de todos os arquivos de configuração necessários para o banco de dados. Os arquivos incluem properties.xml, tenants.xml, hosts.xml, logger.xml e components.xml.
  • upload-config
    Carrega o arquivo properties.xml para o banco de dados.
  • upload-config -Dfile=<nome do arquivo de configuração>
    Faz upload do arquivo de configuração para o banco de dados. Por exemplo, logger.xml.
  • download-config
    Faz download do arquivo properties.xml a partir do banco de dados.
  • download-config -Dfile=<nome do arquivo de configuração>
    Faz download do arquivo de configuração do banco de dados. Por exemplo, hosts.xml.
  • apply-ownership
    Aplica o proprietário correto de grupo e usuário a todos os arquivos existentes no diretório especificado (somente Unix).
 
opção
 
 system-options 
As seguintes opções de comando, disponíveis nas releases 15.3.0.5, 15.4.1.1, 15.5 e nas releases mais recentes, permitem adicionar ou excluir opções e valores de sistema:
admin system-options -add <option code> <option value>
-add
Adiciona uma nova entrada e um novo valor de opção de sistema.
-multi
Adiciona vários valores de opção para uma única entrada da nova opção de sistema.
 
-force
Exclui e recria a entrada e o valor da opção. O indicador -force não funciona com -multi.
-list
Lista os valores de opção. 
-delete
Exclui uma entrada e um valor de opção do sistema usando a seguinte sintaxe:
-delete<option code> <option value>
Exemplo 1
: o comando a seguir adiciona um novo valor de opção
ca.com
para a configuração
CONTENT_SECURITY_DOMAINS
na tabela
cmn_option_values
:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
 
 
Exemplo 2
: o primeiro comando exclui todos os domínios e dados de propagação atuais e, em seguida, as linhas restantes adicionam todos os domínios determinados:
admin system-options -delete CONTENT_SECURITY_DOMAINS
admin system-options -add CONTENT_SECURITY_DOMAINS "'self'" -multi admin system-options -add CONTENT_SECURITY_DOMAINS cppmxxxx.ca.com -multi admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi admin system-options -add CONTENT_SECURITY_DOMAINS docops.ca.com -multi admin system-options -add CONTENT_SECURITY_DOMAINS fonts.googleapis.com -multi
Exemplo 3
: o comando a seguir adiciona um novo valor de opção para a configuração
CONTENT_SECURITY_DOMAINS
na tabela
cmn_option_values
:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
Exemplo 4
: o comando a seguir lista valores de opção para a configuração
CONTENT_SECURITY_DOMAINS
na tabela
cmn_option_values
:
admin system-options -list CONTENT_SECURITY_DOMAINS
 
Após emitir os comandos, atualize ou descarregue todos os caches, especialmente systemOptions e securityDomains.
Ativar os comandos System-Option para CORS
As informações a seguir aplicam-se somente a 15.3.0.5, 15.4.1.1, 15.5 ou 15.5.1. Se você tiver o
Clarity
15.6 ou superior, o CORS será suportado e esta seção não se aplicará mais. Consulte a API REST na seção Referência da documentação da edição em inglês.
O comando admin system-options permite CORS para a API REST (ainda não suportado, disponível exclusivamente para as integrações feitas pelos parceiros de serviços da Broadcom). Outros aplicativos podem fazer chamadas de API diretas para o
Clarity
. Por exemplo, o CA Agile Central pode ler os dados de projeto do
Clarity
Por padrão, essas opções não são ativadas.
  • Caso você esteja planejando usar o novo recurso canal de blueprint, o
    Clarity
    tem um recurso integrado para colocar um domínio na lista branca assim que ele for definido no canal. A inclusão na lista branca permite que o
    Clarity
    exiba aplicativos externos na estrutura do
    Clarity
    , contanto que o outro aplicativo não tenha restrições de CORS integradas, uma vez que o
    Clarity
    não pode substituir uma política de segurança externa.
  • Se o conteúdo existente estiver apontando para outros domínios, você poderá implementar um ou mais canais como uma substituição. Se você desejar continuar usando os portlets HTML e outros links para aplicativos de terceiros e não usar canais na Nova experiência do usuário, ative CORS com o seguinte comando de atualização do banco de dados para as opções do sistema:
DECLARE
option_exists
INTEGER
; FEATURE_EXISTS
INTEGER
;
BEGIN
cmn_feature_delete_sp('CORS_ENABLEMENT_F18624'); cmn_feature_ins_sp('CORS_ENABLEMENT_F18624', 'CORS Enablement', 'This is the toggle for the CORS Enablement feature for rest api', 1);
END
;