# Command-Line Interface

# Description

ImunifyAV(+) command-line interface (CLI) makes working with ImunifyAV(+) basics and features from your terminal even simpler.

# Usage

For access to the ImunifyAV agent features from the command-line interface, use the following command:

imunify-antivirus

Basic usage:

imunify-antivirus [command] [--option1] [--option2]... 

# Options

The following options are available for all commands.

# Examples

1. This command allows to show help for the start command:

   imunify-antivirus start [-h]
   

Available commands:

# Add-sudouser

This command adds a user with root privileges to the server.

Usage:

imunify-antivirus add-sudouser <userID> [--optional arguments]

Example:

This command adds the user 11XXX111 with root privileges to the server:

imunify-antivirus add-sudouser 11XXX111
OK

# Checkdb

Checks database integrity. In case database is corrupt, then this command saves backup copy of the database at /var/imunifyav and tries to restore integrity of the original database.

Usage:

imunify-antivirus checkdb [--optional arguments]

Example:

The following command checks the database integrity:

imunify-antivirus checkdb

# Check-domains

Allows to send domains list to check on ImunifyAV central server. This command requires cPanel. After domains checked, the results is available via the infected-domains command.

Usage:

imunify-antivirus check-domains [--optional arguments]

Example:

The following command sends the domains list for a check to the Imunify central server. In case there are no infected domains found on the server, you will see no output. If there are any, you will get the following output:

imunify-antivirus check-domains
'domain1.com'
'domain2.com'

# Config update

Allows to update configuration file via CLI.

Usage:

imunify-antivirus config update [configuration options]

You can find instructions on how to apply configuration changes from CLI here and configuration options can be taken from the /etc/sysconfig/imunify360/imunify360.config file.

Example:

Set the MALWARE_SCAN_INTENSITY.cpu = 5 configuration option from a command line:

imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"cpu": 5}}'

The successful output should display the configuration file content.

# Delete-sudouser

This command removes a user with root privileges from the server.

Usage:

imunify-antivirus delete-sudouser <userID> [--optional arguments]

Example:

The following command removes the user 11XXX111 with root privileges from the server.

imunify-antivirus delete-sudouser 11XXX111
OK

# Doctor

This command collects information about ImunifyAV state, generates the report and sends it to the ImunifyAV Support Team. This command can be used in case of any troubles or issues with ImunifyAV. This command will generate a key to be sent to the ImunifyAV Support Team. With that key the ImunifyAV Support Team can help with any problem as fast as possible.

Usage:

imunify-antivirus doctor [--optional arguments]

The successful output will contain the unique set of symbols, for example:

imunify-antivirus doctor
Please, provide this key:
SSXX11xXXXxxxxXX.1a1bcd1e-222f-33g3-hi44-5551k5lmn555
to Imunify360 Support Team

# Infected-domains

Allows to retrieve infected domains list.

Usage:

imunify-antivirus infected-domains [-h] [--optional arguments]

Optional arguments for list:

Example:

The following command displays the results of the check-domains command. In case there are no infected domains found on the server, you will see no output. If there are any, you will get the following output:

imunify-antivirus infected-domains
'domain1.com'
'domain2.com'

# Feature-management

Allows to manage ImunifyAV features available for users.

Usage:

imunify-antivirus feature-management [command] [--optional argument]...

Command can be one of the following:

Optional argument for the enable/disable commands can be one of the following:

The mandatory argument for the get command:

Example:

The following command enables malware cleanup feature for the user1. If the operation is successful for the user user1, you will receive the following reply:

imunify-antivirus feature-management enable --feature av --users user1
failed: []
succeeded:
- user1

# Hooks

You can read more about hooks here.

This command allows to manage hooks.

Usage:

imunify-antivirus hook [command] --event [event_name|all] [--path </path/to/hook_script>]

command can be one of the following:

Example:

The following command shows existing event handlers. If you have any hooks configured, the output will include something similar to this:

imunify-antivirus hook list --event all
Event: malware-detected, Path: /root/directory/IMAVscannereventhooks/malware_detected.py

# Login

Allows to get a token which can be used for authentication in stand-alone Imunify UI.

Usage:

imunify-antivirus login [command] [--optional arguments]

command can be one of the following:

Optional arguments for get:

Optional arguments for pam:

Example:

You can use the login get command to implement your own authorization mechanism for stand-alone ImunifyAV. For example, you can generate tokens for users which are already authorized in your system/panel, and redirect to stand-alone Imunify UI with ?token=<TOKEN> in URL. (You can also set it in localStorage: localStorage.setItem('I360_AUTH_TOKEN', '<TOKEN>');)

imunify-antivirus login get --username my-user1
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MDAyNDQwMTAuMDk5MzE5LCJ1c2VyX3R5cGUiOiJjbGllbnQiLCJ1c2VybmFtZSI6ImNsdGVzdCJ9.V_Q03hYw4dNLX5cewEb_h46hOw96KWBWP0E0ChbP3dA

# Malware

Allows to manage malware options.

Usage:

imunify-antivirus malware [command] [--optional arguments]

Available commands:

Optional arguments:

action is the second positional argument for ignore and can be one of the following:

where PATHS are the absolute paths to files or folders divided by a whitespace.

command2 is the second positional argument for the malicious command and can be one of the following:

action is the second positional argument for on-demand and can be one of the following:

The optional arguments for on-demand start and on-demand queue put are:

action is the second positional argument for suspicious and can be one of:

action is the second positional argument for user and can be one of the following:

Examples

1. The following command starts on-demand scanner for the path specified after the start command:

imunify-antivirus malware on-demand start --path /home/<username>/public_html/

2. The following command shows the example of the ignore-mask usage when you have to scan all d* folders except for the dixon77w.com and dunnrrr.com:

imunify-antivirus malware on-demand start --path='/var/www/vhosts/d*' --ignore-mask='/var/www/vhosts/dixon77w.com/*,/var/www/vhosts/dunnrrr.com/*'

3. The following command adds on-demand scans for the selected path(s) to the scan queue

imunify-antivirus malware on-demand queue put "/home/user1/some folder" "/home/user2" --file-mask="*.php"

4. The following command removes the selected scans from the scan queue

imunify-antivirus malware on-demand list        # get scan_ids for the selected scans from the malicious list
imunify-antivirus malware on-demand queue remove 84f043211dc045ae8e6d641f3b9fdb0a 8c4ee39d4d8f43e296e893940c8e791a

5. The following command stops the on-demand Malware Scanner process

imunify-antivirus malware on-demand stop

6. The following command stops the on-demand Malware Scanner process and clears the scan queue

imunify-antivirus malware on-demand stop --all

7. The following command shows how to get an extended list of malicious files for a particular user. By default, a limit value equals to 50

imunify-antivirus malware malicious list --user cltest --limit 500
CLEANED_AT  CREATED     EXTRA_DATA  FILE  HASH  ID  MALICIOUS  SCAN_ID  SCAN_TYPE  SIZE  STATUS  TYPE  USERNAME
None        1599955297  {}          /home/cltest/public_html/test/TsMeJD.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1627  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/test/TZlfnU.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1628  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/test/Ke7V8n.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1629  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/yoUq0L.php             275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1630  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/test/PKiuhY.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1631  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/public_html/Zqrsvh.php  275a021bbfb6489e54d471899f7db9d1663fc695

8. The following command adds the specified path to the Ignore List

imunify-antivirus malware ignore add /home/user1/public_html/ "/home/some user/public_html/index.php"

9. The following command lists all users and their current infection status

imunify-antivirus malware user list

The successful initiation/stopping of a scanning process or adding of ignore directories/files should give you OK in the output.

# Notifications config

Allows administrators to execute custom scripts on events execution.

Usage:

imunify-antivirus notifications-config [command] [configuration options]

command can be:

We advise administrators to use the notifications-config show to get the full config, pick what they want to edit, and feed it to the notifications-config update.

The general structure of the imunify-antivirus notifications-config show command output:

{
  "eula": null,
  "items": {
    "rules": {
      "CUSTOM_SCAN_FINISHED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "CUSTOM_SCAN_MALWARE_FOUND": {
        "SCRIPT": {
          "enabled": true,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "CUSTOM_SCAN_STARTED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": []
        }
      },
      "USER_SCAN_FINISHED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": []
        }
      },
      "USER_SCAN_MALWARE_FOUND": {
        "SCRIPT": {
          "enabled": true,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "USER_SCAN_STARTED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": []
        }
      }
    }
  },

Let's review all the options.

Rules:

• USER_SCAN_FINISHED – occurs immediately after the user scanning has finished, regardless the malware has found or not.
• USER_SCAN_MALWARE_FOUND – occurs when the malware scanning process of a user account has finished and malware found.
• USER_SCAN_STARTED – occurs immediately after the user scanning has started.
• CUSTOM_SCAN_STARTED – occurs immediately after on-demand (manual) scanning has started.
• CUSTOM_SCAN_FINISHED – occurs immediately after on-demand (manual) scanning has finished, regardless the malware has found or not.
• CUSTOM_SCAN_MALWARE_FOUND – occurs when the on-demand scanning process has finished and malware found.

Examples:

1. Enable "CUSTOM_SCAN_STARTED" triger:

# imunify-antivirus notifications-config update '{"rules": {"CUSTOM_SCAN_STARTED": {"SCRIPT": {"enabled": true}}}}'

After the successful execution, the imunify-antivirus notifications-config update command returns the full config with changes.

The imunify-antivirus notifications-config show command output after applying the example 1:

{
  "eula": null,
  "items": {
    "rules": {
      "CUSTOM_SCAN_FINISHED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "CUSTOM_SCAN_MALWARE_FOUND": {
        "SCRIPT": {
          "enabled": true,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "CUSTOM_SCAN_STARTED": {
        "SCRIPT": {
          "enabled": true,
          "scripts": []
        }
      },
      "USER_SCAN_FINISHED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": []
        }
      },
      "USER_SCAN_MALWARE_FOUND": {
        "SCRIPT": {
          "enabled": true,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "USER_SCAN_STARTED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": []
        }
      }
    }
  },

More examples:

2. Run the custom script on the USER_SCAN_FINISHED event occurrence:

imunify-antivirus notifications-config update '{"rules": {"USER_SCAN_FINISHED": {"SCRIPT": {"scripts": ["/script/my-handler.py"], "enabled": true}}}}'

After the successful execution, the imunify-antivirus notifications-config update command returns the full config with changes.

The imunify-antivirus notifications-config show command output after applying the example 2:

{
  "eula": null,
  "items": {
    "rules": {
      "CUSTOM_SCAN_FINISHED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": [
            "/root/myhook"
          ]
        }
      },
      "CUSTOM_SCAN_MALWARE_FOUND": {
        "SCRIPT": {
          "enabled": true,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "CUSTOM_SCAN_STARTED": {
        "SCRIPT": {
          "enabled": true,
          "scripts": []
        }
      },
      "USER_SCAN_FINISHED": {
        "SCRIPT": {
          "enabled": true,
          "scripts": [
            "/script/my-handler.py"
          ]
        }
      },
      "USER_SCAN_MALWARE_FOUND": {
        "SCRIPT": {
          "enabled": true,
          "scripts": [
            "/home/myhook"
          ]
        }
      },
      "USER_SCAN_STARTED": {
        "SCRIPT": {
          "enabled": false,
          "scripts": []
        }
      }
    }
  },

# Example of script to create custom scripts to use with notifications-config

There are two script examples you can download:

• Shell script
• Python script

You can use these scripts as a reference and customize them.

chown root:_imunify hook_script.sh

# Python script description

The agent generates messages of different types on hook events. The ‘if chain’ in the script calls the particular method corresponding to type of the event that came from the agent.

To unblock user sites which were scanned as clean, you can use the handle_user_scan_finished method.

Add your path to the related hook (or multiple hooks) and implement the custom logic of blocking and unblocking sites.

Also in this script you could find the way to parse JSON that come from ImunifyAV(+) and description of this JSON schema in every possible case. Such descriptions are provided by docstring of the handle methods.

# Register

Allows to register and activate ImunifyAV. You can use it in case if ImunifyAV was not activated during installation process or in case if activation key of the ImunifyAV was changed for any reason. If you do not know what is an activation key or have any problem with it then, please, read Installation Guide or contact our support team.

Usage:

imunify-antivirus register [--optional arguments] [KEY]

KEY is a positional argument:

If you will use this command without the KEY argument, then it will try to register and activate current activation key.

Example 1: The following command will register and activate Imunify360 with the provided activation key:

imunify-antivirus register IMAV250jjRRjowbjk56dGN
OK

Example 2: If you have an IP-based license, you can use IPL argument to register and activate ImunifyAV:

imunify-antivirus register IPL
OK

# Rstatus

Allows to check if ImunifyAV server license is valid.

Usage:

imunify-antivirus rstatus [--optional arguments]

An extended variation (otherwise, you receive OK if everything is fine with the license registered):

imunify-antivirus rstatus --json -v
{
  "expiration": null,
  "id": "SSXX11xXXXxxxxXX",
  "ip_license": false,
  "license": {
    "expiration": null,
    "id": "SSXX11xXXXxxxxXX",
    "ip_license": false,
    "license_type": "imunify-antivirus",
    "message": " ",
    "status": true,
    "upgrade_url": "  ",
    "user_count": 100,
    "user_limit": 2147483647
  },
  "license_type": "imunify-antivirus",
  "message": " ",
  "status": true,
  "upgrade_url": " ",
  "user_count": 100,
  "user_limit": 2147483647,
  "version": "5.1.2-1"
}

# Submit false-positive/false-negative

To submit file as false positive for analysis (if ImunifyAV considers file as a malicious but it actually isn't), you can use the following command (please make sure to specify the file name along with full path):

imunify-antivirus submit false-positive <file>

To submit file as false negative for analysis (if ImunifyAV considers file as a non-malicious but it actually does), you can use the following command (please make sure to specify the file name along with full path):

imunify-antivirus submit false-negative <file>

Optional arguments:

# Unregister

Allows to unregister and disable ImunifyAV on the server.

Usage:

imunify-antivirus unregister [--optional arguments]
OK

# Update

This command allows updating ImunifyAV malware signatures.

Usage:

imunify-antivirus update sign
OK

# Update-license

This command force updating the ImunifyAV license.

Usage:

imunify-antivirus update-license [--optional arguments]
OK

# Version

Allows to show the actual ImunifyAV version installed on the server.

Usage:

imunify-antivirus version [--optional arguments]
5.1.2-1

# How to apply changes from CLI

In order to apply changes via command-line interface (CLI), you can use the following command:

imunify-antivirus config update '{"SECTION": {"parameter": value}}'

For example, if you want to set MALWARE_SCAN_INTENSITY.cpu = 5 from a command line, then you should execute the following command:

imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"cpu": 5}}'
imunify-antivirus config update '{"MALWARE_SCANNING": {"rapid_scan": true}}'

It is also possible to apply several parameters at once.

For example:

imunify-antivirus config update '{"MALWARE_SCAN_INTENSITY": {"cpu": 5, "io": 7}}'