Configuration¶

This section details the configuration and optimization of the SAP Agent plugin.

Plugin Options¶

The following options are available for the SAP Agent plugin.

System.Path¶

Plugins.SAPAGENT.System.Path — Path to the external plugin executable.
Mandatory: yes
Default value:

Timeout¶

Plugins.SAPAGENT.Timeout — The maximum amount of time to wait for a server to respond to SOAP requests.
Mandatory: no
Limits: 1-30
Default value: Global timeout

Uri¶

Plugins.SAPAGENT.Default.Uri
Plugins.SAPAGENT.Sessions.<SessionName>.Uri
The URI to connect to. If specified in a session, it overrides the default value.
Mandatory: no
Range: Must match URI format; supported schemas: http, https, unix.
Default value:

Username¶

Plugins.SAPAGENT.Default.Username
Plugins.SAPAGENT.Sessions.<SessionName>.Username
Username for the connection. If specified in a session, it overrides the default value.
Mandatory: no
Range: Must match SAP Agent username.
Default value:

Password¶

Plugins.SAPAGENT.Default.Password
Plugins.SAPAGENT.Sessions.<SessionName>.Password
Password for the connection. If specified in a session, it overrides the default value.
Mandatory: no
Range: Must match password format.
Default value:

TLSRootCAFile¶

Plugins.SAPAGENT.Default.TLSRootCAFile
Plugins.SAPAGENT.Sessions.<SessionName>.TLSRootCAFile
Full pathname of a file containing the top-level CA(s) certificate. If specified in a session, it overrides the default value.
Mandatory: no
Default value:

TLSServerName¶

Plugins.SAPAGENT.Default.TLSServerName
Plugins.SAPAGENT.Sessions.<SessionName>.TLSServerName
TLS hostname used to verify the server certificate. If specified in a session, it overrides the default value.
Mandatory: no
Default value:

TLSInsecureSkipVerify¶

Plugins.SAPAGENT.Default.TLSInsecureSkipVerify
Plugins.SAPAGENT.Sessions.<SessionName>.TLSInsecureSkipVerify
Disable server's certificate chain and hostname verification. If specified in a session, it overrides the default value.
Mandatory: no
Default value:

Named Sessions¶

Named sessions allow you to group connection settings (URI, credentials and TLS) and reference them in item keys instead of passing individual parameters. This is the recommended way to manage multiple SAP Agent connections securely.

To define a named session, add the parameters to the plugin configuration file:

Plugins.SAPAGENT.Sessions.Prod.Uri=https://192.168.1.10:1129
Plugins.SAPAGENT.Sessions.Prod.Username=sapadm
Plugins.SAPAGENT.Sessions.Prod.Password=secret_password

Once defined, the session name can be used as the first parameter in item keys: sap.agent.ping[Prod]

Named session parameters override Default parameters. If a parameter is not defined in a session, the corresponding Default parameter will be used.