Plugins Management¶
Get the Plugin Manager¶
The plugin manager links to the following resources:
- The
srv.install
relation links to the plugin manager installation service. This installation service permits installing/uninstalling plugins. - The
pg.plugins
relation links to the list of plugins. - The
pg.reload
relation links to the plugin reload service.
Query¶
GET /provd/pg_mgr HTTP/1.1
Example request¶
GET /provd/pg_mgr HTTP/1.1
Host: xivoserver
Accept: application/vnd.proformatique.provd+json
Example response¶
HTTP/1.1 200 OK
Content-Type: application/vnd.proformatique.provd+json
{
"links": [
{
"href": "/provd/pg_mgr/install",
"rel": "srv.install"
},
{
"href": "/provd/pg_mgr/plugins",
"rel": "pg.plugins"
},
{
"href": "/provd/pg_mgr/reload",
"rel": "pg.reload"
}
]
}
List Plugins¶
List the installed plugins.
If you want to install/uninstall plugins, you need to go trough the plugin installation service.
Query¶
GET /provd/pg_mgr/plugins HTTP/1.1
Example request¶
GET /provd/pg_mgr/plugins HTTP/1.1
Host: xivoserver
Accept: application/vnd.proformatique.provd+json
Example response¶
HTTP/1.1 200 OK
Content-Type: application/vnd.proformatique.provd+json
{
"plugins": {
"xivo-aastra-3.3.1-SP2": {
"links": [
{
"href": "/provd/pg_mgr/plugins/xivo-aastra-3.3.1-SP2",
"rel": "pg.plugin"
}
]
},
"xivo-cisco-sccp-9.0.3": {
"links": [
{
"href": "/provd/pg_mgr/plugins/xivo-cisco-sccp-9.0.3",
"rel": "pg.plugin"
}
]
}
}
}
Get a Plugin¶
The plugin links to the following resources:
- The
pg.info
relation links to the plugin information. - The
srv.install
relation links to the plugin installation service. Plugins usually provided this service to install/uninstall firmware and language files.
Query¶
GET /provd/pg_mgr/plugins/<plugin_id> HTTP/1.1
Example request¶
GET /provd/pg_mgr/plugins/xivo-aastra-3.3.1-SP2 HTTP/1.1
Host: xivoserver
Accept: application/vnd.proformatique.provd+json
Example response¶
HTTP/1.1 200 OK
Content-Type: application/vnd.proformatique.provd+json
{
"links": [
{
"href": "/provd/pg_mgr/plugins/xivo-aastra-3.3.1-SP2/info",
"rel": "pg.info"
},
{
"href": "/provd/pg_mgr/plugins/xivo-aastra-3.3.1-SP2/install",
"rel": "srv.install"
}
]
}
Get Information of a Plugin¶
Query¶
GET /provd/pg_mgr/plugins/<plugin_id>/info HTTP/1.1
Example request¶
GET /provd/pg_mgr/plugins/xivo-aastra-3.3.1-SP2/info HTTP/1.1
Host: xivoserver
Accept: application/vnd.proformatique.provd+json
Example response¶
HTTP/1.1 200 OK
Content-Type: application/vnd.proformatique.provd+json
{
"plugin_info": {
"capabilities": {
"Aastra, 6730i, 3.3.1.5089": {
"sip.lines": 6
},
"Aastra, 6731i, 3.3.1.2235": {
"sip.lines": 6,
"switchboard": true
},
"Aastra, 6735i, 3.3.1.5089": {
"sip.lines": 9
},
"Aastra, 6737i, 3.3.1.5089": {
"sip.lines": 9
},
"Aastra, 6739i, 3.3.1.2235": {
"sip.lines": 9
},
"Aastra, 6753i, 3.3.1.2235": {
"sip.lines": 9
},
"Aastra, 6755i, 3.3.1.2235": {
"sip.lines": 9,
"switchboard": true
},
"Aastra, 6757i, 3.3.1.2235": {
"sip.lines": 9,
"switchboard": true
},
"Aastra, 9143i, 3.3.1.2235": {
"sip.lines": 9
},
"Aastra, 9480i, 3.3.1.2235": {
"sip.lines": 9
}
},
"description": "Plugin for Aastra 6730i, 6731i, 6735i, 6737i, 6739i, 6753i, 6755i, 6757i, 6757i CT, 9143i, 9480i, 9480i CT in version 3.3.1 SP2.",
"version": "1.1"
}
}
Reload a Plugin¶
Reload the given plugin. This is mostly useful during plugin development, after changing the code of the plugin, instead of restarting the xivo-provd application.
Query¶
POST /provd/pg_mgr/reload HTTP/1.1
Example request¶
POST /provd/pg_mgr/reload HTTP/1.1
Host: xivoserver
Content-Type: application/vnd.proformatique.provd+json
{
"id": "xivo-aastra-3.3.1-SP2"
}
Example response¶
HTTP/1.1 204 No Content