Automox

Administrate your IT organization from XSOAR with comprehensive commands for the Automox platform.

Endpoint · Automox

Details

IDAutomox
ProviderAutomox Inc
CategoryEndpoint
From Version6.0.0
Docker Imagedemisto/python3:3.12.13.10116658
Supported ModulesAgentix XSIAM

README

Use the Automox integration to create device groups, update devices, run policies, and remediate vulnerabilities of devices through the Automox platform.
This integration was integrated and tested as of 2022-03-21 with the Automox API

Configure Automox in Cortex

Parameter Description Required
Organization ID A comma-separated list of organization ids. When specified, data pulled from Automox will only belong to this organization; otherwise, the default permissions for this API key will be used. False
API Key The API Key to use for connection True
Trust any certificate (not secure)   False
Use system proxy settings   False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

automox-devices-list

List all devices in Automox based on group and organization permissions.

Base Command

automox-devices-list

Input

Argument Name Description Required
org_id Organization ID. Optional
group_id Group ID. Optional
limit The maximum number of results to return per page. Default is 50. Optional
page The page of results to return. Optional

Context Output

Path Type Description
Automox.Devices.id Number Identifier of device
Automox.Devices.server_group_id Number Identifier of server group
Automox.Devices.organization_id Number Identifier of organization
Automox.Devices.uuid String The Automox UUID of a device
Automox.Devices.name String The name of a device
Automox.Devices.refresh_interval Number Frequency of device refreshes in minutes
Automox.Devices.last_update_time String The last time a device was updated in Automox
Automox.Devices.last_refresh_time String The last time a device was refreshed in Automox
Automox.Devices.uptime Number The device uptime in minutes
Automox.Devices.needs_reboot Boolean Whether a device needs to be rebooted
Automox.Devices.timezone String The device timezone
Automox.Devices.tags String List of tags for the device
Automox.Devices.deleted Boolean Whether a device is deleted
Automox.Devices.create_time Date The time a device was created in Automox
Automox.Devices.os_version String The operating system version of a device
Automox.Devices.os_name String The operating system name of a device
Automox.Devices.os_family String the operating system family of a device
Automox.Devices.ip_addrs String List of IP addresses for a device
Automox.Devices.ip_addrs_private String List of private IP addresses for a device
Automox.Devices.patches Number The number of patches currently identified for a device
Automox.Devices.agent_version String The version of the Automox agent on the device
Automox.Devices.custom_name String The Automox specific custom name for the device
Automox.Devices.is_compatible Boolean Whether a device is compatible with Automox
Automox.Devices.policy_status.id Number Identifier of policy
Automox.Devices.policy_status.organization_id Number Identifier of organization
Automox.Devices.policy_status.policy_name String Name of the policy
Automox.Devices.policy_status.policy_type_name String Type of the policy
Automox.Devices.policy_status.status Number Current status of the policy
Automox.Devices.policy_status.result String Result of the policy
Automox.Devices.policy_status.create_time Datetime Policy created datetime
Automox.Devices.last_scan_failed Boolean Whether the last scan failed on a device
Automox.Devices.pending Boolean Whether work is pending on a device
Automox.Devices.compliant Boolean Whether a device is compliant
Automox.Devices.display_name String The display name of a device
Automox.Devices.commands.command_type_name String The type of a command previously issued on a device
Automox.Devices.commands.args String The arguments of a command previously issued on a device
Automox.Devices.commands.exec_time Date The execution time of a command previously issued on a device
Automox.Devices.pending_patches Number The number of pending patches for a device
Automox.Devices.connected Boolean Whether a device is currently connected to Automox
Automox.Devices.last_process_time String The last time the device was processed
Automox.Devices.next_patch_time String The next time the device is patched
Automox.Devices.notification_count Number The number of notifications for the device
Automox.Devices.reboot_notification_count Number The number of reboot notifications for a device
Automox.Devices.patch_deferral_count Number The number of patch deferrals for a device
Automox.Devices.is_delayed_by_notification Boolean Whether a patch is delayed by notifications
Automox.Devices.reboot_is_delayed_by_notification Boolean Whether a reboot is delayed by notifications
Automox.Devices.is_delayed_by_user Boolean Whether a patch is delayed by the user
Automox.Devices.reboot_is_delayed_by_user Boolean Whether a reboot is delayed by the user
Automox.Devices.last_disconnect_time Date Last time a device disconnected from Automox
Automox.Devices.needs_attention Boolean Whether a device currently needs attention
Automox.Devices.serial_number String The device serial number
Automox.Devices.status.device_status String The status of a device
Automox.Devices.status.agent_status String The status of a device agent
Automox.Devices.status.policy_status String The overall status of all policies assigned to a device
Automox.Devices.status.policy_statuses.id Number The identifier of the policy
Automox.Devices.status.policy_statuses.compliant Boolean Whether a device is compliant to a given status
Automox.Devices.last_logged_in_user String The last logged in user of a device

Command Example

!automox-devices-list limit=1

Context Example

{
    "Automox": {
        "Devices": {
            "agent_version": "string",
            "commands": [
                {
                    "command_type_name": "InstallUpdate",
                    "args": "KB12345 KB67890",
                    "exec_time": "2017-06-29T16:39:50.951Z"
                }
            ],
            "compliant": true,
            "connected": true,
            "create_time": "2019-08-24T14:15:22Z",
            "custom_name": "string",
            "deleted": true,
            "display_name": "string",
            "exception": true,
            "id": 0,
            "ip_addrs": [
                "string"
            ],
            "ip_addrs_private": [
                "string"
            ],
            "is_compatible": true,
            "is_delayed_by_notification": true,
            "is_delayed_by_user": true,
            "last_disconnect_time": "2019-08-24T14:15:22Z",
            "last_logged_in_user": "string",
            "last_process_time": "string",
            "last_refresh_time": "string",
            "last_scan_failed": true,
            "last_update_time": "string",
            "name": "string",
            "needs_attention": true,
            "needs_reboot": true,
            "next_patch_time": "string",
            "notification_count": 0,
            "organization_id": 0,
            "os_family": "string",
            "os_name": "string",
            "os_version": "string",
            "patch_deferral_count": 0,
            "patches": 0,
            "pending": true,
            "pending_patches": 0,
            "policy_status": [
                {
                    "id": 0,
                    "organization_id": 0,
                    "policy_id": 0,
                    "server_id": 0,
                    "policy_name": "string",
                    "policy_type_name": "patch",
                    "status": 0,
                    "result": "string",
                    "create_time": "string"
                }
            ],
            "reboot_is_delayed_by_notification": true,
            "reboot_is_delayed_by_user": true,
            "reboot_notification_count": 0,
            "refresh_interval": 0,
            "serial_number": "string",
            "server_group_id": 0,
            "status": {
                "device_status": "string",
                "agent_status": "string",
                "policy_status": "string",
                "policy_statuses": [
                    {
                        "id": 0,
                        "compliant": true
                    }
                ]
            },
            "tags": [
                "string"
            ],
            "timezone": "string",
            "total_count": 0,
            "uptime": 0,
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
        }
    }
}

Human Readable Output

Devices

agent_version commands compliant connected create_time custom_name deleted display_name exception id ip_addrs ip_addrs_private is_compatible is_delayed_by_notification is_delayed_by_user last_disconnect_time last_logged_in_user last_process_time last_refresh_time last_scan_failed last_update_time name needs_attention needs_reboot next_patch_time notification_count organization_id os_family os_name os_version patch_deferral_count patches pending pending_patches policy_status reboot_is_delayed_by_notification reboot_is_delayed_by_user reboot_notification_count refresh_interval serial_number server_group_id status tags timezone total_count uptime uuid
string command_type_name: InstallUpdate
args: KB12345 KB67890
exec_time: 2017-06-29T16:39:50.951Z		 true true 2019-08-24T14:15:22Z string true string true 0 1.1.1.1 1.1.1.1 true true true 2019-08-24T14:15:22Z string string string true string string true true string 0 0 string string string 0 0 true 0 id: 0
organization_id: 0
policy_id: 0
server_id: 0
policy_name: string
policy_type_name: patch
status: 0
result: string
create_time: string		 true true 0 0 string 0 {“device_status”: “string”,”agent_status”: “string”,”policy_status”: “string”,”policy_statuses”: [{“id”: 0,”compliant”: true}]} string string 0 0 095be615-a8ad-4c33-8e9c-c7612fbf6c9f

automox-organizations-list

List all Automox organizations based on user permissions.

Base Command

automox-organizations-list

Input

Argument Name Description Required
limit The maximum number of results to return per page. Default is 50. Optional
page The page of results to return. Optional

Context Output

Path Type Description
Automox.Organizations.id Number Identifier of organization
Automox.Organizations.name String Name of organization
Automox.Organizations.create_time Date The datetime when the organization was created
Automox.Organizations.server_limit Number The organization server limit
Automox.Organizations.parent_id Number The organization parent id
Automox.Organizations.device_limit Number The organization device limit
Automox.Organizations.device_count Number The organization device count

Command example

!automox-organizations-list limit=1

Context Example

{
    "Automox": {
        "Organizations": {
            "create_time": "2019-08-27T21:59:19+0000",
            "device_count": 26,
            "device_limit": null,
            "id": 9237,
            "name": "string",
            "parent_id": 65,
            "server_limit": 0
        }
    }
}

Human Readable Output

Organizations

create_time device_count device_limit id name parent_id server_limit
2019-08-27T21:59:19+0000 26   9237 string 65 0

automox-organization-users-list

List all Automox users within an organization.

Base Command

automox-organization-users-list

Input

Argument Name Description Required
org_id Organization identifier. Optional
limit The maximum number of results to return per page. Default is 50. Optional
page The page of results to return. Optional

Context Output

Path Type Description
Automox.Users.id Number Identifier of user
Automox.Users.firstname String The first name of the user
Automox.Users.lastname String The last name of the user
Automox.Users.email String The email of the user
Automox.Users.orgs.id Number Identifier of organization
Automox.Users.orgs.name String Name of organization
Automox.Users.tags String User tags
Automox.Users.saml_enabled Boolean Whether SAML has been enabled for the user
Automox.Users.rbac_roles.id Number The RBAC role identifier
Automox.Users.rbac_roles.name String The RBAC role name
Automox.Users.rbac_roles.organization_id Number Identifier of organization

Command example

!automox-organization-users-list limit=1

Context Example

{
    "Automox": {
        "Users": {
            "email": "string",
            "firstname": "string",
            "id": 1,
            "lastname": "string",
            "orgs": [
                {
                    "id": 1,
                    "name": "string"
                }
            ],
            "rbac_roles": [
                {
                    "id": 0,
                    "name": "string",
                    "organization_id": 1
                }
            ],
            "saml_enabled": true,
            "tags": [
                "string"
            ]
        }
    }
}

Human Readable Output

Organization Users
id firstname lastname email orgs tags saml_enabled rbac_roles
0 string string string id: 0
name: string		 string true id: 0
name: string
organization_id: 0

automox-vulnerability-sync-batch-action

Perform an action on an Automox Vulnerability Sync batch.

Base Command

automox-vulnerability-sync-batch-action

Input

Argument Name Description Required
org_id Organization identifier. Optional
batch_id Batch identifier. Required
action Action to perform on the batch specified. Options are “accept” or “reject”. Possible values are: accept, reject. Required

Context Output

There is no context output for this command.

automox-vulnerability-sync-task-action

Perform an action on an Automox task.

Base Command

automox-vulnerability-sync-task-action

Input

Argument Name Description Required
org_id Organization identifier. Optional
batch_id Batch identifier. Required
action Action to perform on the batch specified. Options are “accept” or “reject”. Possible values are: accept, reject. Required

Context Output

There is no context output for this command.

automox-vulnerability-sync-batch-get

Get details about a Vulnerability Sync batch.

Base Command

automox-vulnerability-sync-batch-get

Input

Argument Name Description Required
org_id Organization identifier. Optional
batch_id Batch identifier. Required

Context Output

Path Type Description
Automox.VulnSyncBatch.id Number Identifier of batch
Automox.VulnSyncBatch.organization_id Number Identifier of organization
Automox.VulnSyncBatch.status String Status of batch
Automox.VulnSyncBatch.source String Originating vendor of vulnerability information
Automox.VulnSyncBatch.created_by.id Number The identifier of the user who created this batch
Automox.VulnSyncBatch.created_by.firstname String The first name of the user who created this batch
Automox.VulnSyncBatch.created_by.lastname String The last name of the user who created this batch
Automox.VulnSyncBatch.created_by.email String The email of the user who created this batch
Automox.VulnSyncBatch.updated_by.id Number The identifier of the user who last updated this batch
Automox.VulnSyncBatch.updated_by.firstname String The first name of the user who last updated this batch
Automox.VulnSyncBatch.updated_by.lastname String The last name of the user who last updated this batch
Automox.VulnSyncBatch.updated_by.email String The email of the user who last updated this batch
Automox.VulnSyncBatch.uploaded_at Date Datetime of initial upload
Automox.VulnSyncBatch.task_count Number Number of tasks related to batch
Automox.VulnSyncBatch.unknown_host_count Number Number of hosts that are unknown within batch
Automox.VulnSyncBatch.impacted_device_count Number Number of devices impacted by batch
Automox.VulnSyncBatch.issue_count Number Number of issues identified with batch
Automox.VulnSyncBatch.cve_count Number Number of CVEs impacted by batch

Command Example

!automox-vulnerability-sync-batch-get batch_id=1

Context Example

{
    "Automox": {
        "Batch": {
            "created_by": {
                "id": 0,
                "firstname": "string",
                "lastname": "string",
                "email": "string"
            },
            "cve_count": 0,
            "id": 1,
            "impacted_device_count": 0,
            "issue_count": 0,
            "organization_id": 1,
            "source": "string",
            "status": "processing",
            "task_count": 0,
            "unknown_host_count": 0,
            "updated_by": {
                "id": 0,
                "firstname": "string",
                "lastname": "string",
                "email": "string"
            },
            "uploaded_at": "2019-08-24T14:15:22Z"
        }
    }
}

Human Readable Output

Batch

created_by cve_count id impacted_device_count issue_count organization_id source status task_count unknown_host_count updated_by uploaded_at
id: 0
firstname: string
lastname: string
email: string
 0 1 0 0 1 string processing 0 0 id: 0
firstname: string
lastname: string
email: string
 2019-08-24T14:15:22Z

automox-vulnerability-sync-batches-list

Get a list of Vulnerability Sync batches.

Base Command

automox-vulnerability-sync-batches-list

Input

Argument Name Description Required
org_id Organization identifier. Optional
limit The maximum number of results to return per page. Default is 50. Optional
page The page of results to return. Optional

Context Output

Path Type Description
Automox.VulnSyncBatches.id Number Identifier of batch
Automox.VulnSyncBatches.organization_id Number Identifier of organization
Automox.VulnSyncBatches.status String Status of batch
Automox.VulnSyncBatches.source String Source of batch
Automox.VulnSyncBatches.created_by.id Number Identifier of user who created the batch
Automox.VulnSyncBatches.created_by.firstname String First name of the user who created the batch
Automox.VulnSyncBatches.created_by.lastname String Last name of the user who created the batch
Automox.VulnSyncBatches.created_by.email String Email of the user who created the batch
Automox.VulnSyncBatches.updated_by.id Number Identifier of the user who last updated the batch
Automox.VulnSyncBatches.updated_by.firstname String First name of the user who last updated the batch
Automox.VulnSyncBatches.updated_by.lastname String Last name of the user who last updated the batch
Automox.VulnSyncBatches.updated_by.email String Email off the user who last updated the batch
Automox.VulnSyncBatches.uploaded_at Date Datetime the batch was uploaded
Automox.VulnSyncBatches.task_count Number Number of tasks related to batch
Automox.VulnSyncBatches.unknown_host_count Number number of hosts that are unknown within batch
Automox.VulnSyncBatches.impacted_device_count Number Number of devices that are impacted by batch
Automox.VulnSyncBatches.issue_count Number Number of issues identified with batch
Automox.VulnSyncBatches.cve_count Number Number of CVEs that are impacted by batch

Command example

!automox-vulnerability-sync-batches-list limit=1

Context Example

{
    "Automox": {
        "VulnSyncBatches": {
            "created_by": {
                "id": 0,
                "firstname": "string",
                "lastname": "string",
                "email": "string"
            },
            "cve_count": 0,
            "id": 1,
            "impacted_device_count": 0,
            "issue_count": 0,
            "organization_id": 1,
            "source": "string",
            "status": "processing",
            "task_count": 0,
            "unknown_host_count": 0,
            "updated_by": {
                "id": 0,
                "firstname": "string",
                "lastname": "string",
                "email": "string"
            },
            "uploaded_at": "2019-08-24T14:15:22Z"
        }
    }
}

Human Readable Output

Batches

created_by cve_count id impacted_device_count issue_count organization_id source status task_count unknown_host_count updated_by uploaded_at
id: 0
firstname: string
lastname: string
email: string
 0 1 0 0 1 string processing 0 0 id: 0
firstname: string
lastname: string
email: string
 2019-08-24T14:15:22Z

automox-vulnerability-sync-tasks-list

Get a list of Automox tasks.

Base Command

automox-vulnerability-sync-tasks-list

Input

Argument Name Description Required
org_id Organization identifier. Optional
batch_id Batch identifier. Optional
status Filter by status of tasks. Possible values are: pending, in_progress, completed, canceled. Optional
limit The maximum number of results to return per page. Default is 50. Optional
page The page of results to return. Optional

Context Output

Path Type Description
Automox.VulnSyncTasks.id Number Identifier of task
Automox.VulnSyncTasks.organization_id Number Identifier of organization
Automox.VulnSyncTasks.task_type String Type of task
Automox.VulnSyncTasks.payload.patch_id String Identifier of patch associated with the task
Automox.VulnSyncTasks.payload.severity String Severity of patch associated with the task
Automox.VulnSyncTasks.payload.package_versions.id String Identifier of package associated with the task
Automox.VulnSyncTasks.payload.package_versions.name String Name of the package associated with the task
Automox.VulnSyncTasks.payload.package_versions.version String Version of the package associated with the task
Automox.VulnSyncTasks.payload.package_versions.display_name String Display name of the package associated with the task
Automox.VulnSyncTasks.payload.package_versions.requires_reboot Boolean Whether the package installed by the task will require a reboot
Automox.VulnSyncTasks.source String Source of task
Automox.VulnSyncTasks.notes String Notes associated with task
Automox.VulnSyncTasks.status String Status of task
Automox.VulnSyncTasks.created_by_user.id Number Identifier of user who created the task
Automox.VulnSyncTasks.created_by_user.email String Email of user who created the task
Automox.VulnSyncTasks.created_by_user.firstname String First name of user who created the task
Automox.VulnSyncTasks.created_by_user.lastname String Last name of user who created the task
Automox.VulnSyncTasks.last_updated_by_user.id Number Identifier of user who last updated the task
Automox.VulnSyncTasks.last_updated_by_user.email String Email of user who last updated the task
Automox.VulnSyncTasks.last_updated_by_user.firstname String First name of user who last updated the task
Automox.VulnSyncTasks.last_updated_by_user.lastname String Last name of user who last updated the task
Automox.VulnSyncTasks.created_at Date Datetime the task was created at
Automox.VulnSyncTasks.updated_at Date Datetime the task was last updated at
Automox.VulnSyncTasks.completed_at Date Datetime the task was completed

Command example

!automox-vulnerability-sync-tasks-list limit=1

Context Example

{
    "Automox": {
        "VulnSyncTasks": {
            "completed_at": "2022-03-30 20:00:03",
            "created_at": "2022-03-29T19:46:12+0000",
            "created_by_user": {
                "email": "string",
                "firstname": "string",
                "id": 19017,
                "lastname": "string"
            },
            "cves": [],
            "id": 1221,
            "last_updated_by_user": {
                "email": "string",
                "firstname": "string",
                "id": 19017,
                "lastname": "string"
            },
            "notes": "",
            "organization_id": 9237,
            "payload": {
                "package_versions": [
                    {
                        "display_name": "2020-05 Cumulative Update for Windows 10 Version 1809 for x64-based Systems (KB4551853)",
                        "id": "223683225",
                        "name": "3f646594-9a4f-4b7a-bb7b-1932a5b490a6",
                        "requires_reboot": false,
                        "version": "1"
                    },
                ],
                "patch_id": "CVE-2018-0886",
                "severity": "critical"
            },
            "source": "Automox",
            "status": "executed",
            "task_type": "patch-now",
            "updated_at": "2022-03-30T20:00:03+0000"
        }
    }
}

Human Readable Output

Tasks

completed_at created_at created_by_user cves id last_updated_by_user notes organization_id payload source status task_type updated_at
2022-03-30 20:00:03 2022-03-29T19:46:12+0000 id: 19017
email: string
firstname: string
lastname: string		   1221 id: 19017
email: string
firstname: string
lastname: string		   9237 patch_id: CVE-2018-0886
severity: critical
package_versions: {‘id’: ‘223683225’, ‘name’: ‘3f646594-9a4f-4b7a-bb7b-1932a5b490a6’, ‘version’: ‘1’, ‘display_name’: ‘2020-05 Cumulative Update for Windows 10 Version 1809 for x64-based Systems (KB4551853)’, ‘requires_reboot’: False}		 Automox executed patch-now 2022-03-30T20:00:03+0000

automox-vulnerability-sync-file-upload

Upload a vulnerability report to Automox Vulnerability Sync.

Base Command

automox-vulnerability-sync-file-upload

Input

Argument Name Description Required
org_id Organization identifier. Optional
entry_id Entry ID of the CSV file to upload. Required
csv_file_name Name for CSV file uploaded and shown within Automox. Default is XSOAR-uploaded-report.csv. Optional
reports_source The third-party source of the vulnerability report. Default is Generic Report. Optional
type The type of task to create Optional

Context Output

Path Type Description
Automox.VulnUpload.batch_id Number Identifier of batch

Command example

!automox-vulnerability-sync-file-upload entry_id="1075@1a203850-514b-4ba5-848e-f944bd9ab460"

Context Example

{
    "Automox": {
        "VulnUpload": {
            "batch_id": 1241
        }
    }
}

Human Readable Output

Upload

batch_id
1241

automox-policies-list

Retrieve a list of Automox policies belonging to an organization.

Base Command

automox-policies-list

Input

Argument Name Description Required
org_id Organization identifier. Optional
limit The maximum number of results to return per page. Default is 50. Optional
page The page of results to return. Optional

Context Output

Path Type Description
Automox.Policies.id Number Identifier of policy
Automox.Policies.organization_id Number Identifier of organization
Automox.Policies.name String Name of policy
Automox.Policies.policy_type_name String Policy type name
Automox.Policies.server_groups Number List of identifiers for device groups assigned to the policy

Command example

!automox-policies-list limit=1

Context Example

{
    "Automox": {
        "Policies": {
            "create_time": "2021-03-03T21:29:09+0000",
            "id": 112411,
            "name": "string",
            "notes": "",
            "organization_id": 9237,
            "policy_type_name": "patch",
            "server_count": 1,
            "server_groups": [
                85579,
                86754
            ]
        }
    }
}

Human Readable Output

Policies

create_time id name notes organization_id policy_type_name server_count server_groups
2021-03-03T21:29:09+0000 112411 string   9237 patch 1 85579,
86754

automox-command-run

Run a command on a device in Automox

Base Command

automox-command-run

Input

Argument Name Description Required
org_id Organization identifier. Optional
device_id Device identifier. Required
patches List of patches to be installed by name. (Note: this only works with the InstallUpdate command). Optional
command Command to run on device. Possible values are: GetOS, InstallUpdate, InstallAllUpdates, Reboot. Required

Context Output

There is no context output for this command.

Command example

!automox-command-run command=GetOS device_id=1375363

Human Readable Output

Command: GetOS successfully sent to Automox device ID: 1375363

automox-device-delete

Delete a device from Automox

Base Command

automox-device-delete

Input

Argument Name Description Required
org_id Organization identifier. Optional
device_id Device identifier. Required

Context Output

There is no context output for this command.

automox-device-update

Update a device’s information in Automox

Base Command

automox-device-update

Input

Argument Name Description Required
org_id Organization identifier. Optional
device_id Device identifier. Required
custom_name Custom name to set on device. Optional
exception Exclude the device from reports and statistics. Required
server_group_id Identifier of server group. Required
tags List of tags to associate with the device. Optional
ip_addrs IP address of the device. Optional

Context Output

There is no context output for this command.

automox-groups-list

List all groups in Automox based on organization permissions.

Base Command

automox-groups-list

Input

Argument Name Description Required
org_id Organization identifier. Optional
limit The maximum number of results to return per page. Default is 50. Optional
page The page of results to return. Optional

Context Output

Path Type Description
Automox.Groups.id Number Identifier of the created group
Automox.Groups.organization_id Number Identifier of organization
Automox.Groups.name String The name of the group
Automox.Groups.refresh_interval Number Frequency of device refreshes in minutes.
Automox.Groups.parent_server_group_id Number Identifier of parent group
Automox.Groups.ui_color String Automox console highlight color for the group
Automox.Groups.notes String Notes defined for the group
Automox.Groups.enable_os_auto_update Boolean Enable operating system auto updates
Automox.Groups.server_count Number Number of devices assigned to group
Automox.Groups.policies Number List of policies assigned to group
Automox.Groups.deleted Boolean Whether a group is deleted

Command example

!automox-groups-list limit=1

Context Example

{
    "Automox": {
        "Groups": {
            "enable_os_auto_update": true,
            "id": 1,
            "name": "string",
            "notes": "string",
            "organization_id": 1,
            "parent_server_group_id": 0,
            "policies": [
                163746,
                167809,
                172118,
                172076,
                156951,
                147303
            ],
            "refresh_interval": 360,
            "server_count": 5,
            "ui_color": "#059F1D",
            "deleted": false
        }
    }
}

Human Readable Output

Groups
id organization_id name refresh_interval parent_server_group_id ui_color notes enable_os_auto_update server_count policies deleted
0 0 string 0 0 string string true 0 0 false

automox-group-create

Create a group in Automox

Base Command

automox-group-create

Input

Argument Name Description Required
org_id Organization identifier. Optional
name Name of the group. Required
notes Define notes for the group. Optional
parent_server_group_id Identifier of the parent group. Defaults to default group id if omitted. Optional
policies List of policy identifiers to assign to group. Optional
refresh_interval Frequency of device refreshes in minutes. (Must be between 360 and 1440). Required
color Automox console highlight color for the group. Value should be a valid Hex color code Optional

Context Output

Path Type Description
Automox.CreatedGroups.id Number Identifier of the created group
Automox.CreatedGroups.organization_id Number Identifier of organization
Automox.CreatedGroups.name String The name of the group
Automox.CreatedGroups.refresh_interval Number Frequency of device refreshes in minutes
Automox.CreatedGroups.parent_server_group_id Number Identifier of parent group
Automox.CreatedGroups.ui_color String Automox console highlight color for the group
Automox.CreatedGroups.notes String Notes defined for the group
Automox.CreatedGroups.enable_os_auto_update Boolean Enable operating system auto updates
Automox.CreatedGroups.server_count Number Number of devices assigned to group
Automox.CreatedGroups.policies Number List of policies assigned to group

Command Example

!automox-group-create

Human Readable Output

Group
id organization_id name refresh_interval parent_server_group_id ui_color notes enable_os_auto_update server_count policies
0 0 string 0 0 string string true 0 0

automox-group-update

Update a group’s information in Automox

Base Command

automox-group-update

Input

Argument Name Description Required
org_id Organization identifier. Optional
group_id Group identifier. Required
name Name of the group. Optional
notes Define notes for the group. Optional
parent_server_group_id Identifier of the parent group. Defaults to default group id if omitted. Optional
policies List of policy identifiers to assign to group. Optional
refresh_interval Frequency of device refreshes in minutes. Optional
color Automox console highlight color for the group. Value should be a valid Hex color code Optional

Context Output

There is no context output for this command.

automox-group-delete

Delete a group from Automox

Base Command

automox-group-delete

Input

Argument Name Description Required
org_id Organization identifier. Optional
group_id Group identifier. Required

Context Output

There is no context output for this command.

Configuration parameters

  • org_id — Organization ID
  • credentials — (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (17)

  • automox-command-run

    Run a command on a device in Automox.

  • automox-device-delete

    Delete a device from Automox.

  • automox-device-update

    Update a device's information in Automox.

  • automox-devices-list

    List all devices in Automox based on group and organization permissions.

  • automox-group-create

    Create a group in Automox.

  • automox-group-delete

    Delete a group from Automox.

  • automox-group-update

    Update a group's information in Automox.

  • automox-groups-list

    List all groups in Automox based on organization permissions.

  • automox-organization-users-list

    List all Automox users within an organization.

  • automox-organizations-list

    List all Automox organizations based on user permissions.

  • automox-policies-list

    Retrieve a list of Automox policies belonging to an organization.

  • automox-vulnerability-sync-batch-action

    Perform an action on an Automox Vulnerability Sync batch.

  • automox-vulnerability-sync-batch-get

    Get details about a Vulnerability Sync batch.

  • automox-vulnerability-sync-batches-list

    Get a list of Vulnerability Sync batches.

  • automox-vulnerability-sync-file-upload

    Upload a vulnerability report to Automox Vulnerability Sync.

  • automox-vulnerability-sync-task-action

    Perform an action on an Automox task.

  • automox-vulnerability-sync-tasks-list

    Get a list of Automox tasks.

Source

Automox.py Automox_test.py Automox.yml Automox_description.md command_examples.txt
Download History Raw 
category: Endpoint
provider: Automox Inc
commonfields:
  id: Automox
  version: -1
configuration:
- display: Organization ID
  additionalinfo: When specified, data pulled from Automox will only belong to this organization; otherwise, the default permissions for this API key will be used.
  name: org_id
  type: 0
  required: false
- displaypassword: API Key
  additionalinfo: The API Key to use for connection
  name: credentials
  required: true
  hiddenusername: true
  type: 9
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
description: 'Administrate your IT organization from XSOAR with comprehensive commands for the Automox platform.'
display: Automox
name: Automox
script:
  commands:
  - name: automox-devices-list
    description: 'List all devices in Automox based on group and organization permissions.'
    arguments:
    - name: org_id
      description: 'Organization ID.'
    - name: group_id
      description: 'Group ID.'
    - name: limit
      description: 'The maximum number of results to return per page.'
      type: 'number'
      defaultValue: 50
    - name: page
      description: 'The page of results to return.'
      type: 'number'
      defaultValue: 0
    outputs:
    - contextPath: Automox.Devices.id
      description: 'Identifier of device.'
      type: Number
    - contextPath: Automox.Devices.server_group_id
      description: 'Identifier of server group.'
      type: Number
    - contextPath: Automox.Devices.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.Devices.uuid
      description: 'The Automox UUID of a device.'
      type: String
    - contextPath: Automox.Devices.name
      description: 'The name of a device.'
      type: String
    - contextPath: Automox.Devices.refresh_interval
      description: 'Frequency of device refreshes in minutes.'
      type: Number
    - contextPath: Automox.Devices.last_update_time
      description: 'The last time a device was updated in Automox.'
      type: String
    - contextPath: Automox.Devices.last_refresh_time
      description: 'The last time a device was refreshed in Automox.'
      type: String
    - contextPath: Automox.Devices.uptime
      description: 'The device uptime in minutes.'
      type: Number
    - contextPath: Automox.Devices.needs_reboot
      description: 'Whether a device needs to be rebooted.'
      type: Boolean
    - contextPath: Automox.Devices.timezone
      description: 'The device timezone.'
      type: String
    - contextPath: Automox.Devices.tags
      description: 'List of tags for the device.'
      type: String
    - contextPath: Automox.Devices.deleted
      description: 'Whether a device is deleted.'
      type: Boolean
    - contextPath: Automox.Devices.create_time
      description: 'The time a device was created in Automox.'
      type: Date
    - contextPath: Automox.Devices.os_version
      description: 'The operating system version of a device.'
      type: String
    - contextPath: Automox.Devices.os_name
      description: 'The operating system name of a device.'
      type: String
    - contextPath: Automox.Devices.os_family
      description: 'the operating system family of a device.'
      type: String
    - contextPath: Automox.Devices.ip_addrs
      description: 'List of IP addresses for a device.'
      type: String
    - contextPath: Automox.Devices.ip_addrs_private
      description: 'List of private IP addresses for a device.'
      type: String
    - contextPath: Automox.Devices.patches
      description: 'The number of patches currently identified for a device.'
      type: Number
    - contextPath: Automox.Devices.agent_version
      description: 'The version of the Automox agent on the device.'
      type: String
    - contextPath: Automox.Devices.custom_name
      description: 'The Automox specific custom name for the device.'
      type: String
    - contextPath: Automox.Devices.is_compatible
      description: 'Whether a device is compatible with Automox.'
      type: Boolean
    - contextPath: Automox.Devices.policy_status.id
      description: 'Identifier of policy.'
      type: Number
    - contextPath: Automox.Devices.policy_status.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.Devices.policy_status.policy_name
      description: 'Name of the policy.'
      type: String
    - contextPath: Automox.Devices.policy_status.policy_type_name
      description: 'Type of the policy.'
      type: String
    - contextPath: Automox.Devices.policy_status.status
      description: 'Current status of the policy.'
      type: Number
    - contextPath: Automox.Devices.policy_status.result
      description: 'Result of the policy.'
      type: String
    - contextPath: Automox.Devices.policy_status.create_time
      description: 'Policy created datetime.'
      type: Datetime
    - contextPath: Automox.Devices.last_scan_failed
      description: 'Whether the last scan failed on a device.'
      type: Boolean
    - contextPath: Automox.Devices.pending
      description: 'Whether work is pending on a device.'
      type: Boolean
    - contextPath: Automox.Devices.compliant
      description: 'Whether a device is compliant.'
      type: Boolean
    - contextPath: Automox.Devices.display_name
      description: 'The display name of a device.'
      type: String
    - contextPath: Automox.Devices.commands.command_type_name
      description: 'The type of a command previously issued on a device.'
      type: String
    - contextPath: Automox.Devices.commands.args
      description: 'The arguments of a command previously issued on a device.'
      type: String
    - contextPath: Automox.Devices.commands.exec_time
      description: 'The execution time of a command previously issued on a device.'
      type: Date
    - contextPath: Automox.Devices.pending_patches
      description: 'The number of pending patches for a device.'
      type: Number
    - contextPath: Automox.Devices.connected
      description: 'Whether a device is currently connected to Automox.'
      type: Boolean
    - contextPath: Automox.Devices.last_process_time
      description: 'The last time the device was processed.'
      type: String
    - contextPath: Automox.Devices.next_patch_time
      description: 'The next time the device is patched.'
      type: String
    - contextPath: Automox.Devices.notification_count
      description: 'The number of notifications for the device.'
      type: Number
    - contextPath: Automox.Devices.reboot_notification_count
      description: 'The number of reboot notifications for a device.'
      type: Number
    - contextPath: Automox.Devices.patch_deferral_count
      description: 'The number of patch deferrals for a device.'
      type: Number
    - contextPath: Automox.Devices.is_delayed_by_notification
      description: 'Whether a patch is delayed by notifications.'
      type: Boolean
    - contextPath: Automox.Devices.reboot_is_delayed_by_notification
      description: 'Whether a reboot is delayed by notifications.'
      type: Boolean
    - contextPath: Automox.Devices.is_delayed_by_user
      description: 'Whether a patch is delayed by the user.'
      type: Boolean
    - contextPath: Automox.Devices.reboot_is_delayed_by_user
      description: 'Whether a reboot is delayed by the user.'
      type: Boolean
    - contextPath: Automox.Devices.last_disconnect_time
      description: 'Last time a device disconnected from Automox.'
      type: Date
    - contextPath: Automox.Devices.needs_attention
      description: 'Whether a device currently needs attention.'
      type: Boolean
    - contextPath: Automox.Devices.serial_number
      description: 'The device serial number.'
      type: String
    - contextPath: Automox.Devices.status.device_status
      description: 'The status of a device.'
      type: String
    - contextPath: Automox.Devices.status.agent_status
      description: 'The status of a device agent.'
      type: String
    - contextPath: Automox.Devices.status.policy_status
      description: 'The overall status of all policies assigned to a device.'
      type: String
    - contextPath: Automox.Devices.status.policy_statuses.id
      description: 'The identifier of the policy.'
      type: Number
    - contextPath: Automox.Devices.status.policy_statuses.compliant
      description: 'Whether a device is compliant to a given status.'
      type: Boolean
    - contextPath: Automox.Devices.last_logged_in_user
      description: 'The last logged in user of a device.'
      type: String
  - name: automox-organizations-list
    arguments:
    - name: limit
      description: 'The maximum number of results to return per page.'
      type: 'number'
      defaultValue: 50
    - name: page
      description: 'The page of results to return.'
      type: 'number'
      defaultValue: 0
    description: 'List all Automox organizations based on user permissions.'
    outputs:
    - contextPath: Automox.Organizations.id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.Organizations.name
      description: 'Name of organization.'
      type: String
    - contextPath: Automox.Organizations.create_time
      description: 'The datetime when the organization was created.'
      type: Date
    - contextPath: Automox.Organizations.server_limit
      description: 'The organization server limit.'
      type: Number
    - contextPath: Automox.Organizations.parent_id
      description: 'The organization parent id.'
      type: Number
    - contextPath: Automox.Organizations.device_limit
      description: 'The organization device limit.'
      type: Number
    - contextPath: Automox.Organizations.device_count
      description: 'The organization device count.'
      type: Number
  - name: automox-organization-users-list
    description: 'List all Automox users within an organization.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: limit
      description: 'The maximum number of results to return per page.'
      type: 'number'
      defaultValue: 50
    - name: page
      description: 'The page of results to return.'
      type: 'number'
      defaultValue: 0
    outputs:
    - contextPath: Automox.Users.id
      description: 'Identifier of user.'
      type: Number
    - contextPath: Automox.Users.firstname
      description: 'The first name of the user.'
      type: String
    - contextPath: Automox.Users.lastname
      description: 'The last name of the user.'
      type: String
    - contextPath: Automox.Users.email
      description: 'The email of the user.'
      type: String
    - contextPath: Automox.Users.orgs.id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.Users.orgs.name
      description: 'Name of organization.'
      type: String
    - contextPath: Automox.Users.tags
      description: 'User tags.'
      type: String
    - contextPath: Automox.Users.saml_enabled
      description: 'Whether SAML has been enabled for the user.'
      type: Boolean
    - contextPath: Automox.Users.rbac_roles.id
      description: 'The RBAC role identifier.'
      type: Number
    - contextPath: Automox.Users.rbac_roles.name
      description: 'The RBAC role name.'
      type: String
    - contextPath: Automox.Users.rbac_roles.organization_id
      description: 'Identifier of organization.'
      type: Number
  - name: automox-vulnerability-sync-batch-action
    description: 'Perform an action on an Automox Vulnerability Sync batch.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: batch_id
      description: 'Batch identifier.'
      type: 'number'
      required: true
    - name: action
      description: 'Action to perform on the batch specified. Options are "accept" or "reject".'
      auto: PREDEFINED
      predefined:
      - accept
      - reject
      required: true
  - name: automox-vulnerability-sync-task-action
    description: 'Perform an action on an Automox task.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: batch_id
      description: 'Batch identifier.'
      type: 'number'
      required: true
    - name: action
      description: 'Action to perform on the batch specified. Options are "accept" or "reject".'
      auto: PREDEFINED
      predefined:
      - accept
      - reject
      required: true
  - name: automox-vulnerability-sync-batch-get
    description: 'Get details about a Vulnerability Sync batch.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: batch_id
      description: 'Batch identifier.'
      type: 'number'
      required: true
    outputs:
    - contextPath: Automox.VulnSyncBatch.id
      description: 'Identifier of batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.status
      description: 'Status of batch.'
      type: String
    - contextPath: Automox.VulnSyncBatch.source
      description: 'Originating vendor of vulnerability information.'
      type: String
    - contextPath: Automox.VulnSyncBatch.created_by.id
      description: 'The identifier of the user who created this batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.created_by.firstname
      description: 'The first name of the user who created this batch.'
      type: String
    - contextPath: Automox.VulnSyncBatch.created_by.lastname
      description: 'The last name of the user who created this batch.'
      type: String
    - contextPath: Automox.VulnSyncBatch.created_by.email
      description: 'The email of the user who created this batch.'
      type: String
    - contextPath: Automox.VulnSyncBatch.updated_by.id
      description: 'The identifier of the user who last updated this batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.updated_by.firstname
      description: 'The first name of the user who last updated this batch.'
      type: String
    - contextPath: Automox.VulnSyncBatch.updated_by.lastname
      description: 'The last name of the user who last updated this batch.'
      type: String
    - contextPath: Automox.VulnSyncBatch.updated_by.email
      description: 'The email of the user who last updated this batch.'
      type: String
    - contextPath: Automox.VulnSyncBatch.uploaded_at
      description: 'Datetime of initial upload.'
      type: Date
    - contextPath: Automox.VulnSyncBatch.task_count
      description: 'Number of tasks related to batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.unknown_host_count
      description: 'Number of hosts that are unknown within batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.impacted_device_count
      description: 'Number of devices impacted by batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.issue_count
      description: 'Number of issues identified with batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatch.cve_count
      description: 'Number of CVEs impacted by batch.'
      type: Number
  - name: automox-vulnerability-sync-batches-list
    description: 'Get a list of Vulnerability Sync batches.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: limit
      description: 'The maximum number of results to return per page.'
      type: 'number'
      defaultValue: 50
    - name: page
      description: 'The page of results to return.'
      type: 'number'
      defaultValue: 0
    outputs:
    - contextPath: Automox.VulnSyncBatches.id
      description: 'Identifier of batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.status
      description: 'Status of batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.source
      description: 'Source of batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.created_by.id
      description: 'Identifier of user who created the batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.created_by.firstname
      description: 'First name of the user who created the batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.created_by.lastname
      description: 'Last name of the user who created the batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.created_by.email
      description: 'Email of the user who created the batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.updated_by.id
      description: 'Identifier of the user who last updated the batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.updated_by.firstname
      description: 'First name of the user who last updated the batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.updated_by.lastname
      description: 'Last name of the user who last updated the batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.updated_by.email
      description: 'Email off the user who last updated the batch.'
      type: String
    - contextPath: Automox.VulnSyncBatches.uploaded_at
      description: 'Datetime the batch was uploaded.'
      type: Date
    - contextPath: Automox.VulnSyncBatches.task_count
      description: 'Number of tasks related to batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.unknown_host_count
      description: 'number of hosts that are unknown within batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.impacted_device_count
      description: 'Number of devices that are impacted by batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.issue_count
      description: 'Number of issues identified with batch.'
      type: Number
    - contextPath: Automox.VulnSyncBatches.cve_count
      description: 'Number of CVEs that are impacted by batch.'
      type: Number
  - name: automox-vulnerability-sync-tasks-list
    description: 'Get a list of Automox tasks.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: batch_id
      description: 'Batch identifier.'
      type: 'number'
    - name: status
      description: 'Filter by status of tasks.'
      type: 'string'
      auto: PREDEFINED
      predefined:
      - pending
      - in_progress
      - completed
      - canceled
    - name: limit
      description: 'The maximum number of results to return per page.'
      type: 'number'
      defaultValue: 50
    - name: page
      description: 'The page of results to return.'
      type: 'number'
      defaultValue: 0
    outputs:
    - contextPath: Automox.VulnSyncTasks.id
      description: 'Identifier of task.'
      type: Number
    - contextPath: Automox.VulnSyncTasks.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.VulnSyncTasks.task_type
      description: 'Type of task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.payload.patch_id
      description: 'Identifier of patch associated with the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.payload.severity
      description: 'Severity of patch associated with the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.payload.package_versions.id
      description: 'Identifier of package associated with the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.payload.package_versions.name
      description: 'Name of the package associated with the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.payload.package_versions.version
      description: 'Version of the package associated with the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.payload.package_versions.display_name
      description: 'Display name of the package associated with the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.payload.package_versions.requires_reboot
      description: 'Whether the package installed by the task will require a reboot.'
      type: Boolean
    - contextPath: Automox.VulnSyncTasks.source
      description: 'Source of task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.notes
      description: 'Notes associated with task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.status
      description: 'Status of task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.created_by_user.id
      description: 'Identifier of user who created the task.'
      type: Number
    - contextPath: Automox.VulnSyncTasks.created_by_user.email
      description: 'Email of user who created the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.created_by_user.firstname
      description: 'First name of user who created the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.created_by_user.lastname
      description: 'Last name of user who created the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.last_updated_by_user.id
      description: 'Identifier of user who last updated the task.'
      type: Number
    - contextPath: Automox.VulnSyncTasks.last_updated_by_user.email
      description: 'Email of user who last updated the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.last_updated_by_user.firstname
      description: 'First name of user who last updated the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.last_updated_by_user.lastname
      description: 'Last name of user who last updated the task.'
      type: String
    - contextPath: Automox.VulnSyncTasks.created_at
      description: 'Datetime the task was created at.'
      type: Date
    - contextPath: Automox.VulnSyncTasks.updated_at
      description: 'Datetime the task was last updated at.'
      type: Date
    - contextPath: Automox.VulnSyncTasks.completed_at
      description: 'Datetime the task was completed.'
      type: Date
  - name: automox-vulnerability-sync-file-upload
    description: 'Upload a vulnerability report to Automox Vulnerability Sync.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: entry_id
      description: 'Entry ID of the CSV file to upload.'
      type: 'string'
      required: true
    - name: csv_file_name
      description: 'Name for CSV file uploaded and shown within Automox.'
      type: 'string'
      defaultValue: 'XSOAR-uploaded-report.csv'
    - name: reports_source
      description: 'The third-party source of the vulnerability report.'
      type: 'string'
      defaultValue: 'Generic Report'
    - name: type
      description: 'The type of task to create.'
      type: 'string'
      defaultValue: 'patch'
    outputs:
    - contextPath: Automox.VulnUpload.batch_id
      description: 'Identifier of batch.'
      type: Number
  - name: automox-policies-list
    description: 'Retrieve a list of Automox policies belonging to an organization.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: limit
      description: 'The maximum number of results to return per page.'
      type: 'number'
      defaultValue: 50
    - name: page
      description: 'The page of results to return.'
      type: 'number'
      defaultValue: 0
    outputs:
    - contextPath: Automox.Policies.id
      description: 'Identifier of policy.'
      type: Number
    - contextPath: Automox.Policies.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.Policies.name
      description: 'Name of policy.'
      type: String
    - contextPath: Automox.Policies.policy_type_name
      description: 'Policy type name.'
      type: String
    - contextPath: Automox.Policies.server_groups
      description: 'List of identifiers for device groups assigned to the policy.'
      type: Number
  - name: automox-command-run
    description: 'Run a command on a device in Automox.'
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: device_id
      description: 'Device identifier.'
      type: 'number'
      required: true
    - name: patches
      description: 'List of patches to be installed by name. (Note: this only works with the InstallUpdate command).'
      type: 'string'
      isArray: true
    - name: command
      description: 'Command to run on device.'
      type: 'String'
      auto: PREDEFINED
      predefined:
      - GetOS
      - InstallUpdate
      - InstallAllUpdates
      - Reboot
      required: true
  - name: automox-device-delete
    description: "Delete a device from Automox."
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: device_id
      description: 'Device identifier.'
      type: 'number'
      required: true
  - name: automox-device-update
    description: "Update a device's information in Automox."
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: device_id
      description: 'Device identifier.'
      type: 'number'
      required: true
    - name: custom_name
      description: 'Custom name to set on device.'
      type: 'string'
    - name: exception
      description: 'Exclude the device from reports and statistics.'
      type: Boolean
      required: true
      defaultValue: false
    - name: server_group_id
      description: 'Identifier of server group.'
      type: Number
      required: true
    - name: tags
      description: 'List of tags to associate with the device.'
      type: String
      isArray: true
    - name: ip_addrs
      description: 'IP address of the device.'
      type: String
  - name: automox-groups-list
    description: "List all groups in Automox based on organization permissions."
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: limit
      description: 'The maximum number of results to return per page.'
      type: 'number'
      defaultValue: 50
    - name: page
      description: 'The page of results to return.'
      type: 'number'
      defaultValue: 0
    outputs:
    - contextPath: Automox.Groups.id
      description: 'Identifier of the created group.'
      type: Number
    - contextPath: Automox.Groups.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.Groups.name
      description: 'The name of the group.'
      type: String
    - contextPath: Automox.Groups.refresh_interval
      description: 'Frequency of device refreshes in minutes.'
      type: Number
    - contextPath: Automox.Groups.parent_server_group_id
      description: 'Identifier of parent group.'
      type: Number
    - contextPath: Automox.Groups.ui_color
      description: 'Automox console highlight color for the group.'
      type: String
    - contextPath: Automox.Groups.notes
      description: 'Notes defined for the group.'
      type: String
    - contextPath: Automox.Groups.enable_os_auto_update
      description: 'Enable operating system auto updates.'
      type: Boolean
    - contextPath: Automox.Groups.server_count
      description: 'Number of devices assigned to group.'
      type: Number
    - contextPath: Automox.Groups.policies
      description: 'List of policies assigned to group.'
      type: Number
    - contextPath: Automox.Groups.deleted
      description: 'Whether a group is deleted.'
      type: Boolean
  - name: automox-group-create
    description: "Create a group in Automox."
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: name
      description: 'Name of the group.'
      type: String
      required: true
    - name: notes
      description: 'Define notes for the group.'
      type: String
    - name: parent_server_group_id
      description: 'Identifier of the parent group. Defaults to default group id if omitted.'
      type: Number
    - name: policies
      description: 'List of policy identifiers to assign to group.'
      type: Number
      isArray: true
    - name: refresh_interval
      description: 'Frequency of device refreshes in minutes. (Must be between 360 and 1440).'
      type: Number
      required: true
    - name: color
      description: 'Automox console highlight color for the group. Value should be a valid Hex color code.'
      type: String
    outputs:
    - contextPath: Automox.CreatedGroups.id
      description: 'Identifier of the created group.'
      type: Number
    - contextPath: Automox.CreatedGroups.organization_id
      description: 'Identifier of organization.'
      type: Number
    - contextPath: Automox.CreatedGroups.name
      description: 'The name of the group.'
      type: String
    - contextPath: Automox.CreatedGroups.refresh_interval
      description: 'Frequency of device refreshes in minutes.'
      type: Number
    - contextPath: Automox.CreatedGroups.parent_server_group_id
      description: 'Identifier of parent group.'
      type: Number
    - contextPath: Automox.CreatedGroups.ui_color
      description: 'Automox console highlight color for the group.'
      type: String
    - contextPath: Automox.CreatedGroups.notes
      description: 'Notes defined for the group.'
      type: String
    - contextPath: Automox.CreatedGroups.enable_os_auto_update
      description: 'Enable operating system auto updates.'
      type: Boolean
    - contextPath: Automox.CreatedGroups.server_count
      description: 'Number of devices assigned to group.'
      type: Number
    - contextPath: Automox.CreatedGroups.policies
      description: 'List of policies assigned to group.'
      type: Number
  - name: automox-group-update
    description: "Update a group's information in Automox."
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: 'number'
    - name: group_id
      description: 'Group identifier.'
      type: 'number'
      required: true
    - name: name
      description: 'Name of the group.'
      type: String
    - name: notes
      description: 'Define notes for the group.'
      type: String
    - name: parent_server_group_id
      description: 'Identifier of the parent group. Defaults to default group id if omitted.'
      type: Number
    - name: policies
      description: 'List of policy identifiers to assign to group.'
      type: Number
      isArray: true
    - name: refresh_interval
      description: 'Frequency of device refreshes in minutes.'
      type: Number
    - name: color
      description: 'Automox console highlight color for the group. Value should be a valid Hex color code.'
      type: String
  - name: automox-group-delete
    description: "Delete a group from Automox."
    arguments:
    - name: org_id
      description: 'Organization identifier.'
      type: Number
    - name: group_id
      description: 'Group identifier.'
      type: Number
      required: true
  runonce: false
  script: '-'
  type: python
  subtype: python3
  dockerimage: demisto/python3:3.12.13.10116658
fromversion: 6.0.0
tests:
- No tests