ASA/FP2K¶

This section lists the services which are supported with FXOS Firepower 2000 series platform plugin. This plugin is used when os=fxos and platform=fp2k are specified.

execute

configure

fxos

fxos_mgmt

sudo

disable

enable

rommon

reload

switchto

The following generic services are also available:

send

sendline

expect

execute¶

The services fxos, fxos_mgmt, sudo, disable, enable, rommon are aliases to the execute service and are based on the generic execute implementation. You can use these methods to switch between states and/or execute commands in that state.

When the execute() method is used, there is no state change performed, the current state is left ‘as-is’ and commands are executed in the state the device is in.

For more information see execute

Example usage of the execute services:

# simple execute call
output = dev.execute("show version")

# switch state and execute
dev.fxos()
dev.execute('show version')
dev.execute('another command')

# switch state and execute combined
dev.fxos_mgmt('show version')

# bring device to rommon and execute command in rommon mode
# Note: the device will stay in rommon unless the state is switched
dev.rommon('help')

configure¶

For more information see configure

reload¶

The reload service executes a device reboot via the enable prompt. This works with console connections and with SSH based connections. When SSH is used, the service automatically disconnects and reconnects. The console output is captured and returned to the caller.

Argument	Type	Description
reload_command	str	reload command to be issued on device. default reload_command is “reboot”
reply	Dialog	additional dialogs/new dialogs which are not handled by default.
timeout	int	timeout value in sec, Default value is 600 sec

The following settings can be updated to influence the timers used:

# Timeout for console based reboot
BOOT_TIMEOUT (default: 600 seconds)

# How many seconds to wait before trying to reconnect after rebooting the device
RELOAD_WAIT (default: 420 seconds)

# How many times to try to reconnect
RELOAD_RECONNECT_ATTEMPTS (default: 3)

Example execution:

# console output is returned
output = dev.reload()

switchto¶

The switchto service is a helper method to switch between CLI states. This can be used to switch to more specific states than e.g. the fxos method.

Supported states are:

fxos
fxos scope <path>
fxos admin
fxos root (sudo)
disable
enable
rommon
sudo
config

Argument	Type	Description
to_state	str or list	target state(s) to switch to
timeout	int (default 60 sec)	timeout value for the command execution takes.

The fxos state allows to specify a scope to switch to, e.g. /system/services. See below for an example.

Example usage of the execute services:

# switch to fxos state
dev.switchto("fxos")

# switch to sudo state
dev.switchto("sudo")

# switch to specific scope in fxos state
dev.switchto("fxos scope /system/services")

# switch via several states
# this switches to fxos, then ftd and then sudo
dev.switchto(['fxos', 'sudo'])