S-Filer Config CLI : Guide d'utilisation
Note
Le S-Filer Config CLI est un utilitaire en ligne de commande qui permet aux administrateurs de gérer les paramètres de configuration de la solution S-Filer Portal.
Concepts
L'application nécessite une authentification pour accéder à ses fonctions. Une fois authentifiés, les utilisateurs peuvent créer, modifier ou supprimer les différents paramètres de configuration de l'application.
L'application fonctionne sur les systèmes d'exploitation Windows et Linux. Il suffit d'ouvrir une console de commande et d'exécuter les commandes nécessaires. Vous pouvez utiliser le paramètre --help pour obtenir de l'aide sur les commandes disponibles.
Chaque commande est composée de plusieurs options, dont certaines sont utilisées par toutes les commandes.
Les options générales sont :
Options | Obligatoire / Facultatif | Description |
---|---|---|
-l | Facultatif | Nom d'utilisateur à utiliser pour exécuter la commande. |
-p | Facultatif | Le mot de passe pour l'authentification. |
-op | Facultatif | Le mot de passe obscurci (caché) pour l'authentification. |
-cf | Facultatif | Le fichier de configuration contenant l'URL de la base de données, le pilote et le dialecte hibernate. Il peut être remplacé par la propriété système "sfiler.config.cli.config.file". |
--dbUrl | Facultatif | URL de la base de données à utiliser pour se connecter à la base de données. |
--dbDriver | Facultatif | Le pilote de base de données à utiliser pour se connecter à la base de données. |
--dbHibernateDialect | Facultatif | Le dialecte hibernate à utiliser pour se connecter à la base de données. |
-x | Facultatif | Un fichier script contenant des commandes à exécuter. Chaque ligne doit correspondre exactement à la ligne de commande, à l'exception des options globales qui ne doivent pas être spécifiées. |
-xc | Facultatif | S'il est présent, l'exécution du script se poursuivra en cas d'erreur. |
Obtenir de l'aide pour une commande spécifique
Il est possible d'obtenir une liste de paramètres pour une commande spécifique. Il suffit d'utiliser l'option « --help » pour obtenir une aide spécifique. Par exemple, pour la commande « set-config » :
./sfiler-config-cli.sh --help set-config
Set Configuration
Usage: set-config [options]
Options:
-encrypt
This config value is to be encrypted before storing in the database.
Default: false
-id
Instance Id. (Optional if the instance Name is specify)
* -k
Key.
-n
Instance Name. (Optional if the instance Id is specify)
* -t
Type 1:server 3:Gateway 4:Gui.
Default: 0
* -v
New Value.
Les pilotes de la base de données
L'application S-Filer Portal supporte les pilotes de base de données suivants :
- Oracle :
oracle.jdbc.OracleDriver
- SQL Server :
com.microsoft.sqlserver.jdbc.SQLServerDriver
- MySQL :
com.mysql.cj.jdbc.Driver
- MariaDB :
org.mariadb.jdbc.Driver
Les dialectes Hibernate
L'application S-Filer Portal supporte les dialectes Hibernate suivants :
- Oracle :
org.hibernate.dialect.Oracle10cDialect
- SQL Server :
org.hibernate.dialect.SQLServer2012Dialect
- MySQL :
org.hibernate.dialect.MySQL5Dialect
- MariaDB :
org.hibernate.dialect.MySQL5InnoDBDialect
Commandes
Le S-Filer Config CLI supporte commandes suivantes :
- add-admin-user
- add-amazon-s3-storage
- add-auth-domain
- add-azure-blob-storage
- add-gateway
- add-gui
- add-local-storage
- add-server
- delete-certificate
- delete-gateway
- delete-gui
- delete-storage
- export-config
- export-server-config
- generate-key-pair
- generate-ssh-key
- import-certificate-file
- import-crypto
- list-auth-configs
- list-auth-domains
- list-certificates`
- list-components
- list-configs
- list-storages
- migrate-database
- migrate-system-certificate
- modify-amazon-s3-storage
- modify-azure-blob-storage
- modify-local-storage
- renew-key
- set-auth-config
- set-auth-domain
- set-config
- set-default-storage
- test-access-amazon-s3-storage
- test-access-azure-blob-storage
- test-access-local-storage
- test-connectivity
- trust-certificate
- update-db-schema
- validate-component-config