Module netmiko.a10.a10_ssh
A10 support.
-
Source code
++Expand source code +
"""A10 support."""
from netmiko.cisco_base_connection import CiscoSSHConnection
@@ -58,16 +62,16 @@ Classes
class A10SSH
-(ip='', host='', username='', password=None, secret='', port=None, device_type='', verbose=False, global_delay_factor=1.0, global_cmd_verify=None, use_keys=False, key_file=None, pkey=None, passphrase=None, disabled_algorithms=None, allow_agent=False, ssh_strict=False, system_host_keys=False, alt_host_keys=False, alt_key_file='', ssh_config_file=None, conn_timeout=10, auth_timeout=None, banner_timeout=15, blocking_timeout=20, timeout=100, session_timeout=60, read_timeout_override=None, keepalive=0, default_enter=None, response_return=None, serial_settings=None, fast_cli=True, session_log=None, session_log_record_writes=False, session_log_file_mode='write', allow_auto_change=False, encoding='ascii', sock=None, auto_connect=True, delay_factor_compat=False)
+(ip: str = '', host: str = '', username: str = '', password: Optional[str] = None, secret: str = '', port: Optional[int] = None, device_type: str = '', verbose: bool = False, global_delay_factor: float = 1.0, global_cmd_verify: Optional[bool] = None, use_keys: bool = False, key_file: Optional[str] = None, pkey: Optional[paramiko.pkey.PKey] = None, passphrase: Optional[str] = None, disabled_algorithms: Optional[Dict[str, Any]] = None, allow_agent: bool = False, ssh_strict: bool = False, system_host_keys: bool = False, alt_host_keys: bool = False, alt_key_file: str = '', ssh_config_file: Optional[str] = None, conn_timeout: int = 10, auth_timeout: Optional[int] = None, banner_timeout: int = 15, blocking_timeout: int = 20, timeout: int = 100, session_timeout: int = 60, read_timeout_override: Optional[float] = None, keepalive: int = 0, default_enter: Optional[str] = None, response_return: Optional[str] = None, serial_settings: Optional[Dict[str, Any]] = None, fast_cli: bool = True, session_log: Optional[SessionLog] = None, session_log_record_writes: bool = False, session_log_file_mode: str = 'write', allow_auto_change: bool = False, encoding: str = 'ascii', sock: Optional[socket.socket] = None, auto_connect: bool = True, delay_factor_compat: bool = False)
-
-
A10 support.
+A10 support.
Initialize attributes for establishing connection to target device.
- :param ip: IP address of target device. Not required if `host` is
+ :param ip: IP address of target device. Not required if <code>host</code> is
provided.
- :param host: Hostname of target device. Not required if `ip` is
+ :param host: Hostname of target device. Not required if <code>ip</code> is
provided.
:param username: Username to authenticate against target device if
@@ -106,7 +110,7 @@ Classes
:param system_host_keys: Load host keys from the users known_hosts file.
- :param alt_host_keys: If `True` host keys will be loaded from the file specified in
+ :param alt_host_keys: If <code>True</code> host keys will be loaded from the file specified in
alt_key_file.
:param alt_key_file: SSH host key file to use (if alt_host_keys=True).
@@ -151,12 +155,12 @@ Classes
:param encoding: Encoding to be used when writing bytes to the output channel.
(default: ascii)
- :param sock: An open socket or socket-like object (such as a `.Channel`) to use for
+ :param sock: An open socket or socket-like object (such as a <code>.Channel</code>) to use for
communication to the target host (default: None).
: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.
+ (default: None). Global attribute takes precedence over function <code>cmd\_verify</code>
+ argument. Value of <code>None</code> indicates to use function <code>cmd\_verify</code> argument.
:param auto_connect: Control whether Netmiko automatically establishes the connection as
part of the object creation (default: True).
@@ -164,9 +168,11 @@ Classes
:param delay_factor_compat: Set send_command and send_command_timing back to using Netmiko
3.x behavior for delay_factor/global_delay_factor/max_loops. This argument will be
eliminated in Netmiko 5.x (default: False).
-
+
-Source code
+
+Expand source code
+
class A10SSH(CiscoSSHConnection):
"""A10 support."""
@@ -195,12 +201,14 @@ Ancestors
Methods
-def save_config(self, cmd='', confirm=False, confirm_response='')
+def save_config(self, cmd: str = '', confirm: bool = False, confirm_response: str = '') ‑> str
-
-
Not Implemented
+Not Implemented
-Source code
+
+Expand source code
+
def save_config(
self, cmd: str = "", confirm: bool = False, confirm_response: str = ""
) -> str:
@@ -209,12 +217,14 @@ Methods
-def session_preparation(self)
+def session_preparation(self) ‑> None
-
-
A10 requires to be enable mode to disable paging.
+A10 requires to be enable mode to disable paging.
-Source code
+
+Expand source code
+
def session_preparation(self) -> None:
"""A10 requires to be enable mode to disable paging."""
self._test_channel_read(pattern=r"[>#]")
@@ -303,9 +313,7 @@
-Generated by pdoc 0.6.3.
+Generated by pdoc 0.10.0.
-
-