Cumin 6.0.0 documentation

An automation and orchestration framework written in Python.

• Introduction
  • Cumin - An automation and orchestration framework
  • Main components
    • Query language
    • Backends
    • Transports
  • Examples
    • CLI
    • Library
• Installation
  • PyPI
  • Debian package
  • Source code
• Configuration
  • config.yaml
  • aliases.yaml
• Cumin CLI
  • Positional Arguments
  • Named Arguments
• Python API
  • CuminError
  • trace()
  • Config
  • parse_config()
  • nodeset()
  • nodeset_fromlist()
  • ensure_kerberos_ticket()
  • __version__
  • Backends
    • InvalidQueryError
    • BaseQuery
    • BaseQueryAggregator
    • Direct
    • KnownHosts
    • OpenStack
    • PuppetDB
  • Color
    • ColoredType
    • Colored
  • Grammar
    • Backend
    • INTERNAL_BACKEND_PREFIX
    • get_registered_backends()
    • grammar()
    • _import_backend()
  • Query
    • Query
  • Transport
    • Transport
  • Transports
    • Command
    • State
    • WorkerError
    • StateTransitionError
    • InvalidStateError
    • OutputsMismatchError
    • SingleOutputMissingHostsError
    • HostNotFoundError
    • SingleCommandOnlyError
    • HostState
    • Target
    • BaseWorker
    • validate_list()
    • validate_positive_integer()
    • validate_positive_float()
    • raise_error()
    • BaseExecutionProgress
    • TqdmProgressBars
    • NoProgress
    • ExecutionStatus
    • CommandOutputResult
    • HostsOutputResult
    • HostResults
    • TargetedHostsMembers
    • TargetedHostsCounters
    • TargetedHosts
    • get_targeted_hosts()
    • CommandResults
    • ExecutionResults
    • ClusterShell
• Development
  • Code Structure
    • Query and global grammar
    • Backends
  • Running tests
    • CLI output tests

• Release Notes
  • Cumin Changelog

Indices and tables

• Index

• Module Index

• Search Page