Set-up
What the set-up of a new host starts from: the starting profile and the features.
| Operation | Kind | HTTP |
|---|---|---|
setup.catalogue | call | GET /v1/setup |
setup.generate | call | POST /v1/setup/generate |
setup.catalogue
What a new host starts from, and what plugins can install on one.
Needs the role admin.
Result
| Field | Type | Description |
|---|---|---|
features | FeatureInfo[] | What the server's plugins can install, in the order they are applied. |
template | any | The profile a new host starts from. |
{
"id": 1,
"op": "setup.catalogue"
}{
"id": 1,
"result": {
"features": [
{
"group": "text",
"help": "text",
"key": "layout",
"label": "text",
"types": [
"ssh"
]
}
],
"template": null
}
}setup.generate
Make up a host name, or hash or make up a password.
Needs the role admin.
Input
What to make
| Field | Type | Description |
|---|---|---|
host (optional) | string | null | |
password (optional) | string | null | For password: the password to hash. Without it one is made up and kept in the server's store with host, under user, for hosts.credentials to give. |
user (optional) | string | null | |
what | string | hostname or password. |
Result
| Field | Type | Description |
|---|---|---|
note | string | What to tell whoever asked. |
password (optional) | string | null | A password that was made up, for whoever asked to write down. |
value | string | The host name or the password's hash. |
Errors
| Status | When |
|---|---|
| 400 | It could not be made; the message says why |
{
"id": 1,
"op": "setup.generate",
"data": {
"host": "studio",
"password": "text",
"user": "agent",
"what": "text"
}
}{
"id": 1,
"result": {
"note": "text",
"password": "text",
"value": "text"
}
}Types
The named types used on this page.
FeatureInfo
Something a plugin installs, for the Features page of a host.
| Field | Type | Description |
|---|---|---|
group | string | The group of the Features page it is listed in. |
help | string | |
key | string | PLUGIN/FEATURE, as a profile's rookery_plugin_features names it. |
label | string | |
types | HostType[] | The types of host it is for, such as workstation or node. |
HostType
What rookery does with a host: what its profile means it to be, or what it was seen to be. They are in the order of how much of rookery each has.
What rookery does with a host: what its profile means it to be, or what it was seen to be. They are in the order of how much of rookery each has.