bmc-ade-http plug-in


Use this plug-in to send third-party data to BMC Helix Platform.

Plug-in parameters

The following table lists the parameters and their usage:

Parameter

Description

Mandatory

@type

Specify the type of plug-in. For this plug-in, the type is bmc_ade_http.

Type: String

Example
<filter tagname>
        @type bmc_ade_http
...
...
...
</filter>

Yes

endpoint_url

Specify the endpoint URL to send events or CI information from third-party applications to BMC Helix applications:

  • To send events to BMC Helix Operations Management, specify the URL in the following format:
    https://<BMC Helix Portal URL>/events-service/api/v1.0/events
    Example:
    https://helixdev.host.com/events-service/api/v1.0/events
    For more information the BMC Helix Operations Management endpoints, see the Event data section on Event management endpoints in the REST API.

  • To send CI information to BMC Helix Discovery, specify the URL in the following format:
    https://<BMC Helix Portal URL>/smart-graph-api/api/v1.2/data/import
    Example: 
    https://helixdev.host.com/smart-graph-api/api/v1.2/data/import
    For more information about the BMC Helix Discovery endpoints, see the data section on Endpoints in the REST API.

Type: String

Yes

ssl_no_verify

Specify whether to skip the SSL verification. Set one of the following values:

  • true: Apply SSL verification.
  • false: Skip SSL verification.

Type: Boolean

Default: false

No

http_method

Specify the http request method. You can set one of the following values:

  • get
  • post
  • delete

Type: enum

Default: post

No

serializer

Choose one of the following serialization methods:

  • json
  • form

Type: enum

Default: form

No

rate_limit_msec

Default: 0

If the rate_limit_msec is set to 0, no rate limiting is set.

No

raise_on_error

Type: Boolean

Default: true

No

recoverable_status_codes

Specify the status codes. Valid values:

  • 503
  • 400

Default: 503

No

config_json_file_path

Specify the JSON file path.

Type: String

Example: /fluentd/etc/config/ade_config.json

Yes

cacert_file

Specify the complete path of the CA certificate filename.

Type: String

Default: ''

No

client_cert_path

Specify the complete path of the client certificate filename.

Type: String

Default: ''

No

private_key_path

Specify the complete path of the private key filename.

Type: String

Default: ''

No

private_key_passphrase

Specify the pass phrase.

Type: String

Default: ''

Example: yourpassphrase

No

custom_headers

Specify the custom headers.

Default: nil

Example: {"token":"arbitrary"}

No

authentication

Specify the authentication type.

Default: none

Example: basic

No

username

Specify the user name.

Type: String

Default: ''

No

password

Specify the password.

Type: String

Default: ''

No

token

Specify the token details.

Default: ''

No

buffered

Specify whether to switch between the non-buffered and buffered mode.

Type: Boolean

Default: false

No

bulk_request

Choose to send events as application/x-ndjson.

Type: Boolean

Default: false

No

compress_request

Specify whether to compress data.

Type: Boolean

Default: false

No

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*