Skip to content

Restore

Bases: Action

Reimages a host, removing all malicious activity.

Has flat penalty of -1, representing the downtime of the host.

Attributes:

Name Type Description
session int

the session id of the session

agent str

the name of the agent executing the action

hostname str

the name of the host targeted by this action.

Functions

__init__

__init__(session: int, agent: str, hostname: str)

Instantiates the Restore class.

Parameters:

Name Type Description Default
session int

the session id of the session

required
agent str

the name of the agent executing the action

required
hostname str

the name of the host targeted by this action.

required

execute

execute(state) -> Observation

Executes the action.

Parameters:

Name Type Description Default
state

The current CybORG state.

required

Returns:

Name Type Description
obs Observation

The observation to be returned to the user.