Veeam Backup & Replication

LAST UPDATED: NOV 6, 2024

Overview

Veeam Backup & Replication is a comprehensive data protection and disaster recovery solution. With Veeam Backup & Replication, users can create image-level backups of virtual, physical and cloud machines and restore from those backups.

D3 SOAR is providing REST operations to function with Veeam Backup & Replication.

Veeam Backup & Replication is available for use in:

D3 SOAR	V16.8.243.0
Category	Endpoint Security
Deployment Options	Option I, Option III

Connection

To connect to Veeam Backup & Replication from D3 SOAR, follow this part to collect the required information below:

Parameter	Description	Example
Server URL	The server URL for the Veeam Backup and Replication instance connection. By default, the default port number is 9419.	https://enterprise01.tech.local:9419
User Name	The user name for the connection.	USR_NAME
Password	The user's password for the connection.	YOUR_PASSWORD
API Version	The API major version. By default, the value is v1.	v1

Permission Requirements

Each endpoint in the Veeam Backup & Replication API requires a certain permission scope. The following are required scopes for the commands in this integration:

Command	Required Permissions
Create Malware Event	Available to: Veeam Backup Administrator
Fetch Event	Available to: Veeam Backup Administrator
List Inventory Objects	Available to: Veeam Backup Administrator
List Managed Servers	Available to: All user roles
List Restore Points	Available to: All user roles
List Servers	Available to: Veeam Backup Administrator
Test Connection	Available to: Veeam Backup Administrator

Configuring D3 SOAR to Work with Veeam Backup & Replication

Log in to D3 SOAR.
Find the Veeam Backup & Replication integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Veeam Backup & Replication in the search box to find the integration, then click it to select it.
4. Click on the + Connection button on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Veeam Backup & Replication.
1. Connection Name: The desired name for the connection.
2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.
4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
5. Description (Optional): Add your desired description for the connection.
6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.
7. Configure User Permissions: Defines which users have access to the connection.
8. Active: Check the checkbox to ensure the connection is available for use.
9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
  1. Input the Server URL.
  2. Input the User Name.
  3. Input the Password.
  4. Input the API Version. The default value is v1.
10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.
  Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
  To set up a connection health check, check the Connection Health Check tick box. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.
Test the connection.
1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green check mark appear beside the Test Connection button. If the test connection fails, check your connection parameters and try again.
2. Click OK to close the alert window.
3. Click + Add to create and add the configured connection.

Commands

Veeam Backup & Replication includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Veeam Backup & Replication API, refer to the Veeam Backup & Replication API reference.

READER NOTE

Certain permissions are required for each command. Refer to the Permission Requirements section for details.

Note for Time-related parameters

The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:

Navigate to Configuration Application Settings. Select Date/Time Format.
Choose your desired date and time format, then click on the Save button.

After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.

Create Malware Event

Creates a new malware event.

Input

Input Parameter	Required/Optional	Description	Example
Detection Time	Required	The date and time, in UTC, when a new malware event is detected.	2024-08-26 11:49:01
Machine FQDN	Optional	Identifies a machine by its Fully Qualified Domain Name (FQDN). Veeam Backup & Replication can recognize a machine using its FQDN, IPv4 address, or IPv6 address, provided the machine is powered on during the backup. If the machine is powered off at the time of backup, Veeam Backup & Replication cannot retrieve the machine's IP addresses or domain name and, therefore, cannot identify it. At least two of the following parameters must be specified: Machine FQDN, IPv4, IPv6, or Machine UUID. Machine FQDN, IPv4, IPv6, or Machine BIOS UUID information can be obtained from third-party products, such as EDR or XDR.	PMATest02
Machine IPv4	Optional	Identifies a machine by its IPv4 address. Veeam Backup & Replication can recognize a machine using its FQDN, IPv4 address, or IPv6 address only if the machine is powered on during the backup. If the machine is powered off at the time of backup, Veeam Backup & Replication cannot retrieve the machine's IP addresses or domain name, rendering the machine unidentifiable. At least two of the following parameters must be specified: Machine FQDN, IPv4, IPv6, or Machine UUID. Information such as Machine FQDN, IPv4, IPv6, or Machine BIOS UUID can be obtained from third-party products, such as EDR or XDR.	192.168.12.100
Machine IPv6	Optional	Identifies a machine by its IPv6 address.Veeam Backup & Replication can recognize a machine using its FQDN, IPv4 address, or IPv6 address only if the machine is powered on during the backup. If the machine is powered off at the time of backup, Veeam Backup & Replication cannot retrieve the machine's IP addresses or domain name, rendering the machine unidentifiable. At least two of the following parameters must be specified: Machine FQDN, IPv4, IPv6, or Machine UUID. Information such as Machine FQDN, IPv4, IPv6, or Machine BIOS UUID can be obtained from third-party products, such as EDR or XDR.	*****
Machine UUID	Optional	Identifies a machine by its BIOS UUID. At least two of the following parameters must be specified: Machine FQDN, IPv4, IPv6, or Machine UUID. Machine FQDN, IPv4, IPv6, or Machine BIOS UUID information can be obtained from third-party products, such as EDR or XDR.	*****
Description	Required	Descriptive details for the new malware event.	Malware Event test description 0826a
Engine	Required	The detection engine for the new malware event.	CS

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "type": "Unknown",
            "state": "Created",
            "source": "External",
            "severity": "Infected",
            "id": "*****",
            "detectionTimeUtc": "2024-08-26T11:49:01Z",
            "machine": {
                "displayName": "PMATest02",
                "uuid": "*****",
                "backupObjectId": "*****"
            },
            "details": "Malware Event test description 0826a",
            "createdBy": ".\\restapiuser",
            "engine": "CS"
        }
    ],
    "D3Errors": []
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
  "EventID": *****,
  "State": Created,
  "MachineDisplayName": PMATest02
}

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

id	*****
state	Created

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Create Malware Event failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Veeam Backup & Replication portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Error Sample Data

Create Malware Event failed.

Status Code: 400.

Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Fetch Event

Ingests malware events created on the backup server into the vSOC platform as events, based on specified search criteria. The ingested events are sorted by Detection Time in descending order.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Optional	Returns events created after the specified start time, in UTC. By default, the Start Time is 30 days before the End Time.	2019-08-24T14:15:22
End Time	Optional	Returns events created before the specified end time, in UTC. By default, the End Time is the current time.	2019-08-24T20:00:00
Number of Event(s) Fetched	Optional	The maximum number of events to fetch.By default, all malware events matching the time range and search conditions will be returned. The maximum number is 1000.	10
Event Type	Optional	Filters malware events by event type. By default, events will be returned regardless of their type.	Unknown
Event State	Optional	Filters malware events by event state. By default, events will be returned regardless of their state.	Created
Event Source	Optional	Filters malware events by event source type. By default, events will be returned regardless of their source.	Internal Veeam Detector
Event Severity	Optional	Filters malware events by event severity. By default, events will be returned regardless of their severity.	Infected
Engine	Optional	Filters events by the detection engine. To substitute one or more characters, use the asterisk (*) character at the beginning, end or both.	m*

Output

Return Data

Indicates one of the possible command execution states: Successful, Successful but without events, or Failed

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "id": "*****",
            "type": "Unknown",
            "detectionTimeUtc": "2019-08-24T14:15:22Z",
            "machine": {
                "displayName": "string",
                "uuid": "string",
                "backupObjectId": "*****"
            },
            "state": "Created",
            "details": "string",
            "source": "Manual",
            "severity": "Clean",
            "createdBy": "string",
            "engine": "string"
        }
    ]
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
  "EventIDs": ["*****"],
  "HostName": ["host-1"]
}

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

Start Time (UTC)	2024-07-11 02:19
End Time (UTC)	2024-08-10 02:19
Number of Event(s) Fetched	1

Fetch Event Field Mapping

Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Refer to Event and Incident Intake Field Mapping for details.

To customize field mapping, click + Add Field and add the custom field of your choice. You can also remove built-in field mappings by clicking x. Note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.

As a system integration, the Veeam Backup & Replication integration has some pre-configured field mappings for default field mapping.

Default Event Source
The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events. The default event source has a "Main Event JSON Path" (i.e. $.data) that is used to extract a batch of events from the response raw data. Click Edit Event Source to view the "Main Event JSON Path".
- Main Event JSON Path: $.data

The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([‘...’]) should be used to separate child elements in JSON arrays.

For example, the root node of a JSON Path is data. The child node denoting the Unique Event Key field would be id. Putting it together, the JSON Path expression to extract the Unique Event Key is $.data.id.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Backup Object ID	.machine.backupObjectId
Created By	.createdBy
Engine	.engine
Machine UUID	.machine.uuid
Unique Event Key	.id
Event Type	.type
Hostname	.machine.displayName
Start Time	.detectionTimeUtc
Description	.details
Severity	.severity
Source	.source
Status	.state

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Fetch Event failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Veeam Backup & Replication portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Error Sample Data

Fetch Event failed.

Status Code: 400.

Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

List Inventory Objects

Retrieves an array of inventory objects for the specific virtualization server (or host) identified by the specified hostname. The returned inventory objects are sorted alphabetically by object name.

READER NOTE

Host Name is a required parameter to run this command.

Run the List Servers command to obtain the Host Name. Host Names can be found in the raw data at the path $.data[*].hostName.

Input

Input Parameter	Required/Optional	Description	Example
Host Name	Required	The name of the virtualization server for which to retrieve inventory objects. Host Name can be obtained using the List Servers command.	Server_1
Platform Name	Optional	Filters inventory objects by platform name. By default, inventory objects from either the VMware or Cloud Director platform will be returned.	VMware
Inventory Object Types	Optional	Filters inventory objects by type(s). By default, inventory objects will be returned regardless of their type. For the VMware platform, available types include: Unknown, VirtualMachine, vCenterServer, Datacenter, Cluster, Host, ResourcePool, Folder, Datastore, DatastoreCluster, StoragePolicy, Template, ComputeResource, VirtualApp, Tag, Category, Multitag, Network, and DVSNetwork. For the Cloud Director platform, available types include: Unknown, VirtualMachine, CloudDirectorServer, Organization, OrganizationVDC, vApp, StoragePolicy, Network, vCenter, VmTemplate, and Datastore.	JSON `["VirtualMachine"]`

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "platform": "VMware",
            "size": "string",
            "hostName": "string",
            "name": "string",
            "type": "Unknown",
            "objectId": "string",
            "urn": "string"
        }
    ]
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
  "ObjectTypes": ["unknown"],
  "ObjectNames": ["string"]
}

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

Inventory Objects Count

1

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Inventory Objects failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Veeam Backup & Replication portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Error Sample Data

List Inventory Objects failed.

Status Code: 400.

Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

List Managed Servers

Retrieves an array of all servers added to the backup infrastructure. The returned servers are sorted alphabetically by host name.

Input

Input Parameter	Required/Optional	Description	Example
Host Name	Optional	Filters servers by server name. The pattern can match any server parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, end or both.	Server_1*
Host Type	Optional	Filters servers by server type. The options are: ESX ESXi V Center By default, servers will be returned regardless of their type.	Windows Host
VMware vSphere Server Type	Optional	Filters servers by the type of VMware vSphere server. The options are: Windows Host Linux Host VMware vSphere Server Host Cloud Director Host By default, hosts will be returned regardless of the VMware vSphere server type.	ESX

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "networkSettings": {
                "components": [
                    {
                        "componentName": "DeployerSvc",
                        "port": 6160
                    },
                    {
                        "componentName": "Transport",
                        "port": 6162
                    },
                    {
                        "componentName": "Nfs",
                        "port": 6161
                    },
                    {
                        "componentName": "RestoreProxy",
                        "port": 6170
                    },
                    {
                        "componentName": "WanAccelerator",
                        "port": 6164
                    },
                    {
                        "componentName": "Tape",
                        "port": 6166
                    },
                    {
                        "componentName": "CloudGate",
                        "port": 6168
                    },
                    {
                        "componentName": "AgentConfigureService",
                        "port": 9380
                    },
                    {
                        "componentName": "FileSystemVssIntegration",
                        "port": 6210
                    },
                    {
                        "componentName": "VssHwSnapshotProvider",
                        "port": 6211
                    }
                ],
                "portRangeStart": 2500,
                "portRangeEnd": 3300,
                "serverSide": false
            },
            "type": "WindowsHost",
            "id": "*****",
            "name": "enterprise04.tech.local",
            "description": "Created by TECH\\sheila.d.cory",
            "credentialsId": "*****"
        }
    ],
    "pagination": {
        "total": 1,
        "count": 1,
        "skip": 0,
        "limit": 200
    }
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
  "HostNames": ["enterprise04.tech.local"],
  "Types": ["WindowsHost"],
  "UUIDs": ["*****"]
}

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

Servers Count

1

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Managed Servers failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Veeam Backup & Replication portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Error Sample Data

List Managed Servers failed.

Status Code: 400.

Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

List Restore Points

Retrieves all restore points created on the backup server. The returned restored points are sorted by creation time in descending order.

READER NOTE

Backup Object ID is an optional parameter to run this command.

Run the Fetch Event command to obtain the Backup Object ID. Backup Object IDs can be found in the raw data at the path $.data[*].machine.backupObjectId.

Input

Input Parameter	Required/Optional	Description	Example
Created After	Optional	Returns restore points that were created after the specified date and time, in UTC.	2024-02-02T22:01:18
Created Before	Optional	Returns restore points that were created before the specified date and time, in UTC.	2024-02-02T23:00:00
Platform Name	Optional	Filters restore points by name of the backup object platform. The options are: VMware Hyper-V Cloud Director Windows Physical Linux Physical Tape NAS Backup Custom Platform By default, restore points will be returned regardless of their platform.	VMware
Name Filter	Optional	Filters restore points by the nameFilter pattern. The pattern can match any restore point parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, end or both.	VMware*
Malware Status	Optional	Filters restore points by malware status. The options include: Clean Suspicious Infected By default, restore points will be returned regardless of the malware status.	Clean
Backup ID	Optional	Filters restore points by backup ID.	*****
Backup Object ID	Optional	Filters restore points by backup object ID. Backup Object ID can be obtained using the Fetch Event command.	*****

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "platformName": "VmWare",
            "id": "*****",
            "name": "winsrv88",
            "platformId": "*****",
            "creationTime": "2024-02-02T22:01:18.163+01:00",
            "backupId": "*****",
            "allowedOperations": []
        },
        {
            "platformName": "VmWare",
            "id": "*****",
            "name": "winsrv88",
            "platformId": "*****",
            "creationTime": "2024-02-01T22:00:39.997+01:00",
            "backupId": "*****",
            "allowedOperations": []
        }
    ]
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
  "RestorePointIDs": ["*****","*****"],
  "BackupIDs": ["*****","*****"]
}

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

Restore Points Count

1

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Restore Points failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Veeam Backup & Replication portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Error Sample Data

List Restore Points failed.

Status Code: 400.

Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

List Servers

Retrieves an array of all servers and hosts added to the backup infrastructure. The returned servers are sorted alphabetically by host name.

Input

Input Parameter	Required/Optional	Description	Example
Host Name	Optional	Filters based on the full or partial name of the server.	Server_1
Platform Name	Optional	Filters based on platform name. By default, inventory objects from either the VMware or Cloud Director platform will be returned.	VMware

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "data": [
        {
            "type": "vCenterServer",
            "hostName": "vcenter01.tech.local",
            "name": "vcenter01.tech.local",
            "objectId": "*****",
            "urn": "vc:vcenter01.tech.local",
            "platform": "VMware",
            "size": "N/A"
        }
    ]
}

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
  "HostNames": ["vcenter01.tech.local"],
  "Types": ["vCenterServer"],
  "Platforms": ["VMware"]
}

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

Servers Count

1

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Servers failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Veeam Backup & Replication portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Error Sample Data

List Servers failed.

Status Code: 400.

Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration

The API returned an error message

No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Test Connection failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Veeam Backup & Replication portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 400.

Message: Message: No connection adapters were found for '//None:9419/badServerURL/api/oauth2/token'.