Editing the settings file (agent.conf)

You can directly edit the settings file (agent.conf) on Agent so that you can configure the operation settings of Agent.

  • The contents of the agent.conf file are applied when Agent starts next time.
  • If the value that is not able to be specified as a settings value or the path that does not exist has been specified in agent.conf file, Agent fails to start.
  • If the item name that is described in agent.conf file is incorrect, Agent ignores the item.
  • When performing a communication test, you do not have to edit the agent.conf file.

Example agent.conf file

This example shows that the agent.conf file sets the following items.

  • The output directory for the system files that Agent internally uses (workfile_path): /tmp/wkfiles
  • The temporary storage directory for the log files that Agent will send to Manager (logfile_path): /tmp/logfiles
  • The file in which the contents for the [Remarks] on the screens are written (remarks_file): /tmp/remarks.txt
devicename = 
server_hostname = aaaaa.bbbb.co.jp:8765
proxy = aaaaa.bbbb.co.jp:3128
proxy_user = test:test
protocol = 0
cert_verification = 0
activation_key = 12345678-1234-1234-1234-123456789012
first_conn_retry_interval = 3600
workfile_path  = /tmp/wkfiles
remarks_file = /tmp/remarks.txt
logfile_path = /tmp/logfiles
agent_id = 12345678-1234-1234-1234-123456789012
Note

Do not change the value of the other than the following items. If you change the value, Agent does not guarantee any operations.

  • protocol
  • cert_verification
  • workfile_path
  • remarks_file
  • logfile_path

We recommend backing up the agent.conf file before making any changes.

protocol

Specify the method of communication to Manager.

  • 0: http
  • 1: https

 

cert_verification

Specify if Agent verifies the correspondence between a host name that was used for a communication request to Manager and a host name that is included in the server certificate.

  • 0: do not verify
  • 1: verify

 

workfile_path

Specify an absolute path by using ASCII characters (alphanumeric characters and symbols) for the output directory of the system files that Agent internally uses with a maximum of 216 bytes in length.

If the value is not specified for workfile_path or the line of workfile_path does not exist, Agent outputs the files to the install directory of Agent.

 

remarks_file

Specify an absolute path by using ASCII characters (alphanumeric characters and symbols) for the file in which the contents for the [Remarks] on the Agent List screen and Agent Details screen are written with a maximum of 256 bytes in length.

If the value is not specified for remarks_file or the line of remarks_file does not exist, the contents of [Remarks] are empty.

Note

The size of the text file must be with a maximum of 512 bytes.

The contents of the file must be written by using ASCII characters (alphanumeric characters and symbols).

When the newline character is included in the text file, the [Remarks] on the Agent Details screen displays all lines, however the [Remarks] on the Agent List screen displays only the first line.

 

logfile_path

Specify an absolute path by using ASCII characters (alphanumeric characters and symbols) for the temporary storage directory for the following log files that Agent will send to Manager with a maximum of 226 bytes in length.

  • Send Logs among Transfer Logs
  • Receive Logs
  • Trace Logs

If the value is not specified for logfile_path or the line of logfile_path does not exist, Agent outputs the files to the install directory of Agent.

Note

If you change the output location, when Agent restarts, the files in the past output location are not sent to Manager and remain there. Therefore, a part of the logs might be dropped.