Commit e10c743b authored by Daniel Dehennin's avatar Daniel Dehennin
Browse files

Import API v1

parent cb2ae6a8
---
uri: execution.salt.job.error.list
sampleuse: ~
description: |
Une erreur est survenue lors de la constrution de la liste des tâches.
public: true
pattern: error
parameters:
reason:
type: String
description: Message d’erreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.job.list
---
uri: execution.salt.job.error.missing-jid
sampleuse: ~
description: |
Vous avez oublié de fournir 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
---
uri: execution.salt.job.error.unknown-jid
sampleuse: ~
description: |
l’identifiant de tâche est inconnue de SalStack.
public: true
pattern: error
parameters:
reason:
type: String
description: Message d’erreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.job.describe
---
uri: execution.salt.job.list
description: |
Retourne la liste de tous tâches SaltStack d'un minion.
sampleuse: |
zephir-client execution.salt.job.list
domain: execution-domain
pattern: rpc
public: false
parameters:
minion_pattern:
type: String
description: Nom du minion.
command:
type: String
description: Commande SaltStack à exécuter.
response:
type: '[]SaltJob'
description: Liste des tâches SalStack.
errors:
- uri: execution.salt.job.error.db-connection
- uri: execution.salt.job.error.list
related:
- execution.salt.job.describe
- execution.salt.exec
---
uri: execution.salt.master.event.ready
sampleuse: ~
description: Événement signalant que le minion est prêt
public: false
pattern: event
domain: execution-domain
parameters:
server_id:
type: Number
description: ID du serveur
---
uri: execution.salt.master.event.start
sampleuse: ~
description: Événement signalant le démarrage d'un minion
public: false
pattern: event
domain: execution-domain
parameters:
server_id:
type: Number
description: ID du serveur
---
uri: execution.salt.minion.registered
sampleuse: ~
description: |
TODO: Message émis lorsqu'un nouveau minion est attaché à l'instance saltmaster utilisée par l'application Zéphir
public: false
pattern: event
domain: execution-domain
parameters:
saltminionid:
type: String
description: |
Identifiant interne du minion Salt distant
---
uri: execution.salt.minion.unregistered
sampleuse: ~
description: |
TODO: Message émis lorsqu'un minion est détaché de l'instance saltmaster utilisée par l'application Zéphir
public: false
pattern: event
domain: execution-domain
parameters:
saltminionid:
type: String
description: |
Identifiant interne du minion Salt distant
---
uri: execution.salt.peer.error
sampleuse: ~
description: |
L’appairage s’est terminé avec un code d’erreur.
public: true
pattern: error
parameters:
reason:
type: String
description: Message d’erreur lisible par un humain.
domain: server-domain
related:
- execution.salt.peer
---
uri: execution.salt.peer.registered
sampleuse: ~
description: |
Notify salt peering
pattern: event
parameters:
serverid:
type: Number
description: server and salt minion uid
automation:
type: String
description: Automation engine
public: false
domain: execution-domain
---
uri: identity.session-user.get
description: |
Returns the informations about the current HTTP session user
sampleuse: |
zephir-client identity.session-user.get
pattern: rpc
public: true
domain: identity-domain
response:
type: IdentitySession
description: Informations sur l'identité de l'utilisateur.
---
uri: identity.settings.get
description: |
Return the given user's setting value
sampleuse: |
zephir-client identity.settings.get '{"username": "yo"}'
pattern: rpc
public: true
domain: identity-domain
parameters:
username:
type: String
ref: Identity.username
description: Nom de l'utilisateur
response:
type: Dict
description: Préférences de l'utilisateur
---
uri: identity.settings.set
description: |
Return the given user's setting value
sampleuse: |
zephir-client identity.settings.set '{"username": "yo", "settings": {"ssh_pubkey": "654987", "lastname": "Dupont", "firstname": "Philippe"}}'
pattern: rpc
public: true
domain: identity-domain
parameters:
username:
type: String
ref: Identity.username
description: Nom de l'utilisateur
settings:
type: Dict
description: Préférences de l'utilisateur
response:
type: Boolean
description: Les préférences de l'utilisateur ont été modifiées
---
uri: identity.settings.updated
description: |
notify Crossbar for any settings changing
sampleuse: |
zephir-client identity.settings.updated {"settings": {"username": "yo", "ssh_pubkey": "654987", "lastname": "Dupont", "firstname": "Philippe"}}
pattern: event
public: false
domain: identity-domain
parameters:
settings:
type: Dict
description: Préférence de l'utilisateur
---
uri: server.create
description: |
Créer un serveur.
sampleuse: |
zephir-client server.create '{"servername":"MonJoliServeur", "serverdescription": "un bien joli serveur", "servermodelid":1, "serverpassphrase": "MyPassPhrase"}'
pattern: rpc
public: true
domain: server-domain
parameters:
servername:
type: String
description: |
Nom du serveur.
serverdescription:
type: String
description: |
Description du serveur.
servermodelid:
type: Number
ref: Servermodel.ServermodelId
description: |
ID du modèle de serveur.
serverpassphrase:
type: String
description: |
Phrase secrète de la clef privé.
response:
type: Server
description: Description du serveur créé.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-servermodel-id
- uri: server.error.unknown-servermodel-id
- uri: server.error.servername-not-provided
related:
- server.list
- server.describe
- server.update
- server.delete
---
uri: server.created
description: Un serveur a été créé.
pattern: event
public: false
domain: server-domain
parameters:
type: Server
description: Description du serveur.
---
uri: server.delete
description: |
Supprimer un serveur.
public: true
pattern: rpc
domain: server-domain
sampleuse: |
zephir-client server.delete '{"serverid":1}'
parameters:
serverid:
type: Number
ref: Server.ServerId
description: |
ID du serveur.
response:
type: Server
description: Description du serveur supprimé.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
related:
- server.list
- server.describe
- server.create
- server.update
---
uri: server.deleted
sampleuse: ~
description: |
Deleted server message
pattern: event
public: false
domain: server-domain
parameters:
serverid:
type: Number
description: |
Server model identifier
---
uri: server.describe
description: |
Retourne les attributs détaillées d’un serveur.
sampleuse: |
zephir-client server.describe '{"serverid":1}'
pattern: rpc
public: true
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: Identifiant du serveur.
configuration:
type: Boolean
description: Inclure les valeurs de configuration.
default: false
response:
type: ServerDescribe
description: Description du serveur.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
related:
- server.list
- server.create
- server.update
- server.delete
---
uri: server.environment.updated
description: Les données d'environnements d'un serveur sont modifiées
sampleuse: |
zephir-client server.environment.updated '{"server_id": 15}'
pattern: event
public: false
domain: config-domain
parameters:
server_id:
type: Number
description: |
Id de la configuration.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment