otto 0.4.0 documentation

host

host¶

The host package provides the core abstractions for running commands on local and remote machines.

host.host
- otto.host.host.getLoggingCommandOutputEnabled
  - Return type
- otto.host.host.isDryRun
  - Return type
- otto.host.host.setDryRun
  - Return type
- otto.host.host.ShellCommand
  - cmd
  - expects
  - timeout
- otto.host.host.RunResult
  - status
  - statuses
  - only
- otto.host.host.Host
  - log
  - id
  - resources
  - interact
    - Return type
  - run
    - Return type
  - oneshot
    - Return type
  - open_session
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - get
    - Return type
  - put
    - Return type
  - close
    - Return type
- otto.host.host.BaseHost
  - name
  - interact
    - Return type
  - run
  - oneshot
    - Return type
  - open_session
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - get
    - Return type
  - put
    - Return type
  - close
    - Return type
  - start_repeat
    - Return type
  - stop_repeat
    - Return type
  - stop_all_repeats
    - Return type
  - repeat_results
    - Return type
- otto.host.host.HostFilter
  - host
  - filter
    - Return type
- otto.host.host.SuppressCommandOutput
  - host
host.remoteHost
- otto.host.remoteHost.OsType
- otto.host.remoteHost.RemoteHost
  - ip
  - ne
  - id
  - name
  - creds
  - resources
  - log
  - user
  - neId
  - board
  - slot
  - hop
  - osType
  - osName
  - osVersion
  - default_dest_dir
  - snmp
  - max_filename_len
host.unixHost
- otto.host.unixHost.UnixHost
  - ip
  - creds
  - ne
  - osType
  - osName
  - osVersion
  - name
  - user
  - neId
  - board
  - slot
  - hw_version
  - sw_version
  - term
  - is_virtual
  - docker_capable
  - transfer
  - default_dest_dir
  - max_filename_len
  - ssh_options
  - telnet_options
  - sftp_options
  - scp_options
  - ftp_options
  - nc_options
  - snmp
  - hop
  - resources
  - log
  - log_stdout
  - toolchain
  - id
  - rebuild_connections
    - Return type
  - set_term_type
  - set_transfer_type
  - verify_connection
    - Return type
  - close
    - Return type
  - oneshot
    - Parameters
    - Return type
    - Returns
  - open_session
    - Parameters
    - Return type
    - Returns
  - send
    - Return type
  - expect
    - Return type
  - get
    - Return type
  - put
    - Return type
host.embeddedHost
- otto.host.embeddedHost.EmbeddedHost
  - ip
  - ne
  - osType
  - osName
  - osVersion
  - name
  - creds
  - user
  - neId
  - board
  - slot
  - is_virtual
  - transfer
  - filesystem
  - command_frame
  - default_dest_dir
  - max_filename_len
  - telnet_options
  - snmp
  - toolchain
  - hop
  - resources
  - log
  - log_stdout
  - id
  - verify_connection
    - Return type
  - close
    - Return type
  - oneshot
    - Return type
  - open_session
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - get
    - Return type
  - put
    - Return type
- otto.host.embeddedHost.ZephyrHost
  - ip
  - ne
  - osVersion
  - name
  - creds
  - user
  - neId
  - board
  - slot
  - is_virtual
  - transfer
  - filesystem
  - default_dest_dir
  - max_filename_len
  - telnet_options
  - snmp
  - toolchain
  - hop
  - resources
  - log
  - log_stdout
  - id
  - osType
  - osName
  - command_frame
host.localHost
- otto.host.localHost.LocalFileTransfer
- otto.host.localHost.LocalHost
  - name
  - log
  - oneshot
    - Return type
  - open_session
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - get
    - Return type
  - put
    - Return type
  - close
    - Return type
host.dockerHost
- otto.host.dockerHost.DockerContainerHost
  - parent
  - container_id
  - project
  - service
  - compose_project
  - name
  - id
  - is_virtual
  - log
  - log_stdout
  - resources
  - oneshot
    - Return type
  - open_session
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - put
    - Return type
  - get
    - Return type
  - rebuild_connections
    - Return type
  - close
    - Return type
host.transfer
- otto.host.transfer.make_rich_progress_handler
  - Return type
- otto.host.transfer.make_rich_progress_factory
  - Return type
- otto.host.transfer.make_transfer_progress
  - Return type
- otto.host.transfer.validate_filename_lengths
- otto.host.transfer.BaseFileTransfer
  - put_files
    - Return type
  - get_files
    - Return type
- otto.host.transfer.NcPortStrategy
- otto.host.transfer.NcListenerCheck
- otto.host.transfer.FileTransfer
  - prepare
    - Return type
host.embedded_transfer
- Backends
- Why console transfer is slow
- otto.host.embedded_transfer.EmbeddedTransferType
- otto.host.embedded_transfer.EmbeddedFileTransfer
host.embedded_filesystem
- Built-in variants
- otto.host.embedded_filesystem.EmbeddedFileSystem
  - Default command hooks
- otto.host.embedded_filesystem.NoFileSystem
  - type_name
  - mount
- otto.host.embedded_filesystem.FatRamFileSystem
- otto.host.embedded_filesystem.LittleFsFileSystem
  - type_name
  - mount
- otto.host.embedded_filesystem.register_filesystem
  - Return type
  - Raises
- otto.host.embedded_filesystem.build_filesystem
  - Return type
  - Raises
host.session
- otto.host.session.ShellSession
  - alive
  - close
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - run_cmd
- otto.host.session.SshSession
  - close
    - Return type
- otto.host.session.TelnetSession
  - close
    - Return type
- otto.host.session.LocalSession
  - close
    - Return type
- otto.host.session.HostSession
  - alive
  - run
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - close
    - Return type
- otto.host.session.SessionManager
  - has_live_sessions
  - run_cmd
    - Return type
  - oneshot
    - Return type
  - open_session
    - Return type
  - send
    - Return type
  - expect
    - Return type
  - close_all
    - Return type
host.connections
- otto.host.connections.TunneledFtpClient
  - connect
    - Parameters
      - host
      - port
    - Return type
- otto.host.connections.ConnectionManager
  - telnet_options
  - credentials
  - ip
  - term
  - connected
  - has_tunnel
  - ssh
    - Return type
  - sftp
    - Return type
  - ftp
    - Return type
  - telnet
    - Return type
  - forward_port
    - Return type
  - close
    - Return type
host.transport
- otto.host.transport.HopTransport
- otto.host.transport.SshHopTransport
  - Parameters
host.repeat
- otto.host.repeat.RepeatRunner
  - Parameters
    - start
      - Return type
    - stop
      - Return type
    - stop_all
      - Return type
    - get_results
      - Return type
host.telnet
- otto.host.telnet.abort_console_transports
  - Return type
- otto.host.telnet.TelnetClient
  - host
  - user
  - password
  - options
  - prompt
  - connect_port
  - reader
  - writer
  - connect
    - Parameters
    - Return type
  - login
    - Return type
  - alive
  - close
    - Return type
host.os_profile
- otto.host.os_profile.BaseFamily
- otto.host.os_profile.OsProfile
  - name
  - base
  - defaults
- otto.host.os_profile.register_host_class
  - Return type
  - Raises
- otto.host.os_profile.build_host_class
  - Return type
- otto.host.os_profile.get_host_class
  - Return type
- otto.host.os_profile.register_os_profile
- otto.host.os_profile.build_os_profile
  - Return type
  - Raises
- otto.host.os_profile.get_os_profile
  - Return type
- otto.host.os_profile.registered_profile_names
  - Return type
host.command_frame
- Built-in frames
- otto.host.command_frame.SessionMarkers
  - begin
  - end_prefix
  - ready
  - recover
  - for_session
    - Return type
- otto.host.command_frame.CommandFrame
  - type_name
  - handshake
    - Return type
  - frame
    - Return type
  - recover
    - Return type
  - end_pattern
    - Return type
  - marks_begin
    - Return type
  - parse_output
    - Return type
  - extract_retcode
    - Return type
- otto.host.command_frame.BashFrame
  - type_name
  - handshake
    - Return type
  - frame
    - Return type
  - recover
    - Return type
  - end_pattern
    - Return type
  - marks_begin
    - Return type
  - parse_output
    - Return type
  - extract_retcode
    - Return type
- otto.host.command_frame.ZephyrFrame
  - type_name
  - handshake
    - Return type
  - frame
    - Return type
  - recover
    - Return type
  - end_pattern
    - Return type
  - marks_begin
    - Return type
  - extract_retcode
    - Return type
  - parse_output
    - Return type
- otto.host.command_frame.ZephyrSerialFrame
  - type_name
  - handshake
    - Return type
- otto.host.command_frame.register_command_frame
  - Return type
  - Raises
- otto.host.command_frame.build_command_frame
  - Return type
  - Raises
host.toolchain
- otto.host.toolchain.Toolchain
  - Variables
    - sysroot
    - lcov
    - gcov
  - sysroot
  - lcov
  - gcov
  - lcov_bin
  - gcov_bin
  - compiler
host.toolchain_discovery
- otto.host.toolchain_discovery.discover_toolchain_from_gcno
- otto.host.toolchain_discovery.toolchain_from_gcov
  - Parameters
  - Return type
host.options
- otto.host.options.LocalPortForward
- otto.host.options.RemotePortForward
- otto.host.options.SocksForward
  - listen_host
  - listen_port
- otto.host.options.SshOptions
- otto.host.options.TelnetOptions
- otto.host.options.SftpOptions
  - env
  - send_env
  - extra
- otto.host.options.ScpOptions
  - preserve
  - recurse
  - block_size
  - extra
- otto.host.options.FtpOptions
- otto.host.options.NcOptions
- otto.host.options.TftpOptions
  - port
  - server_ip
  - block_size
  - timeout
- otto.host.options.SnmpOptions
  - oids
  - community
  - port
  - version
  - address
host.interact
- otto.host.interact.run_ssh_login
  - Return type
- otto.host.interact.run_telnet_login
  - Return type