.. _nim_vios_hc_module:


nim_vios_hc -- Check if a pair of VIOSes can be updated
=======================================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Check if a pair of Virtual I/O Servers can be updated.



Requirements
------------
The below requirements are needed on the host that executes this module.

- AIX >= 7.1 TL3
- Python >= 2.7



Parameters
----------

  action (True, str, None)
    Specifies the operation to perform.

    ``health_check`` to perform a health check.


  targets (True, list, None)
    NIM target.

    To perform a health check on dual VIOSes specify a tuple with the following format: "vios1,vios2".


  vars (optional, dict, None)
    Specifies additional parameters.





Notes
-----

.. note::
   - Requires vioshc.py available at https://github.com/aixoss/vios-health-checker.




Examples
--------

.. code-block:: yaml+jinja

    
    - name: Perform a health check on dual VIOSes vios1,vios2 and on VIOS vios3
      nim_vios_hc:
        targets:
        - vios1,vios2
        - vios3
        action: health_check



Return Values
-------------

msg (always, str, )
  Status information.


status (always, dict, )
  Status for each VIOS (dictionary key).


nim_node (always, dict, )
  NIM node info.


targets (always, list, )
  List of VIOS tuples.





Status
------




- This module is not guaranteed to have a backwards compatible interface. *[preview]*


- This module is maintained by community.



Authors
~~~~~~~

- AIX Development Team (@pbfinley1911)

