mirror_master_2

mirror_master_2 — sets up a secure mirroring master.

Synopsis

(mirror_master_2 host port flags localdomain remotedomain 
 heartbeat timeout [username password])
    

Arguments

host

The master host's name or IP address.

port

The port number or service name of the mirroring master.

flags

Any combination of:

HexFlagNotes
0x00000001 USE_SSL Use an SSL connection.
0x00000002 USE_WEBSOCKET Use a WebSocket connection.
0x00000004 VALIDATE_SSL Validate the SSL certificate when making a connection.
0x00000008 VALIDATE_HOST Validate the SSL certificate against the host name when making a connection.
0x00000010 USE_PROXY Use a forward proxy when connecting via WebSocket.
0x00000020 USE_HTTP_CONNECT Use HTTP CONNECT when connecting to a forward proxy.
0x00008000 DISABLED Client is disabled (and not connected).
0x00010000 USE_BINARY Send point messages in binary rather than ASCII.
0x00020000 EMBEDDED Target is an Embedded Toolkit server (ETK).
0x00100000 READABLE Data is readable from the master. Always set this.
0x00200000 WRITABLE Data is writable to the master.
0x01000000 SYNC_SEND On initial connection, send all data to the master
0x02000000 SYNC_RECV On initial connection, receive all data from the master
0x04000000 SYNC_TIME On initial connection, synchronize by comparing time stamps.
0x10000000 AUTHORITATIVE Master is authoritative. Data here is marked Not Connected when the connection drops.
0x20000000 NON_AUTHORITATIVE I am authoritative. Data in the master is marked Not Connected when the connection drops.
0x40000000 OVERRIDE_TIME Override the time stamp on incoming data with the system clock time.

Some combinations of flags will generate strange results:

  • Combining WRITABLE with OVERRIDE_TIME will result in pollution of the master's time stamps.

  • Only one of SYNC_SEND, SYNC_RECV and SYNC_TIME should be specified.

  • Only one of AUTHORITATIVE and NON_AUTHORITATIVE should be specified.

  • If WRITABLE is not set, then SYNC_SEND, SYNC_TIME and NON_AUTHORITATIVE make no sense.

localdomain

The domain of the slave (i.e. local) computer

remotedomain

The domain of the mirroring master.

heartbeat

The number of milliseconds for the heartbeat on this connection. 0 means disabled.

timeout

The number of milliseconds for the timeout on this connection. 0 means disabled. The timeout should be significantly longer than the heartbeat.

username

(optional) The user name to use if authenticating this connection.

password

(optional) The password to use if authenticating this connection. This password is stored in obfuscated text to stop somebody from casually copying it. However, since this obfuscation must be reversible to give access to the original password, it does not represent strong security. Do not allow untrusted people access to your configuration file.

Returns

A message indicating success or error. Please refer to Return Syntax for details.

Description

This command is the same as mirror_master, but includes the necessary parameters for security. This command is sent to the slave DataHub instance in a mirroring relationship. It tells the slave all the information it needs about its connection to the master DataHub instance. This command corresponds to all the entries in the Mirror Master dialog that opens when you click the Add button in the Tunnel/Mirror option of the Properties window.

The mirror_master_2 command was originally used for setting up tunnel connections in the Cogent DataHub.cfg file. When the tunnel code was moved to a separate plug-in (plugin_TCP.cfg), the command format was changed, and renamed master. Now when the DataHub instance receives a mirror_master_2 command, it converts it into a master command and forwards it to plugin_TCP.cfg.

The master command is not accessible outside of plugin_TCP.cfg. Its syntax is:

(master primaryhost primaryport secondaryhost secondaryport 
 localdomain remotedomain remoteusername remotepassword flags timeout 
 heartbeat retrydelay proxyaddress proxyport proxyusername 
 proxypassword)

Optional entries that get left blank during configuration are designated by empty quotes ( "" ).