1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 .. image:: ../etc/opnfv-logo.png
9 .. these two pipes are to seperate the logo from the first title
12 Using domino-cli Client
13 =======================
14 Make sure that domino-cli.py is in +x mode.
16 Change directory to where domino-cli.py is located or include file path in the PATH environment variable.
18 * Registration Command
24 ./domino-cli.py register
26 This message has the following fields that are automatically filled in.
30 Message Type (= REGISTER)
31 DESIRED UDID (= if not allocated, this will be assigned as Unique Domino ID)
32 Sequence Number (=incremented after each RPC call)
33 IP ADDR (= IP address of DOMINO Client to be used by DOMINO Server for future RPC Calls to this client)
34 TCP PORT (= TCP port of DOMINO Client to be used by DOMINO Server for future RPC Calls to this client)
35 Supported Templates (= Null, this field not used currently)
43 ./domino-cli.py heartbeat
45 This message has the following fields that are automatically filled in.
49 Message Type (= HEART_BEAT)
50 UDID (= Unique Domino ID assigned during registration)
51 Sequence Number (=incremented after each RPC call)
53 * Label and Template Type Subscription Command
57 ./domino-cli.py subscribe -l <labelname> -t <templatetype>
59 Note that -l can be substituted by --label and -t can be substituted by --ttype.
61 More than one label or template type can be subscribed within the same command line as comma separated labels or template types
65 ./domino-cli.py subscribe -l <label1>,<label2>,<labeln> -t <ttype1>,<ttype2>,<ttypen>
67 To subscribe more than one label or template type, one can also repeat the options -l and -t, e.g.:
71 ./domino-cli.py subscribe -l <label1> -l <label2> -l <labeln> -t <ttype1> -t <ttype2> -t <ttypen>
73 It is safe to call subscribe command multiple times with duplicate labels.
75 This message has the following fields that are automatically filled in.
79 Message Type (= SUBSCRIBE)
80 UDID (= Unique Domino IDassigned during registration)
81 Sequence Number (=incremented after each RPC call)
82 Template Operation (= APPEND)
83 Label Operation (= APPEND)
85 The following fields are filled in based on arguments passed on via -l/--label and -t/--ttype flags
89 Supported Template Types
92 * Template Publishing Command
96 ./domino-cli.py publish -t <toscafile>
98 Note that -t can be substituted by --tosca-file.
100 If -t or --tosca-file flag is used multiple times, the last tosca file passed as input will be used. This usage is not recommended as undefined/unintended results may emerge as the Domino client will continue to publish.
102 This message has the following fields that are automatically filled in.
106 Message Type (= SUBSCRIBE)
107 UDID (= Unique Domino IDassigned during registration)
108 Sequence Number (=incremented after each RPC call)
109 Template Type (= TOSCA)