otto documentation

API Reference

API Reference¶

host
- host.host
  - otto.host.host.get_logging_command_output_enabled
  - otto.host.host.is_dry_run
  - otto.host.host.ShellCommand
    - cmd
    - expects
    - timeout
    - log
  - otto.host.host.Host
    - log
    - id
    - name
    - resources
    - products
    - power_control
    - login
    - run
      - Parameters
      - Returns
    - exec
      - Returns
    - open_session
    - send
    - expect
      - Parameters
      - Returns
    - get
    - put
    - power
    - reboot
    - shutdown
    - is_reachable
    - wait_until_up
    - wait_until_down
    - close
    - stage
    - install
    - uninstall
    - is_installed
    - is_uninstalled
  - otto.host.host.BaseHost
    - id
    - name
    - log
    - resources
    - products
    - power_control
    - switch_user
    - as_user
    - current_user
    - login
      - Parameters
    - run
      - Parameters
      - Returns
    - exec
    - open_session
    - app_shell
    - send
    - expect
    - get
    - put
    - close
    - stage
    - install
    - uninstall
    - is_installed
    - is_uninstalled
    - power
    - reboot
    - shutdown
    - is_reachable
    - wait_until_up
    - wait_until_down
  - otto.host.host.HostFilter
    - filter
  - otto.host.host.SuppressCommandOutput
    - host
- host.remote_host
  - otto.host.remote_host.slug
  - otto.host.remote_host.make_host_id
  - otto.host.remote_host.OsType
  - otto.host.remote_host.RemoteHost
    - ip
    - element
    - id
    - logical_index
    - name
    - creds
    - resources
    - log
    - user
    - element_id
    - board
    - slot
    - hop
    - os_type
    - os_name
    - os_version
    - default_dest_dir
    - snmp
    - max_filename_len
    - interfaces
    - products
    - power_control
    - verify_connection
    - is_reachable
    - address_for
- host.unix_host
  - otto.host.unix_host.UnixHost
    - ip
    - creds
    - element
    - os_type
    - os_name
    - os_version
    - name
    - user
    - element_id
    - board
    - slot
    - hw_version
    - sw_version
    - term
    - is_virtual
    - has_bash
    - docker_capable
    - transfer
    - valid_terms
    - valid_transfers
    - impairer
    - valid_impairers
    - default_dest_dir
    - max_filename_len
    - ssh_options
    - telnet_options
    - sftp_options
    - scp_options
    - ftp_options
    - nc_options
    - command_frame
    - snmp
    - hop
    - resources
    - interfaces
    - products
    - power_control
    - log
    - log_stdout
    - toolchain
    - id
    - logical_index
    - cred
    - default_cred
    - rebuild_connections
    - verify_connection
    - close
    - exec
      - Parameters
      - Returns
    - open_session
      - Parameters
      - Returns
    - send
    - expect
    - get
    - put
    - lsmod
    - load
    - unload
    - shutdown
- host.embedded_host
  - otto.host.embedded_host.EmbeddedHost
    - ip
    - element
    - os_type
    - os_name
    - os_version
    - name
    - creds
    - user
    - element_id
    - board
    - slot
    - is_virtual
    - has_bash
    - term
    - transfer
    - valid_terms
    - valid_transfers
    - filesystem
    - command_frame
    - loader
    - default_dest_dir
    - max_filename_len
    - telnet_options
    - snmp
    - toolchain
    - hop
    - resources
    - interfaces
    - products
    - power_control
    - log
    - log_stdout
    - id
    - logical_index
    - verify_connection
    - close
    - exec
    - open_session
    - send
    - expect
    - get
    - put
    - exists
    - ls
    - rm
    - mkdir
    - cp
    - mv
    - read_file
    - write_file
    - load
    - unload
  - otto.host.embedded_host.ZephyrHost
    - ip
    - element
    - os_version
    - name
    - creds
    - user
    - element_id
    - board
    - slot
    - is_virtual
    - has_bash
    - term
    - transfer
    - valid_terms
    - valid_transfers
    - filesystem
    - loader
    - default_dest_dir
    - max_filename_len
    - telnet_options
    - snmp
    - toolchain
    - hop
    - resources
    - interfaces
    - products
    - power_control
    - log
    - log_stdout
    - id
    - logical_index
    - os_type
    - os_name
    - command_frame
- host.local_host
  - otto.host.local_host.LocalFileTransfer
  - otto.host.local_host.LocalHost
    - name
    - id
    - has_bash
    - log
    - resources
    - products
    - power_control
    - exec
    - open_session
    - send
    - expect
    - get
    - put
    - is_reachable
    - close
- host.docker_host
  - otto.host.docker_host.DockerContainerHost
    - parent
    - container_id
    - project
    - service
    - compose_project
    - name
    - id
    - is_virtual
    - has_bash
    - log
    - log_stdout
    - resources
    - products
    - power_control
    - exec
    - open_session
    - send
    - expect
    - put
    - get
    - rebuild_connections
    - close
- host.transfer
  - otto.host.transfer.BaseFileTransfer
  - otto.host.transfer.ConsoleFileTransfer
    - create
  - otto.host.transfer.EmbeddedFileTransfer
    - host_families
    - create
  - otto.host.transfer.FtpFileTransfer
    - host_families
    - create
  - otto.host.transfer.NcFileTransfer
  - otto.host.transfer.ScpFileTransfer
    - host_families
    - create
  - otto.host.transfer.SftpFileTransfer
    - host_families
    - create
  - otto.host.transfer.TftpFileTransfer
    - create
  - otto.host.transfer.TransferContext
  - otto.host.transfer.TransferProgressFactory
  - otto.host.transfer.TransferProgressHandler
  - otto.host.transfer.UnixFileTransfer
    - host_families
    - prepare
  - otto.host.transfer.aggregate_transfer
  - otto.host.transfer.build_transfer_backend
    - Raises
  - otto.host.transfer.make_rich_progress_factory
  - otto.host.transfer.make_rich_progress_handler
  - otto.host.transfer.make_transfer_progress
  - otto.host.transfer.register_transfer_backend
  - otto.host.transfer.validate_filename_lengths
- host.transfer.base
  - otto.host.transfer.base.TransferContext
  - otto.host.transfer.base.validate_filename_lengths
  - otto.host.transfer.base.aggregate_transfer
  - otto.host.transfer.base.mark_skipped
  - otto.host.transfer.base.BaseFileTransfer
  - otto.host.transfer.base.NcPortStrategy
  - otto.host.transfer.base.NcListenerCheck
- 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
    - Raises
  - otto.host.embedded_filesystem.build_filesystem
    - Raises
- host.session
  - otto.host.session.ShellSession
    - alive
    - close
    - send
    - expect
    - run_cmd
      - Parameters
      - Returns
  - otto.host.session.SshSession
    - close
  - otto.host.session.TelnetSession
    - close
  - otto.host.session.LocalSession
    - close
  - otto.host.session.HostSession
    - alive
    - current_user
    - switch_user
    - as_user
    - run
    - send
    - expect
    - close
  - otto.host.session.SessionManager
    - has_live_sessions
    - current_user
    - run_cmd
    - exec
    - open_session
    - send
    - expect
    - close_all
- host.app_shell
  - otto.host.app_shell.ParseMismatch
  - otto.host.app_shell.Parsed
    - pattern
  - otto.host.app_shell.parse_one
  - otto.host.app_shell.parse_all
  - otto.host.app_shell.apply_parse
  - otto.host.app_shell.AppShellActiveError
  - otto.host.app_shell.AppShellTimeoutError
  - otto.host.app_shell.AppShell
    - launch
    - prompt
    - quit_cmd
    - user
    - cmd_timeout
    - attach
    - cmd
- host.connections
  - otto.host.connections.TermContext
    - ip
    - creds
    - user
    - term
    - name
    - hop
    - ssh_options
    - telnet_options
    - sftp_options
    - ftp_options
  - otto.host.connections.ssh_connect
  - otto.host.connections.ConnectionManager
    - create
    - telnet_options
    - login_target
    - credentials
    - proxy_hops
    - ip
    - term
    - connected
    - has_tunnel
    - ssh
    - sftp
    - ftp
    - telnet
    - forward_port
    - close
  - otto.host.connections.TermBackend
    - cls
    - host_families
  - otto.host.connections.register_term_backend
  - otto.host.connections.build_term_backend
    - Raises
- host.login_proxy
  - otto.host.login_proxy.Cred
    - login
    - password
    - proxy
    - via
    - params
  - otto.host.login_proxy.ProxyIO
    - send
    - expect
  - otto.host.login_proxy.ProxyContext
    - target
    - via
    - host_id
  - otto.host.login_proxy.LoginProxyFn
  - otto.host.login_proxy.LoginProxy
    - fn
    - undo
  - otto.host.login_proxy.LoginProxyError
  - otto.host.login_proxy.register_login_proxy
  - otto.host.login_proxy.cred_for
  - otto.host.login_proxy.resolve_chain
  - otto.host.login_proxy.run_proxy
  - otto.host.login_proxy.run_undo
  - otto.host.login_proxy.perform_switch
- host.transport
  - otto.host.transport.HopTransport
  - otto.host.transport.SshHopTransport
    - Parameters
- host.telnet
  - otto.host.telnet.open_telnet_connection
  - otto.host.telnet.abort_console_transports
  - otto.host.telnet.TelnetClient
    - host
    - user
    - password
    - options
    - prompt
    - connect_port
    - reader
    - writer
    - connect
      - Parameters
    - login
    - alive
    - close
- host.os_profile
  - otto.host.os_profile.BaseFamily
  - otto.host.os_profile.OsProfile
    - name
    - base
    - defaults
  - otto.host.os_profile.register_host_class
    - Parameters
    - Raises
  - otto.host.os_profile.build_host_spec
  - otto.host.os_profile.registered_host_specs
  - otto.host.os_profile.build_host_class
  - otto.host.os_profile.get_host_class
  - otto.host.os_profile.register_os_profile
    - Parameters
    - Raises
  - otto.host.os_profile.build_os_profile
    - Raises
  - otto.host.os_profile.get_os_profile
  - otto.host.os_profile.registered_profile_names
- host.factory
  - otto.host.factory.create_host_from_dict
  - otto.host.factory.validate_host_dict
    - Raises
- host.command_frame
  - Built-in frames
  - otto.host.command_frame.SessionMarkers
    - begin
    - end_prefix
    - ready
    - recover
    - for_session
  - otto.host.command_frame.CommandFrame
  - otto.host.command_frame.BashFrame
  - otto.host.command_frame.ZephyrFrame
    - type_name
    - handshake
    - frame
    - recover
    - end_pattern
    - marks_begin
    - extract_retcode
    - parse_output
  - otto.host.command_frame.ZephyrSerialFrame
    - type_name
    - handshake
  - otto.host.command_frame.register_command_frame
    - Raises
  - otto.host.command_frame.build_command_frame
    - Raises
- host.daemon
  - otto.host.daemon.launch_command
  - otto.host.daemon.ps_scan_command
    - Raises
  - otto.host.daemon.parse_etime
  - otto.host.daemon.DaemonProcess
    - pid
    - age_seconds
    - token
  - otto.host.daemon.parse_ps_output
  - otto.host.daemon.kill_command
    - Raises
  - otto.host.daemon.enc
  - otto.host.daemon.dec
  - otto.host.daemon.encode_token
  - otto.host.daemon.split_token
- 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.read_gcno_version
  - otto.host.toolchain_discovery.discover_toolchain_from_gcno
    - Parameters
    - Returns
  - otto.host.toolchain_discovery.ensure_gcov_tool
- 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.interface
  - otto.host.interface.Interface
    - ip
- host.interact
  - otto.host.interact.run_ssh_login
  - otto.host.interact.run_telnet_login
- host.product
  - otto.host.product.Product
    - name
    - stage
    - install
    - uninstall
    - is_installed
  - otto.host.product.FileProduct
    - artifact
    - name
    - dest_dir
    - stage
  - otto.host.product.ProductProvider
  - otto.host.product.register_product_provider
  - otto.host.product.apply_product_providers
- host.power
  - otto.host.power.PowerState
    - ON
    - OFF
  - otto.host.power.PowerController
    - type_name
    - on
    - off
    - cycle
    - status
  - otto.host.power.CommandPowerController
    - type_name
    - on_cmd
    - off_cmd
    - status_cmd
    - status_on
    - controller
    - on
    - off
    - status
  - otto.host.power.register_power_controller
  - otto.host.power.build_power_controller
  - otto.host.power.power_control_from_spec
- host.privilege
  - otto.host.privilege.PosixPrivilege
    - switch_user
    - as_user
- host.file_ops
  - otto.host.file_ops.PosixFileOps
    - exists
    - ls
    - mkdir
    - rm
    - cp
    - mv
    - read_file
    - write_file
- host.binary_loader
  - otto.host.binary_loader.BinaryLoader
  - otto.host.binary_loader.LlextHexLoader
  - otto.host.binary_loader.register_binary_loader
  - otto.host.binary_loader.build_binary_loader
suite
- suite.suite
  - otto.suite.suite.TOptions
  - otto.suite.suite.OttoSuite
- suite.run
- suite.selection
- suite.plugin
- suite.register
- suite.expect
  - otto.suite.expect.ExpectCollector
    - Parameters
    - failures
    - expect
      - Parameters
    - reset
    - raise_if_failures
  - otto.suite.expect.expect
    - Parameters
monitor
- monitor.broadcast
  - otto.monitor.broadcast.Broadcaster
- monitor.collector
- monitor.db
- monitor.events
  - otto.monitor.events.MonitorEvent
    - timestamp
    - label
    - source
    - color
    - dash
    - id
    - end_timestamp
    - to_dict
- monitor.export
- monitor.factory
  - otto.monitor.factory.build_monitor_collector
    - Parameters
- monitor.log_sourced
- monitor.parsers
  - otto.monitor.parsers.MetricDataPoint
    - value
    - meta
  - otto.monitor.parsers.ParseContext
    - core_count
    - ts
  - otto.monitor.parsers.TimedSample
    - ts
    - series
  - otto.monitor.parsers.LogEvent
    - ts
    - fields
  - otto.monitor.parsers.TickResult
    - samples
    - events
  - otto.monitor.parsers.human_readable
    - Parameters
  - otto.monitor.parsers.MetricParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - interval
    - table_columns
    - parse
      - Parameters
      - Returns
    - parse_tick
  - otto.monitor.parsers.TopCpuParser
    - Parameters
    - y_title
    - unit
    - tab
    - tab_label
    - chart
    - command
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.MemParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.DiskParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.LoadParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.NetDevParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.SocketsParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.DiskIoParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.PerCoreCpuParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.ProcCountParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
      - Parameters
      - Returns
  - otto.monitor.parsers.register_host_parsers
  - otto.monitor.parsers.register_parsers
  - otto.monitor.parsers.default_catalog
  - otto.monitor.parsers.get_host_parsers
- monitor.rates
  - otto.monitor.rates.compute_rate
  - otto.monitor.rates.RateTracker
    - update
    - prune
- monitor.server
- monitor.session
- monitor.snmp
- monitor.store
  - otto.monitor.store.MetricStore
cli
- cli.main
- cli.invoke
- cli.registry
- cli.run
- cli.test
- cli.monitor
  - otto.cli.monitor.monitor
- cli.host
  - otto.cli.host.main
  - otto.cli.host.resolve_cli_host
- cli.cov
- cli.docker
  - otto.cli.docker.docker_callback
- cli.reservation
coverage
- coverage.reporter
- coverage.store.model
- coverage.merge
- coverage.fetcher
- coverage.renderer
  - otto.coverage.renderer.html_renderer.HtmlRenderer
    - Parameters
    - render
- coverage.capture
- coverage.validity
- coverage.tiers
- coverage.exclusions
  - otto.coverage.exclusions.scan_excluded_lines
- coverage.colors
  - otto.coverage.colors.validate_color
    - Raises
docker
- otto.docker.build_images
  - Parameters
  - Returns
- otto.docker.compose_down
- otto.docker.compose_ps
- otto.docker.compose_up
  - Parameters
- otto.docker.composed
- otto.docker.context_hash
- otto.docker.get_container_host
- otto.docker.get_user_compose_project
- otto.docker.image_full_tag
- otto.docker.image_latest_tag
- docker.build
- docker.compose
- docker.staging
models
- models.base
  - otto.models.base.OttoModel
- models.host
  - otto.models.host.ToolchainSpec
    - sysroot
    - lcov
    - gcov
    - to_runtime
  - otto.models.host.InterfaceSpec
    - ip
    - to_runtime
  - otto.models.host.CredSpec
    - login
    - password
    - proxy
    - via
    - params
    - to_cred
  - otto.models.host.HostSpec
    - ip
    - element
    - creds
    - name
    - os_type
    - os_name
    - os_version
    - user
    - element_id
    - board
    - slot
    - hop
    - is_virtual
    - has_bash
    - default_dest_dir
    - max_filename_len
    - resources
    - interfaces
    - log
    - log_stdout
    - telnet_options
    - snmp
    - toolchain
    - command_frame
    - power_control
    - labs
    - to_host
  - otto.models.host.UnixHostSpec
    - creds
    - hw_version
    - sw_version
    - valid_terms
    - valid_transfers
    - valid_impairers
    - term
    - transfer
    - impairer
    - docker_capable
    - ssh_options
    - sftp_options
    - scp_options
    - ftp_options
    - nc_options
    - to_host
  - otto.models.host.EmbeddedHostSpec
    - os_type
    - valid_terms
    - valid_transfers
    - term
    - transfer
    - filesystem
    - loader
    - to_host
  - otto.models.host.HOST_SPEC_RUNTIME_PAIRS
- models.options
- models.settings
- models.monitor
  - otto.models.monitor.MIN_INTERVAL_SECONDS
  - otto.models.monitor.validate_interval
  - otto.models.monitor.MetricPoint
    - ts
    - value
    - meta
  - otto.models.monitor.ChartSpec
    - label
    - y_title
    - unit
    - command
    - chart
    - interval
  - otto.models.monitor.TabSpec
    - id
    - label
    - metrics
    - kind
    - columns
  - otto.models.monitor.MonitorMeta
    - hosts
    - live
    - metrics
    - tabs
    - interval
  - otto.models.monitor.RowModel
  - otto.models.monitor.MetricRecord
    - timestamp
    - host
    - label
    - value
    - meta
    - source
  - otto.models.monitor.EventRecord
    - id
    - timestamp
    - end_timestamp
    - label
    - source
    - color
    - dash
  - otto.models.monitor.LogEventRecord
    - timestamp
    - host
    - tab
    - fields
  - otto.models.monitor.ElementRecord
    - id
    - type
    - description
  - otto.models.monitor.HostSnapshot
    - id
    - element
    - name
    - board
    - slot
    - hop
    - os_type
    - os_name
    - os_version
    - ip
    - interfaces
    - labs
    - is_virtual
  - otto.models.monitor.LinkEndpointSnapshot
    - host
    - interface
    - ip
    - port
  - otto.models.monitor.LinkSnapshot
    - id
    - endpoints
    - protocol
    - provenance
    - name
    - impair
  - otto.models.monitor.LabSnapshot
    - elements
    - hosts
    - links
  - otto.models.monitor.ChartSpecRecord
  - otto.models.monitor.TabSpecRecord
  - otto.models.monitor.SessionMeta
    - interval
    - charts
    - tabs
  - otto.models.monitor.SessionRecord
    - id
    - label
    - note
    - start
    - end
    - lab
    - meta
    - metrics
    - events
    - log_events
    - chart_map
  - otto.models.monitor.MonitorExport
    - format
    - sessions
  - otto.models.monitor.MonitorSessionFragment
    - format
    - session
    - metrics
    - events
    - log_events
    - deleted_event_ids
    - chart_map
    - meta
bootstrap
- otto.bootstrap.BootstrapError
- otto.bootstrap.BootstrapResult
  - env
  - repos
  - errors
- otto.bootstrap.discover
- otto.bootstrap.bootstrap
- otto.bootstrap.set_completion_names
- otto.bootstrap.get_completion_names
context
- otto.context.LIBRARY_LAB_NAME
- otto.context.HostScope
  - register
- otto.context.get_context
- otto.context.try_get_context
- otto.context.set_context
- otto.context.reset_context
- otto.context.OttoContext
- otto.context.open_context
Link
- otto.link.canonical_key
- otto.link.equivalent
- otto.link.model.Provenance
  - IMPLICIT
  - DECLARED
  - DYNAMIC
- otto.link.model.LinkEndpoint
  - host
  - interface
  - ip
  - port
- otto.link.model.make_link_id
- otto.link.model.make_static_link_id
- otto.link.model.Link
  - a
  - b
  - protocol
  - provenance
  - id
  - name
  - impair
- otto.link.derive.HostAddressing
  - ip
  - interfaces
- otto.link.derive.addressing_from_dict
- otto.link.derive.resolve_declared_links
- otto.link.derive.implicit_links
- otto.link.params.parse_time_ms
- otto.link.params.parse_percent
- otto.link.params.parse_rate
- otto.link.params.ImpairmentParams
  - delay_ms
  - jitter_ms
  - loss_pct
  - corrupt_pct
  - duplicate_pct
  - reorder_pct
  - rate
  - is_empty
  - merged_over
  - validate
  - describe
- otto.link.params.Selector
  - port
  - proto
  - describe
- otto.link.params.canonical_key
- otto.link.params.equivalent
- otto.link.impairer.FIRST_SELECTOR_BAND
- otto.link.impairer.MAX_SELECTORS
- otto.link.impairer.ScopedState
  - kind
  - whole
  - selectors
  - clean
  - whole_link
  - from_selectors
  - foreign
- otto.link.impairer.LinkImpairer
  - host_families
  - supports_selectors
  - apply_command
  - read_command
  - clear_command
  - parse_read
  - scoped_root_command
  - scoped_band_command
  - scoped_filter_commands
  - scoped_clear_selector_commands
  - scoped_read_commands
  - parse_scoped
- otto.link.impairer.register_impairer
- otto.link.impairer.build_impairer
- otto.link.netem.netem_args
- otto.link.netem.parse_qdisc_show
- otto.link.netem.parse_scoped_outputs
- otto.link.netem.NetEmImpairer
  - host_families
  - supports_selectors
  - apply_command
  - read_command
  - clear_command
  - parse_read
  - scoped_root_command
  - scoped_band_command
  - scoped_filter_commands
  - scoped_clear_selector_commands
  - scoped_read_commands
  - parse_scoped
- otto.link.placement.FlowDirection
  - A_TO_B
  - B_TO_A
- otto.link.placement.Placement
  - host_id
  - netdev
  - direction
- otto.link.placement.parse_ip_addr
- otto.link.placement.ensure_not_local_link
- otto.link.placement.ensure_not_mgmt
- otto.link.placement.ensure_not_hop_transit
- otto.link.placement.endpoint_placements
- otto.link.placement.inpath_placements
- otto.link.manage.AppliedPlacement
  - placement
  - params
  - selector
- otto.link.manage.ImpairReport
  - link_id
  - applied
- otto.link.manage.RepairReport
  - link_id
  - cleared
  - timers_cancelled
- otto.link.manage.DirectionState
  - whole
  - scoped
  - foreign
- otto.link.manage.LinkState
  - link
  - by_direction
  - impairable
  - unreachable
- otto.link.manage.find_link
- otto.link.manage.impair_link
- otto.link.manage.repair_link
- otto.link.manage.repair_all
- otto.link.manage.read_link_states
- otto.link.sentinel.IMPAIR_PS_COMMAND
- otto.link.sentinel.ImpairTimer
  - pid
  - link_id
  - netdev
  - selector
- otto.link.sentinel.encode_impair_sentinel
- otto.link.sentinel.encode_impair_sentinel_v2
- otto.link.sentinel.parse_impair_sentinel
- otto.link.sentinel.parse_impair_ps
- otto.models.link.LinkEndpointSpec
  - host
  - interface
- otto.models.link.LinkSpec
  - endpoints
  - protocol
  - name
  - impair
  - management
Tunnel
- otto.tunnel.model.Direction
  - FWD
  - REV
- otto.tunnel.model.Role
  - INGRESS
  - RELAY
  - EGRESS
- otto.tunnel.model.ProcKey
- otto.tunnel.model.TunnelHop
  - host
  - interface
- otto.tunnel.model.make_tunnel_id
- otto.tunnel.model.Tunnel
  - protocol
  - service_port
  - path
  - dest
  - id
  - expected_processes
- otto.tunnel.sentinel.ParsedSentinel
  - tunnel
  - direction
  - role
  - hop_index
  - carrier_port
- otto.tunnel.sentinel.encode_sentinel
- otto.tunnel.sentinel.parse_sentinel
- otto.tunnel.carrier.DEFAULT_CARRIER
- otto.tunnel.carrier.TunnelCarrier
  - supported_protocols
  - requirements_command
  - tools_description
  - ingress_args
  - relay_args
  - egress_args
- otto.tunnel.carrier.register_carrier
- otto.tunnel.carrier.build_carrier
- otto.tunnel.socat.FREE_PORT_PROBE_COMMAND
- otto.tunnel.socat.ingress_socat_args
- otto.tunnel.socat.relay_socat_args
- otto.tunnel.socat.egress_socat_args
- otto.tunnel.socat.parse_listening_ports
- otto.tunnel.socat.pick_free_port
- otto.tunnel.socat.SocatCarrier
  - supported_protocols
  - requirements_command
  - tools_description
  - ingress_args
  - relay_args
  - egress_args
- otto.tunnel.discovery.DISCOVERY_PS_COMMAND
- otto.tunnel.discovery.Observation
  - pid
  - age_seconds
  - parsed
- otto.tunnel.discovery.parse_process_discovery
- otto.tunnel.discovery.discover_observations
- otto.tunnel.discovery.DiscoveredTunnel
  - tunnel
  - present
  - missing
  - age_seconds
  - uncertain
  - status
- otto.tunnel.discovery.TunnelDiscovery
  - tunnels
  - unreachable
- otto.tunnel.discovery.group_observations
- otto.tunnel.discovery.discover_tunnels
- otto.tunnel.manage.ResolvedHop
  - hop
  - ip
  - host
- otto.tunnel.manage.AddedTunnel
  - tunnel
  - carrier_fwd
  - carrier_rev
- otto.tunnel.manage.add_tunnel
- otto.tunnel.manage.RemovedReport
  - removed_ids
  - killed
  - unreachable
  - survivors
- otto.tunnel.manage.remove_tunnel
- otto.tunnel.manage.remove_all_tunnels
logger
- otto.logger.formatters.format_log_time
- otto.logger.formatters.MultilineFormatter
  - format
- otto.logger.formatters.RichFormatter
  - format
  - rich
- otto.logger.mode.LogMode
  - NORMAL
  - QUIET
  - NEVER
  - rank
- otto.logger.mode.effective_mode
- otto.logger.management.verbose_floor
- otto.logger.management.set_capture_prefixes
- otto.logger.management.capture_external_loggers
- otto.logger.management.reset
- otto.logger.management.init_cli_logging
- otto.logger.management.create_output_dir
- otto.logger.management.attach_console_suppress_filter
- otto.logger.management.remove_old_logs
config
- otto.config.fleet.all_hosts
  - Parameters
  - Yields
- otto.config.fleet.do_for_all_hosts
  - Parameters
  - Returns
- otto.config.fleet.run_on_all_hosts
  - Parameters
  - Returns
- otto.config.fleet.get_host
  - Parameters
- otto.config.fleet.get_lab
- otto.config.env.validate_path
- otto.config.env.load_otto_env
- otto.config.lab.LAB_SEPARATOR
- otto.config.lab.split_lab_names
- otto.config.lab.Lab
  - name
  - resources
  - hosts
  - links
  - add_host
    - Parameters
  - static_links
  - resolve_handle
- otto.config.lab.logical_indices
- otto.config.lab.load_lab
  - Parameters
  - Returns
- otto.config.repo.DockerImage
  - name
  - dockerfile
  - context
  - target
  - build_args
- otto.config.repo.DockerCompose
- otto.config.repo.DockerSettings
- otto.config.repo.CollectedTest
  - Attributes
    - nodeid
    - name
    - path
    - cls_name
- otto.config.repo.Repo
- otto.config.repo.get_repos
- otto.config.version.Version
  - major
  - minor
  - patch
registry
- otto.registry.T
- otto.registry.caller_module
- otto.registry.Registry
  - register
    - Raises
  - get
    - Raises
  - unregister
    - Raises
  - names
  - origin
    - Raises
  - items
reservations
- Package summary
- The backend contract
- Exceptions
- The check
- Identity resolution
  - otto.reservations.identity.ResolvedIdentity
    - Attributes
      - username
      - source
  - otto.reservations.identity.resolve_username
    - Parameters
    - Returns
- Bundled backends
  - JSON backend
    - otto.reservations.json_backend.JsonReservationBackend
      - Parameters
        
        backend_name
        
        get_reserved_resources
        
        Raises
        
        who_reserved
        
        Raises
  - Null backend
    - otto.reservations.null_backend.NullReservationBackend
- Backend factory
- Extension points for implementers
labs
- otto.labs.build_lab_repository
- otto.labs.register_lab_repository
- otto.labs.LabNotFoundError
- otto.labs.protocol.LabRepository
  - load_lab
  - list_labs
    - Returns
- otto.labs.json_repository.parse_lab_sections
  - Raises
- otto.labs.json_repository.JsonFileLabRepository
  - load_lab
    - Raises
  - list_labs
- otto.labs.registry.register_lab_repository
- otto.labs.registry.get_lab_repository_class
  - Raises
- otto.labs.errors.LabRepositoryError
- otto.labs.errors.LabNotFoundError
testing
- otto.testing.assert_lab_repository_conforms
  - Parameters
- otto.testing.assert_reservation_backend_conforms
  - Parameters
examples
- otto.examples.lab_repository.ExampleLabRepository
  - Parameters
    - load_lab
      - Raises
    - list_labs
- otto.examples.reservations.ExampleReservationBackend
  - Parameters
result
- otto.result.Result
  - status
  - value
  - msg
  - is_ok
  - exit_code
- otto.result.CommandResult
- otto.result.ShellResult
  - command
  - output
- otto.result.Results
  - collect
  - only
  - first_failure
  - exit_code
utils
- otto.utils.split_on
  - Parameters
  - Returns
- otto.utils.complete_separated_list
- otto.utils.async_typer_command
- otto.utils.Arg
  - variadic
  - elem_type
  - name
  - help
- otto.utils.Opt
  - elem_type
  - name
  - help
- otto.utils.cli_exposed
- otto.utils.is_literal
- otto.utils.Status
  - Success
  - Failed
  - Error
  - Unstable
  - Skipped
  - is_ok