Skip to main content

Groups

This article refers to SDK version v0.5.0. The current SDK version is N/A.

Mounted at client.groups. Groups organize nodes independently of clusters: a group is a label for filtering and reporting, and does not imply a shared deployment target the way a cluster does. See the Overview for narrative examples, and Nodes list for group management in Panel.

Concept

Group. A named collection of nodes an operator sets up in Barbara Panel's Nodes list, purely for filtering and reporting, with no shared deployment target implied.

Learn more

GroupsResource​

GroupsResource(client: BarbaraClient)

list​

list() -> List[Group]

get​

get(group_id: str) -> Group

create​

create(
    name: str,
    description: str,
    node_ids: List[str],
    *,
    user_ids: Optional[List[str]] = None,
) -> Group

update​

update(
    group_id: str,
    name: str,
    description: str,
    node_ids: List[str],
    *,
    user_ids: Optional[List[str]] = None,
) -> Group

delete​

delete(group_id: str) -> None

list_admin​

list_admin() -> List[Dict[str, Any]]

The admingroup shape differs from the regular group entity — kept raw rather than forced into Group.

AsyncGroupsResource​

AsyncGroupsResource(client: AsyncBarbaraClient)

list​

list() -> List[Group]

get​

get(group_id: str) -> Group

create​

create(
    name: str,
    description: str,
    node_ids: List[str],
    *,
    user_ids: Optional[List[str]] = None,
) -> Group

update​

update(
    group_id: str,
    name: str,
    description: str,
    node_ids: List[str],
    *,
    user_ids: Optional[List[str]] = None,
) -> Group

delete​

delete(group_id: str) -> None

list_admin​

list_admin() -> List[Dict[str, Any]]

Signatures above are generated from barbara-api-sdk 0.5.0 docstrings. If a new SDK release changes one, this page needs a re-sync — the surrounding prose does not update itself.