Fortinet black logo

BMC Discovery v1.0.0

1.0.0
Copy Link
Copy Doc ID bd5a54d9-97e7-11ed-8e6d-fa163e15d75b:489

About the connector

BMC Discovery is a data center discovery solution that automatically discovers data center inventory, configuration, and relationship data, and maps applications to the IT infrastructure. This connector facilitates automated operations related to the search.

This document provides information about the BMC Discovery Connector, which facilitates automated interactions, with a BMC Discovery server using FortiSOAR™ playbooks. Add the BMC Discovery Connector as a step in FortiSOAR™ playbooks and perform automated operations with BMC Discovery.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

Use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-bmc-discovery

Prerequisites to configuring the connector

  • You must have the URL of the BMC Discovery server to which you will connect and perform automated operations and credentials to access that server.
  • The FortiSOAR™ server should have outbound connectivity to port 443 on the BMC Discovery server.

Minimum Permissions Required

  • Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the BMC Discovery connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server URL The service-based URL of the BMC Discovery to connect and perform automated operations.
Username Username of the BMC Discovery Platform used to create an authentication token required to access the API.
Password Password of the BMC Discovery Platform used to create an authentication token required to access the API.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set to True.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

Function Description Annotation and Category
Run Search Retrieves information for a search query from BMC Discovery based on the filter query, an offset, and the limit you have specified. search_query
Investigation

operation: Run Search

Input parameters

Parameter Description
Filter Query Specify a search query to run in BMC Discovery query syntax available here.
Result Deleted (Optional) Select this option to delete the result set before results are returned.
Result sets are deleted automatically before the last page of results is returned, but setting this field to true on any page will delete the result set immediately.
This deletion step is an optimization to free resources if you don't plan on accessing any further pages of data. Alternatively, if set to false, automatic deletion of the result set will not happen (for this request).
Offset (Optional) Specify the count of the first few records to skip while retrieving the response from BMC Discovery.
NOTE: For an offset value greater than 0, specify a results ID in the next field.
Results ID (Optional) Specify a results ID if requesting an offset value greater than 0. This ID is useful when retrieving the result set of a previously run query.
NOTE: Provide the original query corresponding to this result ID to avoid the case where the result set has timed out and the query needs to be re-run. The results_id can be found on any page of results except the last page.
Limit (Optional) Specify the maximum number of records to fetch from BMC Discovery.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - BMC Discovery - 1.0.0 playbook collection comes bundled with the BMC Discovery connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the BMC Discovery connector.

  • Run Search

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

Previous
Next

About the connector

BMC Discovery is a data center discovery solution that automatically discovers data center inventory, configuration, and relationship data, and maps applications to the IT infrastructure. This connector facilitates automated operations related to the search.

This document provides information about the BMC Discovery Connector, which facilitates automated interactions, with a BMC Discovery server using FortiSOAR™ playbooks. Add the BMC Discovery Connector as a step in FortiSOAR™ playbooks and perform automated operations with BMC Discovery.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

Use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-bmc-discovery

Prerequisites to configuring the connector

Minimum Permissions Required

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the BMC Discovery connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server URL The service-based URL of the BMC Discovery to connect and perform automated operations.
Username Username of the BMC Discovery Platform used to create an authentication token required to access the API.
Password Password of the BMC Discovery Platform used to create an authentication token required to access the API.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set to True.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

Function Description Annotation and Category
Run Search Retrieves information for a search query from BMC Discovery based on the filter query, an offset, and the limit you have specified. search_query
Investigation

operation: Run Search

Input parameters

Parameter Description
Filter Query Specify a search query to run in BMC Discovery query syntax available here.
Result Deleted (Optional) Select this option to delete the result set before results are returned.
Result sets are deleted automatically before the last page of results is returned, but setting this field to true on any page will delete the result set immediately.
This deletion step is an optimization to free resources if you don't plan on accessing any further pages of data. Alternatively, if set to false, automatic deletion of the result set will not happen (for this request).
Offset (Optional) Specify the count of the first few records to skip while retrieving the response from BMC Discovery.
NOTE: For an offset value greater than 0, specify a results ID in the next field.
Results ID (Optional) Specify a results ID if requesting an offset value greater than 0. This ID is useful when retrieving the result set of a previously run query.
NOTE: Provide the original query corresponding to this result ID to avoid the case where the result set has timed out and the query needs to be re-run. The results_id can be found on any page of results except the last page.
Limit (Optional) Specify the maximum number of records to fetch from BMC Discovery.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - BMC Discovery - 1.0.0 playbook collection comes bundled with the BMC Discovery connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the BMC Discovery connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

Previous
Next