Commit a63bcd58 authored by Lionel Morin's avatar Lionel Morin

Merge branch 'develop' into 'updated_list'

# Conflicts:
#   messages/v1/messages/server.configuration.updated.yml
parents 22b5211b addeab16
---
uri: config.session.server.configure
description: |
Modifie la configuration en cours d'édition.
sampleuse: |
zephir-client config.session.server.configure -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la session.
action:
type: String
shortarg: a
description: Action sur la variable ("modify", "delete", "add").
name:
type: String
shortarg: n
description: Nom de la variable a modifier.
index:
type: Number
shortarg: i
description: Index de la variable a modifier.
default: null
value:
type: Any
shortarg: v
description: Valeur de la variable.
default: null
response:
type: ConfigStatus
description: Description de la session.
---
uri: config.session.server.filter
description: |
Filte la configuration en cours d'édition.
sampleuse: |
zephir-client config.session.server.filter -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la session.
namespace:
type: String
shortarg: n
description: Nom du namespace de la configuration.
default: null
mode:
type: String
shortarg: m
description: Mode de la configuration (basic, normal, expert).
default: null
debug:
type: Boolean
shortarg: d
description: Activation du mode debug.
default: null
response:
type: ConfigSession
description: Description de la session.
---
uri: config.session.server.get
description: |
Affiche la configuration en cours d'édition.
sampleuse: |
zephir-client config.session.server.get -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la session.
response:
type: ConfigSession
description: Description de la session.
......@@ -2,7 +2,7 @@
uri: config.session.server.list
description: |
Liste les sessions de configuration des serveurs.
Liste les sessions de configuration en cours d'édition.
sampleuse: |
zephir-client config.session.server.list
......
......@@ -19,7 +19,7 @@ parameters:
ref: Server.ServerId
shortarg: c
description: |
Identifiant de la configuration.
Identifiant du serveur.
response:
type: ConfigSession
......
......@@ -19,6 +19,11 @@ parameters:
type: String
shortarg: s
description: Identifiant de la session.
save:
type: Boolean
shortarg: a
description: Sauver la configuration avant de la terminer.
default: false
response:
type: ConfigSession
......
---
uri: config.session.server.validate
description: |
Valider la configuration en cours d'édition.
sampleuse: |
zephir-client config.session.server.validate -s xxxxx
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
ref: Config.SessionId
type: String
shortarg: s
description: Identifiant de la session.
response:
type: ConfigConfigurationStatus
description: Statut de la configuration.
---
uri: config.session.servermodel.configure
description: |
Modifie la configuration en cours d'édition.
sampleuse: |
zephir-client config.session.servermodel.configure -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la session.
action:
type: String
shortarg: a
description: Action sur la variable ("modify", "delete", "add").
name:
type: String
shortarg: n
description: Nom de la variable a modifier.
index:
type: Number
shortarg: i
description: Index de la variable a modifier.
default: null
value:
type: Any
shortarg: v
description: Valeur de la variable.
default: null
response:
type: ConfigStatus
description: Description de la session.
---
uri: config.session.servermodel.filter
description: |
Filte la configuration en cours d'édition.
sampleuse: |
zephir-client config.session.servermodel.filter -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la session.
namespace:
type: String
shortarg: n
description: Nom du namespace de la configuration.
default: null
mode:
type: String
shortarg: m
description: Mode de la configuration (basic, normal, expert).
default: null
debug:
type: Boolean
shortarg: d
description: Activation du mode debug.
default: null
response:
type: ConfigSession
description: Description de la session.
---
uri: config.session.servermodel.get
description: |
Affiche la configuration du serveur en cours d'édition.
sampleuse: |
zephir-client config.session.servermodel.get -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la session.
response:
type: ConfigSession
description: Description de la session.
......@@ -18,7 +18,7 @@ parameters:
ref: Servermodel.ServermodelId
shortarg: c
description: |
Identifiant de la configuration.
Identifiant du modèle de serveur.
response:
type: ConfigSession
......
......@@ -18,6 +18,11 @@ parameters:
type: String
shortarg: s
description: Identifiant de la session.
save:
type: Boolean
shortarg: a
description: Sauver la configuration avant de la terminer.
default: false
response:
type: ConfigSession
......
---
uri: config.session.servermodel.validate
description: |
Valider la configuration en cours d'édition.
sampleuse: |
zephir-client config.session.servermodel.validate -s xxxxx
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
ref: Config.SessionId
type: String
shortarg: s
description: Identifiant de la session.
response:
type: ConfigConfigurationStatus
description: Statut de la configuration.
......@@ -21,5 +21,5 @@ parameters:
description: Identifiant de l'utilisateur.
response:
type: Dict
type: IdentitySettings
description: Préférences de l'utilisateur.
......@@ -22,7 +22,7 @@ parameters:
sshkey:
type: String
shortarg: s
description: Clé publique ssh.
description: Clé publique SSH.
default: null
firstname:
type: String
......@@ -46,5 +46,5 @@ parameters:
default: null
response:
type: Boolean
description: Les préférences de l'utilisateur ont été modifiées
type: IdentitySettings
description: Informations sur l'identité de l'utilisateur.
---
uri: server.config.get
description: |
Retourne les valeurs de configuration d’un serveur.
sampleuse: |
zephir-client server.config.get -s 1
pattern: rpc
public: true
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
shortarg: s
description: Identifiant du serveur.
response:
type: ConfigConfiguration
description: Configuration du serveur.
......@@ -15,5 +15,30 @@ domain: server-domain
parameters:
serverid:
type: Number
description: |
Identifiant du serveur supprimé.
description: Identifiant du serveur.
ref: Server.ServerId
servername:
type: String
description: Nom du serveur.
serverdescription:
type: String
description: Description du serveur.
servermodelid:
type: Number
description: Identifiant du modèle de serveur.
ref: Servermodel.ServermodelId
zoneid:
type: Number
description: Identifiant de la zone.
ref: Zone.ZoneId
machineid:
type: Number
description: Identifiant de la machine.
ref: Zone.MachineId
automation:
type: String
description: Moteur d'exécution.
ref: Server.automation
lastpeerconnection:
type: String
description: Timestamp de la dernière connexion avec le serveur.
......@@ -23,6 +23,14 @@ parameters:
type: Boolean
description: Inclure les valeurs de configuration.
default: false
environment:
type: Boolean
description: Inclure les variables d'environement.
default: false
peering:
type: Boolean
description: Inclure la clé d'appairage.
default: false
response:
type: ServerDescribe
......
---
uri: server.peering-conf.get
description: |
Accès à la configuration d'appairage.
sampleuse: |
zephir-client server.peering-conf.get -s 1
pattern: rpc
public: true
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
shortarg: s
description: Identifiant du serveur.
response:
type: ServerPeeringConf
description: Configuration d'appairage.
errors:
- uri: server.error.peering-conf-not-available
related:
- server.list
- server.create
- server.update
- server.delete
---
uri: server.peering-conf.sent
sampleuse: ~
description: La configuration d'appairage du serveur a été envoyée à l'utilisateur.
pattern: event
public: false
domain: server-domain
parameters:
serverid:
type: Number
description: Identifiant du serveur.
---
uri: servermodel.applicationservice.join
description: |
Associe un service applicatif à un modèle de serveur.
sampleuse: |
zephir-client servermodel.applicationservice.join -m 1 -s 1
pattern: rpc
public: true
domain: servermodel-domain
parameters:
servermodelid:
type: Number
shortarg: m
description: |
Identifiant du modèle de serveur.
applicationserviceid:
type: Number
shortarg: s
description: |
Identifiant du service applicatif.
response:
type: Servermodel
description: Description du modèle de serveur.
......@@ -2,7 +2,7 @@
uri: servermodel.applicationservice.list
description: |
Retourne la liste des applications service.
Retourne la liste des services applicatif
sampleuse: |
zephir-client servermodel.applicationservice.list -s 6
......@@ -22,4 +22,4 @@ parameters:
response:
type: '[]Dict'
description: Liste des applications service disponibles.
description: Liste des services applicatif disponibles.
......@@ -14,12 +14,12 @@ public: true
domain: servermodel-domain
parameters:
servermodelparentid:
type: Number
servermodelparentsid:
type: "[]Number"
ref: Servermodel.ServermodelId
shortarg: p
description: |
Identifiant du modèle de serveur parent auquel rattacher le nouveau modèle.
Identifiants des modèles de serveur parents auquels rattacher le nouveau modèle.
servermodelname:
type: String
shortarg: n
......
---
uri: servermodel.delete.error.database_not_available
sampleuse: ~
description: |
Erreur retournée lorsque la base de données n'est pas disponible.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain
---
uri: servermodel.delete.error.dependency_lock
sampleuse: ~
public: true
pattern: error
description: |
Ce modèle de serveur est parent d'autres modèles.
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.