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
15 Using domino-cli Client
16 -----------------------
20 1. Make sure that domino-cli.py is in +x mode.
22 2. Change directory to where domino-cli.py, DominoClient.py and DominoServer.py are located or include file path in the PATH environment variable.
24 3. Start the Domino Server:
28 ./DominoServer.py --log=debug
30 4. Start the Domino Client:
34 ./DominoClient.py -p <portnumber> --cliport <cli-portnumber> --log=debug
36 Note1: The default log level is WARNING and omitting --log option will lead to minimal/no logging on the console
38 Note2: domino_conf.py file includes most of the default values
40 * Registration Command
46 ./domino-cli.py <cli-portnumber> register
48 This message has the following fields that are automatically filled in.
52 Message Type (= REGISTER)
53 DESIRED UDID (= if not allocated, this will be assigned as Unique Domino ID)
54 Sequence Number (=incremented after each RPC call)
55 IP ADDR (= IP address of DOMINO Client to be used by DOMINO Server for future RPC Calls to this client)
56 TCP PORT (= TCP port of DOMINO Client to be used by DOMINO Server for future RPC Calls to this client)
57 Supported Templates (= Null, this field not used currently)
65 ./domino-cli.py <cli-portnumber> heartbeat
67 This message has the following fields that are automatically filled in.
71 Message Type (= HEART_BEAT)
72 UDID (= Unique Domino ID assigned during registration)
73 Sequence Number (=incremented after each RPC call)
75 * Label and Template Type Subscription Command
79 ./domino-cli.py <cli-portnumber> subscribe -l <labelname> -t <templatetype>
81 Note that -l can be substituted by --label and -t can be substituted by --ttype.
83 More than one label or template type can be subscribed within the same command line as comma separated labels or template types
87 ./domino-cli.py <cli-portnumber> subscribe -l <label1>,<label2>,<labeln> -t <ttype1>,<ttype2>,<ttypen>
89 To subscribe more than one label or template type, one can also repeat the options -l and -t, e.g.:
93 ./domino-cli.py <cli-portnumber> subscribe -l <label1> -l <label2> -l <labeln> -t <ttype1> -t <ttype2> -t <ttypen>
95 It is safe to call subscribe command multiple times with duplicate labels.
97 This message has the following fields that are automatically filled in.
101 Message Type (= SUBSCRIBE)
102 UDID (= Unique Domino ID assigned during registration)
103 Sequence Number (=incremented after each RPC call)
104 Template Operation (= APPEND)
105 Label Operation (= APPEND)
107 The following fields are filled in based on arguments passed on via -l/--label and -t/--ttype flags
109 Subscribe RPC also supports options for label using
110 --lop=APPEND/DELETE/OVERWRITE
111 and for supported template types using
112 --top=APPEND/DELETE/OVERWRITE.
113 When unspecified, the default is APPEND.
114 DELETE deletes existing labels (template types) specified in the current call via key -l/--label (-t/--ttype).
115 OVERWRITE removes the current set of labels (template types) and sets it to the new set of values passed in the same RPC call.
119 Supported Template Types
122 * Template Publishing Command
126 ./domino-cli.py <cli-portnumber> publish -t <toscafile>
128 Note that -t can be substituted by --tosca-file.
130 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.
132 This message has the following fields that are automatically filled in.
136 Message Type (= SUBSCRIBE)
137 UDID (= Unique Domino ID assigned during registration)
138 Sequence Number (=incremented after each RPC call)
139 Template Type (= TOSCA)
146 To enter this mode, start Domino Client with interactive console option set as true, i.e., --iac=true:
150 ./DominoClient -p <portnumber> --iax=true --log=DEBUG
152 The rest of the API calls are the same as in the case of using domino-cli.py except that at the prompt there is no need to write "domino-cli.py <cli-portnumber>, e.g.,:
158 >>subscribe -l <label1> -t <ttype1>
159 >>publish -t <toscafile>
161 The interactive CLI mode is mainly supported for manual testing.