.. Document meta

:orphan:

.. |antsibull-internal-nbsp| unicode:: 0xA0
    :trim:

.. meta::
  :antsibull-docs: 2.26.0

.. Anchors

.. _ansible_collections.stephrobert.scaleway.rolling_reboot_role:

.. Title

stephrobert.scaleway.rolling_reboot role -- Reboot a named inventory group in batches
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This role is part of the `stephrobert.scaleway collection <https://galaxy.ansible.com/ui/repo/published/stephrobert/scaleway/>`_ (version 0.7.0).

    It is not included in ``ansible-core``.
    To check whether it is installed, run :code:`ansible-galaxy collection list`.

    To install it use: :code:`ansible\-galaxy collection install stephrobert.scaleway`.

    To use it in a playbook, specify: :code:`stephrobert.scaleway.rolling_reboot`.

.. contents::
   :local:
   :depth: 2

.. _ansible_collections.stephrobert.scaleway.rolling_reboot_role__entrypoint-main:

.. Entry point title

Entry point ``main`` -- Reboot a named inventory group in batches
-----------------------------------------------------------------

.. version_added


.. Deprecated


Synopsis
^^^^^^^^

.. Description

- Reboots one batch at a time and waits for each batch to come back before touching the next. A machine that is not running is left alone and named: a rolling reboot that starts machines has done something nobody asked for.
- The waiting is observation, never a duration. The action module watches each machine leave :literal:`running` and return, and refuses to conclude when it never saw it change.

.. Requirements


.. Options

Parameters
^^^^^^^^^^

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Parameter
    - Comments

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-main--scaleway_rolling_reboot_batch_size"></div>

      .. _ansible_collections.stephrobert.scaleway.rolling_reboot_role__parameter-main__scaleway_rolling_reboot_batch_size:

      .. rst-class:: ansible-option-title

      **scaleway_rolling_reboot_batch_size**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-main--scaleway_rolling_reboot_batch_size" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`




      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      How many machines to reboot at once. One at a time is the safe default; a larger batch is a decision.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`1`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-main--scaleway_rolling_reboot_group"></div>

      .. _ansible_collections.stephrobert.scaleway.rolling_reboot_role__parameter-main__scaleway_rolling_reboot_group:

      .. rst-class:: ansible-option-title

      **scaleway_rolling_reboot_group**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-main--scaleway_rolling_reboot_group" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`




      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The inventory group to roll through. Empty means do nothing and say so, because a roll with no target would reboot whatever the inventory happens to hold.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`""`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-main--scaleway_rolling_reboot_selector"></div>

      .. _ansible_collections.stephrobert.scaleway.rolling_reboot_role__parameter-main__scaleway_rolling_reboot_selector:

      .. rst-class:: ansible-option-title

      **scaleway_rolling_reboot_selector**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-main--scaleway_rolling_reboot_selector" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`




      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      What to roll through, said the same way everywhere: exactly one of :literal:`group`\ , :literal:`name` or :literal:`tags`\ , plus :literal:`match` set to :literal:`all` or :literal:`any` when several tags are given.

      :literal:`all` is the default, because it is the narrower selection: for an operation that writes, erring on the safe side means touching fewer machines, never more.

      An ambiguous name is refused rather than settled, and an unknown key is refused rather than selecting nothing, because a typo and an empty fleet look alike.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`{}`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-main--scaleway_rolling_reboot_wait_timeout"></div>

      .. _ansible_collections.stephrobert.scaleway.rolling_reboot_role__parameter-main__scaleway_rolling_reboot_wait_timeout:

      .. rst-class:: ansible-option-title

      **scaleway_rolling_reboot_wait_timeout**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-main--scaleway_rolling_reboot_wait_timeout" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`




      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Bound, in seconds, for the observation the action module performs on each machine. Not a sleep.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`300`

      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso





.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/stephrobert/collection-scaleway/issues"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/stephrobert/collection-scaleway"
    external: true


.. Parsing errors