Agent Properties
An agent property specifies the characteristics/attributes of an HVR Agent. This can include agent connection parameters, user access levels, authentication mode, etc. In the Command Line interface (CLI), the repository properties can be set using the command hvragentconfig.
An array property and map property can store multiple values. The syntax for updating them from the Command Line Interface (CLI) varies.
| Property | Argument | Description |
|---|---|---|
| Agent_Server_Kerberos_Keytab | keytabfile | Full path to the user specified Kerberos keytab file that contains a security key for identifying the agent to the hub during authentication (when connecting hub to the agent). If defined, this keytab file will be used instead of the operating system defaults. |
| Agent_Server_Kerberos_Principal | principal | User specified Kerberos principal name for identifying the agent to the hub during authentication (when connecting hub to the agent). If defined, this principal name will be used instead of the operating system defaults. |
| Agent_Server_Private_Key | base64 | Private key for the HVR Agent. This property is generated when agent starts for the first time. |
| Agent_Server_Private_Key_Password | password | Password for the Agent_Server_Private_Key |
| Agent_Server_Public_Certificate | base64 | Public certificate for the HVR Agent. This property is generated when agent starts for the first time. See also, Agent_Server_Public_Certificate in location properties. |
| All_User_Access | accesslevel | Enables you to set the HVR Agent administration permissions for all agent users configuring the agent. The following access level is supported by Fivetran HVR:
|
| Anonymous_Access | true | Anonymous access to HVR Agent. If set to true, the HVR Hub System can connect anonymously to HVR Agent without supplying a username and password. This requires the agent property Only_From_Client_Public_Certificates. Example JSON to enable anonymous access: |
| Only_From_Client_Public_Certificates | base64 | The SSL public certificate of the client (HVR Hub System). When this property is set, only the client that has the specified certificate is allowed to connect to the HVR Agent. Note that multiple certificates can be defined, and the incoming connection can use one of them. This is a map property that can store multiple values. See also, Agent_Client_Public_Certificate in repository property. |
| PAM_Service | service | The name of the PAM service used for authenticating the agent users with PAM authentication. This defaults to the login service. |
| PAM_Sudo_User | username | Name of the user for running the PAM authenticator instead of the operating system user under which the HVR Agent is running. This user must have privilege to run the following command: |
Remote_KeepaliveSince v6.1.5/7 | seconds | Set the timeout for HVR protocol keepalive messages between the HVR hub and HVR agent. This helps prevent network devices such as load balancers from terminating idle connections, ensuring continuous communication even when no data is being transferred. Note that defining this property may introduce a minor performance overhead. The value specified for this property is in seconds. For example, to set a timeout of 2 minutes and 20 seconds, you need to set the value to 140. |
| Setup_Mode_Timed_Until | time | When this property is set, the agent is in setup mode until the time specified. This property can be used with the Setup_Mode_Token_Value. Valid date formats are:
|
| Setup_Mode_Token_Name | tokenname | User friendly name/description of the setup token. |
| Setup_Mode_Token_Value | tokenvalue | When this property is set, the agent is in setup mode, and only allows access when the token value is provided. This property can be used with the Setup_Mode_Timed_Until. |
| User_Access | accesslevel | Enables you to set the HVR Agent administration permissions for a specific agent user configuring the agent. The following access level is supported by HVR:
|