1OCCI(1)                            Ruby OCCI                           OCCI(1)
2
3
4

NAME

6       occi - Open Cloud Computing Interface Client
7
8
9

SYNOPSIS

11       occi [OPTIONS]
12
13
14

DESCRIPTION

16       Client implementation of the Open Cloud Computing Interface in Ruby.
17
18
19

OPTIONS

21       -a, --action ACTION
22              Action to be performed on a resource instance, required.
23
24
25       -c, --ca-path PATH [/etc/grid-security/certificates]
26              Path to CA certificates director.
27
28
29       -d, --debug
30              Enable debugging messages.
31
32
33       -e, --endpoint URI [http://localhost:3000]
34              OCCI server URI.
35
36
37       -g, --trigger-action ACTION
38              Action to be triggered on the resource, formatted as SCHEME#TERM
39              or TERM.
40
41
42       -h, --help
43              Show this message.
44
45
46       -j, --link URI
47              URI of an instance to be linked with the given resource,  appli‐
48              cable only for action 'link'.
49
50
51       -l, --log-to OUTPUT [stderr]
52              Log to the specified device, only: {stdout|stderr}.
53
54
55       -M, --mixin IDENTIFIER
56              Identifier   of   a   mixin,   formatted   as   SCHEME#TERM   or
57              SHORT_SCHEME#TERM.
58
59
60       -n, --auth METHOD [none]
61              Authentication method. Only {x509|basic|digest|none}.
62
63
64       -f, --ca-file PATH
65              Path to CA certificates in a file.
66
67
68       -F, --filter CATEGORY
69              Category type identifier to filter categories from  model.  Must
70              be used together with the -m option.
71
72
73       -k, --timeout TIMEOUT
74              Default timeout for all HTTP connections, in seconds.
75
76
77       -m, --dump-model
78              Contact the endpoint and dump its model.
79
80
81       -o, --output-format FORMAT [plain]
82              Output                       format,                       only:
83              {json|plain|json_pretty|json_extended|json_extended_pretty}.
84
85
86       -p, --password PASSWORD
87              Password for basic, digest and x509 authentication.
88
89
90       -r, --resource RESOURCE
91              Term, identifier or URI of a resource to be queried, required.
92
93
94       -t, --attribute ATTRIBUTE
95              An "attribute='value'" pair, mandatory attributes  for  creating
96              new resource instances: [occi.core.title].
97
98
99       -T, --context CTX_VAR
100              A  "context_variable='value'"  pair  for  new 'compute' resource
101              instances, only: {public_key|user_data}.
102
103
104       -s, --skip-ca-check
105              Skip server certificate verification [NOT recommended].
106
107
108       -u, --username USER [anonymous]
109              Username for basic or digest authentication.
110
111
112       -v, --version
113              Show version.
114
115
116       -w, --wait-for-active TIMEOUT [0]
117              Wait for TIMEOUT seconds for  the  created  resource  to  become
118              'active' before returning. Defaults to 0 seconds (will be inter‐
119              preted as 'disabled').
120
121
122       -x, --user-cred FILE [~/.globus/usercred.pem]
123              Path to user's x509 credentials.
124
125
126       -X, --voms
127              Using VOMS credentials; modifies behavior of the X509 authN mod‐
128              ule.
129
130
131       -y, --media-type MEDIA_TYPE [text/plain,text/occi]
132              Media  type for client <-> server communication. Only: {applica‐
133              tion/occi+json|text/plain,text/occi|text/plain|text/occi}.
134
135
136       -z, --examples
137              Show usage examples.
138
139
140

EXAMPLES

142   Quick reference guide
143        occi --endpoint http://localhost:3000/ --action list --resource os_tpl
144        occi  --endpoint  http://localhost:3000/  --action   list   --resource
145       resource_tpl
146        occi  --endpoint  http://localhost:3000/  --action describe --resource
147       os_tpl#debian6
148        occi --endpoint http://localhost:3000/ --action create --resource com‐
149       pute  --mixin  os_tpl#debian6  --mixin  resource_tpl#small  --attribute
150       occi.core.title="My rOCCI VM"
151        occi  --endpoint  http://localhost:3000/  --action  delete  --resource
152       /compute/65sd4f654sf65g4-s5fg65sfg465sfg-sf65g46sf5g4sdfg
153
154
155   Listing resources
156        occi  --endpoint  http://localhost:3000/ --action list --resource com‐
157       pute
158        occi --endpoint http://localhost:3000/ --action list  --resource  net‐
159       work
160        occi  --endpoint http://localhost:3000/ --action list --resource stor‐
161       age
162        occi --endpoint http://localhost:3000/ --action list --resource os_tpl
163        occi  --endpoint  http://localhost:3000/  --action   list   --resource
164       resource_tpl
165
166
167   Describing resources
168        occi  --endpoint  http://localhost:3000/  --action describe --resource
169       compute
170        occi --endpoint http://localhost:3000/  --action  describe  --resource
171       network
172        occi  --endpoint  http://localhost:3000/  --action describe --resource
173       storage
174        occi --endpoint http://localhost:3000/  --action  describe  --resource
175       os_tpl
176        occi  --endpoint  http://localhost:3000/  --action describe --resource
177       resource_tpl
178
179
180   Creating resources
181        occi --endpoint http://localhost:3000/ --action create  [  --attribute
182       attribute_name='attribute_value'  ]+ [ --mixin mixin_type#mixin_term ]+
183       --resource compute
184        occi --endpoint http://localhost:3000/ --action create  [  --attribute
185       attribute_name='attribute_value'  ]+ [ --mixin mixin_type#mixin_term ]+
186       --resource network
187        occi --endpoint http://localhost:3000/ --action create  [  --attribute
188       attribute_name='attribute_value'  ]+ [ --mixin mixin_type#mixin_term ]+
189       --resource storage
190
191
192   Linking/unlinking resources
193        occi --endpoint http://localhost:3000/ --action link --resource  /com‐
194       pute/instance_id --link /network/instance_id
195        occi  --endpoint http://localhost:3000/ --action link --resource /com‐
196       pute/instance_id --link /storage/instance_id
197
198
199   Deleting resources
200        occi --endpoint http://localhost:3000/ --action delete --resource com‐
201       pute
202        occi --endpoint http://localhost:3000/ --action delete --resource net‐
203       work
204        occi  --endpoint  http://localhost:3000/  --action  delete  --resource
205       storage
206
207
208   Triggering actions on resources
209        occi  --endpoint  http://localhost:3000/  --action  trigger --trigger-
210       action         action_scheme#action_term         [          --attribute
211       attribute_name='attribute_value'  ]+  --resource computeocci --endpoint
212       http://localhost:3000/ --action trigger --trigger-action action_term  [
213       --attribute attribute_name='attribute_value' ]+ --resource compute
214        occi  --endpoint  http://localhost:3000/  --action  trigger --trigger-
215       action         action_scheme#action_term         [          --attribute
216       attribute_name='attribute_value'  ]+  --resource networkocci --endpoint
217       http://localhost:3000/ --action trigger --trigger-action action_term  [
218       --attribute attribute_name='attribute_value' ]+ --resource network
219        occi  --endpoint  http://localhost:3000/  --action  trigger --trigger-
220       action         action_scheme#action_term         [          --attribute
221       attribute_name='attribute_value'  ]+  --resource storageocci --endpoint
222       http://localhost:3000/ --action trigger --trigger-action action_term  [
223       --attribute attribute_name='attribute_value' ]+ --resource storage
224
225
226   Authentication
227        occi --endpoint http://localhost:3000/ [ --auth none ]
228        occi  --endpoint http://localhost:3000/ --auth basic [ --username user
229       ] [ --password pass ]
230        occi --endpoint http://localhost:3000/ --auth digest [ --username user
231       ] [ --password pass ]
232        occi  --endpoint  http://localhost:3000/  --auth  x509  [  --user-cred
233       /home/user/.globus/usercred.pem ] [  --ca-file  /etc/grid-security/cer‐
234       tificates/ca.pem  ]  [  --ca-path  /etc/grid-security/certificates  ] [
235       --voms ] [ --password pass ]
236        occi  --endpoint  http://localhost:3000/   --auth   x509   --user-cred
237       /home/user/.globus/usercred.pem
238        occi   --endpoint   http://localhost:3000/   --auth  x509  --user-cred
239       /tmp/x509_1000 --voms
240        occi  --endpoint  http://localhost:3000/   --auth   x509   --user-cred
241       /tmp/x509_1000 --ca-path /etc/grid-security/certificates --voms
242
243
244   Media types
245        occi  --endpoint  http://localhost:3000/ [ ... ] --media-type applica‐
246       tion/occi+json
247        occi  --endpoint   http://localhost:3000/   [   ...   ]   --media-type
248       text/plain,text/occi
249        occi --endpoint http://localhost:3000/ [ ... ] --media-type text/plain
250        occi --endpoint http://localhost:3000/ [ ... ] --media-type text/occi
251
252
253   Output formats
254        occi --endpoint http://localhost:3000/ [ ... ] --output-format json
255        occi --endpoint http://localhost:3000/ [ ... ] --output-format plain
256        occi   --endpoint   http://localhost:3000/  [  ...  ]  --output-format
257       json_pretty
258        occi  --endpoint  http://localhost:3000/  [  ...   ]   --output-format
259       json_extended
260        occi   --endpoint   http://localhost:3000/  [  ...  ]  --output-format
261       json_extended_pretty
262
263
264   Attribute values (type-casting)
265        occi   --endpoint   http://localhost:3000/   [   ...   ]   --attribute
266       attribute_name='attribute_value'
267        occi   --endpoint   http://localhost:3000/   [   ...   ]   --attribute
268       attribute_name='num(attribute_value)'
269        occi   --endpoint   http://localhost:3000/   [   ...   ]   --attribute
270       attribute_name='float(attribute_value)'
271        occi   --endpoint   http://localhost:3000/   [   ...   ]   --attribute
272       attribute_name='bool(attribute_value)'
273
274
275

BUGS

277       Please report all bugs to EGI-TF rOCCI-cli issue tracker  available  at
278       https://github.com/EGI-FCTF/rOCCI-cli/issues
279
280
281

AUTHORS

283       EGI-FCTF, CESNET
284
285       GWDG
286
287
288
289CESNET                            August 2014                          OCCI(1)