Skip to content

Shell Management

The Simple Management Protocol (SMP) Shell Management group.

ExecuteRequest

Bases: WriteRequest

Execute a shell command.

Source code in smp/shell_management.py 
10
11
12
13
14
15
16
class ExecuteRequest(message.WriteRequest):
    """Execute a shell command."""

    _GROUP_ID = header.GroupId.SHELL_MANAGEMENT
    _COMMAND_ID = header.CommandId.ShellManagement.EXECUTE

    argv: List[str]

argv: List[str] instance-attribute

ExecuteResponse

Bases: WriteResponse

Success response to a shell command execution.

Source code in smp/shell_management.py 
19
20
21
22
23
24
25
26
class ExecuteResponse(message.WriteResponse):
    """Success response to a shell command execution."""

    _GROUP_ID = header.GroupId.SHELL_MANAGEMENT
    _COMMAND_ID = header.CommandId.ShellManagement.EXECUTE

    o: str
    ret: int

o: str instance-attribute

ret: int instance-attribute

SHELL_MGMT_RET_RC

Bases: IntEnum

Return codes for the shell management group.

Source code in smp/shell_management.py 
29
30
31
32
33
34
35
36
37
38
39
40
@unique
class SHELL_MGMT_RET_RC(IntEnum):
    """Return codes for the shell management group."""

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

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

    INVALID_FORMAT = 2
    """The provided format value is not valid."""

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.

INVALID_FORMAT = 2 class-attribute instance-attribute

The provided format value is not valid.

ShellManagementErrorV1

Bases: ErrorV1

Error response to a shell command execution.

Source code in smp/shell_management.py 
43
44
45
46
class ShellManagementErrorV1(error.ErrorV1):
    """Error response to a shell command execution."""

    _GROUP_ID = header.GroupId.SHELL_MANAGEMENT

ShellManagementErrorV2

Bases: ErrorV2[SHELL_MGMT_RET_RC]

Error response to a shell command execution.

Source code in smp/shell_management.py 
49
50
51
52
class ShellManagementErrorV2(error.ErrorV2[SHELL_MGMT_RET_RC]):
    """Error response to a shell command execution."""

    _GROUP_ID = header.GroupId.SHELL_MANAGEMENT