doc:
  short_help: Wait for ssh service to be available on a host.
  examples:
  - title: Wait for host ssh on host 'example.com' to be available (port 22).
    vars:
      host: example.com
args:
  host:
    doc:
      short_help: The name or IP address of the host.
    type: string
    required: true
  port:
    doc:
      short_help: The port ssh listens on.
    type: integer
    required: false
    default: 22
  delay:
    doc:
      short_help: Number of seconds to wait before starting to poll.
    type: integer
    required: false
    default: 0
  timeout:
    doc:
      short_help: Maximum number of seconds to wait for.
    type: integer
    required: false
    default: 300
  extra_wait_time:
    doc:
      short_help: Wait an extra amount of seconds before continuing.
    type: integer
    required: false
    default: 0
frecklets:
- frecklet:
    name: wait_for
    type: ansible-module
    desc:
      short: "wait for ssh on host '{{:: host ::}}' to become available"
    properties:
      elevated: false
      idempotent: false
      internet: false
  task:
    connection: local
  vars:
    port: '{{:: port ::}}'
    host: '{{:: host ::}}'
    search_regex: OpenSSH
    delay: '{{:: delay ::}}'
    timeout: '{{:: timeout ::}}'
- sleep:
    frecklet::skip: '{{:: extra_wait_time | true_if_equal(0) ::}}'
    time: '{{:: extra_wait_time ::}}'
meta: {}