@@PRODUCT@@

Managing groups

A group decides which servers, customers and users belong together, and therefore what a reseller can and cannot see. You find them under Beheer → Mensen → Groepen (Administration → People → Groups). As an administrator you can create a gro

Written for: Administrator

A group decides which servers, customers and users belong together, and therefore what a reseller can and cannot see. You find them under Beheer → Mensen → Groepen (Administration → People → Groups). As an administrator you can create a group, change its name or its short name, delete an empty group, and select several groups at once to delete them or give them the same reseller plan. Resellers and customers do not see these controls; the panel also refuses the actions when somebody else tries them through the API.

Renaming a group

Choose Edit next to the group in the list. In the panel that opens you change the Name: that is what the panel shows, and you can change it freely.

The Short name is different. It is how the rest of the world points at the group: the --org flag of corecp-panel bindings … and other commands on the server, your own scripts, and API calls. Change it and those no longer find the group under the old name. So for a new short name the panel asks for a tick that says you understand that, and only then can you save. The short name stays unique (a name another group already has is refused before anything changes) and keeps the format of creation: 2 to 63 lowercase letters, digits and hyphens, starting with a letter or a digit.

Wave rules that name a group (see "Assigning servers to rollout waves", a rule on "group") follow the new name, so the group's servers stay in their wave. Every change is in the audit log with the old and the new value.

# The same from the server
corecp-panel groups rename bedrijf-a --name "Bedrijf A B.V." --config /etc/corecp-panel/panel.yaml
corecp-panel groups rename bedrijf-a --slug bedrijf-a-bv --confirm-slug --config /etc/corecp-panel/panel.yaml

Deleting a group

A group is deleted only when nothing belongs to it any more: no servers, hosting accounts, customers, users, API keys, packages, placement pools, mail-gateway configuration or switches, wave rules that name the group, invitations or server-admin assignments. The panel counts that itself, in every table that points at the group, so a delete never takes anything with it silently. When something is still in it you see how much per kind, for example "Servers: 1, API keys: 2", so you know what to move or remove first.

What does go with the group is named in the confirmation: the group's branding (and its certificate), its assistant settings and the group's own settings. They mean nothing without the group.

Three groups are never deleted: the group you are signed in from, the platform's own group (the panel's hostname, its mail and its staff belong to it), and the last group on the panel. The panel says why.

# What is in a group, and whether it can go
corecp-panel groups show bedrijf-a --config /etc/corecp-panel/panel.yaml
corecp-panel groups delete bedrijf-a --config /etc/corecp-panel/panel.yaml

Several groups at once

Tick the groups you want to handle in the list. A bar appears above it with Delete and, when there are reseller plans, Change reseller plan. You confirm once for the whole selection.

A delete goes group by group: empty groups are deleted, groups that still hold something are skipped with the same count per kind, and a group that no longer exists is listed as failed. What has been deleted stays deleted when a later group fails. Every group gets its own line in the audit log.

Change reseller plan gives the selected groups the same reseller plan, or takes the plan off. Only plans of the reseller kind can cap a group.

# The API does the same in one call: one result per group
curl -s -X POST https://panel.example.com/api/v1/organizations/bulk \
  -H 'Content-Type: application/json' -b cookies.txt -H "X-CoreCP-CSRF: $CSRF" \
  -d '{"action":"delete","organization_ids":["<id-1>","<id-2>"]}'

What the panel writes to the audit log

  • org.update, with from and to for the name and the short name.
  • org.delete, with the short name and what went with it, or — on a refusal — what was still in the group.
  • org.package.set per group on a bulk plan change, with the old and the new plan.

A change made from the server is recorded under the console's name.

See also

  • Managing users
  • Running your own hosting brand
  • API keys