ecflow.MirrorAttr

class ecflow.MirrorAttr

Bases: instance

A mirror attribute, assigned to a node, enables establishing an external link and locally replicate the state of a node executing on a remote ecFlow server.

Although mirror attributes can be set at any level (Suite, Family, Task), it only makes sense to assign mirror attributes to Tasks, and only one mirror attribute per node is allowed.

Constructor:

MirrorAttr(name, remote_path, ...)
   string name: The Mirror attribute name
   string remote_path: The path on the remote ecFlow server to the node being replicated
   string remote_host: The host of the remote ecFlow server
   string remote_port: The port of the remote ecFlow server
   string polling: The polling interval used to contact the remote ecFlow server
   Bool ssl: `true`, when using SSL to contact the remote ecFlow server; `false`, otherwise
   string auth: The path to the Mirror Authentication credentials

Usage:

t1 = Task('t1',
          MirrorAttr('name', '/remote/task', 'remote-ecflow', '3141', '60', True, '/path/to/auth'))

t2 = Task('t2')
t2.add_aviso('name', '/remote/task', 'remote-ecflow', '3141', '60', True, '/path/to/auth')

The parameters remote_host, remote_port, polling, ssl, and auth are optional

MirrorAttr.auth((MirrorAttr)arg1) → str :

Returns the path to Authentication credentials used to contact the remote ecFlow server

MirrorAttr.name((MirrorAttr)arg1) → str :

Returns the name of the Mirror attribute

MirrorAttr.polling((MirrorAttr)arg1) → str :

Returns the polling interval used to contact the remove ecFlow server

MirrorAttr.remote_host((MirrorAttr)arg1) → str :

Returns the host of the remote ecFlow server

MirrorAttr.remote_path((MirrorAttr)arg1) → str :

Returns the path on the remote ecFlow server

MirrorAttr.remote_port((MirrorAttr)arg1) → str :

Returns the port of the remote ecFlow server

MirrorAttr.ssl((MirrorAttr)arg1) → bool :

Returns a boolean, where true means that SSL is enabled