Skip to Content

Set-up

What the set-up of a new host starts from: the starting profile and the features.

OperationKindHTTP
setup.cataloguecallGET /v1/setup
setup.generatecallPOST /v1/setup/generate

setup.catalogue

What a new host starts from, and what plugins can install on one.

Needs the role admin.

Result

FieldTypeDescription
featuresFeatureInfo[]What the server's plugins can install, in the order they are applied.
templateanyThe profile a new host starts from.
Request
{
  "id": 1,
  "op": "setup.catalogue"
}
Reply
{
  "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

FieldTypeDescription
host (optional)string | null
password (optional)string | nullFor 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
whatstringhostname or password.

Result

FieldTypeDescription
notestringWhat to tell whoever asked.
password (optional)string | nullA password that was made up, for whoever asked to write down.
valuestringThe host name or the password's hash.

Errors

StatusWhen
400It could not be made; the message says why
Request
{
  "id": 1,
  "op": "setup.generate",
  "data": {
    "host": "studio",
    "password": "text",
    "user": "agent",
    "what": "text"
  }
}
Reply
{
  "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.

FieldTypeDescription
groupstringThe group of the Features page it is listed in.
helpstring
keystringPLUGIN/FEATURE, as a profile's rookery_plugin_features names it.
labelstring
typesHostType[]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.

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.

On this page