nyx_client.circles

Module for Circles-related (i.e. ACL) definitions in Nyx.

Classes

RemoteHost	Represents a remote host on the network.
Circle	Represents a circle, which is a grouping of remote hosts.

Module Contents

class nyx_client.circles.RemoteHost

Represents a remote host on the network.

did: str

the name of the organization

name: str = ''

the name of the organization

classmethod from_dict(value)

Builds a Remote Host object from json.

Parameters:

value (dict) – a dictionary of the organization object

Returns:

RemoteHost object

Return type:

RemoteHost

class nyx_client.circles.Circle

Represents a circle, which is a grouping of remote hosts.

name: str

The name of the circle, this must be unique within your instance.

description: str | None = None

Optional description of what the circle is.

did: str | None = None

The did of the circle.

organizations: Sequence[RemoteHost] = ()

Optional list of remote organizations in the circle.

classmethod from_dict(value)

Builds a circle object from json.

Parameters:

value (dict) – a dictionary of the circle object

Returns:

Circle object

Return type:

Circle

as_dict()

Returns the object as a dictionary.

Returns:

A dictionary of the circle, that matches POST/PUT requests in the API.

Return type:

dict[str, Any]