Skip to content

Statistics Management

The Simple Management Protocol (SMP) Statistics Management group.

GroupDataRequest

Bases: ReadRequest

Read the statistics group data.

Source code in smp/statistics_management.py 
12
13
14
15
16
17
18
class GroupDataRequest(smpmsg.ReadRequest):
    """Read the statistics group data."""

    _GROUP_ID = smphdr.GroupId.STATISTICS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.StatisticsManagement.GROUP_DATA

    name: str

name: str instance-attribute

GroupDataResponse

Bases: ReadResponse

Statistics group data response.

Source code in smp/statistics_management.py 
21
22
23
24
25
26
27
28
class GroupDataResponse(smpmsg.ReadResponse):
    """Statistics group data response."""

    _GROUP_ID = smphdr.GroupId.STATISTICS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.StatisticsManagement.GROUP_DATA

    name: str
    fields: Dict[str, int]

name: str instance-attribute

fields: Dict[str, int] instance-attribute

ListOfGroupsRequest

Bases: ReadRequest

List the available statistics groups.

Source code in smp/statistics_management.py 
31
32
33
34
35
class ListOfGroupsRequest(smpmsg.ReadRequest):
    """List the available statistics groups."""

    _GROUP_ID = smphdr.GroupId.STATISTICS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.StatisticsManagement.LIST_OF_GROUPS

ListOfGroupsResponse

Bases: ReadResponse

List of available statistics groups.

Source code in smp/statistics_management.py 
38
39
40
41
42
43
44
class ListOfGroupsResponse(smpmsg.ReadResponse):
    """List of available statistics groups."""

    _GROUP_ID = smphdr.GroupId.STATISTICS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.StatisticsManagement.LIST_OF_GROUPS

    stat_list: Tuple[str, ...]

stat_list: Tuple[str, ...] instance-attribute

STAT_MGMT_ERR

Bases: IntEnum

Return codes for the statistics management group.

Source code in smp/statistics_management.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@unique
class STAT_MGMT_ERR(IntEnum):
    """Return codes for the statistics management group."""

    OK = 0
    """No error, this is implied if there is no ret value in the response."""

    UNKNOWN = 1
    """Unknown error occurred."""

    ERR_INVALID_GROUP = 2
    """The provided statistic group name was not found."""

    ERR_INVALID_STAT_NAME = 3
    """The provided statistic name was not found."""

    ERR_INVALID_STAT_SIZE = 4
    """The size of the statistic cannot be handled."""

    ERR_WALK_ABORTED = 5
    """Walk through of statistics was aborted."""

OK = 0 class-attribute instance-attribute

No error, this is implied if there is no ret value in the response.

UNKNOWN = 1 class-attribute instance-attribute

Unknown error occurred.

ERR_INVALID_GROUP = 2 class-attribute instance-attribute

The provided statistic group name was not found.

ERR_INVALID_STAT_NAME = 3 class-attribute instance-attribute

The provided statistic name was not found.

ERR_INVALID_STAT_SIZE = 4 class-attribute instance-attribute

The size of the statistic cannot be handled.

ERR_WALK_ABORTED = 5 class-attribute instance-attribute

Walk through of statistics was aborted.

StatisticsManagementErrorV1

Bases: ErrorV1

Error response to a statistics management command.

Source code in smp/statistics_management.py 
70
71
72
73
class StatisticsManagementErrorV1(smperr.ErrorV1):
    """Error response to a statistics management command."""

    _GROUP_ID = smphdr.GroupId.STATISTICS_MANAGEMENT

StatisticsManagementErrorV2

Bases: ErrorV2[STAT_MGMT_ERR]

Error response to a statistics management command.

Source code in smp/statistics_management.py 
76
77
78
79
class StatisticsManagementErrorV2(smperr.ErrorV2[STAT_MGMT_ERR]):
    """Error response to a statistics management command."""

    _GROUP_ID = smphdr.GroupId.STATISTICS_MANAGEMENT