otto 0.3.6 documentation

API Reference

API Reference¶

host
- 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.RemoteHost
    - ip
    - creds
    - ne
    - name
    - user
    - neId
    - board
    - slot
    - hw_version
    - sw_version
    - term
    - is_virtual
    - docker_capable
    - transfer
    - ssh_options
    - telnet_options
    - sftp_options
    - scp_options
    - ftp_options
    - nc_options
    - 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.localHost
  - 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.transfer
- host.session
- 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.TelnetClient
    - host
    - user
    - password
    - options
    - prompt
    - connect_port
    - reader
    - writer
    - connect
      - Parameters
      - Return type
    - login
      - Return type
    - alive
    - close
      - Return type
suite
monitor
- monitor.collector
  - otto.monitor.collector.MonitorTarget
    - host
    - parsers
    - core_count
  - otto.monitor.collector.MetricCollector
    - Parameters
    - init_db
      - Return type
    - close_db
      - Return type
    - close
      - Return type
    - run
      - Parameters
      - Return type
    - add_event
      - Return type
    - delete_event
      - Return type
    - update_event
      - Return type
    - get_series
      - Return type
    - get_chart_map
      - Return type
    - get_events
      - Return type
    - get_meta
      - Return type
    - subscribe
      - Return type
    - unsubscribe
      - Return type
    - from_json
      - Return type
    - from_sqlite
      - Return type
    - export_json
      - Return type
    - to_json
      - Return type
- monitor.parsers
  - otto.monitor.parsers.MetricDataPoint
    - value
    - meta
  - otto.monitor.parsers.human_readable
    - Parameters
    - Return type
  - otto.monitor.parsers.MetricParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - core_count
    - parse
  - otto.monitor.parsers.TopCpuParser
    - Parameters
    - y_title
    - unit
    - tab
    - tab_label
    - chart
    - command
    - parse
  - otto.monitor.parsers.MemParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
  - otto.monitor.parsers.DiskParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
  - otto.monitor.parsers.LoadParser
    - y_title
    - unit
    - command
    - tab
    - tab_label
    - chart
    - parse
  - otto.monitor.parsers.register_host_parsers
    - Return type
  - otto.monitor.parsers.get_host_parsers
    - Return type
- monitor.events
  - otto.monitor.events.MonitorEvent
    - timestamp
    - label
    - source
      - Type
    - color
    - dash
      - Type
    - id
    - end_timestamp
      - Type
    - to_dict
      - Return type
- monitor.server
cli
logger
configmodule
reservations
storage
utils