Skip to main content

Register Monitor Agent with Monitor Server

ArcGIS Monitor Agent must be registered with ArcGIS Monitor Server before you can begin collecting data.

Register as a new agent

To register a Monitor Agent installation for the first time, complete the following steps:

  1. Open a command prompt window on the Monitor Agent machine.

  2. Start a terminal session on the Monitor Agent machine with the ArcGIS Monitor account.

  3. Run the command below, editing the parameters to include the root URL to Monitor Server and your username and password.

    <Monitor Agent installation location>\bin\arcgis-monitor-agent.exe admin:system:register --server-url <https://monitorserver.example.com:30443/arcgis> --username <user> --password <password>

    <Monitor Agent installation location>/bin/arcgis-monitor-agent admin:system:register --server-url <https://monitorserver.example.com:30443/arcgis> --username <user> --password <password>

    The following is an example:

    "C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe" admin:system:register --server-url https://monitorserver.example.com:30443/arcgis --username jdoe --password "my password"

    $HOME/arcgis/monitor/agent/bin/arcgis-monitor-agent admin:system:register --server-url https://monitorserver.example.com:30443/arcgis --username jdoe --password "my password"

    Tip:

    For more information about the admin:system:register command, run the command with the --help parameter.

    The following is an example:

    "C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe" admin:system:register --help

    $HOME/arcgis/monitor/agent/bin/arcgis-monitor-agent admin:system:register --help

    A confirmation message appears, indicating that Monitor Agent is registered with Monitor Server.

The Monitor Agent instance is registered with Monitor Server. The host machine is automatically registered as a Windows host component and added to the list of monitored components on the Monitoring page.

The Monitor Agent instance is registered with Monitor Server. The host machine is automatically registered as a Linux host component and added to the list of monitored components on the Monitoring page.

Register as an existing agent

To reconnect a Monitor Agent installation or transfer its responsibilities to another Monitor Agent installation, you must register it as an existing agent. Before completing these steps, ensure that the Monitor Agent connection that you want to register as an existing agent is disconnected from Monitor Server.

To register Monitor Agent as an existing agent, complete the following steps:

  1. Open a command prompt window on the Monitor Agent machine.

  2. Start a terminal session on the Monitor Agent machine with the ArcGIS Monitor account.

  3. Run the command below, editing the command line parameters to include the root URL to Monitor Server, your username and password, and the ID of the ArcGIS Monitor Agent machine.

    <Monitor Agent installation location>\bin\arcgis-monitor-agent.exe admin:system:register --server-url <https://monitorserver.example.com:30443/arcgis> --username <user> --password <password> --agent-id <agent ID>

    <Monitor Agent installation location>/bin/arcgis-monitor-agent admin:system:register --server-url <https://monitorserver.example.com:30443/arcgis> --username <user> --password <password> --agent-id <agent ID>

    The following is an example:

    "C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe" admin:system:register --server-url https://monitorserver.example.com:30443/arcgis --username jdoe --password "my password" --agent-id 28

    $HOME/arcgis/monitor/agent/bin/arcgis-monitor-agent admin:system:register --server-url https://monitorserver.example.com:30443/arcgis --username jdoe --password "my password" --agent-id 28

    Tip:

    For more information about the admin:system:register command, run the command with the --help parameter.

    The following is an example:

    "C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe" admin:system:register --help

    $HOME/arcgis/monitor/agent/bin/arcgis-monitor-agent admin:system:register --help

    A confirmation message appears, indicating that Monitor Agent is registered with Monitor Server.

The Monitor Agent instance is registered with Monitor Server as an existing agent. The host machine is automatically registered as a Windows host component and added to the list of monitored components on the Monitoring page.

The Monitor Agent instance is registered with Monitor Server as an existing agent. The host machine is automatically registered as a Linux host component and added to the list of monitored components on the Monitoring page.