Controller: /nodeworx/updates
=============================

:Required Permissions: UPDATES

Action: ``apply``
-----------------

:Added in Version: 4.8.0-393
:Description: Apply available updates for specified packages.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``package``
     - struct (integer)
     - No*
     - 
     - 
     - 

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``channels``
--------------------

:Added in Version: 4.11.4-467
:Description: Update software channels.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``interworx_channel``
     - string
     - No*
     - stable, release, release-candidate, beta
     - stable
     - Changes the channel that InterWorx receives updates via. <ul><li><b>Release</b> - the default channel.</li><li><b>Stable</b> - The Stable channel is updated with the contents of Release after a period of stability. This applies to ALL updates - including security updates.</li><li><b>Release Candidate</b> - This channel contains features that have passed through the Beta process and are scheduled for near-future release.</li><li><b>Beta</b> - contains pre-release versions. Recommended for customers that want not-yet-released features or bug fixes, and are willing to help test and provide bug reports.</li></ul>

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``editRepository``
--------------------------

:Added in Version: 5.0.14-579
:Description: Edit a repository.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``repository``
     - string
     - Yes
     - 
     - 
     - 
   * - ``file``
     - string
     - Yes
     - 
     - 
     - 

Action: ``fail``
----------------

:Added in Version: n/a
:Description: Magic function - test for failure mechanism.

Action: ``listAvailableUpdates``
--------------------------------

:Added in Version: 4.8.0-393
:Description: Lists available updates.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
     ),
     'reply_code' => 205,
   )


Action: ``listRecentUpdates``
-----------------------------

:Added in Version: 4.8.0-393
:Description: Lists recent updates.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
     ),
     'reply_code' => 205,
   )


Action: ``listRepositories``
----------------------------

:Added in Version: 5.0.14-579
:Description: Lists software repositories.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       0 => 
       array (
         'name' => ' CentOS-7 - Base',
         'repository' => 'base',
         'is_enabled' => 1,
         'file' => '/etc/yum.repos.d/CentOS-Base.repo',
       ),
       1 => 
       array (
         'name' => ' CentOS-7 - Updates',
         'repository' => 'updates',
         'is_enabled' => 1,
         'file' => '/etc/yum.repos.d/CentOS-Base.repo',
       ),
       2 => 
       array (
         'name' => ' CentOS-7 - Extras',
         'repository' => 'extras',
         'is_enabled' => 1,
         'file' => '/etc/yum.repos.d/CentOS-Base.repo',
       ),
     ),
     'reply_code' => 205,
   )


Action: ``listUpdateChannel``
-----------------------------

:Added in Version: 5.0.14-579
:Description: Lists the current update channel for InterWorx.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 'stable',
     'reply_code' => 205,
   )


Action: ``options``
-------------------

:Added in Version: 4.7.0-339
:Description: Set auto-update options.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``osupdates``
     - integer
     - No*
     - 1, 0
     - 1
     - 
   * - ``update_email``
     - string
     - No
     - 
     - 
     - InterWorx can send an email to notify recipients that an update has occurred.

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``queryChannels``
-------------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "channels".

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'interworx_channel' => 'stable',
     ),
     'reply_code' => 205,
   )


Action: ``queryEditRepository``
-------------------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "editRepository".

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``repository``
     - string
     - Yes
     - 
     - 
     - 
   * - ``file``
     - string
     - Yes
     - 
     - 
     - 

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'repository' => 'interworx-build-test',
       'file' => '/etc/yum.repos.d/CentOS-Base.repo',
     ),
     'reply_code' => 205,
   )


Action: ``queryHistory``
------------------------

:Added in Version: 4.8.0-393
:Description: Lists history for a specific package.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``package``
     - string
     - Yes
     - 
     - 
     - 

Action: ``queryOptions``
------------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "options".

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'osupdates' => '1',
       'iworxupdates' => '##LG_ENABLED##',
       'update_email' => '',
     ),
     'reply_code' => 205,
   )


Action: ``queryUpgradeStep``
----------------------------

:Added in Version: 5.0.14-579
:Description: Check the status of an upgrade step.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``step``
     - integer
     - Yes
     - 
     - 
     - 

Action: ``reroute``
-------------------

:Added in Version: n/a
:Description: Action to re-route from the current controller to a different one.

Action: ``win``
---------------

:Added in Version: n/a
:Description: Magic function - test for testing success mechanism.