aboutsummaryrefslogtreecommitdiffstats
path: root/src/site/apt/nodes.apt
blob: b8ce9879aa5b65e1582db16fb067250834bd550f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
~~~
~~ ============LICENSE_START=======================================================
~~ openECOMP : SDN-C
~~ ================================================================================
~~ Copyright (C) 2017 AT&T Intellectual Property. All rights
~~ 						reserved.
~~ ================================================================================
~~ Licensed under the Apache License, Version 2.0 (the "License");
~~ you may not use this file except in compliance with the License.
~~ You may obtain a copy of the License at
~~ 
~~      http://www.apache.org/licenses/LICENSE-2.0
~~ 
~~ Unless required by applicable law or agreed to in writing, software
~~ distributed under the License is distributed on an "AS IS" BASIS,
~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~~ See the License for the specific language governing permissions and
~~ limitations under the License.
~~ ============LICENSE_END=========================================================
~~~

      ---
      Service Logic Interpreter
      ---
      Dan Timoney
      ---
      2014-11-12
      ---

Supported node types

   The following built-in node types are currently supported:

     *  Flow Control

        *  {{{Block node}<<block>>}}

        *  {{{Call node}<<call>>}}

        *  {{{For node}<<for>>}}

        *  {{{Return node}<<return>>}}

        *  {{{Set node}<<set>>}}

        *  {{{Switch node}<<switch>>}}

     *  Device Management

        *  {{{Configure node}<<configure>>}}

     *  Java Plugin Support

        *  {{{Execute node}<<execute>>}}

     *  Recording

        *  {{{Record node}<<record>>}}

     *  Resource Management

        *  {{{Delete node}<<delete>>}}

        *  {{{Exists node}<<exists>>}}

        *  {{{Get-resource node}<<get-resource>>}}

        *  {{{Is-available node}<<is-available>>}}

        *  {{{Notify node}<<notify>>}}

        *  {{{Release node}<<release>>}}

        *  {{{Reserve node}<<reserve>>}}

        *  {{{Save node}<<save>>}}

        *  {{{Update node}<<update>>}}


* Flow Control

** Block node

*** Description

   A <<block>> node is used to executes a set of nodes.

*** Attributes

*--------------*--------------------------------------------+
| <<atomic>>   | if <true>, then if a node returns failure, subsequent nodes will not be executed and nodes already executed will be backed out.
*--------------*--------------------------------------------+

*** Parameters

  None

*** Outcomes

  None

*** Example

+-----------------+
<block>
  <record plugin="org.openecomp.sdnc.sli.recording.FileRecorder">
    <parameter name="file" value="/tmp/sample_r1.log" />
    <parameter name="field1" value="__TIMESTAMP__"/>
    <parameter name="field2" value="RESERVED"/>
    <parameter name="field3" value="$asePort.uni_circuit_id"/>
  </record>
  <return status="success">
    <parameter name="uni-circuit-id" value="$asePort.uni_circuit_id" />
  </return>
</block>
+-----------------+



**Call node

*** Description

  A <<call>> node is used to call another graph

*** Attributes

*--------------*-------+
| <<module>>   | Module of directed graph to call.  If unset, defaults to that of calling graph
*--------------*-------+
| <<rpc>>      | rpc of directed graph to call.
*--------------*-------+
| <<version>>  | version of graph to call,  If unset, uses active version.
*--------------*-------+
| <<mode>>     | mode (sync/async) of graph to call.   If unset, defaults to that of calling graph.
*--------------*-------+



*** Parameters

  Not applicable

*** Outcomes

*----------*---------+
| <<success>> | Sub graph returned success
*----------*---------+
| <<not-found>> | Graph not found
*----------*---------+
| <<failure>> | Subgraph returned success
*----------*---------+
   .

*** Example

+-------------------+
<call rpc="svc-topology-reserve" mode="sync" />
+-------------------+

**For node

*** Description

  A <<for>> node provides a fixed iteration looping mechanism, similar to the Java for loop

*** Attributes

*--------------*-------+
| <<index>>   | index variable
*--------------*-------+
| <<start>>    | initial value
*--------------*-------+
| <<end>>      | maximum value
*--------------*-------+


*** Parameters

  Not applicable.

*** Outcomes

  Not applicable.  The <<status>> node has no outcomes.

*** Example

+-------------------+
<for index="i" start="0" end="`$service-data.universal-cpe-ft.l2-switch-interfaces_length`">
   <record plugin="org.openecomp.sdnc.sli.recording.Slf4jRecorder">
      <parameter name="logger" value="message-log"/>
      <parameter name="level" value="info"/>
      <parameter name="field1" value="`'current l2-switch-interface name is ' + $service-data.universal-cpe-ft.l2-switch-interfaces[$i].name`"/>
   </record>
</for>
+-------------------+

**Return node

*** Description

  A <<return>> node is used to return a status to the invoking MD-SAL application

*** Attributes

*--------------*-------+
| <<status>>   | Status value to return (<success> or <failure>)
*--------------*-------+


*** Parameters

  The following optional parameters may be passed to convey more
  detailed status information.

*------------*-----------+
| <<error-code>> | A brief, usually numeric, code indicating the error condition
*------------*-----------+
| <<error-message>> | A more detailed error message
*------------*-----------+

*** Outcomes

  Not applicable.  The <<status>> node has no outcomes.

*** Example

+-------------------+
<return status="failure">
  <parameter name="error-code" value="1542" />
  <parameter name="error-message" value="Activation failure" />
</return>
+-------------------+

**Set node

*** Description

  A <<set>> node is used to set one or more values in the execution context

*** Attributes

*--------------*-------+
| <<only-if-unset>>   | If true the set node will only execute if the current value of the target is null
*--------------*-------+

*** Parameters

  Values to be set are passed as parameters

*** Outcomes

  Not applicable.  The <<set>> node has no outcomes.

*** Example

+-------------------+
<set>
  <parameter name="vlan" value="$network.provider-segmentation-id" />
</set>
+-------------------+

**Switch node

*** Description

  A <<switch>> node is used to make a decision based on its <<test>> attribute.

*** Attributes

*--------------*-------+
| <<test>>   | Condition to test
*--------------*-------+


*** Parameters

  None


*** Outcomes

  Depends on the <<test>> condition

*** Example

+-------------------+
<switch test="$uni-cir-units">
  <outcome value="Mbps">
    <reserve plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
             resource="ase-port"
             key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value"
             pfx="asePort">

      <outcome value="success">
        <return status="success">
          <parameter name="uni-circuit-id" value="$asePort.uni_circuit_id" />
        </return>
      </outcome>
      <outcome value="Other">
        <return status="failure">
          <parameter name="error-code" value="1010" />
          <parameter name="error-message" value="No ports found that match criteria" />
        </return>
      </outcome>
    </reserve>
  </outcome>
  <outcome value="Gbps">
    <reserve plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
             resource="ase-port"
             key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value*1000"
             pfx="asePort">

      <outcome value="success">
        <return status="success">
          <parameter name="uni-circuit-id" value="$asePort.uni_circuit_id" />
        </return>
      </outcome>
      <outcome value="Other">
        <return status="failure">
          <parameter name="error-code" value="1010" />
          <parameter name="error-message" value="No ports found that match criteria" />
        </return>
      </outcome>
    </reserve>
  </outcome>
</switch>
+-------------------+

* Device Management

**Configure node

*** Description

  A <<configure>> node is used to configure a device.

*** Attributes

*--------------*-------+
| <<adaptor>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<activate>> | Activate device/interface, for devices that support a separate activation step.
*--------------*-------+
| <<key>>      | SQL-like string specifying criteria for item to configure
*--------------*-------+

*** Parameters

  Specific to device adaptor.

*** Outcomes

*-----------*-------+
| <<success>>  | Device successfully configured
*-----------*-------+
| <<not-found>> | Element to be configured does not exist.
*-----------*--------+
| <<not-ready>> | Element is not in a state where it can be configured/activated
*-----------*-------+
| <<already-active>> | Attempt to activate element that is already active
*-----------*-------+
| <<failure>> | Configure failed for some other reason
*-----------*-------+

*** Example

+-------------------+
<configure adaptor="org.openecomp.sdnc.sli.adaptor.emt.EmtAdaptor"
           key="$uni-circuit-id" activate="true">
  <parameter name="circuit.id" value="$uni-circuit-id" />
  <parameter name="subscriber.name" value="$subscriber-name" />
  <parameter name="emt.clli" value="$edge-device-clli" />
  <parameter name="port.tagging" value="$port-tagging" />
  <parameter name="port.mediaSpeed" value="$media-speed" />
  <parameter name="location.state" value="$uni-location-state" />
  <parameter name="location.city" value="$uni-location-city" />
  <parameter name="cosCategory" value="$cos-category" />
  <parameter name="gosProfile" value="$gos-profile" />
  <parameter name="lldp" value="$asePort.resource-lldp" />
  <parameter name="mtu" value="$asePort.resource-mtu" />
  <outcome value="success">
    <block>
      <record plugin="org.openecomp.sdnc.sli.recording.FileRecorder">
        <parameter name="file" value="/tmp/sample_r1.log" />
        <parameter name="field1" value="__TIMESTAMP__"/>
        <parameter name="field2" value="ACTIVE"/>
        <parameter name="field3" value="$uni-circuit-id"/>
      </record>
      <return status="success">
        <parameter name="edge-device-clli" value="$asePort.resource-emt-clli" />
      </return>
    </block>
  </outcome>
  <outcome value="already-active">
    <return status="failure">
      <parameter name="error-code" value="1590" />
      <parameter name="error-message" value="Port already active" />
    </return>
  </outcome>
  <outcome value="Other">
    <return status="failure">
      <parameter name="error-code" value="1542" />
      <parameter name="error-message" value="Activation failure" />
    </return>
  </outcome>
</configure>
+-------------------+

* Java Plugin Support

**Execute node

*** Description

  An <<execute>> node is used to execute Java code supplied as a plugin

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of plugin to be used
*--------------*-------+
| <<method>> | Name of method in the plugin class to execute.  Method must return void, and take 2 arguments: a Map (for parameters) and a SvcLogicContext (to allow plugin read/write access to context memory)
*--------------*-------+

*** Parameters

  Specific to plugin / method

*** Outcomes

*-----------*-------+
| <<success>>  | Device successfully configured
*-----------*-------+
| <<not-found>> | Plugin class could not be loaded
*-----------*--------+
| <<unsupported-method>> | Named method taking (Map, SvcLogicContext) could not be found
*-----------*-------+
| <<failure>> | Configure failed for some other reason
*-----------*-------+

*** Example

+-------------------+
<execute plugin="org.openecomp.sdnc.sli.plugin.HelloWorld"
           method="log">
  <parameter name="message" value="Hello, world!" />
  <outcome value="success">
      <return status="success"/>
  </outcome>
  <outcome value="not-found">
    <return status="failure">
      <parameter name="error-code" value="1590" />
      <parameter name="error-message" value="Could not locate plugin" />
    </return>
  </outcome>
  <outcome value="Other">
    <return status="failure">
      <parameter name="error-code" value="1542" />
      <parameter name="error-message" value="Internal error" />
    </return>
  </outcome>
</execute>
+-------------------+

* Recording

** Record node

*** Description

  A <<record>> node is used to record an event.  For example, this might be used
  to log provisioning events.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class to handle recording.
*--------------*-------+


*** Parameters

 Parameters will depend on the plugin being used.  For the FileRecorder class,
 the parameters are as follows

*------------*-----------+
| <<file>> | The file to which the record should be written
*------------*-----------+
| <<field1>> | First field to write.  There will be <<field>> parameters for each field to write, from <<field1>> through <<fieldN>>.  A special value __TIMESTAMP__ may be assigned to a field to insert the current timestamp
*------------*-----------+


*** Outcomes

*----------*---------+
| <<success>> | Record successfully written
*----------*---------+
| <<failure>> | Record could not be successfully written
*----------*---------+

*** Example

+-------------------+
<record plugin="org.openecomp.sdnc.sli.recording.FileRecorder">
  <parameter name="file" value="/tmp/sample_r1.log" />
  <parameter name="field1" value="__TIMESTAMP__"/>
  <parameter name="field2" value="ACTIVE"/>
  <parameter name="field3" value="$uni-circuit-id"/>
</record>
+-------------------+

* Resource Management

** Delete node

*** Description

  A <<delete>> node is used to delete a resource from the local resource inventory.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to delete
*--------------*-------+
| <<key>>      | SQL-like string specifying key to delete
*--------------*-------+

*** Parameters

  None

*** Outcomes

*-----------*-------+
| <<success>>  | Resource specified deleted successfully.
*-----------*-------+
| <failure>> | Resource specified was not deleted
*-----------*-------+

*** Example

+-------------------+
<delete plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
        resource="ase-port"
        key="uni_circuit_id == $uni-circuit-id">
  <outcome value="true">
    <return status="success"/>
  </outcome>
  <outcome value="false">
    <return status="failure"/>
  </outcome>
</delete>
+-------------------+


** Exists node

*** Description

  An <<exists>> node is used to determine whether a particular
  instance of a resource exists.  For example, this might be
  used to test whether a particular switch CLLI is provisioned.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to check
*--------------*-------+
| <<key>>      | SQL-like string specifying key to check for
*--------------*-------+

*** Parameters

  None

*** Outcomes

*-----------*-------+
| <<true>>  | Resource specified exists.
*-----------*-------+
| <<false>> | Resource specified is unknown
*-----------*-------+

*** Example

+-------------------+
<exists plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
        resource="ase-port"
        key="uni_circuit_id == $uni-circuit-id">
  <outcome value="true">
    <return status="success"/>
  </outcome>
  <outcome value="false">
    <return status="failure"/>
  </outcome>
</exists>
+-------------------+

** Get-resource node

*** Description

  A <<get-resource>> node is used to retrieve information about a
  particular resource and make it available to other nodes in the
  service logic tree.  For example, this might be used to
  retrieve information about a particular uni-port.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to retrieve
*--------------*-------+
| <<key>>      | SQL-like string specifying criteria for retrieval
*--------------*-------+
| <<pfx>>      | Prefix to add to context variable names set for data retrieved
*--------------*-------+
| <<select>>      | String to specify, if key matches multiple entries, which entry should take precedence
*--------------*-------+
| <<order-by>>      | Prefix to add to context variable names set for data retrieved
*--------------*-------+

*** Parameters

  None


*** Outcomes

*-----------*-------+
| <<success>>  | Resource successfully retrieved
*-----------*-------+
| <<not-found>> | Resource referenced does not exist
*-----------*-------+
| <<failure>> | Resource retrieve failed for some other reason
*-----------*-------+

*** Example

+-------------------+
<get-resource plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
              resource="ase-port"
              key="uni_circuit_id == $uni-circuit-id"
              pfx="current-port">
  <outcome value="success">
    <return status="success"/>
  </outcome>
  <outcome value="not-found">
    <return status="failure"/>
  </outcome>
  <outcome value="failure">
    <return status="failure"/>
  </outcome>
</get-resource>
+-------------------+

** Is-available node

*** Description

  An <<is-available>> node is used to determine whether a particular
  type of resource is available.  For example, this might be used to
  test whether any ports are available for assignment on a particular switch.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to check
*--------------*-------+
| <<key>>      | SQL-like string specifying key to check for
*--------------*-------+
| <<pfx>>      | Prefix to add to context variable names set for data retrieved
*--------------*-------+

*** Parameters

  None

*** Outcomes

*-----------*-------+
| <<true>>  | Resource requested is available
*-----------*-------+
| <<false>> | Resource requested is not available
*-----------*-------+

*** Example

+-------------------+
<is-available plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
              resource="ase-port"
              key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value">
  <outcome value="true">
    <return status="success"/>
  </outcome>
  <outcome value="false">
    <return status="failure"/>
  </outcome>
</is-available>
+-------------------+

** Notify node

*** Description

  A <<notify>> node is used to inform an external application (e.g. A&AI) that a resource was
  updated.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Identifies resource that was updated
*--------------*-------+
| <<action>>      | Action that triggered notification to be sent (ADD/UPDATE/DELETE)
*--------------*-------+

*** Parameters

  None

*** Outcomes

*-----------*-------+
| <<success>>  | Notification was successful
*-----------*-------+
| <<failure>> | Notification failed is not available
*-----------*-------+

*** Example

+-------------------+
<notify plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
              resource="ase-port"
              action="ADD">
  <outcome value="success">
    <return status="success"/>
  </outcome>
  <outcome value="Other">
    <return status="failure"/>
  </outcome>
</notify>
+-------------------+

** Release node

*** Description

  A <<release>> node is used to mark a resource as no longer in use, and thus
  available for assignment.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to release
*--------------*-------+
| <<key>>      | SQL-like string specifying key to check of resource to release
*--------------*-------+

*** Parameters

  None

*** Outcomes

*-----------*-------+
| <<success>>  | Resource successfully released
*-----------*-------+
| <<not-found>> | Resource referenced does not exist
*-----------*-------+
| <<failure>> | Resource release failed for some other reason
*-----------*-------+

*** Example

+-------------------+
<release plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
         resource="ase-port"
         key="uni_circuit_id == $uni-circuit-id">
  <outcome value="success">
    <return status="success"/>
  </outcome>
  <outcome value="not-found">
    <return status="failure"/>
  </outcome>
  <outcome value="failure">
    <return status="failure"/>
  </outcome>
</release>
+-------------------+


** Reserve node

*** Description

  A <<reserve>> node is used to reserve a particular
  type of resource..  For example, this might be used to
  reserve a port on a particular switch.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to reserve
*--------------*-------+
| <<key>>      | SQL-like string specifying criteria for reservation
*--------------*-------+
| <<select>>   | String to specify, if <<key>> matches multiple entries, which entry should take precedence
*--------------*-------+

*** Parameters

  None

*** Outcomes

*-----------*-------+
| <<success>>  | Resource requested was successfully reserved
*-----------*-------+
| <<failure>> | Resource requested was not successfully reserved
*-----------*-------+

*** Example

+-------------------+
<reserve plugin="org.openecomp.sdnc.sli.resource.samplesvc.SampleServiceResource"
         resource="ase-port"
         key="resource-emt-clli == $edge-device-clli and speed >= $uni-cir-value"
         select="min(speed)">
  <outcome value="success">
    <return status="success"/>
  </outcome>
  <outcome value="failure">
    <return status="failure"/>
  </outcome>
</reserve>
+-------------------+

** Save node

*** Description

  A <<save>> node is used to save information about a
  particular resource to persistent storage.  For example, this might be used to
  save information about a particular uni-port.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to save
*--------------*-------+
| <<key>>      | SQL-like string specifying criteria for retrieval
*--------------*-------+
| <<force>>    | If "true", save resource even if this resource is already stored in persistent storage
*--------------*-------+
| <<pfx>>      | Prefix to be prepended to variable names, when attributes are set in SvcLogicContext
*--------------*-------+

*** Parameters

  Values to save (columns) are specified as parameters, with each name
  corresponding to a column name and each value corresponding to the
  value to set.

*** Outcomes

*-----------*-------+
| <<success>>  | Resource successfully saved
*-----------*-------+
| <<failure>> | Resource save failed
*-----------*-------+

*** Example

+-------------------+
<save plugin="`$sample-resource-plugin`" resource="vnf"
    key="vnf-name = $requests.vnf.vnf-name" force="true"
    pfx="requests.vnf">
    <parameter name="vnf-name"
        value="`$requests.cust-country-code + $requests.cust-id + $requests.cust-city + $requests.cust-state + '001VCE'`" />
    <parameter name="vnf-type" value="vce" />
    <parameter name="orchestration-status" value="pending-create" />
    <parameter name="heat-stack-id" value="`$requests.heat-stack-id`" />
    <parameter name="mso-catalog-key" value="`$requests.mso-catalog-key`" />
    <parameter name="oam-ipv4-address" value="`$vce-ipv4-oam-addr.ipv4-addr`" />
</save>
+-------------------+

** Update node

*** Description

  An <<update>> node is used to update information about a
  particular resource to persistent storage.

*** Attributes

*--------------*-------+
| <<plugin>>   | Fully qualified Java class of resource adaptor to be used
*--------------*-------+
| <<resource>> | Type of resource to update
*--------------*-------+
| <<key>>      | SQL-like string specifying criteria for retrieval
*--------------*-------+
| <<pfx>>      | Prefix to be prepended to variable names, when attributes are set in SvcLogicContext
*--------------*-------+

*** Parameters

  Values to save (columns) are specified as parameters, with each name
  corresponding to a column name and each value corresponding to the
  value to set.

*** Outcomes

*-----------*-------+
| <<success>>  | Resource successfully saved
*-----------*-------+
| <<failure>> | Resource save failed
*-----------*-------+

*** Example

+-------------------+
<update plugin="`$sample-resource-plugin`" resource="vnf"
    key="vnf-name = $requests.vnf.vnf-name"
    pfx="requests.vnf">
    <parameter name="vnf-name"
        value="`$requests.cust-country-code + $requests.cust-id + $requests.cust-city + $requests.cust-state + '001VCE'`" />
    <parameter name="vnf-type" value="vce" />
    <parameter name="orchestration-status" value="pending-create" />
    <parameter name="heat-stack-id" value="`$requests.heat-stack-id`" />
    <parameter name="mso-catalog-key" value="`$requests.mso-catalog-key`" />
    <parameter name="oam-ipv4-address" value="`$vce-ipv4-oam-addr.ipv4-addr`" />
</update>
+-------------------+