Skip to content

malwareExecuteScan

Parameters

name mandatory default possible values
file Yes
host Yes
malwareScanCredentialsId Yes
password Yes
script Yes
timeout No 600
username Yes
verbose No false true, false
  • file: The file which is scanned for malware
  • host: malware scanning host.
  • malwareScanCredentialsId: The technical user/password credential used to communicate with the malwarescanning service
  • password: Password
  • script: The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.
  • timeout: timeout for http layer in seconds
  • username: User
  • verbose: verbose output

Step Configuration

We recommend to define values of step parameters via config.yml file.

In following sections of the config.yml the configuration is possible:

parameter general step/stage
file X
host X
password X
timeout X
username X
verbose X

Exceptions

None

Examples

malwareExecuteScan script: this

configuration

steps:
    malwareExecuteScan:
        file: myFile.zip
        host: https://malwarescanner.example.sap.com
        malwareScanCredentialsId: MALWARESCAN