IOSXR¶
This section lists down all those services which are only specific to IOSXR. For list of all the other service please refer this: Common Services.
Important
In argument table
values in parenthesis are default values.
mandatory arguments are marked with
*.
attach_console¶
Service to attach to line card console to execute commands in. Returns a router-like object to execute commands on using python context managers.
Argument |
Type |
Description |
|---|---|---|
module_num |
str |
slot number to attach console to |
login_name |
str |
name to login with, |
default_escape_chars |
str |
default escape char, default: exit, |
change_prompt |
str |
new prompt to change to for ez automation |
timeout |
int (default 60 sec) |
timeout in sec for executing commands |
prompt |
str |
bash prompt (default # ) |
with device.attach_console('0/RP0/CPU0') as conn:
output1 = conn.execute('ls')
output2 = conn.execute('pwd')
admin_attach_console¶
Service to attach to line card console from admin bash to execute commands in. Returns a router-like object to execute commands on using python context managers.
Argument |
Type |
Description |
|---|---|---|
module_num |
str |
slot number to attach console to |
login_name |
str |
name to login with, |
default_escape_chars |
str |
default escape char, default: exit, |
change_prompt |
str |
new prompt to change to for ez automation |
timeout |
int (default 60 sec) |
timeout in sec for executing commands |
prompt |
str |
bash prompt (default |
with device.admin_attach_console('0/RP0') as conn:
output1 = conn.execute('ls')
output2 = conn.execute('pwd')
admin_bash_console¶
Service to execute commands in the router Bash from admin prompt. admin_bash_console
gives you a router-like object to execute commands on using python context
managers.
Argument |
Type |
Description |
|---|---|---|
timeout |
int (default 60 sec) |
timeout in sec for executing commands |
prompt |
str |
bash prompt (default |
with device.admin_bash_console() as bash:
output1 = bash.execute('ls')
output2 = bash.execute('pwd')
admin_console¶
Service to execute commands in admin prompt. admin_console
gives you a router-like object to execute commands on using python context
managers.
Argument |
Type |
Description |
|---|---|---|
timeout |
int (default 60 sec) |
timeout in sec for executing commands |
prompt |
str |
bash prompt (default: |
with device.admin_console() as bash:
output1 = bash.execute('show platform')
output2 = bash.execute('show version')
admin_execute¶
Service to execute commands under admin state. Has same arguments as generic execute service.
output = device.admin_execute('show version')
admin_configure¶
Service to configure device under admin-config state. Has same arguments as generic configure service.
output = device.admin_configure('no logging console')
configure_exclusive¶
Service to configure device while locking the router configuration. The system configuration can be made only from the login terminal. Has same arguments as generic configure service.
output = device.configure_exclusive('logging console disable')
Sub-Plugins¶
Spitfire¶
The spitfire sub plugin supports all services provided by :doc Common Services.
In addition to the common services spitfire also supports the following services
attach_console¶
Service to attach to line card console/Standby RP to execute commands in. Returns a router-like object to execute commands on using python context managers.This service is supported in HA as well.
Argument |
Type |
Description |
|---|---|---|
module_num |
str |
slot number to attach console to |
login_name |
str |
name to login with, |
default_escape_chars |
str |
default escape char, default: exit, |
change_prompt |
str |
new prompt to change to for ez automation |
timeout |
int (default 60 sec) |
timeout in sec for executing commands |
prompt |
str |
bash prompt (default # ) |
with device.attach_console('0/0/CPU0') as conn:
output1 = conn.execute('ls')
output2 = conn.execute('pwd')
switchto¶
Service to switch the router console to any state that user needs in order to perform his tests. The api becomes a no-op if the console is already at the state user wants to reach. This service is supported in HA as well.
The states available to switch to are :
enable
config
bmc
xr_bash
xr_run
xr_env
Argument |
Type |
Description |
|---|---|---|
target_state |
str |
target state user wants the console at |
timeout |
int (default in None) |
timeout in sec for executing commands |
device.switchto("xr_env")
.... some commands that need to be run in xr_env state ....
device.switchto("enable")