SysAid
This Integration is part of the SysAid Pack.#
Supported versions
Supported Cortex XSOAR versions: 6.0.0 and later.
SysAid is a robust IT management system designed to meet all of the needs of an IT department. This integration was integrated and tested with version 21.4.44 of SysAid.
Configure SysAid on Cortex XSOAR#
Navigate to Settings > Integrations > Servers & Services.
Search for SysAid.
Click Add instance to create and configure a new integration instance.
Parameter Description Required Server URL True Username True Password True Trust any certificate (not secure) False Use system proxy settings False Incident type False Maximum number of incidents to fetch Maximum is limited to 200. False Fetch incidents False First fetch time interval False Fetch types Choose which service record type to fetch - incidents, requests, problems, changes, or all. False Included statuses A comma separated list of statuses to return. Default value includes "open classes". You may add/remove statuses according to your needs. The list of status numbers and their values can be retrieved by running the "sysaid-table-list" command with the "list_id=status" argument. False Include Archived False Click Test to validate the URLs, token, and connection.
Commands#
You can execute these commands from the Cortex XSOAR 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.
sysaid-table-list#
Retrieve all lists (tables) related to a specific entity, or a specific list from an entity.
Base Command#
sysaid-table-list
Input#
Argument Name | Description | Required |
---|---|---|
entity | A SysAid entity by which to retrieve the available lists. Defaults to service record. Options are: sr - Service record related lists, asset - Asset related lists, user - User related lists, ci - CI related lists, company - Company related lists, action_item - Action item related lists, project - Service record Sub Tabs lists, task - Task related lists, catalog - Catalog related lists, software - Software related lists, sr_activity - Service Record activity related lists, supplier - Supplier related lists, task_activity - Task activity related lists, user_groups - User Group related lists. Possible values are: sr, asset, user, ci, company, action_item, project, task, catalog, software, sr_activity, supplier, task_activity, user_groups. | Optional |
entity_id | The entity's ID. For example, in service record Form lists, send the service record ID to populate additional filters on the lists. For example, the responsibility list may be filtered by the admin group of the service record. | Optional |
entity_type | Numeric. For example, in sr entity, send the sr_type ID, for ci entity, send the ci type ID (for retrieving the list of CI sub-types). | Optional |
list_id | Desired list ID. | Optional |
key | Relevant for users/groups related fields. Defines whether to use the ID or the name as the key for each value in the result. Available values are "name" or "id". Defaults to "id". Possible values are: id, name. | Optional |
fields | A comma separated list of fields to return. Available fields are: id (always returned), caption, and values. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.List.id | String | The ID of the list. |
SysAid.List.caption | String | The caption of the list. |
SysAid.List.values | String | The values of the list. |
Command example#
!sysaid-table-list list_id=known_error
Context Example#
Human Readable Output#
List ID known_error Results:#
Id Caption Values known_error Known Error {'id': 'P', 'caption': 'Production'},
{'id': 'D', 'caption': 'Development'},
{'id': 'N', 'caption': 'No'}
sysaid-asset-list#
List all assets or get a specific asset by ID. Cortex XSOAR recommends filtering the results by the desired fields.
Base Command#
sysaid-asset-list
Input#
Argument Name | Description | Required |
---|---|---|
asset_id | The ID of the asset to return. | Optional |
fields | Comma separated list of fields to return to context data. The valid fields can be retrieved using the "sysaid-table-list" command with the "entity=asset" argument. You can send "all" for debugging purposes. | Required |
page_number | Index of the page of results to retrieve. Default is 1. | Optional |
page_size | The number of assets to return on a page. Default is 100. | Optional |
Context Output#
Path | Type | Description |
---|---|---|
SysAid.Asset.id | String | The ID of the asset. |
SysAid.Asset.name | String | The name of the asset. |
SysAid.Asset.info | String | The info of the asset. |
Command example#
!sysaid-asset-list fields=all