Import API v1

messages/v1/messages/config.configuration.server.get.yml

+---
+uri: config.configuration.server.get
+
+description: |
+  Obtenir le contenu de la configuration.
+
+sampleuse: |
+  zephir-client config.configuration.server.get '{"id": 15}'
+
+pattern: rpc
+
+public: false
+
+domain: config-domain
+
+parameters:
+  server_id:
+    type: Number
+    ref: Server.ServerId
+    description: |
+      Id de la configuration.
+
+response:
+  type: ConfigConfiguration
+  description: |
+    Contenu de la configuration.

messages/v1/messages/config.configuration.server.saved.yml

+---
+uri: config.configuration.server.saved
+
+description: |
+  Liste les sessions de configuration.
+
+sampleuse: |
+  zephir-client config.configuration.server.saved '{"id": 15}'
+
+pattern: event
+
+public: false
+
+domain: config-domain
+
+parameters:
+  server_id:
+    type: Number
+    description: |
+      Id de la configuration.

messages/v1/messages/config.session.error.locked.yml

+---
+uri: config.session.error.locked
+
+sampleuse: ~
+
+description: |
+  Une erreur est survenue lors de la tentative d’ouverture d’une session existante.
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message de l’erreur lisible par un humain.
+  sessionid:
+    type: String
+    description: Identifiant de la session existante.
+    ref: Config.SessionId
+  username:
+    type: String
+    description: Nom de l’utilisateur propriétaire de la session existante.
+
+domain: config-domain

messages/v1/messages/config.session.server.list.yml

+---
+uri: config.session.server.list
+
+description: |
+  Liste les sessions de configuration des serveurs.
+
+sampleuse: |
+  zephir-client config.session.server.list
+
+pattern: rpc
+
+public: true
+
+domain: config-domain
+
+response:
+  type: '[]ConfigSession'
+  description: |
+    Liste des sessions.

messages/v1/messages/config.session.server.start.yml

+---
+uri: config.session.server.start
+
+description: |
+  Démarrer une session de configuration pour un serveur.
+
+sampleuse: |
+  zephir-client config.session.server.start '{"id":2}'
+
+pattern: rpc
+
+public: true
+
+domain: config-domain
+
+parameters:
+  id:
+    type: Number
+    ref: Server.ServerId
+    description: |
+      Id de la configuration
+
+response:
+  type: ConfigSession
+  description: Description de la session.

messages/v1/messages/config.session.server.stop.yml

+---
+uri: config.session.server.stop
+
+description: |
+  Termine une session de configuration d'un serveur.
+
+sampleuse: |
+  zephir-client config.session.server.stop '{"sessionid":"xxxxx"}'
+
+pattern: rpc
+
+public: true
+
+domain: config-domain
+
+parameters:
+  sessionid:
+    ref: Config.SessionId
+    type: String
+    description: Id de la session.
+
+response:
+  type: ConfigSession
+  description: Description de la session.

messages/v1/messages/datasource.available.yml

+---
+uri: datasource.available
+
+sampleuse: ~
+
+description: |
+  Annonce la disponibilité d’une source de données.
+
+pattern: event
+
+public: false
+
+domain: datasource-domain
+
+parameters:
+  datasourceurl:
+    type: String
+    description: |
+      Adresse de la source de données

messages/v1/messages/execution.salt.configuration.deploy-scheduled.yml

+---
+uri: execution.salt.configuration.deploy-scheduled
+
+sampleuse: ~
+
+description: |
+  le déploiement de la configuration est planifiée par SaltStack
+
+public: false
+
+pattern: event
+
+parameters:
+  return:
+    type: Dict
+    description: valeur de retour de salt-api
+
+domain: execution-domain
+
+related:
+  - execution.salt.configuration.deploy
+  - execution.salt.job.list
+  - execution.salt.job.describe

messages/v1/messages/execution.salt.configuration.deploy.yml

+---
+uri: execution.salt.configuration.deploy
+
+description: |
+  Déployer les fichiers de configuration EOLE sur des minions.
+
+sampleuse: |
+  zephir-client execution.salt.configuration.deploy '{"minion_pattern": "*"}'
+
+domain: execution-domain
+
+pattern: rpc
+
+public: false
+
+parameters:
+  minion_pattern:
+    type: String
+    description: Patron de sélection des minions.
+    help: Le patron de sélection est au format glob.
+
+response:
+  type: 'SaltExec'
+  description: Liste des tâches planifiées par SaltStack.
+
+errors:
+  - uri: execution.salt.exec.error.missing-minion_pattern
+  - uri: execution.salt.exec.error.login
+  - uri: execution.salt.exec.error.execute
+
+related:
+  - execution.salt.configuration.deploy-scheduled
+  - execution.salt.job.list
+  - execution.salt.job.describe

messages/v1/messages/execution.salt.configuration.missing.yml

+---
+uri: execution.salt.configuration.missiong
+
+sampleuse: ~
+
+description: |
+  La configuration du serveur n’existe pas
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message d’erreur lisible par un humain.
+
+domain: execution-domain
+
+related:
+  - execution.salt.configuration.deploy

messages/v1/messages/execution.salt.environment.get.yml

+---
+uri: execution.salt.environment.get
+
+description: Récupérer les données d'environnement d'un serveur.
+
+sampleuse: |
+  zephir-client execution.salt.environment.get '{"server_id":1}'
+
+domain: execution-domain
+
+pattern: rpc
+
+public: false
+
+parameters:
+  server_id:
+    type: Number
+    ref: Server.ServerId
+    description: ID du serveur.
+
+response:
+  type: Dict
+  description: Données d'environnement.

messages/v1/messages/execution.salt.exec.command-executed.yml

+---
+uri: execution.salt.exec.command-executed
+
+sampleuse: ~
+
+description: |
+  L’exécution d’une commande est correctement planifiée par SaltStack.
+
+public: false
+
+pattern: event
+
+parameters:
+  type: 'SaltExec'
+  description: Liste des tâches planifiées par SaltStack.
+
+domain: execution-domain
+
+related:
+  - execution.salt.exec
+  - execution.salt.job.list
+  - execution.salt.job.describe

messages/v1/messages/execution.salt.exec.error.execute.yml

+---
+uri: execution.salt.exec.error.execute
+
+sampleuse: ~
+
+description: |
+  Une demande d’exécution a retourné un code d’erreur.
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message de l’erreur lisible par un humain.
+
+domain: execution-domain
+
+related:
+  - execution.salt.exec

messages/v1/messages/execution.salt.exec.error.login.yml

+---
+uri: execution.salt.exec.error.login
+
+sampleuse: ~
+
+description: |
+  Une erreur est survenue lors de la connexion à « salt-api ».
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message de l’erreur lisible par un humain.
+
+domain: execution-domain
+
+related:
+  - execution.salt.exec

messages/v1/messages/execution.salt.exec.error.missing-command.yml

+---
+uri: execution.salt.exec.error.missing-command
+
+sampleuse: ~
+
+description: |
+  Vous avez oublié de fournir l’argument « Command ».
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message de l’erreur lisible par un humain.
+
+domain: execution-domain
+
+related:
+  - execution.salt.exec

messages/v1/messages/execution.salt.exec.error.missing-minion_pattern.yml

+---
+uri: execution.salt.exec.error.missing-minion_pattern
+
+sampleuse: ~
+
+description: |
+  Vous avez oublié de fournir l’argument « Minion_Pattern ».
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message d’erreur lisible par un humain.
+
+domain: execution-domain
+
+related:
+  - execution.salt.exec

messages/v1/messages/execution.salt.exec.yml

+---
+uri: execution.salt.exec
+
+description: |
+  Planifier l’exécution d’une commande sur des minions.
+
+sampleuse: |
+  zephir-client execution.salt.exec '{"minion_pattern":"*", "command":"cmd.run", "arg": "ls /tmp"}'
+
+domain: execution-domain
+
+pattern: rpc
+
+public: false
+
+parameters:
+  minion_pattern:
+    type: String
+    description: Patron de sélection des minions.
+    help: Le patron de sélection est au format glob.
+  command:
+    type: String
+    description: Commande SaltStack à exécuter.
+  arg:
+    type: String
+    description: Arguments de la commande SaltStack.
+    default: null
+  client_mode:
+    type: String
+    description: Mode d’exécution des commandes SaltStack.
+    help: |
+      Utiliser un des modes de communication parmis :
+        - « local »
+        - « local_async »
+    default: local_async
+
+response:
+  type: 'SaltExec'
+  description: Retour de la tâches planifiées par SaltStack.
+
+errors:
+  - uri: execution.salt.exec.error.missing-command
+  - uri: execution.salt.exec.error.missing-minion_pattern
+  - uri: execution.salt.exec.error.login
+  - uri: execution.salt.exec.error.execute
+
+related:
+  - execution.salt.job.list
+  - execution.salt.job.describe

messages/v1/messages/execution.salt.job.describe.yml

+---
+uri: execution.salt.job.describe
+
+description: |
+  Retourne les attributs détaillés d’une tâche SaltStack.
+
+sampleuse: |
+  zephir-client execution.salt.job.describe '{"jid": "20171128101826972627"}'
+
+domain: execution-domain
+
+pattern: rpc
+
+public: false
+
+parameters:
+  jid:
+    type: String
+    ref: Server.JobId
+    description: Identifiant de la tâche SaltStack.
+
+response:
+  type: '[]SaltJob'
+  description: Liste des tâches SaltStack pour chaque minion avec leurs attributs détaillés.
+
+errors:
+  - uri: execution.salt.job.error.db-connection
+  - uri: execution.salt.job.error.missing-jid
+  - uri: execution.salt.job.error.jid-type
+  - uri: execution.salt.job.error.unknown-jid
+
+related:
+  - execution.salt.job.list
+  - execution.salt.exec

messages/v1/messages/execution.salt.job.error.db-connection.yml

+---
+uri: execution.salt.job.error.db-connection
+
+sampleuse: ~
+
+description: |
+  Une erreur est survenue lors de la connexion à la base de données.
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message d’erreur lisible par un humain.
+
+domain: execution-domain
+
+related:
+  - execution.salt.job.list
+  - execution.salt.job.describe

messages/v1/messages/execution.salt.job.error.jid-type.yml

+---
+uri: execution.salt.job.error.jid-type
+
+sampleuse: ~
+
+description: |
+  Vous vous êtes trompé de type pour l’argument « JId ».
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: Message d’erreur lisible par un humain.
+
+domain: execution-domain
+
+related:
+  - execution.salt.job.describe