Withdraw

Bases: RemoteAction

A red action that removes all the agent's sessions from a local or remote host.

Attributes:

Name	Type	Description
session	int	The source session id.
agent	str	The name of the red agent executing the action.
ip_address	IPv4Address	The ip_address of the red agent executing the action. Used within RemoteAction.
hostname	str	The name of the target host.

Functions

__init__

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

Parameters:

Name	Type	Description	Default
session	int	The source session id.	required
agent	str	The name of the red agent executing the action.	required
ip_address	IPv4Address	The ip_address of the red agent executing the action. Used within RemoteAction.	required
hostname	str	The name of the target host.	required

execute

execute(state: State) -> Observation

Removes all the agent's sessions from the target host.

Parameters:

Name	Type	Description	Default
state	State	The state of the simulated network at the current step.	required

Returns:

Name	Type	Description
obs	Observation	An observation containing an indication of the action's successful execution as True/False.