AdminManager2 V10
Présentation
AdminManager2 est un outil permettant d'effectuer des tâches d'administration en ligne de commande.
Il est disponible en version 10 ici
Il est disponible en version 11 ici
Mise en oeuvre
Authentification au référentiel
Les informations de connexion aux référentiels sont stockées dans la base de registre, et sont partagées avec le client lourd.
Les commandes authentifiées attendent un paramètre "alias" qui identifie l'entrée de la base de registre par le nom de la clef ou par le libellé de la base.
Mode interactif
Les commandes disponibles
about
about:update
about:update
Télécharge le dernier binaire en ligne et remplace le binaire actuel.
about:version
about:version
Affiche la version courante et la version disponible en ligne
accessProfile
accessProfile:create
accessProfile:create [--accessProfileCaption=xx] [--connectionsTypes=xx] [--isUniqueAccess=xx] [--readOnlyAccess=xx] [--alertOnLoginFail=xx] [--timeToBlock=xx] [--nbLoginFailToLoc=xx] [--failPeriod=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Crée une politique d'accès. les types de connexions possibles sont ctDesktop,ctWebTop,ctService,ctTask,ctOutlook,ctExcel,ctDashboard,ctMobile,ctSOAP,ctSDATA,ctFTP,ctAdmin.
accesstoken
accesstoken:create
accesstoken:create --caption=xx --folderName=xx [--databaseName=xx] [--societyName=xx] --applicationName=xx --userName=xx [--expireDays=xx] [--varName=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Crée un jeton daccès et lenregistre dans le répertoire "accesstoken" dans un fichier nommé par le paramètre "caption". Il est de la responsabilité de l'appelant de supprimer ce fichier une fois récupéré. Le contenu du jeton peut être copié dans une variable d'environnement "varName"
application
application:deploy
application:deploy --applicationNames=xx [--masterPath=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Déploie une liste d'applications dans le référentiel
Si le master est absent, l'application est téléchargée
Les applications sont Sage1000Entreprise,Tresorerie,AppNotesFrais,cautionsbancaires,comptaGenFin,comptaGenFinGroup,immobilisation,rapprobancaire,banquepaiement
application:list
application:list
affiche la liste des applications disponibles en ligne
application:update
application:update [--onlyBySerialNummber=xx] [--verbose=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
télécharge et installe les patchs disponibles puis synchronise les bases métiers si nécessaire
authProfile
authProfile:create
authProfile:create [--authProfileCaption=xx] [--doConfirmContactInf=xx] [--isComplexPassword=xx] [--minLengthPassword=xx] [--maxAgePassword=xx] [--minAgePassword=xx] [--nbHistorPassword=xx] [--trialNbToBlockUser=xx] [--forbiddenWords=xx] [--doubleFactor=xx] [--allowPasswordReInit=xx] [--passwordReInitSms=xx] [--allowRegister=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx Crée une politique d'authentification
azureKV
azureKV:get
azureKV:get --keyvaultName=xx --secretName=xx [--varName=xx]
La valeur du secret du coffre fort Azure est copiée dans une variable d'environnement "varName" La machine qui exécute l'adminmanager doit être service principal pour accéder au coffre
azureKV:set
azureKV:set --keyvaultName=xx --secretName=xx [--varName=xx]
La valeur de la variable d'environnement "varName" est copiée dans le secret du coffre fort Azure. La machine qui exécute l'adminmanager doit être service principal pour accéder au coffre
container
container:create
container:create --containerName=xx --containerCaption=xx --containerManager=xx [--azureContainerName=xx] [--azureStorageAccount=xx] [--azureStorageAccessKey=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Crée un conteneur
database
database:create
database:create [--url=xx] [--masterUserName=xx] [--masterUserPassword=xx] [--osAuthentication=xx] [--compressed=xx] [--unicode=xx] [--textSupport=xx] [--shareSupport=xx] [--driver=xx] [--serverName=xx] [--databaseName=xx] [--databaseSchema=xx] [--databaseUser=xx] [--databasePassword=xx] [--databaseGiven=xx] [--doInitialize=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Crée une base de données métier
database:delete
database:delete [--databaseName=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx [--org=xx]
Supprime une base de données métier
desktop:install
desktop:install [--path=xx] [--url=xx]
Installe le client lourd
directory
directory:addEntity
directory:addEntity --directoryName=xx [--directoryIdentifier=xx] [--userName=xx] [--groupName=xx] [--authProfile=xx] [--accessProfile=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Ajoute un utilisateur ou un groupe à un annuaire et positionne le cas échéant une politique d'accès ou d'authentification.
directory:removeEntity
directory:removeEntity --directoryName=xx [--userName=xx] [--groupName=xx] [--adminUser=xx] [--adminPassword=xx] [--org=xx] --alias=xx
Retire un utilisateur ou un groupe d'un annuaire.
directoryAD
directoryAD:create
directoryAD:create [--dnBase=xx] --login=xx --password=xx [--isSSO=xx] [--domainName=xx] [--accessProfile=xx] [--name=xx] [--caption=xx] [--adminUser=xx] [--adminPassword=xx] [--org=xx] --alias=xx
Créé un annuaire Active Directory
directorySageID
directorySageID:create
directorySageID:create [--isShadow=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Créé un annuaire Sage Cloud ID
dbmaster
dbmaster:create
dbmaster:create [--url=xx] [--masterUserName=xx] [--masterUserPassword=xx] [--osAuthentication=xx] [--compressed=xx] [--unicode=xx] [--masterPath=xx] --userName=xx --userPassword=xx [--driver=xx] [--serverName=xx] [--databaseName=xx] [--databaseSchema=xx] [--multitenant=xx] [--providerName=xx] --alias=xx
Crée un référentiel
exemples : dbmaster:create --url=msodbc://FRPO150757\SQLEXPRESS/dbMaster900_Test?prefix="dbo." --alias="ref test" --userName=test --userPassword=test --masterUserName=sa --masterUserPassword=bunny
dbmaster:create --serverName=FRPO150757\SQLEXPRESS --databaseName=dbMaster900_Test --alias="ref test" --userName=test --userPassword=test --masterUserName=sa --masterUserPassword=bunny
dbmaster:create --serverName=localhost\SQLEXPRESS --databaseName=dbMaster910 --alias="910" --userName=test --userPassword=test --osAuthentication=1
dbmaster:update
dbmaster:update --alias=xx
synchronise un référentiel
env
env:set
env:set --name=xx --value=xx
Positionne une variable d'environnement
env:get
env:get --name=xx
Retourne une variable d'environnement
folder
folder:authorize
folder:authorize --folderName=xx [--userName=xx] [--groupName=xx] [--applicationName=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx [--org=xx]
Autorise un utilisateur sur un dossier
folder:create
folder:create --folderName=xx --applicationName=xx --databaseName=xx [--dbRefScript=xx] [--initArchive=xx] [--docContainers=xx] [--taskMode=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Crée un dossier dbRefScript est
- soit le chemin complet vers un fichier xml qui décrit le fichier .sql associé
- soit le nom d'un script disponible dans le master en ligne, il est alors téléchargé (voir online:dbrefs )
folder:delete
folder:delete --folderName=xx [--adminUser=xx] [--adminPassword=xx] --alias=xx
Supprime un dossier
group
group:add
group:add --groupName=xx --userName=xx [--adminUser=xx] [--adminPassword=xx] --alias=xx
Ajoute un utilisateur à un groupe
group:create
group:create --groupName=xx [--parentName=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Crée un groupe d'utilisateurs
group:remove
group:remove --groupName=xx --userName=xx [--adminUser=xx] [--adminPassword=xx] --alias=xx
Retire un utilisateur d'un groupe
license
license:deploy
license:deploy [--keys=xx] [--varName=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Déploie une liste de clefs dans le référentiel
license:validate
license:validate --codes=xx [--adminUser=xx] [--adminPassword=xx] --alias=xx [--org=xx]
Enregistre un code DUA
mail:setup
mail:setup --server=xx --TLSimplicit=xx --TLSexplicit=xx --user=xx [--password=xx] [--exp=xx] [--port=xx] [--adminUser=xx] [--adminPassword=xx] [--org=xx] --alias=xx
Paramètre le serveur de mail
mail:send
mail:send --dest=xx --subject=xx --body=xx [--adminUser=xx] [--adminPassword=xx] [--org=xx] --alias=xx
Envoie un mail (utile pour tester le paramétrage du serveur de mail)
online
online:dbrefs
online:dbrefs
Retourne la liste des scripts de références disponibles en ligne
online:demos
online:demos
Retourne la liste des bases de démo disponibles en ligne
server
server:install
server:install [--path=xx] [--withLoader=xx] [--url=xx]
Télécharge et installe le serveur Sage FRP 1000, ajoute une exception au pare feu pour le service. Le paramètre "withLoader" permet d'installer le service avec le loader de service
service
service:create
service:create --name=xx --applicationName=xx --folderNames=xx --serverUser=xx --serverPassword=xx [--path=xx] [--withLoader=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Crée un service dans le fichier de configuration ainsi que le service windows associé Le paramètre "withLoader" permet d'installer le service avec le loader de service
service:update
service:update --keys=xx --values=xx [--path=xx] [--withLoader=xx] --name=xx
Modifie le fichier de configuration du service
service:delete
service:delete [--path=xx] [--withLoader=xx] --name=xx
Supprime un service dans le fichier de configuration ainsi que le service windows associé
service:start
service:start --name=xx
Démarre le service windows lié
service:stop
service:stop --name=xx
Arrête le service Windows
service:list
service:list [--path=xx] [--withLoader=xx]
Liste les services présents dans le fichier de configuration du service
tools:init
tools:init
tools:init
Installe les composants nécessaires: libraisiries SSL, OVPs, sage.common.dll, drivers SQL
user
user:add
user:add --userName=xx --userCaption=xx [--userMail=xx] [--newUserPassword=xx] [--expire=xx] [--hasAdminRole=xx] [--hasAdminFolderRole=xx] [--hasDevelopperRole=xx] [--hasPersonalDataRestrictions=xx] [--haveToChangePassword=xx] [--randomPassword=xx] [--adminUser=xx] [--adminPassword=xx] [--org=xx] --alias=xx
Crée un utilisateur, le paramétre expire indique le nombre de jour avant l'expiration du compte (à partir de la date de création)
user:update
user:add --userName=xx --userCaption=xx [--userMail=xx] [--newUserPassword=xx] [--expire=xx] [--hasAdminRole=xx] [--hasAdminFolderRole=xx] [--hasDevelopperRole=xx] [--haveToChangePassword=xx] [--randomPassword=xx] [--hasPersonalDataRestrictions=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Modifie un utilisateur
user:getName
user:getName --userMail=xx [--varName=xx]
Mode batch
il est possible d'appeler l'exécutable avec en paramètre un fichier contenant une liste de commandes
frp.exe --file="C:\projets\Desktop\adminl1000_scripts\commands.txt"
Exemples
user:update user:update --userName=xx [--userCaption=xx] [--userMail=xx] [--newUserPassword=xx] [--expire=xx] [--adminUser=xx] [--adminPassword=xx] --alias=xx
Exemple 1 : Première utilisation
Téléchargement et installation des prérequis
tools:init
Téléchargement et installation du server Sage FRP 1000
server:install
Exemple 2 : Création d'un référentiel et d'un dossier
Créer le référentiel
dbmaster:create --url=msodbc://FRPO150757\SQLEXPRESS/dbMaster900_Test?prefix="dbo." --alias="ref test" --userName=test --userPassword=test --masterUserName=sa --masterUserPassword=bunny
Installer l'application suite financière
application:deploy --applicationNames=Sage1000Entreprise --alias="ref test"
Installer les clefs d'authenticité
license:deploy --alias="ref test" --keys=XXXXXXXXXXXXXXX,XXXXXXXXXXXXXXXXXXX
Créer la base de données métier
database:create --alias="ref test" --url=msodbc://FRPO150757\SQLEXPRESS/baseSuiteTest?prefix="dbo." --masterUserName=sa --masterUserPassword=bunny
Créer le dossier
folder:create --alias="ref test" --databaseName=baseSuiteTest --applicationName=Sage1000Entreprise --folderName=monDossierSuite --dbRefScript=sql_dbRefGCF1000-euro
Créer un groupe
group:create --alias="ref test" --groupName="mon groupe"
Créer un utilisateur
user:add --alias="ref test" --userName="mon user" --userCaption="jean dupont" --userMail="[email protected]"
Associer l'utilisateur au groupe
group:add --alias="ref test" --groupName="mon groupe" --userName="mon user"
Autoriser le groupe sur le dossier
folder:authorize --alias="ref test" --folderName=monDossierSuite --groupName="mon groupe"
Exemple 3 : Création d'un service
Ajouter l'utilisateur de service
user:add --alias="ref test" --userName="webuser" --userCaption="webuser" --userPassword=P@ss
Autoriser l'utilisateur
folder:authorize --alias="ref test" --folderName=monDossierSuite --userName="webuser"
Créer le service
service:create --alias="ref test" --name="900_suitefi" --applicationName=Sage1000Entreprise --folderNames="monDossier" --serverUser=webuser --serverPassword=P@ss
Démarrer le service
service:start --name="900_suitefi"
Exemple 4 : utilisation des variables d'environnement
Les variables peuvent être définies dans le script, dans le programme appelant, ou bien au niveau du système.
Tip : Les variables sont substituées sur la ligne de commande, si la variable contient des espaces il faut la référencée entre guillemets "%maVariableAvecEspaces%" |
env:set --name=monAlias --value="référentiel 910" env:set --name=monServeur --value="FRPO150757\SQLEXPRESS" dbmaster:create --url=msodbc://%monServeur%/dbMasterTest4?prefix="dbo." --alias="%monAlias%" --userName=test --userPassword=test --masterUserName=sa --masterUserPassword=bunny
Exemple 5 : Créer un jeton d'accès
accesstoken:create --caption="test1" --folderName="Compta" --societyName="S1" --applicationName="comptaGenFin" --userName="sage" --alias="920 locale" --expireDays=10
Exemple : Fichier batch
Création d'une base master, installation de la Suite Financière et création d'une base métier
; Set variables ; env:set --name=masterAlias --value="master local" env:set --name=dbServer --value="xxxx" env:set --name=saPassword --value="xxxx" ; env:set --name=dbUser --value="syfre" env:set --name=dbUserPassword --value="xxxx" ; env:set --name=dbName --value="db1100SuiteFi" ; env:set --name=folder --value="Test Suite Fi" env:set --name=group --value="users" env:set --name=user --value="syfre" ; Initialization ; tools:init ; Create master database ; dbmaster:create --url=msodbc://%dbServer%/dbMaster1100?prefix="dbo." --alias="%masterAlias%" --userName=%dbUser% --userPassword=%dbUserPassword% --masterUserName=sa --masterUserPassword=%saPassword% ; Install Sage FRP 1000 Suite Fi ; application:deploy --applicationNames=Sage1000Entreprise --alias="%masterAlias%" ; Create product database ; database:create --alias="%masterAlias%" --url=msodbc://%dbServer%/%dbName%?prefix="dbo." --masterUserName=sa --masterUserPassword=%saPassword% folder:create --alias="%masterAlias%" --databaseName=%dbName% --applicationName=Sage1000Entreprise --folderName="%folder%" --dbRefScript=sql_dbRefGCF1000-euro ; Create group and user ; group:create --alias="%masterAlias%" --groupName=%group% user:add --alias="%masterAlias%" --userName=%user% --userCaption="sylvain frere" --userMail="[email protected]" group:add --alias="%masterAlias%" --groupName=%group% --userName=%user% folder:authorize --alias="%masterAlias%" --folderName="%folder%" --groupName=%group%