CSA: Dienst- und Admin-Befehlszeilendienstprogramme (nur On-Premise)

ccppmop1591
Verwenden Sie Befehlszeilendienstprogramme, um Dienste außerhalb der
Classic PPM
-Systemverwaltung (CSA) zu starten, anzuhalten oder zu verwalten. Sie können Befehlszeilendienstprogramme in Skripten verwenden, um eine Reihe von Systemverwaltungsaufgaben zu automatisieren.
3
Service-Befehl
Verwenden Sie den Befehl "service", um Dienste über die Befehlszeile zu verwalten. Dieser Befehl hat das folgende Format:
service start|stop|status|add|clone|remove|deploy|destroy {all|service name} [-info] [-verbose] [-help]
start
Startet alle oder angegebene Dienste.
Beispiele:
service start nsa service start nsa bg
stop
Beendet alle oder angegebene Dienste. Sie können diese Option gemeinsam mit der Option "start" verwenden, um einen oder mehrere Dienste anzuhalten und wieder neu zu starten.
Beispiele:
service stop beacon service stop start beacon service stop app bg nsa beacon
status
Zeigt den Status aller oder angegebener Dienste an.
Beispiel
:
service status all
add
Aktiviert alle oder angegebene Dienste auf einem lokalen Server.
clone
Erstellt eine Kopie des Diensts "app" oder "bg" auf demselben Server wie das Original. Ports, Dienstnamen und andere Eigenschaften des Diensts können mit inkrementellen Ziffern versehen werden, um Konflikte zu vermeiden.
Beispiel
:
service clone app
remove
Deaktiviert alle oder angegebene Dienste auf einem lokalen Server.
Beispiel
:
service remove app bg nsa beacon
deploy
Verteilt die Einstellungen an Server im Cluster.
destroy
Entfernt und löscht einen zuvor geklonten Dienst. Die Originaldienste können nicht gelöscht werden.
{all | Dienstname}
Gibt an, ob die Aufgabe für alle Dienste oder für einen der folgenden Dienste ausgeführt wird:
  • app
  • beacon
  • nsa
  • db
  • bg
  • reports (nicht verfügbar in
    Classic PPM
    14.4 und höheren Versionen)
-info
Zeigt Informationsmeldungen an.
-verbose
Zeigt ausführliche Meldungen an.
-help
Zeigt die Hilfe zu einem Befehl für alle Optionen oder eine angegebene Option an.
Beispiel
:
service -help service stop -help
Befehle können miteinander kombiniert werden. Mithilfe der folgenden Kombination können Sie z. B. die Anwendungs- und Hintergrunddienste neu starten:
service stop start app bg
Die folgenden Befehle stoppen und entfernen alle Dienste auf dem aktuellen Einzelserver oder Cluster-Server:
service stop remove all
Admin-Befehl
Verwenden Sie die Befehlszeilendienstprogramme
admin
, um folgende Datenbank-, Index- und Systemaufgaben auszuführen:
  • Vorbereiten des Systems vor und nach einem Upgrade.
  • Analysieren, Exportieren und Importieren von Datenbanken.
  • Lesen der XDM-Metadaten und Generieren von neuen Dateien und Ressourcen.
  • Packen von Archivdateien der
    Clarity
    -Systemverwaltung.
  • Erstellen und Neuerstellen des Suchindexes.
  • Migrieren von Dokumenten aus dem Dateisystem in die Datenbank.
Dieser Befehl hat das folgende Format:
admin xdm|search|package|[-info] [-verbose] [-help]
xdm
option
Verarbeitet
Classic PPM
-XDM. Dieser Befehl ist nur für aktualisierte Systeme verfügbar, auf denen vor dem Upgrade XDM verwendet wurde. Verfügbare XDM-Optionen:
  • install
    Übernimmt Konfigurationsänderungen.
  • validate
    Bestätigt die XDM-Konfiguration.
  • gen-glossary
    Generiert die Glossardatei.
  • apply-glossary
    Übernimmt Glossaränderungen.
  • force
    Stellt den Prozess fertig, auch wenn Fehler aufgetreten sind. Wenn diese Option nicht angegeben ist, wird die Verarbeitung bei Fehlern angehalten.
  • all
    Übernimmt XDM-Definitionsänderungen.
search
option
Verwaltet den Index. Die folgenden Optionen stehen zur Verfügung:
  • migrate
    Migriert die Dokumente aus dem Dateisystem in die Datenbank.
  • recreate-index-files
    Erstellt die Dateien im Dateispeicher neu.
  • recreate-index-data
    Erstellt den Index für alle relationalen Daten in der cscoll-Sammlung neu.
  • index
    Indiziert Dateien und alle relationalen Daten in den Warteschlangen unmittelbar.
package {app | bg}
Packt den
Clarity
-Anwendungsdienst (app) oder den
Clarity
-Hintergrunddienst (bg) in eine Archivdatei. Das resultierende Paket wird
app.ear
oder
bg.ear
genannt.
db
option
Verwaltet Datenbankobjekte auf dem Anwendungsserver. Verfügbare Optionen:
  • compile
    Kompiliert alle gültigen Datenbankobjekte (nur Oracle).
  • analyze
    Analysiert das Datenbankschema (nur Oracle).
  • upgrade
    Aktualisiert das Datenbankschema von Version 13.0 oder höher auf das aktuelle Release.
  • compare -Dreport.file= report file path
    Vergleicht die Datenbank mit dem angegebenen XML-Schema (nur Oracle). Die Standarddatei ist installdir/logs/compare-report.txt.
  • compare-any params
    Vergleicht die Datenbank mit einem anderen XML-Schema. Ausführliche Informationen zu den erforderlichen Parametern finden Sie in der Befehlszeilenhilfe (aufrufbar über "admin db compare-any -help").
  • post-install
    Führt die Datenbankprozeduren nach der Installation aus.
backup
Wenn Sie dazu aufgefordert werden, geben Sie das Zielverzeichnis für die Sicherungsdatei an.
general-
Option
Verwaltet die Konfigurationsdateien und Eigentumsrechte von Dateien. Verfügbare Optionen:
  • view-config
    Zeigt die Version der Konfigurationsdatei in der Datenbank an.
  • upload-all-config
    Lädt alle erforderlichen Konfigurationsdateien in die Datenbank hoch. Die Dateien umfassen "properties.xml", "tenants.xml", "hosts.xml", "logger.xml" und "components.xml".
  • upload-config
    Lädt die Datei "properties.xml" in die Datenbank.
  • upload-config -Dfile=<config filename>
    Lädt die Konfigurationsdatei in die Datenbank. Zum Beispiel "logger.xml".
  • download-config
    Lädt die Datei "properties.xml" aus der Datenbank.
  • download-config -Dfile=<config filename>
    Lädt die Konfigurationsdatei aus der Datenbank. Zum Beispiel "hosts.xml".
  • apply-ownership
    Übernimmt den richtigen Benutzer und Gruppenbesitzer in allen Dateien im angegebenen Verzeichnis (nur Unix).
system-options
option
Mit den folgenden, in 15.3.0.5, 15.4.1.1, 15.5 und neueren Versionen verfügbaren Befehlsoptionen können Sie Systemoptionen und -werte hinzufügen oder löschen:
admin system-options -add <option code> <option value>
-add
Fügt einen neuen Systemoptionseintrag und -wert hinzu.
-multi
Fügt mehrere Optionswerte für einen einzelnen neuen Systemoptionseintrag hinzu.
-force
Löscht den Optionseintrag und -wert und erstellt diese neu. Das Flag -force funktioniert mit -multi nicht.
-list
Listet die Optionswerte auf.
-delete
Löscht einen Optionseintrag und -wert des Systems mithilfe der folgenden Syntax:
-delete <option code> <option value>
Beispiel 1
: Mit dem folgenden Befehl wird ein neuer
ca.com
-Optionswert für die Einstellung
CONTENT_SECURITY_DOMAINS
in der Tabelle
cmn_option_values
hinzugefügt:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
Beispiel 2
: Mit dem ersten Befehl werden alle aktuellen Domänen und Seed-Daten gelöscht, und die restlichen Zeilen fügen alle angegebenen Domänen hinzu:
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
Beispiel 3
: Mit dem folgenden Befehl wird ein neuer -Optionswert für die Einstellung
CONTENT_SECURITY_DOMAINS
in der Tabelle
cmn_option_values
hinzugefügt:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
Beispiel 4
: Mit dem folgenden Befehl werden Optionswerte für die Einstellung
CONTENT_SECURITY_DOMAINS
in der Tabelle
cmn_option_values
aufgelistet:
admin system-options -list CONTENT_SECURITY_DOMAINS
Aktualisieren oder leeren Sie nach dem Ausgeben der Befehle alle Caches, insbesondere systemOptions und securityDomains.
Die System-Option-Befehle für CORS aktivieren
Die folgenden Informationen gelten nur für 15.3.0.5, 15.4.1.1, 15.5 oder 15.5.1. Wenn Sie
Clarity
15.6 oder höher haben, wird CORS unterstützt, und dieser Abschnitt ist nicht mehr gültig. Weitere Informationen finden Sie in REST API der englischen Version der Dokumentation unter dem Abschnitt Reference.
Mit dem Befehl "admin system-options" wird CORS für die REST-API aktiviert (noch nicht unterstützt, ausschließlich für Integrationen von Broadcom-Servicepartnern verfügbar). Andere Anwendungen können dann direkte API-Aufrufe in
Clarity
ausführen. CA Agile Central kann z. B. Projektdaten von
Clarity
lesen.
Diese Optionen werden nicht standardmäßig aktiviert.
  • Wenn Sie vorhaben, die neue Blueprint-Kanal-Funktion zu verwenden, verfügt
    Clarity
    über eine integrierte Funktion, um eine Domäne auf die Whitelist zu setzen, nachdem Sie sie im Kanal definiert haben. Durch Whitelisting kann
    Clarity
    externe Anwendungen im
    Clarity
    -Framework anzeigen, vorausgesetzt, die andere Anwendung hat keine integrierten CORS-Einschränkungen, da
    Clarity
    keine externe Sicherheitsrichtlinie überschreiben kann.
  • Wenn Sie vorhandene Inhalte haben, die auf andere Domänen verweisen, können Sie als Ersatz einen oder mehrere Kanäle implementieren. Wenn Sie weiter HTML-Portlets und andere Verknüpfungen zu Anwendungen von Drittanbietern verwenden möchten und Sie keine Kanäle in der neuen Benutzererfahrung verwenden, aktivieren Sie CORS mit dem folgenden Befehl zur Datenbankaktualisierung für Systemoptionen:
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
;