CSA: Utilità della riga di comando Service e Admin (solo On Premise)

ccppmop1592
Per avviare, interrompere o gestire i servizi al di fuori dell'Amministrazione sistema
Classic PPM
(CSA), utilizzare le utilità della riga di comando. È possibile utilizzare le utilità della riga di comando negli script per automatizzare varie attività di amministrazione del sistema.
3
Comando service
Utilizzare il comando service per gestire i servizi dalla riga di comando. Questo comando utilizza il formato seguente:
service start|stop|status|add|clone|remove|deploy|destroy {all|service name} [-info] [-verbose] [-help]
start
Avvia tutti i servizi o quelli specificati.
Esempi:
service start nsa service start nsa bg
stop
Interrompe tutti i servizi o quelli specificati. È possibile utilizzare questa opzione con l'opzione di avvio per interrompere e riavviare uno o più servizi.
Esempi:
service stop beacon service stop start beacon service stop app bg nsa beacon
status
Visualizza lo stato di tutti i servizi o di quelli specificati.
Esempio
:
service status all
add
Attiva tutti i servizi o quelli specificati su un server locale.
clone
Crea una copia del servizio app o bg sullo stesso server del servizio originale. Le porte, i nomi e altre proprietà del servizio possono essere aumentati per evitare un conflitto.
Esempio
:
service clone app
remove
Disattiva tutti i servizi o quelli specificati su un server locale.
Esempio
:
service remove app bg nsa beacon
deploy
Distribuisce le impostazioni ai server nel cluster.
destroy
Rimuove e distrugge un servizio precedentemente clonato. Non è possibile distruggere il servizio originale.
{all | service name}
Indica se l'attività viene eseguita su tutti i servizi o su uno dei seguenti:
  • app
  • beacon
  • nsa
  • db
  • bg
  • report (non disponibile in
    Classic PPM
    14.4 e versioni successive)
-info
Visualizza i messaggi informativi.
-verbose
Visualizza i messaggi in dettaglio.
-help
Visualizza la guida in linea del comando per tutte o per un'opzione specifica.
Esempio
:
service -help service stop -help
È possibile combinare i comandi. Ad esempio, è possibile utilizzare la combinazione seguente per riavviare i servizi app e bg:
service stop start app bg
I seguenti comandi consentono di arrestare e rimuovere tutti i servizi del singolo server o del server in cluster:
service stop remove all
Comando admin
Utilizzare le utilità della riga di comando
admin
per completare le seguenti attività relative a database, indice e sistema:
  • Preparare il sistema prima e dopo un aggiornamento.
  • Analizzare, esportare e importare database.
  • Leggere i metadati di XDM e generare nuovi file e risorse.
  • Creare un pacchetto dei file di archivio di Amministrazione sistema di
    Clarity
    .
  • Creare e ricreare l'indice di ricerca.
  • Eseguire la migrazione dei documenti dal file system al database.
Questo comando utilizza il formato seguente:
admin xdm|search|package|[-info] [-verbose] [-help]
Opzione
xdm
Elabora l'XDM di
Classic PPM
. Questo comando è disponibile solo su sistemi aggiornati che utilizzano l'XDM prima dell'aggiornamento. Di seguito si riportano le opzioni XDM disponibili:
  • install
    Applica le modifiche di configurazione.
  • validate
    Convalida la configurazione di XDM.
  • gen-glossary
    Genera il file di glossario.
  • apply-glossary
    Applica le modifiche di glossario.
  • force
    Completa l'elaborazione anche in caso di errori. Se questa opzione non è specificata, un errore interrompe l'elaborazione.
  • all
    Applica le modifiche di definizione di XDM.
Opzione
search
Gestisce l'indice. Sono disponibili le seguenti opzioni:
  • migrate
    Esegue la migrazione dei documenti dal file system al database.
  • recreate-index-files
    Ricrea i file nell'archivio file.
  • recreate-index-data
    Ricrea l'indice di tutti i dati relazionali nella raccolta cscoll.
  • index
    Indicizza subito i file e tutti i dati relazionali nelle code.
package {app | bg}
Crea un pacchetto del servizio Applicazione (app) di
Clarity
o Background (bg) di
Clarity
in un file di archivio. Il pacchetto creato viene nominato
app.ear
o
bg.ear
.
Opzione
db
Gestisce gli oggetti di database sul server applicazioni. Di seguito vengono riportate le opzioni disponibili:
  • compile
    Compila tutti gli oggetti di database validi (solo Oracle).
  • analyze
    Analizza lo schema di database (solo Oracle).
  • upgrade
    Aggiorna lo schema del database dalla versione 13.0 o successiva alla release corrente.
  • compare -Dreport.file= percorso file report
    Confronta il database con lo schema XML specificato (solo Oracle). Il file predefinito è installdir/logs/compare-report.txt.
  • compare-any params
    Confronta il database con un altro schema XML. Per informazioni dettagliate sui parametri richiesti, visualizzare la guida in linea della riga di comando (admin db compare-any -help).
  • post-install
    Esegue tutte le procedure successive all'installazione del database.
backup
Quando viene richiesto, indicare la directory di destinazione per il file di backup.
general
option
Gestisce i file di configurazione e la proprietà di file. Di seguito vengono riportate le opzioni disponibili:
  • view-config
    Visualizza la versione del file di configurazione compreso nel database.
  • upload-all-config
    Carica tutti i file di configurazione necessari nel database. I file includono properties.xml, tenants.xml, hosts.xml, logger.xml e components.xml.
  • upload-config
    Carica il file properties.xml nel database.
  • upload-config -Dfile=<config filename>
    Carica il file di configurazione nel database. Ad esempio, logger.xml.
  • download-config
    Scarica il file properties.xml dal database.
  • download-config -Dfile=<config filename>
    Scarica il file di configurazione dal database. Ad esempio, hosts.xml.
  • apply-ownership
    Applica l'utente e il proprietario di gruppo corretti a tutti i file nella directory specificata (solo Unix).
Opzione
system-options
Le seguenti opzioni di comando, disponibili nelle release 15.3.0.5, 15.4.1.1, 15.5 e successive, consentono di aggiungere o eliminare valori e opzioni di sistema:
admin system-options -add <option code> <option value>
-add
Aggiunge una nuova voce opzione di sistema e il rispettivo valore.
-multi
Aggiunge più valori di opzione per un'unica nuova voce dell'opzione di sistema.
-force
Elimina e ricrea la voce opzione e il suo valore. Il flag -force non è compatibile con -multi.
-list
Elenca i valori di opzione.
-delete
Elimina una voce e un valore di opzione di sistema utilizzando la seguente sintassi:
-delete<option code> <option value>
Esempio 1
: il seguente comando aggiunge un nuovo valore di opzione
ca.com
per l'impostazione
CONTENT_SECURITY_DOMAINS
nella tabella
cmn_option_values
:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
Esempio 2
: il primo comando elimina tutti i domini correnti e i dati seed, quindi le righe restanti aggiungono tutti i domini specificati:
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
Esempio 3
: il seguente comando aggiunge un nuovo valore di opzione per l'impostazione
CONTENT_SECURITY_DOMAINS
nella tabella
cmn_option_values
:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
Esempio 4
: il seguente comando elenca i valori di opzione per l'impostazione
CONTENT_SECURITY_DOMAINS
nella tabella
cmn_option_values
:
admin system-options -list CONTENT_SECURITY_DOMAINS
Dopo aver emesso i comandi, aggiornare o svuotare tutte le cache, in particolare systemOptions e securityDomains.
Abilitazione dei comandi system-option per CORS
Le informazioni riportate di seguito sono valide solo per 15.3.0.5, 15.4.1.1, 15.5 e 15.5.1. Se si dispone di
Clarity
15.6 (o versioni successive), CORS è supportato, pertanto questa sezione non è più valida. Consultare le API REST nella sezione Riferimenti dell'edizione in lingua inglese della documentazione.
Il comando admin system-options consente il CORS per l'API REST (non ancora supportato, disponibile esclusivamente per le integrazioni dei partner di Broadcom Services). Le altre applicazioni possono poi effettuare chiamate API dirette in
Clarity
. Ad esempio, CA Agile Central può leggere i dati di progetto di
Clarity
.
Queste opzioni non sono abilitate per impostazione predefinita.
  • Se si prevede di utilizzare la nuova funzionalità del canale blueprint, tenere presente che
    Clarity
    dispone di una funzionalità integrata che consente di inserire i domini precedentemente definiti nel canale come elementi consentiti. L'inserimento nella white list consente a
    Clarity
    di visualizzare le applicazioni esterne nel framework di
    Clarity
    , purché l'applicazione non presenti restrizioni CORS integrate.
    Clarity
    non può infatti sovrascrivere un criterio di protezione esterno.
  • Se dei contenuti esistenti puntano ad altri domini, è possibile implementare uno o più canali sostitutivi. Se si desidera continuare a utilizzare portlet HTML e altri collegamenti ad applicazioni di terze parti e non si utilizzano canali Nuova esperienza utente, abilitare il CORS con il seguente comando di aggiornamento del database per le opzioni di 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
;