Skip to main content

ssh-wait waits for the service to be available over ssh

Project description

ssh_wait module and ssh-wait command

ssh-wait command

Usage: ssh-wait <options> <host>

ssh-wait will wait for the service to be available
on <host>.

    --verbose
        - print progress messages
    --nowait
        - check once and exit 0 if can connect exit 1 if cannot
    --wait-limit=<limit>
        - exit 2 if service is not avaiable within <limit> seconds.
          defaults to 600.
    --service=<service>
        - check the service <service>. Can be a service
          name or a port number. Default is ssh.

ssh_wait module

ssh_wait module

  • ssh_wait( host, service='ssh', wait=True, wait_limit=600, log_fn=print )

The ssh_wait function waits for host to be available if 'wait` is True. Otherwise it will checks once and returns.

The return code to indicate status of the host:

  • 0 - success the host is accepting ssh connections
  • 1 - failed to connect to host
  • 2 - failed to connect within wait_limit seconds
  • 3 - service is not known

The service argument can be either the name of the service (as listed in /etc/services) or the port number.

By default log_fn is the print function and will be used to log messages. Pass None for log_fn to surpress all messages.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssh_wait-1.0.3.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssh_wait-1.0.3-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file ssh_wait-1.0.3.tar.gz.

File metadata

  • Download URL: ssh_wait-1.0.3.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for ssh_wait-1.0.3.tar.gz
Algorithm Hash digest
SHA256 02a7926b4792b42b26cfe3844acfeed3551e362906f249db0b0809590a1493c3
MD5 d7afcfde1fd5dadca94cdf6feb5f20fb
BLAKE2b-256 047d62eb428c31424fbb87dd944fc8654b4f0dfd608dd9f1b580be144e2dddf7

See more details on using hashes here.

File details

Details for the file ssh_wait-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: ssh_wait-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for ssh_wait-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1ce1e5035a0db6dda14b3a54c96460a209fb617b67f98b901ab01eaf3a87ed9d
MD5 26cc0de9ebc1011dfca70d80ab83cb06
BLAKE2b-256 6ae25f48184e1b65e1260df3455203b753762ca0493f0b1f2df561dc00979d22

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page