Configurable Settings - .NET Static Agent on Windows

How to apply changes to the Controller environment

Changes in the installation.yaml can be applied by running the install script or the upgrade script. Note that re-running the install script will delete any information that would have been stored previously.

Required fields in installation.yaml

Variable Name
Key Value
Explanation of the Variable and Key Values
controller.name
 String This will be the identifier used in the VF Server UI. So, this should be as precise a name as possible, e.g. "UAT Viper" or "Prod App1"
controller.host
 String The controller.host is the address that the vFunction Server address with which the Controller will connect. The value needs to start with http:// or https://. The value can be an IP Address or a FQDN
controller.org_id
controller.app_id
controller.client_id
controller.client_secret
Strings Once the Server is installed, the Admin can log into the UI and create the App. In the UI's Install Controller dialog box, the YAML values for the org_id, app_id, client_id and client_secret will be displayed. The values for this YAML file should be copied for the Server UI to here
controller.type
 String
viper.assemblies
 List of Strings Path(s) to the Monolithic Application's directory where the assemblies (DLLs, EXEs, Resource Files) are placed, such as the ..\bin directory

Sample with required fields in installation.yaml

controller:
  name: Prod App1
  host: http://10.0.0.143
  org_id: 3cf59199-0a0a-0a0a-0a0a-7c63ffac776e
  app_id: 7b1ab58d-0a0a-0a0a-0a0a-098a113ad721
  client_id: 20761b99-0a0a-0a0a-0a0a-94c2e0bc1859
  client_secret: 6b5b7bc1-0a0a-0a0a-0a0a-2bd10db75e2f
  type: dotnet
  tags:
#    - tag1

server_application:
#  name:
#  include_classes: com.
#  allowed_users:
#  new_user_default_password:

viper:
  assemblies:
    - C:\myapp\bin
  stored_procedure:
    # optional db_provider: sqlserver, oracle
#    db_provider:
    # optional db_connection_string: Server=<IP>;Database=<DB name>;User ID=<ID>;Password=<Password>;Encrypt=False
#    db_connection_string:

Optional fields in installation.yaml
controller.client_certificate
Installation.yaml Configuration
Details
controller:
   client_certificate:
      crt: |
         -----BEGIN CERTIFICATE-----
         ...
         -----END CERTIFICATE-----
      key: |
         -----BEGIN PRIVATE KEY-----
         ...
         -----END PRIVATE KEY-----
  • Adding a Client Certificate and Key to the Controller allows for the vFunction Server and Controller to have some form of verification
  • The Controller loads and sends the Client Certificates to a Server that verifies the source of the traffic. That Server could be set up as an intermediary that manages token validation, such as an IBM DataPower Gateway, before being sent onto the vFunction Server
  • The vFunction Nginx Container could also be configured to "ssl_verify_client on" and point to the Client Certificate which would be loaded on the Nginx Container's filesystem somewhere like /etc/nginx/certs/ca.crt
  • Note that the indentation must be maintained when copy-and-pasting the Certificate and Key into the installation.yaml
controller.tags
Installation.yaml Configuration
Details
controller:
   tags:
      - applicationName
      - moduleName
  • Tags can be used during Learning to make sure that Learning occurs on one or all Controllers with a specific Tag. This ensures that, even if a Controller with a specific UUID goes down, Learning will still occur on live Controllers with the desired Tag name
server_application.name
Installation.yaml Configuration
Details
server_application:
   name: "OMS Dotnet"
  • Two workflows are available to allow the Agent to communicate with the vFunction Server: (1) Use the UUIDs gathered after creating the vFunction Application in the UI or (2) Create the Application from the Agent itself. The server_application.name is used in the second workflow
  • This key must be used in conjunction with the server_application.include_classes, server_application.server_username and server_application.server_password fields
  • The value associated with this Key will be the vFunction UI's Application Name
  • During the Agent installation process, if these fields are present then the vFunction Application will be created in the vFunction UI
server_application.include_classes
Installation.yaml Configuration
Details
server_application:
   include_classes: "oms."
  • Two workflows are available to allow the Agent to communicate with the vFunction Server: (1) Use the UUIDs gathered after creating the vFunction Application in the UI or (2) Create the Application from the Agent itself. The server_application.name is used in the second workflow
  • This key must be used in conjunction with the server_application.name, server_application.server_username and server_application.server_password fields
  • The value associated with this Key will be the Classes to Include / Namespace / Top-Level Package to be filtered into the vFunction Analysis
  • During the Agent installation process, if these fields are present then the vFunction Application will be created in the vFunction UI
server_application.allowed_users
Installation.yaml Configuration
Details
server_application:
   allowed_users: "name@email.com, name2@email.com"
  • This allows non-Administrators to access a vFunction Application
  • The Key takes a list of comma-separated email addresses
server_application.new_user_default_password
Installation.yaml Configuration
Details
server_application:
   new_user_default_password: "Password1!"
  • New users need a one-time password to finish their Account Creation. This allows for the Default New User Password to be created automatically
viper.debug_mode
Installation.yaml Configuration
Details
viper:
   debug_mode: true
  • Adds additional logging to the output of the vfviper.log

Updated on 22 May 2026