Error: Invalid spaceKey on retrieving a related space config.

Relay module parameters

The Relay module is used to manage the client/relay relationship. A relay is a client machine which also acts as an intermediary between the client and the master server. It is located on the next higher hierarchy level than the client. Depending on the size of the network more than one level of relays may exist.This module is required for the basic functioning of the software and cannot be unloaded.

Parameter

Default Value

Description

Is Enabled

Yes

Displays if the current device is a relay. If the relay functionality is deactivated the device is only a simple client. Only a client which has been verified by the AutoDiscovery and received the status Verified may be a relay. This field defines if the current device is to be a relay. If the relay functionality is deactivated the device is only a simple client.

Child IP Address Range

The IP address range in which the children below the currently selected device may be found if it is enabled as a relay. If a client outside the IP range specified here, tries to define this device as its relay, it is rejected. The addresses may be entered as single IP addresses or in form of address ranges:

  • Dotted notation, for example, 94.24.127.0-94.24.127.24 - 2001:db8:85a3::8a2e:370:152-2001:db8:85a3::8a2e:370:896 , or 94.24.127.0-24 - 2001:db8:85a3::8a2e:370:152-896 or 94.24.127.0/24 - 2001:db8:85a3::8a2e:370:152/896
  • With the short or complete network name such as scotty or scotty.enterprise.com
  • A mixture of both: 94.24.127.24, 2001:db8:85a3::8a2e:370:152, scotty.enterprise.com .Several ranges must be separated by a comma (,).

Rejected Relays

Defines a list of clients, which are NOT to be used as a relay for other clients, such as the master server or other specific devices. The devices may be listed with their short or long network names, such as scotty or scotty.enterprise.com or their IP address in dotted notation. The field may also contain a range of devices in the form of 192.1.1.1-192.1.1.4,2001:db8:85a3::8a2e:370:152-896,kirk,scotty or 192.1.1.1-kirk or kirk-scotty .

Parent Name

The name of the direct parent to which the target device is to be connected. This is either the master or the new device's relay on the next higher level. The name may be entered as the short or long network name, that is, scotty or scotty.enterprise.com or as its IP address in dotted notation, that is, 192.168.1.1 or 2001:db8:85a3::8a2e:370:7334 . You may also select the parent from the list of available devices by clicking the Add Device icon and selecting the desired parent from the appearing list.

Parent Port

The port number of the direct parent to which the device is connected.

Tunnel to Parent

2

Defines if the agent creates and maintains a tunnel with its parent. Be aware that Auto Detection has a slight impact on the performance. Use Yes if the network configuration is such that the relay cannot directly connect to its clients.

Tunnel Compression Level

0

Defines compression level to use when building a tunnel to the parent, the possible values range from 0 to 9, 0 meaning no compression and 9 the highest compression.

Lost Parent Verification Retry Count

0

The number of times a device tries to contact the device defined as its parent, if the contact cannot be established at the first try. If after this count the contact still cannot be established the agent moves on to the selecion mechanisms defined by the Mechanism List parameter for dynamic relay selection. For static relay selection this mechanism loops until a connection with the defined relay was established again if this value is set to 0 and the Interval between Lost Parent Verifications parameter is set to a value greater than 0 . If both values are set to 0 the reselection is disabled, which is NOT recommended.

Interval between Lost Parent Verifications (sec)

0

The time interval in seconds between each try to contact the parent.

Interval between Parent Verifications (sec)

0

Defines the timout delay in seconds after which the currently connected parent is to be verified. If the connection with the parent cannot be established, the parent resynchronization process defined via the Lost Parent Verification Retry Count and Interval between Lost Parent Verifications parameters is started. This process is disabled if currently no parent is connected or if the parameter value is set to 0 .

Reselection Interval (sec)

3600

Defines the interval in seconds between attempts at selecting a "better" parent than the current one. This selection is done even if the current parent is contactable. This option is disabled if the value is set to 0 or if currently no parent is connected.

Parent Selection Retry Interval (sec)

60

Defines the interval in seconds at which the client tries to locate the parent relay it belongs to. This option is only enabled if currently no parent device is connected, that is, the device is orphaned . It is disabled if a parent is connected or if the value is set to 0 .

Mechanism List

60

Defines the order in which the dynamic relay selection methods are applied. You must enter the methods in form of a comma (,) separated list, the list is read from left to right. The following relay selection methods are available: dhcp, list, static, autodiscovery, script and backup . If this parameter is empty the Parent Name and Parent Port parameters is used as static parent information.

Static Parent Name

60

The name of the direct parent to which the target device is to be connected in static mode. This value is ignored if the dynamic relay selection is activated, that is, at least one value is entered in the Mechanism List field. The direct parent is either the master or the new device's relay on the next higher level. The name may be entered as the short or long network name, that is, scotty or scotty.enterprise.com or as its IP address in dotted notation, that is, 192.168.1.1 or 2001:db8:85a3::8a2e:370:7334 . You may also select the parent from the list of available devices by clicking the Add Device icon and selecting the desired parent from the appearing list.

Static Parent Port

60

The port number of the direct parent to which the device is connected in static mode. This value is ignored if the dynamic relay selection is activated, that is, at least one value is entered in the Mechanism List field.

List Server URL

60

The URL to the BCM agent on which the actions to find the appropriate relay are to be executed, generally this is the Master.

DHCP Extended Option

60

The number of the option defined in the DHCP Server that corresponds to the relay.

Script Path

Provides the relative or absolute path to the script. The path may also be entered as a valid URL starting with _

http://_

or _

https://_

, in which case the script is downloaded every time it is referenced. This parameter is mandatory of the script option is listed as a dynamic relay selection mechanism in the Mechanism List field.

Backup Relays

A list of backup parents to be scanned if during the auto selection no suitable parent is found through AutoDiscovery. The format is host1:port1,host2:port2, etc. Host 1 is the closest alternative to the regular relay and the last host listed is typically the master. The host name can be entered either as its long or short network name, for example, scotty or scotty.enterprise.com or as its IP address in dotted notation, for example, 192.168.56.4 or 2001:db8:85a3::8a2e:370:7334 . If the port number is not listed the default port 1610 is assumed.

Execute Script at Connection to Backup Relay

Allows to execute a specific Chilli script every time when a connection is established with a backup relay. Enter here the absolute path to the Chilli script.

Execute Script at Disconnection from Backup Relay

Allows to execute a specific Chilli script every time when the connection with a backup relay is terminated. Enter here the absolute path to the Chilli script.

Share Point Path for Administrative Install

The path to the administrative installation point for MSI packages. You may define the path as a UNC path with the following syntax: UNC[IPAddress][MsiFiles] , whereby [IPAddress] is the remote device and [MsiFiles] the remote network share. When using an UNC path the administrator login and password must be specified as they is used to perform a Run As on the machine. This option does not work if the agent is running under a LocalSystem account that cannot access network shares. If you are using IPv6 addresses you must use the following format: FD43-0-0-0-8C84-4BAD-D413-DD68.ipv6-literal.net .

Share Point Name for Administrative Install

The name of the administrative installation point for MSI packages.

Administrator Login for Administrative/Network Installation

The login name of the device's administrator who has all necessary access rights to log on to remote devices.

Administrator Password for Administrative/Network Installation

Enter the corresponding password. For security reasons the keyword is only displayed in the form of asterisks (*).

Short Storage Path

No

Defines if the short or the long storage path for the network and administrative installation is used on the relay. If deactivated the package is stored under the location [RelativePath]/[PackageName.msi]/checksum , whereby [RelativePath] represents the directory structure in the Console under which the package was created. If it is activated, the package is stored directly under the [RelativePath] directory and a checksum subdirectory is created containing the installpackage.zip file.

Share Point Path for Network Install

The path to the network installation point for custom packages. You may define the path as a UNC path with the following syntax: UNC[IPAddress][CustomFiles] , whereby [IPAddress] is the remote device and [CustomFiles] the remote network share. When using an UNC path the Administrator Login and Password must be specified as they is used to perform a Run As on the machine. If the agent is running under a LocalSystem account, this option does not work because this account cannot access network shares.

Share Point Name for Network Install

The name of the network installation point for custom packages.

Automatically Install Package on Network Share

1609

Defines if the packages are installed on the relay via an administrative and/or network install. At module startup, the relay performs a check on the disk to look for packages that are to be installed on the network share:

  • None : The relay only stores the packages but does not install them.
  • Administrative : The respective MSI packages is put on the share as defined in the Share Point Name for Administrative Install parameter and installed on their destination.
  • Network : The respective packages (MSI and custom) is put on the share as indicated in the Share Point Path for Network Install parameter and installed on their destination if they are MSI packages.
  • All : Both network and administrative packages is put on the shares as defined by the Share Point Path parameters above and installed on their destination if they are MSI packages.

Bandwidth Check Port

1609

Specifies the port number on which the bandwidth is calculated, which is available to the device for downloads from the relay.

Bandwidth Check Frequency (sec)

60

The delay in seconds between two calculation phase.

Client Check Frequency (sec)

10

Defines the interval at which the device verifies with the relay how many devices are currently downloading from the relay in seconds. If set to 0 the client check is disabled.

Bandwidth Check Duration (ms)

200

The calculation phase's duration in milli-seconds.

Relay List Synchronization at StartupNoCheck this box if the relay lists are to be synchronized at every startup of the agent. Relay list synchronization allows a device to send its current relay lists it is assigned to as well as their checksum. The master compares the checksum and, if it is different to its own, it sends the relay lists available on the master to the device. In this case the local agent compares its relay lists assigned with the master list and updates it accordingly by deleting the unassigned relay lists and adding the newly assigned ones.
Relay List Additional Automatic Synchronization Hour23

Enter here the hour at which an additional synchronization is to be effected, that is, the comparison of locally available relay lists with the relay lists master list. The format is 24-hour format, for example, 23 for 11 pm.

Relay List Minimum Gap between Two Automatic Synchronizations (sec)43200Defines the minimum interval in seconds at which the relay list synchronisations are to be done. This means that if a default synchronisation is executed at 23:00 at night and the client is started at 6 am with agent startup synchronisation defined, no synchronisation is executed until at least 11 am even if the agent is started/restarted before, as the interval is fixed for 12 hours minimum.
Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Jan Sierens

    "Tunnel to Parent" default value is 2 and the description mentions to set it to Yes. What does a value of 2 represent? What are the other possible values?

    Mar 15, 2019 04:41