Built-in Agent

Overview

RapidDeploy has a built-in agent configured and running with in framework container. This agent instance is run on framework starting up with the following default settings:

        Agent Host: 127.0.0.1
        Agent Port: 20000
        Secure Agent Port: 20443
        Protocol: bisocket
        Multicast Detection Address: 224.1.9.1
        Multicast Detection Port: 4567

This configuration file is usually located in MV_HOME/bin/rapiddeploy.properties

These are the available settings:

rapiddeploy.built.in.remote.agent.enabled=true
rapiddeploy.built.in.remote.agent.protocol=bisocket
rapiddeploy.built.in.remote.agent.host=127.0.0.1
rapiddeploy.built.in.remote.agent.port=20000
rapiddeploy.built.in.remote.agent.bind.ports=
rapiddeploy.built.in.remote.agent.ssl.port=20443
rapiddeploy.built.in.remote.agent.ssl.bind.ports=
rapiddeploy.built.in.remote.agent.multicast.address=224.1.9.1
rapiddeploy.built.in.remote.agent.multicast.bind.address=
rapiddeploy.built.in.remote.agent.multicast.default.ip=224.1.9.1
rapiddeploy.built.in.remote.agent.multicast.port=4567
rapiddeploy.built.in.remote.agent.auth.servers=
rapiddeploy.built.in.remote.agent.backward.compatibility=false

Where:

  • rapiddeploy.built.in.remote.agent.enabled is the setting value to enable or disable the built-in agent instance, by default is set in true.
  • rapiddeploy.built.in.remote.agent.protocol is the agent transport protocol, by default is set as bisocket.
  • rapiddeploy.built.in.remote.agent.host is the agent host name or IP, by default is set as 127.0.0.1.
  • rapiddeploy.built.in.remote.agent.port is the agent listening port number, by default is set in 20000.
  • rapiddeploy.built.in.remote.agent.bind.ports is the agent bind ports, by default is set in blank.
  • rapiddeploy.built.in.remote.agent.ssl.port is the secure agent listening port number, by default is set in 20443.
  • rapiddeploy.built.in.remote.agent.ssl.bind.ports is the secure agent bind ports, by default is set in blank.
  • rapiddeploy.built.in.remote.agent.multicast.address is the agent multicast address, by default is set as 224.1.9.1.
  • rapiddeploy.built.in.remote.agent.multicast.bind.address is the agent multicast address ports, by default is set in blank.
  • rapiddeploy.built.in.remote.agent.multicast.default.ip is the agent multicast default IP, by default is set as 224.1.9.1.
  • rapiddeploy.built.in.remote.agent.multicast.port is the agent multicast port number, by default is set in 4567.
  • rapiddeploy.built.in.remote.agent.auth.servers is the agent authenticated servers, by default is set in blank.
  • rapiddeploy.built.in.remote.agent.backward.compatibility is the agent backward compatibily, by default is set in false.

Besides the starting up of an instance of the built-in agent, the framework automatically creates or updates a built-in server pointing at the configured built-in agent. The name of the server within the framework will be named as localhost_[OS TYPE], for example, on Windows OS, it is will be named as localhost_windows, on Linux OS, it will be names as localhost_linux, on Mac OS, it will be named as localhost_mac, and so on.

Further reading