+
+Netmiko Examples
+=======
+
+A set of common Netmiko use cases.
+
+Module netmiko.broadcom.broadcom_icos_ssh
+
+
+Source code
+import time
+from netmiko.cisco_base_connection import CiscoSSHConnection
+
+
+class BroadcomIcosSSH(CiscoSSHConnection):
+ """
+ Implements support for Broadcom Icos devices.
+ Syntax its almost identical to Cisco IOS in most cases
+ """
+
+ def session_preparation(self):
+ self._test_channel_read()
+ self.set_base_prompt()
+ self.enable()
+ self.set_base_prompt()
+ self.disable_paging()
+ self.set_terminal_width()
+
+ # Clear the read buffer
+ time.sleep(0.3 * self.global_delay_factor)
+ self.clear_buffer()
+
+ def check_config_mode(self, check_string=")#"):
+ """Checks if the device is in configuration mode or not."""
+ return super().check_config_mode(check_string=check_string)
+
+ def config_mode(self, config_command="configure"):
+ """Enter configuration mode."""
+ return super().config_mode(config_command=config_command)
+
+ def exit_config_mode(self, exit_config="exit"):
+ """Exit configuration mode."""
+ return super().exit_config_mode(exit_config=exit_config)
+
+ def exit_enable_mode(self, exit_command="exit"):
+ """Exit enable mode."""
+ return super().exit_enable_mode(exit_command=exit_command)
+
+ def save_config(self, cmd="write memory", confirm=False, confirm_response=""):
+ """Saves configuration."""
+ return super().save_config(
+ cmd=cmd, confirm=confirm, confirm_response=confirm_response
+ )Classes
+-
+
+class BroadcomIcosSSH +(ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, timeout=100, session_timeout=60, auth_timeout=None, blocking_timeout=20, banner_timeout=15, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=False, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True) +
+-
+
Implements support for Broadcom Icos devices. +Syntax its almost identical to Cisco IOS in most cases
+
+Initialize attributes for establishing connection to target device. + + :param ip: IP address of target device. Not required if `host` is + provided. + :type ip: str + + :param host: Hostname of target device. Not required if `ip` is + provided. + :type host: str + + :param username: Username to authenticate against target device if + required. + :type username: str + + :param password: Password to authenticate against target device if + required. + :type password: str + + :param secret: The enable password if target device requires one. + :type secret: str + + :param port: The destination port used to connect to the target + device. + :type port: int or None + + :param device_type: Class selection based on device type. + :type device_type: str + + :param verbose: Enable additional messages to standard output. + :type verbose: bool + + :param global_delay_factor: Multiplication factor affecting Netmiko delays (default: 1). + :type global_delay_factor: int + + :param use_keys: Connect to target device using SSH keys. + :type use_keys: bool + + :param key_file: Filename path of the SSH key file to use. + :type key_file: str + + :param pkey: SSH key object to use. + :type pkey: paramiko.PKey + + :param passphrase: Passphrase to use for encrypted key; password will be used for key + decryption if not specified. + :type passphrase: str + + :param allow_agent: Enable use of SSH key-agent. + :type allow_agent: bool + + :param ssh_strict: Automatically reject unknown SSH host keys (default: False, which + means unknown SSH host keys will be accepted). + :type ssh_strict: bool + + :param system_host_keys: Load host keys from the users known_hosts file. + :type system_host_keys: bool + :param alt_host_keys: If `True` host keys will be loaded from the file specified in + alt_key_file. + :type alt_host_keys: bool + + :param alt_key_file: SSH host key file to use (if alt_host_keys=True). + :type alt_key_file: str + + :param ssh_config_file: File name of OpenSSH configuration file. + :type ssh_config_file: str + + :param timeout: Connection timeout. + :type timeout: float + + :param session_timeout: Set a timeout for parallel requests. + :type session_timeout: float + + :param auth_timeout: Set a timeout (in seconds) to wait for an authentication response. + :type auth_timeout: float + + :param banner_timeout: Set a timeout to wait for the SSH banner (pass to Paramiko). + :type banner_timeout: float + + :param keepalive: Send SSH keepalive packets at a specific interval, in seconds. + Currently defaults to 0, for backwards compatibility (it will not attempt + to keep the connection alive). + :type keepalive: int + + :param default_enter: Character(s) to send to correspond to enter key (default: +). +:type default_enter: str
+
+:param response_return: Character(s) to use in normalized return data to represent + enter key (default: +) +:type response_return: str
+:param fast_cli: Provide a way to optimize for performance. Converts select_delay_factor + to select smallest of global and specific. Sets default global_delay_factor to .1 + (default: False) + :type fast_cli: boolean + + :param session_log: File path or BufferedIOBase subclass object to write the session log to. + :type session_log: str + + :param session_log_record_writes: The session log generally only records channel reads due + to eliminate command duplication due to command echo. You can enable this if you + want to record both channel reads and channel writes in the log (default: False). + :type session_log_record_writes: boolean + + :param session_log_file_mode: "write" or "append" for session_log file mode + (default: "write") + :type session_log_file_mode: str + + :param allow_auto_change: Allow automatic configuration changes for terminal settings. + (default: False) + :type allow_auto_change: bool + + :param encoding: Encoding to be used when writing bytes to the output channel. + (default: ascii) + :type encoding: str + + :param sock: An open socket or socket-like object (such as a `.Channel`) to use for + communication to the target host (default: None). + :type sock: socket + + :param global_cmd_verify: Control whether command echo verification is enabled or disabled + (default: None). Global attribute takes precedence over function `cmd_verify` + argument. Value of `None` indicates to use function `cmd_verify` argument. + :type global_cmd_verify: bool|None + + :param auto_connect: Control whether Netmiko automatically establishes the connection as + part of the object creation (default: True). + :type auto_connect: bool +++Source code
+
+class BroadcomIcosSSH(CiscoSSHConnection): + """ + Implements support for Broadcom Icos devices. + Syntax its almost identical to Cisco IOS in most cases + """ + + def session_preparation(self): + self._test_channel_read() + self.set_base_prompt() + self.enable() + self.set_base_prompt() + self.disable_paging() + self.set_terminal_width() + + # Clear the read buffer + time.sleep(0.3 * self.global_delay_factor) + self.clear_buffer() + + def check_config_mode(self, check_string=")#"): + """Checks if the device is in configuration mode or not.""" + return super().check_config_mode(check_string=check_string) + + def config_mode(self, config_command="configure"): + """Enter configuration mode.""" + return super().config_mode(config_command=config_command) + + def exit_config_mode(self, exit_config="exit"): + """Exit configuration mode.""" + return super().exit_config_mode(exit_config=exit_config) + + def exit_enable_mode(self, exit_command="exit"): + """Exit enable mode.""" + return super().exit_enable_mode(exit_command=exit_command) + + def save_config(self, cmd="write memory", confirm=False, confirm_response=""): + """Saves configuration.""" + return super().save_config( + cmd=cmd, confirm=confirm, confirm_response=confirm_response + )Ancestors
+ +Methods
+-
+
+def check_config_mode(self, check_string=')#') +
+-
+
Checks if the device is in configuration mode or not.
++Source code
+
+def check_config_mode(self, check_string=")#"): + """Checks if the device is in configuration mode or not.""" + return super().check_config_mode(check_string=check_string)
+ +def config_mode(self, config_command='configure') +
+-
+
Enter configuration mode.
++Source code
+
+def config_mode(self, config_command="configure"): + """Enter configuration mode.""" + return super().config_mode(config_command=config_command)
+ +def exit_config_mode(self, exit_config='exit') +
+-
+
Exit configuration mode.
++Source code
+
+def exit_config_mode(self, exit_config="exit"): + """Exit configuration mode.""" + return super().exit_config_mode(exit_config=exit_config)
+ +def exit_enable_mode(self, exit_command='exit') +
+-
+
Exit enable mode.
++Source code
+
+def exit_enable_mode(self, exit_command="exit"): + """Exit enable mode.""" + return super().exit_enable_mode(exit_command=exit_command)
+ +def save_config(self, cmd='write memory', confirm=False, confirm_response='') +
+-
+
Saves configuration.
++Source code
+
+def save_config(self, cmd="write memory", confirm=False, confirm_response=""): + """Saves configuration.""" + return super().save_config( + cmd=cmd, confirm=confirm, confirm_response=confirm_response + )
+
Inherited members
+-
+
CiscoSSHConnection: +-
+
check_enable_mode
+cleanup
+clear_buffer
+close_session_log
+commit
+disable_paging
+disconnect
+enable
+establish_connection
+find_prompt
+is_alive
+normalize_cmd
+normalize_linefeeds
+open_session_log
+paramiko_cleanup
+read_channel
+read_until_pattern
+read_until_prompt
+read_until_prompt_or_pattern
+select_delay_factor
+send_command
+send_command_expect
+send_command_timing
+send_config_from_file
+send_config_set
+session_preparation
+set_base_prompt
+set_terminal_width
+special_login_handler
+strip_ansi_escape_codes
+strip_backspaces
+strip_command
+strip_prompt
+telnet_login
+write_channel
+
+
+