ClusterShell 1.10 documentation

ClusterShell is a High Performance Software Foundation (HPSF) Established project, under Linux Foundation Europe stewardship.

This documentation is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

Contents:

• Introduction
• Release Notes
  • Version 1.10
    • Main changes in 1.10
  • Version 1.9
    • Version 1.9.3
    • Version 1.9.2
    • Version 1.9.1
    • Main changes in 1.9
  • Version 1.8
    • Version 1.8.4
    • Version 1.8.3
    • Version 1.8.2
    • Version 1.8.1
    • Main changes in 1.8
  • Version 1.7
    • Version 1.7.3
    • Version 1.7.2
    • Version 1.7.1
    • Main changes in 1.7
• Installation
  • Requirements
  • Distribution
    • Python support overview
    • Red Hat Enterprise Linux
    • Fedora
    • openSUSE
    • Debian
    • Ubuntu
    • Installing ClusterShell the Python way
  • Source
• Configuration
  • clush
    • clush.conf
    • Run modes
  • Node groups
    • groups.conf
    • File-based group sources
    • External group sources
  • Library Defaults
    • Use case: rsh
    • Use case: Slurm
• Tools
  • clush
    • Target and filter nodes
    • Flat execution mode
    • Tree execution mode
    • Non-interactive (or one-shot) mode
    • Interactive mode
    • File copying mode
    • Reverse file copying mode
    • Run modes
    • Other options
  • clubak
    • Overview
    • Tree trace mode (-T)
  • cluset
    • Usage basics
    • Stepping and auto-stepping
    • Zero-padding
    • Leading and trailing digits
    • Arithmetic operations
    • Special operations
    • Node groups
    • Range sets
  • nodeset
    • Usage basics
    • Stepping and auto-stepping
    • Zero-padding
    • Leading and trailing digits
    • Arithmetic operations
    • Special operations
    • Node groups
    • Range sets
• Programming Guide
  • Node sets handling
    • NodeSet class
    • Node groups
    • NodeSet object serialization
  • Range sets
    • RangeSet class
    • RangeSetND class
  • Task management
    • Structure of Task
    • Using Task objects
    • Configuring explicit Shell Worker objects
  • Programming Examples
    • Remote command example (sequential mode)
    • Remote command example with live output (event-based mode)
    • check_nodes.py example script
    • Using NodeSet with Parallel Python Batch script using SLURM
• Python API
  • NodeSet
    • Usage example
    • NodeSet
    • expand()
    • fold()
    • grouplist()
    • std_group_resolver()
    • set_std_group_resolver()
  • NodeUtils
    • GroupSource
    • GroupResolver
    • GroupResolverConfig
  • RangeSet
    • RangeSet
  • RangeSetND
    • RangeSetND
  • MsgTree
    • MsgTree
  • Task
    • Task
    • task_self()
    • task_wait()
    • task_terminate()
    • task_cleanup()
  • Defaults
    • Defaults
    • DEFAULTS
  • Event
    • EventHandler
  • EngineTimer
    • EngineTimer
  • Workers
    • Worker
    • ExecWorker
    • StreamWorker
    • TreeWorker
    • WorkerRsh
    • WorkerPdsh
    • WorkerPopen
    • WorkerSsh
• Going further
  • Running the test suite
  • Bug reports
• ClusterShell Technical Charter
• Acknowledgments

Indices and tables

• Index

• Module Index

• Search Page