Note

You are viewing the documentation for an older release of Interworx (7.14). To see documentation for the current generally available release of Interworx, click here: 8.2.

Controller: /nodeworx/updates

Required Permissions

UPDATES

Action: apply

Added in Version

4.8.0-393

Description

Apply available updates for specified packages.

Input Parameters

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

Name	Type	Required?	Example Values	Default Values	Notes
interworx_channel	string	No*	base, ga, rc, beta	base	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

Name	Type	Required?	Example Values	Default Values	Notes
repository	string	Yes
file	string	Yes	/etc/yum.repos.d/MariaDB.repo, /etc/yum.repos.d/Rocky-AppStream.repo, /etc/yum.repos.d/Rocky-BaseOS.repo, /etc/yum.repos.d/Rocky-Debuginfo.repo, /etc/yum.repos.d/Rocky-Devel.repo, /etc/yum.repos.d/Rocky-Extras.repo, /etc/yum.repos.d/Rocky-HighAvailability.repo, /etc/yum.repos.d/Rocky-Media.repo, /etc/yum.repos.d/Rocky-NFV.repo, /etc/yum.repos.d/Rocky-Plus.repo, /etc/yum.repos.d/Rocky-PowerTools.repo, /etc/yum.repos.d/Rocky-RT.repo, /etc/yum.repos.d/Rocky-ResilientStorage.repo, /etc/yum.repos.d/Rocky-Sources.repo, /etc/yum.repos.d/epel-modular.repo, /etc/yum.repos.d/epel-testing-modular.repo, /etc/yum.repos.d/epel-testing.repo, /etc/yum.repos.d/epel.repo, /etc/yum.repos.d/gh-cli.repo, /etc/yum.repos.d/google-chrome.repo, /etc/yum.repos.d/interworx-7.repo, /etc/yum.repos.d/interworx-hotfix.repo, /etc/yum.repos.d/interworx-rpm-streams.repo, /etc/yum.repos.d/iworx-build-test.repo, /etc/yum.repos.d/remi-modular.repo, /etc/yum.repos.d/remi-safe.repo, /etc/yum.repos.d/remi.repo

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

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

Action: listRecentUpdates

Added in Version

4.8.0-393

Description

Lists recent updates.

Sample Output

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

Action: listRepositories

Added in Version

5.0.14-579

Description

Lists software repositories.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'name' => ' MariaDB 10.6',
      'repository' => 'mariadb-10.6',
      'is_enabled' => 1,
      'file' => '/etc/yum.repos.d/MariaDB.repo',
    ),
    1 =>
    array (
      'name' => ' Rocky Linux 8 - AppStream',
      'repository' => 'appstream',
      'is_enabled' => 1,
      'file' => '/etc/yum.repos.d/Rocky-AppStream.repo',
    ),
    2 =>
    array (
      'name' => ' Rocky Linux 8 - BaseOS',
      'repository' => 'baseos',
      'is_enabled' => 1,
      'file' => '/etc/yum.repos.d/Rocky-BaseOS.repo',
    ),
  ),
  'reply_code' => 205,
)

Action: listUpdateChannel

Added in Version

5.0.14-579

Description

Lists the current update channel for InterWorx.

Sample Output

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

Action: options

Added in Version

4.7.0-339

Description

Set auto-update options.

Input Parameters

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

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

Action: queryEditRepository

Added in Version

5.1.0-838

Description

Displays the information available to the action “editRepository”.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
repository	string	Yes
file	string	Yes	/etc/yum.repos.d/MariaDB.repo, /etc/yum.repos.d/Rocky-AppStream.repo, /etc/yum.repos.d/Rocky-BaseOS.repo, /etc/yum.repos.d/Rocky-Debuginfo.repo, /etc/yum.repos.d/Rocky-Devel.repo, /etc/yum.repos.d/Rocky-Extras.repo, /etc/yum.repos.d/Rocky-HighAvailability.repo, /etc/yum.repos.d/Rocky-Media.repo, /etc/yum.repos.d/Rocky-NFV.repo, /etc/yum.repos.d/Rocky-Plus.repo, /etc/yum.repos.d/Rocky-PowerTools.repo, /etc/yum.repos.d/Rocky-RT.repo, /etc/yum.repos.d/Rocky-ResilientStorage.repo, /etc/yum.repos.d/Rocky-Sources.repo, /etc/yum.repos.d/epel-modular.repo, /etc/yum.repos.d/epel-testing-modular.repo, /etc/yum.repos.d/epel-testing.repo, /etc/yum.repos.d/epel.repo, /etc/yum.repos.d/gh-cli.repo, /etc/yum.repos.d/google-chrome.repo, /etc/yum.repos.d/interworx-7.repo, /etc/yum.repos.d/interworx-hotfix.repo, /etc/yum.repos.d/interworx-rpm-streams.repo, /etc/yum.repos.d/iworx-build-test.repo, /etc/yum.repos.d/remi-modular.repo, /etc/yum.repos.d/remi-safe.repo, /etc/yum.repos.d/remi.repo

Sample Output

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

Action: queryHistory

Added in Version

4.8.0-393

Description

Lists history for a specific package.

Input Parameters

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

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

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.