CSA : utilitaires de ligne de commande de service et d'administration (Sur site uniquement)

ccppmop1593
Les utilitaires de ligne de commande permettent de démarrer, d'arrêter ou de gérer les services en dehors de l'outil d'administration système (CSA) de
PPM classique
. Vous pouvez utiliser les utilitaires de ligne de commande dans les scripts pour automatiser diverses tâches d'administration du système.
 
3
 
 
Commande de service
Utilisez la commande de service pour gérer les services à partir de la ligne de commande. Cette commande présente le format suivant :
service start|stop|status|add|clone|remove|deploy|destroy {all|service name} [-info] [-verbose] [-help]
start
Démarre tous les services ou les services spécifiés.
Exemples :
service start nsa service start nsa bg
stop
Arrête tous les services ou les services spécifiés. Vous pouvez utiliser cette option conjointement à l'option start pour arrêter, puis redémarrer un ou plusieurs services.
Exemples :
service stop beacon service stop start beacon service stop app bg nsa beacon
status
Affiche le statut de tous les services ou des services spécifiés.
Exemple
:
service status all
add
Active tous les services ou les services spécifiés sur un serveur local.
clone
Crée une copie du service app ou bg sur le même serveur que le service d'origine. Les ports, les noms de service et les autres propriétés du service peuvent être incrémentés afin d'éviter tout conflit.
Exemple
:
service clone app
remove
Désactive tous les services ou les services spécifiés sur un serveur local.
Exemple
:
service remove app bg nsa beacon
deploy
Applique les paramètres aux serveurs inclus dans le cluster.
destroy
Supprime et détruit un service préalablement cloné. Vous ne pouvez pas détruire le service d'origine.
{all | service name}
Indique si la tâche est effectuée sur tous les services ou sur l'un service suivant :
  • app
  • balise
  • nsa
  • bdd
  • bg
  • rapports (non disponibles dans les versions 14.4 de
    PPM classique
    et versions ultérieures)
-info
Affiche les messages d'information.
-verbose
Affiche les messages détaillés.
-help
Affiche l'Aide de commande pour toutes les options ou pour une option spécifiée.
Exemple :
service -help service stop -help
Vous pouvez combiner plusieurs commandes. Par exemple, vous pouvez utiliser la combinaison suivante pour redémarrer les services d'application et de bg :
service stop start app bg
Les commandes suivantes arrête et suppriment tous les services sur le serveur actuel unique ou mis en cluster :
service stop remove all
Commande d'administration
Utilisez les utilitaires de ligne de commande
admin
pour effectuer les tâches de base de données, d'index et de système suivantes :
  • Préparer le système avant et après une mise à niveau.
  • Analyser, exporter et importer des bases de données.
  • Lire des métadonnées XDM et générer des nouveaux fichiers et ressources.
  • Mettre en package les fichiers d'archive de l'outil d'administration système de
    Clarity
  • Créer et recréer l'index de recherche.
  • Migrer les documents du système de fichiers à la base de données.
Cette commande présente le format suivant :
admin xdm|search|package|[-info] [-verbose] [-help]
xdm
option
Traite l'outil XDM
PPM classique
. Cette commande est disponible uniquement sur les systèmes mis à niveau qui utilisaient l'outil XDM avant la mise à niveau. Les options XDM ci-dessous sont disponibles :
  • install
    Applique les changements de configuration.
  • validate
    Valide la configuration XDM.
  • gen-glossary
    Génère le fichier de glossaire.
  • apply-glossary
    Applique les modifications de glossaire.
  • force
    Termine le traitement même si des erreurs sont rencontrées. Si vous ne spécifiez pas cette option, une erreur arrête le traitement.
  • all
    Applique les modifications de définition de XDM.
search
option
Gère l'index. Les options suivantes sont disponibles :
  • migrate
    Migre les documents du système de fichiers à la base de données.
  • recreate-index-files
    Recrée les fichiers dans le magasin de fichiers.
  • recreate-index-data
    Recrée l'index pour toutes les données relationnelles dans la collection cscoll.
  • index
    Indexe immédiatement les fichiers et toutes les données relationnelles dans les files d'attente.
package {app | bg}
Met en package le service d'application (app)
Clarity
ou le service d'arrière-plan (bg)
Clarity
dans un fichier d'archive. Le package généré est nommé
app.ear
ou
bg.ear
.
db
option
Gère les objets de base de données sur le serveur d'applications. Les options ci-dessous sont disponibles :
  • compile
    Collecte tous les objets de base de données valides (Oracle uniquement).
  • analyze
    Analyse le schéma de la base de données (Oracle uniquement).
  • upgrade
    Met à niveau le schéma de la base de données de la version 13.0 ou ultérieure à la version actuelle.
  • compare -Dreport.file= report file path
    Compare la base de données au schéma XML spécifié (Oracle uniquement). Le fichier par défaut est installdir/logs/compare-report.txt
  • compare-any params
    Compare la base de données à un autre schéma XML. Pour des informations détaillées concernant les paramètres obligatoires, affichez l'Aide de la ligne de commande (admin db compare-any -help).
  • post-install
    Effectue les procédures de post-installation de la base de données.
backup
Lorsque vous y êtes invité, spécifiez le répertoire cible du fichier de sauvegarde.
general
option
Gère les fichiers de configuration et l'appartenance des fichiers. Les options ci-dessous sont disponibles :
  • view-config
    Affiche la version du fichier de configuration qui se trouve dans la base de données.
  • upload-all-config
    Charge tous les fichiers de configuration requis sur la base de données. notamment, les fichiers properties.xml, tenants.xml, hosts.xml, logger.xml et components.xml.
  • upload-config
    Télécharge le fichier properties.xml dans la base de données.
  • upload-config -Dfile=<config filename>
    Télécharge le fichier de configuration dans la base de données. Par exemple, logger.xml.
  • download-config
    Charge le fichier properties.xml à partir de la base de données.
  • download-config -Dfile=<config filename>
    Charge le fichier de configuration à partir de la base de données. Par exemple, hosts.xml.
  • apply-ownership
    Applique le bon utilisateur et le propriétaire du groupe à tous les fichiers dans le répertoire spécifié (Unix uniquement).
system-options 
 
option
 
 
Les options de commandes suivantes, disponibles dans les versions 15.3.0.5, 15.4.1.1, 15.5 et ultérieures, vous permettent d'ajouter ou de supprimer des valeurs et des options système :
admin system-options -add <option code> <option value>
-add
Ajoute une entrée et une valeur d'option système.
-multi
: ajoute plusieurs valeurs d'option pour une seule nouvelle entrée d'option système.
 
-force
Supprime et recrée l'entrée et la valeur de l'option. L'indicateur -force ne fonctionne pas avec l'option -multi.
-list
Répertorie les valeurs de l'option. 
-delete
Supprime une entrée et une valeur d'option système à l'aide de la syntaxe suivante :
-delete<option code> <option value>
Exemple 1
: La commande suivante ajoute une valeur d'option
ca.com
pour le paramètre
CONTENT_SECURITY_DOMAINS
dans la table
cmn_option_values
:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
 
 
Exemple 2
: la première commande supprime tous les domaines actuels et les données initiales, puis les lignes restantes ajoutent tous les domaines donnés :
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
Exemple 3
: La commande suivante ajoute une valeur d'option pour le paramètre
CONTENT_SECURITY_DOMAINS
dans la table
cmn_option_values
:
admin system-options -add CONTENT_SECURITY_DOMAINS ca.com -multi
Exemple 4
: La commande suivante répertorie les valeurs d'option pour le paramètre
CONTENT_SECURITY_DOMAINS
dans la table
cmn_option_values
:
admin system-options -list CONTENT_SECURITY_DOMAINS
 
Une fois les commandes émises, actualisez ou videz tous les caches, notamment systemOptions et securityDomains.
Activation des commandes system-options pour CORS
Les informations suivantes s'appliquent uniquement aux versions 15.3.0.5, 15.4.1.1, 15.5 et 15.5.1. Si vous disposez de
Clarity
15.6 ou version ultérieure, CORS est pris en charge et cette section ne s'applique plus. Reportez-vous à la section REST API de la version anglaise de cette documentation.
La commande oadmin system-options autorise le mécanisme CORS pour l'API REST (pas encore pris en charge, disponible uniquement pour les intégrations partenaire de Broadcom Service). D'autres applications peuvent alors effectuer des appels d'API directs dans
Clarity
. Par exemple, CA Agile Central peut lire les données de projet
Clarity
Ces options ne sont pas activées par défaut.
  • Si vous prévoyez d'utiliser la nouvelle fonctionnalité de canal de plan,
    Clarity
    intègre la capacité d'ajouter un domaine à la liste blanche une fois défini dans le canal. La définition d'une liste blanche permet à
    Clarity
    d'afficher des applications externes dans la structure
    Clarity
    , pour autant que l'autre application ne présente pas de restrictions CORS intégrées étant donné que
    Clarity
    ne peut pas écraser une stratégie de sécurité externe.
  • Si vous avez du contenu existant qui pointe vers d'autres domaines, vous pouvez implémenter un ou plusieurs canaux en remplacement. Si vous souhaitez continuer à utiliser les portlets HTML et autres liens vers des applications tierces et que vous n'utilisez pas de canaux dans la nouvelle expérience utilisateur, activez CORS avec la commande de mise à jour de base de données suivantes pour les options système :
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
;