Controller: /nodeworx/health

Required Permissions

SETTINGS

Action: edit

Added in Version

4.7.0-339

Description

Edit Problem settings - action has conditional inputs not documented.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

code

string

Yes

CLAMAV_NOT_WORKING, EPEL_ENABLED, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, HOSTNAME_VALIDATE, IWORX_DATABASE_BACKUP_FAILED, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED

repeat_rate

string

No*

once, 0, 30, 60, 1440, 10080

1440

The repeat rate controls how often notices are sent for the conditions checked by the Problem Detectors.

run_time

string

No*

fively, fifteenly, hourly, quad_daily, daily, weekly, monthly

hourly

Controls how often the Detector is run. Detection is triggered by the InterWorx CRON jobs.

sender_address

string

No*

default

default

sender_name

string

No*

default

default

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

Action: editRecipients

Added in Version

4.7.0-339

Description

Change the recipients of a code.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

code

string

Yes

CLAMAV_NOT_WORKING, EPEL_ENABLED, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, HOSTNAME_VALIDATE, IWORX_DATABASE_BACKUP_FAILED, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED

email_recipients

struct (string)

No

2, 3, nw1, nw2, nw3

[“2”]

banner_recipients

struct (string)

No

2, 3, nw1, nw2, nw3

[“2”]

Banner notices are delivered through the InterWorx interface as a banner across the top of each screen

email_only

struct (string)

No

Add direct email addresses to send to

Action: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

Action: queryCodeHistory

Added in Version

4.7.0-339

Description

Get the code history for a specific code.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

code

string

Yes

CLAMAV_NOT_WORKING, EPEL_ENABLED, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, HOSTNAME_VALIDATE, IWORX_DATABASE_BACKUP_FAILED, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED

Action: queryCodesByEmail

Added in Version

4.8.0-393

Description

Lists codes that the given email address may recieve.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

email

string

Yes

Action: queryEdit

Added in Version

5.1.0-838

Description

Displays the information available to the action “edit”.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'repeat_rate' => '1440',
    'run_time' => 'hourly',
    'sender_address' => 'default',
    'sender_name' => 'default',
    'code' => 'CLAMAV_NOT_WORKING',
  ),
  'reply_code' => 205,
)

Action: queryEditRecipients

Added in Version

5.1.0-838

Description

Displays the information available to the action “editRecipients”.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

code

string

Yes

CLAMAV_NOT_WORKING, EPEL_ENABLED, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, HOSTNAME_VALIDATE, IWORX_DATABASE_BACKUP_FAILED, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'email_recipients' =>
    array (
      0 => '2',
    ),
    'banner_recipients' =>
    array (
      0 => '2',
    ),
    'email_only' =>
    array (
    ),
    'code' => 'CLAMAV_NOT_WORKING',
  ),
  'reply_code' => 205,
)

Action: queryHealthStatus

Added in Version

5.0.14-579

Description

Lists real-time status of detectors (actually runs each, be careful about load).

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'code' => 'CLAMAV_NOT_WORKING',
      'name' => '##LG_CLAMAV_NOT_WORKING##',
      'status' => 0,
      'type' => '##LG_PROBLEM_SYSTEM_MONITORS##',
      'message' => '',
    ),
    1 =>
    array (
      'code' => 'EPEL_ENABLED',
      'name' => '##LG_EPEL_ENABLED##',
      'status' => 0,
      'type' => '##LG_PROBLEM_SYSTEM_MONITORS##',
      'message' => '',
    ),
    2 =>
    array (
      'code' => 'EXTERNAL_NFS_CANNOT_CONNECT',
      'name' => '##LG_EXTERNAL_NFS_CANNOT_CONNECT##',
      'status' => 0,
      'type' => '##LG_PROBLEM_SYSTEM_MONITORS##',
      'message' => '',
    ),
  ),
  'reply_code' => 205,
)

Action: removeTargetFromCode

Added in Version

4.8.0-393

Description

Removes a specific target from a code. Use queryCodesByEmail() to see targets.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

code

string

Yes

CLAMAV_NOT_WORKING, EPEL_ENABLED, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, HOSTNAME_VALIDATE, IWORX_DATABASE_BACKUP_FAILED, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED

target

string

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.