forked from p15670423/monkey
Island: Add docstrings to Machine
This commit is contained in:
parent
43a53112fc
commit
ebcfe5a9fc
|
@ -12,12 +12,25 @@ MachineID: TypeAlias = PositiveInt
|
|||
|
||||
|
||||
class Machine(MutableInfectionMonkeyBaseModel):
|
||||
"""Represents machines, VMs, or other network nodes discovered by Infection Monkey"""
|
||||
|
||||
id: MachineID = Field(..., allow_mutation=False)
|
||||
"""Uniquely identifies the machine within the island"""
|
||||
|
||||
hardware_id: Optional[HardwareID]
|
||||
"""An identifier generated by the agent that uniquely identifies a machine"""
|
||||
|
||||
network_interfaces: Sequence[IPv4Interface]
|
||||
"""The machine's networking interfaces"""
|
||||
|
||||
operating_system: OperatingSystem
|
||||
"""The operating system the machine is running"""
|
||||
|
||||
operating_system_version: str
|
||||
"""The specific version of the operating system the machine is running"""
|
||||
|
||||
hostname: str
|
||||
"""The hostname of the machine"""
|
||||
|
||||
_make_immutable_sequence = validator("network_interfaces", pre=True, allow_reuse=True)(
|
||||
make_immutable_sequence
|
||||
|
|
Loading…
Reference in New Issue