---
uri: servermodel.describe

description: |
  Retourne les attributs détaillés d'un modèle de serveur.

sampleuse: |
  zephir-client servermodel.describe -s 1

pattern: rpc

public: true

domain: servermodel-domain

parameters:
  servermodelid:
    type: Number
    shortarg: s
    description: Identifiant du modèle de serveur à récupérer.
    ref: Servermodel.ServermodelId
  inheritance:
    type: Boolean
    shortarg: i
    description: Inclure les données héritées des modèles de serveur parents.
    default: true
  resolvdepends:
    type: Boolean
    shortarg: r
    description: Résoudre les dépendances de services.
    default: true
  schema:
    type: Boolean
    shortarg: c
    description: Inclure le schema de configuration (réaggrège les données provenant du datasource).
    default: false
  probes:
    type: Boolean
    shortarg: p
    description: Inclure les informations sur les sondes de la configuration.
    default: false
  creolefuncs:
    type: Boolean
    shortarg: o
    description: Inclure les fonctions Creole.
    default: false
  conffiles:
    type: Boolean
    shortarg: f
    description: Inclure les fichier creole au format tar encodé en base64
    default: false

response:
  type: Servermodel
  description: Description du modèle de serveur.

errors:
  - uri: servermodel.describe.error.database_not_available
  - uri: servermodel.describe.error.invalid_servermodel_id
  - uri: servermodel.describe.error.unknown_servermodel_id

related:
  - servermodel.list
  - servermodel.create
  - servermodel.update
  - servermodel.delete
  - servermodel.event